lms-api 1.2.7 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24c84120ece41009fe047528839394f91d801e9f
-  data.tar.gz: 7c07f89e2b00a8f41bfe437324b04bed8c6511d4
+  metadata.gz: 67b3b72f988679b53c1765c8865815d08be99ac2
+  data.tar.gz: 27a7f36cdcd20407e5d5ece8e41959a03a4083e5
 SHA512:
-  metadata.gz: 83663596c06851b2ff53b9f3903f0ac259c489f6f836b573d2b1fcd0d342ac8c9538851e706c41a49671167788bedb506b310f2fe98e9a54185ea6098f80c709
-  data.tar.gz: bdef58c1d1254908169d4e20259ea55654c25c595cc04577b16a1c78afb7e441c58f1d51282cc9d3dd1ffcd2fe3f7cb3e771f8d27eab080ba9e7657e08e407a8
+  metadata.gz: 70d881c7ff2b502d960832f59cb828d23342f09ced74671d0c0df3989a6f6a023e9d01526479399a1b10fab7eebf208b96282bd4f6db718b6651c17945f2ba09
+  data.tar.gz: aad199ea1ec1c3232b59e220e2e566512ae13ff4fd048608c56588b5f0240f6990fa48adab77f9e0b1e464dcdf01b47d5d71fd22ac2ca3ae2b4117975558134a

data/lib/lms/canvas.rb

@@ -7,13 +7,10 @@ require "active_support/core_ext/hash/indifferent_access"
 require "ostruct"
 
 require "lms/canvas_urls"
+require "lms/helper_urls"
 
 module LMS
 
-  CANVAS_HELPER_URLs = {
-    "HELPER_ALL_ACCOUNTS" => :all_accounts
-  }
-
   class Canvas
 
     # a model that encapsulates authentication state. By default, it
@@ -205,8 +202,7 @@ module LMS
       end
     end
 
-    def proxy(type, params, payload = nil, get_all = false)
-
+    def multi_proxy(type, params, payload = nil, get_all = false)
       # Helper methods call several Canvas methods to return a block of data to the client
       if helper = CANVAS_HELPER_URLs[type]
         result = self.send(helper)
@@ -216,7 +212,9 @@ module LMS
           body: result.to_json
         )
       end
+    end
 
+    def single_proxy(type, params, payload = nil, get_all = false)
       additional_headers = {
         "Content-Type" => "application/json"
       }
@@ -259,13 +257,27 @@ module LMS
       raise new_ex
     end
 
+    def proxy(type, params, payload = nil, get_all = false, &block)
+      multi_proxy(type, params, payload, get_all) ||
+        single_proxy(type, params, payload, get_all, &block)
+    end
+
     # Ignore required params for specific calls. For example, the external tool calls
     # have required params "name, privacy_level, consumer_key, shared_secret". However, those
     # params are not required if the call specifies config_type: "by_xml".
     def self.ignore_required(type)
       [
         "CREATE_EXTERNAL_TOOL_COURSES",
-        "CREATE_EXTERNAL_TOOL_ACCOUNTS"
+        "CREATE_EXTERNAL_TOOL_ACCOUNTS",
+      ].include?(type)
+    end
+
+    # These methods allow custom paths to be appended to the API endpoint.
+    def self.allow_scoped_path(type)
+      [
+        "STORE_CUSTOM_DATA",
+        "LOAD_CUSTOM_DATA",
+        "DELETE_CUSTOM_DATA",
       ].include?(type)
     end
 
@@ -302,6 +314,14 @@ module LMS
       args = params.slice(*path_parameters).symbolize_keys
       uri = args.blank? ? uri_proc.call : uri_proc.call(**args)
 
+      # Handle scopes in the url. These API endpoints allow for additional path
+      # information to be added to their urls.
+      # ie "users/#{user_id}/custom_data/favorite_color/green"
+      if allow_scoped_path(type) &&
+        scope = params[:scope]&.gsub("../", "").gsub("..", "") # Don't allow moving up in the path
+        uri = File.join(uri, scope)
+      end
+
       # Generate the query string
       query_parameters = parameters.select { |p| p["paramType"] == "query" }.
         map { |p| p["name"].to_sym }
@@ -326,9 +346,9 @@ module LMS
     # Get all accounts including sub accounts
     def all_accounts
       all = []
-      proxy("LIST_ACCOUNTS", {}, nil, true).each do |account|
+      single_proxy("LIST_ACCOUNTS", {}, nil, true).each do |account|
         all << account
-        sub_accounts = proxy("GET_SUB_ACCOUNTS_OF_ACCOUNT",
+        sub_accounts = single_proxy("GET_SUB_ACCOUNTS_OF_ACCOUNT",
                              {
                                 account_id: account["id"],
                                 recursive: true,

data/lib/lms/helper_urls.rb

@@ -0,0 +1,8 @@
+
+module LMS
+
+  CANVAS_HELPER_URLs = {
+    "HELPER_ALL_ACCOUNTS" => :all_accounts
+  }
+
+end

data/lib/lms/version.rb

@@ -1,3 +1,3 @@
 module LMS
-  VERSION = "1.2.7".freeze
+  VERSION = "1.2.8".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lms-api
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.2.8
 platform: ruby
 authors:
 - Atomic Jolt
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
+date: 2017-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -109,6 +109,7 @@ files:
 - Rakefile
 - lib/lms/canvas.rb
 - lib/lms/canvas_urls.rb
+- lib/lms/helper_urls.rb
 - lib/lms/version.rb
 - lib/lms_api.rb
 - lib/tasks/canvas_api.rake