omniauth-kona 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 570d25af43dac608793a7264388ff898969ecc8b
+  data.tar.gz: 363b7854c1b6a01ef6f523079ff4da5365c477cd
+SHA512:
+  metadata.gz: c276786745b5b8c487e79b111e4c637114617903a4072c85652b50936b0cb1d2be12c1e1efa76a035c64e9acd74011d0f73e953e515204119f3ddac6cc00cd11
+  data.tar.gz: 18037b9e05f506ac920eaf1e6df2aafc17f119668dbd76ccea9ca65529ba61edf3974fc95c1fecebba3d91958b1e809d6208825e344393663ae0fd52e8753511

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+.yardoc
+Gemfile.lock
+_yardoc/
+coverage/
+doc/
+pkg/
+spec/reports/
+tmp/
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/History.md

@@ -0,0 +1,3 @@
+## Version 0.1.0
+### Added
+* Initial pass

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ronald Salas
+
+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/README.md

@@ -0,0 +1,98 @@
+# OmniAuth Kona
+
+OmniAuth strategy for authenticating your users using Kona.
+
+[ ![Codeship Status for ronaldsalas/omniauth-kona](https://codeship.com/projects/4bb85690-450f-0133-7583-6641cf1712e7/status?branch=master)](https://codeship.com/projects/104599)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-kona'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-kona
+
+## Usage
+
+In your Kona Business account administration, register your application to get the Client ID and Client secret. Make sure that you put `http://YOURSERVER/auth/kona/callback` in the redirect URI field, with `YOURSERVER` is your application's server name (and port number if any). Kona matches exactly the redirect URI passed by the gem to the URI it has on record to authenticate the user, so make sure that you put in the correct URI.
+
+Afterwards you can add the middleware in your Rails app in `config/initializers/omniauth.rb`
+
+```ruby
+    Rails.application.config.middleware.use OmniAuth::Builder do
+        provider :kona, "ClientID", "ClientSecret"
+    end
+```
+
+You can check out the Sinatra example included.
+
+### Connecting to the sandbox environment
+
+You can connect your app to Kona's sandbox environment for testing purposes. First, get a KB account in their sandbox environment so that you can register your app. Then add the following hash to the middleware configuration:
+
+```ruby
+    Rails.application.config.middleware.use OmniAuth::Builder do
+        provider :kona, "ClientID", "ClientSecret",
+            {
+               :client_options => {
+                    :site => 'https://sandbox.kona.com',
+                    :authorize_url => 'https://sandbox.kona.com/oauth/authorize',
+                    :token_url => 'https://sandbox.kona.com/oauth/token'
+               }
+           }
+    end
+```
+
+## Auto Hash schema
+
+The Kona OmniAuth strategy returns the following information
+
+```
+    {
+      "provider":"kona",
+      "uid":integer,
+      "info":{
+        "email":string,
+        "name":string,
+        "image":string, url
+        },
+      "credentials":{
+        "token":string,
+        "refresh_token":string,
+        "expires_at":datetime,
+        "expires":true},
+      "extra":{
+        "raw_info":{
+          "id":integer,
+          "email":string,
+          "name":string,
+          "picture_thumb":string, url,
+          "updated_at":datetime, ,
+          "href":string, url,
+          "current_account":{
+            "id":integer,
+            "member":boolean}
+        }
+      }
+    }
+```
+
+### Guest Members
+
+We have provided the key `member` under the `extra` hash to identify if user is a member of the Kona Business account or not
+
+## Contributing
+
+1. Fork it ( https://github.com/ronaldsalas/omniauth-kona/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

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :default => :spec

data/example/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'omniauth-kona', :path => ".."

data/example/config.ru

@@ -0,0 +1,32 @@
+# Sample app for Kona OAuth2 Strategy
+# Make sure to setup the ENV variables CLIENT_ID and CLIENT_SECRET
+# Run with "bundle exec rackup"
+# On your browser, visit http://localhost:9292
+
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-kona'
+
+class App < Sinatra::Base
+  get '/' do
+    "<a href='/auth/kona'>Log in with Kona</a>"
+  end
+
+  get '/auth/kona/callback' do
+    content_type 'application/json'
+    MultiJson.encode(request.env['omniauth.auth'])
+  end
+
+  get '/auth/failure' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+end
+
+use Rack::Session::Cookie, :secret => 'iduf93ub9sdhfusdhf' # replace this with your own secret
+
+use OmniAuth::Builder do
+  provider :kona, ENV['CLIENT_ID'], ENV['CLIENT_SECRET']
+end
+
+run App.new

data/lib/omniauth/strategies/kona.rb

@@ -0,0 +1,38 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Kona < OmniAuth::Strategies::OAuth2
+      option :name, "kona"
+      option :client_options, {
+                 :site => 'https://io.kona.com',
+                 :authorize_url => 'https://io.kona.com/oauth/authorize',
+                 :token_url => 'https://io.kona.com/oauth/token'
+                }
+
+      def request_phase
+        super
+      end
+
+      uid { raw_info['id']}
+
+      info do
+        {
+            'email' => raw_info['email'],
+            'name' => raw_info['name'],
+            'image' => raw_info['picture_thumb']
+        }
+      end
+
+      extra do
+        { 'raw_info' => raw_info }
+      end
+
+      def raw_info
+        @userinfo = access_token.get('/api/userinfo').parsed
+        @raw_info ||= @userinfo['users'][0]
+      end
+
+    end
+  end
+end

data/lib/omniauth-kona/version.rb

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

data/lib/omniauth-kona.rb

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

data/omniauth-kona.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-kona/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-kona"
+  spec.version       = Omniauth::Kona::VERSION
+  spec.authors       = ["Ronald Salas"]
+  spec.email         = ["ronaldsalas@deltek.com"]
+
+  spec.summary       = 'Kona OAuth2 strategy for Omniauth'
+  spec.homepage      = 'https://github.com/ronaldsalas/omniauth-kona'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth-oauth2'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-kona
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ronald Salas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-24 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: 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'
+description: 
+email:
+- ronaldsalas@deltek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- History.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/Gemfile
+- example/config.ru
+- lib/omniauth-kona.rb
+- lib/omniauth-kona/version.rb
+- lib/omniauth/strategies/kona.rb
+- omniauth-kona.gemspec
+homepage: https://github.com/ronaldsalas/omniauth-kona
+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: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Kona OAuth2 strategy for Omniauth
+test_files: []