moodle-api 1.3 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e5edfc4de74aa0771bf2197cc68bdda8d33ce20
-  data.tar.gz: 23aa1db0b94479fc0e4938fb2b588b61e442d45d
+  metadata.gz: a71818e7b85063b4316df6fa56edb7d7ef693b71
+  data.tar.gz: cbca9d7f5335f6a9c767cec223ebd79b3366ab7e
 SHA512:
-  metadata.gz: 8e3966da9448fedc2e7d545b288769360993cb1f0e841cab86951f0c53288a343178b24c0c6aeb9b07f526d5bb74a7778b229e9267d8a3c821f497dbd24aa1d8
-  data.tar.gz: 8b70a1714bcafe49ba93960695bb4c8f11d6c7cea0b9145eb091c04093555f7018cff7d2d28c962e32e23848144b2cbcf9cea07386f8bbdada43480ae5d0b485
+  metadata.gz: 1109adec53160b999567f6184e9f2a6c8c896922e5aa90bf299585aa4cb349cd1027d805199e145c721031a0faa5296780c91d3e5ca87776e97bb78c9dc0ad78
+  data.tar.gz: 9d9663bb2e17dfcc5ea94373dee096f794ff2c8914d09e7ad30630ad876c144ebe6b27a4945359bbda8831679925e49792d52b0db3db1d67e209dd2f05fadadb

data/.codeclimate.yml

@@ -0,0 +1,22 @@
+# Under the engines key, you can configure which engines will analyze your repo.
+# Each key is an engine name. For each value, you need to specify enabled: true
+# to enable the engine as well as any other engines-specific configuration.
+engines:
+# to turn on an engine, add it here and set enabled to `true`
+# to turn off an engine, set enabled to `false` or remove it
+  rubocop:
+    enabled: true
+# Engines can analyze files and report issues on them, but you can separately
+# decide which files will receive ratings based on those issues. This is
+# specified by path patterns under the ratings key.
+ratings:
+  paths:
+  - app/**
+  - lib/**
+  - "**.rb"
+#   - "**.go"
+# You can globally exclude files from being analyzed by any engine using the
+# exclude_paths key.
+exclude_paths:
+- spec/**
+- vendor/**

data/.rubocop.yml

@@ -0,0 +1,9 @@
+require: rubocop-rspec
+
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'Guardfile'

data/.rubocop_todo.yml

@@ -0,0 +1,16 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-07-16 19:09:22 +0200 using RuboCop version 0.32.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 9
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 104
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/BlockComments:
+  Enabled: false

data/Guardfile

@@ -24,8 +24,8 @@
 #  * zeus: 'zeus rspec' (requires the server to be started separately)
 #  * 'just' rspec: 'rspec'
 
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
   # Feel free to open issues for suggestions and improvements
@@ -65,6 +65,6 @@ guard :rspec, cmd: "bundle exec rspec" do
   # Turnip features and steps
   watch(%r{^spec/acceptance/(.+)\.feature$})
   watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
-    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
   end
 end

data/README.md

@@ -42,12 +42,10 @@ Moodle::Api.configuration.host = 'http://my_moodle_instance.com'
 Moodle::Api.configuration.token = 'mytoken'
 
 # Pass options hash to configure
-Moodle::Api.configure({host: 'http://my_moodle_instance.com',
-                  token: 'mytoken'})
+Moodle::Api.configure({host: 'http://my_moodle_instance.com', token: 'mytoken'})
 
 # The client can also be instantiated and used.
-client = Moodle:Client.new({host: 'http://my_moodle_instance.com',
-                            token: 'mytoken'})
+client = Moodle:Client.new({host: 'http://my_moodle_instance.com', token: 'mytoken'})
 
 client.make_request(:function_name_here, my_params)
 ```
@@ -67,8 +65,7 @@ New functions created in Moodle will automatically be available in the gem.
 ### Example
 
 ```ruby
-Moodle::Api.configure({host: 'http://my_moodle_instance.com',
-                  token: 'mytoken'})
+Moodle::Api.configure({host: 'http://my_moodle_instance.com', token: 'mytoken'})
 
 params = { 'criteria[0][key]' => 'firstname', 'criteria[0][value]' => 'Jon' }
 
@@ -79,10 +76,10 @@ Moodle::Api.core_user_get_users(params)
 Moodle uses token authentication, but sometimes you might not have a token. Users are able to generate tokens automatically when calling services using basic authentication.
 ```ruby
 Moodle::Api.configure({host: 'http://my_moodle_instance.com',
-                  service: 'my_external_service', # ensure you include the shortname of the external service
-                  username: 'jonsnow',
-                  password: 'defendthewall'})
-                  
+                       service: 'my_external_service', # ensure you include the shortname of the external service
+                       username: 'jonsnow',
+                       password: 'defendthewall'})
+
 params = { 'criteria[0][key]' => 'firstname', 'criteria[0][value]' => 'Jon' }
 
 Moodle::Api.core_user_get_users(params)
@@ -114,11 +111,12 @@ Note: regenerating vcr cassettes, some data will change which will break the tes
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/moodle/fork )
+1. Fork it ( https://github.com/[my-github-username]/moodle-api/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+6. Ensure your stuff is rubocop'd
 
 I am always keen to learn so please feel free to create an issue with code reviews, suggestions and possible refactorings.
 
@@ -126,7 +124,5 @@ I am always keen to learn so please feel free to create an issue with code revie
 
 - Add additional protocols
 - Make cassettes easily rerunnable - will require a parser for the response to remove dynamic data or a funky regex in the specs.
+- Moodle web services require you to know how the Moodle API expects params. They are pretty messy. It would be nice to leverage hashes and arrays and then parse them to into what moodle expects.
 
-## Warning
-
-This gem is still under heavy development.

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 task :console do
-  exec "pry -r moodle -I ./lib"
+  exec 'pry -r moodle -I ./lib'
 end

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "moodle"
+require 'bundler/setup'
+require 'moodle'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/fixtures/vcr_cassettes/external_service/invalid_service.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users_invalid&wstoken=072556801bf07076fff6bff2a463b7c5
+    uri: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users_invalid&wstoken=mytoken
     body:
       encoding: US-ASCII
       string: ''
@@ -43,6 +43,6 @@ http_interactions:
         * FROM {external_functions} WHERE name = ?\n[array (\n  0 => ''core_user_get_users_invalid'',\n)]"}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users_invalid&wstoken=072556801bf07076fff6bff2a463b7c5
+      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users_invalid&wstoken=mytoken
   recorded_at: Wed, 01 Jul 2015 12:33:57 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/external_service/valid_service.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=072556801bf07076fff6bff2a463b7c5
+    uri: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=mytoken
     body:
       encoding: US-ASCII
       string: ''
@@ -56,6 +56,6 @@ http_interactions:
         names checked","shortname":"certificatenameschecked"}],"preferences":[{"name":"auth_manual_passwordupdatetime","value":"1434626773"},{"name":"block7hidden","value":"0"},{"name":"block9hidden","value":"0"},{"name":"docked_block_instance_7","value":"0"},{"name":"docked_block_instance_9","value":"0"},{"name":"email_bounce_count","value":"0"},{"name":"email_send_count","value":"41"},{"name":"filepicker_recentlicense","value":"allrightsreserved"},{"name":"filepicker_recentrepository","value":"7"},{"name":"htmleditor","value":""},{"name":"login_failed_count_since_success","value":"7"},{"name":"message_beepnewmessage","value":"0"},{"name":"message_blocknoncontacts","value":"0"},{"name":"message_provider_enrol_manual_expiry_notification_loggedin","value":"email"},{"name":"message_provider_enrol_manual_expiry_notification_loggedoff","value":"email"},{"name":"message_provider_enrol_self_expiry_notification_loggedin","value":"email"},{"name":"message_provider_enrol_self_expiry_notification_loggedoff","value":"email"},{"name":"message_provider_mod_assign_assign_notification_loggedin","value":"email"},{"name":"message_provider_mod_assign_assign_notification_loggedoff","value":"email"},{"name":"message_provider_mod_forum_posts_loggedin","value":"email"},{"name":"message_provider_mod_forum_posts_loggedoff","value":"email"},{"name":"message_provider_mod_lesson_graded_essay_loggedin","value":"email"},{"name":"message_provider_mod_lesson_graded_essay_loggedoff","value":"email"},{"name":"message_provider_mod_quiz_attempt_overdue_loggedin","value":"email"},{"name":"message_provider_mod_quiz_attempt_overdue_loggedoff","value":"email"},{"name":"message_provider_mod_quiz_confirmation_loggedin","value":"email"},{"name":"message_provider_mod_quiz_confirmation_loggedoff","value":"email"},{"name":"message_provider_mod_quiz_submission_loggedin","value":"email"},{"name":"message_provider_mod_quiz_submission_loggedoff","value":"email"},{"name":"message_provider_moodle_availableupdate_loggedin","value":"email"},{"name":"message_provider_moodle_availableupdate_loggedoff","value":"email"},{"name":"message_provider_moodle_backup_loggedin","value":"email"},{"name":"message_provider_moodle_backup_loggedoff","value":"email"},{"name":"message_provider_moodle_badgecreatornotice_loggedin","value":"none"},{"name":"message_provider_moodle_badgecreatornotice_loggedoff","value":"email"},{"name":"message_provider_moodle_badgerecipientnotice_loggedin","value":"popup"},{"name":"message_provider_moodle_badgerecipientnotice_loggedoff","value":"popup,email"},{"name":"message_provider_moodle_courserequestapproved_loggedin","value":"email"},{"name":"message_provider_moodle_courserequestapproved_loggedoff","value":"email"},{"name":"message_provider_moodle_courserequested_loggedin","value":"email"},{"name":"message_provider_moodle_courserequested_loggedoff","value":"email"},{"name":"message_provider_moodle_courserequestrejected_loggedin","value":"email"},{"name":"message_provider_moodle_courserequestrejected_loggedoff","value":"email"},{"name":"message_provider_moodle_errors_loggedin","value":"email"},{"name":"message_provider_moodle_errors_loggedoff","value":"email"},{"name":"message_provider_moodle_instantmessage_loggedin","value":"popup"},{"name":"message_provider_moodle_instantmessage_loggedoff","value":"popup,email"},{"name":"message_provider_moodle_notices_loggedin","value":"email"},{"name":"message_provider_moodle_notices_loggedoff","value":"email"},{"name":"userselector_autoselectunique","value":"0"},{"name":"userselector_optionscollapsed","value":"0"},{"name":"userselector_preserveselected","value":"1"},{"name":"userselector_searchanywhere","value":"0"},{"name":"_lastloaded","value":1435753952}]}],"warnings":[]}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=072556801bf07076fff6bff2a463b7c5
+      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=mytoken
   recorded_at: Wed, 01 Jul 2015 12:32:32 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/external_service/valid_service_empty_array_response.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://my_moodle_instance.com/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=local_getsmarter_get_quiz_grades&wstoken=072556801bf07076fff6bff2a463b7c5&courseid=92
+    uri: http://my_moodle_instance.com/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=local_getsmarter_get_quiz_grades&wstoken=mytoken&courseid=92
     body:
       encoding: US-ASCII
       string: ''
@@ -41,6 +41,6 @@ http_interactions:
       string: "[]"
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=local_getsmarter_get_quiz_grades&wstoken=072556801bf07076fff6bff2a463b7c5&courseid=92
+      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=local_getsmarter_get_quiz_grades&wstoken=mytoken&courseid=92
   recorded_at: Thu, 02 Jul 2015 07:10:48 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/external_service/valid_service_not_external.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=072556801bf07076fff6bff2a463b7c5
+    uri: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=mytoken
     body:
       encoding: US-ASCII
       string: ''
@@ -54,6 +54,6 @@ http_interactions:
         Plugins > Web services > External services and Manage tokens."}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=072556801bf07076fff6bff2a463b7c5
+      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=mytoken
   recorded_at: Wed, 01 Jul 2015 12:44:52 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/token_service/token_service.yml

@@ -39,7 +39,7 @@ http_interactions:
       - application/json; charset=utf-8
     body:
       encoding: UTF-8
-      string: '{"token":"072556801bf07076fff6bff2a463b7c5"}'
+      string: '{"token":"mytoken"}'
     http_version: '1.1'
     adapter_metadata:
       effective_url: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=phoenix_integration

data/lib/moodle/api.rb

@@ -12,18 +12,21 @@ rescue
 end
 
 module Moodle
+  # Handles instantiating the client and determining how
+  # method calls should be delegated to the client
   module Api
     class << self
-      def method_missing method, *args, &block
+      def method_missing(method, *args, &block)
         if client.respond_to?(method)
           client.send(method, *args, &block)
         else
-          client.make_request(method, args.first) # assume method name is moodle external service
+          # assume method name is moodle external service
+          client.make_request(method, args.first)
         end
       end
 
-      def respond_to?(method, include_all=false)
-        return client.respond_to?(method, include_all) || super
+      def respond_to?(method, include_all = false)
+        client.respond_to?(method, include_all) || super
       end
 
       def client

data/lib/moodle/api/client.rb

@@ -1,14 +1,16 @@
 module Moodle
   module Api
+    # The client is responsible for making requests
+    # and delegating config setup to configuration
     class Client
       attr_reader :web_service_name, :filter_params
-      attr_writer :token_service
+      attr_writer :token_service, :configuration
 
-      def initialize options = {}
+      def initialize(options = {})
         configure(options)
       end
 
-      def make_request web_service_name, filter_params = {}
+      def make_request(web_service_name, filter_params = {})
         @web_service_name = web_service_name
         @filter_params = filter_params
 
@@ -17,14 +19,14 @@ module Moodle
 
       def request_params
         {
-          params: filter_params.merge!({ moodlewsrestformat: configuration.format,
-                                         wsfunction: web_service_name,
-                                         wstoken: configuration.token }),
+          params: filter_params.merge!(moodlewsrestformat: configuration.format,
+                                       wsfunction: web_service_name,
+                                       wstoken: configuration.token),
           headers: { 'Accept' => 'json' }
         }
       end
 
-      def configure options = {}, &block
+      def configure(options = {}, &block)
         configuration.configure(options, &block)
       end
 

data/lib/moodle/api/configuration.rb

@@ -1,13 +1,15 @@
 module Moodle
   module Api
+    # Handles all configuration settings required
+    # to interaction with a Moodle API
     class Configuration
       attr_writer :token_service
       attr_accessor :host,
-        :username,
-        :password,
-        :service,
-        :token,
-        :format
+                    :username,
+                    :password,
+                    :service,
+                    :token,
+                    :format
 
       DEFAULT_FORMAT = :json
 
@@ -15,7 +17,7 @@ module Moodle
 
       DEFAULT_TOKEN_API_URL = '/login/token.php'
 
-      def initialize options = {}
+      def initialize(options = {})
         @format = DEFAULT_FORMAT
 
         configure(options)
@@ -38,7 +40,7 @@ module Moodle
         "#{host}#{DEFAULT_TOKEN_API_URL}"
       end
 
-      def configure options = {}, &block
+      def configure(options = {}, &block)
         options.each { |key, value| instance_variable_set("@#{key}", value) }
         block.call(self) if block_given?
       end

data/lib/moodle/api/request.rb

@@ -3,10 +3,14 @@ require 'json'
 
 module Moodle
   module Api
+    # Handles making the request to the Moodle API and interpreting the
+    # results. The Moodle API is not consistent in the way it returns
+    # responses so the type of response is determined, successful responses
+    # are returned, failures are parsed and raised in a generic fashion.
     class Request
       attr_reader :response
 
-      def post path,  options = {}
+      def post(path,  options = {})
         @response = Typhoeus.post(path, options)
         resolve_response if response.success?
       end
@@ -19,9 +23,9 @@ module Moodle
 
       def request_raised_exception?
         if external_services_api_exception?
-          raise MoodleError, response_body["message"]
+          fail MoodleError, response_body['message']
         elsif token_service_api_exception?
-          raise MoodleError, response_body["error"]
+          fail MoodleError, response_body['error']
         end
       end
 
@@ -39,11 +43,9 @@ module Moodle
 
       # API calls that return null are considered successful
       def response_body
-        begin
-          JSON.parse(response.body)
-        rescue JSON::ParserError => e
-          response.body
-        end
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        response.body
       end
     end
   end

data/lib/moodle/api/token_generator.rb

@@ -1,14 +1,20 @@
 module Moodle
   module Api
+    # Generates tokens using username, password and service
+    # Used for accessing Moodle API
     class TokenGenerator
       attr_reader :configuration
 
-      def initialize configuration
+      def initialize(configuration)
         @configuration = configuration
       end
 
       def call
-        raise ArgumentError, 'Username and password are required to generate a token' if raise_token_exception?
+        if raise_token_exception?
+          fail ArgumentError,
+               'Username and password are required to generate a token'
+        end
+
         generate_token
       end
 
@@ -17,7 +23,7 @@ module Moodle
       def generate_token
         response = Request.new.post(configuration.token_api_url,
                                     params: request_params,
-                                    headers: { 'Accept' => "json" })
+                                    headers: { 'Accept' => 'json' })
         response['token']
       end
 

data/lib/moodle/api/version.rb

@@ -1,5 +1,8 @@
 module Moodle
+  # Used to determine the current version of the gem
+  # Semantic versioning is used
+  # http://guides.rubygems.org/patterns/#semantic-versioning
   module Api
-    VERSION = "1.3"
+    VERSION = '1.4'
   end
 end

data/moodle-api.gemspec

@@ -4,36 +4,38 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'moodle/api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "moodle-api"
+  spec.name          = 'moodle-api'
   spec.version       = Moodle::Api::VERSION
-  spec.authors       = ["Ryan-Neal Mes"]
-  spec.email         = ["ryan.mes@gmail.com"]
+  spec.authors       = ['Ryan-Neal Mes']
+  spec.email         = ['ryan.mes@gmail.com']
 
-  spec.summary       = %q{Moodle web service API wrapper.}
-  spec.description   = %q{Wraps Moodle API and exposes web services that have been made external.}
-  spec.homepage      = "https://github.com/get-smarter/moodle-api"
-  spec.license       = "MIT"
+  spec.summary       = 'Moodle web service API wrapper.'
+  spec.description   = 'Wraps Moodle API and exposes web services that have been made external.'
+  spec.homepage      = 'https://github.com/get-smarter/moodle-api'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+    fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
 
   spec.add_dependency 'typhoeus'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moodle-api
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '1.4'
 platform: ruby
 authors:
 - Ryan-Neal Mes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -129,8 +157,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
@@ -184,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Moodle web service API wrapper.