lms-api 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31cd2969fb85d7b0594f8a168c76104f521e9705
-  data.tar.gz: 85d5ea9a8c6cd17c6f0e9d902eb340dabcac9114
+  metadata.gz: 32377199608ae195be9f19c7f77dd605ead04f14
+  data.tar.gz: b85788d8c68781b28c35469ae45ff9d081315f72
 SHA512:
-  metadata.gz: 7f5bd2e2aaec03c9ff5bf15927009117706954a6680793408147f9fbe701ff0007edcd4fa3ece85fbc84a812f5f508ffa5e6e98b6151053802b316e45a9d1dd4
-  data.tar.gz: abda015f052117b144ae795d0d8626ae143390c16ecdef7c35d33fc350a8b8f6eeffcfe679e89f387efaa943c1e53c445367a6cca1d65d7b4af37ed4e42094a1
+  metadata.gz: a7240adaed7b9ff946afddafa74134b034b2325d8d0bd024b1e5ad0ff0fa1e95db78e7bbe2500c3f260dd08b493b87dd47473ae0cc84e4fffa642250d4cef212
+  data.tar.gz: 9a4d9bb8f56e159a3db8fe391dfa8eedd1f673b37abf51cf0a2a0caf34cbe625b930868dc05789bf30d978fee7493e099a2ffab90cb71e7b1354f58b665b97ee

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2016 Atomic Jolt
+Copyright 2016-2017 Atomic Jolt
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,25 +1,25 @@
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'LMS API'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "LMS API"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-load './lib/tasks/canvas_api.rake'
+load "./lib/tasks/canvas_api.rake"
 
 Bundler::GemHelper.install_tasks
 
 begin
-  require 'rspec/core/rake_task'
+  require "rspec/core/rake_task"
   RSpec::Core::RakeTask.new(:spec)
 
   task default: :spec

data/lib/lms/canvas.rb

@@ -3,6 +3,7 @@ require "active_support"
 require "active_support/core_ext/object/blank"
 require "active_support/core_ext/object/to_query"
 require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/hash/indifferent_access"
 
 require "lms/canvas_urls"
 
@@ -33,7 +34,7 @@ module LMS
     # set up a default auth callback. It assumes that #auth_state_model
     # is set. If #auth_state_model will not be set, the client app must
     # define a custom on_auth callback.
-    self.on_auth do |api|
+    on_auth do |api|
       api.lock do |record|
         if record.token == api.authentication.token
           record.update token: api.refresh_token
@@ -52,18 +53,24 @@ module LMS
       @per_page = 100
       @lms_uri = lms_uri
       @refresh_token_options = refresh_token_options
-      if authentication.is_a?(String)
-        @authentication = OpenStruct.new(token: authentication)
-      else
-        @authentication = authentication
-      end
+      @authentication = if authentication.is_a?(String)
+                          OpenStruct.new(token: authentication)
+                        else
+                          authentication
+                        end
 
       if refresh_token_options.present?
         required_options = [:client_id, :client_secret, :redirect_uri, :refresh_token]
         extra_options = @refresh_token_options.keys - required_options
-        raise InvalidRefreshOptionsException, "Invalid option(s) provided: #{extra_options.join(', ')}" unless extra_options.length == 0
+        unless extra_options.empty?
+          raise InvalidRefreshOptionsException,
+                "Invalid option(s) provided: #{extra_options.join(', ')}"
+        end
         missing_options = required_options - @refresh_token_options.keys
-        raise InvalidRefreshOptionsException, "Missing required option(s): #{missing_options.join(', ')}" unless missing_options.length == 0
+        unless missing_options.empty?
+          raise InvalidRefreshOptionsException,
+                "Missing required option(s): #{missing_options.join(', ')}"
+        end
       end
     end
 
@@ -93,12 +100,10 @@ module LMS
     def full_url(api_url, use_api_prefix = true)
       if api_url[0...4] == "http"
         api_url
+      elsif use_api_prefix
+        "#{@lms_uri}/api/v1/#{api_url}"
       else
-        if use_api_prefix
-          "#{@lms_uri}/api/v1/#{api_url}"
-        else
-          "#{@lms_uri}/#{api_url}"
-        end
+        "#{@lms_uri}/#{api_url}"
       end
     end
 
@@ -141,7 +146,7 @@ module LMS
     def api_get_blocks_request(api_url, additional_headers = {})
       connector = api_url.include?("?") ? "&" : "?"
       next_url = "#{api_url}#{connector}per_page=#{@per_page}"
-      while next_url do
+      while next_url
         result = api_get_request(next_url, additional_headers)
         yield result
         next_url = get_next_url(result.headers["link"])
@@ -163,7 +168,9 @@ module LMS
       }.merge(@refresh_token_options)
       url = full_url("login/oauth2/token", false)
       result = HTTParty.post(url, headers: headers, body: payload)
-      raise LMS::Canvas::RefreshTokenFailedException, api_error(result) unless [200, 201].include?(result.response.code.to_i)
+      unless [200, 201].include?(result.response.code.to_i)
+        raise LMS::Canvas::RefreshTokenFailedException, api_error(result)
+      end
       result["access_token"]
     end
 
@@ -187,7 +194,7 @@ module LMS
 
     def get_next_url(link)
       return nil if link.blank?
-      if url = link.split(",").find{ |l| l.split(";")[1].strip == 'rel="next"' }
+      if url = link.split(",").detect { |l| l.split(";")[1].strip == 'rel="next"' }
         url.split(";")[0].gsub(/[\<\>\s]/, "")
       end
     end
@@ -199,9 +206,10 @@ module LMS
       payload = {} if payload.blank?
       payload_json = payload.is_a?(String) ? payload : payload.to_json
       parsed_payload = payload.is_a?(String) ? JSON.parse(payload) : payload
+      parsed_payload = parsed_payload.with_indifferent_access
 
       method = LMS::CANVAS_URLs[type][:method]
-      url = LMS::Canvas.lms_url(type, params, payload)
+      url = LMS::Canvas.lms_url(type, params, parsed_payload)
 
       case method
       when "GET"
@@ -250,32 +258,36 @@ module LMS
 
       # Make sure all required parameters are present
       missing = []
-      if !self.ignore_required(type)
-        parameters.find_all{|p| p["required"]}.map{|p| p["name"]}.each do |p|
+      if !ignore_required(type)
+        parameters.select { |p| p["required"] }.map { |p| p["name"] }.each do |p|
           if p.include?("[") && p.include?("]")
-            parts = p.split('[')
+            parts = p.split("[")
             parent = parts[0].to_sym
             child = parts[1].gsub("]", "").to_sym
             missing << p unless (params[parent].present? && params[parent][child].present?) ||
-                                (payload.present? && payload[parent].present? && payload[parent][child].present?)
+                (payload.present? && payload[parent].present? && payload[parent][child].present?)
           else
-            missing << p unless params[p.to_sym].present? || (payload.present? && !payload.is_a?(String) && payload[p.to_sym].present?)
+            missing << p unless params[p.to_sym].present? ||
+                (payload.present? && !payload.is_a?(String) && payload[p.to_sym].present?)
           end
         end
       end
 
-      if missing.length > 0
-        raise LMS::Canvas::MissingRequiredParameterException, "Missing required parameter(s): #{missing.join(', ')}"
+      if !missing.empty?
+        raise LMS::Canvas::MissingRequiredParameterException,
+              "Missing required parameter(s): #{missing.join(', ')}"
       end
 
       # Generate the uri. Only allow path parameters
       uri_proc = endpoint[:uri]
-      path_parameters = parameters.find_all{|p| p["paramType"] == "path"}.map{|p| p["name"].to_sym}
+      path_parameters = parameters.select { |p| p["paramType"] == "path" }.
+        map { |p| p["name"].to_sym }
       args = params.slice(*path_parameters).symbolize_keys
       uri = args.blank? ? uri_proc.call : uri_proc.call(**args)
 
       # Generate the query string
-      query_parameters = parameters.find_all{ |p| p["paramType"] == "query" }.map{ |p| p["name"].to_sym }
+      query_parameters = parameters.select { |p| p["paramType"] == "query" }.
+        map { |p| p["name"].to_sym }
 
       # always allow paging parameters
       query_parameters << :per_page
@@ -297,9 +309,12 @@ module LMS
     # Get all accounts including sub accounts
     def all_accounts
       all = []
-      self.proxy("LIST_ACCOUNTS", {}, nil, true).each do |account|
+      proxy("LIST_ACCOUNTS", {}, nil, true).each do |account|
         all << account
-        sub_accounts = self.proxy("GET_SUB_ACCOUNTS_OF_ACCOUNT", {account_id: account['id']}, nil, true)
+        sub_accounts = proxy("GET_SUB_ACCOUNTS_OF_ACCOUNT",
+                             { account_id: account["id"] },
+                             nil,
+                             true)
         all = all.concat(sub_accounts)
       end
       all
@@ -309,28 +324,28 @@ module LMS
     # Exceptions
     #
 
-    class Exception < RuntimeError
+    class CanvasException < RuntimeError
     end
 
-    class RefreshTokenRequired < Exception
+    class RefreshTokenRequired < CanvasException
     end
 
-    class InvalidRefreshOptionsException < Exception
+    class InvalidRefreshOptionsException < CanvasException
     end
 
-    class RefreshTokenFailedException < Exception
+    class RefreshTokenFailedException < CanvasException
     end
 
-    class InvalidAPIRequestException < Exception
+    class InvalidAPIRequestException < CanvasException
     end
 
-    class InvalidAPIRequestFailedException < Exception
+    class InvalidAPIRequestFailedException < CanvasException
     end
 
-    class InvalidAPIMethodRequestException < Exception
+    class InvalidAPIMethodRequestException < CanvasException
     end
 
-    class MissingRequiredParameterException < Exception
+    class MissingRequiredParameterException < CanvasException
     end
 
   end

data/lib/lms/version.rb

@@ -1,3 +1,3 @@
 module LMS
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

data/lib/tasks/canvas_api.rake

@@ -16,11 +16,11 @@ namespace :canvas do
           graphql_primitive(type, property["format"])
         when "array"
           begin
-            if property["items"]["$ref"]
-              type = property["items"]["$ref"]
-            else
-              type = graphql_primitive(property["items"]["type"], property["items"]["format"])
-            end
+            type = if property["items"]["$ref"]
+                     property["items"]["$ref"]
+                   else
+                     graphql_primitive(property["items"]["type"], property["items"]["format"])
+                   end
           rescue
             type = "GraphQLString"
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lms-api
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Atomic Jolt
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-22 00:00:00.000000000 Z
+date: 2017-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -82,6 +82,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
 description: Wrapper for the Instructure Canvas API
 email:
 - jamis@jamisbuck.org
@@ -130,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Wrapper for the Instructure Canvas API