omniauth-odesk 1.0.0

data/.gitignore

@@ -0,0 +1,9 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+Gemfile.lock
+.project
+*.gem

data/Gemfile

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

data/README.md

@@ -0,0 +1,78 @@
+omniauth-odesk
+===============
+
+Odesk Developer API OAuth 1.0 Strategy for OmniAuth.
+
+Supports the OAuth 1.0 server-side and client-side flows. Read the [Odesk Developer API docs](http://developers.odesk.com/w/page/38106543/Authentication-using-OAuth) for more details.
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-odesk'
+```
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::Odesk` is simply a Rack middleware.Read the [OmniAuth 1.0](https://github.com/intridea/omniauth) and [OAuth 2.0](https://github.com/intridea/oauth2) docs for detailed instructions
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :elance, ENV['ODESK_CONSUMER_KEY'], ENV['ODESK_CONSUMER_SECRET']
+end
+```
+
+## Examples
+Standalone usage from a Ruby script samples can be found under `examples` folder.
+
+## Auth Hash
+
+Here's an example [Auth Hash](https://github.com/intridea/omniauth/wiki/Auth-Hash-Schema) available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => 'odesk',
+  :uid => '1234567',
+  :info => {
+    first_name: 'First Name',
+    last_name: 'Last Name',
+    email: 'email@odesk.com',
+    status: 'active',
+    profile_key: 'profile_key'
+  },
+  :credentials => {
+    :token => 'ABCDEF...', # OAuth 2.0 access_token, which you may wish to store
+    :expires_at => 1321747205, # when the access token expires (it always will)
+    :expires => true # this will always be true
+  },
+  :extra => {
+    :raw_info => {
+        id: "4124672",
+        status: "active",
+        timezone: "UTC+02:00 Eastern Europe",
+        timezone_offset: "10800"
+        public_url: 'https://www.odesk.com/users/~~kyad0112d885630b',
+        last_name: 'Novozhylov',
+        email: 'myemail@odesk.com',
+        reference: "12345",
+        first_name: "Maksym",
+        profile_key: "~~kyad0112d885630b",
+        id_provider: '1'
+  }
+}
+```
+
+## License
+
+Copyright (c) 2013 by Jignesh Gohel
+
+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/examples/oauth_odesk_script.rb

@@ -0,0 +1,75 @@
+# References:
+# http://wiki.openstreetmap.org/wiki/OAuth_ruby_examples
+# https://github.com/oauth-xx/oauth-ruby
+# https://github.com/oauth-xx/oauth-ruby/tree/master/lib/oauth
+require 'rubygems'
+require 'oauth'
+require 'json'
+
+auth={}
+
+puts "First, create API keys at"
+puts "https://www.odesk.com/services/api/keys"
+puts "Enter the consumer key you are assigned:"
+auth[:consumer_key] = gets.strip
+puts "Enter the consumer secret you are assigned:"
+auth[:consumer_secret] = gets.strip
+puts "Your application is now set up, but you need to register"
+puts "this instance of it with your user account."
+
+client_opts = {
+  site: "https://www.odesk.com",
+  request_token_path: "/api/auth/v1/oauth/token/request",
+  authorize_path: "/services/api/auth",
+  access_token_path: "/api/auth/v1/oauth/token/access"
+}
+
+@consumer = OAuth::Consumer.new(auth[:consumer_key], auth[:consumer_secret], client_opts)
+@request_token = @consumer.get_request_token
+
+puts "Visit the following URL, log in if you need to, and authorize the app"
+authorize_url = @request_token.authorize_url
+
+puts authorize_url
+
+puts "When you've authorized the request, enter the verifier code you are assigned:"
+
+verifier = gets.strip
+
+puts "Converting the authorization code into access token..."
+
+access_token_params = {
+  oauth_verifier: verifier
+}
+
+@access_token= @request_token.get_access_token(access_token_params)
+
+auth[:token] = @access_token.token
+auth[:token_secret] = @access_token.secret
+
+puts "Done.Following are the credentials to be used to access the API"
+puts "#{auth}"
+
+puts "Fetching your basic information now..."
+
+raw_info = @access_token.get('/api/hr/v2/users/me.json').read_body
+
+if raw_info
+  user_info = JSON.parse(raw_info)['user']
+  id = user_info['id']
+  first_name =  user_info['first_name']
+  last_name = user_info['last_name']
+  email = user_info['email']
+  status = user_info['status']
+  profile_key = user_info['profile_key']
+
+  puts "Id: #{id}"
+  puts "Name: #{first_name} #{last_name}"
+  puts "Email: #{email}"
+  puts "Status: #{status}"
+  puts "Profile Key: #{profile_key}"
+end
+
+
+
+

data/lib/omniauth-odesk.rb

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

data/lib/omniauth-odesk/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Odesk
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth/strategies/odesk.rb

@@ -0,0 +1,50 @@
+require 'omniauth-oauth'
+require 'json'
+
+module OmniAuth
+  module Strategies
+    class Odesk < OmniAuth::Strategies::OAuth
+      # Strategy name
+      option :name, "odesk"
+
+      # Options being passed to initialize client from the OAuth Gem.
+      # Reference: https://github.com/oauth-xx/oauth-ruby
+      option :client_options, {
+          site: "https://www.odesk.com",
+          request_token_path: "/api/auth/v1/oauth/token/request",
+          authorize_path: "/services/api/auth",
+          access_token_path: "/api/auth/v1/oauth/token/access"
+      }
+
+      # Called after authentication has succeeded.
+      uid {
+        raw_info['id']
+      }
+
+      info do
+        {
+          first_name: raw_info['first_name'],
+          last_name: raw_info['last_name'],
+          email: raw_info['email'],
+          status: raw_info['status'],
+          profile_key: raw_info['profile_key']
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        # Reference: https://www.elance.com/q/api2/methods/profiles/my
+        raw_info = access_token.get('/api/hr/v2/users/me.json')
+
+        data = raw_info.read_body
+        data = (data ? JSON.parse(data) : {} )
+        data['user'] || {}
+      end
+    end
+  end
+end

data/omniauth-odesk.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-odesk/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'omniauth-oauth', '~> 1.0.1'
+  gem.add_dependency 'json', '~> 1.8.0'
+
+  gem.authors           = ["Jignesh Gohel"]
+  gem.email             = ["jignesh.gohel@botreeconsulting.com"]
+  gem.description       = %q{Odesk strategy for OmniAuth.}
+  gem.summary           = %q{Odesk strategy for OmniAuth.}
+  gem.homepage          = "https://github.com/JigneshGohel-BoTreeConsulting/omniauth-odesk"
+  gem.license           = "MIT"
+
+  gem.executables       = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files             = `git ls-files`.split("\n")
+  gem.test_files        = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name              = "omniauth-odesk"
+  gem.require_paths     = ["lib"]
+  gem.version           = OmniAuth::Odesk::VERSION
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-odesk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jignesh Gohel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Odesk strategy for OmniAuth.
+email:
+- jignesh.gohel@botreeconsulting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- examples/oauth_odesk_script.rb
+- lib/omniauth-odesk.rb
+- lib/omniauth-odesk/version.rb
+- lib/omniauth/strategies/odesk.rb
+- omniauth-odesk.gemspec
+homepage: https://github.com/JigneshGohel-BoTreeConsulting/omniauth-odesk
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.8.25
+signing_key: 
+specification_version: 3
+summary: Odesk strategy for OmniAuth.
+test_files: []