omniauth-your-membership-token 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b6cbc53f84e9388a1eb6d143ff170395d8b401f
+  data.tar.gz: 7977fd59d21e5b80125aeee25a73ab4acd50d791
+SHA512:
+  metadata.gz: 3e456fe9bc3be2ff2d5bda42d621deb16c0ecb14d434c3e6ae5ee1060a7df0119f4522843681e92d4c31e9fd065407de8b0dcc414027a7f42830710312d52f7c
+  data.tar.gz: 87ec483b50b9a011a2042c4efc10cd14ba43980d7e29ac5a1fd5722db3797a6e95a93187b7f395b6a0bcc040cb8fc07c560db1ef373cc3c3aaa93e0f9d700e55

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathan Flood
+
+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,157 @@
+# Omniauth::Strategies::YourMembershipToken
+
+This is an OmniAuth Strategy for authenticating to YourMembership implementations using token-based authentication.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+```RUBY
+gem 'omniauth'
+gem 'omniauth-your-membership-token'
+```
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+`OmniAuth::Strategies::YourMembershipToken` is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.
+
+This strategy depends on the `your_membership` gem. You will need to configure your YourMembership environment before you can use this strategy for authentication. Read the documentation for that gem for instructions: https://github.com/ECHOInternational/your_membership
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb:`
+
+```RUBY
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :yourMembershipToken
+end
+```
+
+## Auth Hash
+
+Here's an example Auth Hash available in `request.env['omniauth.auth']`:
+
+```RUBY
+{
+  :provider => YourMembershipToken,
+  :uid => 234235D-3234-2342252-AS432, # YourMembership API Member ID
+  :extra => {
+    :access_token => 453532-D234234-234234-D2132, # YourMembership Authenticated Session ID
+  }
+}
+```
+
+## Interacting with the returned Session ID
+
+`request.env['omniauth.auth']['extra']['access_token']` provides the authenticated session ID as a way for the authenticated user to interact with the YourMembership API through the Ruby SDK.
+
+Due to the fact that Rails (and most other frameworks) don't maintain object state between requests it is incumbent upon you to implement the storage and retrieval of the Session ID and an ever-incrementing call counter.
+
+Upon authorization set the call counter to 10 or more to account for calls during authentication.
+
+Here's an example of how to maintain a call counter in an ActiveRecord model. Your User table will need to have these fields at minimum:
++ provider
++ uid
++ remote_session_call_counter
++ remote_session
+
+```RUBY
+class User < ActiveRecord::Base
+
+  # Create user if it doesn't exist (this probably isn't necessary if you're using Devise or another Auth Framework)
+  def self.create_with_omniauth(auth)
+    create! do |user|
+      user.provider = auth['provider']
+      user.uid = auth['uid']
+    end
+  end
+
+  # An example API call
+  def member
+    # You need to increment the call_counter before every call or you'll get errors from YourMembership's API
+    update_remote_session_call_counter
+    YourMembership::Member.create_from_session ym_session
+  end
+
+  def ym_session
+    # Cache the session object so that you aren't re-creating it with every call.
+    @session ||= YourMembership::Session.new remote_session, remote_session_call_counter
+  end
+
+  def update_remote_session_call_counter
+    # Make the database call_counter match that which is in the session object
+    update(remote_session_call_counter: ym_session.call_id)
+  end
+
+  def abandon_remote_session
+    begin
+      update_remote_session_call_counter
+      ym_session.abandon
+    rescue YourMembership::Error => e
+      logger.info "YourMembership returned error #{e.error_code}: #{e.error_description}"
+    ensure
+      update(remote_session: nil)
+      update(remote_session_call_counter: 200)
+      save
+    end
+  end
+end
+```
+
+And you would want to do something like this in your session controller:
+
+```RUBY
+class SessionsController < ApplicationController
+  # This will save you a headache when using remote authentication
+  skip_before_filter :verify_authenticity_token, :only => :create
+  
+  # This is the standard way to access an OmniAuth strategy, this may change for your framework of choice.
+  def new
+    redirect_to '/auth/yourmembershiptoken'
+  end
+
+  def create
+    auth = request.env["omniauth.auth"]
+    user = User.where(:provider => auth['provider'],
+                      :uid => auth['uid'].to_s).first || User.create_with_omniauth(auth)
+
+    #Remember the current session so you can access it later
+    user.remote_session = auth['extra']['access_token']
+    user.remote_session_call_counter = 300
+    user.save
+
+    reset_session
+    session[:user_id] = user.id
+    redirect_to root_url, :notice => 'Signed in!'
+  end
+
+  def destroy
+    current_user.abandon_remote_session
+    reset_session
+    redirect_to root_url, :notice => 'Signed out!'
+  end
+
+  def failure
+    redirect_to root_url, :alert => "Authentication error: #{params[:message].humanize}"
+  end
+
+end
+```
+
+### Session Expiration
+
+You'll need to watch out for sessions expiring. An easy way to recover from an expired session is to write a rescue_from method in your `application.rb`
+
+Here's an example:
+
+```Ruby
+rescue_from YourMembership::Error do | error |
+  case error.error_code
+  when '202'
+    reset_session
+    redirect_to root_url, :notice => 'Your Session Timed Out.'
+  else
+    raise error
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/omniauth-your-membership-token.rb

@@ -0,0 +1,3 @@
+require 'omniauth'
+require 'your_membership'
+require 'omniauth/strategies/your_membership_token'

data/lib/omniauth/strategies/your_membership_token.rb

@@ -0,0 +1,53 @@
+require'omniauth'
+require'your_membership'
+
+module OmniAuth
+  module Strategies
+    class YourMembershipToken
+      include OmniAuth::Strategy
+
+      # The UID is going to be the member's API id (member_id)
+      # We'll also store the session ID 
+      option :fields, [:member_id, :ym_session]
+      option :uid_field, :member_id
+
+      def request_phase
+        # Build an Access Token
+        session = YourMembership::Session.create
+        token_hash = session.createToken(:RetUrl => callback_url)
+
+        # Pass the YourMembership session id to the Callback
+        request.params[:ym_session] = session.to_s
+
+        # Redirect to token url
+        redirect token_hash['GoToUrl']
+      end
+
+      def callback_phase
+        # create session object
+
+        ym_session  = YourMembership::Session.new(request.env['omniauth.params'][:ym_session], 100)
+
+        fail! 'Failed To Log In' unless ym_session
+        begin
+          fail! 'Failed To Log In' unless ym_session.authenticated?
+        rescue YourMembership::Error => e
+          fail! e.error_description
+        end
+
+        @user_id = ym_session.user_id
+        @access_token = ym_session.to_s
+
+        super
+      end
+
+      uid do
+        @user_id
+      end
+      
+      extra do
+        {'access_token' => @access_token}
+      end
+    end
+  end
+end

data/lib/omniauth/your_membership_token/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module YourMembershipToken
+    VERSION = "1.0.0"
+  end
+end

data/omniauth-your-membership-token.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/your_membership_token/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-your-membership-token"
+  spec.version       = OmniAuth::YourMembershipToken::VERSION
+  spec.authors       = ["Nate Flood"]
+  spec.email         = ["nflood@echonet.org"]
+  spec.summary       = %q{Omniauth Strategy For Authenticating To YourMembership}
+  spec.description   = %q{This is an Omniauth Strategy for Authenticating to YourMembership. It requires the your_membership gem.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "omniauth", "~> 1.2"
+  spec.add_dependency "your_membership", "~> 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-your-membership-token
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nate Flood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-22 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: your_membership
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: This is an Omniauth Strategy for Authenticating to YourMembership. It
+  requires the your_membership gem.
+email:
+- nflood@echonet.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-your-membership-token.rb
+- lib/omniauth/strategies/your_membership_token.rb
+- lib/omniauth/your_membership_token/version.rb
+- omniauth-your-membership-token.gemspec
+homepage: ''
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Omniauth Strategy For Authenticating To YourMembership
+test_files: []
+has_rdoc: