Merge pull request #34 from rdytech/RTO-35842-allow-multiple-ids-to-s…

…how-function

RTO-35842 Allow multiple ids to show function

.github/workflows/build.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.3']
+        ruby-version: ['2.7']
 
     steps:
     - uses: actions/checkout@v2
@@ -30,7 +30,7 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
-        bundler: 1.17.3
+        bundler: 2.1.4
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
       run: bundle exec rspec spec

Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.3-slim
+FROM ruby:2.7
 
 RUN apt-get update -y && apt-get install -y git
 

README.md

@@ -1,6 +1,6 @@
 # MoodleRb
 
-[![Build](https://github.com/jobready/moodle-rb/actions/workflows/build.yml/badge.svg)](https://github.com/jobready/moodle-rb/actions/workflows/build.yml) 
+[![Build](https://github.com/jobready/moodle-rb/actions/workflows/build.yml/badge.svg)](https://github.com/jobready/moodle-rb/actions/workflows/build.yml)
 
 [![Gem Version](https://badge.fury.io/rb/moodle_rb.svg)](https://badge.fury.io/rb/moodle_rb)
 
@@ -49,6 +49,10 @@ Show a course
 moodle.courses.show(course_id)
 ```
 
+```
+moodle.courses.show(course_ids) # Example: moodle.courses.show(1234, 234, ...)
+```
+
 Delete a course
 ```
 moodle.courses.destroy(course_id)

lib/moodle_rb/courses.rb

@@ -69,22 +69,24 @@ def create(params)
       response.parsed_response.first
     end
 
-    def show(id)
+    def show(*id)
+      ids = id.map.with_index do |item, idx|
+        [idx.to_s, item]
+      end.to_h
+
       response = self.class.post(
         '/webservice/rest/server.php',
         {
           :query => query_hash('core_course_get_courses', token),
           :body => {
             :options => {
-              :ids => {
-                '0' => id
-              }
+              ids: ids
             }
           }
         }.merge(query_options)
       )
       check_for_errors(response)
-      response.parsed_response.first
+      id.count > 1 ? response.parsed_response : response.parsed_response.first
     end
 
     def destroy(id)

lib/moodle_rb/version.rb

@@ -1,5 +1,5 @@
 module MoodleRb
-  VERSION = '2.1.5' unless defined?(self::VERSION)
+  VERSION = '2.2.0' unless defined?(self::VERSION)
 
   def self.version
     VERSION

moodle_rb.gemspec

@@ -11,12 +11,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/jobready/moodle-rb'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = Dir["lib/**/*"] + %w(README.md LICENSE Rakefile)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = Dir['spec/**/*']
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'rake', '~> 0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 1.24.6'

spec/cassettes/MoodleRb_Courses/_show/when_passing_array_of_ids/.yml

@@ -0,0 +1,38 @@
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:8888/moodle28/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_course_get_courses&wstoken=60fc9c9415259404795094957e4ab32f
+    body:
+      string: options[ids][0]=1&options[ids][1]=2
+    headers: {}
+
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Powered-By:
+      - PHP/5.6.2
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Server:
+      - Apache/2.2.29 (Unix) mod_fastcgi/2.4.6 mod_wsgi/3.4 Python/2.7.8 PHP/5.6.2 mod_ssl/2.2.29 OpenSSL/0.9.8zd DAV/2 mod_perl/2.0.8 Perl/v5.20.0
+      Pragma:
+      - no-cache
+      Accept-Ranges:
+      - none
+      Content-Type:
+      - application/json
+      Date:
+      - Sun, 12 Apr 2015 00:51:46 GMT
+      Content-Length:
+      - "707"
+      Cache-Control:
+      - private, must-revalidate, pre-check=0, post-check=0, max-age=0
+    body:
+      string: "[{\"id\":1,\"shortname\":\"Moodle 2.8\",\"categoryid\":0,\"categorysortorder\":1,\"fullname\":\"Moodle 2.8\",\"idnumber\":\"\",\"summary\":\"<h2 style=\\\"font-size: large;\\\">Moodle<span style=\\\"font-size: 1.8em; color: red;\\\">4<\\/span>Mac<\\/h2>\\r\\n<p>This package for OS&nbsp;X comes with Moodle&nbsp;2.8.5+ and MAMP 3.0.7.3.&nbsp;We hope you will like it!<\\/p>\",\"summaryformat\":1,\"format\":\"site\",\"showgrades\":1,\"newsitems\":3,\"startdate\":0,\"numsections\":1,\"maxbytes\":0,\"showreports\":0,\"visible\":1,\"groupmode\":0,\"groupmodeforce\":0,\"defaultgroupingid\":0,\"timecreated\":1405375287,\"timemodified\":1426316351,\"enablecompletion\":0,\"completionnotify\":0,\"lang\":\"\",\"forcetheme\":\"\",\"courseformatoptions\":[{\"name\":\"numsections\",\"value\":1}]}, {\"id\":2,\"shortname\":\"Moodle 2.8\",\"categoryid\":0,\"categorysortorder\":1,\"fullname\":\"Moodle 2.8\",\"idnumber\":\"\",\"summary\":\"<h2 style=\\\"font-size: large;\\\">Moodle<span style=\\\"font-size: 1.8em; color: red;\\\">4<\\/span>Mac<\\/h2>\\r\\n<p>This package for OS&nbsp;X comes with Moodle&nbsp;2.8.5+ and MAMP 3.0.7.3.&nbsp;We hope you will like it!<\\/p>\",\"summaryformat\":1,\"format\":\"site\",\"showgrades\":1,\"newsitems\":3,\"startdate\":0,\"numsections\":1,\"maxbytes\":0,\"showreports\":0,\"visible\":1,\"groupmode\":0,\"groupmodeforce\":0,\"defaultgroupingid\":0,\"timecreated\":1405375287,\"timemodified\":1426316351,\"enablecompletion\":0,\"completionnotify\":0,\"lang\":\"\",\"forcetheme\":\"\",\"courseformatoptions\":[{\"name\":\"numsections\",\"value\":1}]}]"
+    http_version:
+  recorded_at: Sun, 12 Apr 2015 00:51:46 GMT
+recorded_with: VCR 2.9.3

spec/lib/moodle_rb/courses_spec.rb

@@ -86,11 +86,24 @@
     :match_requests_on => [:path], :record => :once
   } do
     let(:id) { 1 }
-    let(:result) { course_moodle_rb.show(id) }
 
-    specify do
-      expect(result).to be_a Hash
-      expect(result['id']).to eq 1
+    context 'when passing single id' do
+      let(:result) { course_moodle_rb.show(id) }
+
+      specify do
+        expect(result).to be_a Hash
+        expect(result['id']).to eq 1
+      end
+    end
+
+    context 'when passing array of ids' do
+      let(:result) { course_moodle_rb.show(1, 2) }
+
+      specify do
+        expect(result).to be_a Array
+        expect(result[0]['id']).to eq 1
+        expect(result[1]['id']).to eq 2
+      end
     end
 
     context 'when using invalid token' do