omniauth-square 0.1.1 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a8b8a2a024dd7a38a02d13cbf52067567c557bc
-  data.tar.gz: 98a8a96df1a87b05577a9d6d8743db5839d2f251
+  metadata.gz: 1fbc8b1e3899fde29413ae907a92edafe6e9abc9
+  data.tar.gz: 3048aa68a28366aed6b7b7c4556c6f9c405b4799
 SHA512:
-  metadata.gz: 70658d92c5fc8dcaa4b794c9162d85d5549ad2e71293e82b7d76ee194ebc532cb42fcdc1a5862f1384a315f19bac880b30fef33a6f69121317e146c21174e5f6
-  data.tar.gz: b8b2f6e4c76a595d7aaedf28af0e50c5493644416f75260dca54faf13cce8214a317c2a44000e097515bb0368baf5c4d764d6e06ae83c206e5152c31532ec170
+  metadata.gz: 8cb2528181d44ea921c1d4ce7f0aacdfc6ab62c5f7c4ec4909d9f3c8b67571f8d5c550ff8a3664c174e975ebe8bcb3cb87270767851c9afc21cec812fde5c003
+  data.tar.gz: ff69b8212bb7a13ed19d2923684e6188bd4aee22d1f064a7fdd01e1e016ab5262a158d8b9d0b29c3a12f754277a835cb336560e5294e6abec3265402e6180b6f

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+coverage

data/README.md

@@ -4,8 +4,6 @@ This gem contains the Square strategy for OmniAuth.
 
 Square uses the OAuth2 flow, you can read about it here: http://connect.squareup.com
 
-## This gem is unfinished at the moment.
-
 ## How To Use It
 
 So let's say you're using Rails, you need to add the strategy to your `Gemfile`:
@@ -28,7 +26,7 @@ Now just follow the README at: https://github.com/intridea/omniauth
 
 ## License
 
-Copyright (c) 2013 by [Daniel Archer](https://github.com/danieljacobarcher/), [Jen Aprahamian](https://github.com/jennifermarie/), [Adam Bouck](https://github.com/abouck/)
+Copyright (c) 2013 by [Daniel Archer](https://github.com/danieljacobarcher/), [Jen Aprahamian](https://github.com/jennifermarie/), [Adam Bouck](https://github.com/abouck/), [Ray Zane](https://github.com/rzane)
 
 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:
 

data/lib/omniauth/strategies/square.rb

@@ -3,64 +3,75 @@ require 'omniauth/strategies/oauth2'
 module OmniAuth
   module Strategies
     class Square < OmniAuth::Strategies::OAuth2
-      DEFAULT_SCOPE = 'merchant_id'
 
       option :client_options, {
-        :site => 'https://squareup.com/',
-        :authorize_url => 'https://squareup.com/oauth2/authorize',
-        :token_url => 'https://squareup.com/oauth2/token'
+        :site          => 'https://squareup.com/',
+        :authorize_url => '/oauth2/authorize',
+        :token_url     => '/oauth2/token'
       }
 
-      option :access_token_options, {
-        mode: :query,
-        header_format: 'OAuth %s'
-      }
-
-      option :provider_ignores_state, true
+      uid { raw_info['id'] }
 
-      def request_phase
-        super
+      info do
+        prune!(
+          :name     => raw_info["name"],
+          :email    => raw_info["email"],
+          :phone    => (raw_info["business_phone"]||{}).values.join(''),
+          :location => (raw_info["business_address"]||{})["locality"]
+        )
       end
 
-      uid { raw_info['merchant_id'] }
+      extra do
+        { :raw_info => raw_info }
+      end
 
-      info do
+      def raw_info
+        @raw_info ||= access_token.get('https://connect.squareup.com/v1/me').parsed
       end
 
-      credentials do
-        hash = {'token' => access_token.token}
-        hash.merge!('refresh_token' => access_token.refresh_token) if access_token.expires? && access_token.refresh_token
-        hash.merge!('expires_at' => access_token.expires_at) if access_token.expires?
-        hash.merge!('expires' => access_token.expires?)
-        hash.merge!('scope' => raw_info["scopes"] ? raw_info["scopes"].join(" ") : nil)
-        prune!(hash)
+      protected
+
+      def build_access_token
+        parsed_response = fetch_access_token
+
+        parsed_response['expires_at'] = Time.parse(parsed_response['expires_at']).to_i
+        parsed_response.merge!(deep_symbolize(options.auth_token_params))
+
+        ::OAuth2::AccessToken.from_hash(client, parsed_response)
       end
 
-      def raw_info
-        unless skip_info?
-          @raw_info ||= access_token.get('https://connect.squareup.com/v1/me').parsed
-        else
-          {}
-        end
+      private
+
+      def fetch_access_token
+        opts     = access_token_request_payload
+        response = client.request(client.options[:token_method], client.token_url, opts)
+        parsed   = response.parsed
+        error    = ::OAuth2::Error.new(response)
+        fail(error) if opts[:raise_errors] && !(parsed.is_a?(Hash) && parsed['access_token'])
+        parsed
       end
 
-      def authorize_params
-        super.tap do |params|
-          %w[state request_type session].each do |v|
-            if request.params[v]
-              params[v.to_sym] = request.params[v]
+      def access_token_request_payload
+        params = {
+          :code         => request.params['code'],
+          :redirect_uri => callback_url
+        }
 
-              # to support omniauth-oauth2's auto csrf protection
-              session['omniauth.state'] = params[:state] if v == 'state'
-              session['omniauth.request_type'] = params[:request_type] if v == 'request_type'
-            end
-          end
+        params.merge! client.auth_code.client_params
+        params.merge! token_params.to_hash(:symbolize_keys => true)
 
-          params[:scope] ||= DEFAULT_SCOPE
-        end
+        opts = {
+          :raise_errors => params.delete(:raise_errors),
+          :parse        => params.delete(:parse),
+          :headers      => {'Content-Type' => 'application/x-www-form-urlencoded'}
+        }
+
+        headers     = params.delete(:headers)
+        opts[:body] = params
+        opts[:headers].merge!(headers) if headers
+        opts
       end
 
-    private
       def prune!(hash)
         hash.delete_if do |_, value|
           prune!(value) if value.is_a?(Hash)
@@ -71,4 +82,4 @@ module OmniAuth
   end
 end
 
-OmniAuth.config.add_camelization 'square', 'Square'
+OmniAuth.config.add_camelization 'square', 'Square'

data/lib/omniauth-square/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Square
-    VERSION = "0.1.1"
+    VERSION = "0.9"
   end
 end

data/omniauth-square.gemspec

@@ -5,8 +5,8 @@ require "omniauth-square/version"
 Gem::Specification.new do |s|
   s.name        = "omniauth-square"
   s.version     = Omniauth::Square::VERSION
-  s.authors     = ["Daniel Archer", "Jennifer Aprahamian", "Adam Bouck"]
-  s.email       = ["me@dja.io", "j.aprahamian@gmail.com", "adam.j.bouck@gmail.com"]
+  s.authors     = ["Daniel Archer", "Jennifer Aprahamian", "Adam Bouck", "Ray Zane"]
+  s.email       = ["me@dja.io", "j.aprahamian@gmail.com", "adam.j.bouck@gmail.com", "raymondzane@gmail.com"]
   s.homepage    = "https://github.com/danieljacobarcher/omniauth-square"
   s.summary     = %q{Square OAuth strategy for OmniAuth}
   s.description = %q{Square OAuth strategy for OmniAuth}
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'omniauth-oauth2'
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.1.1'
   s.add_development_dependency 'rspec', '~> 2.7'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'simplecov'

data/spec/omniauth/strategies/square_spec.rb

@@ -1,117 +1,92 @@
 require 'spec_helper'
-require 'omniauth-square'
 
 describe OmniAuth::Strategies::Square do
   before :each do
-    @request = double('Request')
+    @request = double('Request', :scheme => '', :url => '')
     @request.stub(:params) { {} }
-    @client_id = '123'
-    @client_secret = 'afalsf'
-    @raw_info = {
-      'name' => 'Sebastian Rabuini',
-      'email' => 'sebas@wasabit.com.ar',
-      'bio' => 'Sebas',
-      'blog_url' => 'sebas_blog',
-      'online_bio_url' => 'http://wasabitlabs.com',
-      'twitter_url' => 'http://twitter.com/#!/sebasr',
-      'facebook_url' => 'http://www.facebook.com/sebastian.rabuini',
-      'linkedin_url' => 'http://www.linkedin.com/in/srabuini',
-      'follower_count' => 6,
-      'investor' => false,
-      'locations' => [
-        {'id' => 1963, 'tag_type' => 'LocationTag', 'name' => 'buenos aires',
-          'display_name' => 'Buenos Aires',
-          'angellist_url' => 'https://angel.co/buenos-aires'}
-      ],
-      'roles' => [
-        {'id' => 14726, 'tag_type' => 'RoleTag', 'name' => 'developer',
-          'display_name' => 'Developer',
-          'angellist_url' => 'https://angel.co/developer'},
-        {'id' => 14725, 'tag_type' => 'RoleTag', 'name' => 'entrepreneur',
-          'display_name' => 'Entrepreneur',
-          'angellist_url' => 'https://angel.co/entrepreneur-1'}
-      ],
-      'skills' => [
-        {"id" => 82532, "tag_type" => "SkillTag", "name" => "ruby on rails",
-          "display_name" => "Ruby on Rails",
-          "angellist_url" => "https://angel.co/ruby-on-rails-1"}
-      ],
-      'scopes' => ["email","comment","message","talent"],
-      'angellist_url' => 'https://angel.co/sebasr',
-      'image' => 'https://s3.amazonaws.com/photos.angel.co/users/90585-medium_jpg?1327684569'
-    }
   end
 
   subject do
-    args = [@client_id, @client_secret, @options].compact
-    OmniAuth::Strategies::Square.new(nil, *args).tap do |strategy|
+    OmniAuth::Strategies::Square.new(nil, @options || {}).tap do |strategy|
       strategy.stub(:request) { @request }
     end
   end
 
-  it_should_behave_like 'an oauth2 strategy'
-
   describe '#client' do
-    it 'has correct AngelList site' do
-      subject.client.site.should eq('https://angel.co/')
+    it 'has correct Square site' do
+      subject.client.site.should eq('https://squareup.com/')
     end
 
     it 'has correct authorize url' do
-      subject.client.options[:authorize_url].should eq('https://angel.co/api/oauth/authorize')
+      subject.client.options[:authorize_url].should eq('/oauth2/authorize')
     end
 
     it 'has correct token url' do
-      subject.client.options[:token_url].should eq('https://angel.co/api/oauth/token')
+      subject.client.options[:token_url].should eq('/oauth2/token')
     end
   end
 
   describe '#info' do
     before :each do
+      @raw_info = {
+        "id" => "JGHJ0343",
+        "name" => "Dave Davis",
+        "email" => "dave@example.com",
+        "country_code" => "US",
+        "language_code" => "en-US",
+        "business_name" => "Dave's Milkshakes",
+        "business_address" => {
+          "address_line_1" => "1455 Market St",
+          "locality" => "San Francisco",
+          "administrative_district_level_1" => "CA",
+          "postal_code" => "94103"
+        },
+        "business_phone" => {
+          "calling_code" => "+1",
+          "number" => "4155551234"
+        },
+        "business_type" => "restaurants"
+      }
+
       subject.stub(:raw_info) { @raw_info }
     end
 
     context 'when data is present in raw info' do
-      it 'returns the combined name' do
-        subject.info['name'].should eq('Sebastian Rabuini')
+      it 'returns the name' do
+        subject.info[:name].should eq('Dave Davis')
       end
 
-      it 'returns the bio' do
-        subject.info['bio'].should eq('Sebas')
+      it 'returns the email' do
+        subject.info[:email].should eq('dave@example.com')
       end
 
-      it 'returns the image' do
-        subject.info['image'].should eq(@raw_info['image'])
+      it 'returns the phone number' do
+        subject.info[:phone].should eq('+14155551234')
       end
 
-      it "return the email" do
-        subject.info['email'].should eq('sebas@wasabit.com.ar')
+      it 'returns the user location' do
+        subject.info[:location].should eq('San Francisco')
       end
 
-      it "return skills" do
-        subject.info['skills'].first['name'].should eq("ruby on rails")
+      it 'sets the location blank if business_address isnt provided' do
+        @raw_info.delete('business_address')
+        subject.info[:location].should be_nil
       end
-    end
-  end
-
-  describe '#authorize_params' do
-    before :each do
-      subject.stub(:session => {})
-    end
 
-    it 'includes default scope for email' do
-      subject.authorize_params['scope'].should eq('email')
+      it 'returns raw info' do
+        subject.extra[:raw_info]['business_name'].should eq("Dave's Milkshakes")
+      end
     end
   end
 
   describe '#credentials' do
     before :each do
       @access_token = double('OAuth2::AccessToken')
-      @access_token.stub(:token) { '123' } # Token is always required
+      @access_token.stub(:token)
       @access_token.stub(:expires?)
       @access_token.stub(:expires_at)
       @access_token.stub(:refresh_token)
       subject.stub(:access_token) { @access_token }
-      subject.stub(:raw_info) { @raw_info }
     end
 
     it 'returns a Hash' do
@@ -119,13 +94,10 @@ describe OmniAuth::Strategies::Square do
     end
 
     it 'returns the token' do
+      @access_token.stub(:token) { '123' }
       subject.credentials['token'].should eq('123')
     end
 
-    it "return scopes" do
-      subject.credentials['scope'].should eq("email comment message talent")
-    end
-
     it 'returns the expiry status' do
       @access_token.stub(:expires?) { true }
       subject.credentials['expires'].should eq(true)
@@ -157,4 +129,34 @@ describe OmniAuth::Strategies::Square do
       subject.credentials.should_not have_key('refresh_token')
     end
   end
+
+  describe '#build_access_token' do
+    it 'converts iso8601 expires_at to an integer' do
+      now = Time.now
+      subject.stub(:fetch_access_token).and_return({'expires_at' => now.iso8601})
+      token = subject.send(:build_access_token)
+      expect(token.expires_at).to eq(now.to_i)
+    end
+  end
+
+  describe '#access_token_request_payload' do
+    before do
+      @request.stub(:params).and_return('code' => '11111')
+      subject.stub(:callback_url).and_return('http://example.com')
+    end
+
+    let!(:payload) { subject.send(:access_token_request_payload) }
+
+    it 'sets the Content-Type header' do
+      expect(payload[:headers]['Content-Type']).to eq('application/x-www-form-urlencoded')
+    end
+
+    it 'sets the redirect_uri' do
+      expect(payload[:body][:redirect_uri]).to eq('http://example.com')
+    end
+
+    it 'sets the authorization code' do
+      expect(payload[:body][:code]).to eq('11111')
+    end
+  end
 end

data/spec/spec_helper.rb

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

metadata

@@ -1,31 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-square
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.9'
 platform: ruby
 authors:
 - Daniel Archer
 - Jennifer Aprahamian
 - Adam Bouck
+- Ray Zane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-13 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +88,7 @@ email:
 - me@dja.io
 - j.aprahamian@gmail.com
 - adam.j.bouck@gmail.com
+- raymondzane@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -101,7 +103,6 @@ files:
 - omniauth-square.gemspec
 - spec/omniauth/strategies/square_spec.rb
 - spec/spec_helper.rb
-- spec/support/shared_examples.rb
 homepage: https://github.com/danieljacobarcher/omniauth-square
 licenses:
 - MIT
@@ -129,4 +130,3 @@ summary: Square OAuth strategy for OmniAuth
 test_files:
 - spec/omniauth/strategies/square_spec.rb
 - spec/spec_helper.rb
-- spec/support/shared_examples.rb

data/spec/support/shared_examples.rb

@@ -1,23 +0,0 @@
-# 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' } }
-      subject.client.options[:authorize_url].should == 'https://example.com'
-    end
-  end
-
-  describe '#token_params' do
-    it 'should include any authorize params passed in the :authorize_params option' do
-      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
-      subject.token_params['foo'].should eq('bar')
-      subject.token_params['baz'].should eq('zip')
-    end
-
-    it 'should include top-level options that are marked as :authorize_options' do
-      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
-      subject.token_params['scope'].should eq('bar')
-      subject.token_params['foo'].should eq('baz')
-    end
-  end
-end