omniauth-vatsim 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd2adf8c01f5191152519f3d9d930856897bbb89
+  data.tar.gz: def59d5daf416be0919b0207dd5ec48f46c6def2
+SHA512:
+  metadata.gz: 2685f37a0f81dfc9384bf2eaeb9aa58b0357f972a18298d9d8ea799cc99bcac355aa73b112983cf745b093db48b74d7508d6fdedc31d6ce076b9cf6f30a54239
+  data.tar.gz: ddb622943ddf633d66e99a310ca10535acafb66d0727fb456c707ed5f3c4fbcc7299ece826df2451492eb122c27ed73db9fe169ef9941e4940497e8d0172ed94

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonathan P. Voss
+
+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,119 @@
+# OmniAuth VATSIM
+
+OmniAuth::Strategies::Vatsim is an OmniAuth strategy for authenticating with 
+the VATSIM SSO with OAuth1.
+
+Note: Currently only supports HMAC-SHA1 authentication
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-vatsim'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-vatsim
+
+## Usage
+
+Add the strategy to your ```Gemfile```:
+
+```ruby
+gem 'omniauth-vatsim'
+```
+
+Or you can pull it directly from github:
+
+```ruby
+gem 'omniauth-vatsim', git: 'https://github.com/jvoss/omniauth-vatsim.git'
+```
+
+For a Rails application you can now create an initializer ```config/initializers/omniauth.rb```:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :vatsim, 'app_id', 'app_secret', site: 'https://cert.vatsim.net/sso'
+end
+```
+
+For a Rails application using [Devise](https://github.com/plataformatec/devise), modify ```config/initializers/devise.rb```:
+
+```ruby
+config.omniauth :vatsim, 'app_id', 'app_secret', client_options: {site: 'https://cert.vatsim.net/sso'}
+```
+
+For Sinatra you would add:
+
+```ruby
+use Rack::Session::Cookie
+use OmniAuth::Builder do
+  provider :vatsim, 'api_id', 'api_secret', site: 'https://cert.vatsim.net/sso'
+end
+```
+
+## Sample Auth Hash
+
+```
+{
+  "provider"=>"vatsim",
+  "uid"=>"1300011",
+  "info"=>{
+    "id"=>"1300011",
+    "name_first"=>"11th",
+    "name_last"=>"Test",
+    "rating"=>{
+      "id"=>"11", 
+      "short"=>"SUP", 
+      "long"=>"Supervisor", 
+      "GRP"=>"Supervisor"
+    },
+    "pilot_rating"=>{
+      "rating"=>"22",
+      "2"=>{
+        "id"=>2, 
+        "short"=>"P2", 
+        "long"=>"Flight Fundamentals"
+      },
+      "4"=>{
+        "id"=>4,
+        "short"=>"P3",
+        "long"=>"VFR Pilot"
+      },
+      "16"=>{
+        "id"=>16, 
+        "short"=>"P5", 
+        "long"=>"Advanced IFR Pilot"
+       }
+     },
+     "email"=>"noreply@vatsim.net",
+     "experience"=>"N",
+     "reg_date"=>"2014-05-14 17:17:26",
+     "country"=>{
+       "code"=>"GB", "name"=>"United Kingdom"
+     },
+     "region"=>{
+       "code"=>"EUR", "name"=>"Europe"
+     },
+     "division"=>{
+       "code"=>"GBR", "name"=>"United Kingdom"
+     },
+     "subdivision"=>{
+       "code"=>nil, "name"=>nil
+     }
+   }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jvoss/omniauth-vatsim.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/omniauth/strategies/vatsim.rb

@@ -0,0 +1,70 @@
+require 'omniauth-oauth'
+require 'multi_json'
+
+module OmniAuth
+  module Strategies
+    class Vatsim < OmniAuth::Strategies::OAuth
+      option :name, 'vatsim'
+
+      option :client_options, {
+        site:               'http://sso.hardern.net/server', # default to demo site
+        authorize_path:     '/auth/pre_login/?',
+        request_token_path: '/api/login_token',
+        access_token_path:  '/api/login_return',
+      }
+
+      uid do
+        parse_callback['id']
+      end
+
+      info do
+        {
+          id:           parse_callback['id'],
+          name_first:   parse_callback['name_first'],
+          name_last:    parse_callback['name_last'],
+          rating:       parse_callback['rating'],
+          pilot_rating: parse_callback['pilot_rating'],
+          email:        parse_callback['email'],
+          experience:   parse_callback['experience'],
+          reg_date:     parse_callback['reg_date'],
+          country:      parse_callback['country'],
+          region:       parse_callback['region'],
+          division:     parse_callback['division'],
+          subdivision:  parse_callback['subdivision']
+        }
+      end
+
+      # Parse the callback for user information
+      def parse_callback
+        MultiJson.decode(self.extra['access_token'].params.keys[1])['user']
+      end
+
+      # Customize the OAuth request phase to handle VATSIM SSO
+      def request_phase
+        request_token = consumer.get_request_token({oauth_callback: callback_url}, options.request_params) do |response_body|
+          # symbolize string keys returned by VATSIM SSO
+          MultiJson.decode(response_body)['token'].symbolize_keys
+        end
+
+        session['oauth'] ||= {}
+        session['oauth'][name.to_s] = {
+          'callback_confirmed': request_token.callback_confirmed?,
+          'request_token':      request_token.token,
+          'request_secret':     request_token.secret
+        }
+
+        if request_token.callback_confirmed?
+          redirect request_token.authorize_url(options[:authorize_params])
+        else
+          redirect request_token.authorize_url(options[:authorize_params].merge(oauth_callback: callback_url))
+        end
+
+      rescue ::Timeout::Error => e
+        fail!(:timeout, e)
+      rescue ::Net::HTTPFatalError, ::OpenSSL::SSL::SSLError => e
+        fail!(:service_unavailable, e)
+      end # def request_phase
+
+    end # class Vatsim
+  end # module Strategies
+end # module OmniAuth

data/lib/omniauth-vatsim/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Vatsim
+    VERSION = "0.1.3"
+  end
+end

data/lib/omniauth-vatsim.rb

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

data/omniauth-vatsim.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-vatsim/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-vatsim"
+  spec.version       = Omniauth::Vatsim::VERSION
+  spec.authors       = ["Jonathan P. Voss"]
+  spec.email         = ["jvoss@onvox.net"]
+
+  spec.summary       = %q{OmniAuth strategy for VATSIM OAuth/SSO}
+  spec.description   = %q{OmniAuth strategy for VATSIM OAuth/SSO}
+  spec.homepage      = "https://github.com/jvoss/omniauth-vatsim"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'multi_json', '~> 1.3'
+  spec.add_runtime_dependency 'omniauth-oauth', '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-vatsim
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Jonathan P. Voss
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: OmniAuth strategy for VATSIM OAuth/SSO
+email:
+- jvoss@onvox.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-vatsim.rb
+- lib/omniauth-vatsim/version.rb
+- lib/omniauth/strategies/vatsim.rb
+- omniauth-vatsim.gemspec
+homepage: https://github.com/jvoss/omniauth-vatsim
+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.1
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for VATSIM OAuth/SSO
+test_files: []