omnicontacts 0.1.7 → 0.2.0

data/.gitignore

@@ -2,3 +2,4 @@ coverage
 *.iml
 .idea
 .DS_Store
+nbproject

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    omnicontacts (0.1.7)
+    omnicontacts (0.2.0)
       json
       rack
 

data/README.md

@@ -36,8 +36,16 @@ On the other hand it makes things much easier to leave the default value for `:r
 
 ## Integrating with your Application
 
-To use OmniContacts you only need to redirect users to `/contacts/:importer`, where `:importer` can be google, yahoo or hotmail. Once the user has authorized your application, he will be redirected back to your website, to the path specified in `:redirect_path` (or `:callback_path` for yahoo). The user is redirected to `/contacts/:importer/callback` by default, which therefore makes things much simpler to not specify any value for `:redirect_path` or `:callback_path`.
-The list of contacts can be accessed via the `omnicontacts.contacts` key in the environment hash. The list of contacts is a simple array of hashes. Each hash has two keys: `:email` and `:name`, containing the email and the name of the contact respectively.
+To use the Gem you first need to redirect your users to `/contacts/:importer`, where `:importer` can be google, yahoo or hotmail. 
+No changes to `config/routes.rb` are needed for this step since OmniContacts 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` (or `:callback_path` for yahoo).
+If nothing is specified the default value is `/contacts/:importer/callback` (e.g. `/contacts/yahoo/callback`). This makes things simpler and you can just add the following line to `config/routes.rb`:
+
+```ruby
+  match "/contacts/:importer/callback" => "your_controller#callback"
+```
+
+The list of contacts can be accessed via the `omnicontacts.contacts` key in the environment hash. It is a simple array of hashes. Each hash has two keys: `:email` and `:name`, containing the email and the name of the contact respectively.
 
 ```ruby
 def contacts_callback

data/Rakefile

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

data/lib/omnicontacts.rb

@@ -1,11 +1,16 @@
 module OmniContacts
-
-  VERSION = "0.1.7"
+  
+  VERSION = "0.2.0"
 
   autoload :Builder, "omnicontacts/builder"
   autoload :Importer, "omnicontacts/importer"
+  autoload :IntegrationTest, "omnicontacts/integration_test"
 
   class AuthorizationError < RuntimeError
   end
-
-end
+  
+  def self.integration_test
+    IntegrationTest.instance
+  end
+  
+end

data/lib/omnicontacts/authorization/oauth2.rb

@@ -27,13 +27,13 @@ module OmniContacts
 
       def authorize_url_params
         to_query_string({
-                          :client_id => client_id,
-                          :scope => encode(scope),
-                          :response_type => "code",
-                          :access_type => "offline",
-                          :approval_prompt => "force",
-                          :redirect_uri => encode(redirect_uri)
-                        })
+            :client_id => client_id,
+            :scope => encode(scope),
+            :response_type => "code",
+            :access_type => "offline",
+            :approval_prompt => "force",
+            :redirect_uri => encode(redirect_uri)
+          })
       end
 
       public

data/lib/omnicontacts/http_utils.rb

@@ -36,7 +36,7 @@ module OmniContacts
     def host_url_from_rack_env env
       port = ((env["SERVER_PORT"] == 80) && "") || ":#{env['SERVER_PORT']}"
       host = (env["HTTP_HOST"]) || (env["SERVER_NAME"] + port)
-      scheme(env) + "://" + host
+      "#{scheme(env)}://#{host}"
     end
 
     def scheme env
@@ -45,7 +45,7 @@ module OmniContacts
       elsif env['HTTP_X_FORWARDED_SSL'] == 'on'
         'https'
       elsif env['HTTP_X_FORWARDED_PROTO']
-        env['HTTP_X_FORWARDED_PROTO'].split(',')[0]
+        env['HTTP_X_FORWARDED_PROTO'].split(',').first
       else
         env["rack.url_scheme"]
       end

data/lib/omnicontacts/integration_test.rb

@@ -0,0 +1,36 @@
+require 'singleton'
+
+class IntegrationTest
+  include Singleton
+  
+  attr_accessor :enabled
+  
+  def initialize
+    enabled = false
+    clear_mocks
+  end
+  
+  def clear_mocks
+    @mock = {}
+  end
+  
+  def mock provider, mock
+    @mock[provider.to_sym] = mock
+  end
+  
+  def mock_authorization_from_user provider
+    [302, {"location" => provider.redirect_path}, []]
+  end
+  
+  def mock_fetch_contacts provider
+    result = @mock[provider.class_name.to_sym] || []
+    if result.is_a? Array
+      result
+    elsif result.is_a? Hash
+      [result]
+    else
+      raise result.to_s
+    end
+  end
+  
+end

data/lib/omnicontacts/middleware/base_oauth.rb

@@ -17,16 +17,12 @@ module OmniContacts
         @ssl_ca_file = options[:ssl_ca_file]
       end
 
-      private
-
       def class_name
         self.class.name.split('::').last.downcase
       end
 
-      public
-
       # Rack callback. It handles three cases:
-      # * user visit middleware entru point. 
+      # * user visit middleware entry point. 
       #   In this case request_authorization_from_user is called
       # * user is redirected back to the application 
       #   from the authorization site. In this case the list
@@ -47,16 +43,28 @@ module OmniContacts
       end
 
       private
+      
+      def test_mode?
+        IntegrationTest.instance.enabled
+      end
 
       def handle_initial_request
         execute_and_rescue_exceptions do
-          request_authorization_from_user
+          if test_mode?
+            IntegrationTest.instance.mock_authorization_from_user(self)
+          else
+            request_authorization_from_user
+          end
         end
       end
 
       def handle_callback
         execute_and_rescue_exceptions do
-          @env["omnicontacts.contacts"] = fetch_contacts
+          @env["omnicontacts.contacts"] = if test_mode?
+            IntegrationTest.instance.mock_fetch_contacts(self)
+          else
+            fetch_contacts
+          end
           @app.call(@env)
         end
       end

data/lib/omnicontacts/middleware/oauth1.rb

@@ -18,7 +18,7 @@ module OmniContacts
         super app, options
         @consumer_key = consumer_key
         @consumer_secret = consumer_secret
-        @callback_path = options[:callback_path] ||= "/contacts/#{class_name}/callback"
+        @callback_path = options[:callback_path] || "/contacts/#{class_name}/callback"
         @token_prop_name = "#{base_prop_name}.oauth_token"
       end
 

data/lib/omnicontacts/middleware/oauth2.rb

@@ -19,7 +19,7 @@ module OmniContacts
         super app, options
         @client_id = client_id
         @client_secret = client_secret
-        @redirect_path = options[:redirect_path] ||= "/contacts/#{class_name}/callback"
+        @redirect_path = options[:redirect_path] || "/contacts/#{class_name}/callback"
         @ssl_ca_file = options[:ssl_ca_file]
       end
 

data/spec/omnicontacts/integration_test_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+require "omnicontacts/integration_test"
+
+describe IntegrationTest do
+
+  context "mock_initial_request" do
+    it "should redirect to the provider's redirect_path" do
+      provider = mock
+      redirect_path = "/redirect_path"
+      provider.stub(:redirect_path => redirect_path)
+      IntegrationTest.instance.mock_authorization_from_user(provider)[1]["location"].should eq(redirect_path)
+    end
+  end
+  
+  context "mock_callback" do
+
+    before(:each) {
+      @env = {}
+      @provider = self.mock
+      @provider.stub(:class_name => "test")
+      IntegrationTest.instance.clear_mocks
+    }
+    
+    it "should return an empty contacts list" do
+      IntegrationTest.instance.mock_fetch_contacts(@provider).should be_empty
+    end
+    
+    it "should return a configured list of contacts " do
+      contacts = [:name => 'John Doe', :email => 'john@doe.com']
+      IntegrationTest.instance.mock('test', contacts)
+      result = IntegrationTest.instance.mock_fetch_contacts(@provider)
+      result.size.should be(1)
+      result.first[:email].should eq(contacts.first[:email])
+      result.first[:name].should eq(contacts.first[:name])
+    end
+
+    it "should return a single element list of contacts " do
+      contact = {:name => 'John Doe', :email => 'john@doe.com'}
+      IntegrationTest.instance.mock('test', contact)
+      result = IntegrationTest.instance.mock_fetch_contacts(@provider)
+      result.size.should be(1)
+      result.first[:email].should eq(contact[:email])
+      result.first[:name].should eq(contact[:name])
+    end
+    
+    it "should throw an exception" do
+      IntegrationTest.instance.mock('test', :some_error)
+      expect {IntegrationTest.instance.mock_fetch_contacts(@provider)}.should raise_error
+    end
+  end
+end

data/spec/omnicontacts/middleware/base_oauth_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+require "omnicontacts/middleware/base_oauth"
+
+describe OmniContacts::Middleware::BaseOAuth do
+  
+  before(:all) do 
+    class TestProvider < OmniContacts::Middleware::BaseOAuth
+      def initialize app, consumer_key, consumer_secret, options = {}
+        super app, options
+      end
+      
+      def redirect_path
+        "/contacts/testprovider/callback"
+      end
+    end
+    OmniContacts.integration_test.enabled = true
+  end
+
+  let(:app) {
+    Rack::Builder.new do |b|
+      b.use TestProvider, "consumer_id", "consumer_secret"
+      b.run lambda { |env| [200, {"Content-Type" => "text/html"}, ["Hello World"]] }
+    end.to_app
+  }
+  
+  it "should return a preconfigured list of contacts" do
+    OmniContacts.integration_test.mock(:testprovider, :email => "user@example.com")
+    get "/contacts/testprovider"    
+    get "/contacts/testprovider/callback"    
+    last_request.env["omnicontacts.contacts"].first[:email].should eq("user@example.com")
+  end
+
+  it "should redurect to failure url" do
+    OmniContacts.integration_test.mock(:testprovider, "some_error" )
+    get "/contacts/testprovider"
+    get "/contacts/testprovider/callback"
+    last_response.should be_redirect
+    last_response.headers["location"].should eq("/contacts/failure?error_message=internal_error")
+  end
+  
+  after(:all) do 
+    OmniContacts.integration_test.enabled = false
+    OmniContacts.integration_test.clear_mocks
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omnicontacts
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-07 00:00:00.000000000 Z
+date: 2012-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -129,6 +129,7 @@ files:
 - lib/omnicontacts/importer/gmail.rb
 - lib/omnicontacts/importer/hotmail.rb
 - lib/omnicontacts/importer/yahoo.rb
+- lib/omnicontacts/integration_test.rb
 - lib/omnicontacts/middleware/base_oauth.rb
 - lib/omnicontacts/middleware/oauth1.rb
 - lib/omnicontacts/middleware/oauth2.rb
@@ -139,6 +140,8 @@ files:
 - spec/omnicontacts/importer/gmail_spec.rb
 - spec/omnicontacts/importer/hotmail_spec.rb
 - spec/omnicontacts/importer/yahoo_spec.rb
+- spec/omnicontacts/integration_test_spec.rb
+- spec/omnicontacts/middleware/base_oauth_spec.rb
 - spec/omnicontacts/middleware/oauth1_spec.rb
 - spec/omnicontacts/middleware/oauth2_spec.rb
 - spec/spec_helper.rb