omniauth-khan-academy 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-khan-academy.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dipil
+
+MIT License
+
+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/README.md

@@ -0,0 +1,56 @@
+# OmniAuth KhanAcademy
+
+This is an [OmniAuth 1.0](https://github.com/intridea/omniauth) strategy for authenticating to KhanAcademy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-khan-academy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-khan-academy
+
+## Usage
+
+Register[http://www.khanacademy.org/api-apps/register] your app at KhanAcademy and get your consumer token and secret.
+
+
+In a Rack application:
+
+```ruby
+use OmniAuth::Builder do
+  provider :khan_academy, CONSUMER_TOKEN, CONSUMER_SECRET
+end
+```
+
+For Rails, put this in your omniauth configuration file:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :khan_academy, CONSUMER_TOKEN, CONSUMER_SECRET
+end
+```
+
+Restart the server and visit "*/auth/khanacademy" to try it out.
+
+The default callback is routed to "*/auth/khanacademy/callback" but you can override it as shown:
+
+    provider :khan_academy, CONSUMER_TOKEN, CONSUMER_SECRET, callback_url: "my_callback_url"
+    
+## Author
+
+[Dipil Saud (@dipil-saud)](https://github.com/dipil-saud)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/omniauth-khan-academy.rb

@@ -0,0 +1,2 @@
+require "omniauth-khan-academy/version"
+require "omniauth/strategies/khan_academy"

data/lib/omniauth-khan-academy/version.rb

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

data/lib/omniauth/strategies/khan_academy.rb

@@ -0,0 +1,107 @@
+require "multi_json"
+require "omniauth"
+require "oauth"
+
+# for Hash#to_query
+require "active_support/core_ext"
+
+module OmniAuth
+  module Strategies
+
+    class KhanAcademy
+      include OmniAuth::Strategy
+
+      args [:consumer_key, :consumer_secret]
+
+      option :consumer_key, nil
+      option :consumer_secret, nil
+      option :callback_url, nil
+      option :client_options, {}
+
+      DEFAULT_CLIENT_OPTIONS = {
+        "http_method" => :get,
+        "site" => "http://www.khanacademy.org",
+        "request_token_path" => "/api/auth/request_token",
+        "access_token_path" => "/api/auth/access_token"
+      }
+
+      attr_reader :access_token
+
+      # this will redirect to the KhanAcademy login page where you can login using google, facebook or khan"s login
+      # Khan returns the required credentials for the request token after authentication
+      def request_phase
+        session["oauth"] ||= {}
+        redirect login_url
+      end
+
+
+      def callback_phase
+        raise OmniAuth::NoSessionError.new("Session Expired") if session["oauth"].nil?
+        # Create a request token from the token and secret provided in the response
+        request_token = ::OAuth::AccessToken.new(consumer, request["oauth_token"], request["oauth_token_secret"])
+        # Request access_token from the created request_token
+        @access_token = consumer.get_access_token(request_token, {oauth_callback: callback_url, oauth_verifier: request["oauth_verifier"]})
+
+        super
+      rescue ::Timeout::Error => e
+        fail!(:timeout, e)
+      rescue ::Net::HTTPFatalError, ::OpenSSL::SSL::SSLError => e
+        fail!(:service_unavailable, e)
+      rescue ::OAuth::Unauthorized => e
+        fail!(:invalid_credentials, e)
+      rescue ::MultiJson::DecodeError => e
+        fail!(:invalid_response, e)
+      rescue ::OmniAuth::NoSessionError => e
+        fail!(:session_expired, e)
+      end
+
+      def raw_info
+        @raw_info ||= MultiJson.decode(access_token.get("/api/v1/user").body)
+      end
+
+      uid do
+        raw_info["user_id"]
+      end
+
+      credentials do
+        {"token" => access_token.token, "secret" => access_token.secret}
+      end
+
+      extra do
+        {"access_token" => access_token, "raw_info" => raw_info}
+      end
+
+      info do
+        {
+          "email" => raw_info["email"],
+          "nickname" => raw_info["nickname"]
+        }
+      end
+
+      def client_options
+        DEFAULT_CLIENT_OPTIONS.merge(options.client_options || {})
+      end
+
+      def callback_url
+        options.callback_url || super
+      end
+
+
+      def consumer
+        @consumer ||= ::OAuth::Consumer.new(options.consumer_key, options.consumer_secret, client_options)
+      end
+
+
+      def login_url
+        req = consumer.create_signed_request(:get, consumer.request_token_url, nil, {oauth_callback: callback_url})
+
+        oauth_params_string = req.instance_variable_get("@header")["authorization"].first
+        oauth_params_hash = req.parse_header(oauth_params_string)
+
+        "#{consumer.request_token_url}?#{oauth_params_hash.to_query}"
+      end
+
+    end
+
+  end
+end

data/omniauth-khan-academy.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-khan-academy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dipil"]
+  gem.email         = ["dipil.saud@gmail.com"]
+  gem.description   = %q{A KhanAcademy OAuth strategy for OmniAuth 1.0}
+  gem.summary       = %q{A KhanAcademy OAuth strategy for OmniAuth 1.0}
+  gem.homepage      = "https://github.com/dipil-saud/omniauth-khan-academy"
+
+  gem.add_runtime_dependency 'omniauth', '~> 1.0'
+  gem.add_runtime_dependency 'oauth'
+  gem.add_runtime_dependency 'multi_json'
+  gem.add_runtime_dependency 'active_support'
+
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'pry'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "omniauth-khan-academy"
+  gem.require_paths = ["lib"]
+  gem.version       = Omniauth::KhanAcademy::VERSION
+end

data/spec/omniauth/strategies/khan_academy_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::KhanAcademy do
+  let(:consumer_token){ "dummy_consumer_token" }
+  let(:consumer_secret){ "dummy_consumer_secret" }
+
+  let(:khan_academy){ OmniAuth::Strategies::KhanAcademy.new({}, consumer_secret, consumer_token) }
+  subject{ khan_academy }
+
+
+  describe "DEFAULT_CLIENT_OPTIONS" do
+    subject{ OmniAuth::Strategies::KhanAcademy::DEFAULT_CLIENT_OPTIONS }
+
+    it{ should eq({"http_method" => :get, "site" => "http://www.khanacademy.org", "request_token_path" => "/api/auth/request_token", "access_token_path" => "/api/auth/access_token"}) }
+  end
+
+  describe "#client_options" do
+    context "when the option client_options are not specified" do
+      it "should equal the default_client_options" do
+        subject.client_options.should eq(OmniAuth::Strategies::KhanAcademy::DEFAULT_CLIENT_OPTIONS)
+      end
+    end
+
+    context "when the option client_options are specified" do
+      let(:custom_client_options){ {"http_method" => :post} }
+
+      subject{ OmniAuth::Strategies::KhanAcademy.new({}, consumer_secret, consumer_token, client_options: custom_client_options) }
+
+      it "should equal the default_client_options merged with the custom options" do
+        subject.client_options.should eq(OmniAuth::Strategies::KhanAcademy::DEFAULT_CLIENT_OPTIONS.merge(custom_client_options))
+      end
+    end
+  end
+
+  describe "#request_phase" do
+    before do
+      khan_academy.stub(:login_url).and_return('login_url')
+      khan_academy.stub(:session).and_return({})
+    end
+
+    it "should redirect to the login url at khan_academy" do
+      khan_academy.should_receive(:redirect).with('login_url').once
+
+      khan_academy.request_phase
+    end
+  end
+
+  describe "login_url" do
+    before do
+      khan_academy.stub(:callback_url).and_return("http://callback.url")
+    end
+
+    subject { khan_academy.login_url }
+
+    it{ should be_a(String) }
+    it{ should =~ /\Ahttp:\/\/www.khanacademy.org\/api\/auth\/request_token\?oauth_callback=.+&oauth_consumer_key=\w+&oauth_nonce=\w+&oauth_signature.+&oauth_signature_method=HMAC-SHA1&oauth_timestamp=\d+&oauth_version=1\.0\z/ }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require 'omniauth-khan-academy'
+require 'pry'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-khan-academy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dipil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: &77917510 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *77917510
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &77917300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *77917300
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &77917070 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *77917070
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &77916860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *77916860
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &77916610 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *77916610
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &77916400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *77916400
+description: A KhanAcademy OAuth strategy for OmniAuth 1.0
+email:
+- dipil.saud@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-khan-academy.rb
+- lib/omniauth-khan-academy/version.rb
+- lib/omniauth/strategies/khan_academy.rb
+- omniauth-khan-academy.gemspec
+- spec/omniauth/strategies/khan_academy_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dipil-saud/omniauth-khan-academy
+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.11
+signing_key: 
+specification_version: 3
+summary: A KhanAcademy OAuth strategy for OmniAuth 1.0
+test_files:
+- spec/omniauth/strategies/khan_academy_spec.rb
+- spec/spec_helper.rb