omniauth-positionly 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a02a94cf15ec1636e7297f5daf1b2f9f5f4c059
+  data.tar.gz: 6efb178cff0c850f36b8763628690cb2d0e931bd
+SHA512:
+  metadata.gz: 0ea8108cc528dc96ad7d3736f24ef6e428c35b633b6b871c06c5a8598f115c3f39fb57ff8f7f5be4bb91d5d818860cf76fbebd68be315a2a3bbcf011e1db1f6d
+  data.tar.gz: d8d4d71748619b9d9cc84f4c8769cab307d7e65a966f9af308e258364a1109fcb3de7b4a29634a806dd5b4ac770ea87a397b691d78c34a798890c4bb832d9e9c

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    omniauth-positionly (0.1.0)
+      omniauth-oauth2 (~> 1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    hashie (2.0.4)
+    httpauth (0.2.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.6)
+    multipart-post (1.2.0)
+    oauth2 (0.8.1)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    omniauth (1.1.4)
+      hashie (>= 1.2, < 3)
+      rack
+    omniauth-oauth2 (1.1.1)
+      oauth2 (~> 0.8.0)
+      omniauth (~> 1.0)
+    rack (1.5.2)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-positionly!
+  rake
+  rspec

data/README.md

@@ -0,0 +1,16 @@
+# OmniAuth Positionly
+
+This gem contains the Positionly strategy for OmniAuth.
+
+## How To Use It
+
+Usage is as per any other OmniAuth 1.0 strategy. So let's say you're using Rails, you need to add the strategy to your `Gemfile`:
+
+    gem 'omniauth-positionly', git: "git@github.com:positionly/omniauth-positionly.git", require: false
+
+Once these are in, you need to add the following to your `config/initializers/omniauth.rb`:
+
+	require "omniauth-positionly"
+	Rails.application.config.middleware.use  OmniAuth::Strategies::Positionly, "IDENTIFIER", "SECRET"
+
+You will obviously have to put in your identifier and secret, which you get when you register new client app with Positionly

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/omniauth-positionly.rb

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

data/lib/omniauth-positionly/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Positionly
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/positionly.rb

@@ -0,0 +1,43 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Positionly < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "read"
+
+      option :name, 'positionly'
+      option :authorize_options, [:scope, :account_domain]
+
+      option :client_options, {
+        :site          => 'https://api.positionly.com',
+        :authorize_url => '/oauth2/authorize',
+        :token_url     => '/oauth2/token'
+      }
+
+      def authorize_params
+        super.tap do |params|
+          %w(scope account_domain).each do |k|
+            params[k.to_sym] = request.params[k] unless [nil, ''].include?(request.params[k])
+          end
+          params[:scope] ||= DEFAULT_SCOPE
+        end
+      end
+
+      uid { raw_info['id'] }
+
+      info do
+        raw_info
+      end
+
+      extra do
+        hash = {}
+        hash[:raw_info] = raw_info unless skip_info?
+        hash
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("/v1/addons/user.json").parsed
+      end
+    end
+  end
+end

data/omniauth-positionly.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-positionly/version"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Piotr Chmolowski"]
+  gem.email         = ["piotr@positionly.com"]
+  gem.description   = %q{Omniauth plugin for Positionly API}
+  gem.summary       = %q{Omniauth plugin for Positionly API}
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  gem.name          = "omniauth-positionly"
+  gem.require_paths = ["lib"]
+  gem.version       = Omniauth::Positionly::VERSION
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.1'
+end

data/spec/omniauth/strategies/positionly_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'omniauth-positionly'
+
+describe OmniAuth::Strategies::Positionly do
+  def app; lambda{|env| [200, {}, ["Hello."]]} end
+
+  before :each do
+    OmniAuth.config.test_mode = true
+    @request = double('Request')
+    @request.stub(:params) { {} }
+    @request.stub(:cookies) { {} }
+    @request.stub(:env) { {} }
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  subject do
+    args = ['appid', 'secret', @options || {}].compact
+    OmniAuth::Strategies::Positionly.new(app, *args).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct auth url' do
+      subject.client.site.should eq('https://api.positionly.com')
+    end
+
+    it 'has correct auth path' do
+      subject.client.options[:authorize_url].should eq('/oauth2/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/oauth2/token')
+    end
+  end
+
+  describe '#callback_path' do
+    it 'has the correct callback path' do
+      subject.callback_path.should eq('/auth/positionly/callback')
+    end
+  end
+
+  describe '#authorize_params' do
+    describe 'scope' do
+      it 'should set default scope to "read"' do
+        @options = { :authorize_options => [:scope]}
+        subject.authorize_params['scope'].should eq('read')
+      end
+
+      it 'should dynamically set the scope in the request' do
+        @options = {:scope => 'fooscope'}
+        subject.stub(:request) { double('Request', {:params => { 'scope' => 'barscope' }, :env => {}}) }
+        subject.authorize_params['scope'].should eq('barscope')
+      end
+    end
+  end
+
+  describe 'raw info' do
+    it 'should include raw_info in extras hash by default' do
+      subject.stub(:raw_info) { { :foo => 'bar' } }
+      subject.extra[:raw_info].should eq({ :foo => 'bar' })
+    end
+
+    it 'should not include raw_info in extras hash when skip_info is specified' do
+      @options = { :skip_info => true }
+      subject.extra.should_not have_key(:raw_info)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+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,36 @@
+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 '#authorize_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :authorize_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.authorize_params['foo'].should eq('bar')
+      subject.authorize_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :authorize_options => [:scope, :foo], :scope => 'http://bar', :foo => 'baz' }
+      subject.authorize_params['scope'].should eq('http://bar')
+      subject.authorize_params['foo'].should 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' } }
+      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 :token_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,96 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-positionly
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Chmolowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: Omniauth plugin for Positionly API
+email:
+- piotr@positionly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/omniauth-positionly.rb
+- lib/omniauth-positionly/version.rb
+- lib/omniauth/strategies/positionly.rb
+- omniauth-positionly.gemspec
+- spec/omniauth/strategies/positionly_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: 
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Omniauth plugin for Positionly API
+test_files: []