pezra-contacts 0.1.0

data/spec/feeds/wl_contacts.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="utf-8"?>
+<LiveContacts>
+  <Owner>
+    <WindowsLiveID>hugo@hotmail.com</WindowsLiveID>
+  </Owner>
+  <Contacts>
+    <Contact>
+      <Profiles>
+        <Personal />
+      </Profiles>
+      <PreferredEmail>froz@gmail.com</PreferredEmail>
+    </Contact>
+    <Contact>
+      <Profiles>
+        <Personal>
+          <FirstName>Rafael</FirstName>
+          <LastName>Timbo</LastName>
+        </Personal>
+      </Profiles>
+      <PreferredEmail>timbo@hotmail.com</PreferredEmail>
+    </Contact>
+    <Contact>
+      <Profiles>
+        <Personal />
+      </Profiles>
+      <PreferredEmail>betinho@hotmail.com</PreferredEmail>
+    </Contact>
+    </Contacts>
+</LiveContacts>

data/spec/feeds/yh_contacts.txt

@@ -0,0 +1,119 @@
+{
+   "type":"search_response",
+   "contacts":[
+      {
+         "type":"contact",
+         "fields":[
+            {
+               "type":"email",
+               "data":"hugo.barauna@gmail.com",
+               "fid":2,
+               "categories":[
+               ]
+            },
+            {
+               "type":"name",
+               "first":"Hugo",
+               "last":"Barauna",
+               "fid":1,
+               "categories":[
+               ]
+            }
+         ],
+         "cid":4,
+         "categories":[
+         ]
+      },
+      {
+         "type":"contact",
+         "fields":[
+            {
+               "type":"email",
+               "data":"nina@hotmail.com",
+               "fid":5,
+               "categories":[
+               ]
+            },
+            {
+               "type":"name",
+               "first":"Nina",
+               "last":"Benchimol",
+               "fid":4,
+               "categories":[
+               ]
+            }
+         ],
+         "cid":5,
+         "categories":[
+         ]
+      },
+      {
+         "type":"contact",
+         "fields":[
+            {
+               "type":"email",
+               "data":"and@yahoo.com",
+               "fid":7,
+               "categories":[
+               ]
+            },
+            {
+               "type":"name",
+               "first":"Andrea",
+               "last":"Dimitri",
+               "fid":6,
+               "categories":[
+               ]
+            }
+         ],
+         "cid":1,
+         "categories":[
+         ]
+      },
+      {
+         "type":"contact",
+         "fields":[
+            {
+               "type":"email",
+               "data":"ricardo@poli.usp.br",
+               "fid":11,
+               "categories":[
+               ]
+            },
+            {
+               "type":"name",
+               "first":"Ricardo",
+               "last":"Fiorelli",
+               "fid":10,
+               "categories":[
+               ]
+            }
+         ],
+         "cid":3,
+         "categories":[
+         ]
+      },
+      {
+         "type":"contact",
+         "fields":[
+            {
+               "type":"email",
+               "data":"pizinha@yahoo.com.br",
+               "fid":14,
+               "categories":[
+               ]
+            },
+            {
+               "type":"name",
+               "first":"Priscila",
+               "fid":13,
+               "categories":[
+               ]
+            }
+         ],
+         "cid":2,
+         "categories":[
+         ]
+      }
+   ]
+}

data/spec/feeds/yh_credential.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+<BBAuthTokenLoginResponse 
+  xmlns:wsse='http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd'
+  xmlns:yahooauth='urn:yahoo:auth'>   
+  <Success>
+    <Cookie>
+Y=cdunlEx76ZEeIdWyeJNOegxfy.jkeoULJCnc7Q0Vr8D5P.u.EE2vCa7G2MwBoULuZhvDZuJNqhHwF3v5RJ4dnsWsEDGOjYV1k6snoln3RlQmx0Ggxs0zAYgbaA4BFQk5ieAkpipq19l6GoD_k8IqXRfJN0Q54BbekC_O6Tj3zl2wV3YQK6Mi2MWBQFSBsO26Tw_1yMAF8saflF9EX1fQl4N.1yBr8UXb6LLDiPQmlISq1_c6S6rFbaOhSZMgO78f2iqZmUAk9RmCHrqPJiHEo.mJlxxHaQsuqTMf7rwLEHqK__Gi_bLypGtaslqeWyS0h2J.B5xwRC8snfEs3ct_kLXT3ngP_pK3MeMf2pe1TiJ4JXVciY9br.KJFUgNd4J6rmQsSFj4wPLoMGCETfVc.M8KLiaFHasZqXDyCE7tvd1khAjQ_xLfQKlg1GlBOWmbimQ1FhdHnsVj3svXjEGquRh8JI2sHIQrzoiqAPBf9WFKQcH0t_1dxf4MOH.7gJaYDPEozCW5EcCsYjuHup9xJKxyTddh5pk8yUg5bURzA.TwPalExMKsbv.RWFBhzWKuTp5guNcqjmUHcCoT19_qFENHX41Xf3texAnsDDGj
+    </Cookie>
+    <WSSID>tr.jZsW/ulc</WSSID>
+    <Timeout>3600</Timeout>
+    <YahooSOAPAuthHeader>
+      <wsse:Security>
+        <yahooauth:YahooAuthToken>
+<yahooauth:Cookies>Y=cdunlEx76ZEeIdWyeJNOegxfy.jkeoULJCnc7Q0Vr8D5P.u.EE2vCa7G2MwBoULuZhvDZuJNqhHwF3v5RJ4dnsWsEDGOjYV1k6snoln3RlQmx0Ggxs0zAYgbaA4BFQk5ieAkpipq19l6GoD_k8IqXRfJN0Q54BbekC_O6Tj3zl2wV3YQK6Mi2MWBQFSBsO26Tw_1yMAF8saflF9EX1fQl4N.1yBr8UXb6LLDiPQmlISq1_c6S6rFbaOhSZMgO78f2iqZmUAk9RmCHrqPJiHEo.mJlxxHaQsuqTMf7rwLEHqK__Gi_bLypGtaslqeWyS0h2J.B5xwRC8snfEs3ct_kLXT3ngP_pK3MeMf2pe1TiJ4JXVciY9br.KJFUgNd4J6rmQsSFj4wPLoMGCETfVc.M8KLiaFHasZqXDyCE7tvd1khAjQ_xLfQKlg1GlBOWmbimQ1FhdHnsVj3svXjEGquRh8JI2sHIQrzoiqAPBf9WFKQcH0t_1dxf4MOH.7gJaYDPEozCW5EcCsYjuHup9xJKxyTddh5pk8yUg5bURzA.TwPalExMKsbv.RWFBhzWKuTp5guNcqjmUHcCoT19_qFENHX41Xf3texAnsDDGj
+</yahooauth:Cookies>
+          <yahooauth:AppID>
+            jjmaQ37IkY0JH18hDRbVIbZ0r6BGYrbaQnm-
+          </yahooauth:AppID>
+          <yahooauth:WSSID>
+            tr.jZsW/ulc
+          </yahooauth:WSSID>
+        </yahooauth:YahooAuthToken>
+      </wsse:Security>
+    </YahooSOAPAuthHeader>
+  </Success>
+</BBAuthTokenLoginResponse>
+<!-- apil02.member.re3.yahoo.com uncompressed/chunked Mon Aug 11 19:00:37 PDT 2008 -->
+

data/spec/flickr/auth_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'contacts/flickr'
+require 'uri'
+
+describe Contacts::Flickr, "authentication" do
+  
+  before(:each) do
+    @f = Contacts::Flickr
+  end
+  
+  describe "authentication for desktop apps" do
+    # Key, secret and signature come from the Flickr API docs.
+    # http://www.flickr.com/services/api/auth.howto.desktop.html
+    it "should generate a correct url to retrieve a frob" do
+      path, query = Contacts::Flickr.frob_url('9a0554259914a86fb9e7eb014e4e5d52', '000005fab4534d05').split('?')
+      path.should == '/services/rest/'
+
+      hsh = hash_from_query(query)
+      hsh[:method].should == 'flickr.auth.getFrob'
+      hsh[:api_key].should == '9a0554259914a86fb9e7eb014e4e5d52'
+      hsh[:api_sig].should == '8ad70cd3888ce493c8dde4931f7d6bd0'
+      hsh[:secret].should be_nil
+    end
+
+    it "should generate an authentication url from a response with a frob" do
+      response = mock_response
+      response.stubs(:body).returns sample_xml('flickr/auth.getFrob')
+      Contacts::Flickr.frob_from_response(response).should == '934-746563215463214621'
+    end
+
+    # The :api_sig parameter is documented wronly in the Flickr API docs. It says the string
+    # to sign ends in 'permswread', but this should be 'permsread' of course. Therefore
+    # the :api_sig here does not correspond to the Flickr docs, but it makes the spec valid.
+    it "should return an url to authenticate to containing a frob" do
+      response = mock_response
+      response.stubs(:body).returns sample_xml('flickr/auth.getFrob')
+      @f.expects(:http_start).returns(response)
+      uri = URI.parse @f.authentication_url('9a0554259914a86fb9e7eb014e4e5d52', '000005fab4534d05')
+      
+      uri.host.should == 'www.flickr.com'
+      uri.scheme.should == 'http'
+      uri.path.should == '/services/auth/'
+      hsh = hash_from_query(uri.query)
+      hsh[:api_key].should == '9a0554259914a86fb9e7eb014e4e5d52'
+      hsh[:api_sig].should == '0d08a9522d152d2e43daaa2a932edf67'
+      hsh[:frob].should == '934-746563215463214621'
+      hsh[:perms].should == 'read'
+      hsh[:secret].should be_nil
+    end
+    
+    it "should get a token from a frob" do
+      response = mock_response
+      response.stubs(:body).returns sample_xml('flickr/auth.getToken')
+      connection = mock('Connection')
+      connection.expects(:get).with do |value|
+        path, query = value.split('?')
+        path.should == '/services/rest/'
+        
+        hsh = hash_from_query(query)
+        hsh[:method].should == 'flickr.auth.getToken'
+        hsh[:api_key].should == '9a0554259914a86fb9e7eb014e4e5d52'
+        hsh[:api_sig].should == 'a5902059792a7976d03be67bdb1e98fd'
+        hsh[:frob].should == '934-746563215463214621'
+        hsh[:secret].should be_nil
+        true
+      end
+      @f.expects(:http_start).returns(response).yields(connection)
+      @f.get_token_from_frob('9a0554259914a86fb9e7eb014e4e5d52', '000005fab4534d05', '934-746563215463214621').should == '45-76598454353455'
+    end
+        
+  end
+
+  def hash_from_query(str)
+    str.split('&').inject({}) do |hsh, pair|
+      key, value = pair.split('=')
+      hsh[key.to_sym] = value
+      hsh
+    end
+  end
+end

data/spec/gmail/auth_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'contacts/google'
+require 'uri'
+
+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
+    # connection = mock_connection
+    # response = mock_response
+    # Net::HTTP.expects(:new).with('www.google.com', 443).returns(connection)
+    # connection.expects(:start)
+    # connection.expects(:get).with('/accounts/AuthSubSessionToken', 'Authorization' => %(AuthSub token="dummytoken")).returns(response)
+    # response.expects(:body).returns()
+    FakeWeb::register_uri 'https://www.google.com/accounts/AuthSubSessionToken',
+      :string => "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 'https://www.google.com/accounts/ClientLogin',
+      :method => 'POST',
+      :query => {
+        'accountType' => 'GOOGLE', 'service' => 'cp', 'source' => 'Contacts-Ruby',
+        'Email' => 'mislav@example.com', 'Passwd' => 'dummyPassword'
+      },
+      :string => "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,190 @@
+require 'spec_helper'
+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 'www.google.com/m8/feeds/contacts/default/thin',
+        :string => '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 'www.google.com/m8/feeds/contacts/person%40example.com/full',
+        :string => '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 '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 == ['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 == 3
+    found[0].name.should == 'Elizabeth Bennet'
+    found[0].emails.should == ['liz@gmail.com', 'liz@example.org']
+    found[1].name.should == 'William Paginate'
+    found[1].emails.should == ['will_paginate@googlegroups.com']
+    found[2].name.should be_nil
+    found[2].emails.should == ['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' }, true)
+      @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, partial = false)
+      FakeWeb::register_uri 'www.google.com/m8/feeds/contacts/default/thin',
+        :query => params, :query_partial_match => partial
+    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