omniauth-linkedin-oauth2 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e198fe921bc4621e180fbfb542da271a2bbe71f7
-  data.tar.gz: 408178ddfe9aed178033cdd992e43a5c589b714e
+  metadata.gz: 2d2c0f9146e300a9cc647e53a54c75abfdde6988
+  data.tar.gz: c7e26797d512f938cd83bd0279e0a710ecbe74eb
 SHA512:
-  metadata.gz: 9fab83d99157fa89a19446ae5d6bc71f8d1097cbd26fea850b8da293b3f9a2c389cfaa06870fb503f0724ba5fade7634586e9d606d062a9738edcdacd35ecb76
-  data.tar.gz: 7ccf2cc673c91ca9eb94db651114d7cf991f169ca5373ca442e7e8e4e966edb22634c40cabc61c41c56b22bac64961b5573cc350567ca765da300d8c5b5d66d3
+  metadata.gz: 081ac395e1819ff2c52948e4a89b9648894e3087a9c8e153c0c228d32715e16fd6adb2f329326bdf4d471a1b2f6db941e7af425edcbf6f638baf76a899b9d091
+  data.tar.gz: 013abfd2808b0fd5c43fa5a1ef44b07da0b915773ca52d4f8470dab27dee4f3ad83050ca63e431f23fa0de88dc212b401b4e70237ff9d9151588df8ac59ca9ee

data/README.md

@@ -20,6 +20,12 @@ Or install it yourself as:
 
     $ gem install omniauth-linkedin-oauth2
 
+## Upgrading
+
+Previous versions of this gem used the provider name `:linkedin_oauth2`. In order to provide a cleaner upgrade path for users who were previously using the OAuth 1.0 omniauth adapter for LinkedIn [https://github.com/skorks/omniauth-linkedin], this has been renamed to just `:linkedin`.
+
+Users who are upgrading from previous versions of this gem may need to update their Omniauth and/or Devise configurations to use the shorter provider name.
+
 ## Usage
 
 Register your application with LinkedIn to receive an API key: https://www.linkedin.com/secure/developer
@@ -28,11 +34,11 @@ This is an example that you might put into a Rails initializer at `config/initia
 
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :linkedin_oauth2, ENV['LINKEDIN_KEY'], ENV['LINKEDIN_SECRET']
+  provider :linkedin, ENV['LINKEDIN_KEY'], ENV['LINKEDIN_SECRET']
 end
 ```
 
-You can now access the OmniAuth LinkedIn OAuth2 URL: `/auth/linkedin_oauth2`.
+You can now access the OmniAuth LinkedIn OAuth2 URL: `/auth/linkedin`.
 
 ## Granting Member Permissions to Your Application
 
@@ -46,7 +52,7 @@ By default, omniauth-linkedin-oauth2 requests the following permissions:
 You can configure the scope option:
 
 ```ruby
-provider :linkedin_oauth2, ENV['LINKEDIN_KEY'], ENV['LINKEDIN_SECRET'], :scope => 'r_fullprofile r_emailaddress r_network'
+provider :linkedin, ENV['LINKEDIN_KEY'], ENV['LINKEDIN_SECRET'], :scope => 'r_fullprofile r_emailaddress r_network'
 ```
 
 ## Profile Fields
@@ -60,7 +66,7 @@ When specifying which permissions you want to users to grant to your application
 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']
+provider :linkedin, 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

data/lib/omniauth-linkedin-oauth2.rb

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

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

@@ -1,5 +1,5 @@
 module OmniAuth
   module LinkedInOAuth2
-    VERSION = "0.0.3"
+    VERSION = "0.1.0"
   end
 end

data/lib/omniauth/strategies/{linkedin_oauth2.rb → linkedin.rb}

@@ -2,9 +2,9 @@ require 'omniauth-oauth2'
 
 module OmniAuth
   module Strategies
-    class LinkedInOAuth2 < OmniAuth::Strategies::OAuth2
+    class LinkedIn < OmniAuth::Strategies::OAuth2
       # Give your strategy a name.
-      option :name, 'linkedin_oauth2'
+      option :name, 'linkedin'
 
       # This is where you pass the options you would pass when
       # initializing your consumer from the OAuth gem.
@@ -67,4 +67,4 @@ module OmniAuth
   end
 end
 
-OmniAuth.config.add_camelization 'linkedin_oauth2', 'LinkedInOAuth2'
+OmniAuth.config.add_camelization 'linkedin', 'LinkedIn'

data/spec/omniauth/strategies/linkedin_oauth2_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 require 'omniauth-linkedin-oauth2'
 
-describe OmniAuth::Strategies::LinkedInOAuth2 do
-  subject { OmniAuth::Strategies::LinkedInOAuth2.new(nil) }
+describe OmniAuth::Strategies::LinkedIn do
+  subject { OmniAuth::Strategies::LinkedIn.new(nil) }
 
   it 'should add a camelization for itself' do
-    OmniAuth::Utils.camelize('linkedin_oauth2').should == 'LinkedInOAuth2'
+    OmniAuth::Utils.camelize('linkedin').should == 'LinkedIn'
   end
 
   describe '#client' do
@@ -24,7 +24,7 @@ describe OmniAuth::Strategies::LinkedInOAuth2 do
 
   describe '#callback_path' do
     it 'has the correct callback path' do
-      subject.callback_path.should eq('/auth/linkedin_oauth2/callback')
+      subject.callback_path.should eq('/auth/linkedin/callback')
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-linkedin-oauth2
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Décio Ferreira
@@ -112,7 +112,7 @@ files:
 - example/config.ru
 - lib/omniauth-linkedin-oauth2.rb
 - lib/omniauth-linkedin-oauth2/version.rb
-- lib/omniauth/strategies/linkedin_oauth2.rb
+- lib/omniauth/strategies/linkedin.rb
 - omniauth-linkedin-oauth2.gemspec
 - spec/omniauth/strategies/linkedin_oauth2_spec.rb
 - spec/spec_helper.rb