lperichon-contacts 1.0

data/spec/gmail/fetching_spec.rb

@@ -0,0 +1,196 @@
+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(:get, '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(:get, '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(: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 == ['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',
+                    '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/rcov.opts

@@ -0,0 +1,2 @@
+--exclude ^\/,^spec\/
+--no-validator-links

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,84 @@
+require 'rubygems'
+gem 'rspec', '~> 1.1.3'
+require 'spec'
+gem 'mocha', '~> 0.9.0'
+require 'mocha'
+
+require 'cgi'
+require 'fake_web'
+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,34 @@
+require 'spec_helper'
+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[0].name.should be_nil
+    contacts[0].email.should == 'froz@gmail.com'
+    contacts[1].name.should == 'Rafael Timbo'
+    contacts[1].email.should == 'timbo@hotmail.com'
+    contacts[2].name.should be_nil
+    contacts[2].email.should == 'betinho@hotmail.com'
+
+  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_contacts.xml', 'r+').read
+  end
+end

data/spec/yahoo/yahoo_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'contacts/yahoo'
+
+describe Contacts::Yahoo do
+  
+  before(:each) do
+    @path = Dir.getwd + '/spec/feeds/'
+    @yahoo = Contacts::Yahoo.new(@path + 'contacts.yml')
+  end
+
+  it 'should generate an athentication URL' do
+    auth_url = @yahoo.get_authentication_url()
+    auth_url.should match(/https:\/\/api.login.yahoo.com\/WSLogin\/V1\/wslogin\?appid=i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--&ts=.*&sig=.*/)
+  end
+
+  it 'should have a simple interface to grab the contacts' do
+    @yahoo.expects(:access_user_credentials).returns(read_file('yh_credential.xml'))
+    @yahoo.expects(:access_address_book_api).returns(read_file('yh_contacts.txt'))
+
+    redirect_path = '/?appid=i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--&token=AB.KoEg8vBwvJKFkwfcDTJEMKhGeAD6KhiDe0aZLCvoJzMeQG00-&appdata=&ts=1218501215&sig=d381fba89c7e9d3c14788720733c3fbf'
+                            
+    results = @yahoo.contacts(redirect_path)
+    results.should have_contact('Hugo Barauna', 'hugo.barauna@gmail.com')
+    results.should have_contact('Nina Benchimol', 'nina@hotmail.com')
+    results.should have_contact('Andrea Dimitri', 'and@yahoo.com')
+    results.should have_contact('Ricardo Fiorelli', 'ricardo@poli.usp.br')
+    results.should have_contact('Priscila', 'pizinha@yahoo.com.br')
+  end
+
+  it 'should validate yahoo redirect signature' do
+    redirect_path = '/?appid=i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--&token=AB.KoEg8vBwvJKFkwfcDTJEMKhGeAD6KhiDe0aZLCvoJzMeQG00-&appdata=&ts=1218501215&sig=d381fba89c7e9d3c14788720733c3fbf'
+
+    @yahoo.validate_signature(redirect_path).should be_true
+    @yahoo.token.should == 'AB.KoEg8vBwvJKFkwfcDTJEMKhGeAD6KhiDe0aZLCvoJzMeQG00-'
+  end
+  
+  it 'should detect when the redirect is not valid' do
+    redirect_path = '/?appid=i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--&token=AB.KoEg8vBwvJKFkwfcDTJEMKhGeAD6KhiDe0aZLCvoJzMeQG00-&appdata=&ts=1218501215&sig=de4fe4ebd50a8075f75dcc23f6aca04f'
+
+    lambda{ @yahoo.validate_signature(redirect_path) }.should raise_error
+  end
+  
+  it 'should generate the credential request URL' do
+    redirect_path = '/?appid=i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--&token=AB.KoEg8vBwvJKFkwfcDTJEMKhGeAD6KhiDe0aZLCvoJzMeQG00-&appdata=&ts=1218501215&sig=d381fba89c7e9d3c14788720733c3fbf'
+    @yahoo.validate_signature(redirect_path)
+
+    @yahoo.get_credential_url.should match(/https:\/\/api.login.yahoo.com\/WSLogin\/V1\/wspwtoken_login\?appid=i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--&ts=.*&token=.*&sig=.*/)
+  end
+  
+  it 'should parse the credential XML' do
+    @yahoo.parse_credentials(read_file('yh_credential.xml'))
+
+    @yahoo.wssid.should == 'tr.jZsW/ulc'
+    @yahoo.cookie.should == 'Y=cdunlEx76ZEeIdWyeJNOegxfy.jkeoULJCnc7Q0Vr8D5P.u.EE2vCa7G2MwBoULuZhvDZuJNqhHwF3v5RJ4dnsWsEDGOjYV1k6snoln3RlQmx0Ggxs0zAYgbaA4BFQk5ieAkpipq19l6GoD_k8IqXRfJN0Q54BbekC_O6Tj3zl2wV3YQK6Mi2MWBQFSBsO26Tw_1yMAF8saflF9EX1fQl4N.1yBr8UXb6LLDiPQmlISq1_c6S6rFbaOhSZMgO78f2iqZmUAk9RmCHrqPJiHEo.mJlxxHaQsuqTMf7rwLEHqK__Gi_bLypGtaslqeWyS0h2J.B5xwRC8snfEs3ct_kLXT3ngP_pK3MeMf2pe1TiJ4JXVciY9br.KJFUgNd4J6rmQsSFj4wPLoMGCETfVc.M8KLiaFHasZqXDyCE7tvd1khAjQ_xLfQKlg1GlBOWmbimQ1FhdHnsVj3svXjEGquRh8JI2sHIQrzoiqAPBf9WFKQcH0t_1dxf4MOH.7gJaYDPEozCW5EcCsYjuHup9xJKxyTddh5pk8yUg5bURzA.TwPalExMKsbv.RWFBhzWKuTp5guNcqjmUHcCoT19_qFENHX41Xf3texAnsDDGj'
+  end
+
+  it 'should parse the contacts json response' do
+    json = read_file('yh_contacts.txt')
+    
+    Contacts::Yahoo.parse_contacts(json).should have_contact('Hugo Barauna', 'hugo.barauna@gmail.com')
+    Contacts::Yahoo.parse_contacts(json).should have_contact('Nina Benchimol', 'nina@hotmail.com')
+    Contacts::Yahoo.parse_contacts(json).should have_contact('Andrea Dimitri', 'and@yahoo.com')
+    Contacts::Yahoo.parse_contacts(json).should have_contact('Ricardo Fiorelli', 'ricardo@poli.usp.br')
+    Contacts::Yahoo.parse_contacts(json).should have_contact('Priscila', 'pizinha@yahoo.com.br')
+  end
+
+  it 'should can be initialized by a YAML file' do
+    @yahoo.appid.should == 'i%3DB%26p%3DUw70JGIdHWVRbpqYItcMw--'
+    @yahoo.secret.should == 'a34f389cbd135de4618eed5e23409d34450'
+  end
+
+  def read_file(file)
+    File.open(@path + file, 'r+').read
+  end
+
+  def have_contact(name, email)
+    matcher_class = Class.new()
+    matcher_class.instance_eval do 
+      define_method(:matches?) {|some_contacts| some_contacts.any? {|a_contact| a_contact.name == name && a_contact.emails.include?(email)}}
+    end
+    matcher_class.new
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: lperichon-contacts
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-12 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitmodules
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/contacts.rb
+- lib/contacts/consumer.rb
+- lib/contacts/google.rb
+- lib/contacts/oauth_consumer.rb
+- lib/contacts/util.rb
+- lib/contacts/version.rb
+- lib/contacts/windows_live.rb
+- lib/contacts/yahoo.rb
+- rails/init.rb
+- spec/contact_spec.rb
+- spec/feeds/contacts.yml
+- spec/feeds/flickr/auth.getFrob.xml
+- spec/feeds/flickr/auth.getToken.xml
+- spec/feeds/google-many.xml
+- spec/feeds/google-single.xml
+- spec/feeds/wl_contacts.xml
+- spec/feeds/yh_contacts.txt
+- spec/feeds/yh_credential.xml
+- spec/flickr/auth_spec.rb
+- spec/gmail/auth_spec.rb
+- spec/gmail/fetching_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/windows_live/windows_live_spec.rb
+- spec/yahoo/yahoo_spec.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Fetch users' contact lists without asking them to provide their passwords, as painlessly as possible.
+test_files: []
+