zendesk_remote_auth 0.9.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tobias Crawley
+
+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,89 @@
+= zendesk_remote_auth
+
+zendesk_remote_auth is a simple gem providing help with Zendesk's SSO
+functionality (see http://www.zendesk.com/api/remote_authentication).
+
+== Installation and Setup
+
+* Install:
+
+  gem install tobias-zendesk_remote_auth
+
+* Setup:
+You will need to give the gem your token and authentication url,
+perhaps in an initializer:
+  Zendesk::RemoteAuth.token = 'YOUR-TOKEN'
+  Zendesk::RemoteAuth.auth_url = 'https://yourcompany.zendesk.com/access/remote/'
+
+and config the gem in environment.rb (if using rails):
+  config.gem 'tobias-zendesk_remote_auth', :lib => 'zendesk_remote_auth', :source => http://gems.github.com'
+
+== Usage
+
+Mixin the Zendesk::RemoteAuthHelper module wherever needed, then call:
+  zendesk_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 zendesk account. 
+
+As a convenience, you can pass a user object to zendesk_remote_auth_url:
+  zendesk_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). If the user object responds to :zendesk_organization, that will
+be used as the :organization for the call.
+
+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
+zendesk:
+
+  # Uses restful-authentication style auth. 
+  # 
+  # Define the following in routes.rb:
+  # map.with_options :controller => 'zendesk_auth' do |zd|
+  #   zd.connect '/zendesk/authorize', :action => 'authorize'
+  #   zd.connect '/zendesk/logout', :action => 'logout'
+  # end
+  class ZendeskAuthController < ApplicationController
+    include Zendesk::RemoteAuthHelper
+  
+    skip_before_filter :login_required, :only => :logout
+  
+    def authorize
+      redirect_to zendesk_remote_auth_url(current_user)
+    end
+
+    def logout
+      redirect_to logout_url
+    end
+
+    protected
+    def login_required
+      if !logged_in?
+        flash[:notice] = 'You must log in to access the support site.'
+        store_location
+        redirect_to login_path
+      end
+    end
+  end
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Tobias Crawley. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "zendesk_remote_auth"
+    gem.summary = %Q{Helper for Zendesk SSO/remote authentication}
+    gem.description = %Q{See the README.}
+    gem.email = "tcrawley@gmail.com"
+    gem.homepage = "http://github.com/tobias/zendesk_remote_auth"
+    gem.authors = ["Tobias Crawley"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "mocha"
+    gem.add_development_dependency "matchy"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+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 @@
+0.9.0

data/lib/zendesk_remote_auth.rb

@@ -0,0 +1,82 @@
+require 'digest/md5'
+require 'active_support' #gives us Hash.to_query
+
+##
+# Provides a helper to use Zendesk's SSO/remote auth service.
+# see: http://www.zendesk.com/api/remote_authentication
+module Zendesk
+
+  ##
+  # Handles storing the token and auth_url (endpoint) for the Zendesk side.
+  class RemoteAuth
+    class << self
+      attr_writer :auth_url, :token
+
+      def token
+        raise ArgumentError.new('Zendesk token must be set. Set with Zendesk::RemoteAuth.token = <token>') unless @token
+        @token
+      end
+
+      def auth_url
+        raise ArgumentError.new('Zendesk auth_url must be set. Set with Zendesk::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: http://www.zendesk.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, and if the user
+    # responds to :zendesk_organization, that will be used as the
+    # :organization. 
+    def zendesk_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(Zendesk::RemoteAuth.token, params) : ''
+
+      "#{Zendesk::RemoteAuth.auth_url}?#{params.to_query}"
+    end
+
+    private
+    def user_to_params(user)
+      params = { }
+      [[:email, :email],
+       [:name, :name],
+       [:external_id, :id],
+       [:organization, :zendesk_organization]].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[:organization].to_s if params[:organization]
+      str_to_hash << token
+      str_to_hash << params[:timestamp].to_s
+      Digest::MD5.hexdigest(str_to_hash)
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'matchy'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'zendesk_remote_auth'
+
+class Test::Unit::TestCase
+end

data/test/zendesk_remote_auth_test.rb

@@ -0,0 +1,103 @@
+require 'test_helper'
+
+class ZendeskRemoteAuthTest < Test::Unit::TestCase
+  
+  def setup
+    @auth = Object.new
+    @auth.extend(Zendesk::RemoteAuthHelper)
+  end
+  
+  context 'RemoteAuth' do
+    setup do
+      Zendesk::RemoteAuth.token = Zendesk::RemoteAuth.auth_url = nil
+    end
+    
+    should 'raise exception if token is not set' do
+      assert_raise ArgumentError do
+        Zendesk::RemoteAuth.token
+      end
+    end
+
+    should 'return the token without exception if it is set' do
+      Zendesk::RemoteAuth.token = 'blah'
+      Zendesk::RemoteAuth.token.should == 'blah'
+    end
+
+
+    should 'raise exception if auth_url is not set' do
+      assert_raise ArgumentError do
+        Zendesk::RemoteAuth.auth_url
+      end
+    end
+
+    should 'return the auth_url without exception if it is set' do
+      Zendesk::RemoteAuth.auth_url = 'blah'
+      Zendesk::RemoteAuth.auth_url.should == 'blah'
+    end
+  end
+  
+
+  context 'url generation' do
+    setup do
+      Zendesk::RemoteAuth.token = 'the_token'
+      Zendesk::RemoteAuth.auth_url = 'the_url'
+      @valid_params = { :email => 'test@example.com', :name => 'blah'}
+    end
+    
+    context 'required fields' do
+      should 'raise an argument error the name is not provided' do
+        assert_raise ArgumentError do
+          @valid_params.delete(:name)
+          @auth.zendesk_remote_auth_url(@valid_params)
+        end
+      end
+
+      should 'raise an argument error the email is not provided' do
+        assert_raise ArgumentError do
+          @valid_params.delete(:email)
+          @auth.zendesk_remote_auth_url(@valid_params)
+        end
+      end
+
+    end
+    
+    should 'return a url that starts with the auth_url' do
+      @auth.zendesk_remote_auth_url(@valid_params)
+    end
+
+    should 'have an empty hash param if external_id not provided' do
+      @auth.zendesk_remote_auth_url(@valid_params).should =~ /hash=(&|$)/
+    end
+
+    should 'have a hash param if external_id provided' do
+      @auth.zendesk_remote_auth_url(@valid_params.merge(:external_id => 'id')).should_not =~ /hash=(&|$)/
+    end
+
+    context 'given a user object' do
+      setup do
+        @user = mock
+        @user.expects(:name).returns('a_name')
+        @user.expects(:email).returns('an_email')
+      end
+      
+      should 'pull the name from the user' do
+        @auth.zendesk_remote_auth_url(@user).should =~ /name=a_name/
+      end
+      
+      should 'pull the email from the user' do
+        @auth.zendesk_remote_auth_url(@user).should =~ /email=an_email/
+      end
+      
+      should 'pull the id from the user' do
+        @user.expects(:id).returns('an_id')
+        @auth.zendesk_remote_auth_url(@user).should =~ /external_id=an_id/
+      end
+
+      should 'pull the organization from the user if available' do
+        @user.expects(:zendesk_organization).returns('org')
+        @auth.zendesk_remote_auth_url(@user).should =~ /organization=org/
+      end
+      
+    end
+  end
+end

data/zendesk_remote_auth.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{zendesk_remote_auth}
+  s.version = "0.9.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tobias Crawley"]
+  s.date = %q{2009-10-01}
+  s.description = %q{See the README.}
+  s.email = %q{tcrawley@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/zendesk_remote_auth.rb",
+     "test/test_helper.rb",
+     "test/zendesk_remote_auth_test.rb",
+     "zendesk_remote_auth.gemspec"
+  ]
+  s.homepage = %q{http://github.com/tobias/zendesk_remote_auth}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Helper for Zendesk SSO/remote authentication}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/zendesk_remote_auth_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<matchy>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<matchy>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<matchy>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: zendesk_remote_auth
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Tobias Crawley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-01 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: matchy
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: See the README.
+email: tcrawley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/zendesk_remote_auth.rb
+- test/test_helper.rb
+- test/zendesk_remote_auth_test.rb
+- zendesk_remote_auth.gemspec
+has_rdoc: true
+homepage: http://github.com/tobias/zendesk_remote_auth
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Helper for Zendesk SSO/remote authentication
+test_files: 
+- test/test_helper.rb
+- test/zendesk_remote_auth_test.rb