omniauth-desk 0.0.1

data/.gitignore

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

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2-p290@omniauth-desk --create

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in omniauth-flickr.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Salesforce.com
+
+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,40 @@
+# OmniAuth Desk
+
+This gem contains the Desk.com strategy for OmniAuth.
+
+Desk.com uses the OAuth 1.0a flow, you can read about it here: http://dev.desk.com/docs/api/oauth
+
+## How To Use It
+
+Add the strategy to your `Gemfile`:
+
+    gem 'omniauth-desk'
+
+Or you can pull it directly from github eg:
+
+    gem 'omniauth-desk', :git => 'https://github.com/tstachl/omniauth-desk.git'
+
+For a Rails application you'd now create an initializer `config/initializers/omniauth.rb`:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :desk, 'api_key', 'api_secret', :site => 'https://yoursite.desk.com' 
+    end
+
+For Sinatra you'd add this 4 lines:
+
+    use Rack::Session::Cookie
+    use OmniAuth::Builder do
+      provider :desk, 'api_key', 'api_secret', :site => 'https://yoursite.desk.com'
+    end
+
+You can find the api_key and the api_secret in your desk.com administration area. Click on Settings -> API -> My Applications.
+
+## License
+
+Copyright (c) 2011 by Salesforce.com, Thomas Stachl <tstachl@salesforce.com>
+
+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/desk.rb

@@ -0,0 +1,54 @@
+require 'omniauth-oauth'
+require 'multi_json'
+
+module OmniAuth
+  module Strategies
+    # An omniauth 1.0 strategy for Desk.com authorization
+    class Desk < OmniAuth::Strategies::OAuth
+      option :name, 'desk'
+      option :client_options, {
+        :authorize_path       => '/oauth/authorize',
+        :request_token_path   => '/oauth/request_token',
+        :access_token_path    => '/oauth/access_token',
+      }
+
+      uid { 
+        user_info['id']
+      }
+      
+      info do 
+        {
+          :name        => user_info['name'],
+          :name_public => user_info['name_public'],
+          :email       => user_info['email'],
+          :user_level  => user_info['user_level'],
+          :login_count => user_info['login_count'],
+          :time_zone   => user_info['time_zone']
+        }
+      end
+            
+      extra do
+        {
+          :raw_info => raw_info
+        }
+      end
+
+      # Return info gathered from the verify_credentials API call 
+      def raw_info
+        @raw_info ||= MultiJson.decode(access_token.get('/api/v1/account/verify_credentials.json').body)
+      rescue ::Errno::ETIMEDOUT
+        raise ::Timeout::Error
+      end
+
+      # Provide the "user" portion of the raw_info
+      def user_info
+        @user_info ||= raw_info.nil? ? {} : raw_info['user']
+      end
+      
+      def request_phase
+        options[:client_options][:site] = options[:site] if options[:site]
+        super
+      end
+    end
+  end
+end

data/lib/omniauth-desk/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Desk
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth-desk.rb

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

data/omniauth-desk.gemspec

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

data/spec/omniauth/strategies/desk_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Desk do
+  subject do
+    OmniAuth::Strategies::Desk.new({})
+  end
+
+  context "client options" do
+    it 'should have correct name' do
+      subject.options.name.should eq("desk")
+    end
+
+    it 'should have correct authorize path' do
+      subject.options.client_options.authorize_path.should eq('/oauth/authorize')
+    end
+
+    it 'should have correct request token path' do
+      subject.options.client_options.request_token_path.should eq('/oauth/request_token')
+    end
+
+    it 'should have correct access token path' do
+      subject.options.client_options.access_token_path.should eq('/oauth/access_token')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$:.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-desk'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-desk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Stachl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: &2154477140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154477140
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth
+  requirement: &2154476400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154476400
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &2154475620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154475620
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2154475000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *2154475000
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2154474440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *2154474440
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &2154474000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154474000
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2154473420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154473420
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &2154472980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154472980
+description: OmniAuth strategy for Desk.com
+email:
+- tstachl@salesforce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-desk.rb
+- lib/omniauth-desk/version.rb
+- lib/omniauth/strategies/desk.rb
+- omniauth-desk.gemspec
+- spec/omniauth/strategies/desk_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tstachl/omniauth-desk
+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: 2036770633909583126
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2036770633909583126
+requirements: []
+rubyforge_project: omniauth-desk
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: OmniAuth strategy for Desk.com
+test_files:
+- spec/omniauth/strategies/desk_spec.rb
+- spec/spec_helper.rb