omnigroupcontacts 0.3.10 → 0.3.11

data/spec/omnicontacts/importer/yahoo_spec.rb

@@ -0,0 +1,124 @@
+require "spec_helper"
+require "omnigroupcontacts/importer/yahoo"
+
+describe OmniGroupContacts::Importer::Yahoo do
+
+  describe "fetch_contacts_from_token_and_verifier" do
+    let(:self_response) {
+      '{"profile":{
+                  "guid":"PCLASP523T3E2R5TFMHDW9KWQQ",
+                  "birthdate": "06/21",
+                  "emails":[{"handle":"chrisjohnson@gmail.com", "id":10, "primary":true, "type":"HOME"}, {"handle":"xyz@xyz.com", "id":11, "type":"HOME"}],
+                  "familyName": "Johnson",
+                  "gender":"M",
+                  "givenName":"Chris",
+                  "image":{"imageUrl":"https://avatars.zenfs.com/users/23T3E2R5TFMHDW-AFE-I7lUpIsGQ==.large.png"}
+                }
+      }'
+    }
+
+    let(:contacts_as_json) {
+      '{
+        "contacts": {
+          "start":1,
+          "count":1,
+          "contact":[
+            {
+              "id":10,
+              "fields":[
+                {"id":819, "type":"email", "value":"johnny@yahoo.com"},
+                {"id":806,"type":"name","value":{"givenName":"John","middleName":"","familyName":"Smith"},"editedBy":"OWNER","categories":[]},
+                {"id":33555343,"type":"guid","value":"7ET6MYV2UQ6VR6CBSNMCLFJIVI"},
+                {"id":946,"type":"birthday","value":{"day":"22","month":"2","year":"1952"},"editedBy":"OWNER","categories":[]},
+                {"id":21, "type":"address", "value":{"street":"1313 Trashview Court\nApt. 13", "city":"Nowheresville", "stateOrProvince":"OK", "postalCode":"66666", "country":"", "countryCode":""}, "editedBy":"OWNER", "flags":["HOME"], "categories":[]}
+              ]
+            }
+          ]
+        }
+      }' }
+
+    let(:yahoo) { OmniGroupContacts::Importer::Yahoo.new({}, "consumer_key", "consumer_secret") }
+
+    before(:each) do
+      yahoo.instance_variable_set(:@env, {})
+    end
+
+    it "should request the contacts by specifying all required parameters" do
+      yahoo.should_receive(:fetch_access_token).and_return(["access_token", "access_token_secret", "guid"])
+
+      yahoo.should_receive(:https_get) do |host, path, params|
+        params[:format].should eq("json")
+        params[:oauth_consumer_key].should eq("consumer_key")
+        params[:oauth_nonce].should_not be_nil
+        params[:oauth_signature_method].should eq("HMAC-SHA1")
+        params[:oauth_timestamp].should_not be_nil
+        params[:oauth_token].should eq("access_token")
+        params[:oauth_version].should eq("1.0")
+        self_response
+      end
+
+      yahoo.should_receive(:https_get) do |host, path, params|
+        params[:format].should eq("json")
+        params[:oauth_consumer_key].should eq("consumer_key")
+        params[:oauth_nonce].should_not be_nil
+        params[:oauth_signature_method].should eq("HMAC-SHA1")
+        params[:oauth_timestamp].should_not be_nil
+        params[:oauth_token].should eq("access_token")
+        params[:oauth_version].should eq("1.0")
+        contacts_as_json
+      end
+      yahoo.fetch_contacts_from_token_and_verifier "auth_token", "auth_token_secret", "oauth_verifier"
+    end
+
+    it "should correctly parse id, name,email,gender, birthday, snailmail address, image source and relation for contact and logged in user" do
+      yahoo.should_receive(:fetch_access_token).and_return(["access_token", "access_token_secret", "guid"])
+      yahoo.should_receive(:https_get).and_return(self_response)
+      yahoo.should_receive(:https_get).and_return(contacts_as_json)
+      result = yahoo.fetch_contacts_from_token_and_verifier "auth_token", "auth_token_secret", "oauth_verifier"
+
+      result.size.should be(1)
+      result.first[:id].should eq('10')
+      result.first[:first_name].should eq('John')
+      result.first[:last_name].should eq('Smith')
+      result.first[:name].should eq("John Smith")
+      result.first[:email].should eq("johnny@yahoo.com")
+      result.first[:gender].should be_nil
+      result.first[:birthday].should eq({:day=>22, :month=>2, :year=>1952})
+      result.first[:address_1].should eq('1313 Trashview Court')
+      result.first[:address_2].should eq('Apt. 13')
+      result.first[:city].should eq('Nowheresville')
+      result.first[:region].should eq('OK')
+      result.first[:postcode].should eq('66666')
+      result.first[:relation].should be_nil
+    end
+
+    it "should return an empty list of contacts" do
+      empty_contacts_list = '{"contacts": {"start":0, "count":0}}'
+      yahoo.should_receive(:fetch_access_token).and_return(["access_token", "access_token_secret", "guid"])
+      yahoo.should_receive(:https_get).and_return(self_response)
+      yahoo.should_receive(:https_get).and_return(empty_contacts_list)
+      result = yahoo.fetch_contacts_from_token_and_verifier "auth_token", "auth_token_secret", "oauth_verifier"
+
+      result.should be_empty
+    end
+
+    it "should correctly parse and set logged in user information" do
+      yahoo.should_receive(:fetch_access_token).and_return(["access_token", "access_token_secret", "guid"])
+      yahoo.should_receive(:https_get).and_return(self_response)
+      yahoo.should_receive(:https_get).and_return(contacts_as_json)
+      yahoo.fetch_contacts_from_token_and_verifier "auth_token", "auth_token_secret", "oauth_verifier"
+
+      user = yahoo.instance_variable_get(:@env)["omnigroupcontacts.user"]
+      user.should_not be_nil
+      user[:id].should eq('PCLASP523T3E2R5TFMHDW9KWQQ')
+      user[:first_name].should eq('Chris')
+      user[:last_name].should eq('Johnson')
+      user[:name].should eq('Chris Johnson')
+      user[:gender].should eq('male')
+      user[:birthday].should eq({:day=>21, :month=>06, :year=>nil})
+      user[:email].should eq('chrisjohnson@gmail.com')
+      user[:profile_picture].should eq('https://avatars.zenfs.com/users/23T3E2R5TFMHDW-AFE-I7lUpIsGQ==.large.png')
+    end
+
+  end
+end

data/spec/omnicontacts/integration_test_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+require "omnigroupcontacts/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)}.to raise_error
+    end
+  end
+end

data/spec/omnicontacts/middleware/base_oauth_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+require "omnigroupcontacts"
+require "omnigroupcontacts/middleware/base_oauth"
+
+describe OmniGroupContacts::Middleware::BaseOAuth do
+  
+  before(:all) do 
+    class TestProvider < OmniGroupContacts::Middleware::BaseOAuth
+      def initialize app, consumer_key, consumer_secret, options = {}
+        super app, options
+      end
+      
+      def redirect_path
+        "#{ MOUNT_PATH }testprovider/callback"
+      end
+    end
+    omnigroupcontacts.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
+    omnigroupcontacts.integration_test.mock(:testprovider, :email => "user@example.com")
+    get "#{ MOUNT_PATH }testprovider"
+    get "#{ MOUNT_PATH }testprovider/callback"
+    last_request.env["omnigroupcontacts.contacts"].first[:email].should eq("user@example.com")
+  end
+
+  it "should redurect to failure url" do
+    omnigroupcontacts.integration_test.mock(:testprovider, "some_error" )
+    get "#{ MOUNT_PATH }testprovider"
+    get "#{MOUNT_PATH }testprovider/callback"
+    last_response.should be_redirect
+    last_response.headers["location"].should eq("#{ MOUNT_PATH }failure?error_message=internal_error&importer=testprovider")
+  end
+  
+  it "should pass through state query params to the failure url" do
+    omnigroupcontacts.integration_test.mock(:testprovider, "some_error" )
+    get "#{MOUNT_PATH }testprovider/callback?state=/parent/resource/id"
+    last_response.headers["location"].should eq("#{ MOUNT_PATH }failure?error_message=internal_error&importer=testprovider&state=/parent/resource/id")
+  end
+  
+  after(:all) do 
+    omnigroupcontacts.integration_test.enabled = false
+    omnigroupcontacts.integration_test.clear_mocks
+  end
+  
+end

data/spec/omnicontacts/middleware/oauth1_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+require "omnigroupcontacts/middleware/oauth1"
+
+describe OmniGroupContacts::Middleware::OAuth1 do
+
+  before(:all) do
+    class OAuth1Middleware < OmniGroupContacts::Middleware::OAuth1
+      def self.mock_auth_token_resp
+        @mock_auth_token_resp ||= Object.new
+      end
+
+      def fetch_authorization_token
+        OAuth1Middleware.mock_auth_token_resp.body
+      end
+
+      def authorization_url auth_token
+        "http://www.example.com"
+      end
+
+      def fetch_contacts_from_token_and_verifier oauth_token, ouath_token_secret, oauth_verifier
+        [{:name => "John Doe", :email => "john@example.com"}]
+      end
+
+      def self.mock_session
+        @mock_session ||= {}
+      end
+
+      def session
+        OAuth1Middleware.mock_session
+      end
+    end
+  end
+
+  let(:app) {
+    Rack::Builder.new do |b|
+      b.use OAuth1Middleware, "consumer_id", "consumer_secret"
+      b.run lambda { |env| [200, {"Content-Type" => "text/html"}, ["Hello World"]] }
+    end.to_app
+  }
+
+  context "visiting the listening path" do
+    it "should save the authorization token and redirect to the authorization url" do
+      OAuth1Middleware.mock_auth_token_resp.should_receive(:body).and_return(["auth_token", "auth_token_secret"])
+      get "#{ MOUNT_PATH }oauth1middleware"
+      last_response.should be_redirect
+      last_response.headers['location'].should eq("http://www.example.com")
+    end
+
+    it "should pass through state query params visiting the listening path" do
+      OAuth1Middleware.mock_auth_token_resp.should_receive(:body).and_return(["auth_token", "auth_token_secret"])
+      get "#{ MOUNT_PATH }oauth1middleware?state=/parent/resource/id"
+      last_response.headers['location'].should eq("http://www.example.com?state=/parent/resource/id")
+    end
+
+    it "should redirect to failure url if fetching the request token does not succeed" do
+      OAuth1Middleware.mock_auth_token_resp.should_receive(:body).and_raise("Request failed")
+      get "contacts/oauth1middleware"
+      last_response.should be_redirect
+      last_response.headers["location"].should eq("#{ MOUNT_PATH }failure?error_message=internal_error&importer=oauth1middleware")
+    end
+  end
+
+  context "visiting the callback url after authorization" do
+    it "should return the list of contacts" do
+      OAuth1Middleware.mock_session.should_receive(:[]).and_return("oauth_token_secret")
+      get "#{ MOUNT_PATH }oauth1middleware/callback?oauth_token=token&oauth_verifier=verifier"
+      last_response.should be_ok
+      last_request.env["omnigroupcontacts.contacts"].size.should be(1)
+    end
+
+    it "should redirect to failure url if oauth_token_secret is not found in the session" do
+      OAuth1Middleware.mock_session.should_receive(:[]).and_return(nil)
+      get "#{ MOUNT_PATH }oauth1middleware/callback?oauth_token=token&oauth_verifier=verifier"
+      last_response.should be_redirect
+      last_response.headers["location"].should eq("#{ MOUNT_PATH }failure?error_message=not_authorized&importer=oauth1middleware")
+    end
+  end
+end

data/spec/omnicontacts/middleware/oauth2_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+require "omnigroupcontacts/middleware/oauth2"
+
+describe OmniGroupContacts::Middleware::OAuth2 do
+
+  before(:all) do
+    class OAuth2Middleware < OmniGroupContacts::Middleware::OAuth2
+      def authorization_url
+        "http://www.example.com"
+      end
+
+      def redirect_path
+        "/redirect_path"
+      end
+
+      def self.mock_session
+        @mock_session ||= {}
+      end
+
+      def session
+        OAuth2Middleware.mock_session
+      end
+
+      def fetch_access_token code
+        ["access_token", "token_type", "token_refresh"]
+      end
+
+      def fetch_contacts_using_access_token token, token_type
+        [{:name => "John Doe", :email => "john@example.com"}]
+      end
+    end
+  end
+
+  let(:app) {
+    Rack::Builder.new do |b|
+      b.use OAuth2Middleware, "client_id", "client_secret"
+      b.run lambda { |env| [200, {"Content-Type" => "text/html"}, ["Hello World"]] }
+    end.to_app
+  }
+
+  context "visiting the listening path" do
+    it "should redirect to authorization site when visiting the listening path" do
+      get "#{ MOUNT_PATH }oauth2middleware"
+      last_response.should be_redirect
+      last_response.headers['location'].should eq("http://www.example.com")
+    end
+
+    it "should pass through state query params visiting the listening path" do
+      get "#{ MOUNT_PATH }oauth2middleware?state=/parent/resource/id"
+      last_response.headers['location'].should eq("http://www.example.com?state=/parent/resource/id")
+    end
+  end
+
+  context "visiting the callback url after authorization" do
+    it "should fetch the contacts" do
+      get '/redirect_path?code=ABC'
+      last_response.should be_ok
+      last_request.env["omnigroupcontacts.contacts"].size.should be(1)
+    end
+
+    it "should redirect to failure page because user did not allow access to contacts list" do
+      get '/redirect_path?error=not_authorized'
+      last_response.should be_redirect
+      last_response.headers["location"].should eq("#{ MOUNT_PATH }failure?error_message=not_authorized&importer=oauth2middleware")
+    end
+  end
+end

data/spec/omnicontacts/parse_utils_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+require "omnigroupcontacts/parse_utils"
+
+include OmniGroupContacts::ParseUtils
+
+describe OmniGroupContacts::ParseUtils do
+  describe "normalize_name" do
+    it "should remove trailing spaces" do
+      result = normalize_name("John ")
+      result.should eq("John")
+    end
+
+    it "should preserve capitalization" do
+      result = normalize_name("John McDonald")
+      result.should eq("John McDonald")
+    end
+  end
+
+  describe "full_name" do
+    it "should preserve capitalization" do
+      result = full_name("John", "McDonald")
+      result.should eq("John McDonald")
+    end
+
+    it "returns only first name if no last name present" do
+      result = full_name("John", nil)
+      result.should eq("John")
+    end
+
+    it "returns only last name if no first name present" do
+      result = full_name(nil, "McDonald")
+      result.should eq("McDonald")
+    end
+  end
+
+  describe "birthday_format" do
+    it "returns nil if (!year && !month) || (!year && !day)" do
+      result = birthday_format(nil, Date.today, nil)
+      result.should eq(nil)
+
+      result = birthday_format(Date.today.month, nil, nil)
+      result.should eq(nil)
+    end
+  end
+
+  describe "email_to_name" do
+    it "create a probable name from email" do
+      username_or_email = "foo.bar@test.com"
+      result = email_to_name(username_or_email)
+      result.should eq ['foo','bar',"foo bar"]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "simplecov"
+SimpleCov.start do
+  add_filter "spec/"
+end
+
+require "rspec"
+require "rack/test"
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end
+
+MOUNT_PATH = "/contacts/"