omniauth-linkedin 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5739865a590da6b43a2061707ce034055d06d79e
+  data.tar.gz: b055f89bfcada21c4b11606f82082bab14518f05
+SHA512:
+  metadata.gz: d665d65e7779fb016be9a770e7f31c121c6986d6f646dc3fafea70e113e529a59113d3d9a48a1574a79fde1feb93f34e1cb4f794287ad808e214f9ab51553479
+  data.tar.gz: f2140b74d209042b74c687f7f863ab84a9efbddcc31aa6e383430e6be5f1b6b2533afd14f3cabb17a55e5c88976216831d7f8925a4f236480f45cbd854bc1419

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format=progress
+--require spec_helper

data/.ruby-version

@@ -0,0 +1,2 @@
+2.1.2
+

data/README.md

@@ -8,14 +8,18 @@ LinkedIn uses the OAuth 1.0a flow, you can read about it here: https://developer
 
 Usage is as per any other OmniAuth 1.0 strategy. So let's say you're using Rails, you need to add the strategy to your `Gemfile` along side omniauth:
 
-    gem 'omniauth'
-    gem 'omniauth-linkedin'
+```ruby
+gem 'omniauth'
+gem 'omniauth-linkedin'
+```
 
 Once these are in, you need to add the following to your `config/initializers/omniauth.rb`:
 
-    Rails.application.config.middleware.use OmniAuth::Builder do
-      provider :linkedin, "consumer_key", "consumer_secret"
-    end
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :linkedin, "consumer_key", "consumer_secret"
+end
+```
 
 You will obviously have to put in your key and secret, which you get when you register your app with LinkedIn (they call them API Key and Secret Key).
 
@@ -27,50 +31,120 @@ LinkedIn recently (August 2012) provided the ability to request different permis
 
 By default, omniauth-linkedin requests the following permissions:
 
-    "r_basicprofile r_emailaddress"
+```ruby
+"r_basicprofile r_emailaddress"
+```
 
 This allows us to obtain enough information from LinkedIn to satisfy the requirements for the basic auth hash schema.
 
 To change the scope, simply change your initializer to something like this:
 
-    Rails.application.config.middleware.use OmniAuth::Builder do
-      provider :linkedin, "consumer_key", "consumer_secret", :scope => 'r_fullprofile r_emailaddress r_network'
-    end
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :linkedin, "consumer_key", "consumer_secret", :scope => 'r_fullprofile r_emailaddress r_network'
+end
+```
 
 One thing to note is the fact that when you ask for extra permissions, you will probably want to specify the array of fields that you want returned in the omniauth hash. If you don't then only the default fields (see below) will be returned which would defeat the purpose of asking for the extra permissions. So do the following:
 
-    Rails.application.config.middleware.use OmniAuth::Builder do
-      provider :linkedin, "consumer_key", "consumer_secret", :scope => 'r_fullprofile r_emailaddress r_network', :fields => ["id", "email-address", "first-name", "last-name", "headline", "industry", "picture-url", "public-profile-url", "location", "connections"]
-    end
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :linkedin, "consumer_key", "consumer_secret", :scope => 'r_fullprofile r_emailaddress r_network', :fields => ["id", "email-address", "first-name", "last-name", "headline", "industry", "picture-url", "public-profile-url", "location", "connections"]
+end
+```
 
 We have to repeat the list of default fields in order to get the extra 'connections' field.
 
 The list of default fields is as follows:
 
-    ["id", "email-address", "first-name", "last-name", "headline", "industry", "picture-url", "public-profile-url", "location"]
+```ruby
+["id", "email-address", "first-name", "last-name", "headline", "industry", "picture-url", "public-profile-url", "location"]
+```
 
 To see a complete list of available fields, consult the LinkedIn documentation at https://developer.linkedin.com/documents/profile-fields
 
+## Example Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  "provider"=>"linkedin",
+  "uid"=>"AbC123",
+  "info"=> {
+    "name"=>"John Doe",
+    "email"=>"john@doe.com",
+    "nickname"=>"John Doe",
+    "first_name"=>"John",
+    "last_name"=>"Doe",
+    "location"=>"Greater Boston Area, US",
+    "description"=>"Senior Developer, Hammertech",
+    "image"=> "http://m.c.lnkd.licdn.com/mpr/mprx/0_aBcD...",
+    "phone"=>"null",
+    "headline"=> "Senior Developer, Hammertech",
+    "industry"=>"Internet",
+    "urls"=>{
+      "public_profile"=>"http://www.linkedin.com/in/johndoe"
+    }
+  },
+  "credentials"=> {
+    "token"=>"12312...",
+    "secret"=>"aBc..."
+  },
+  "extra"=>
+  {
+    "access_token"=> {
+      "token"=>"12312...",
+      "secret"=>"aBc...",
+      "consumer"=>nil, #<OAuth::Consumer>
+      "params"=> {
+        :oauth_token=>"12312...",
+        :oauth_token_secret=>"aBc...",
+        :oauth_expires_in=>"5183999",
+        :oauth_authorization_expires_in=>"5183999",
+      },
+      "response"=>nil #<Net::HTTPResponse>
+    },
+   "raw_info"=> {
+     "firstName"=>"Joe",
+     "headline"=>"Senior Developer, Hammertech",
+     "id"=>"AbC123",
+     "industry"=>"Internet",
+     "lastName"=>"Doe",
+     "location"=> {"country"=>{"code"=>"us"}, "name"=>"Greater Boston Area"},
+     "pictureUrl"=> "http://m.c.lnkd.licdn.com/mpr/mprx/0_aBcD...",
+     "publicProfileUrl"=>"http://www.linkedin.com/in/johndoe"
+    }
+  }
+}
+```
+
 ## Using It With The LinkedIn Gem
 
 You may find that you want to use OmniAuth for authentication, but you want to use an API wrapper such as this one https://github.com/pengwynn/linkedin to actually make your api calls. But the LinkedIn gem provides it's own way to authenticate with LinkedIn via OAuth. In this case you can do the following.
 
 Configure the LinkedIn gem with your consumer key and secret:
 
-    LinkedIn.configure do |config|
-      config.token = "consumer_key"
-      config.secret = "consumer_secret"
-    end
+```ruby
+LinkedIn.configure do |config|
+  config.token = "consumer_key"
+  config.secret = "consumer_secret"
+end
+```
 
-Use OmniAuth as per normal to obtain an access token and an access token secret for your user. Now create the LinkedIn client and authorize it using the access token and secret that you ontained via OmniAuth:
+Use OmniAuth as per normal to obtain an access token and an access token secret for your user. Now create the LinkedIn client and authorize it using the access token and secret that you obtained via OmniAuth:
 
-    client = LinkedIn::Client.new
-    client.authorize_from_access("access_token", "access_token_secret")
+```ruby
+client = LinkedIn::Client.new
+client.authorize_from_access("access_token", "access_token_secret")
+```
 
 You can now make API calls as per normal e.g.:
 
-    client.profile
-    client.add_share({:comment => "blah"})
+```ruby
+client.profile
+client.add_share({:comment => "blah"})
+```
 
 ## Note on Patches/Pull Requests
 

data/lib/omniauth-linkedin.rb

@@ -2,7 +2,7 @@ require "omniauth-linkedin/version"
 require 'omniauth/strategies/linkedin'
 
 
-module Omniauth
+module OmniAuth
   module Linkedin
     # Your code goes here...
   end

data/lib/omniauth-linkedin/version.rb

@@ -1,5 +1,5 @@
-module Omniauth
+module OmniAuth
   module Linkedin
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/omniauth/strategies/linkedin.rb

@@ -44,7 +44,9 @@ module OmniAuth
       end
 
       def raw_info
-        @raw_info ||= MultiJson.decode(access_token.get("/v1/people/~:(#{options.fields.join(',')})?format=json").body)
+        fields = options.fields
+        fields.map! { |f| f == "picture-url" ? "picture-url;secure=true" : f } if options[:secure_image_url]
+        @raw_info ||= MultiJson.decode(access_token.get("/v1/people/~:(#{fields.join(',')})?format=json").body)
       end
 
       def request_phase

data/omniauth-linkedin.gemspec

@@ -4,7 +4,7 @@ require "omniauth-linkedin/version"
 
 Gem::Specification.new do |s|
   s.name        = "omniauth-linkedin"
-  s.version     = Omniauth::Linkedin::VERSION
+  s.version     = OmniAuth::Linkedin::VERSION
   s.authors     = ["Alan Skorkin"]
   s.email       = ["alan@skorks.com"]
   s.homepage    = "https://github.com/skorks/omniauth-linkedin"
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'omniauth-oauth', '~> 1.0'
 
-  s.add_development_dependency 'rspec', '~> 2.7'
+  s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'webmock'
   s.add_development_dependency 'rack-test'

data/spec/omniauth/strategies/linkedin_spec.rb

@@ -1,59 +1,57 @@
-require 'spec_helper'
-
-describe "OmniAuth::Strategies::LinkedIn" do
-  subject do
+RSpec.describe OmniAuth::Strategies::LinkedIn do
+  subject(:linkedin) do
     OmniAuth::Strategies::LinkedIn.new(nil, @options || {})
   end
 
-  it 'should add a camelization for itself' do
-    OmniAuth::Utils.camelize('linkedin').should == 'LinkedIn'
+  it 'adds a camelization for itself' do
+    expect(OmniAuth::Utils.camelize('linkedin')).to eq 'LinkedIn'
   end
 
   context 'client options' do
     it 'has correct LinkedIn site' do
-      subject.options.client_options.site.should eq('https://api.linkedin.com')
+      expect(linkedin.options.client_options.site).to eq 'https://api.linkedin.com'
     end
 
     it 'has correct request token path' do
-      subject.options.client_options.request_token_path.should eq('/uas/oauth/requestToken')
+      expect(linkedin.options.client_options.request_token_path).to eq '/uas/oauth/requestToken'
     end
 
     it 'has correct access token path' do
-      subject.options.client_options.access_token_path.should eq('/uas/oauth/accessToken')
+      expect(linkedin.options.client_options.access_token_path).to eq '/uas/oauth/accessToken'
     end
 
     it 'has correct authorize url' do
-      subject.options.client_options.authorize_url.should eq('https://www.linkedin.com/uas/oauth/authenticate')
+      expect(linkedin.options.client_options.authorize_url).to eq 'https://www.linkedin.com/uas/oauth/authenticate'
     end
   end
 
   context '#uid' do
-    before :each do
-      subject.stub(:raw_info) { { 'id' => '123' } }
+    before do
+      allow(linkedin).to receive(:raw_info).and_return('id' => '123')
     end
 
     it 'returns the id from raw_info' do
-      subject.uid.should eq('123')
+      expect(linkedin.uid).to eq '123'
     end
   end
 
   context 'returns info hash conformant with omniauth auth hash schema' do
-    before :each do
-      subject.stub(:raw_info) { {} }
+    before do
+      allow(linkedin).to receive(:raw_info).and_return({})
     end
 
     context 'and therefore has all the necessary fields' do
-      it {subject.info.should have_key :name}
-      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 :phone}
-      it {subject.info.should have_key :urls}
+      it {expect(linkedin.info).to have_key :name}
+      it {expect(linkedin.info).to have_key :name}
+      it {expect(linkedin.info).to have_key :email}
+      it {expect(linkedin.info).to have_key :nickname}
+      it {expect(linkedin.info).to have_key :first_name}
+      it {expect(linkedin.info).to have_key :last_name}
+      it {expect(linkedin.info).to have_key :location}
+      it {expect(linkedin.info).to have_key :description}
+      it {expect(linkedin.info).to have_key :image}
+      it {expect(linkedin.info).to have_key :phone}
+      it {expect(linkedin.info).to have_key :urls}
     end
   end
 end

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-linkedin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Alan Skorkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2014-06-16 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'
   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: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !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'
 description: LinkedIn strategy for OmniAuth.
@@ -98,9 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rvmrc
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
 - Gemfile
 - Guardfile
 - README.md
@@ -116,32 +105,27 @@ files:
 - todo.txt
 homepage: https://github.com/skorks/omniauth-linkedin
 licenses: []
+metadata: {}
 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: 2699125881048178184
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2699125881048178184
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: LinkedIn strategy for OmniAuth.
-test_files: []
+test_files:
+- spec/omniauth/strategies/linkedin_spec.rb
+- spec/spec_helper.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm --create 1.9.3@omniauth-linkedin