omniauth-devpost 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cffa0603342e24acd9961652e4f0cc6df3501ca
+  data.tar.gz: 200fb44dfec674893f7aab5ea5689e6fa2da69df
+SHA512:
+  metadata.gz: 10ab9bfc9abe8cacf474fee5fe9a854584d8964652cdcd99be37436a4db13a78e57792200efe1110984dc726658a70a284799e88f946d7b4c41e469fd1f02a1a
+  data.tar.gz: 6a570c02de3198abbee74d5e33587cfd84444f2e0ff0b6b3a48fe287707f72ee635cd811062e41322156bb0eac1e5a5326d84624ad60df7b9954d2d038af24a1

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
+.ruby-version

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-devpost.gemspec
+gemspec
+
+gem 'pry'
+gem 'pry-debugger', platform: :ruby_19
+gem 'pry-byebug', platform: :ruby_21

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ross Kaffenberger
+
+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,29 @@
+# Omniauth::Devpost
+
+Use this gem to authenticate against the (future) Devpost user api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-devpost'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-devpost
+
+## Usage
+
+The Devpost OAuth protocol is supported but not yet publicly available.
+
+## 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,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+task default: :spec

data/lib/omniauth/strategies/devpost.rb

@@ -0,0 +1,63 @@
+require 'omniauth'
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Devpost < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "user"
+      OMNIAUTH_PROVIDER_SITE = ENV.fetch('OMNIAUTH_PROVIDER_SITE') { 'https://api.devpost.com' }
+      OMNIAUTH_AUTHORIZE_URL = ENV.fetch('OMNIAUTH_AUTHORIZE_URL') { 'https://oauth.devpost.com/oauth/authorize' }
+      OMNIAUTH_TOKEN_URL     = ENV.fetch('OMNIAUTH_TOKEN_URL') { 'https://oauth.devpost.com/oauth/token' }
+
+      option :name, "devpost"
+
+      option :client_options, {
+        :site => OMNIAUTH_PROVIDER_SITE,
+        :authorize_url => OMNIAUTH_AUTHORIZE_URL,
+        :token_url => OMNIAUTH_TOKEN_URL
+      }
+
+      option :authorize_options, [:scope]
+
+      # For more info, see https://github.com/intridea/omniauth/wiki/Auth-Hash-Schema
+
+      uid { raw_info['id'] }
+
+      info do
+        prune!({
+          'nickname' => raw_info['screen_name'],
+          'email' => raw_info['email'],
+          'location' => raw_info['location'],
+          'first_name' => raw_info['first_name'],
+          'last_name' => raw_info['last_name']
+        })
+      end
+
+      extra do
+        prune!({
+          'raw_info' => raw_info
+        })
+      end
+
+      def raw_info
+        @raw_info ||= raw_credentials_json["user"]
+      end
+
+      protected
+
+      def raw_credentials_json
+        @raw_credentials_json ||= begin
+                                    access_token.options[:mode] = :query
+                                    access_token.get('/user/credentials').parsed
+                                  end
+      end
+
+      def prune!(hash)
+        hash.delete_if do |_, value|
+          prune!(value) if value.is_a?(Hash)
+          value.nil? || (value.respond_to?(:empty?) && value.empty?)
+        end
+      end
+    end
+  end
+end

data/lib/omniauth-devpost/version.rb

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

data/lib/omniauth-devpost.rb

@@ -0,0 +1,7 @@
+require "omniauth-devpost/version"
+require "omniauth/strategies/devpost"
+
+module Omniauth
+  module Devpost
+  end
+end

data/omniauth-devpost.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-devpost/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ross Kaffenberger"]
+  gem.email         = ["rosskaff@gmail.com"]
+  gem.description   = %q{Official OmniAuth strategy for Devpost.}
+  gem.summary       = %q{Official OmniAuth strategy for Devpost.}
+  gem.homepage      = "https://github.com/challengepost/omniauth-devpost"
+
+  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{^spec/})
+  gem.name          = "omniauth-devpost"
+  gem.require_paths = ["lib"]
+  gem.version       = Omniauth::Devpost::VERSION
+
+  gem.add_dependency 'omniauth-oauth2', '~> 1.1'
+
+  gem.add_development_dependency 'rspec', '~> 3'
+  gem.add_development_dependency 'rake'
+end

data/spec/omniauth/strategies/devpost_spec.rb

@@ -0,0 +1,362 @@
+require 'spec_helper'
+require 'omniauth-devpost'
+require 'uri'
+
+describe OmniAuth::Strategies::Devpost do
+  before do
+    @request = double('Request')
+    allow(@request).to receive(:params) { {} }
+    allow(@request).to receive(:cookies) { {} }
+    allow(@request).to receive(:env) { {} }
+    allow(@request).to receive(:scheme) { 'http' }
+
+    @app_id = '123'
+    @app_secret = '53cr3tz'
+  end
+
+  subject do
+    args = [@app_id, @app_secret, @options].compact
+    OmniAuth::Strategies::Devpost.new(nil, *args).tap do |strategy|
+      allow(strategy).to receive(:request) { @request }
+    end
+  end
+
+  it { should be_a(OmniAuth::Strategies::OAuth2) }
+
+  describe '#client' do
+    it 'has correct Facebook site' do
+      expect(subject.client.site).to eq('https://api.devpost.com')
+    end
+
+    it 'has correct authorize url' do
+      expect(subject.client.options[:authorize_url]).to eq('https://oauth.devpost.com/oauth/authorize')
+    end
+
+    it 'has correct token url' do
+      expect(subject.client.options[:token_url]).to eq('https://oauth.devpost.com/oauth/token')
+    end
+  end
+
+  describe '#callback_url' do
+
+    it "returns the default callback url" do
+      url_base = 'http://auth.request.com'
+      allow(@request).to receive(:url) { "#{url_base}/some/page" }
+      allow(subject).to receive(:script_name) { '' } # as not to depend on Rack env
+      expect(subject.callback_url).to eq("#{url_base}/auth/devpost/callback")
+    end
+
+    it "returns path from callback_path option" do
+      url_base = 'http://auth.request.com'
+      @options = { :callback_path => "/auth/CP/done"}
+      allow(@request).to receive(:url) { "#{url_base}/some/page" }
+      allow(subject).to receive(:script_name) { '' } # as not to depend on Rack env
+      expect(subject.callback_url).to eq("#{url_base}/auth/CP/done")
+    end
+
+  end
+
+  describe '#uid' do
+    before :each do
+      allow(subject).to receive(:raw_info) { { 'id' => '123' } }
+    end
+
+    it 'returns the id from raw_info' do
+      expect(subject.uid).to eq('123')
+    end
+  end
+
+  describe '#info' do
+    context 'when optional data is not present in raw info' do
+      before :each do
+
+        allow(subject).to receive(:raw_info) { {} }
+      end
+
+      it 'has no email key' do
+        expect(subject.info).to_not have_key('email')
+      end
+
+      it 'has no nickname key' do
+        expect(subject.info).to_not have_key('nickname')
+      end
+
+      it 'has no first name key' do
+        expect(subject.info).to_not have_key('first_name')
+      end
+
+      it 'has no last name key' do
+        expect(subject.info).to_not have_key('last_name')
+      end
+
+      it 'has no location key' do
+        expect(subject.info).to_not have_key('location')
+      end
+
+    end
+
+    context 'when optional data is present in raw info' do
+      before :each do
+        @raw_info ||= { 'screen_name' => 'fredsmith' }
+        allow(subject).to receive(:raw_info) { @raw_info }
+      end
+
+      it 'returns the name' do
+        expect(subject.info['nickname']).to eq('fredsmith')
+      end
+
+      it 'returns the email' do
+        @raw_info['email'] = 'fred@smith.com'
+        expect(subject.info['email']).to eq('fred@smith.com')
+      end
+
+      it 'returns the username as nickname' do
+        @raw_info['screen_name'] = 'fredsmith'
+        expect(subject.info['nickname']).to eq('fredsmith')
+      end
+
+      it 'returns the first name' do
+        @raw_info['first_name'] = 'Fred'
+        expect(subject.info['first_name']).to eq('Fred')
+      end
+
+      it 'returns the last name' do
+        @raw_info['last_name'] = 'Smith'
+        expect(subject.info['last_name']).to eq('Smith')
+      end
+
+      it 'returns the location name as location' do
+        @raw_info['location'] = 'Palo Alto, California'
+        expect(subject.info['location']).to eq('Palo Alto, California')
+      end
+
+    end
+
+  end
+
+  describe '#raw_info' do
+    before :each do
+      @access_token = double('OAuth2::AccessToken', :options => {})
+      allow(subject).to receive(:access_token) { @access_token }
+    end
+
+    it 'performs a GET to /user/credentials' do
+      allow(@access_token).to receive(:get) { @access_token.as_null_object }
+      expect(@access_token).to receive(:get).with('/user/credentials')
+      subject.raw_info
+    end
+
+    it 'returns a Hash' do
+      allow(@access_token).to receive(:get).with('/user/credentials') do
+        raw_response = double('Faraday::Response')
+        allow(raw_response).to receive(:body) { '{ "user" : { "ohai": "thar" } }' }
+        allow(raw_response).to receive(:status) { 200 }
+        allow(raw_response).to receive(:headers) { { 'Content-Type' => 'application/json' } }
+        OAuth2::Response.new(raw_response)
+      end
+      expect(subject.raw_info).to be_a(Hash)
+      expect(subject.raw_info['ohai']).to eq('thar')
+    end
+  end
+
+end
+
+#   describe '#credentials' do
+#     before :each do
+#       @access_token = double('OAuth2::AccessToken')
+#       @access_token.stub(:token)
+#       @access_token.stub(:expires?)
+#       @access_token.stub(:expires_at)
+#       @access_token.stub(:refresh_token)
+#       subject.stub(:access_token) { @access_token }
+#     end
+
+#     it 'returns a Hash' do
+#       subject.credentials.should be_a(Hash)
+#     end
+
+#     it 'returns the token' do
+#       @access_token.stub(:token) { '123' }
+#       subject.credentials['token'].should eq('123')
+#     end
+
+#     it 'returns the expiry status' do
+#       @access_token.stub(:expires?) { true }
+#       subject.credentials['expires'].should eq(true)
+
+#       @access_token.stub(:expires?) { false }
+#       subject.credentials['expires'].should eq(false)
+#     end
+
+#     it 'returns the refresh token and expiry time when expiring' do
+#       ten_mins_from_now = (Time.now + 600).to_i
+#       @access_token.stub(:expires?) { true }
+#       @access_token.stub(:refresh_token) { '321' }
+#       @access_token.stub(:expires_at) { ten_mins_from_now }
+#       subject.credentials['refresh_token'].should eq('321')
+#       subject.credentials['expires_at'].should eq(ten_mins_from_now)
+#     end
+
+#     it 'does not return the refresh token when it is nil and expiring' do
+#       @access_token.stub(:expires?) { true }
+#       @access_token.stub(:refresh_token) { nil }
+#       subject.credentials['refresh_token'].should be_nil
+#       subject.credentials.should_not have_key('refresh_token')
+#     end
+
+#     it 'does not return the refresh token when not expiring' do
+#       @access_token.stub(:expires?) { false }
+#       @access_token.stub(:refresh_token) { 'XXX' }
+#       subject.credentials['refresh_token'].should be_nil
+#       subject.credentials.should_not have_key('refresh_token')
+#     end
+#   end
+
+#   describe '#extra' do
+#     before :each do
+#       @raw_info = { 'name' => 'Fred Smith' }
+#       subject.stub(:raw_info) { @raw_info }
+#     end
+
+#     it 'returns a Hash' do
+#       subject.extra.should be_a(Hash)
+#     end
+
+#     it 'contains raw info' do
+#       subject.extra.should eq({ 'raw_info' => @raw_info })
+#     end
+#   end
+
+#   describe '#signed_request' do
+#     context 'cookie/param not present' do
+#       it 'is nil' do
+#         subject.send(:signed_request).should be_nil
+#       end
+#     end
+
+#     context 'cookie present' do
+#       before :each do
+#         @payload = {
+#           'algorithm' => 'HMAC-SHA256',
+#           'code' => 'm4c0d3z',
+#           'issued_at' => Time.now.to_i,
+#           'user_id' => '123456'
+#         }
+
+#         @request.stub(:cookies) do
+#           { "fbsr_#{@client_id}" => signed_request(@payload, @client_secret) }
+#         end
+#       end
+
+#       it 'parses the access code out from the cookie' do
+#         subject.send(:signed_request).should eq(@payload)
+#       end
+#     end
+
+#     context 'param present' do
+#       before :each do
+#         @payload = {
+#           'algorithm' => 'HMAC-SHA256',
+#           'oauth_token' => 'XXX',
+#           'issued_at' => Time.now.to_i,
+#           'user_id' => '123456'
+#         }
+
+#         @request.stub(:params) do
+#           { 'signed_request' => signed_request(@payload, @client_secret) }
+#         end
+#       end
+
+#       it 'parses the access code out from the param' do
+#         subject.send(:signed_request).should eq(@payload)
+#       end
+#     end
+
+#     context 'cookie + param present' do
+#       before :each do
+#         @payload_from_cookie = {
+#           'algorithm' => 'HMAC-SHA256',
+#           'from' => 'cookie'
+#         }
+
+#         @request.stub(:cookies) do
+#           { "fbsr_#{@client_id}" => signed_request(@payload_from_cookie, @client_secret) }
+#         end
+
+#         @payload_from_param = {
+#           'algorithm' => 'HMAC-SHA256',
+#           'from' => 'param'
+#         }
+
+#         @request.stub(:params) do
+#           { 'signed_request' => signed_request(@payload_from_param, @client_secret) }
+#         end
+#       end
+
+#       it 'picks param over cookie' do
+#         subject.send(:signed_request).should eq(@payload_from_param)
+#       end
+#     end
+#   end
+
+#   describe '#request_phase' do
+#     describe 'params contain a signed request with an access token' do
+#       before do
+#         payload = {
+#           'algorithm' => 'HMAC-SHA256',
+#           'oauth_token' => 'm4c0d3z'
+#         }
+#         @raw_signed_request = signed_request(payload, @client_secret)
+#         @request.stub(:params) do
+#           { "signed_request" => @raw_signed_request }
+#         end
+
+#         subject.stub(:callback_url) { '/' }
+#       end
+
+#       it 'redirects to callback passing along signed request' do
+#         subject.should_receive(:redirect).with("/?signed_request=#{Rack::Utils.escape(@raw_signed_request)}").once
+#         subject.request_phase
+#       end
+#     end
+#   end
+
+#   describe '#build_access_token' do
+#     describe 'params contain a signed request with an access token' do
+#       before do
+#         @payload = {
+#           'algorithm' => 'HMAC-SHA256',
+#           'oauth_token' => 'm4c0d3z'
+#         }
+#         @raw_signed_request = signed_request(@payload, @client_secret)
+#         @request.stub(:params) do
+#           { "signed_request" => @raw_signed_request }
+#         end
+
+#         subject.stub(:callback_url) { '/' }
+#       end
+
+#       it 'returns a new access token from the signed request' do
+#         result = subject.build_access_token
+#         result.should be_an_instance_of(::OAuth2::AccessToken)
+#         result.token.should eq(@payload['oauth_token'])
+#       end
+#     end
+#   end
+
+# private
+
+#   def signed_request(payload, secret)
+#     encoded_payload = base64_encode_url(MultiJson.encode(payload))
+#     encoded_signature = base64_encode_url(signature(encoded_payload, secret))
+#     [encoded_signature, encoded_payload].join('.')
+#   end
+
+#   def base64_encode_url(value)
+#     Base64.encode64(value).tr('+/', '-_').gsub(/\n/, '')
+#   end
+
+#   def signature(payload, secret, algorithm = OpenSSL::Digest::SHA256.new)
+#     OpenSSL::HMAC.digest(algorithm, secret, payload)
+#   end
+# end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-devpost
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ross Kaffenberger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Official OmniAuth strategy for Devpost.
+email:
+- rosskaff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-devpost.rb
+- lib/omniauth-devpost/version.rb
+- lib/omniauth/strategies/devpost.rb
+- omniauth-devpost.gemspec
+- spec/omniauth/strategies/devpost_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/challengepost/omniauth-devpost
+licenses: []
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Official OmniAuth strategy for Devpost.
+test_files:
+- spec/omniauth/strategies/devpost_spec.rb
+- spec/spec_helper.rb