omniauth-zendesk 0.1.0

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in omniauth-desk.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rake'
+end

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Thomas Stachl <tom@desk.com>, Desk.com - A Salesforce.com Company
+
+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,37 @@
+# OmniAuth Zendesk
+
+This gem contains the Zendesk strategy for OmniAuth.
+
+Zendesk uses the HTTPBasic Authentication flow, you can read about it here: [Zendesk API - Security and Authentication](http://developer.zendesk.com/documentation/rest_api/introduction.html#security-and-authentication)
+
+## How To Use It
+
+Add the strategy to your `Gemfile`:
+
+    gem 'omniauth-zendesk'
+
+Or you can pull it directly from github eg:
+
+    gem 'omniauth-zendesk', :git => 'https://github.com/tstachl/omniauth-zendesk.git'
+
+For a Rails application you'd now create an initializer `config/initializers/omniauth.rb`:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :zendesk, :site => 'https://yoursite.zendesk.com' 
+    end
+
+For Sinatra you'd add this 3 lines:
+
+    use OmniAuth::Builder do
+      provider :zendesk, :site => 'https://yoursite.zendesk.com'
+    end
+
+## License
+
+Copyright (c) 2013 Thomas Stachl <tom@desk.com>, Desk.com - A Salesforce.com Company
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+desc 'Default: run specs.'
+task :default => :spec

data/lib/omniauth/strategies/zendesk.rb

@@ -0,0 +1,83 @@
+require 'zendesk_api'
+
+module OmniAuth
+  module Strategies
+    class Zendesk
+      include OmniAuth::Strategy
+      
+      option :site, nil
+      option :params, { site: 'site', username: 'email', password: 'password' }
+      option :on_failed_registration, nil
+      
+      uid  { identity.url }
+      info {
+        {
+          name:         identity.name,
+          email:        identity.email,
+          role:         identity.role,
+          time_zone:    identity.time_zone,
+          description:  identity.notes,
+          image:        identity.photo.respond_to?(:thumbnails) ? identity.photo.thumbnails.first.content_url : nil,
+          phone:        identity.phone,
+          site:         site
+        }
+      }
+      credentials { { token: username, secret: password } }
+      extra { { raw_info: identity } }
+      
+      def request_phase
+        OmniAuth::Form.build(
+          title: (options[:title] || "Zendesk Authentication"),
+          url: callback_path
+        ) do |f|
+          f.text_field 'Username', options.params.username
+          f.password_field 'Password', options.params.password
+          f.text_field 'Zendesk Site', options.params.site
+        end.to_response
+      end
+      
+      def callback_phase
+        return fail!(:invalid_credentials) if not identity or identity.email == 'invalid@example.com'
+        super
+      end
+      
+      def identity
+        return unless site && username && password
+        client = ZendeskAPI::Client.new do |c|
+          c.url = "#{site}/api/v2"
+          c.username = username
+          c.password = password
+        end
+        @identity ||= client.current_user
+      end
+      
+    protected
+      def site
+        options.site || validate_site(request.params[options.params.site])
+      end
+      
+      def username
+        request.params[options.params.username]
+      end
+      
+      def password
+        request.params[options.params.password]
+      end
+      
+      def uri?(uri)
+        uri = URI.parse(uri)
+        uri.scheme == 'https'
+      rescue URI::BadURIError
+        false
+      rescue URI::InvalidURIError
+        false
+      end
+      
+      def validate_site(str)
+        if str and str != ''
+          uri?(str) ? str : "https://#{str}.zendesk.com"
+        end
+      end
+    end
+  end
+end

data/lib/omniauth-zendesk/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Zendesk
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth-zendesk.rb

@@ -0,0 +1,2 @@
+require 'omniauth-zendesk/version'
+require 'omniauth/strategies/zendesk'

data/omniauth-zendesk.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-zendesk/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-zendesk"
+  s.version     = OmniAuth::Zendesk::VERSION
+  s.authors     = ["Thomas Stachl"]
+  s.email       = ["tom@desk.com"]
+  s.homepage    = "https://github.com/tstachl/omniauth-zendesk"
+  s.summary     = %q{OmniAuth strategy for Zendesk}
+  s.description = %q{OmniAuth strategy for Zendesk}
+
+  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_runtime_dependency 'omniauth', '~> 1.0'
+  s.add_runtime_dependency 'zendesk_api', '~> 0.2.2'
+  
+  s.add_development_dependency 'rspec', '~> 2.7'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'webmock'
+end

data/spec/fixtures/anonymous.json

@@ -0,0 +1,33 @@
+{
+    "user": {
+        "url": null,
+        "id": null,
+        "external_id": null,
+        "name": "Anonymous user",
+        "alias": null,
+        "created_at": null,
+        "updated_at": null,
+        "active": true,
+        "verified": false,
+        "shared": false,
+        "locale_id": null,
+        "locale": "en-US",
+        "time_zone": "Pacific Time (US & Canada)",
+        "last_login_at": null,
+        "email": "invalid@example.com",
+        "phone": null,
+        "signature": null,
+        "details": null,
+        "notes": null,
+        "organization_id": null,
+        "role": "end-user",
+        "custom_role_id": null,
+        "moderator": false,
+        "ticket_restriction": null,
+        "only_private_comments": false,
+        "tags": [],
+        "suspended": false,
+        "photo": null,
+        "authenticity_token": "OoiEE0BhDanZaH6LsWCd9xWBTwfVg090ipqKLeCacKg="
+    }
+}

data/spec/fixtures/me.json

@@ -0,0 +1,46 @@
+{
+    "user": {
+        "url": "https://my.zendesk.com/api/v2/users/35436.json",
+        "id": 35436,
+        "external_id": "sai989sur98w9",
+        "name": "Johnny Agent",
+        "alias": "Mr. Johnny",
+        "created_at": "2009-07-20T22:55:29Z",
+        "updated_at": "2011-05-05T10:38:52Z",
+        "active": true,
+        "verified": true,
+        "shared": false,
+        "locale_id": 1,
+        "locale": "en-US",
+        "time_zone": "Pacific Time (US & Canada)",
+        "last_login_at": "2011-05-05T10:38:52Z",
+        "email": "john@example.com",
+        "phone": "555-123-4567",
+        "signature": "Have a nice day, Johnny",
+        "details": "",
+        "notes": "Johnny is a nice guy!",
+        "organization_id": 57542,
+        "role": "agent",
+        "custom_role_id": 9373643,
+        "moderator": true,
+        "ticket_restriction": "assigned",
+        "only_private_comments": false,
+        "tags": ["enterprise", "other_tag"],
+        "suspended": false,
+        "photo": {
+            "id": 928374,
+            "name": "my_funny_profile_pic.png",
+            "content_url": "https://my.zendesk.com/photos/my_funny_profile_pic.png",
+            "content_type": "image/png",
+            "size": 166144,
+            "thumbnails": [{
+                "id": 928375,
+                "name": "my_funny_profile_pic_thumb.png",
+                "content_url": "https://my.zendesk.com/photos/my_funny_profile_pic_thumb.png",
+                "content_type": "image/png",
+                "size": 58298
+            }]
+        },
+        "authenticity_token": "YPVLYV0ebkk33hYOzylaVXyQZZv1M5+kC4CN17sti4c="
+    }
+}

data/spec/omniauth/strategies/zendesk_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Zendesk do
+  attr_accessor :app
+  
+  let(:auth_hash){ last_response.headers['env']['omniauth.auth'] }
+  
+  # customize rack app for testing, if block is given, reverts to default
+  # rack app after testing is done
+  def set_app!(options = {})
+    old_app = self.app
+    self.app = Rack::Builder.app do
+      use Rack::Session::Cookie, secret: 'ultra_strong_secret'
+      use OmniAuth::Strategies::Zendesk, options
+      run lambda{|env| [404, {'env' => env}, ["HELLO!"]]}
+    end
+    if block_given?
+      yield
+      self.app = old_app
+    end
+    self.app
+  end
+  
+  before(:all) do
+    set_app!
+  end
+  
+  describe '#request_phase' do
+    it 'should display a form' do
+      get '/auth/zendesk'
+      last_response.body.should be_include("<form")
+    end
+  end
+  
+  describe '#callback_phase' do
+    context 'with valid credentials' do
+      before do
+        stub_request(:get, "https://john%40example.com:awesome@my.zendesk.com/api/v2/users/me").
+          to_return(status: 200, body: File.new(File.dirname(__FILE__) + '/../../fixtures/me.json'), headers: {content_type: "application/json; charset=utf-8"})
+        post '/auth/zendesk/callback', email: 'john@example.com', password: 'awesome', site: 'my'
+      end
+
+      it 'should populate the auth hash' do
+        auth_hash.should be_kind_of(Hash)
+      end
+
+      it 'should populate the uid' do
+        auth_hash['uid'].should == 'https://my.zendesk.com/api/v2/users/35436.json'
+      end
+
+      it 'should populate the info hash' do
+        auth_hash['info']['name'].should == 'Johnny Agent'
+      end
+    end
+
+    context 'with invalid credentials' do
+      before do
+        OmniAuth.config.on_failure = lambda{|env| [401, {}, [env['omniauth.error.type'].inspect]]}
+        stub_request(:get, "https://wrong%40example.com:login@my.zendesk.com/api/v2/users/me").
+          to_return(status: 200, body: File.new(File.dirname(__FILE__) + '/../../fixtures/anonymous.json'), headers: {content_type: "application/json; charset=utf-8"})
+        post '/auth/zendesk/callback', email: 'wrong@example.com', password: 'login', site: 'my'
+      end
+    
+      it 'should fail with :invalid_credentials' do
+        last_response.body.should == ':invalid_credentials'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-zendesk'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-zendesk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Stachl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: zendesk_api
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: OmniAuth strategy for Zendesk
+email:
+- tom@desk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/omniauth-zendesk.rb
+- lib/omniauth-zendesk/version.rb
+- lib/omniauth/strategies/zendesk.rb
+- omniauth-zendesk.gemspec
+- spec/fixtures/anonymous.json
+- spec/fixtures/me.json
+- spec/omniauth/strategies/zendesk_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tstachl/omniauth-zendesk
+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: 1456298723233117652
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1456298723233117652
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: OmniAuth strategy for Zendesk
+test_files:
+- spec/fixtures/anonymous.json
+- spec/fixtures/me.json
+- spec/omniauth/strategies/zendesk_spec.rb
+- spec/spec_helper.rb