omniauth-lti 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in omniauth-lti.gemspec
+gemspec

data/README.md

@@ -0,0 +1,40 @@
+OmniAuth LTI
+============
+
+The OmniAuth LTI gem provides a way for applications to authenticate users using LTI 1.1 specification. 
+
+It relies on [ims-lti gem][] for validating LTI data.
+
+Usage
+=====
+
+Add the provider to your OmniAuth stack, giving the tool_consumer credentials:
+
+	Rails.application.config.middleware.use OmniAuth::Builder do
+	  provider :lti, :oauth_credentials => {:test => 'secret'}
+	end
+
+Include Omniauth::Lti::Context in your application_controller:
+
+	class ApplicationController < ActionController::Base
+  	  ...
+	  include Omniauth::Lti::Context
+  	  ...
+	end
+
+When you create the session in your sessions\_controller, call to save_lti_context for saving LTI context through all the application
+
+For accessing the context anywhere in your application, just call the helper method lti\_tool\_provider. 
+For instance, to show the title of the resource that call your application just put in your haml view:
+
+	=lti_tool_provider.resource_link_title
+
+You can find an example web application in [omniauth-lti-example-webapp][]
+
+TODO
+=====
+
+Add support for outcomes
+
+[ims-lti gem]: https://github.com/instructure/ims-lti
+[omniauth-lti-example-webapp]: https://github.com/xaviaracil/omniauth-lti-example

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/omniauth/lti.rb

@@ -0,0 +1,9 @@
+require 'omniauth'
+require 'ims/lti'
+require 'oauth/request_proxy/rack_request'
+
+module OmniAuth
+  module Strategies
+    autoload :Lti, 'omniauth/strategies/lti'
+  end
+end

data/lib/omniauth/strategies/lti.rb

@@ -0,0 +1,58 @@
+module OmniAuth
+  module Strategies
+    class Lti
+      include OmniAuth::Strategy
+      
+      # Hash for storing your Consumer Tools credentials, whether:
+      # - the key is the consumer_key 
+      # - the value is the comsumer_secret
+      option :oauth_credentials, {}
+      
+      # Defaul username for users when LTI context doesn't provide a name
+      option :default_user_name, 'User'
+      
+      def callback_phase
+        # validate request
+        return fail!(:invalid_credentials) unless valid_lti?
+        #save the launch parameters for use in later request
+        env['lti.launch_params'] = @tp.to_params
+        super
+      end
+      
+      # define the UID
+      uid { @tp.user_id }
+      
+      # define the hash of info about user
+      info do
+        {
+          :name => @tp.username(options.default_user_name),
+          :email => @tp.lis_person_contact_email_primary,
+          :first_name => @tp.lis_person_name_given,
+          :last_name => @tp.lis_person_name_family,
+          :image => @tp.user_image
+        }
+      end
+      
+      # define the hash of credentials
+      credentials do
+        {
+          :token => @tp.consumer_key,
+          :secret => @tp.consumer_secret
+        }
+      end
+      
+      #define extra hash
+      extra do
+        { :raw_info => @tp.to_params }
+      end
+      
+      private
+      
+      def valid_lti?
+        key = request.params['oauth_consumer_key']
+        @tp = IMS::LTI::ToolProvider.new(key, options.oauth_credentials[key], request.params)
+        @tp.valid_request!(request)
+      end
+    end
+  end
+end

data/lib/omniauth-lti/context.rb

@@ -0,0 +1,42 @@
+module Omniauth
+  module Lti
+    module Context      
+      
+      def self.included(receiver)
+        receiver.class_eval do
+          # add lti_tool_provider as a helper method to received object
+          helper_method :lti_tool_provider
+          attr_reader :lti_credentials
+
+          def lti_credentials=(credentials) 
+            if credentials && credentials.is_a?(Hash)
+              @lti_credentials = credentials.keys.inject({}) {|h,k| h[k.to_s] = credentials[k] ; h }
+            end
+          end
+        end
+      end      
+      
+      def save_lti_context
+        session[LTI_LAUNCH_PARAMS_SESSION_NAME] = request.env['lti.launch_params']
+      end
+      
+      private 
+      
+      LTI_LAUNCH_PARAMS_SESSION_NAME = 'lti_launch_params'
+
+      def lti_launch_params
+        session[LTI_LAUNCH_PARAMS_SESSION_NAME]
+      end
+
+      def lti_tool_provider        
+        return nil unless lti_launch_params
+        key = lti_launch_params['oauth_consumer_key']
+        secret = self.lti_credentials[key] if self.lti_credentials
+        @tp ||= IMS::LTI::ToolProvider.new(key, 
+                                           secret, 
+                                           lti_launch_params)
+      end
+            
+    end
+  end
+end

data/lib/omniauth-lti/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Lti
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth-lti.rb

@@ -0,0 +1,3 @@
+require "omniauth-lti/version"
+require "omniauth-lti/context"
+require "omniauth/lti"

data/omniauth-lti.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-lti/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-lti"
+  s.version     = Omniauth::Lti::VERSION
+  s.authors     = ["Xavi Aracil"]
+  s.email       = ["xavi@laibeth.com"]
+  s.homepage    = "https://github.com/xaviaracil/omniauth-lti"
+  s.summary     = %q{OmniAuth strategy for LTI spec}
+  s.description = %q{OmniAuth strategy for providing LTI authentication to an OmniAuth application}
+
+  s.rubyforge_project = "omniauth-lti"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  s.add_dependency 'omniauth'
+  s.add_dependency 'ims-lti'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: omniauth-lti
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Xavi Aracil
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-06-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: omniauth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ims-lti
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: OmniAuth strategy for providing LTI authentication to an OmniAuth application
+email: 
+- xavi@laibeth.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-lti.rb
+- lib/omniauth-lti/context.rb
+- lib/omniauth-lti/version.rb
+- lib/omniauth/lti.rb
+- lib/omniauth/strategies/lti.rb
+- omniauth-lti.gemspec
+homepage: https://github.com/xaviaracil/omniauth-lti
+licenses: []
+
+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: omniauth-lti
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: OmniAuth strategy for LTI spec
+test_files: []
+