ims-lti 1.1.4 → 1.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f08cf8db456b71aa74d6c55cecb8e76dc5ae4ad7
+  data.tar.gz: 5f1a47d7a25c957228b9f2bc3038ee5d64bc5b30
+SHA512:
+  metadata.gz: c79e28940abe36bec574f89263f3650948f8e60010061f9799f9c013129d97c13d388ed1eb708f1328a171578db374ccc435e49148849f6e08c6700c9d302728
+  data.tar.gz: 1ed5c8d404daaea3e46177bf5761812a5ae59becc7de4d8e44a736358ee4d991fd71259bfff6c739d05155bd6c8e930bbad104d0719a08a3a6a6a2b1698c9298

data/README.md

@@ -24,7 +24,7 @@ proxy for your application. For example:
     # For a Rails 2.3 app:
     require 'oauth/request_proxy/action_controller_request'
 
-For further information see the [oauth-ruby](https://github.com/oauth/oauth-ruby) project.
+For further information see the [oauth-ruby](https://github.com/oauth-xx/oauth-ruby) project.
 
 ## Usage
 This readme won't cover the LTI standard, just how to use the library. It will be

data/lib/ims/lti.rb

@@ -33,6 +33,19 @@ module IMS # :nodoc:
     class InvalidLTIConfigError < StandardError
     end
 
+    # POST a signed oauth request with the given key/secret/data
+    def self.post_service_request(key, secret, url, content_type, body)
+      raise IMS::LTI::InvalidLTIConfigError, "" unless key && secret
+
+      consumer = OAuth::Consumer.new(key, secret)
+      token = OAuth::AccessToken.new(consumer)
+      token.post(
+              url,
+              body,
+              'Content-Type' => content_type
+      )
+    end
+
     # Generates a unique identifier
     def self.generate_identifier
       UUID.new
@@ -43,6 +56,7 @@ end
 require 'ims/lti/extensions'
 require 'ims/lti/launch_params'
 require 'ims/lti/request_validator'
+require 'ims/lti/tool_base'
 require 'ims/lti/tool_provider'
 require 'ims/lti/tool_consumer'
 require 'ims/lti/outcome_request'

data/lib/ims/lti/extensions/canvas.rb

@@ -28,34 +28,45 @@ module IMS::LTI
 
         # Canvas extension defaults
         # These properties will cascade down to any options that are configured
+        def set_canvas_ext_param(key, value)
+          set_ext_param(PLATFORM, key, value)
+        end
+
+        def get_canvas_param(param_key)
+          get_ext_param PLATFORM, param_key
+        end
 
         def canvas_privacy_public!()
-          set_ext_param(PLATFORM, :privacy_level, 'public')
+          set_canvas_ext_param(:privacy_level, 'public')
         end
 
         def canvas_privacy_name_only!()
-          set_ext_param(PLATFORM, :privacy_level, 'name_only')
+          set_canvas_ext_param(:privacy_level, 'name_only')
         end
 
         def canvas_privacy_anonymous!()
-          set_ext_param(PLATFORM, :privacy_level, 'anonymous')
+          set_canvas_ext_param(:privacy_level, 'anonymous')
         end
 
         def canvas_domain!(domain)
-          set_ext_param(PLATFORM, :domain, domain)
+          set_canvas_ext_param(:domain, domain)
         end
 
         def canvas_text!(text)
-          set_ext_param(PLATFORM, :text, text)
+          set_canvas_ext_param(:text, text)
         end
 
         def canvas_icon_url!(icon_url)
-          set_ext_param(PLATFORM, :icon_url, icon_url)
+          set_canvas_ext_param(:icon_url, icon_url)
+        end
+
+        def canvas_tool_id!(tool_id)
+          set_canvas_ext_param(:tool_id, tool_id)
         end
 
         def canvas_selector_dimensions!(width, height)
-          set_ext_param(PLATFORM, :selection_width, width)
-          set_ext_param(PLATFORM, :selection_height, height)
+          set_canvas_ext_param(:selection_width, width)
+          set_canvas_ext_param(:selection_height, height)
         end
 
         # Canvas options
@@ -65,25 +76,25 @@ module IMS::LTI
         # Enables homework submissions via the tool
         # Valid properties are url, text, selection_width, selection_height, enabled
         def canvas_homework_submission!(params = {})
-          set_ext_param(PLATFORM, :homework_submission, params)
+          set_canvas_ext_param(:homework_submission, params)
         end
 
         # Adds the tool to canvas' rich text editor
         # Valid properties are url, icon_url, text, selection_width, selection_height, enabled
         def canvas_editor_button!(params = {})
-          set_ext_param(PLATFORM, :editor_button, params)
+          set_canvas_ext_param(:editor_button, params)
         end
 
-        # Adds the tool to canvas' rich text editor
-        # Valid properties are url, icon_url, text, selection_width, selection_height, enabled
+        # Adds the tool to canvas' resource selector
+        # Valid properties are url, text, selection_width, selection_height, enabled
         def canvas_resource_selection!(params = {})
-          set_ext_param(PLATFORM, :resource_selection, params)
+          set_canvas_ext_param(:resource_selection, params)
         end
 
         # Adds the tool to account level navigation in canvas
         # Valid properties are url, text, enabled
         def canvas_account_navigation!(params = {})
-          set_ext_param(PLATFORM, :account_navigation, params)
+          set_canvas_ext_param(:account_navigation, params)
         end
 
         # Adds the tool to course level navigation in canvas
@@ -91,17 +102,19 @@ module IMS::LTI
         # Visibility describes who will see the navigation element.  Possible values are "admins", "members", and nil
         # Default determines if it is on or off by default.  Possible values are "admins", "members", and nil
         def canvas_course_navigation!(params = {})
-          set_ext_param(PLATFORM, :course_navigation, params)
+          set_canvas_ext_param(:course_navigation, params)
         end
 
         # Adds the tool to user level navigation in canvas
         # Valid properties are url, text, enabled
         def canvas_user_navigation!(params = {})
-          set_ext_param(PLATFORM, :user_navigation, params)
+          set_canvas_ext_param(:user_navigation, params)
         end
 
-        def get_canvas_param(param_key)
-          get_ext_param PLATFORM, param_key
+        # Adds canvas environment configurations options
+        # Valid properties are launch_url, domain, test_launch_url, test_domain, beta_launch_url, beta_domain
+        def canvas_environments!(params = {})
+          set_canvas_ext_param(:environments, params)
         end
       end
     end

data/lib/ims/lti/extensions/outcome_data.rb

@@ -70,12 +70,14 @@ module IMS::LTI
         # POSTs the given score to the Tool Consumer with a replaceResult and
         # adds the specified data. The data hash can have the keys "text", "cdata_text", or "url"
         #
-        # If  both cdata_text and text are sent, cdata_text will be used
+        # If both cdata_text and text are sent, cdata_text will be used
+        #
+        # If score is nil, the replace result XML will not contain a resultScore node
         #
         # Creates a new OutcomeRequest object and stores it in @outcome_requests
         #
         # @return [OutcomeResponse] the response from the Tool Consumer
-        def post_replace_result_with_data!(score, data={})
+        def post_replace_result_with_data!(score = nil, data={})
           req = new_request
           if data["cdata_text"] 
             req.outcome_cdata_text = data["cdata_text"] 
@@ -85,7 +87,6 @@ module IMS::LTI
           req.outcome_url = data["url"] if data["url"]
           req.post_replace_result!(score)
         end
-
       end
 
       module ToolConsumer

data/lib/ims/lti/launch_params.rb

@@ -137,9 +137,9 @@ module IMS::LTI
       params.each_pair do |key, val|
         if LAUNCH_DATA_PARAMETERS.member?(key)
           self.send("#{key}=", val)
-        elsif key =~ /custom_(.*)/
+        elsif key =~ /\Acustom_(.+)\Z/
           @custom_params[$1] = val
-        elsif key =~ /ext_(.*)/
+        elsif key =~ /\Aext_(.+)\Z/
           @ext_params[$1] = val
         end
       end

data/lib/ims/lti/outcome_request.rb

@@ -32,7 +32,7 @@ module IMS::LTI
   #    else
   #      # return an unsupported OutcomeResponse
   #    end
-  class OutcomeRequest
+  class OutcomeRequest < ToolBase
     include IMS::LTI::Extensions::Base
 
     REPLACE_REQUEST = 'replaceResult'
@@ -123,13 +123,10 @@ module IMS::LTI
     def post_outcome_request
       raise IMS::LTI::InvalidLTIConfigError, "" unless has_required_attributes?
 
-      consumer = OAuth::Consumer.new(@consumer_key, @consumer_secret)
-      token = OAuth::AccessToken.new(consumer)
-      res = token.post(
-              @lis_outcome_service_url,
-              generate_request_xml,
-              'Content-Type' => 'application/xml'
-      )
+      res = post_service_request(@lis_outcome_service_url,
+                                 'application/xml',
+                                 generate_request_xml)
+
       @outcome_response = extend_outcome_response(OutcomeResponse.new)
       @outcome_response.process_post_response(res)
     end

data/lib/ims/lti/tool_base.rb

@@ -0,0 +1,22 @@
+module IMS::LTI
+  class ToolBase
+
+    # OAuth credentials
+    attr_accessor :consumer_key, :consumer_secret
+
+    def initialize(consumer_key, consumer_secret)
+      @consumer_key = consumer_key
+      @consumer_secret = consumer_secret
+    end
+
+    # Convenience method for doing oauth signed requests to services that
+    # aren't supported by this library
+    def post_service_request(url, content_type, body)
+      IMS::LTI::post_service_request(@consumer_key,
+                                     @consumer_secret,
+                                     url,
+                                     content_type,
+                                     body)
+    end
+  end
+end

data/lib/ims/lti/tool_config.rb

@@ -142,7 +142,7 @@ module IMS::LTI
                                       "xsi:schemaLocation" => "http://www.imsglobal.org/xsd/imslticc_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticc_v1p0.xsd http://www.imsglobal.org/xsd/imsbasiclti_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imsbasiclti_v1p0p1.xsd http://www.imsglobal.org/xsd/imslticm_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticm_v1p0.xsd http://www.imsglobal.org/xsd/imslticp_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticp_v1p0.xsd"
       ) do |blti_node|
 
-        %w{title description launch_url secure_launch_url}.each do |key|
+        %w{title description launch_url secure_launch_url icon secure_icon}.each do |key|
           blti_node.blti key.to_sym, self.send(key) if self.send(key)
         end
 

data/lib/ims/lti/tool_consumer.rb

@@ -1,11 +1,11 @@
 module IMS::LTI
   # Class for implementing an LTI Tool Consumer
-  class ToolConsumer
+  class ToolConsumer < ToolBase
     include IMS::LTI::Extensions::Base
     include IMS::LTI::LaunchParams
     include IMS::LTI::RequestValidator
 
-    attr_accessor :consumer_key, :consumer_secret, :launch_url, :timestamp, :nonce
+    attr_accessor :launch_url, :timestamp, :nonce
 
     # Create a new ToolConsumer
     #
@@ -13,8 +13,7 @@ module IMS::LTI
     # @param consumer_secret [String] The OAuth consumer secret
     # @param params [Hash] Set the launch parameters as described in LaunchParams
     def initialize(consumer_key, consumer_secret, params={})
-      @consumer_key = consumer_key
-      @consumer_secret = consumer_secret
+      super(consumer_key, consumer_secret)
       @custom_params = {}
       @ext_params = {}
       @non_spec_params = {}

data/lib/ims/lti/tool_provider.rb

@@ -33,13 +33,11 @@ module IMS::LTI
   #       # failed
   #     end
 
-  class ToolProvider
+  class ToolProvider < ToolBase
     include IMS::LTI::Extensions::Base
     include IMS::LTI::LaunchParams
     include IMS::LTI::RequestValidator
 
-    # OAuth credentials
-    attr_accessor :consumer_key, :consumer_secret
     # List of outcome requests made through this instance
     attr_accessor :outcome_requests
     # Message to be sent back to the ToolConsumer when the user returns
@@ -51,8 +49,7 @@ module IMS::LTI
     # @param consumer_secret [String] The OAuth consumer secret
     # @param params [Hash] Set the launch parameters as described in LaunchParams
     def initialize(consumer_key, consumer_secret, params={})
-      @consumer_key = consumer_key
-      @consumer_secret = consumer_secret
+      super(consumer_key, consumer_secret)
       @custom_params = {}
       @ext_params = {}
       @non_spec_params = {}

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ims-lti
 version: !ruby/object:Gem::Version
-  version: 1.1.4
-  prerelease: 
+  version: 1.1.6
 platform: ruby
 authors:
 - Instructure
@@ -14,23 +13,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,49 +41,43 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-debug
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -106,6 +95,7 @@ files:
 - lib/ims/lti/outcome_request.rb
 - lib/ims/lti/outcome_response.rb
 - lib/ims/lti/request_validator.rb
+- lib/ims/lti/tool_base.rb
 - lib/ims/lti/tool_config.rb
 - lib/ims/lti/tool_consumer.rb
 - lib/ims/lti/tool_provider.rb
@@ -117,26 +107,25 @@ files:
 homepage: http://github.com/instructure/ims-lti
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby library for creating IMS LTI tool providers and consumers
 test_files: []