omniauth-mlh 0.3.0 → 0.3.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjkzNTk2YzE3MTlhOTJmYmQwNzFiM2Y2Yjc1MTE1MTdmNjgyYThlNw==
-  data.tar.gz: !binary |-
-    MmIwODYzYWFkYzVjMmY2OTdlZjliMmYyMzQxMzE1MmI3YTM2ODUzNw==
+SHA1:
+  metadata.gz: 03307dc90020f08280faac875faec0ac71111031
+  data.tar.gz: e1829e9813ca6b21319006f5de592877e87ba7ea
 SHA512:
-  metadata.gz: !binary |-
-    YTViNzg1MzdhZmI3MmI5MmFmNWZmZGNlYTcxNTcyNTlkNDcwYzQ0YjJhNDdh
-    ZDcwODExMWY4MTU5OGZkYjhmNTVhMTFhNzYzYjhiODExODk4ZmQxM2NlZWEw
-    NjNhMmYzMmY4OTJmNjAyZmMwOWZhMTZjN2M1MWI1NDdhMGFmMTI=
-  data.tar.gz: !binary |-
-    MTQ4NmM5ODdiN2FjN2FiNzJlNGExMGFmZWY4Njc2NWVhYTQzYjBhZDFjYjlm
-    MTA0M2ZhY2E5YmViOWQ0MTg3YTJkYjg4NDQwMzAwNzNmYzJmYjlkOTA1OWI0
-    Y2YxNTMxNDJjZGU0Y2M0MjY1ZjhkOTdkODYwMDcxNTMwOTFiMmQ=
+  metadata.gz: 2135d947f6b2c3f1982157648d2deb43a36fccfb28dbec1b8d9878e1070934f8faf63414bf3be376aa3a3ac9f33c7003b9a60cc2e17256be8308ef82a68ee1d4
+  data.tar.gz: 7da3955342e679c494f88f3237a509c536aebba722568c39b0095f16e2fec1be513bb62593c820bdc86fb85fc266e70ac27636c6af7860face5e9799559652e8

data/.ruby-version

@@ -0,0 +1 @@
+2.2.4

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.2.1
+  - 2.2.4

data/README.md

@@ -1,16 +1,14 @@
-# OmniAuth MLH
+# MLH/my-mlh-omniauth
 
-This is the official OmniAuth strategy for authenticating to My MLH. To use
-it, you'll need to sign up for an OAuth2 Application ID and Secret on the
-[My MLH Applications Page](https://my.mlh.io/oauth/applications).
+[![Build Status](https://travis-ci.org/MLH/my-mlh-omniauth.svg?branch=master)](https://travis-ci.org/MLH/my-mlh-omniauth)
 
-# Usage
+This is the official [OmniAuth](https://github.com/omniauth/omniauth) strategy for
+authenticating with [MyMLH](https://my.mlh.io). To use it, you'll need to 
+[register an application](https://my.mlh.io/oauth/applications) and obtain a OAuth Application ID and Secret from MyMLH.
 
-```
-use OmniAuth::Builder do
-  provider :mlh, ENV['MLH_KEY'], ENV['MLH_SECRET']
-end
-```
+It now supports [MyMLH API V2](http://news.mlh.io/introducing-mymlh-v2-09-29-2016). [Read the MyMLH V2 docs here](https://my.mlh.io/docs).
+
+Once you have done so, you can follow the instructions below:
 
 ## Installation
 
@@ -28,17 +26,39 @@ Or install it yourself as:
 
     $ gem install omniauth-mlh
 
+## Usage (Rack)
+
+```ruby
+use OmniAuth::Builder do
+  provider :mlh, ENV['MY_MLH_KEY'], ENV['MY_MLH_SECRET'], scope: 'default email birthday'
+end
+```
+
+## Usage (Rails with Devise)
+
+```ruby
+# config/devise.rb
+
+Devise.setup do |config|
+  config.provider :mlh, ENV['MY_MLH_KEY'], ENV['MY_MLH_SECRET'], scope: 'default email birthday'
+end
+```
+
 ## Contributing
 
-1. Fork it ( https://github.com/mlh/omniauth-mlh/fork )
+1. Fork it ( https://github.com/mlh/my-mlh-omniauth/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+## Credit
+
+We used part of [datariot/omniauth-paypal](http://github.com/datariot/omniauth-paypal)'s code to help us test this gem.
+
 ## Questions?
 
 Have a question about the API or this library? Start by checking out the
-[official My MLH documentation](https://my.mlh.io/docs). If you still can't
+[official MyMLH documentation](https://my.mlh.io/docs). If you still can't
 find an answer, tweet at [@MLHacks](http://twitter.com/mlhacks) or drop an
-email to [hi@mlh.io](mailto://hi@mlh.io).
+email to [engineering@mlh.io](mailto:engineering@mlh.io).

data/lib/omniauth/strategies/mlh.rb

@@ -1,4 +1,5 @@
 require 'omniauth-oauth2'
+require 'ostruct'
 
 module OmniAuth
   module Strategies
@@ -6,38 +7,35 @@ module OmniAuth
       option :name, :mlh
 
       option :client_options, {
-        :site => 'https://my.mlh.io',
+        :site            => 'https://my.mlh.io',
         :authorize_path  => '/oauth/authorize',
-        :token_path => '/oauth/token'
+        :token_path      => '/oauth/token'
       }
 
-      uid { raw_info['data']['id'] }
+      uid { data[:id] }
 
       info do
-        {
-          :email                => raw_info['data']['email'],
-          :created_at           => raw_info['data']['created_at'],
-          :updated_at           => raw_info['data']['updated_at'],
-          :first_name           => raw_info['data']['first_name'],
-          :last_name            => raw_info['data']['last_name'],
-          :level_of_study       => raw_info['data']['level_of_study'],
-          :major                => raw_info['data']['major'],
-          :shirt_size           => raw_info['data']['shirt_size'],
-          :dietary_restrictions => raw_info['data']['dietary_restrictions'],
-          :special_needs        => raw_info['data']['special_needs'],
-          :date_of_birth        => raw_info['data']['date_of_birth'],
-          :gender               => raw_info['data']['gender'],
-          :phone_number         => raw_info['data']['phone_number'],
-          :scopes               => raw_info['data']['scopes'],
-          :school               => {
-                                  :id =>   raw_info['data']['school']['id'],
-                                  :name => raw_info['data']['school']['name'],
-                                }
-        }
+        data.slice(
+          :email,
+          :created_at,
+          :updated_at,
+          :first_name,
+          :last_name,
+          :level_of_study,
+          :major,
+          :shirt_size,
+          :dietary_restrictions,
+          :special_needs,
+          :date_of_birth,
+          :gender,
+          :phone_number,
+          :scopes,
+          :school
+        )
       end
 
-      def raw_info
-        @raw_info ||= access_token.get('/api/v2/user.json').parsed
+      def data
+        @data ||= access_token.get('/api/v2/user.json').parsed.deep_symbolize_keys[:data] rescue {}
       end
     end
   end

data/lib/omniauth-mlh/version.rb

@@ -1,5 +1,9 @@
 module OmniAuth
   module MLH
-    VERSION = "0.3.0"
+    MAJOR_VERSION = 0
+    MINOR_VERSION = 3
+    RELEASE_VERSION = 1
+
+    VERSION = [MAJOR_VERSION, MINOR_VERSION, RELEASE_VERSION].join('.')
   end
 end

data/lib/omniauth-mlh.rb

@@ -1,2 +1,3 @@
+require "active_support"
 require "omniauth-mlh/version"
 require "omniauth/strategies/mlh"

data/omniauth-mlh.gemspec

@@ -14,6 +14,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "http://github.com/mlh/omniauth-mlh"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = '>= 2.2.4'
+
   spec.executables    = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.files          = `git ls-files`.split("\n")
   spec.test_files     = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -21,8 +23,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'omniauth', '~> 1.0'
   spec.add_dependency 'omniauth-oauth2', '~> 1.3.1'
+  spec.add_dependency 'activesupport'
 
   spec.add_development_dependency 'rspec', '~> 2.7'
+  spec.add_development_dependency 'rake', '~> 10.5'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'

data/spec/omniauth/mlh_spec.rb

@@ -2,16 +2,35 @@ require 'spec_helper'
 
 describe OmniAuth::MLH do
   subject do
-    OmniAuth::Strategies::MLH.new({})
+    OmniAuth::Strategies::MLH.new(nil, @options || {})
   end
 
-  context "client options" do
-    it 'should have correct site' do
-      expect(subject.options.client_options.site).to eq('https://my.mlh.io')
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct MyMLH site' do
+      expect(subject.client.site).to eq('https://my.mlh.io')
+    end
+
+    it 'has correct authorize url' do
+      expect(subject.client.options[:authorize_url]).to eq('/oauth/authorize')
+    end
+
+    it 'has correct token url' do
+      expect(subject.client.options[:token_url]).to eq('/oauth/token')
+    end
+
+    it 'runs the setup block if passed one' do
+      counter = ''
+      @options = { :setup => Proc.new { |env| counter = 'ok' } }
+      subject.setup_phase
+      expect(counter).to eq("ok")
     end
+  end
 
-    it 'should have correct authorize url' do
-      expect(subject.options.client_options.authorize_path).to eq('/oauth/authorize')
+  describe '#callback_path' do
+    it "has the correct callback path" do
+      expect(subject.callback_path).to eq('/auth/mlh/callback')
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,14 +1,20 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
 require 'simplecov'
 SimpleCov.start
+
+require 'bundler/setup'
 require 'rspec'
 require 'rack/test'
 require 'webmock/rspec'
 require 'omniauth'
 require 'omniauth-mlh'
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
 
 RSpec.configure do |config|
   config.include WebMock::API
   config.include Rack::Test::Methods
   config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+
+  OmniAuth.config.test_mode = true
 end

data/spec/support/shared_examples.rb

@@ -0,0 +1,39 @@
+# Credit: https://github.com/datariot/omniauth-paypal/blob/master/spec/support/shared_examples.rb
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+
+shared_examples 'an oauth2 strategy' do
+  describe '#client' do
+    it 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      expect(subject.client.options[:authorize_url]).to eq('https://example.com')
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :authorize_params => { :foo => 'bar', :baz => 'zip' } }
+      expect(subject.authorize_params['foo']).to eq('bar')
+      expect(subject.authorize_params['baz']).to eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :authorize_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      expect(subject.authorize_params['scope']).to eq('bar')
+      expect(subject.authorize_params['foo']).to eq('baz')
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any token params passed in the :token_params option' do
+      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
+      expect(subject.token_params['foo']).to eq('bar')
+      expect(subject.token_params['baz']).to eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :token_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      expect(subject.token_params['scope']).to eq('bar')
+      expect(subject.token_params['foo']).to eq('baz')
+    end
+  end
+end

metadata

@@ -1,97 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-mlh
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Swift
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-24 00:00:00.000000000 Z
+date: 2016-11-14 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.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
 - !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
 - !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'
 description: Official OmniAuth strategy for My MLH.
@@ -101,9 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -114,6 +143,7 @@ files:
 - omniauth-mlh.gemspec
 - spec/omniauth/mlh_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples.rb
 homepage: http://github.com/mlh/omniauth-mlh
 licenses:
 - MIT
@@ -124,21 +154,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Official OmniAuth strategy for My MLH.
 test_files:
 - spec/omniauth/mlh_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 
+- spec/support/shared_examples.rb