brainpickin_remote_auth 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gem 'rake'
+gem "jeweler", "~> 1.8.4"
+gem "rspec", "~> 2.13.0"

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    rake (10.0.4)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.8.4)
+  rake
+  rspec (~> 2.13.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 brainpickin P.E.
+
+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.rdoc

@@ -0,0 +1,77 @@
+= brainpickin_remote_auth
+
+brainpickin_remote_auth is a simple gem providing help with brainpickin's Single Sign On
+functionality (see https://my.brainpickin.com/api/remote_authentication).
+
+== Installation and Setup
+
+* Install:
+  gem install brainpickin_remote_auth
+
+* Setup:
+You will need to give the gem your token and authentication url,
+perhaps in an initializer:
+  Brainpickin::RemoteAuth.token = 'OUR-SECRET-TOKEN'
+  Brainpickin::RemoteAuth.auth_url = 'https://yoursubdomain.brainpickin.com/access/remote/'
+
+
+== Usage
+
+Mixin the Brainpickin::RemoteAuthHelper module wherever needed, then call:
+  brainpickin_remote_auth_url(:name => 'user name',
+                          :email => 'user email',
+                          <optional params>)
+
+This will return a url you can redirect the user to to log them in to
+your brainpickin account.
+
+As a convenience, you can pass a user object to brainpickin_remote_auth_url:
+  brainpickin_remote_auth_url(user)
+
+This user must respond_to? :name and :email, and its :id will be used
+as the :external_id (making it useless with user objects that return
+an ephemeral object_id, but works well with ActiveRecord and the
+like).
+
+This method will generate and include the hash of the parameters for
+you if necessary. 
+
+== Example Auth Controller
+
+Here is an example controller that handles login and logout for
+brainpickin:
+
+  # Uses restful-authentication style auth. 
+  # 
+  # Define the following in routes.rb:
+
+  #  match 'services/brainpickin_auth' => 'services#brainpickin_auth'
+  #  match 'services/brainpickin_logout' => 'services#brainpickin_logout'
+
+  class brainpickinAuthController < ApplicationController
+    include Brainpickin::RemoteAuthHelper
+  
+    skip_before_filter :login_required, :only => :logout
+  
+    def brainpickin_auth
+      redirect_to brainpickin_remote_auth_url(current_user)
+    end
+
+    def brainpickin_logout
+      redirect_to logout_url
+    end
+
+    protected
+    def login_required
+      if !logged_in?
+        flash[:notice] = 'You must log in to access to brainpickin site.'
+        store_location
+        redirect_to login_path
+      end
+    end
+  end
+
+
+== Copyright
+
+Copyright (c) 2013 brainpickin. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "brainpickin_remote_auth"
+    gem.summary = %Q{Helper for brainpickin Single Sign In/remote authentication}
+    gem.description = %Q{See the README.}
+    gem.email = "eli@brainpickin.com"
+    gem.homepage = "http://github.com/purian/brainpickin_remote_auth"
+    gem.authors = ["Eli Purian"]
+    gem.add_dependency "activesupport", ">= 3.0.0"
+    gem.add_development_dependency "rspec", ">= 2.6.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/brainpickin_remote_auth.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "brainpickin_remote_auth"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eli Purian"]
+  s.date = "2013-04-28"
+  s.description = "See the README."
+  s.email = "eli@brainpickin.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "brainpickin_remote_auth.gemspec",
+    "lib/brainpickin_remote_auth.rb",
+    "spec/brainpickin_remote_auth_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/purian/brainpickin_remote_auth"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "Helper for brainpickin Single Sign In/remote authentication"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_runtime_dependency(%q<rspec>, ["~> 2.13.0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.6.0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rspec>, ["~> 2.13.0"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<rspec>, [">= 2.6.0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rspec>, ["~> 2.13.0"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<rspec>, [">= 2.6.0"])
+  end
+end
+

data/lib/brainpickin_remote_auth.rb

@@ -0,0 +1,81 @@
+require 'digest/md5'
+require 'active_support/core_ext/object' #gives us Hash.to_query
+
+##
+# Provides a helper to use brainpickin's SSO/remote auth service.
+# see: https://my.brainpickin.com/api/remote_authentication
+module Brainpickin
+
+  ##
+  # Handles storing the token and auth_url (endpoint) for the brainpickin side.
+  class RemoteAuth
+    class << self
+      attr_writer :auth_url, :token
+
+      def token
+        raise ArgumentError.new('brainpickin token must be set. Set with Brainpickin::RemoteAuth.token = <token>') unless @token
+        @token
+      end
+
+      def auth_url
+        raise ArgumentError.new('brainpickin auth_url must be set. Set with Brainpickin::RemoteAuth.auth_url = <url>') unless @auth_url
+        @auth_url
+      end
+    end
+  end
+
+  ##
+  # Provides the method that generates the auth url. Mixin where required.
+  module RemoteAuthHelper
+    ##
+    # Takes a hash of parameters and generates the hashed auth
+    # url. The hash must include the :name and :email for the user.
+    # See: https://my.brainpickin.com/api/remote_authentication for a list
+    # of all of the parameters.
+    #
+    # If the :timestamp is not provided, Time.now will be used. If an
+    # :external_id is provided, then the :hash will be generated.
+    #
+    # As a convenience, a user object can be passed instead, but must
+    # respond_to? at least :email and :name. The :id of the user
+    # object will be used as the :external_id.
+
+    def brainpickin_remote_auth_url(user_or_params)
+      params = user_or_params.is_a?(Hash) ? user_or_params : user_to_params(user_or_params)
+      validate_params(params)
+      params[:timestamp] = Time.now.utc.to_i unless params[:timestamp]
+      params[:hash] = params[:external_id] ? generate_hash(Brainpickin::RemoteAuth.token, params) : ''
+
+      "#{Brainpickin::RemoteAuth.auth_url}?#{params.to_query}"
+    end
+
+    private
+    def user_to_params(user)
+      params = { }
+      [[:email, :email],
+       [:name, :name],
+       [:external_id, :id]].each do |param, field|
+        params[param] = user.send(field) if user.respond_to?(field)
+      end
+      params
+    end
+
+    def validate_params(params)
+      [:email, :name].each do |param|
+        raise ArgumentError.new("Required parameter :#{param} not given") unless params[param]
+      end
+    end
+    
+    def generate_hash(token, params)
+      str_to_hash = params[:name].clone
+      str_to_hash << params[:email]
+      str_to_hash << params[:external_id].to_s if params[:external_id]
+      str_to_hash << params[:interests].to_s if params[:interests]
+      str_to_hash << params[:remote_photo_url].to_s if params[:remote_photo_url]
+      str_to_hash << token
+      str_to_hash << params[:timestamp].to_s
+      Digest::MD5.hexdigest(str_to_hash)
+    end
+
+  end
+end

data/spec/brainpickin_remote_auth_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Brainpickin::RemoteAuth do
+  
+  before(:each) do
+    @auth = Object.new
+    @auth.extend(Brainpickin::RemoteAuthHelper)
+  end
+  
+  context 'RemoteAuth' do
+    before(:each) do
+      Brainpickin::RemoteAuth.token = Brainpickin::RemoteAuth.auth_url = nil
+    end
+    
+    it 'should raise exception if token is not set' do
+      lambda{ Brainpickin::RemoteAuth.token }.should raise_error(ArgumentError)
+    end
+
+    it 'should return the token without exception if it is set' do
+      Brainpickin::RemoteAuth.token = 'blah'
+      Brainpickin::RemoteAuth.token.should == 'blah'
+    end
+
+
+    it 'should raise exception if auth_url is not set' do
+      lambda { Brainpickin::RemoteAuth.auth_url }.should raise_error(ArgumentError)
+    end
+
+    it 'should return the auth_url without exception if it is set' do
+      Brainpickin::RemoteAuth.auth_url = 'blah'
+      Brainpickin::RemoteAuth.auth_url.should == 'blah'
+    end
+  end
+  
+
+  context 'url generation' do
+    before(:each) do
+      Brainpickin::RemoteAuth.token = 'the_token'
+      Brainpickin::RemoteAuth.auth_url = 'the_url'
+      @valid_params = { :email => 'test@example.com', :name => 'blah'}
+    end
+    
+    context 'required fields' do
+      it 'should raise an argument error the name is not provided' do
+        lambda {
+          @valid_params.delete(:name)
+          @auth.brainpickin_remote_auth_url(@valid_params)
+        }.should raise_error(ArgumentError) 
+      end
+
+      it 'should raise an argument error the email is not provided' do
+        lambda {
+          @valid_params.delete(:email)
+          @auth.brainpickin_remote_auth_url(@valid_params)
+        }.should raise_error(ArgumentError) 
+      end
+
+    end
+    
+    it 'should return a url that starts with the auth_url' do
+      @auth.brainpickin_remote_auth_url(@valid_params)
+    end
+
+    it 'should have an empty hash param if external_id not provided' do
+      @auth.brainpickin_remote_auth_url(@valid_params).should =~ /hash=(&|$)/
+    end
+
+    it 'should have a hash param if external_id provided' do
+      @auth.brainpickin_remote_auth_url(@valid_params.merge(:external_id => 'id')).should_not =~ /hash=(&|$)/
+    end
+
+    it 'should have a different hash param if external_id and remote_photo_url provided ' do
+      a=@auth.brainpickin_remote_auth_url(@valid_params.merge(:external_id => 'id')).match(/(hash=[^&]*)/)[1]
+      b=@auth.brainpickin_remote_auth_url(@valid_params.merge(:external_id => 'id', :remote_photo_url => 'photo_url')).match(/(hash=[^&]*)/)[1]
+      a.should_not == b
+    end
+
+    context 'given a user object' do
+      before(:each) do
+        @user = mock
+        @user.should_receive(:name).and_return('a_name')
+        @user.should_receive(:email).and_return('an_email')
+      end
+      
+      it 'should pull the name from the user' do
+        @auth.brainpickin_remote_auth_url(@user).should =~ /name=a_name/
+      end
+      
+      it 'should pull the email from the user' do
+        @auth.brainpickin_remote_auth_url(@user).should =~ /email=an_email/
+      end
+      
+      it 'should pull the id from the user' do
+        @user.should_receive(:id).and_return('an_id')
+        @auth.brainpickin_remote_auth_url(@user).should =~ /external_id=an_id/
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'brainpickin_remote_auth'
+

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: brainpickin_remote_auth
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Eli Purian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+description: See the README.
+email: eli@brainpickin.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- brainpickin_remote_auth.gemspec
+- lib/brainpickin_remote_auth.rb
+- spec/brainpickin_remote_auth_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/purian/brainpickin_remote_auth
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3391257356349651697
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Helper for brainpickin Single Sign In/remote authentication
+test_files: []