lms-api 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cd9d3fda8b686908615d43da2f995cc9293c387
-  data.tar.gz: 6884ba67486fe5df7501ee4fca575ef1f693129c
+  metadata.gz: 12ac6777774b73bce211ffa0619cf743b26a69e4
+  data.tar.gz: e4f2e69442b6f8db3c977011ec7cc3096cc549bf
 SHA512:
-  metadata.gz: e55e6673692a637243852608355d77cd150913b44da9f04c4be4ae99ba4a9caa19a97a71cfde0a1c0dcd6c6c890f27ecced2e577c041008432f7b6b00144c370
-  data.tar.gz: f5b5e700a2d399ef5604425108eda9eb012629a376c87cf78e7946dc5cb0473cb3160a4edc5b9a6184e213c52585374a7c371350f113ad8b7b83abf8889b2ce2
+  metadata.gz: e03f5dae671ec7b94ff0542e359c8caef1c7b00caf2fae2531e9d44fe6a4accaa1de24d076d9a20dc69e65f820ed7be1c9cc2825681f5e54262f8db222acb2aa
+  data.tar.gz: 3c5a656cf724dced157be0138f71c4b4c87db1fc2453cca72bb946bfef270d41a4523177d062cb673d7cc4d0ca198ccb639194cb1db6d4542e3159026069eb3d

data/README.md

@@ -1,4 +1,4 @@
-# LMS::API
+# LMS API
 
 This project provides a wrapper around the Instructure Canvas API.
 
@@ -28,7 +28,7 @@ end
 Then, you tell the gem about this model:
 
 ```ruby
-LMS::API.auth_state_model = Authentication
+LMS::Canvas.auth_state_model = Authentication
 ```
 
 This allows the gem to transparently refresh the token when the token
@@ -38,7 +38,7 @@ to do so in parallel.
 
 ## Usage
 
-To use the API wrapper, instantiate a `LMS::API` instance with the
+To use the API wrapper, instantiate a `LMS::Canvas` instance with the
 url of the LMS instance you want to communicate with, as well as the
 current authentication object, and (optionally) a hash of options to use
 when refreshing the API token.
@@ -48,7 +48,7 @@ Require the gem:
 
 ```ruby
 auth = Authentication.first # or however you are storing global auth state
-api = LMS::API.new("http://your.canvas.instance", auth, 
+api = LMS::Canvas.new("http://your.canvas.instance", auth,
         client_id: "...",
         client_secret: "..."
         redirect_uri: "..."
@@ -67,7 +67,7 @@ params = {
   all_dates: true,
   other_param: "foobar"}
 
-url = LMS::API.lms_url("GET_SINGLE_ASSIGNMENT", params)
+url = LMS::Canvas.lms_url("GET_SINGLE_ASSIGNMENT", params)
 ```
 
 Once you have the URL, you can send the request by using `api_*_request`

data/lib/lms/canvas.rb

@@ -7,7 +7,7 @@ require "active_support/core_ext/hash/keys"
 require "lms/canvas_urls"
 
 module LMS
-  class API
+  class Canvas
 
     # a model that encapsulates authentication state. By default, it
     # is nil, but it may be set to any object that responds to:
@@ -151,7 +151,7 @@ module LMS
     def refreshably
       result = yield
       check_result(result)
-    rescue LMS::API::RefreshTokenRequired => ex
+    rescue LMS::Canvas::RefreshTokenRequired => ex
       raise ex if @refresh_token_options.blank?
       @authentication = @@on_auth.call(self)
       retry
@@ -163,7 +163,7 @@ module LMS
       }.merge(@refresh_token_options)
       url = full_url("login/oauth2/token", false)
       result = HTTParty.post(url, headers: headers, body: payload)
-      raise LMS::API::RefreshTokenFailedException, api_error(result) unless [200, 201].include?(result.response.code.to_i)
+      raise LMS::Canvas::RefreshTokenFailedException, api_error(result) unless [200, 201].include?(result.response.code.to_i)
       result["access_token"]
     end
 
@@ -173,10 +173,10 @@ module LMS
       return result if [200, 201].include?(code)
 
       if code == 401 && result.headers["www-authenticate"] == 'Bearer realm="canvas-lms"'
-        raise LMS::API::RefreshTokenRequired
+        raise LMS::Canvas::RefreshTokenRequired
       end
 
-      raise LMS::API::InvalidAPIRequestException, api_error(result)
+      raise LMS::Canvas::InvalidAPIRequestException, api_error(result)
     end
 
     def api_error(result)
@@ -198,7 +198,7 @@ module LMS
       }
 
       method = LMS::CANVAS_URLs[type][:method]
-      url = LMS::API.lms_url(type, params, payload)
+      url = LMS::Canvas.lms_url(type, params, payload)
       payload_json = payload.to_json
 
       case method
@@ -219,15 +219,15 @@ module LMS
       when "DELETE"
         api_delete_request(url, additional_headers)
       else
-        raise LMS::API::InvalidAPIMethodRequestException "Invalid method type: #{method}"
+        raise LMS::Canvas::InvalidAPIMethodRequestException "Invalid method type: #{method}"
       end
 
-    rescue LMS::API::InvalidAPIRequestException => ex
+    rescue LMS::Canvas::InvalidAPIRequestException => ex
       error = ex.to_s
       error << "API Request Url: #{url} \n"
       error << "API Request Params: #{params} \n"
       error << "API Request Payload: #{payload} \n"
-      new_ex = LMS::API::InvalidAPIRequestFailedException.new(error)
+      new_ex = LMS::Canvas::InvalidAPIRequestFailedException.new(error)
       new_ex.set_backtrace(ex.backtrace)
       raise new_ex
     end
@@ -263,7 +263,7 @@ module LMS
       end
 
       if missing.length > 0
-        raise LMS::API::MissingRequiredParameterException, "Missing required parameter(s): #{missing.join(', ')}"
+        raise LMS::Canvas::MissingRequiredParameterException, "Missing required parameter(s): #{missing.join(', ')}"
       end
 
       # Generate the uri. Only allow path parameters

data/lib/lms/version.rb

@@ -1,3 +1,3 @@
 module LMS
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lms-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Atomic Jolt
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-14 00:00:00.000000000 Z
+date: 2016-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport