omniauth-square 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a8b8a2a024dd7a38a02d13cbf52067567c557bc
+  data.tar.gz: 98a8a96df1a87b05577a9d6d8743db5839d2f251
+SHA512:
+  metadata.gz: 70658d92c5fc8dcaa4b794c9162d85d5549ad2e71293e82b7d76ee194ebc532cb42fcdc1a5862f1384a315f19bac880b30fef33a6f69121317e146c21174e5f6
+  data.tar.gz: b8b2f6e4c76a595d7aaedf28af0e50c5493644416f75260dca54faf13cce8214a317c2a44000e097515bb0368baf5c4d764d6e06ae83c206e5152c31532ec170

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ..gemspec
+gemspec

data/README.md

@@ -0,0 +1,37 @@
+# OmniAuth Square
+
+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`:
+
+    gem 'omniauth-square'
+
+You can pull them in directly from github e.g.:
+
+    gem 'omniauth-square', :git => 'https://github.com/danieljacobarcher/omniauth-square.git'
+
+Once these are in, you need to add the following to your `config/initializers/omniauth.rb`:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :square, "consumer_key", "consumer_secret" 
+    end
+
+You will obviously have to put in your key and secret, which you get when you register your app with Square (they call them Application Key and Secret Key). 
+
+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/)
+
+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,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/omniauth-square.rb

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

data/lib/omniauth-square/version.rb

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

data/lib/omniauth/strategies/square.rb

@@ -0,0 +1,74 @@
+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'
+      }
+
+      option :access_token_options, {
+        mode: :query,
+        header_format: 'OAuth %s'
+      }
+
+      option :provider_ignores_state, true
+
+      def request_phase
+        super
+      end
+
+      uid { raw_info['merchant_id'] }
+
+      info do
+      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)
+      end
+
+      def raw_info
+        unless skip_info?
+          @raw_info ||= access_token.get('https://connect.squareup.com/v1/me').parsed
+        else
+          {}
+        end
+      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]
+
+              # 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[:scope] ||= DEFAULT_SCOPE
+        end
+      end
+
+    private
+      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
+
+OmniAuth.config.add_camelization 'square', 'Square'

data/omniauth-square.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+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.homepage    = "https://github.com/danieljacobarcher/omniauth-square"
+  s.summary     = %q{Square OAuth strategy for OmniAuth}
+  s.description = %q{Square OAuth strategy for OmniAuth}
+  s.license           = "MIT"
+
+  s.rubyforge_project = "omniauth-square"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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_development_dependency 'rspec', '~> 2.7'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/square_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+require 'omniauth-square'
+
+describe OmniAuth::Strategies::Square do
+  before :each do
+    @request = double('Request')
+    @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|
+      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/')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('https://angel.co/api/oauth/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('https://angel.co/api/oauth/token')
+    end
+  end
+
+  describe '#info' do
+    before :each do
+      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')
+      end
+
+      it 'returns the bio' do
+        subject.info['bio'].should eq('Sebas')
+      end
+
+      it 'returns the image' do
+        subject.info['image'].should eq(@raw_info['image'])
+      end
+
+      it "return the email" do
+        subject.info['email'].should eq('sebas@wasabit.com.ar')
+      end
+
+      it "return skills" do
+        subject.info['skills'].first['name'].should eq("ruby on rails")
+      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')
+    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(: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
+      subject.credentials.should be_a(Hash)
+    end
+
+    it 'returns the token' do
+      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)
+
+      @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 + 360).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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'rspec'
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,23 @@
+# 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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-square
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Daniel Archer
+- Jennifer Aprahamian
+- Adam Bouck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-13 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'
+  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: 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: Square OAuth strategy for OmniAuth
+email:
+- me@dja.io
+- j.aprahamian@gmail.com
+- adam.j.bouck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-square.rb
+- lib/omniauth-square/version.rb
+- lib/omniauth/strategies/square.rb
+- 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
+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: omniauth-square
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Square OAuth strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/square_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb