ims-lti 2.0.0.beta.1 → 2.0.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9a9be3ac5b5acb2c58f5c961cb68be59accfa3f
-  data.tar.gz: d5dba5360e965a35e54fe010800735e4d087fe25
+  metadata.gz: 26f070c1a552e6a85696dbf87fc187b14f7a252d
+  data.tar.gz: 56a2303e4793715a1c2e301f62488fc4091219da
 SHA512:
-  metadata.gz: 9b45fee316f01a2681c78bc047d7710e3d7ad502afb170407a15e00e2f1f3305742e03024b92d9feca47b650bc93792d1b9ab26176fd92f3ea00137200961350
-  data.tar.gz: 947ca33099a7285791b82e5e0b9d1fa92202d1370a36a0fae5fb83f2d35fb84cbb790f40cff88fc57a18b1e2e0525018b5585e26995547ff7108ede73768acb7
+  metadata.gz: c55c3788464a299201d8d513d89981917b37b7c752a55c8563c838f61b78d86b6214695e043898f4b97280efc034b82d79ed613a1cfce2ddb1e67769f94999d3
+  data.tar.gz: 42b4177176b634b61164ff40719d6867d1f64ff7adffe2016104d6031c55692b292081b2c00c1a98b2aa64c890b0a7a499799697f70da97f03cca5d768d1817b

data/lib/ims/lti.rb

@@ -1,5 +1,8 @@
 require 'json'
 require 'securerandom'
+require 'simple_oauth'
+require 'faraday'
+require 'faraday_middleware'
 require 'oauth'
 
 module IMS

data/lib/ims/lti/models/lti_model.rb

@@ -42,7 +42,11 @@ module IMS::LTI::Models
 
     def attributes=(attrs)
       attrs.each do |k, v|
-        instance_variable_set("@#{k.to_s}", v)
+        if self.class.attributes.include?(k.to_sym)
+          instance_variable_set("@#{k.to_s}", v)
+        else
+          warn("Unknown attribute '#{k}'")
+        end
       end
     end
 

data/lib/ims/lti/models/messages/message.rb

@@ -3,14 +3,30 @@ module IMS::LTI::Models::Messages
     LAUNCH_TARGET_IFRAME = 'iframe'
     LAUNCH_TARGET_WINDOW = 'window'
 
+    EXTENSION_PREFIX = 'ext_'
+    CUSTOM_PREFIX = 'custom_'
+
     add_attributes :lti_message_type, :lti_version, :user_id, :roles, :launch_presentation_local,
                    :launch_presentation_document_target, :launch_presentation_css_url, :launch_presentation_width,
                    :launch_presentation_height
 
     def initialize(attrs = {})
-      super(attrs)
       @custom_params = {}
       @ext_params = {}
+      attributes = {}
+
+      attrs.each do |k,v|
+        str_key = k.to_s
+        if str_key.start_with?(EXTENSION_PREFIX)
+          @ext_params[str_key.sub(EXTENSION_PREFIX, '')] = v
+        elsif str_key.start_with?(CUSTOM_PREFIX)
+          @custom_params[str_key.sub(CUSTOM_PREFIX, '')] = v
+        else
+          attributes[k] = v
+        end
+      end
+
+      super(attributes)
     end
 
     def post_params
@@ -19,13 +35,13 @@ module IMS::LTI::Models::Messages
 
     def get_ext_params
       params = {}
-      @ext_params.each { |k, v| params["ext_#{k}"] = v }
+      @ext_params.each { |k, v| params["#{EXTENSION_PREFIX}#{k}"] = v }
       params
     end
 
     def get_custom_params
       params = {}
-      @custom_params.each { |k, v| params["custom_#{k}"] = v }
+      @custom_params.each { |k, v| params["#{CUSTOM_PREFIX}#{k}"] = v }
       params
     end
 
@@ -39,5 +55,6 @@ module IMS::LTI::Models::Messages
       end
     end
 
+    private
   end
 end

data/lib/ims/lti/models/resource_handler.rb

@@ -14,5 +14,9 @@ module IMS::LTI::Models
       description && description.default_value
     end
 
+    def messages
+      [*message]
+    end
+
   end
 end

data/lib/ims/lti/models/rest_service.rb

@@ -6,8 +6,24 @@ module IMS::LTI::Models
     add_attribute :id, json_key:'@id'
     add_attribute :type, json_key: '@type'
 
-    def initialize
+    def initialize(attributes = {})
       @type = TYPE
+      super(attributes)
+    end
+
+    def profile
+      RestServiceProfile.new(
+          service: endpoint,
+          action: action
+      )
+    end
+
+    def actions
+      [*action]
+    end
+
+    def formats
+      [*format]
     end
 
   end

data/lib/ims/lti/models/rest_service_profile.rb

@@ -3,5 +3,13 @@ module IMS::LTI::Models
     add_attributes :service, :action
     add_attribute :type, json_key: '@type'
 
+    def initialize(attributes = {})
+      @type = "RestServiceProfile"
+      super(attributes)
+    end
+
+    def actions
+      [*action]
+    end
   end
 end

data/lib/ims/lti/models/tool_consumer_profile.rb

@@ -11,9 +11,14 @@ module IMS::LTI::Models
     add_attribute :product_instance, relation:'IMS::LTI::Models::ProductInstance'
     add_attribute :service_offered, relation: 'IMS::LTI::Models::RestService'
 
-    def initialize
+    def initialize(attr = {})
       @context = [CONTEXT]
       @type = TYPE
+      super(attr)
+    end
+
+    def services_offered
+      [*@service_offered]
     end
 
   end

data/lib/ims/lti/models/tool_profile.rb

@@ -18,5 +18,13 @@ module IMS::LTI::Models
       end
     end
 
+    def resource_handlers
+      [*@resource_handler]
+    end
+
+    def messages
+      [*@message]
+    end
+
   end
 end

data/lib/ims/lti/models/tool_proxy.rb

@@ -7,5 +7,11 @@ module IMS::LTI::Models
     add_attribute :tool_consumer_profile
     add_attribute :tool_profile, relation:'IMS::LTI::Models::ToolProfile'
     add_attribute :security_contract, relation:'IMS::LTI::Models::SecurityContract'
+
+    def initialize(attr = {})
+      @context = ['http://purl.imsglobal.org/ctx/lti/v2/ToolProxy']
+      super(attr)
+      @type = 'ToolProxy'
+    end
   end
 end

data/lib/ims/lti/services.rb

@@ -1,5 +1,6 @@
 module IMS::LTI
   module Services
     require_relative 'services/message_service'
+    require_relative 'services/tool_proxy_registration_service'
   end
 end

data/lib/ims/lti/services/message_service.rb

@@ -2,39 +2,47 @@ module IMS::LTI::Services
   class MessageService
 
     def initialize(key, secret)
-      @key = key
-      @secret = secret
+      @credentials = {consumer_key: key, consumer_secret: secret}
     end
 
-    def signed_request(url, message)
-      uri = URI.parse(url)
-      oauth_consumer = OAuth::Consumer.new(@key, @secret, {
-          :site => "#{uri.scheme}://#{uri.host}",
-          :scheme => :body
-      })
-      request = oauth_consumer.create_signed_request(:post, uri.request_uri, nil, {}, message.post_params)
+    def signed_params(url, message)
+      params = message.post_params
+      header = SimpleOAuth::Header.new(:post, url, params, @credentials)
+      params = header.signed_attributes.merge(params)
+      params
+    end
 
-      request
+    def valid_signature?(url, params)
+      options, parsed_params = parse_params(params)
+      signature = parsed_params.delete(:oauth_signature)
+      header = SimpleOAuth::Header.new(:post, url, parsed_params, options.merge(@credentials))
+      header.valid?(signature: signature)
     end
 
-    def signed_params(url, message)
-      signed_request = signed_request(url, message)
+    private
 
-      params = {}
-      CGI.parse(signed_request.body).each do |key, value|
-        params[key] = value.first
+    def parse_params(params)
+      params.inject([{}, {}]) do |array, (k, v)|
+        attr = k.to_s.sub('oauth_', '').to_sym
+        if SimpleOAuth::Header::ATTRIBUTE_KEYS.include?(attr)
+          array[0][attr] = v
+        else
+          array[1][k] = v
+        end
+        array
       end
-      params
     end
 
-    def valid_signature?(url, params)
-      request = {
-          'method' => 'POST',
-          'uri' => url,
-          'parameters' => params
-      }
+    def signed_request(url, message)
+      uri = URI.parse(url)
+      oauth_consumer = OAuth::Consumer.new(@key, @secret, {
+        :site => "#{uri.scheme}://#{uri.host}",
+        :scheme => :body
+      })
+      request = oauth_consumer.create_signed_request(:post, uri.request_uri, nil, {}, message.post_params)
 
-      OAuth::Signature.build(request, :consumer_secret => @secret).verify()
+      request
     end
+
   end
 end

data/lib/ims/lti/services/tool_proxy_registration_service.rb

@@ -0,0 +1,39 @@
+module IMS::LTI::Services
+  class ToolProxyRegistrationService
+    def initialize(registration_request)
+      @registration_request = registration_request
+    end
+
+    def tool_consumer_profile
+      return @tool_consumer_profile if @tool_consumer_profile
+
+      connection = Faraday.new
+      response = connection.get(@registration_request.tc_profile_url)
+      @tool_consumer_profile = IMS::LTI::Models::ToolConsumerProfile.new.from_json(response.body)
+    end
+
+    def service_profiles
+      tool_consumer_profile.services_offered.map(&:profile)
+    end
+
+    def register_tool_proxy(tool_proxy)
+      service = tool_consumer_profile.services_offered.find{|s| s.formats.include?('application/vnd.ims.lti.v2.toolproxy+json') && s.actions.include?('POST')}
+
+      conn = Faraday.new do |conn|
+        conn.request :oauth, {:consumer_key => @registration_request.reg_key, :consumer_secret => @registration_request.reg_password}
+        conn.adapter :net_http
+      end
+
+      response = conn.post do |req|
+        req.url service.endpoint
+        req.headers['Content-Type'] = 'application/json'
+        req.body = tool_proxy.to_json
+      end
+
+      if response.status == 201
+        IMS::LTI::Models::ToolProxy.new.from_json(tool_proxy.to_json).from_json(response.body)
+      end
+    end
+
+  end
+end

metadata

@@ -1,43 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: ims-lti
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.1
+  version: 2.0.0.beta.2
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-15 00:00:00.000000000 Z
+date: 2014-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json-ld
+  name: oauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: oauth
+  name: simple_oauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.7
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.7
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
 email: 
 executables: []
@@ -110,6 +152,7 @@ files:
 - lib/ims/lti/models/vendor.rb
 - lib/ims/lti/services.rb
 - lib/ims/lti/services/message_service.rb
+- lib/ims/lti/services/tool_proxy_registration_service.rb
 - lib/ims/lti/version.rb
 homepage: http://github.com/instructure/ims-lti
 licenses:
@@ -136,3 +179,4 @@ signing_key:
 specification_version: 4
 summary: Ruby library for creating IMS LTI tool providers and consumers
 test_files: []
+has_rdoc: