moodle_rb 0.0.5

data/spec/lib/moodle_rb/enrolments_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe MoodleRb::Enrolments do
+  let(:url) { ENV['MOODLE_URL'] || 'localhost' }
+  let(:token) { ENV['MOODLE_TOKEN'] || '' }
+  let(:enrolment_moodle_rb) { MoodleRb.new(token, url).enrolments }
+
+  describe '#create', :vcr => {
+    :match_requests_on => [:headers], :record => :once
+  } do
+    let(:params) do
+      {
+        :user_id => 3,
+        :course_id => 8
+      }
+    end
+    let(:result) { enrolment_moodle_rb.create(params) }
+
+    specify do
+      expect(result).to eq true
+    end
+
+    context 'when user or course id is invalid' do
+      let(:params) do
+        {
+          :user_id => 9999,
+          :course_id => 9999
+        }
+      end
+
+      specify do
+        expect{ result }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid parameter value detected'
+        )
+      end
+    end
+  end
+end

data/spec/lib/moodle_rb/error_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe MoodleRb::MoodleError do
+  describe '#new' do
+    let(:response_body) do
+      {
+        'exception' => 'moodle_rb_exception',
+        'errorcode' => 'categoryidnumbertaken',
+        'message' => 'ID number is already used for another category'
+      }
+    end
+    let!(:exception) { MoodleRb::MoodleError.new(response_body) }
+
+    specify do
+      expect(exception.message).to eq 'ID number is already used for another category'
+      expect(exception.code).to eq 'categoryidnumbertaken'
+      expect(exception.response_body).to eq response_body
+    end
+  end
+end

data/spec/lib/moodle_rb/grades_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe MoodleRb::Grades do
+  let(:url) { ENV['MOODLE_URL'] || 'localhost' }
+  let(:token) { ENV['MOODLE_TOKEN'] || '' }
+  let(:grade_moodle_rb) { MoodleRb.new(token, url).grades }
+
+  describe '#by_assignment', :vcr => {
+    :match_requests_on => [:body, :headers], :record => :once
+  } do
+    let(:assignment_id) { 1 }
+    let(:result) { grade_moodle_rb.by_assignment(assignment_id) }
+
+    specify do
+      expect(result).to be_a Array
+      expect(result.first).to have_key 'assignmentid'
+    end
+  end
+
+  describe '#by_course', :vcr => {
+    :match_requests_on => [:headers], :record => :once
+  } do
+    let(:course_id) { 8 }
+    let(:user_ids) { 5 }
+    let(:result) { grade_moodle_rb.by_course(course_id, user_ids) }
+
+    specify do
+      expect(result).to be_a Array
+      expect(result.first).to have_key 'activityid'
+    end
+  end
+end

data/spec/lib/moodle_rb/users_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe MoodleRb::Users do
+  let(:url) { ENV['MOODLE_URL'] || 'localhost' }
+  let(:token) { ENV['MOODLE_TOKEN'] || '' }
+  let(:user_moodle_rb) { MoodleRb.new(token, url).users }
+
+  describe '#create', :vcr => {
+    :match_requests_on => [:headers], :record => :once
+  } do
+    let(:params) do
+      {
+        :username => 'testuser1',
+        :password => 'Password123!',
+        :firstname => 'Austin',
+        :lastname => 'Powers',
+        :email => 'austinp1@jobready.com.au',
+        :idnumber => 'PAUST002'
+      }
+    end
+    let(:result) { user_moodle_rb.create(params) }
+
+    specify do
+      expect(result).to be_a Hash
+      expect(result).to have_key 'username'
+      expect(result['id']).to eq 5
+    end
+
+    context 'when missing required parameters' do
+      let(:params) do
+        {
+          :username => 'testuser1'
+        }
+      end
+
+      specify do
+        expect{ result }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid parameter value detected'
+        )
+      end
+    end
+  end
+
+  describe '#show', :vcr => {
+    :match_requests_on => [:headers], :record => :once
+  } do
+    let(:id) { 5 }
+    let(:result) { user_moodle_rb.show(id) }
+
+    specify do
+      expect(result).to be_a Hash
+      expect(result['id']).to eq 5
+    end
+  end
+
+  describe '#destroy', :vcr => {
+    :match_requests_on => [:headers], :record => :once
+  } do
+    let(:id) { 5 }
+    let(:result) { user_moodle_rb.destroy(id) }
+
+    specify do
+      expect(result).to eq true
+    end
+
+    context 'when id does not exist' do
+      let(:id) { 999 }
+      specify do
+        expect(result).to eq false
+      end
+    end
+  end
+
+  describe '#enrolled_courses', :vcr => {
+    :match_requests_on => [:headers], :record => :once
+  } do
+    let(:user_id) { 3 }
+    let(:result) { user_moodle_rb.enrolled_courses(user_id) }
+    let(:enrolment) { result.first }
+
+    specify do
+      expect(result).to be_a Array
+      expect(enrolment).to have_key 'shortname'
+    end
+  end
+end

data/spec/lib/moodle_rb/utility_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+include MoodleRb::Utility
+
+describe MoodleRb::Utility do
+  describe '#api_array' do
+    let(:result) { api_array(input) }
+
+    context 'when array provided' do
+      let(:output) { {0=>1, 1=>2} }
+      specify { expect(api_array([1, 2])).to eq output }
+    end
+
+    context 'when single value provided' do
+      let(:output) { {0=>1} }
+      specify { expect(api_array(1)).to eq output }
+    end
+
+    context 'when multiple values provided' do
+      let(:output) { {0=>1, 1=>5, 2=>8} }
+      specify { expect(api_array(1, 5, 8)).to eq output }
+    end
+  end
+end

data/spec/lib/moodle_rb_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe MoodleRb do
+  let(:url) { ENV['MOODLE_URL'] || 'localhost' }
+  let(:token) { ENV['MOODLE_TOKEN'] || '' }
+  let(:moodle_rb) { MoodleRb.new(token, url) }
+
+  describe 'new' do
+    specify { expect(moodle_rb).to be_a MoodleRb::Client }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'bundler/setup'
+Bundler.require(:default, :development)
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.filter_run_excluding :perf => true
+  config.order = 'random'
+end
+
+require 'webmock/rspec'
+RSpec.configure do |config|
+  config.before(:each) do
+    WebMock.disable_net_connect!
+  end
+end
+
+require 'vcr'
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end
+
+require File.expand_path('../../lib/moodle_rb.rb', __FILE__)

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification 
+name: moodle_rb
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
+platform: ruby
+authors: 
+- Sam Giffney
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2015-04-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 10
+        - 4
+        version: 0.10.4
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: vcr
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 2
+        - 9
+        version: "2.9"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 11
+        - 0
+        version: 0.11.0
+  type: :runtime
+  version_requirements: *id007
+description: 
+email: 
+- samg@jobready.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/moodle_rb.rb
+- lib/moodle_rb/categories.rb
+- lib/moodle_rb/client.rb
+- lib/moodle_rb/courses.rb
+- lib/moodle_rb/enrolments.rb
+- lib/moodle_rb/error.rb
+- lib/moodle_rb/grades.rb
+- lib/moodle_rb/users.rb
+- lib/moodle_rb/utility.rb
+- lib/moodle_rb/version.rb
+- moodle_rb.gemspec
+- spec/cassettes/MoodleRb_Categories/_create/.yml
+- spec/cassettes/MoodleRb_Categories/_create/when_validation_fails/.yml
+- spec/cassettes/MoodleRb_Categories/_destroy/.yml
+- spec/cassettes/MoodleRb_Categories/_index/.yml
+- spec/cassettes/MoodleRb_Categories/_show/.yml
+- spec/cassettes/MoodleRb_Client/_site_info/when_invalid_token/.yml
+- spec/cassettes/MoodleRb_Client/_site_info/when_valid_token/.yml
+- spec/cassettes/MoodleRb_Courses/_create/.yml
+- spec/cassettes/MoodleRb_Courses/_create/when_validation_fails/.yml
+- spec/cassettes/MoodleRb_Courses/_destroy/.yml
+- spec/cassettes/MoodleRb_Courses/_enrolled_users/.yml
+- spec/cassettes/MoodleRb_Courses/_index/.yml
+- spec/cassettes/MoodleRb_Courses/_show/.yml
+- spec/cassettes/MoodleRb_Enrolments/_create/.yml
+- spec/cassettes/MoodleRb_Enrolments/_create/when_user_or_course_id_is_invalid/.yml
+- spec/cassettes/MoodleRb_Grades/_by_assignment/.yml
+- spec/cassettes/MoodleRb_Grades/_by_course/.yml
+- spec/cassettes/MoodleRb_Users/_create/.yml
+- spec/cassettes/MoodleRb_Users/_create/when_missing_required_parameters/.yml
+- spec/cassettes/MoodleRb_Users/_destroy/.yml
+- spec/cassettes/MoodleRb_Users/_destroy/when_id_does_not_exist/.yml
+- spec/cassettes/MoodleRb_Users/_enrolled_courses/.yml
+- spec/cassettes/MoodleRb_Users/_show/.yml
+- spec/lib/moodle_rb/categories_spec.rb
+- spec/lib/moodle_rb/client_spec.rb
+- spec/lib/moodle_rb/courses_spec.rb
+- spec/lib/moodle_rb/enrolments_spec.rb
+- spec/lib/moodle_rb/error_spec.rb
+- spec/lib/moodle_rb/grades_spec.rb
+- spec/lib/moodle_rb/users_spec.rb
+- spec/lib/moodle_rb/utility_spec.rb
+- spec/lib/moodle_rb_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jobready/moodle-rb
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A Ruby client for the Moodle API
+test_files: 
+- spec/cassettes/MoodleRb_Categories/_create/.yml
+- spec/cassettes/MoodleRb_Categories/_create/when_validation_fails/.yml
+- spec/cassettes/MoodleRb_Categories/_destroy/.yml
+- spec/cassettes/MoodleRb_Categories/_index/.yml
+- spec/cassettes/MoodleRb_Categories/_show/.yml
+- spec/cassettes/MoodleRb_Client/_site_info/when_invalid_token/.yml
+- spec/cassettes/MoodleRb_Client/_site_info/when_valid_token/.yml
+- spec/cassettes/MoodleRb_Courses/_create/.yml
+- spec/cassettes/MoodleRb_Courses/_create/when_validation_fails/.yml
+- spec/cassettes/MoodleRb_Courses/_destroy/.yml
+- spec/cassettes/MoodleRb_Courses/_enrolled_users/.yml
+- spec/cassettes/MoodleRb_Courses/_index/.yml
+- spec/cassettes/MoodleRb_Courses/_show/.yml
+- spec/cassettes/MoodleRb_Enrolments/_create/.yml
+- spec/cassettes/MoodleRb_Enrolments/_create/when_user_or_course_id_is_invalid/.yml
+- spec/cassettes/MoodleRb_Grades/_by_assignment/.yml
+- spec/cassettes/MoodleRb_Grades/_by_course/.yml
+- spec/cassettes/MoodleRb_Users/_create/.yml
+- spec/cassettes/MoodleRb_Users/_create/when_missing_required_parameters/.yml
+- spec/cassettes/MoodleRb_Users/_destroy/.yml
+- spec/cassettes/MoodleRb_Users/_destroy/when_id_does_not_exist/.yml
+- spec/cassettes/MoodleRb_Users/_enrolled_courses/.yml
+- spec/cassettes/MoodleRb_Users/_show/.yml
+- spec/lib/moodle_rb/categories_spec.rb
+- spec/lib/moodle_rb/client_spec.rb
+- spec/lib/moodle_rb/courses_spec.rb
+- spec/lib/moodle_rb/enrolments_spec.rb
+- spec/lib/moodle_rb/error_spec.rb
+- spec/lib/moodle_rb/grades_spec.rb
+- spec/lib/moodle_rb/users_spec.rb
+- spec/lib/moodle_rb/utility_spec.rb
+- spec/lib/moodle_rb_spec.rb
+- spec/spec_helper.rb