omniauth-kindful-user 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a0b822268d4a10c6c7cae406ad384b8a102021f
+  data.tar.gz: d6a804a8ebee99415e72eb4dba2d8017a2587d92
+SHA512:
+  metadata.gz: 7bc95222f7034dd9a06e3a3c68d90dc89d537650e1230df98266338b1179cf33886e79bf0e5a7bf3e15af091bd969022cecbde968128c0fb20e8b5a0218f9c3e
+  data.tar.gz: 9f6e9acc1283fc0e70d2ca8095082d1d3c74f7b302e58237b5f7f3204ba451c3e83e32c9f31e7aaba8bb289e5a4af801ff4ab559356b13c88e8c00472464fec5

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## 1.0.0 Initial setup
+

data/Gemfile

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

data/README.md

@@ -0,0 +1,54 @@
+# OmniAuth KindfulUser
+
+KindfulUser Oauth2 provides an easy way to provide secure sites for donors to log into.   This login can be restrict access based on custom fields set on the donor's profile.
+
+If your looking to integrate with the non profit organization itself to insert client and transaction data into their account, the you should use the KindfulAdmin Oauth2 gem
+
+Additional documentation on getting your access keys generated can be found here https://developer.kindful.com/docs/oauth-user-view
+## Usecases
+
+* Provide access to a website to active members
+* Provide access to a website only to board members
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-kindful-user'
+```
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::KindfulUser` is simply a Rack middleware.
+Read the OmniAuth 2.0 docs for detailed instructions: 
+<https://github.com/intridea/omniauth>.
+
+Here's a quick example, adding the middleware to a Rails app
+in `config/initializers/omniauth.rb` and getting a token with
+scope permissions for full user info, send and request transactions:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :kindful_user, ENV['KINDFUL_KEY'], ENV['KINDFUL_SECRET'],
+  client_options: {site: "https://example-client.kindful.com}
+end
+```
+
+the endpoint /oauth2/api/v1/details.json
+is called and provides the below information
+
+
+```json
+    {
+        "id": 123,
+        "name": "John Doe",
+        "email": "john@test.com"
+    }
+```
+
+
+Additional fields can be configured to provide first_name, last_name, custom fields, and membership details.   talk to support@kindful.com for more information on getting those setup.
+

data/Rakefile

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

data/lib/omniauth/strategies/kindful_user.rb

@@ -0,0 +1,29 @@
+require 'omniauth-oauth2'
+
+
+module OmniAuth
+  module Strategies
+    class KindfulUser < OmniAuth::Strategies::OAuth2
+      option :name, 'kindful_user'
+      option :client_options, {
+        # the site subdomain is specific to the kindful client your working with.   
+        :site          => 'https://client-subdomain.kindful.com',
+        :authorize_url => '/oauth2/authenticate',
+        :token_url     => '/oauth2/token'
+      }
+      
+      uid { raw_info['id'] }
+
+      def raw_info
+        @raw_info ||= access_token.get('/oauth2/api/v1/details.json').parsed
+      end
+
+      # clear query string on redirect_url so as to conform to 3.1.2 of oauth2 spec
+      def query_string
+        ""
+      end
+
+    
+    end
+  end
+end

data/lib/omniauth-kindful-user/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module KindfulUser
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth-kindful-user.rb

@@ -0,0 +1,2 @@
+require "omniauth-kindful-user/version"
+require "omniauth/strategies/kindful_user"

data/omniauth-kindful-user.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-kindful-user/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-kindful-user"
+  s.version     = Omniauth::KindfulUser::VERSION
+  s.authors     = ["pbrumm"]
+  s.email       = ["pete@kindful.com"]
+  s.homepage    = "https://github.com/kindful/omniauth-kindful-user"
+  s.summary     = %q{OmniAuth strategy for Kindful User.}
+  s.description = %q{OmniAuth strategy for Kindful User.}
+  s.license     = 'MIT'
+  post_install_string =<<END
+Remember to specify 
+    client_options: {site: "https://example-client.kindful.com}
+with the correct subdomain for the client your working with
+END
+  s.post_install_message = post_install_string
+
+  s.rubyforge_project = "omniauth-kindful-user"
+
+  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 = ["lib"]
+
+  s.add_dependency 'omniauth', '~> 1.2'
+  s.add_dependency 'omniauth-oauth2', '~> 1.2'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 2.13.0'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'simplecov'
+#  s.add_development_dependency 'debugger'
+
+end

data/spec/omniauth/strategies/kindful_user_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::KindfulUser do
+  subject do
+    OmniAuth::Strategies::KindfulUser.new(nil, @options || {})
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'should have the correct kindful site' do
+      expect(subject.client.site).to eq("https://client-subdomain.kindful.com")
+    end
+
+    it 'should have the correct authorization url' do
+      expect(subject.client.options[:authorize_url]).to eq("/oauth2/authenticate")
+    end
+
+    it 'should have the correct token url' do
+      expect(subject.client.options[:token_url]).to eq('/oauth2/token')
+    end
+
+    #TODO find a way to set :provider_ignores_state to true by default
+    # and add a test for it. -masukomi
+  end
+
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'omniauth'
+require 'omniauth-kindful-user'
+
+
+
+
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+  OmniAuth.config.test_mode = true
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,40 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+# Thanks to Josh Ellithorpe for this file -Will
+
+shared_examples 'an oauth2 strategy' do
+  describe '#client' do
+    it 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      subject.client.options[:authorize_url].should == 'https://example.com'
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :authorize_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.authorize_params['foo'].should eq('bar')
+      subject.authorize_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :authorize_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.authorize_params['scope'].should eq('bar')
+      subject.authorize_params['foo'].should eq('baz')
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any token params passed in the :token_params option' do
+      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.token_params['foo'].should eq('bar')
+      subject.token_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :token_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.token_params['scope'].should eq('bar')
+      subject.token_params['foo'].should eq('baz')
+    end
+  end
+end
+

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-kindful-user
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- pbrumm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: OmniAuth strategy for Kindful User.
+email:
+- pete@kindful.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-kindful-user.rb
+- lib/omniauth-kindful-user/version.rb
+- lib/omniauth/strategies/kindful_user.rb
+- omniauth-kindful-user.gemspec
+- spec/omniauth/strategies/kindful_user_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/kindful/omniauth-kindful-user
+licenses:
+- MIT
+metadata: {}
+post_install_message: "Remember to specify \n    client_options: {site: \"https://example-client.kindful.com}\nwith
+  the correct subdomain for the client your working with\n"
+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: omniauth-kindful-user
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for Kindful User.
+test_files:
+- spec/omniauth/strategies/kindful_user_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+has_rdoc: