omniauth-myusa 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e32846eca541483f4e65f6738e520179cf2ae292
+  data.tar.gz: f63e4b9cd7f5fd647f41d78ae6ea021812b2d5d3
+SHA512:
+  metadata.gz: b22cdf799e98643a36dd8425425dd4b1bf8fb1af3c84cbc5c664906af160a2b22cd486f04d61f7e8ddba322dfed34b3bd8292c7aa14a2e691842701752caa6bc
+  data.tar.gz: 0db2140a6436d5f4c327b571160f0a1c10221f4ca32e8208be04c964c7b255c4e57051974b1eeaf23ce67bcfeded01e762317097cf6e7e6a8137904d7e5d9535

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+example/app.log

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-myusa.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rspec'
+  gem 'simplecov'
+  gem 'rack-test'
+  gem 'webmock'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Greg Gershman
+
+MIT License
+
+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,110 @@
+# OmniAuth::Strategies::Myusa
+
+This gem contains the MyUSA strategy for OmniAuth.
+
+MyUSA uses OAuth 2.0. To find out more information about MyUSA and how to create
+your own application visit the [developers](https://my.usa.gov/developer)
+section of MyUSA.
+
+View the OmniAuth 1.0 docs for more information about strategy implementation:
+https://github.com/intridea/omniauth.
+
+## Before You Begin
+
+Sign in to [MyUSA](https://my.usa.gov/developer) and register an application.
+You will need to provide a redirect URI which is "YOUR_SITE/auth/myusa/callback"
+by default. Take note of your Consumer Key and Consumer Secret.
+
+## Using This Strategy
+
+First start by adding this gem to your Gemfile:
+
+```ruby
+gem 'omniauth-myusa', git: 'https://github.com/18F/omniauth-myusa.git'
+```
+
+Next, tell OmniAuth about this provider. For a Rails app, your
+`config/initializers/omniauth.rb` file should look like this:
+
+```ruby
+provider(
+  :myusa,
+  "CONSUMER_KEY",
+  "CONSUMER_SECRET",
+  scope: "profile.email tasks submit_forms notifications"
+)
+```
+
+Replace CONSUMER_KEY and CONSUMER_SECRET with the appropriate values you obtained from [MyUSA](https://my.usa.gov/apps) earlier. Valid scopes are:
+- profile.email
+- profile.title
+- profile.first_name
+- profile.middle_name
+- profile.last_name
+- profile.suffix
+- profile.address
+- profile.address2
+- profile.city
+- profile.state
+- profile.zip
+- profile.phone_number
+- profile.mobile_number
+- profile.gender
+- profile.marital_status
+- profile.is_parent
+- profile.is_student
+- profile.is_veteran
+- profile.is_retired
+- tasks
+- notifications
+- submit_forms
+
+## Authentication Hash
+An example auth hash available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  "provider"=>"myusa",
+  "uid"=>"r03Ke0000000000FrqOOFlq0DeNc9q1QQQQQQQQC",
+  "info"=>{"email"=>"johnq@bloggs.com"},
+  "credentials"=>{"token"=>"3gnsgg14ymf54mquevfry38ao", "expires"=>false},
+  "extra"=>
+    {"raw_info"=>
+      {"title"=>nil,
+      "first_name"=>nil,
+      "middle_name"=>nil,
+      "last_name"=>nil,
+      "suffix"=>nil,
+      "address"=>nil,
+      "address2"=>nil,
+      "city"=>nil,
+      "state"=>nil,
+      "zip"=>nil,
+      "phone_number"=>nil,
+      "mobile_number"=>nil,
+      "gender"=>nil,
+      "marital_status"=>nil,
+      "is_parent"=>nil,
+      "is_retired"=>nil,
+      "is_veteran"=>nil,
+      "is_student"=>nil,
+      "email"=>"johnq@bloggs.com
+      "uid"=>"r03Ke0000000000FrqOOFlq0DeNc9q1QQQk390QC"
+    }
+  }
+}
+```
+
+## Watch the RailsCast
+
+Ryan Bates has put together an excellent RailsCast on OmniAuth:
+
+[![RailsCast #241](http://railscasts.com/static/episodes/stills/241-simple-omniauth-revised.png "RailsCast #241 - Simple OmniAuth (revised)")](http://railscasts.com/episodes/241-simple-omniauth-revised)
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/example/.cfignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+app.log

data/example/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'sinatra-reloader'
+gem 'omniauth-myusa', git: 'git://github.com/18f/omniauth-myusa.git'

data/example/README.md

@@ -0,0 +1,59 @@
+# OmniAuth MyUSA Example Application
+
+To set up a client application that points to a dev/staging version of MyUSA:
+
+1. Ensure you have Ruby installed - version 2.0 or greater.
+
+1. Install the Bundler gem:
+  ```bash
+  $ gem install bundler
+  ```
+
+1. Clone this repository locally and change to the `example` folder:
+   ```bash
+   $ git clone https://github.com/18F/omniauth-myusa/
+   $ cd omniauth-myusa/example
+   ```
+
+1. Use `bundle` to install the necessary dependencies:
+   ```bash
+   $ bundle install
+   ```
+
+1. Register a new client application with MyUSA at `https://my.usa.gov/oauth/applications`
+  1. Set **Url** to `http://localhost:9292`
+  2. Set **Redirect Uri** to `http://localhost:9292/auth/myusa/callback`
+
+1. Copy the application id and secret and set them as environment variables:
+  ```bash
+  $ export APP_ID=...
+  $ export APP_SECRET=...
+  ```
+
+1. Add the following to the `provider` call in `config.ru`:
+  ```ruby
+  provider :myusa, ENV['APP_ID'], ENV['APP_SECRET'], {
+    scope: %q(...),
+    client_options: {
+      site: 'http://<myusa host:port>',
+      token_url: '/oauth/token'
+    }
+  }
+  ```
+  where `:scope => %q(...)` is a space separated list of scopes that the client
+  application will request.
+
+1. Uncomment the following line in `config.ru` and set the correct url for this
+dummy app (it will default to `http://localhost:9292`):
+  ```ruby
+  OmniAuth.config.full_host = "http://<dummy host:port>"
+  ```
+
+1. Run the dummy app:
+  ```bash
+  $ rackup
+  ```
+  or to run it as a daemon (you may want to set up logging):
+  ```bash
+  $ rackup -D
+  ```

data/example/app.rb

@@ -0,0 +1,31 @@
+require 'sinatra'
+require 'sinatra/reloader'
+require 'yaml'
+
+set :run, false
+set :raise_errors, true
+
+get '/' do
+  content_type 'text/html'
+  <<-END
+<html>
+  <body>
+    <link href='//fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
+    <link href='//s3.amazonaws.com/myusa-static/button.min.css' rel='stylesheet' type='text/css'>
+    <p>
+      <a href="/auth/myusa" class="btn btn-social btn-myusa">Connect with MyUSA</a>
+    </p>
+  </body>
+</html>
+  END
+end
+
+get '/auth/myusa/callback' do
+  content_type 'application/json'
+  MultiJson.encode(request.env)
+end
+
+get '/auth/failure' do
+  content_type 'application/json'
+  MultiJson.encode(request.env)
+end

data/example/config.ru

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+require 'omniauth-myusa'
+require './app.rb'
+
+use Rack::Session::Cookie, secret: 'secret'
+
+# APP_ID an APP_SECRET are provided by MyUSA at the end of app registration,
+# referred to as "Consumer Public Key" and "Consumer Secret Key" respectively.
+# APP_URL is the URL for the front page of this app.
+APP_ID     = ENV['APP_ID']     || nil
+APP_SECRET = ENV['APP_SECRET'] || nil
+APP_URL    = ENV['APP_URL']    || 'http://localhost:9292'
+MYUSA_URL  = ENV['MYUSA_URL']  || 'http://alpha.my.usa.gov'
+
+OmniAuth.config.full_host = APP_URL
+
+# To run the app, simply call `rackup` from the command line. If you would
+# like to run as a daemon, call `rackup -D` ... if you do this, you should
+# set up logging.
+
+use OmniAuth::Builder do
+  provider :myusa, APP_ID, APP_SECRET,
+           scope: 'profile.email profile.last_name',
+           client_options: { site: MYUSA_URL, token_url: '/oauth/token' }
+end
+
+run Sinatra::Application

data/lib/omniauth-myusa.rb

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

data/lib/omniauth-myusa/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Myusa
+    VERSION = "0.0.4"
+  end
+end

data/lib/omniauth/strategies/myusa.rb

@@ -0,0 +1,38 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Myusa < OmniAuth::Strategies::OAuth2
+      # Give your strategy a name.
+      option :name, "myusa"
+
+      # This is where you pass the options you would pass when
+      # initializing your consumer from the OAuth gem.
+      option :client_options, site: 'https://alpha.my.usa.gov', token_url: '/oauth/authorize'
+
+      # These are called after authentication has succeeded. If
+      # possible, you should try to set the UID without making
+      # additional calls (if the user id is returned with the token
+      # or as a URI parameter). This may not be possible with all
+      # providers.
+      uid{ raw_info['uid'] }
+
+      info do
+        {
+          :email => raw_info['email']
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/profile').parsed
+      end
+
+    end
+  end
+end

data/omniauth-myusa.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-myusa/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "omniauth-myusa"
+  gem.version       = Omniauth::Myusa::VERSION
+  gem.authors       = ["Greg Gershman", "Christopher Papazian"]
+  gem.email         = ["gregory.gershman@gsa.gov"]
+  gem.description   = %q{OmniAuth strategy for MyUSA.}
+  gem.summary       = %q{OmniAuth strategy for MyUSA.}
+  gem.homepage      = "https://github.com/GSA-OCSIT/omniauth-myusa"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'omniauth', '~> 1.0'
+  # oauth2 gem locked hard at pre-1.4.0 because 1.4.0 breaks.
+  # See comments on https://github.com/intridea/omniauth-oauth2/commit/26152673224aca5c3e918bcc83075dbb0659717f
+  gem.add_dependency 'omniauth-oauth2', '1.3.1'
+end

data/spec/omniauth/strategies/myusa_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Myusa do
+  subject do
+    OmniAuth::Strategies::Myusa.new({})
+  end
+
+  context "client options" do
+    it 'should have correct name' do
+      subject.options.name.should eq("myusa")
+    end
+
+    it 'should have correct site' do
+      subject.options.client_options.site.should eq('https://alpha.my.usa.gov')
+    end
+
+    it 'should have correct token url' do
+      subject.options.client_options.token_url.should eq('/oauth/authorize')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-myusa'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-myusa
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Greg Gershman
+- Christopher Papazian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  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: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+description: OmniAuth strategy for MyUSA.
+email:
+- gregory.gershman@gsa.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/.cfignore
+- example/Gemfile
+- example/README.md
+- example/app.rb
+- example/config.ru
+- lib/omniauth-myusa.rb
+- lib/omniauth-myusa/version.rb
+- lib/omniauth/strategies/myusa.rb
+- omniauth-myusa.gemspec
+- spec/omniauth/strategies/myusa_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/GSA-OCSIT/omniauth-myusa
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for MyUSA.
+test_files:
+- spec/omniauth/strategies/myusa_spec.rb
+- spec/spec_helper.rb