omniauth-nationbuilder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a09359c904523452ba46358cf476a4e0c39e28fd
+  data.tar.gz: 60aef520596990d65851598a7991203fe0028bb1
+SHA512:
+  metadata.gz: 2bc8b79a24ba40dc23920418521826c1041ae036783a0e6231bf7273ee59a89b4bc460a1f607b59bd2c2d2ad35cb31d1340519eaac64cc06b191f6090af40327
+  data.tar.gz: 79b3b3de168b33ead7c6a5fdb543b2e90b2fb0ab3985c49b2a70e0dca71f405084b9fa0250aa671643ff6b5a89416b3abfb165d0feb6ee4167ecf8167c773442

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+before_install:
+  - gem update --system 2.1.11
+language: ruby
+rvm:
+  - "2.0.0"
+  - "2.1.0"
+  - "2.3.0"
+  - "jruby"

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Chris Jensen
+
+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,66 @@
+[![Build Status](https://travis-ci.org/chrisjensen/omniauth-nationbuilder.svg?branch=master)](https://travis-ci.org/chrisjensen/omniauth-nationbuilder)
+
+# Omniauth::Nationbuilder
+
+Strategy to authenticate with Nationbuilder in OmniAuth.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-nationbuilder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-nationbuilder
+
+## Usage
+
+Here's an example for adding the middleware to a Rails app in config/initializers/omniauth.rb:
+
+````ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :nationbuilder, ENV["NATIONBUILDER_CLIENT_ID"], ENV["NATIONBUILDER_CLIENT_SECRET"]
+end
+````
+
+Because every nation has it's own slug, and this may be configured at run time if you are supporting authorisation of multiple nations, this is passed by a url parameter.
+
+To authenticate your nation, use
+
+	 /auth/nationbuilder?nation_slug=<YOUR NATIONS SLUG>
+
+
+## Auth Hash
+
+Here's an example of an authentication hash available in the callback by accessing request.env["omniauth.auth"]:
+
+````ruby
+	{
+	  :provider => "nationbuilder",
+	  :uid => "YOUR NATIONS SLUG",
+	  :credentials => {
+		:token => "f4d3b3c9528672fa15181dfd9e63a793f4e754186bbeaad7030b053e1398b84f",
+		:expires => false 
+	  },
+	  :extra => {
+		:token_type => "bearer",
+		:created_at => 1465867529,
+		:access_token => "f4d3b3c9528672fa15181dfd9e63a793f4e754186bbeaad7030b053e1398b84f",
+		:refresh_token => nil,
+		:expires_at => nil
+	  }
+	}
+````
+
+## 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,7 @@
+#!/usr/bin/env rake
+require File.join('bundler', 'gem_tasks')
+require File.join('rspec', 'core', 'rake_task')
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/omniauth/nationbuilder/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Nationbuilder
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth/nationbuilder.rb

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

data/lib/omniauth/strategies/nationbuilder.rb

@@ -0,0 +1,63 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Nationbuilder < OmniAuth::Strategies::OAuth2
+      # Give your strategy a name.
+      option :name, "nationbuilder"
+
+	  # We need the nation slug from the user and will use that as the unique id
+	  # for this strategy
+	  option :nation_slug, nil
+      option :slug_param, 'nation_slug'
+      
+	  # Build a form to get the nations slug if one has not been supplied
+	  def get_slug
+        f = OmniAuth::Form.new(:title => 'NationBuilder Authentication')
+        f.label_field("Your Nation's Slug", options.slug_param)
+        f.input_field('url', options.slug_param)
+		f.button "Connect to your Nation"
+        f.to_response
+      end
+      
+      # Configure site before super initialises the OAuth2 Client
+      def client
+        options.client_options[:site] = 'https://' + options.client_options[:slug] + '.nationbuilder.com'
+        super
+      end
+      
+      # Returns the slug, nil if one has not been specified anywhere
+      def slug
+        s = options.nation_slug || request.params[options.slug_param.to_s]
+        s = nil if s == ''
+        s
+      end
+      
+      # Override the normal OAuth request_phase to get a slug from the user if
+      # one hasn't been supplied, and insert the slug into the site url
+      def request_phase
+        if slug
+          # Store slug on the session
+          session["omniauth.nationbuilder.slug"] = options.client_options[:slug] = slug
+          super
+        else
+          get_slug
+        end
+      end
+      
+      def callback_phase
+        options.client_options[:slug] = session.delete("omniauth.nationbuilder.slug")
+        super
+      end
+            
+      # 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 { options.client_options[:slug] }
+      
+      extra { access_token }
+    end
+  end
+end

data/lib/omniauth-nationbuilder/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Nationbuilder
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth-nationbuilder.rb

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

data/omniauth-nationbuilder.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-nationbuilder/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "omniauth-nationbuilder"
+  gem.version       = Omniauth::Nationbuilder::VERSION
+  gem.authors       = ["Chris Jensen"]
+  gem.email         = ["chris@broadthought.co"]
+  gem.description   = %q{Omniauth strategy for NationBuilder using OAuth2}
+  gem.summary       = %q{Omniauth strategy for NationBuilder using OAuth2}
+  gem.homepage      = "https://github.com/chrisjensen/omniauth-nationbuilder"
+  gem.licenses      = ['MIT']
+  
+  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_runtime_dependency 'omniauth', '~> 1.1', '>= 1.1.1'
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.3', '>= 1.3.1'
+
+  gem.add_development_dependency 'rspec', '~> 2.14'
+  gem.add_development_dependency 'rake'
+
+  gem.add_development_dependency 'rack-test', '~> 0.5'
+  gem.add_development_dependency 'webmock', '~> 1.7'
+end

data/spec/omniauth/strategies/nationbuilder_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+require 'omniauth-nationbuilder'
+
+describe OmniAuth::Strategies::Nationbuilder, :type => :strategy do
+  def app
+    strategy = OmniAuth::Strategies::Nationbuilder
+
+    Rack::Builder.new {
+      use Rack::Session::Cookie, :secret => 'suppress no secret warning'
+      use strategy
+      run lambda {|env| [404, {'Content-Type' => 'text/plain'}, [nil || env.key?('omniauth.auth').to_s]] }
+    }.to_app
+  end
+
+  subject do
+    OmniAuth::Strategies::Nationbuilder.new(app, 'appid', 'secret', @options || {})
+  end
+  
+  before do
+    OmniAuth.config.failure_raise_out_environments = ['development','test','']
+  end
+
+  describe '/auth/nationbuilder' do
+    context 'with nation_slug unset' do
+		before do
+		  get '/auth/nationbuilder'
+		end
+
+		it 'should respond with OK' do
+		  expect(last_response).to be_ok
+		end
+
+		it 'should respond with HTML' do
+		  expect(last_response.content_type).to eq('text/html')
+		end
+
+		it 'should prompt for nation slug' do
+		  expect(last_response.body).to match %r{<input[^>]*nation_slug}
+		end
+	end
+
+	context 'with nation_slug in get param' do
+	  let(:slug) { 'mynation' }
+	  let(:redirect_url) { 'https://' + slug + '.nationbuilder.com' }
+    
+      it 'should redirect to the NationBuilder oauth url' do
+        get '/auth/nationbuilder?nation_slug=' + slug
+        expect(last_response).to be_redirect
+        expect(last_response.headers['Location']).to match(%r{^#{redirect_url}.*})
+      end
+	end
+  end
+  
+  ### NOTE ###
+  # This section involves heavy stubbing of Omniauth and OAuth methods to verify
+  # a small amount of code.
+  # There is probably a better way to test this, but would require better knowledge of
+  # rack middleware than I can bring
+  describe 'session' do
+	  before do
+		OmniAuth.config.test_mode = true
+	  end
+
+	  after do
+		OmniAuth.config.test_mode = false
+	  end
+  
+	  let(:rack_cookies) do
+		{}
+	  end
+	  
+	  let(:nation_slug) { 'nationofkinggeorge' }
+
+	  before do
+		allow(subject).to receive(:request) { double('Rack::Test::Request', {:params => {'nation_slug' => nation_slug }, :query_string => 'query_string', :env => { 'rack.session' => rack_cookies }}) }
+
+		allow(subject).to receive(:full_host) { 'example.org' }
+		allow(subject).to receive(:script_name) { 'test' }
+		allow(subject).to receive(:build_access_token) { {} }
+		allow(subject).to receive(:env) { {} }
+		allow(subject).to receive(:call_app!) { {} }
+	
+		allow(subject).to receive(:session) { rack_cookies }
+	  end
+  
+	  describe 'request_phase' do
+
+		  it 'should save the slug on the session' do
+			subject.request_phase
+			expect(subject.session['omniauth.nationbuilder.slug']).to eq(nation_slug)
+		  end
+	  end
+  
+		describe '/auth/nationbuilder/callback' do
+			let(:client) do
+			  OAuth2::Client.new('abc', 'def') do |builder|
+				builder.request :url_encoded
+			  end
+			end
+	
+			let(:nb_response) do
+			  {
+				"access_token" => "token-string",
+				"token_type" => "bearer",
+				"created_at" => 1465867529
+			  }		
+			end
+	
+			let(:access_token) do
+			  OAuth2::AccessToken.from_hash(client, nb_response )
+			end
+
+			before do
+			  allow(subject).to receive(:access_token).and_return(access_token)
+			  subject.options.provider_ignores_state = true;
+			end
+  
+		  it "should provide nationbuilder auth hash in extra" do
+			expect(subject.auth_hash.extra).to include(nb_response)
+		  end
+
+		  it "should set uid from session" do
+			subject.session['omniauth.nationbuilder.slug'] = nation_slug
+			subject.callback_phase
+			expect(subject.auth_hash).to include("uid" => nation_slug)
+		  end
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-nationbuilder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Jensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - '>='
+      - !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'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !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: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Omniauth strategy for NationBuilder using OAuth2
+email:
+- chris@broadthought.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-nationbuilder.rb
+- lib/omniauth-nationbuilder/version.rb
+- lib/omniauth/nationbuilder.rb
+- lib/omniauth/nationbuilder/version.rb
+- lib/omniauth/strategies/nationbuilder.rb
+- omniauth-nationbuilder.gemspec
+- spec/omniauth/strategies/nationbuilder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/chrisjensen/omniauth-nationbuilder
+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: Omniauth strategy for NationBuilder using OAuth2
+test_files:
+- spec/omniauth/strategies/nationbuilder_spec.rb
+- spec/spec_helper.rb