omnicontacts 0.3.5 → 0.3.6

data/Gemfile.lock

@@ -8,31 +8,25 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.2.5)
-    docile (1.1.5)
+    diff-lcs (1.1.3)
     json (1.8.1)
-    multi_json (1.10.1)
-    rack (1.5.2)
-    rack-test (0.6.2)
+    multi_json (1.1.0)
+    rack (1.4.1)
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rake (10.3.2)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    simplecov (0.9.1)
-      docile (~> 1.1.0)
+    rake (0.9.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.6.1)
       multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
 
 PLATFORMS
   ruby

data/README.md

@@ -8,6 +8,14 @@ OmniContacts uses the OAuth protocol to communicate with the contacts provider.
  Facebook, Gmail and Hotmail support OAuth 2.0.
 In order to use OmniContacts, it is therefore necessary to first register your application with the provider and to obtain client_id and client_secret.
 
+## Contribute!
+Me (rubytastic) and the orginal author Diego don't actively use this code at the moment, anyone interested in maintaining and contributing to this codebase please write me up in a personal message ( rubytastic )
+I try to merge pull requests in every once and a while but this code would benefit from someone actively use and contribute to it.
+
+## Gem build updates
+There is now a new gem build out which should address many issues people had when posting on the issue tracker. Please update to the latest GEM version if you have problems before posting new issues.
+
+
 ## Usage
 
 Add OmniContacts as a dependency:
@@ -25,13 +33,14 @@ require "omnicontacts"
 Rails.application.middleware.use OmniContacts::Builder do
   importer :gmail, "client_id", "client_secret", {:redirect_path => "/oauth2callback", :ssl_ca_file => "/etc/ssl/certs/curl-ca-bundle.crt"}
   importer :yahoo, "consumer_id", "consumer_secret", {:callback_path => '/callback'}
+  importer :linkedin, "consumer_id", "consumer_secret", {:redirect_path => "/oauth2callback", :state => '<long_unique_string_value>'}
   importer :hotmail, "client_id", "client_secret"
   importer :facebook, "client_id", "client_secret"
 end
 
 ```
 
-Every importer expects `client_id` and `client_secret` as mandatory, while `:redirect_path` and `:ssl_ca_file` are optional.
+Every importer expects `client_id` and `client_secret` as mandatory, while `:redirect_path` and `:ssl_ca_file` are optional (except linkedin - `state` arg  mandatory).
 Since Yahoo implements the version 1.0 of the OAuth protocol, naming is slightly different. Instead of `:redirect_path` you should use `:callback_path` as key in the hash providing the optional parameters.
 While `:ssl_ca_file` is optional, it is highly recommended to set it on production environments for obvious security reasons.
 On the other hand it makes things much easier to leave the default value for `:redirect_path` and `:callback path`, the reason of which will be clear after reading the following section.
@@ -46,6 +55,9 @@ On the other hand it makes things much easier to leave the default value for `:r
 
 * For Facebook : [Facebook Developers](https://developers.facebook.com/apps)
 
+* For Linkedin : [Linkedin Developer Network](https://www.linkedin.com/secure/developer) 
+
+
 ##### Note:
 Please go through [MSDN](http://msdn.microsoft.com/en-us/library/cc287659.aspx) if above Hotmail link will not work.
 
@@ -159,6 +171,25 @@ The following table shows which fields are supported by which provider:
 		<td>X</td>
 		<td></td>
 	</tr>
+	<tr>
+	    <td>Linkedin</td>
+		<td></td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td></td>
+		<td></td>
+		<td></td>
+		<td></td>
+		<td></td>
+		<td></td>
+		<td></td>
+		<td></td>
+		<td></td>
+		<td></td>
+	<tr>
 </table>
 
 Obviously it may happen that some fields are blank even if supported by the provider in the case that the contact did not provide any information about them.

data/lib/omnicontacts.rb

@@ -1,6 +1,6 @@
 module OmniContacts
   
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 
   MOUNT_PATH = "/contacts/"
 

data/lib/omnicontacts/http_utils.rb

@@ -57,7 +57,7 @@ module OmniContacts
     # If the result of ssl_ca_file is nil no file is used. In this case a warn message is logged.
     private
 
-    # Executes an HTTP GET request. 
+    # Executes an HTTP GET request.
     # It raises a RuntimeError if the response code is not equal to 200
     def http_get host, path, params
       connection = Net::HTTP.new(host)

data/lib/omnicontacts/importer.rb

@@ -5,6 +5,7 @@ module OmniContacts
     autoload :Yahoo, "omnicontacts/importer/yahoo"
     autoload :Hotmail, "omnicontacts/importer/hotmail"
     autoload :Facebook, "omnicontacts/importer/facebook"
+    autoload :Linkedin, "omnicontacts/importer/linkedin"
 
   end
 end

data/lib/omnicontacts/importer/gmail.rb

@@ -13,7 +13,7 @@ module OmniContacts
         @auth_host = "accounts.google.com"
         @authorize_path = "/o/oauth2/auth"
         @auth_token_path = "/o/oauth2/token"
-        @scope = "https://www.google.com/m8/feeds https://www.googleapis.com/auth/userinfo#email https://www.googleapis.com/auth/userinfo.profile"
+        @scope = (args[3] && args[3][:scope]) || "https://www.google.com/m8/feeds https://www.googleapis.com/auth/userinfo#email https://www.googleapis.com/auth/userinfo.profile"
         @contacts_host = "www.google.com"
         @contacts_path = "/m8/feeds/contacts/default/full"
         @max_results =  (args[3] && args[3][:max_results]) || 100
@@ -45,6 +45,7 @@ module OmniContacts
 
       def contacts_from_response response_as_json
         response = JSON.parse(response_as_json)
+
         return [] if response['feed'].nil? || response['feed']['entry'].nil?
         contacts = []
         return contacts if response.nil?
@@ -88,7 +89,7 @@ module OmniContacts
           # Support older versions of the gem by keeping singular entries around
           contact[:email] = contact[:emails][0][:email] if contact[:emails][0]
           contact[:first_name], contact[:last_name], contact[:name] = email_to_name(contact[:name]) if !contact[:name].nil? && contact[:name].include?('@')
-          contact[:first_name], contact[:last_name], contact[:name] = email_to_name(contact[:emails][0][:email]) if contact[:name].nil? && contact[:emails][0][:email]
+          contact[:first_name], contact[:last_name], contact[:name] = email_to_name(contact[:emails][0][:email]) if (contact[:name].nil? && contact[:emails][0] && contact[:emails][0][:email])
           #format - year-month-date
           contact[:birthday] = birthday(entry['gContact$birthday']['when'])  if entry['gContact$birthday']
 

data/lib/omnicontacts/importer/linkedin.rb

@@ -0,0 +1,63 @@
+require "omnicontacts/parse_utils"
+require "omnicontacts/middleware/oauth2"
+
+module OmniContacts
+  module Importer
+    class Linkedin < Middleware::OAuth2
+      include ParseUtils
+
+      attr_reader :auth_host, :authorize_path, :auth_token_path, :scope, :state
+
+      def initialize *args
+        super *args
+        @auth_host = "www.linkedin.com"
+        @authorize_path = "/uas/oauth2/authorization"
+        @auth_token_path = "/uas/oauth2/accessToken"
+        @scope = (args[3] && args[3][:scope]) || "r_network"
+        @contacts_host = "api.linkedin.com"
+        @contacts_path = "/v1/people/~/connections:(id,first-name,last-name,picture-url)"
+        @self_host = "www.linkedin.com"
+        @profile_path = "/oauth2/v1/userinfo"
+        @state = (args[3] && args[3][:state])
+      end
+
+      def fetch_contacts_using_access_token access_token, token_type
+        token_type = "Bearer" if token_type.nil?
+        contacts_response = https_get(@contacts_host, @contacts_path, contacts_req_params, contacts_req_headers(access_token, token_type))
+        contacts_from_response contacts_response
+      end
+
+      private
+
+      def contacts_req_params
+        {'format' => 'json'}
+      end
+
+      def contacts_req_headers token, token_type
+        {"Authorization" => "#{token_type} #{token}"}
+      end
+
+      def contacts_from_response response_as_json
+        response = JSON.parse(response_as_json)
+        return [] if response['values'].nil?
+        contacts = []
+        return contacts if response.nil?
+        response['values'].map do |entry|
+          {
+           id: entry['id'],
+            first_name: normalize_name(entry['firstName']),
+            last_name: normalize_name(entry['lastName']),
+            name: full_name(entry['firstName'],entry['lastName']),
+            profile_picture: entry['pictureUrl']
+          }
+        end
+      end
+
+      def authorize_url_params
+        # merge state param required by LinkedIn
+        _params = super
+        _params += "&" + to_query_string(state: @state)
+      end
+    end
+  end
+end

data/lib/omnicontacts/middleware/oauth2.rb

@@ -5,7 +5,7 @@ require "omnicontacts/middleware/base_oauth"
 #
 # Extending class are required to implement
 # the following methods:
-# * fetch_contacts_using_access_token -> it 
+# * fetch_contacts_using_access_token -> it
 #   fetches the list of contacts from the authorization
 #   server.
 module OmniContacts
@@ -25,7 +25,7 @@ module OmniContacts
 
       def request_authorization_from_user
         target_url = append_state_query(authorization_url)
-        [302, {"location" => target_url}, []]
+        [302, {"Content-Type" => "application/x-www-form-urlencoded", "location" => target_url}, []]
       end
 
       def redirect_uri
@@ -34,7 +34,7 @@ module OmniContacts
 
       # It extract the authorization code from the query string.
       # It uses it to obtain an access token.
-      # If the authorization code has a refresh token associated 
+      # If the authorization code has a refresh token associated
       # with it in the session, it uses the obtain an access token.
       # It fetches the list of contacts and stores the refresh token
       # associated with the access token in the session.

data/spec/omnicontacts/importer/gmail_spec.rb

@@ -5,6 +5,8 @@ describe OmniContacts::Importer::Gmail do
 
   let(:gmail) { OmniContacts::Importer::Gmail.new({}, "client_id", "client_secret") }
 
+  let(:gmail_with_scope_args) { OmniContacts::Importer::Gmail.new({}, "client_id", "client_secret", {scope: "https://www.google.com/m8/feeds https://www.googleapis.com/auth/userinfo#email https://www.googleapis.com/auth/contacts.readonly"}) }
+  
   let(:self_response) {
     '{
       "id":"16482944006464829443",
@@ -110,6 +112,7 @@ describe OmniContacts::Importer::Gmail do
 
     before(:each) do
       gmail.instance_variable_set(:@env, {})
+      gmail_with_scope_args.instance_variable_set(:@env, {})
     end
 
     it "should request the contacts by specifying version and code in the http headers" do
@@ -124,6 +127,9 @@ describe OmniContacts::Importer::Gmail do
         contacts_as_json
       end
       gmail.fetch_contacts_using_access_token token, token_type
+      
+      gmail.scope.should eq "https://www.google.com/m8/feeds https://www.googleapis.com/auth/userinfo#email https://www.googleapis.com/auth/userinfo.profile"
+      gmail_with_scope_args.scope.should eq "https://www.google.com/m8/feeds https://www.googleapis.com/auth/userinfo#email https://www.googleapis.com/auth/contacts.readonly"
     end
 
     it "should correctly parse id, name, email, gender, birthday, profile picture and relation for 1st contact" do

data/spec/omnicontacts/importer/linkedin_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+require "omnicontacts/importer/linkedin"
+
+describe OmniContacts::Importer::Linkedin do
+
+  let(:linkedin) { OmniContacts::Importer::Linkedin.new({}, "client_id", "client_secret", state: "ipsaeumeaque") }
+
+  let(:contacts_as_json) do
+    "{
+      \n  \"_total\":  2,
+      \n  \"values\":  [
+        \n    {
+          \n      \"firstName\":  \"Adolf\",
+          \n      \"id\":  \"k71S5q6MKe\",
+          \n      \"lastName\":  \"Witting\",
+          \n      \"pictureUrl\":  \"https://media.licdn.com/mpr/mprx/0_mLnj-7szw130pFRLB8Op7-p1Sxoyv53U3B47Scp1Sxoyv53U3B47Scp1Sxoyv53U3B47Sc\"\n
+        },
+        \n    {
+          \n      \"firstName\":  \"Emmet\",
+          \n      \"id\":  \"ms5r3lI3J2\",
+          \n      \"lastName\":  \"Little\",
+          \n      \"pictureUrl\":  \"https://media.licdn.com/mpr/mprx/0_iH9m158zCdISt1X6iH9m158zCdISt1X6iH9m158zCdISt1X6iH9m158zCdISt1X6iH9m158zCdISt1X6\"\n
+        }
+      ]\n
+    }"
+  end
+
+  describe "fetch_contacts_using_access_token" do
+    let(:token) { "token" }
+    let(:token_type) { nil }
+
+    before(:each) do
+      linkedin.instance_variable_set(:@env, {})
+    end
+
+    it "should request the contacts by specifying code in the http headers" do
+      linkedin.should_receive(:https_get) do |host, path, params, headers|
+        headers["Authorization"].should eq("Bearer #{token}")
+        contacts_as_json
+      end
+      linkedin.fetch_contacts_using_access_token token, token_type
+    end
+
+    it "should correctly parse id, name, and profile picture for 1st contact" do
+      linkedin.should_receive(:https_get).and_return(contacts_as_json)
+      result = linkedin.fetch_contacts_using_access_token token, token_type
+
+      result.size.should be(2)
+      result.first[:id].should eq('k71S5q6MKe')
+      result.first[:first_name].should eq('Adolf')
+      result.first[:last_name].should eq('Witting')
+      result.first[:name].should eq("Adolf Witting")
+      result.first[:profile_picture].should eq("https://media.licdn.com/mpr/mprx/0_mLnj-7szw130pFRLB8Op7-p1Sxoyv53U3B47Scp1Sxoyv53U3B47Scp1Sxoyv53U3B47Sc")
+    end
+
+    it "should correctly parse id, name, and profile picture for 2nd contact" do
+      linkedin.should_receive(:https_get).and_return(contacts_as_json)
+      result = linkedin.fetch_contacts_using_access_token token, token_type
+      result.size.should be(2)
+      result.last[:id].should eq('ms5r3lI3J2')
+      result.last[:first_name].should eq('Emmet')
+      result.last[:last_name].should eq('Little')
+      result.last[:name].should eq("Emmet Little")
+      result.last[:profile_picture].should eq("https://media.licdn.com/mpr/mprx/0_iH9m158zCdISt1X6iH9m158zCdISt1X6iH9m158zCdISt1X6iH9m158zCdISt1X6iH9m158zCdISt1X6")
+    end
+  end
+end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: omnicontacts
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
+  prerelease: 
 platform: ruby
 authors:
 - Diego Castorina
@@ -9,90 +10,102 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   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: json
   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: 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'
 - !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: 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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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 generalized Rack middleware for importing contacts from major email
@@ -118,6 +131,7 @@ files:
 - lib/omnicontacts/importer/facebook.rb
 - lib/omnicontacts/importer/gmail.rb
 - lib/omnicontacts/importer/hotmail.rb
+- lib/omnicontacts/importer/linkedin.rb
 - lib/omnicontacts/importer/yahoo.rb
 - lib/omnicontacts/integration_test.rb
 - lib/omnicontacts/middleware/base_oauth.rb
@@ -131,6 +145,7 @@ files:
 - spec/omnicontacts/importer/facebook_spec.rb
 - spec/omnicontacts/importer/gmail_spec.rb
 - spec/omnicontacts/importer/hotmail_spec.rb
+- spec/omnicontacts/importer/linkedin_spec.rb
 - spec/omnicontacts/importer/yahoo_spec.rb
 - spec/omnicontacts/integration_test_spec.rb
 - spec/omnicontacts/middleware/base_oauth_spec.rb
@@ -140,25 +155,26 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/Diego81/omnicontacts
 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'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A generalized Rack middleware for importing contacts from major email providers.
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 153f2fff78dd7440fe1c653a7458f47db2b8717a
-  data.tar.gz: f115709601214db1e8826893355146514c5c8b82
-SHA512:
-  metadata.gz: 29f390858859e150129a1a01d3fbbe6d523b997ece36e113e6c8635d5c0ecb2cc47f77e2686c07503703a4a0148dd543842cebfa5d285f0923be01e5f5d4454c
-  data.tar.gz: 7850d3c9bd1f6309f0dd1065262c6b16f7aa947ba3f33deb186ba8bff3a9809e5baeb1e588b6cc817c7b159650f3692c44c522df1d062f62a37fffbd6a97b90a