omniauth-idme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d84f1ccf7610e795077a6150dfab10c513e9c318
+  data.tar.gz: 8e1b81cc5a9d737d9c243fd8fbffe386d4d71a8f
+SHA512:
+  metadata.gz: 2ea148e0f9c90fdc9451776e49adb299a7cb462fec2b12cd7dc1cda878d11eec4af8d832753a79cfdd80d437325d7300d8309afc6485c0b8fd11d8316f923ad2
+  data.tar.gz: 3439056624592f2730f59a22db51e95a2243b00c6c8a75966f0ed397a71d990bb6e22ee5929325fe4bc5de9e39d61fad8b4522c8d80076db15c8371b01e8d446

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+.idea/

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p195

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "multi_json"
+  gem "rake"
+end

data/README.md

@@ -0,0 +1,50 @@
+# OmniAuth ID.me
+
+This gem contains the ID.me strategy for [OmniAuth 2.0](https://github.com/intridea/omniauth).
+
+ID.me offers online brands a secure, real-time method for verifying the military affiliation of their customers online. By verifying military affiliation companies can tailor the user experience on their platform to offer discounts or other benefits.
+
+Read our [documentation](https://developer.id.me/docs) to learn more about how to integrate.
+
+## How To Use It
+
+Usage is as per any other OmniAuth 2.0 strategy.
+
+Add the strategy to your `Gemfile` alongside OmniAuth:
+
+    gem "omniauth"
+    gem "omniauth-idme"
+
+In a Rack application:
+
+    use OmniAuth::Builder do
+      provider :idme, "consumer_key", "consumer_secret"
+    end
+
+For Rails, put this in your OmniAuth configuration file (config/initializers/omniauth.rb):
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :idme, "consumer_key", "consumer_secret"
+    end
+
+By default the scope passed to the ID.me API is military. If you would like to support another scope, put this in your OmniAuth configuration file (config/initializers/omniauth.rb):
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :idme, "consumer_key", "consumer_secret",
+      :scope => "scope"
+    end
+
+Register your app at https://sandbox.developer.id.me/ during development and https://developer.id.me/ for production. Once your app has been approved you'll receive a consumer token and secret.
+
+## TODO:
+- add multi-scope support
+
+## License
+
+Copyright (c) 2012 by TroopSwap, Inc.
+
+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/Rakefile

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

data/example/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem "sinatra"
+gem "multi_json"
+gem "omniauth-idme", :path => "../"

data/example/config.ru

@@ -0,0 +1,27 @@
+require "bundler/setup"
+require "sinatra/base"
+require "omniauth-linkedin"
+
+class App < Sinatra::Base
+  get "/" do
+    redirect "/auth/idme"
+  end
+
+  get "/auth/:provider/callback" do
+    content_type "application/json"
+    MultiJson.encode(request.env)
+  end
+
+  get "/auth/failure" do
+    content_type "application/json"
+    MultiJson.encode(request.env)
+  end
+end
+
+use Rack::Session::Cookie
+
+use OmniAuth::Builder do
+  provider :linkedin, ENV["IDME_CONSUMER_KEY"], ENV["IDME_CONSUMER_SECRET"], :scope => "basic"
+end
+
+run App.new

data/lib/omniauth/strategies/idme.rb

@@ -0,0 +1,43 @@
+require "omniauth/strategies/oauth2"
+
+module OmniAuth
+  module Strategies
+    class IDme < OmniAuth::Strategies::OAuth2
+
+      option :name,   "idme"
+      option :scope,  "military"
+
+      option :client_options, {
+        :site               => "https://api.id.me",
+        :authorize_url      => "https://api.id.me/oauth/authorize",
+        :token_url          => "https://api.id.me/oauth/token"
+      }
+
+      option :authorize_options, [:scope, :display]
+
+      uid { data["id"] }
+
+      info do
+        {
+          :affiliation  => data["affiliation"],
+          :verified     => data["verified"]
+        }
+      end
+
+      extra do
+        { :raw => data }
+      end
+
+      def data
+        @data ||= access_token.get("/v2/#{options[:scope]}.json").parsed
+      end
+
+      def headers
+        { "X-API-ORIGIN" => "OMNIAUTH-IDME" }
+      end
+
+    end
+  end
+end
+
+OmniAuth.config.add_camelization "idme", "IDme"

data/lib/omniauth-idme/version.rb

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

data/lib/omniauth-idme.rb

@@ -0,0 +1,8 @@
+require "omniauth-idme/version"
+require "omniauth/strategies/idme"
+
+module Omniauth
+  module IDme
+
+  end
+end

data/omniauth-idme.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-idme/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-idme"
+  s.version     = Omniauth::IDme::VERSION
+  s.authors     = %w(ID.me)
+  s.email       = %w(awesome@id.me)
+  s.homepage    = "https://github.com/troopswap/omniauth-idme"
+  s.summary     = "ID.me strategy for OmniAuth"
+  s.description = "ID.me strategy for OmniAuth"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = %w(lib)
+
+  s.add_runtime_dependency "omniauth-oauth2"
+
+  s.add_development_dependency "rspec", "~> 2.7"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "rack-test"
+end

data/spec/omniauth/strategies/idme_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe "OmniAuth::Strategies::IDme" do
+  subject do
+    OmniAuth::Strategies::IDme.new(nil, @options || {})
+  end
+
+  context "client options" do
+    it "has correct IDme site" do
+      subject.options.client_options.site.should eq("https://api.id.me")
+    end
+
+    it "has correct authorize url" do
+      subject.options.client_options.authorize_url.should eq("https://api.id.me/oauth/authorize")
+    end
+  end
+
+  context "#uid" do
+    before :each do
+      subject.stub(:data) { { "id" => "123456" } }
+    end
+
+    it "returns the id from data" do
+      subject.uid.should eq("123456")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$:.unshift File.expand_path("..", __FILE__)
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "rspec"
+require "rack/test"
+require "webmock/rspec"
+require "omniauth"
+require "omniauth-idme"
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend OmniAuth::Test::StrategyMacros, :type => :strategy
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-idme
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ID.me
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-08 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !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: webmock
+  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: rack-test
+  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: ID.me strategy for OmniAuth
+email:
+- awesome@id.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- README.md
+- Rakefile
+- example/Gemfile
+- example/config.ru
+- lib/omniauth-idme.rb
+- lib/omniauth-idme/version.rb
+- lib/omniauth/strategies/idme.rb
+- omniauth-idme.gemspec
+- spec/omniauth/strategies/idme_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/troopswap/omniauth-idme
+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.3
+signing_key: 
+specification_version: 4
+summary: ID.me strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/idme_spec.rb
+- spec/spec_helper.rb