zendesk_remote_auth 1.1.0 → 1.2.0

data/LICENSE

@@ -1,5 +1,3 @@
-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

data/README.rdoc

@@ -1,13 +1,9 @@
 = 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).
-
-== HEY YOU!
+16/02/2012 Viewbook took over this gem from Tobias Crawley, this is now the official repo for this gem.
 
-Do you actually use this gem? Are you interested in taking it over?
-I no longer use this, so don't have a lot of interest in maintaining it. 
-If you do, get in touch.
+zendesk_remote_auth is a simple gem providing help with Zendesk's SSO
+functionality (see http://www.zendesk.com/support/api/remote-authentication).
 
 == Installation and Setup
 
@@ -18,14 +14,14 @@ If you do, get in touch.
 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/'
+  Zendesk::RemoteAuth.auth_url = 'https://domain.zendesk.com/access/remoteauth'
 
 and config the gem in environment.rb (if using rails):
   config.gem 'zendesk_remote_auth'
 
 == Usage
 
-Note: The latest release requires ActiveSupport 3.0 or greater. 
+Note: The latest release requires ActiveSupport 3.0 or greater.
 
 Mixin the Zendesk::RemoteAuthHelper module wherever needed, then call:
   zendesk_remote_auth_url(:name => 'user name',
@@ -33,7 +29,7 @@ Mixin the Zendesk::RemoteAuthHelper module wherever needed, then call:
                           <optional params>)
 
 This will return a url you can redirect the user to to log them in to
-your zendesk account. 
+your zendesk account.
 
 As a convenience, you can pass a user object to zendesk_remote_auth_url:
   zendesk_remote_auth_url(user)
@@ -44,16 +40,20 @@ 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.
 
+Same goes for :zendesk_tags, you'll need a string such as:
+  "fine looking gentlemen,single"
+And it'll automatically be passed as :tags to Zendesk
+
 This method will generate and include the hash of the parameters for
-you if necessary. 
+you if necessary.
 
 == Example Auth Controller
 
 Here is an example controller that handles login and logout for
 zendesk:
 
-  # Uses restful-authentication style auth. 
-  # 
+  # 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'
@@ -61,9 +61,9 @@ zendesk:
   # 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
@@ -84,13 +84,9 @@ zendesk:
 
 
 == 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) 2011 Tobias Crawley. See LICENSE for details.

data/Rakefile

@@ -7,9 +7,9 @@ begin
     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.email = "info@viewbook.com"
+    gem.homepage = "https://github.com/viewbook/zendesk_remote_auth"
+    gem.authors = ["Viewbook"]
     gem.add_dependency "activesupport", ">= 3.0.0"
     gem.add_development_dependency "rspec", ">= 2.6.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/lib/zendesk_remote_auth.rb

@@ -40,12 +40,12 @@ module Zendesk
     # 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. 
+    # :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) : ''
+      params[:hash] = generate_hash(Zendesk::RemoteAuth.token, params)
 
       "#{Zendesk::RemoteAuth.auth_url}?#{params.to_query}"
     end
@@ -56,7 +56,8 @@ module Zendesk
       [[:email, :email],
        [:name, :name],
        [:external_id, :id],
-       [:organization, :zendesk_organization]].each do |param, field|
+       [:organization, :zendesk_organization],
+       [:tags, :zendesk_tags]].each do |param, field|
         params[param] = user.send(field) if user.respond_to?(field)
       end
       params
@@ -67,17 +68,19 @@ module Zendesk
         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 << params[:tags].to_s if params[:tags]
-      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)
+      parts = []
+      parts << params[:name]
+      parts << params[:email]
+      parts << params[:external_id]
+      parts << params[:organization]
+      parts << params[:tags]
+      parts << params[:remote_photo_url]
+      parts << token
+      parts << params[:timestamp]
+      input = parts.join('|')
+      Digest::MD5.hexdigest(input)
     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 'zendesk_remote_auth'
+

data/spec/zendesk_remote_auth_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe Zendesk::RemoteAuth do
+  
+  before(:each) do
+    @auth = Object.new
+    @auth.extend(Zendesk::RemoteAuthHelper)
+  end
+  
+  context 'RemoteAuth' do
+    before(:each) do
+      Zendesk::RemoteAuth.token = Zendesk::RemoteAuth.auth_url = nil
+    end
+    
+    it 'should raise exception if token is not set' do
+      lambda{ Zendesk::RemoteAuth.token }.should raise_error(ArgumentError)
+    end
+
+    it 'should return the token without exception if it is set' do
+      Zendesk::RemoteAuth.token = 'blah'
+      Zendesk::RemoteAuth.token.should == 'blah'
+    end
+
+
+    it 'should raise exception if auth_url is not set' do
+      lambda { Zendesk::RemoteAuth.auth_url }.should raise_error(ArgumentError)
+    end
+
+    it '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
+    before(:each) 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
+      it 'should raise an argument error the name is not provided' do
+        lambda {
+          @valid_params.delete(:name)
+          @auth.zendesk_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.zendesk_remote_auth_url(@valid_params)
+        }.should raise_error(ArgumentError) 
+      end
+
+    end
+    
+    it 'should return a url that starts with the auth_url' do
+      @auth.zendesk_remote_auth_url(@valid_params)
+    end
+
+    it 'should have a hash param' do
+      @auth.zendesk_remote_auth_url(@valid_params).should_not =~ /hash=(&|$)/
+    end
+
+    it 'should have a different hash param if external_id and remote_photo_url provided ' do
+      a=@auth.zendesk_remote_auth_url(@valid_params.merge(:external_id => 'id')).match(/(hash=[^&]*)/)[1]
+      b=@auth.zendesk_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.zendesk_remote_auth_url(@user).should =~ /name=a_name/
+      end
+      
+      it 'should pull the email from the user' do
+        @auth.zendesk_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.zendesk_remote_auth_url(@user).should =~ /external_id=an_id/
+      end
+
+      it 'should pull the organization from the user if available' do
+        @user.should_receive(:zendesk_organization).and_return('org')
+        @auth.zendesk_remote_auth_url(@user).should =~ /organization=org/
+      end
+      
+      it 'should pull tags from the user if available' do
+        @user.should_receive(:zendesk_tags).and_return('fine looking gentlemen,married')
+        @auth.zendesk_remote_auth_url(@user).should =~/tags=fine\+looking\+gentlemen%2Cmarried/
+      end
+    end
+  end
+end

data/zendesk_remote_auth.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{zendesk_remote_auth}
-  s.version = "1.1.0"
+  s.name = "zendesk_remote_auth"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Tobias Crawley}]
-  s.date = %q{2011-12-14}
-  s.description = %q{See the README.}
-  s.email = %q{tcrawley@gmail.com}
+  s.authors = ["Viewbook"]
+  s.date = "2012-11-16"
+  s.description = "See the README."
+  s.email = "info@viewbook.com"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
@@ -23,12 +23,14 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/zendesk_remote_auth.rb",
+    "spec/spec_helper.rb",
+    "spec/zendesk_remote_auth_spec.rb",
     "zendesk_remote_auth.gemspec"
   ]
-  s.homepage = %q{http://github.com/tobias/zendesk_remote_auth}
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.4}
-  s.summary = %q{Helper for Zendesk SSO/remote authentication}
+  s.homepage = "https://github.com/viewbook/zendesk_remote_auth"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "Helper for Zendesk SSO/remote authentication"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -1,96 +1,87 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: zendesk_remote_auth
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 0
-  version: 1.1.0
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+  prerelease: 
 platform: ruby
-authors: 
-- Tobias Crawley
+authors:
+- Viewbook
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-14 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - 0
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 6
-        - 0
+  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
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 description: See the README.
-email: tcrawley@gmail.com
+email: info@viewbook.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
+files:
 - .document
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/zendesk_remote_auth.rb
+- spec/spec_helper.rb
+- spec/zendesk_remote_auth_spec.rb
 - zendesk_remote_auth.gemspec
-has_rdoc: true
-homepage: http://github.com/tobias/zendesk_remote_auth
+homepage: https://github.com/viewbook/zendesk_remote_auth
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Helper for Zendesk SSO/remote authentication
 test_files: []
-