omniauth-canvas 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format=progress

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@omniauth-canvas"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.12.4 ()" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,19 @@
+# clean up:
+# rm -rf ~/.bundle/ ~/.gem/; rm -rf $GEM_HOME/bundler/ $GEM_HOME/cache/bundler/; rm -rf .bundle/; rm -rf vendor/cache/; rm -rf Gemfile.lock
+
+source 'http://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'growl'
+  gem 'rspec', '~>2.8.0'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'growl'
+  gem 'rb-fsevent'
+  gem 'simplecov'
+  gem 'debugger'
+  gem 'rack-test'
+end

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/README.md

@@ -0,0 +1,48 @@
+# OmniAuth Canvas
+Gem to authenticate with Instructure Canvas via OAuth2
+
+# Background
+OmniAuth Canvas grew out of the need to simplify the process of setting up LTI and connecting a user account on
+http://www.OpenTapestry.com to Instructure Canvas.
+
+# Setup
+Contact Instructure or your Canvas administrator to get an OAuth key and secret. By default omniauth-canvas will attempt to
+authenticate with http://canvas.instructure.com. To dynamically set the canvas site url do the following:
+
+## Standard setup:
+
+  use OmniAuth::Builder do
+    provider :canvas, :setup => lambda{|env|
+      request = Rack::Request.new(env)
+      env['omniauth.strategy'].options[:client_options].site = env['rack.session']['oauth_site']
+    }
+  end
+
+## Setup with Devise:
+
+  config.omniauth :canvas, 'canvas_key', 'canvas_secret', :setup => lambda{|env|
+    request = Rack::Request.new(env)
+    env['omniauth.strategy'].options[:client_options].site = env['rack.session']['oauth_site']
+  }
+
+## License
+
+Copyright (C) 2012 by Justin Ball and Open Tapestry, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+$: << File.dirname(__FILE__)
+
+require 'bundler'
+require 'rake'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+task :default => [:spec]
+task :test => [:spec]
+
+desc "run spec tests"
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/omniauth/strategies/canvas.rb

@@ -0,0 +1,45 @@
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class Canvas < OmniAuth::Strategies::OAuth2
+
+      option :name, "Canvas"
+
+      option :client_options, {
+        :site           => "https://canvas.instructure.com",
+        :authorize_url  => "/login/oauth2/auth",
+        :token_url      => "/login/oauth2/token"
+      }
+      option :token_params, {
+        :parse          => :json
+      }
+
+      uid do
+        access_token['user']['id']
+      end
+
+      info do
+        {
+          'name' => raw_info['name'],
+          'email' => raw_info['primary_email'],
+          'bio' => raw_info['bio'],
+          'title' => raw_info['title'],
+          'nickname' => raw_info['login_id'],
+          'active_avatar' => raw_info['avatar_url'],
+          'token' => access_token.token,
+        }
+      end
+
+      extra do
+        { :raw_info => raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("/api/v1/users/#{access_token['user']['id']}/profile").parsed
+      end
+
+    end
+  end
+end
+OmniAuth.config.add_camelization 'canvas', 'Canvas'

data/lib/omniauth-canvas/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Canvas
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth-canvas.rb

@@ -0,0 +1,2 @@
+require "omniauth-canvas/version"
+require 'omniauth/strategies/canvas'

data/omniauth-canvas.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-canvas/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = "Justin Ball"
+  gem.email         = "justin@opentapestry.com"
+  gem.description   = %q{OmniAuth Oauth2 strategy for Instructure Canvas.}
+  gem.summary       = %q{OmniAuth Oauth2 strategy for Instructure Canvas.}
+  gem.homepage      = "https://github.com/tatemae/omniauth-canvas"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "omniauth-canvas"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::Canvas::VERSION
+
+  gem.add_dependency 'omniauth', '~> 1.0'
+  gem.add_dependency 'omniauth-oauth2', '~> 1.0'
+end

data/spec/omniauth/strategies/canvas_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::OAuth2 do
+  def app; lambda{|env| [200, {}, ["Hello."]]} end
+
+  before do
+    @request = double('Request')
+    @request.stub(:params) { {} }
+    OmniAuth.config.test_mode = true
+  end
+
+  subject do
+    OmniAuth::Strategies::Canvas.new(nil, @options || {}).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  context "client options" do
+    it "has correct api site" do
+      subject.options.client_options.site.should eq("https://canvas.instructure.com")
+    end
+
+    it "has correct access token path" do
+      subject.options.client_options.token_url.should eq("/login/oauth2/token")
+    end
+
+    it "has correct authorize url" do
+      subject.options.client_options.authorize_url.should eq("/login/oauth2/auth")
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'omniauth'
+require 'omniauth-canvas'
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-canvas
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin Ball
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: OmniAuth Oauth2 strategy for Instructure Canvas.
+email: justin@opentapestry.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/omniauth-canvas.rb
+- lib/omniauth-canvas/version.rb
+- lib/omniauth/strategies/canvas.rb
+- omniauth-canvas.gemspec
+- spec/omniauth/strategies/canvas_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tatemae/omniauth-canvas
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: OmniAuth Oauth2 strategy for Instructure Canvas.
+test_files:
+- spec/omniauth/strategies/canvas_spec.rb
+- spec/spec_helper.rb