omniauth-piryx 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16f5d1e16c73fb8382eacd4601e6f41227b99714
-  data.tar.gz: a74f73bd365dfba0fd3d49bec2249e147b0dcf60
+  metadata.gz: f40b804ebbc151265a94ce59e9720a24327ff49e
+  data.tar.gz: 660507e61abd2bf592f0e7da1514096611e708c9
 SHA512:
-  metadata.gz: ef1cecaa21b50eedaa522c7cf7fb0051278af3d0c27aa6da6d5ed703d0f2e6d740931d140b526a5f6d954c8696693f7542c0166a37b3ac128938602400ba6c11
-  data.tar.gz: 3f91a5ca390cbf639c8845f5ba609b75a1603b36846e62f3f19ef9b5887ee7c2576368f233c7d417618356d1f4ce25d3578c0369abdd807aa226152e2e19b13f
+  metadata.gz: 99f27167d516a7b46020af088b4fb5d4c05053247eba28462124b3a1dfb0a114c95ca7e3a4e777cbd7a8bf2899363f18271e452d35d51785d917be2f428068f5
+  data.tar.gz: 2602e02dba5874db2a29a67cdd8dff01c97cd02bc8723da415f62fd7e5d40dbde5a64fb5ddf378652489f5c5def42b12c7026934c1dd95042bc07c8f2d0c8c7b

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+/.ruby-version
+/.ruby-gemset

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1
+
+Project created and added to github.

data/Gemfile

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

data/README.md

@@ -0,0 +1,31 @@
+# Omniauth Automatic Strategy
+
+[![Build Status](https://travis-ci.org/SparkartGroupInc/omniauth-google-oauth2.png)](https://travis-ci.org/SparkartGroupInc/omniauth-google-oauth2)
+
+[Piryx](http://www.piryx.com) [`omniauth`](http://rubygems.org/gems/omniauth) OAuth2 strategy.
+
+## Installation
+
+```
+gem 'omniauth-piryx'
+bundle
+```
+
+## Usage
+
+Sign up for Piryx and [create an application](http://www.piryx.com/developers/). Once you have the client id and client secret associate them with the OmniAuth strategy.
+
+
+### Example Integration
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :piryx, ENV["PIRYX_CLIENT_ID"], ENV["PIRYX_CLIENT_SECRET"], scope: "never_expire,create_payment,payment_details,payment_summary", sandbox: !Rails.env.production?
+end
+```
+
+If a value for sandbox is not passed in the production API will always be used instead.
+
+### Scopes
+
+You can change the permissions by selecting from the [scopes available](http://dev.piryx.com/docs/oauth.html) and passing them into the configuration above. The default scopes set by this middleware are `create_payment` and `payment_details.`

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/omniauth-piryx.rb

@@ -0,0 +1 @@
+require File.join('omniauth', 'piryx')

data/lib/omniauth/piryx.rb

@@ -0,0 +1 @@
+require File.join('omniauth', 'strategies', 'piryx')

data/lib/omniauth/piryx/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Piryx
+    VERSION = "0.0.2"
+  end
+end

data/lib/omniauth/strategies/piryx.rb

@@ -0,0 +1,70 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Piryx < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "create_payment,payment_details"
+      PRODUCTION_API = 'https://api.piryx.com'
+      OLD_PRODUCTION_API = 'https://secure.piryx.com'
+      SANDBOX_API = 'https://sandbox-api.piryx.com'
+      OLD_SANDBOX_API = 'http://demo.secure.piryx.com'
+
+      option :name, 'piryx'
+
+      option :client_options, {
+        authorize_url: '/oauth/authorize',
+        token_url: '/oauth/access_token'
+      }
+
+      option :authorize_options, [:response_type, :client_id, :redirect_uri, :scope]
+
+      option :auth_token_params, {
+        header_format: "OAuth %s",
+        mode: :header,
+        param_name: "oauth_token"
+      }
+
+      option :sandbox, false
+
+      def client
+        options.client_options[:site] ||= options.sandbox ? SANDBOX_API : PRODUCTION_API
+        ::OAuth2::Client.new(options.client_id, options.client_secret, deep_symbolize(options.client_options))
+      end
+
+      def authorize_params
+        super.tap do |params|
+          options.authorize_options.each do |k|
+            params[k] = request.params[k.to_s] unless [nil, ''].include?(request.params[k.to_s])
+          end
+
+          raw_scope = params[:scope] || DEFAULT_SCOPE
+          scope_list = raw_scope.split(" ").map {|item| item.split(",")}.flatten
+          params[:scope] = scope_list.join(" ")
+        end
+      end
+
+      uid { raw_info['Account']['Id'] }
+
+      info do
+        {
+          name: raw_info['Account']['Name'],
+          biography: raw_info['Account']['Biography'],
+          location: raw_info['Account']['Location'],
+          website_url: raw_info['Account']['WebsiteUrl']
+        }
+      end
+
+      extra do
+        hash = {}
+        hash[:id_token] = access_token.token
+        hash[:raw_info] = raw_info unless skip_info?
+        hash
+      end
+
+      def raw_info
+        api = options.sandbox ? OLD_SANDBOX_API : OLD_PRODUCTION_API
+        @raw_info ||= access_token.get(File.join(api, "api/accounts/me")).parsed
+      end
+    end
+  end
+end

data/omniauth-piryx.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path(File.join('..', 'lib', 'omniauth', 'piryx', 'version'), __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "omniauth-piryx"
+  gem.version       = OmniAuth::Piryx::VERSION
+  gem.license       = 'MIT'
+  gem.summary       = %q{Piryx OAuth2 strategy for OmniAuth 1.x}
+  gem.description   = %q{Piryx OAuth2 strategy for OmniAuth 1.x}
+  gem.authors       = ["Sparkart"]
+  gem.email         = ["product@sparkart.com"]
+  gem.homepage      = "https://github.com/SparkartGroupInc/omniauth-piryx"
+
+  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.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'omniauth', '>= 1.1.1'
+  gem.add_runtime_dependency 'omniauth-oauth2', '>= 1.1.1'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 2.7'
+end

data/spec/omniauth/strategies/piryx_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Piryx do
+  let(:request) { double('Request', params: {}, cookies: {}, env: {}) }
+  let(:app) {
+    lambda do
+      [200, {}, ["Hello World"]]
+    end
+  }
+
+  subject do
+    OmniAuth::Strategies::Piryx.new(app, 'appid', 'secret', @options || {}).tap do |strategy|
+      allow(strategy).to receive(:request) {
+        request
+      }
+    end
+  end
+
+  before do
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  describe 'client_options' do
+    context 'when sandbox is true' do
+      before { subject.options[:sandbox] = true }
+
+      it 'has correct site' do
+        expect(subject.client.site).to eq('https://sandbox-api.piryx.com')
+      end
+    end
+
+    context 'when sandbox is false' do
+      before { subject.options[:sandbox] = false }
+
+      it 'has correct site' do
+        expect(subject.client.site).to eq('https://api.piryx.com')
+      end
+    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/access_token')
+    end
+  end
+
+  describe "authorize_params" do
+    it 'should support persist authorized parameters' do
+      @options = {
+        response_type: "response_type", client_id: "client_id",
+        redirect_uri: "redirect_uri", scope: "scope", invalid: "invalid"
+      }
+
+      expect(subject.authorize_params['response_type']).to eq('response_type')
+      expect(subject.authorize_params['redirect_uri']).to eq('redirect_uri')
+      expect(subject.authorize_params['scope']).to eq('scope')
+      expect(subject.authorize_params['invalid']).to eq(nil)
+    end
+  end
+
+  describe 'extra' do
+    let(:client) do
+      OAuth2::Client.new('abc', 'def') do |builder|
+        builder.request :url_encoded
+        builder.adapter :test do |stub|
+          stub.get('/api/accounts/me') do |env|
+            [
+              200,
+              {'content-type' => 'application/json'},
+              '{"Account": {"Name": "George", "Biography": "None", "Location": "Heaven", "WebsiteUrl": "http://www.example.com"}}'
+            ]
+          end
+        end
+      end
+    end
+
+    let(:access_token) { OAuth2::AccessToken.from_hash(client, {}) }
+    before { allow(subject).to receive(:access_token).and_return(access_token) }
+
+    describe 'info' do
+      it 'should populate info' do
+        expect(subject.info[:name]).to eq("George")
+        expect(subject.info[:biography]).to eq("None")
+        expect(subject.info[:location]).to eq("Heaven")
+        expect(subject.info[:website_url]).to eq("http://www.example.com")
+      end
+    end
+
+    describe 'raw_info' do
+      context 'when skip_info is true' do
+        before { subject.options[:skip_info] = true }
+
+        it 'should not include raw_info' do
+          expect(subject.extra).not_to have_key(:raw_info)
+        end
+      end
+
+      context 'when skip_info is false' do
+        before { subject.options[:skip_info] = false }
+
+        it 'should include raw_info' do
+          expect(subject.extra[:raw_info]).to eq({"Account"=>{"Name"=>"George", "Biography"=>"None", "Location"=>"Heaven", "WebsiteUrl"=>"http://www.example.com"}})
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require 'omniauth-piryx'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-piryx
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sparkart
@@ -73,7 +73,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
 - LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-piryx.rb
+- lib/omniauth/piryx.rb
+- lib/omniauth/piryx/version.rb
+- lib/omniauth/strategies/piryx.rb
+- omniauth-piryx.gemspec
+- spec/omniauth/strategies/piryx_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/SparkartGroupInc/omniauth-piryx
 licenses:
 - MIT