aurelian-contacts 0.3.1

data/spec/contact_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'contacts'
+
+describe Contacts::Contact do
+  describe 'instance' do
+    before do
+      @contact = Contacts::Contact.new('max@example.com', 'Max Power', 'maxpower', "Max", "Power")
+    end
+    
+    it "should have email" do
+      @contact.email.should == 'max@example.com'
+    end
+    
+    it "should have name" do
+      @contact.name.should == 'Max Power'
+    end
+    
+    it "should support a service id" do
+      @contact.service_id = 'service identifier'
+      @contact.service_id.should == 'service identifier'
+    end
+    
+    it "should support multiple emails" do
+      @contact.emails << 'maxpower@example.com'
+      @contact.email.should == 'max@example.com'
+      @contact.emails.should == ['max@example.com', 'maxpower@example.com']
+    end
+    
+    it "should support multiple ims" do
+      @contact.ims << {'value' => 'max', 'type' => 'skype'}
+      @contact.ims.should == [{'value' => 'max', 'type' => 'skype'}]
+    end
+    
+    it "should support multiple phones" do
+      @contact.phones << {'value' => '111 111 1111', 'type' => 'home'}
+      @contact.phones.should == [{'value' => '111 111 1111', 'type' => 'home'}]
+    end
+    
+    it "should support multiple addresses" do
+      @contact.addresses << {'formatted' => '111 SW 1st Street, New York, NY'}
+      @contact.addresses.should == [{'formatted' => '111 SW 1st Street, New York, NY'}]
+    end
+    
+    it "should have username" do
+      @contact.username.should == 'maxpower'
+    end
+    
+    it "should have firstname" do
+      @contact.firstname.should == 'Max'
+    end
+    
+    it "should have lastname" do
+      @contact.lastname.should == 'Power'
+    end
+  end
+  
+  describe '#inspect' do
+    it "should be nice" do
+      @contact = Contacts::Contact.new('max@example.com', 'Max Power', 'maxpower')
+      @contact.inspect.should == '#<Contacts::Contact "Max Power" (max@example.com)>'
+    end
+    
+    it "should be nice without email" do
+      @contact = Contacts::Contact.new(nil, 'Max Power', 'maxpower')
+      @contact.inspect.should == '#<Contacts::Contact "Max Power">'
+    end
+  end
+  
+end

data/spec/gmail/auth_spec.rb

@@ -0,0 +1,68 @@
+require 'contacts/google'
+
+describe Contacts::Google, '.authentication_url' do
+  
+  after :each do
+    FakeWeb.clean_registry
+  end
+  
+  it 'generates a URL for target with default parameters' do
+    uri = parse_authentication_url('http://example.com/invite')
+    
+    uri.host.should == 'www.google.com'
+    uri.scheme.should == 'https'
+    uri.query.split('&').sort.should == [
+      'next=http%3A%2F%2Fexample.com%2Finvite',
+      'scope=http%3A%2F%2Fwww.google.com%2Fm8%2Ffeeds%2Fcontacts%2F',
+      'secure=0',
+      'session=0'
+      ]
+  end
+
+  it 'should handle boolean parameters' do
+    pairs = parse_authentication_url(nil, :secure => true, :session => true).query.split('&')
+    
+    pairs.should include('secure=1')
+    pairs.should include('session=1')
+  end
+
+  it 'skips parameters that have nil value' do
+    query = parse_authentication_url(nil, :secure => nil).query
+    query.should_not include('next')
+    query.should_not include('secure')
+  end
+
+  it 'should be able to exchange one-time for session token' do
+    FakeWeb::register_uri(:get, 'https://www.google.com/accounts/AuthSubSessionToken',
+      :body => "Token=G25aZ-v_8B\nExpiration=20061004T123456Z",
+      :verify => lambda { |req|
+        req['Authorization'].should == %(AuthSub token="dummytoken")
+      }
+    )
+
+    Contacts::Google.session_token('dummytoken').should == 'G25aZ-v_8B'
+  end
+  
+  it "should support client login" do
+    FakeWeb::register_uri(:post, 'https://www.google.com/accounts/ClientLogin',
+      :method => 'POST',
+      :query => {
+        'accountType' => 'GOOGLE', 'service' => 'cp', 'source' => 'Contacts-Ruby',
+        'Email' => 'mislav@example.com', 'Passwd' => 'dummyPassword'
+      },
+      :body => "SID=klw4pHhL_ry4jl6\nLSID=Ij6k-7Ypnc1sxm\nAuth=EuoqMSjN5uo-3B"
+    )
+    
+    Contacts::Google.client_login('mislav@example.com', 'dummyPassword').should == 'EuoqMSjN5uo-3B'
+  end
+  
+  it "should support token authentication after client login" do
+    @gmail = Contacts::Google.new('dummytoken', 'default', true)
+    @gmail.headers['Authorization'].should == 'GoogleLogin auth="dummytoken"'
+  end
+
+  def parse_authentication_url(*args)
+    URI.parse Contacts::Google.authentication_url(*args)
+  end
+  
+end

data/spec/gmail/fetching_spec.rb

@@ -0,0 +1,197 @@
+require 'contacts/google'
+
+describe Contacts::Google do
+
+  before :each do
+    @gmail = create
+  end
+  
+  def create
+    Contacts::Google.new('dummytoken')
+  end
+  
+  after :each do
+    FakeWeb.clean_registry
+  end
+
+  describe 'fetches contacts feed via HTTP GET' do
+    it 'with defaults' do
+      FakeWeb::register_uri(:get, 'www.google.com/m8/feeds/contacts/default/thin',
+        :body => 'thin results',
+        :verify => lambda { |req|
+          req['Authorization'].should == %(AuthSub token="dummytoken")
+          req['Accept-Encoding'].should == 'gzip'
+          req['User-Agent'].should == "Ruby Contacts v#{Contacts::VERSION::STRING} (gzip)"
+        }
+      )
+        
+      response = @gmail.get({})
+      response.body.should == 'thin results'
+    end
+    
+    it 'with explicit user ID and full projection' do
+      @gmail = Contacts::Google.new('dummytoken', 'person@example.com')
+      @gmail.projection = 'full'
+      
+      FakeWeb::register_uri(:get, 'www.google.com/m8/feeds/contacts/person%40example.com/full',
+        :body => 'full results'
+      )
+
+      response = @gmail.get({})
+      response.body.should == 'full results'
+    end
+  end
+
+  it 'handles a normal response body' do
+    response = mock('HTTP response')
+    @gmail.expects(:get).returns(response)
+
+    response.expects(:'[]').with('Content-Encoding').returns(nil)
+    response.expects(:body).returns('<feed/>')
+
+    @gmail.expects(:parse_contacts).with('<feed/>')
+    @gmail.contacts
+  end
+
+  it 'handles gzipped response' do
+    response = mock('HTTP response')
+    @gmail.expects(:get).returns(response)
+
+    gzipped = StringIO.new
+    gzwriter = Zlib::GzipWriter.new gzipped
+    gzwriter.write(('a'..'z').to_a.join)
+    gzwriter.close
+
+    response.expects(:'[]').with('Content-Encoding').returns('gzip')
+    response.expects(:body).returns gzipped.string
+
+    @gmail.expects(:parse_contacts).with('abcdefghijklmnopqrstuvwxyz')
+    @gmail.contacts
+  end
+
+  it 'raises a fetching error when something goes awry' do
+    FakeWeb::register_uri(:get, 'www.google.com/m8/feeds/contacts/default/thin',
+      :status => [404, 'YOU FAIL']
+    )
+      
+    lambda {
+      @gmail.get({})
+    }.should raise_error(Net::HTTPServerException)
+  end
+
+  it 'parses the resulting feed into name/email pairs' do
+    @gmail.stubs(:get)
+    @gmail.expects(:response_body).returns(sample_xml('google-single'))
+
+    found = @gmail.contacts
+    found.size.should == 1
+    contact = found.first
+    contact.name.should == 'Fitzgerald'
+    contact.emails.should == [{'primary' => 'true', 'type' => 'home',  'value' => 'fubar@gmail.com'}]
+  end
+
+  it 'parses a complex feed into name/email pairs' do
+    @gmail.stubs(:get)
+    @gmail.expects(:response_body).returns(sample_xml('google-many'))
+
+    found = @gmail.contacts
+    found.size.should == 4
+    found[0].name.should == 'Elizabeth Bennet'
+    found[0].emails.should == [{'primary' => 'true', 'type' => 'work', 'value' => 'liz@gmail.com'}, {'primary' => 'false', 'type' => 'home', 'value' => 'liz@example.org'}]
+    found[1].name.should == 'Poor Jack'
+    found[1].emails.should == []
+    found[2].name.should == 'William Paginate'
+    found[2].emails.should == [{'primary' => 'false', 'type' => 'other', 'value' => 'will_paginate@googlegroups.com'}]
+    found[3].name.should be_nil
+    found[3].emails.should == [{'primary' => 'false', 'type' => 'other', 'value' => 'anonymous@example.com'}]
+  end
+
+  it 'makes modification time available after parsing' do
+    @gmail.updated_at.should be_nil
+    @gmail.stubs(:get)
+    @gmail.expects(:response_body).returns(sample_xml('google-single'))
+
+    @gmail.contacts
+    u = @gmail.updated_at
+    u.year.should == 2008
+    u.day.should == 5
+    @gmail.updated_at_string.should == '2008-03-05T12:36:38.836Z'
+  end
+
+  describe 'GET query parameter handling' do
+    
+    before :each do
+      @gmail = create
+      @gmail.stubs(:response_body)
+      @gmail.stubs(:parse_contacts)
+    end
+    
+    it 'abstracts ugly parameters behind nicer ones' do
+      expect_params 'max-results' => '25',
+                    'orderby' => 'lastmodified',
+                    'sortorder' => 'ascending',
+                    'start-index' => '11',
+                    'updated-min' => 'datetime'
+
+      @gmail.contacts :limit => 25,
+        :offset => 10,
+        :order => 'lastmodified',
+        :descending => false,
+        :updated_after => 'datetime'
+    end
+
+    it 'should have implicit :descending with :order' do
+      expect_params 'orderby' => 'lastmodified', 
+                    'sortorder' => 'descending',
+                    'max-results' => '200'
+                    
+      @gmail.contacts :order => 'lastmodified'
+    end
+
+    it 'should have default :limit of 200' do
+      expect_params 'max-results' => '200'
+      @gmail.contacts
+    end
+
+    it 'should skip nil values in parameters' do
+      expect_params 'start-index' => '1'
+      @gmail.contacts :limit => nil, :offset => 0
+    end
+
+    def expect_params(params)
+      query_string = Contacts::Google.query_string(params)
+      FakeWeb::register_uri(:get, "www.google.com/m8/feeds/contacts/default/thin?#{query_string}", {})
+    end
+    
+  end
+  
+  describe 'Retrieving all contacts (in chunks)' do
+    
+    before :each do
+      @gmail = create
+    end
+    
+    it 'should make only one API call when no more is needed' do
+      @gmail.expects(:contacts).with(instance_of(Hash)).once.returns((0..8).to_a)
+
+      @gmail.all_contacts({}, 10).should == (0..8).to_a
+    end
+    
+    it 'should make multiple calls to :contacts when needed' do
+      @gmail.expects(:contacts).with(has_entries(:offset => 0 , :limit => 10)).returns(( 0..9 ).to_a)
+      @gmail.expects(:contacts).with(has_entries(:offset => 10, :limit => 10)).returns((10..19).to_a)
+      @gmail.expects(:contacts).with(has_entries(:offset => 20, :limit => 10)).returns((20..24).to_a)
+      
+      @gmail.all_contacts({}, 10).should == (0..24).to_a
+    end
+    
+    it 'should make one extra API call when not sure whether there are more contacts' do
+      @gmail.expects(:contacts).with(has_entries(:offset => 0 , :limit => 10)).returns((0..9).to_a)
+      @gmail.expects(:contacts).with(has_entries(:offset => 10, :limit => 10)).returns([])
+      
+      @gmail.all_contacts({}, 10).should == (0..9).to_a
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+require 'rubygems'
+require 'spec'
+require 'mocha'
+require 'cgi'
+
+begin
+  require 'fake_web'
+rescue LoadError
+  puts "~> spec_helper: Could not load fakeweb gem."
+  puts "~> spec_helper: Please install it with `gem install fakeweb'."
+  exit -1
+end
+
+$LOAD_PATH<< File.join(File.dirname(__FILE__), '..', 'lib')
+
+FakeWeb.allow_net_connect = false
+
+module SampleFeeds
+  FEED_DIR = File.dirname(__FILE__) + '/feeds/'
+  
+  def sample_xml(name)
+    File.read "#{FEED_DIR}#{name}.xml"
+  end
+end
+
+module HttpMocks
+  def mock_response(type = :success)
+    klass = case type
+    when :success  then Net::HTTPSuccess
+    when :redirect then Net::HTTPRedirection
+    when :fail     then Net::HTTPClientError
+    else type
+    end
+    
+    klass.new(nil, nil, nil)
+  end
+  
+  def mock_connection(ssl = true)
+    connection = mock('HTTP connection')
+    connection.stubs(:start)
+    connection.stubs(:finish)
+    if ssl
+      connection.expects(:use_ssl=).with(true)
+      connection.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_NONE)
+    end
+    connection
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include SampleFeeds, HttpMocks
+  # config.predicate_matchers[:swim] = :can_swim?
+  
+  config.mock_with :mocha
+end
+
+module Mocha
+  module ParameterMatchers
+    def query_string(entries, partial = false)
+      QueryStringMatcher.new(entries, partial)
+    end
+  end
+end
+
+class QueryStringMatcher < Mocha::ParameterMatchers::Base
+  
+  def initialize(entries, partial)
+    @entries = entries
+    @partial = partial
+  end
+  
+  def matches?(available_parameters)
+    string = available_parameters.shift.split('?').last
+    broken = string.split('&').map { |pair| pair.split('=').map { |value| CGI.unescape(value) } }
+    hash = Hash[*broken.flatten]
+    
+    if @partial
+      has_entry_matchers = @entries.map do |key, value|
+        Mocha::ParameterMatchers::HasEntry.new(key, value)
+      end
+      Mocha::ParameterMatchers::AllOf.new(*has_entry_matchers).matches?([hash])
+    else
+      @entries == hash
+    end
+  end
+  
+  def mocha_inspect
+    "query_string(#{@entries.mocha_inspect})"
+  end
+  
+end

data/spec/windows_live/windows_live_spec.rb

@@ -0,0 +1,41 @@
+require 'contacts/windows_live'
+
+describe Contacts::WindowsLive do
+
+  before(:each) do
+    @path = Dir.getwd + '/spec/feeds/'
+    @wl = Contacts::WindowsLive.new(@path + 'contacts.yml')
+  end
+  
+  it 'parse the XML contacts document' do
+    contacts = Contacts::WindowsLive.parse_xml(contacts_xml)
+    contacts.size.should == 2
+    contacts[0].service_id == "abc"
+    contacts[0].name.should == "Mia Pia"
+    contacts[0].firstname.should == "Mia"
+    contacts[0].lastname.should == "Pia"
+    contacts[0].emails.should include("mia@hotmail.com", "othermia@yahoo.com")
+    contacts[0].phones.should include({"value"=>"(123) 123 1234", "type"=>"home"}, {"value"=>"(321) 555 1234", "type"=>"other"})
+    contacts[0].addresses.should include({"region"=>"CA", "country"=>"USA", "postalCode"=>"92123", "streetAddress"=>"123 Green St", "type"=>"home", "locality"=>"Middleville", "formatted"=>"123 Green St, Middleville, CA, 92123, USA"})
+    
+    contacts[0].service_id == "def"
+    contacts[1].name.should == ""
+    contacts[1].firstname.should == nil
+    contacts[1].lastname.should == nil
+    contacts[1].emails.should include("marcus@hotmail.com")
+    contacts[1].phones.should be_empty
+    contacts[1].addresses.should be_empty
+  end
+
+  it 'should can be initialized by a YAML file' do
+    wll = @wl.instance_variable_get('@wll')
+
+    wll.appid.should == 'your_app_id'
+    wll.securityalgorithm.should == 'wsignin1.0'
+    wll.returnurl.should == 'http://yourserver.com/your_return_url'
+  end
+
+  def contacts_xml
+    File.open(@path + 'wl_full_contacts.xml', 'r+').read
+  end
+end