omnigroupcontacts 0.3.10 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bad16dc3dfef3e116e85938481d5a92686565d70
-  data.tar.gz: bbb37f94d90262360403edd694b1f9d648257eef
+  metadata.gz: 387500fc78883a2288cdf6b47f55178ffe173d3e
+  data.tar.gz: 6a755ae4559c0a760eb5b36b1fff75cf88c64e15
 SHA512:
-  metadata.gz: 3af199c3e27f360687a7eff63259b28979459d3745a15fa1c663e1a053eb1ded65c65dbb0a05d4af4bd166d7b89325eed41eb95640a028e639f0728ffd17bb60
-  data.tar.gz: 5b1f3edd5d3a9da077f44ae22be491b12f512355f91ab6016f69d66432905ebb268a7376503daa15bbe02b3701e94c10df0a0eacb60066cf130a1147a227fee9
+  metadata.gz: 043996490bf66a9c8dc5ce97a3c7e1c7e8e2fbb9ff08c253c7ca8fee83dfe7401ec31eecb9a4659118a12e78305b7b12ba1b6dd7ef4452f5777d818c5d694422
+  data.tar.gz: 7bb04a34aacc2d8ab1332f5881f67fab2d0cde42dd9397c6ec52fa8239f92ff2d09ae58211f10b3cf220230a53665fe67117f8221f0a2cbcc3835b5ee145d7d5

data/.gitignore

@@ -0,0 +1,6 @@
+coverage
+*.iml
+.idea
+.rvmrc
+.DS_Store
+nbproject

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    omnigroupcontacts (0.3.5)
+      json
+      rack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    json (1.8.1)
+    multi_json (1.1.0)
+    rack (1.4.1)
+    rack-test (0.6.1)
+      rack (>= 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.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omnigroupcontacts!
+  rack-test
+  rake
+  rspec
+  simplecov

data/README.md

@@ -0,0 +1,132 @@
+# omnigroupcontacts
+
+Inspired by the popular OmniContacts, OmniGroupContacts is a library that enables users of an application to import contacts
+from their email accounts with respect to group. The email providers currently supported are Gmail.
+OmniGroupContacts is a Rack middleware, therefore you can use it with Rails, Sinatra and any other Rack-based framework.
+
+OmniGroupContacts uses the OAuth protocol to communicate with the contacts provider.
+In order to use OmniGroupContacts, it is therefore necessary to first register your application with the provider and to obtain client_id and client_secret.
+
+## Usage
+
+Add OmniGroupContacts as a dependency:
+
+```ruby
+gem "omnigroupcontacts"
+
+```
+
+As for OmniAuth, there is a Builder facilitating the usage of multiple contacts importers. In the case of a Rails application, the following code could be placed at `config/initializers/omnigroupcontacts.rb`:
+
+```ruby
+require "omnigroupcontacts"
+
+Rails.application.middleware.use OmniGroupContacts::Builder do
+  importer :gmailgroup, "client_id", "client_secret", {:redirect_path => "/oauth2callback", :ssl_ca_file => "/etc/ssl/certs/curl-ca-bundle.crt"}
+  
+end
+
+```
+
+## Register your application
+
+* For Gmail : [Google API Console](https://code.google.com/apis/console/)
+
+
+## Integrating with your Application
+
+To use the Gem you first need to redirect your users to `/group_contacts/:importer`, where `:importer` can be gmailgroup.
+No changes to `config/routes.rb` are needed for this step since omnigroupcontacts will be listening on that path and redirect the user to the email provider's website in order to authorize your app to access his contact list.
+Once that is done the user will be redirected back to your application, to the path specified in `:redirect_path`.
+If nothing is specified the default value is `/group_contacts/:importer/callback` (e.g. `/group_contacts/gmailgroup/callback`). This makes things simpler and you can just add the following line to `config/routes.rb`:
+
+```ruby
+  match "/group_contacts/:importer/callback" => "your_controller#callback"
+```
+
+The list of contacts can be accessed via the `omnigroupcontacts.contacts` key in the environment hash and it consists of a simple array of hashes.
+The following table shows which fields are supported by which provider:
+
+<table>
+	<tr>
+		<th>Provider</th>
+		<th>:email</th>
+		<th>:id</th>
+		<th>:profile_picture</th>
+		<th>:name</th>
+		<th>:first_name</th>
+		<th>:last_name</th>
+		<th>:address_1</th>
+		<th>:address_2</th>
+		<th>:city</th>
+		<th>:region</th>
+		<th>:postcode</th>
+		<th>:country</th>
+		<th>:phone_number</th>
+		<th>:birthday</th>
+		<th>:gender</th>
+		<th>:relation</th>
+	</tr>
+	<tr>
+		<td>Gmail</td>
+		<td>X</td>
+		<td>X</td>
+		<td></td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</td>
+		<td>X</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.
+
+The information for the logged in user can also be accessed via 'omnigroupcontacts.user' key in the environment hash. It consists of a simple hash which includes the same fields as above.
+
+The following snippet shows how to simply print name and email of each contact, and also the the name of logged in user:
+```ruby
+def contacts_callback
+  @contacts = request.env['omnigroupcontacts.contacts']
+  @user = request.env['omnigroupcontacts.user']
+  puts "List of contacts of #{@user[:name]} obtained from #{params[:importer]}:"
+  @contacts.each do |group_name, contacts|
+  	puts "Group: #{contacts}"
+  	contacts.each do |contact|
+    	puts "Contact found: name => #{contact[:name]}, email => #{contact[:email]}"
+    end
+  end
+end
+```
+
+If the user does not authorize your application to access his/her contacts list, or any other inconvenience occurs, he/she is redirected to `/contacts/failure`. The query string will contain a parameter named `error_message` which specifies why the list of contacts could not be retrieved. `error_message` can have one of the following values: `not_authorized`, `timeout` and `internal_error`.
+
+## License
+
+Copyright (c) 2015 Mitesh Jain
+
+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/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+task :test => :spec

data/lib/omnigroupcontacts.rb

@@ -0,0 +1,19 @@
+module OmniGroupContacts
+  
+  VERSION = "0.3.11"
+
+  MOUNT_PATH = "/group_contacts/"
+
+  autoload :Builder, "omnigroupcontacts/builder"
+  autoload :Importer, "omnigroupcontacts/importer"
+  autoload :IntegrationTest, "omnigroupcontacts/integration_test"
+
+  class AuthorizationError < RuntimeError
+  end
+
+
+  def self.integration_test
+    IntegrationTest.instance
+  end
+  
+end

data/lib/omnigroupcontacts/authorization/oauth1.rb

@@ -0,0 +1,122 @@
+require "omnigroupcontacts/http_utils"
+require "base64"
+
+# This module represent a OAuth 1.0 Client.
+#
+# Classes including the module must implement
+# the following methods:
+# * auth_host ->  the host of the authorization server
+# * auth_token_path -> the path to query to obtain a request token
+# * consumer_key -> the registered consumer key of the client
+# * consumer_secret -> the registered consumer secret of the client
+# * callback -> the callback to include during the redirection step
+# * auth_path -> the path on the authorization server to redirect the user to
+# * access_token_path -> the path to query in order to obtain the access token
+module OmniGroupContacts
+  module Authorization
+    module OAuth1
+      include HTTPUtils
+
+      OAUTH_VERSION = "1.0"
+
+      # Obtain an authorization token from the server.
+      # The token is returned in an array along with the relative authorization token secret.
+      def fetch_authorization_token
+        request_token_response = https_post(auth_host, auth_token_path, request_token_req_params)
+        values_from_query_string(request_token_response, ["oauth_token", "oauth_token_secret"])
+      end
+
+      private
+
+      def request_token_req_params
+        {
+          :oauth_consumer_key => consumer_key,
+          :oauth_nonce => encode(random_string),
+          :oauth_signature_method => "PLAINTEXT",
+          :oauth_signature => encode(consumer_secret + "&"),
+          :oauth_timestamp => timestamp,
+          :oauth_version => OAUTH_VERSION,
+          :oauth_callback => callback
+        }
+      end
+
+      def random_string
+        (0...50).map { ('a'..'z').to_a[rand(26)] }.join
+      end
+
+      def timestamp
+        Time.now.to_i.to_s
+      end
+
+      def values_from_query_string query_string, keys_to_extract
+        map = query_string_to_map(query_string)
+        keys_to_extract.collect do |key|
+          if map.has_key?(key)
+            map[key]
+          else
+            raise "No value found for #{key} in #{query_string}"
+          end
+        end
+      end
+
+      public
+
+      # Returns the url the user has to be redirected to do in order grant permission to the client application.
+      def authorization_url auth_token
+        "https://" + auth_host + auth_path + "?oauth_token=" + auth_token
+      end
+
+      # Fetches the access token from the authorization server.
+      # The method expects the authorization token, the authorization token secret and the authorization verifier.
+      # The result comprises the access token, the access token secret and a list of additional fields extracted from the server's response.
+      # The list of additional fields to extract is specified as last parameter
+      def fetch_access_token auth_token, auth_token_secret, auth_verifier, additional_fields_to_extract = []
+        access_token_resp = https_post(auth_host, access_token_path, access_token_req_params(auth_token, auth_token_secret, auth_verifier))
+        values_from_query_string(access_token_resp, (["oauth_token", "oauth_token_secret"] + additional_fields_to_extract))
+      end
+
+      private
+
+      def access_token_req_params auth_token, auth_token_secret, auth_verifier
+        {
+          :oauth_consumer_key => consumer_key,
+          :oauth_nonce => encode(random_string),
+          :oauth_signature_method => "PLAINTEXT",
+          :oauth_signature => encode(consumer_secret + "&" + auth_token_secret),
+          :oauth_version => OAUTH_VERSION,
+          :oauth_timestamp => timestamp,
+          :oauth_token => auth_token,
+          :oauth_verifier => auth_verifier
+        }
+      end
+
+      public
+
+      # Calculates a signature using HMAC-SHA1 according to the OAuth 1.0 specifications.
+      # 
+      # The base string is given is a RFC 3986 encoded concatenation of:
+      # * Uppercase HTTP method
+      # * An '&'
+      # * A url without any parameters
+      # * An '&'
+      # * All parameters to use in the request encoded themselves and sorted by key.
+      #
+      # The signature key is given by the concatenation of:
+      # * RFC 3986 encoded consumer secret
+      # * An  '&'
+      # * RFC 3986 encoded token secret
+      def oauth_signature method, url, params, secret
+        encoded_method = encode(method.upcase)
+        encoded_url = encode(url)
+        # params must be in alphabetical order
+        encoded_params = encode(to_query_string(params.sort { |x, y| x.to_s <=> y.to_s }))
+        base_string = encoded_method + '&' + encoded_url + '&' + encoded_params
+        key = encode(consumer_secret) + '&' + secret
+        hmac_sha1 = OpenSSL::HMAC.digest('sha1', key, base_string)
+        # base64 encode results must be stripped
+        encode(Base64.encode64(hmac_sha1).strip)
+      end
+
+    end
+  end
+end

data/lib/omnigroupcontacts/authorization/oauth2.rb

@@ -0,0 +1,87 @@
+require "omnigroupcontacts/http_utils"
+require "json"
+
+# This module represents an OAuth 2.0 client.
+#
+# Classes including the module must implement
+# the following methods:
+# * auth_host -> the host of the authorization server
+# * authorize_path -> the path on the authorization server the redirect the use to
+# * client_id -> the registered client id of the client
+# * client_secret -> the registered client secret of the client
+# * redirect_path -> the path the authorization server has to redirect the user back after authorization
+# * auth_token_path -> the path to query once the user has granted permission to the application
+# * scope -> the scope necessary to acquire the contacts list.
+module OmniGroupContacts
+  module Authorization
+    module OAuth2
+      include HTTPUtils
+
+      # Calculates the URL the user has to be redirected to in order to authorize
+      # the application to access his contacts list.
+      def authorization_url
+        "https://" + auth_host + authorize_path + "?" + authorize_url_params
+      end
+
+      private
+
+      def authorize_url_params
+        to_query_string({
+            :client_id => client_id,
+            :scope => encode(scope),
+            :response_type => "code",
+            :access_type => "online",
+            :approval_prompt => "auto",
+            :redirect_uri => encode(redirect_uri)
+          })
+      end
+
+      public
+
+      # Fetches the access token from the authorization server using the given authorization code.
+      def fetch_access_token code
+        access_token_from_response https_post(auth_host, auth_token_path, token_req_params(code))
+      end
+
+      private
+
+      def token_req_params code
+        {
+          :client_id => client_id,
+          :client_secret => client_secret,
+          :code => code,
+          :redirect_uri => encode(redirect_uri),
+          :grant_type => "authorization_code"
+        }
+      end
+
+      def access_token_from_response response
+        if auth_host == "graph.facebook.com"
+          response = query_string_to_map(response).to_json
+        end
+        json = JSON.parse(response)
+        raise json["error"] if json["error"]
+        [json["access_token"], json["token_type"], json["refresh_token"]]
+      end
+
+      public
+
+      # Refreshes the access token using the provided refresh_token.
+      def refresh_access_token refresh_token
+        access_token_from_response https_post(auth_host, auth_token_path, refresh_token_req_params(refresh_token))
+      end
+
+      private
+
+      def refresh_token_req_params refresh_token
+        {
+          :client_id => client_id,
+          :client_secret => client_secret,
+          :refresh_token => refresh_token,
+          :grant_type => "refresh_token"
+        }
+
+      end
+    end
+  end
+end

data/lib/omnigroupcontacts/builder.rb

@@ -0,0 +1,30 @@
+require "omnigroupcontacts"
+
+module OmniGroupContacts
+  class Builder < Rack::Builder
+    def initialize(app, &block)
+      if rack14?
+        super
+      else
+        @app = app
+        super(&block)
+      end
+    end
+
+    def rack14?
+      Rack.release.split('.')[1].to_i >= 4
+    end
+
+    def importer importer, *args
+      middleware = OmniGroupContacts::Importer.const_get(importer.to_s.capitalize)
+      use middleware, *args
+    rescue NameError
+      raise LoadError, "Could not find importer #{importer}."
+    end
+
+    def call env
+      @ins << @app unless rack14? || @ins.include?(@app)
+      to_app.call(env)
+    end
+  end
+end