omniauth-linkedin-oauth2 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+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,72 @@
+# OmniAuth LinkedIn OAuth2 Strategy
+
+A LinkedIn OAuth2 strategy for OmniAuth.
+
+For more details, read the LinkedIn documentation: https://developer.linkedin.com/documents/authentication
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-linkedin-oauth2'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-linkedin-oauth2
+
+## Usage
+
+Register your application with LinkedIn to receive an API key: https://www.linkedin.com/secure/developer
+
+This is an example that you might put into a Rails initializer at `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :linkedin_oauth2, ENV['LINKEDIN_KEY'], ENV['LINKEDIN_SECRET']
+end
+```
+
+You can now access the OmniAuth LinkedIn OAuth2 URL: `/auth/linkedin_oauth2`.
+
+## Granting Member Permissions to Your Application
+
+With the LinkedIn API, you have the ability to specify which permissions you want users to grant your application.
+For more details, read the LinkedIn documentation: https://developer.linkedin.com/documents/authentication
+
+By default, omniauth-linkedin-oauth2 requests the following permissions:
+
+    'r_basicprofile r_emailaddress'
+
+You can configure the scope option:
+
+```ruby
+provider :linkedin_oauth2, ENV['LINKEDIN_KEY'], ENV['LINKEDIN_SECRET'], :scope => 'r_fullprofile r_emailaddress r_network'
+```
+
+## Profile Fields
+
+When specifying which permissions you want to users to grant to your application, you will probably want to specify the array of fields that you want returned in the omniauth hash. The list of default fields is as follows:
+
+```ruby
+['id', 'email-address', 'first-name', 'last-name', 'headline', 'location', 'industry', 'picture-url', 'public-profile-url']
+```
+
+Here's an example of a possible configuration where the the fields returned from the API are: id, email-address, first-name and last-name.
+
+```ruby
+provider :linkedin_oauth2, ENV['LINKEDIN_KEY'], ENV['LINKEDIN_SECRET'], :fields => ['id', 'email-address', 'first-name', 'last-name']
+```
+
+To see a complete list of available fields, consult the LinkedIn documentation at: https://developer.linkedin.com/documents/profile-fields
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/example/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'omniauth-linkedin-oauth2'

data/example/config.ru

@@ -0,0 +1,31 @@
+# Sample app for LinkedIn OAuth2 Strategy
+# Make sure to setup the ENV variables LINKEDIN_KEY and LINKEDIN_SECRET
+# Run with "bundle exec rackup"
+
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-linkedin-oauth2'
+
+class App < Sinatra::Base
+  get '/' do
+    redirect '/auth/linkedin_oauth2'
+  end
+
+  get '/auth/:provider/callback' do
+    content_type 'application/json'
+    MultiJson.encode(request.env['omniauth.auth'])
+  end
+
+  get '/auth/failure' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+end
+
+use Rack::Session::Cookie, :secret => 'change_me'
+
+use OmniAuth::Builder do
+  provider :linkedin_oauth2, ENV['LINKEDIN_KEY'], ENV['LINKEDIN_SECRET']
+end
+
+run App.new

data/lib/omniauth-linkedin-oauth2.rb

@@ -0,0 +1,2 @@
+require "omniauth-linkedin-oauth2/version"
+require "omniauth/strategies/linkedin_oauth2"

data/lib/omniauth-linkedin-oauth2/version.rb

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

data/lib/omniauth/strategies/linkedin_oauth2.rb

@@ -0,0 +1,68 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class LinkedInOAuth2 < OmniAuth::Strategies::OAuth2
+      # Give your strategy a name.
+      option :name, 'linkedin_oauth2'
+
+      # This is where you pass the options you would pass when
+      # initializing your consumer from the OAuth gem.
+      option :client_options, {
+        :site => 'https://www.linkedin.com',
+        :authorize_url => '/uas/oauth2/authorization?response_type=code',
+        :token_url => '/uas/oauth2/accessToken'
+      }
+
+      option :scope, 'r_basicprofile r_emailaddress'
+      option :fields, ['id', 'email-address', 'first-name', 'last-name', 'headline', 'location', 'industry', 'picture-url', 'public-profile-url']
+
+      # These are called after authentication has succeeded. If
+      # possible, you should try to set the UID without making
+      # additional calls (if the user id is returned with the token
+      # or as a URI parameter). This may not be possible with all
+      # providers.
+      uid { raw_info['id'] }
+
+      info do
+        {
+          :name => user_name,
+          :email => raw_info['emailAddress'],
+          :nickname => user_name,
+          :first_name => raw_info['firstName'],
+          :last_name => raw_info['lastName'],
+          :location => raw_info['location'],
+          :description => raw_info['headline'],
+          :image => raw_info['pictureUrl'],
+          :urls => {
+            'public_profile' => raw_info['publicProfileUrl']
+          }
+        }
+      end
+
+      extra do
+        { 'raw_info' => raw_info }
+      end
+
+      def access_token
+        ::OAuth2::AccessToken.new(client, super.token, {
+          :mode => :query,
+          :param_name => 'oauth2_access_token'
+        })
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("/v1/people/~:(#{options.fields.join(',')})?format=json").parsed
+      end
+
+      private
+
+      def user_name
+        name = "#{raw_info['firstName']} #{raw_info['lastName']}".strip
+        name.empty? ? nil : name
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'linkedin_oauth2', 'LinkedInOAuth2'

data/omniauth-linkedin-oauth2.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-linkedin-oauth2/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "omniauth-linkedin-oauth2"
+  gem.version       = OmniAuth::LinkedInOAuth2::VERSION
+  gem.authors       = ["Décio Ferreira"]
+  gem.email         = ["decio.ferreira@decioferreira.com"]
+  gem.description   = %q{A LinkedIn OAuth2 strategy for OmniAuth.}
+  gem.summary       = %q{A LinkedIn OAuth2 strategy for OmniAuth.}
+  gem.homepage      = "https://github.com/decioferreira/omniauth-linkedin-oauth2"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'omniauth', '~> 1.0'
+  gem.add_runtime_dependency 'omniauth-oauth2'
+
+  gem.add_development_dependency 'rspec', '~> 2.13.0'
+  gem.add_development_dependency 'simplecov'
+end

data/spec/omniauth/strategies/linkedin_oauth2_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+require 'omniauth-linkedin-oauth2'
+
+describe OmniAuth::Strategies::LinkedInOAuth2 do
+  subject { OmniAuth::Strategies::LinkedInOAuth2.new(nil) }
+
+  it 'should add a camelization for itself' do
+    OmniAuth::Utils.camelize('linkedin_oauth2').should == 'LinkedInOAuth2'
+  end
+
+  describe '#client' do
+    it 'has correct LinkedIn site' do
+      subject.client.site.should eq('https://www.linkedin.com')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/uas/oauth2/authorization?response_type=code')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/uas/oauth2/accessToken')
+    end
+  end
+
+  describe '#callback_path' do
+    it 'has the correct callback path' do
+      subject.callback_path.should eq('/auth/linkedin_oauth2/callback')
+    end
+  end
+
+  describe '#uid' do
+    before :each do
+      subject.stub(:raw_info) { { 'id' => 'uid' } }
+    end
+
+    it 'returns the id from raw_info' do
+      subject.uid.should eq('uid')
+    end
+  end
+
+  describe '#info' do
+    before :each do
+      subject.stub(:raw_info) { {} }
+    end
+
+    context 'and therefore has all the necessary fields' do
+      it { subject.info.should have_key :name }
+      it { subject.info.should have_key :email }
+      it { subject.info.should have_key :nickname }
+      it { subject.info.should have_key :first_name }
+      it { subject.info.should have_key :last_name }
+      it { subject.info.should have_key :location }
+      it { subject.info.should have_key :description }
+      it { subject.info.should have_key :image }
+      it { subject.info.should have_key :urls }
+    end
+  end
+
+  describe '#extra' do
+    before :each do
+      subject.stub(:raw_info) { { :foo => 'bar' } }
+    end
+
+    it { subject.extra['raw_info'].should eq({ :foo => 'bar' }) }
+  end
+
+  describe '#raw_info' do
+    before :each do
+      response = double('response', :parsed => { :foo => 'bar' })
+      subject.stub(:access_token) { double('access token', :get => response) }
+    end
+
+    it 'returns parsed response from access token' do
+      subject.raw_info.should eq({ :foo => 'bar' })
+    end
+  end
+
+  describe '#authorize_params' do
+    describe 'scope' do
+      before :each do
+        subject.stub(:session => {})
+      end
+
+      it 'sets default scope' do
+        subject.authorize_params['scope'].should eq('r_basicprofile r_emailaddress')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'simplecov'
+SimpleCov.start
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-linkedin-oauth2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Décio Ferreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-04 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: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.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'
+description: A LinkedIn OAuth2 strategy for OmniAuth.
+email:
+- decio.ferreira@decioferreira.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/Gemfile
+- example/config.ru
+- lib/omniauth-linkedin-oauth2.rb
+- lib/omniauth-linkedin-oauth2/version.rb
+- lib/omniauth/strategies/linkedin_oauth2.rb
+- omniauth-linkedin-oauth2.gemspec
+- spec/omniauth/strategies/linkedin_oauth2_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/decioferreira/omniauth-linkedin-oauth2
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A LinkedIn OAuth2 strategy for OmniAuth.
+test_files:
+- spec/omniauth/strategies/linkedin_oauth2_spec.rb
+- spec/spec_helper.rb