omniauth-learn 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10bdc2a76691e99c5c200500d658b164796e2922
+  data.tar.gz: aef8f8ceaa44ec172e70b7f7bbad189e1aa3bebe
+SHA512:
+  metadata.gz: 72a7757111452b29f25c5fb8e19b5d93671a9c6a65b02f76f474cf8b6eadd04762a671cbb4e67ce40ed0a403eb874bb466e843c9ccaba8ee38452f8e3a76b45c
+  data.tar.gz: f756478561316b45c52b51da8a9b646d4cb1c90aff56794b1e87b803dca432c3e83458f1c7da807da62e3cae0623879f336742a43d91a46d5e6d45a5a646e8d4

data/.gitignore

@@ -0,0 +1,54 @@
+
+# Created by https://www.gitignore.io/api/ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    omniauth-learn (0.0.1)
+      omniauth (~> 1.0)
+      omniauth-oauth2 (>= 1.1.1, < 2.0)
+      rake
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    dotenv (2.1.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.0)
+    hashie (3.4.4)
+    json (1.8.3)
+    jwt (1.5.1)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.3.1)
+      hashie (>= 1.2, < 4)
+      rack (>= 1.0, < 3)
+    omniauth-oauth2 (1.4.0)
+      oauth2 (~> 1.0)
+      omniauth (~> 1.2)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (11.1.2)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.4)
+    safe_yaml (1.0.4)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    webmock (2.0.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv
+  omniauth-learn!
+  rack-test
+  rspec (~> 2.7)
+  simplecov
+  webmock
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Learn.co
+
+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,87 @@
+OmniAuth Learn
+---
+
+This is an OmniAuth strategy for authenticating with Learn.co. Right now, it's mostly good for using the (super secret) API. 
+
+To use it, you'll need to sign up for an OAuth2 application key and secret on the [Learn Applications Page](https://learn.co/oauth/applications).
+
+### Basic Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :learn, ENV['LEARN_KEY'], ENV['LEARN_SECRET']
+end
+```
+
+### Rails
+
+* In your Gemfile
+
+`gem 'omniauth-learn'`
+
+* Create an initializer, `config/initializers/omniauth_learn.rb`
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :developer unless Rails.env.production?
+  provider :learn, ENV['LEARN_OAUTH_APP_ID'], ENV['LEARN_OAUTH_APP_SECRET'],
+  provider_ignores_state: true
+end
+```
+
+* Set your callback route in `config/routes.rb`
+
+```ruby
+ get '/auth/:provider/callback', to: "some_controller#some_action"
+```
+
+* In the controller action that maps to your callback URL:
+
+```ruby
+#some_controller.rb
+
+def some_action
+  request.env["omniauth.auth"]["info"]
+  # => {
+          "github_uid" => "2938", 
+          "github_gravatar => "http://mypic.jpg",
+          "username" => "sophiedebenedetto",
+          etc.
+        }
+end
+```
+
+
+### Local Usage
+
+```ruby
+provider :learn, ENV['LEARN_KEY'], ENV['LEARN_SECRET'], {       
+  client_options: {
+    # use the origin for your local instance of Learn.co
+    site: 'http://localhost:3000',
+    authorize_url: 'http://localhost:3000/oauth/authorize',
+    token_url: 'http://localhost:3000/oauth/token'
+  }
+}
+```
+
+## Contributing
+
+* Fork and clone this repository
+* Bundle install and run the test suite by running `rspec`
+
+### TODO
+
+* Add scopes
+  * In the initializer, we should be able to set scopes to determine what information we receive in the payload from Learn. 
+
+## License
+
+Copyright (c) 2016 Learn.co
+
+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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/omniauth-learn.rb

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

data/lib/omniauth-learn/version.rb

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

data/lib/omniauth/strategies/learn.rb

@@ -0,0 +1,31 @@
+require 'omniauth-oauth2'
+require 'pry'
+
+module OmniAuth
+  module Strategies
+    class Learn < OmniAuth::Strategies::OAuth2
+      include OmniAuth::Strategy
+
+      option :client_options, {
+               site: "https://learn.co",
+               authorize_url: "https://learn.co/oauth/authorize",
+               token_url: "https://learn.co/oauth/token"
+             }
+
+      def request_phase
+        super
+      end
+
+      info do
+        raw_info.merge("token" => access_token.token)
+      end
+
+      uid { raw_info["id"] }
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v1/users/me').parsed
+      end
+    end
+  end
+end
+

data/omniauth-learn.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/omniauth-learn/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors = ["Sophie DeBenedetto", "Charles Pletcher"]
+  gem.email = ["sophie@flatironschool.com", "chuck@flatironschool.com"]
+  gem.description = %q{Official OmniAuth strategy for Learn.co.}
+  gem.summary = %q{Official OmniAuth strategy for Learn.co.}
+  gem.homepage = "https://github.com/pletcher/omniauth-learn"
+  gem.license = "MIT"
+
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "omniauth-learn"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::Learn::VERSION
+
+  gem.add_dependency 'omniauth', '~> 1.0'
+  # Nothing lower than omniauth-oauth2 1.1.1
+  # http://www.rubysec.com/advisories/CVE-2012-6134/
+  gem.add_dependency 'omniauth-oauth2', '>= 1.1.1', '< 2.0'
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'dotenv'
+  gem.add_dependency 'rake'
+end

data/spec/omniauth-learn/strategies/learn_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Learn do
+
+  let(:access_token) { stub('AccessToken', :options => {}) }
+  let(:parsed_response) { stub('ParsedResponse') }
+  let(:response) { stub('Response', :parsed => parsed_response) }
+
+  let(:learn_site)          { 'https://learn.co' }
+  let(:learn_authorize_url) { 'https://learn.co/oauth/authorize' }
+  let(:learn_token_url)     { 'https://learn.co/oauth/token' }
+  let(:learn_authorizer) do
+    OmniAuth::Strategies::Learn.new(ENV['LEARN_KEY'], ENV['LEARN_SECRET'])
+  end
+
+  let(:custom_learn_authorizer) do 
+    OmniAuth::Strategies::Learn.new(ENV['LEARN_KEY'], ENV['LEARN_SECRET'],
+        {
+            :client_options => {
+                :site => "http://localhost:3000",
+                :authorize_url => "http://localhost:3000/oauth/authorize",
+                :token_url => "http://localhost:3000/oauth/token"
+            }
+        }
+    )
+  end
+
+  context "client options" do
+    it 'has the correct authorize_url' do
+      expect(learn_authorizer.client.options[:authorize_url]).to eq(learn_authorize_url)
+    end
+
+    it 'has the correct token_url' do 
+      expect(learn_authorizer.client.options[:token_url]).to eq(learn_token_url)
+    end
+
+    describe "should be overrideable" do
+      it "for authorize url" do
+        expect(custom_learn_authorizer.client.options[:authorize_url]).to eq("http://localhost:3000/oauth/authorize")
+      end
+
+      it "for token url" do
+        expect(custom_learn_authorizer.client.options[:token_url]).to eq("http://localhost:3000/oauth/token")
+      end
+    end
+  end
+
+  context "raw info" do 
+
+    before(:each) do 
+      learn_authorizer.stub(:access_token).and_return(access_token)
+      allow(learn_authorizer.access_token).to receive(:get).and_return(parsed_response)
+      res = learn_authorizer.access_token.get("/api/v1/users/me")
+      allow(res).to receive(:parsed).and_return(parsed_response)
+    end
+
+    it "should be set equal to the response that the access token fetches from the Learn API" do
+      expect(learn_authorizer.raw_info).to eq(parsed_response)
+    end
+
+    context "info" do 
+      before do
+        allow(learn_authorizer).to receive(:raw_info).and_return({"email" => "sophie@email.com"})
+        allow(learn_authorizer.access_token).to receive(:token).and_return("testToken")
+        allow(learn_authorizer.raw_info).to receive(:merge).and_return({"email" => "sophie@email.com", "token" => "testToken"})
+      end
+
+      it "constructs the info hash from the raw_info hash and the access token" do 
+        expect(learn_authorizer.info).to eq({"email" => "sophie@email.com", "token" => "testToken"})
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-learn'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+end
+

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-learn
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sophie DeBenedetto
+- Charles Pletcher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Official OmniAuth strategy for Learn.co.
+email:
+- sophie@flatironschool.com
+- chuck@flatironschool.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-learn.rb
+- lib/omniauth-learn/version.rb
+- lib/omniauth/strategies/learn.rb
+- omniauth-learn.gemspec
+- spec/omniauth-learn/strategies/learn_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pletcher/omniauth-learn
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Official OmniAuth strategy for Learn.co.
+test_files:
+- spec/omniauth-learn/strategies/learn_spec.rb
+- spec/spec_helper.rb