googlecontacts 0.1.3 → 0.1.4

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Pieter Noordhuis
+Copyright (c) 2010 Pieter Noordhuis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/google_contacts/base.rb

@@ -117,7 +117,7 @@ module GoogleContacts
     
     # Try to proxy missing method to one of the proxies
     def method_missing(sym, *args, &blk)
-      if sym.to_s =~ /^(\w+)(=)?$/ && @proxies[$1.to_sym]
+      if sym.to_s =~ /^(\w+)(=)?$/ && @proxies[$1]
         if $2
           @proxies[$1].replace(args.first)
         else

data/lib/google_contacts/contact.rb

@@ -25,6 +25,10 @@ module GoogleContacts
       properties[prop] = value
     end
     
+    def email
+      emails.primary.try(:address)
+    end
+    
     def email=(address)
       emails[address].primary!
     end

data/lib/google_contacts/proxies/array.rb

@@ -10,9 +10,9 @@ module GoogleContacts
       end
       
       def reinitialize
-        @current = @parent.xml.xpath("./#{@tag}").map do |entry|
+        @current = sanitize(@parent.xml.xpath("./#{@tag}").map do |entry|
           entry[@attr]
-        end.compact.uniq.sort
+        end)
         
         # create a deep copy
         @new = @current.map { |item| item.dup }
@@ -29,17 +29,35 @@ module GoogleContacts
         end
       end
       
-      def push(item)
-        item = item.href if item.respond_to?(:href)
-        method_missing(:push, item)
+      def replace(content)
+        @new = sanitize([content].flatten)
       end
-      alias :<< :push
-
+      
       private
+      # Extract href from arguments if the operation changes
+      # the contents of the array.
       def method_missing(sym, *args, &blk)
-        ret = @new.send(sym, *args, &blk)
-        @new = @new.compact.uniq.sort
-        ret
+        if [:<<, :push, :+, :-, :concat].include?(sym)
+          args = href_from_items(*args)
+        end
+
+        result = @new.send(sym, *args, &blk)
+        @new = sanitize(@new)
+        result
+      end
+      
+      def sanitize(array)
+        array.compact.uniq.sort
+      end
+      
+      def href_from_items(*items)
+        items.map do |item|
+          if item.is_a?(::Array)
+            href_from_items(*item)
+          else
+            item.respond_to?(:href) ? item.href : item
+          end
+        end
       end
     end # class Array
   end # module Proxies

data/lib/google_contacts/proxies/emails.rb

@@ -22,6 +22,10 @@ module GoogleContacts
         @current != @new
       end
       
+      def primary
+        @new.values.find { |email| email.primary? } || @new.values.first
+      end
+      
       def primary!(address)
         @new.each do |key, email|
           if key == address

data/lib/google_contacts/wrapper.rb

@@ -52,8 +52,21 @@ module GoogleContacts
     end
     
     def find(what, options = {}, &blk)
-      xml = get("http://www.google.com/m8/feeds/#{what}/default/full", options)
-      xml.xpath('/xmlns:feed/xmlns:entry').map(&blk)
+      options['max-results'] ||= 200
+      options['start-index'] = 1
+      
+      result = []
+      begin
+        xml = get("http://www.google.com/m8/feeds/#{what}/default/full", options)
+        result.concat xml.xpath('/xmlns:feed/xmlns:entry').map(&blk)
+              
+        total_results = xml.at('//openSearch:totalResults').text.to_i
+        start_index   = xml.at('//openSearch:startIndex'  ).text.to_i
+        per_page      = xml.at('//openSearch:itemsPerPage').text.to_i
+        options['start-index'] = start_index + per_page
+      end while (options['start-index'] <= total_results)
+
+      result
     end
     
     def save(instance)
@@ -66,8 +79,6 @@ module GoogleContacts
     def append_to_batch(entry)
       if @batching
         if @batch.present?
-          # puts @batch.last.a
-          # puts @batch.last.at('./category').inspect
           batch_term = @batch.last.at('./category')['term']
           entry_term =       entry.at('./category')['term']
           raise "Cannot mix Contact and Group in one batch" if batch_term != entry_term

data/lib/googlecontacts.rb

@@ -1,2 +1,2 @@
 # For convenience
-require './google_contacts'
+require 'google_contacts'

data/spec/assets/contacts_full_page1.xml

@@ -0,0 +1,60 @@
+<feed xmlns='http://www.w3.org/2005/Atom'
+    xmlns:openSearch='http://a9.com/-/spec/opensearch/1.1/'
+    xmlns:gContact='http://schemas.google.com/contact/2008'
+    xmlns:batch='http://schemas.google.com/gdata/batch'
+    xmlns:gd='http://schemas.google.com/g/2005'
+    gd:etag='W/"CUMBRHo_fip7ImA9WxRbGU0."'>
+  <id>liz@gmail.com</id>
+  <updated>2008-12-10T10:04:15.446Z</updated>
+  <category scheme='http://schemas.google.com/g/2005#kind'
+    term='http://schemas.google.com/contact/2008#contact' />
+  <title>Elizabeth Bennet's Contacts</title>
+  <link rel='http://schemas.google.com/g/2005#feed'
+    type='application/atom+xml'
+    href='http://www.google.com/m8/feeds/contacts/liz%40gmail.com/full' />
+  <link rel='http://schemas.google.com/g/2005#post'
+    type='application/atom+xml'
+    href='http://www.google.com/m8/feeds/contacts/liz%40gmail.com/full' />
+  <link rel='http://schemas.google.com/g/2005#batch'
+    type='application/atom+xml'
+    href='http://www.google.com/m8/feeds/contacts/liz%40gmail.com/full/batch' />
+  <link rel='self' type='application/atom+xml'
+    href='http://www.google.com/m8/feeds/contacts/liz%40gmail.com/full?max-results=25' />
+  <author>
+    <name>Elizabeth Bennet</name>
+    <email>liz@gmail.com</email>
+  </author>
+  <generator version='1.0' uri='http://www.google.com/m8/feeds'>
+    Contacts
+  </generator>
+  <openSearch:totalResults>40</openSearch:totalResults>
+  <openSearch:startIndex>1</openSearch:startIndex>
+  <openSearch:itemsPerPage>25</openSearch:itemsPerPage>
+  <entry gd:etag='"Qn04eTVSLyp7ImA9WxRbGEUORAQ."'>
+    <id>
+      http://www.google.com/m8/feeds/contacts/liz%40gmail.com/base/c9012de
+    </id>
+    <updated>2008-12-10T04:45:03.331Z</updated>
+    <app:edited xmlns:app='http://www.w3.org/2007/app'>2008-12-10T04:45:03.331Z</app:edited>
+    <category scheme='http://schemas.google.com/g/2005#kind'
+      term='http://schemas.google.com/contact/2008#contact' />
+    <title>Fitzwilliam Darcy</title>
+    <gd:name>
+      <gd:fullName>Fitzwilliam Darcy</gd:fullName>
+    </gd:name>
+    <link rel='http://schemas.google.com/contacts/2008/rel#photo' type='image/*'
+      href='http://www.google.com/m8/feeds/photos/media/liz%40gmail.com/c9012de'
+      gd:etag='"KTlcZWs1bCp7ImBBPV43VUV4LXEZCXERZAc."' />
+    <link rel='self' type='application/atom+xml'
+      href='http://www.google.com/m8/feeds/contacts/liz%40gmail.com/full/c9012de' />
+    <link rel='edit' type='application/atom+xml'
+      href='http://www.google.com/m8/feeds/contacts/liz%40gmail.com/full/c9012de' />
+    <gd:phoneNumber rel='http://schemas.google.com/g/2005#home'
+      primary='true'>
+      456
+    </gd:phoneNumber>
+    <gd:extendedProperty name='pet' value='hamster' />
+    <gContact:groupMembershipInfo deleted='false'
+      href='http://www.google.com/m8/feeds/groups/liz%40gmail.com/base/270f' />
+  </entry>
+</feed>

data/spec/assets/contacts_full_page2.xml

@@ -0,0 +1,60 @@
+<feed xmlns='http://www.w3.org/2005/Atom'
+    xmlns:openSearch='http://a9.com/-/spec/opensearch/1.1/'
+    xmlns:gContact='http://schemas.google.com/contact/2008'
+    xmlns:batch='http://schemas.google.com/gdata/batch'
+    xmlns:gd='http://schemas.google.com/g/2005'
+    gd:etag='W/"CUMBRHo_fip7ImA9WxRbGU0."'>
+  <id>liz@gmail.com</id>
+  <updated>2008-12-10T10:04:15.446Z</updated>
+  <category scheme='http://schemas.google.com/g/2005#kind'
+    term='http://schemas.google.com/contact/2008#contact' />
+  <title>Elizabeth Bennet's Contacts</title>
+  <link rel='http://schemas.google.com/g/2005#feed'
+    type='application/atom+xml'
+    href='http://www.google.com/m8/feeds/contacts/liz%40gmail.com/full' />
+  <link rel='http://schemas.google.com/g/2005#post'
+    type='application/atom+xml'
+    href='http://www.google.com/m8/feeds/contacts/liz%40gmail.com/full' />
+  <link rel='http://schemas.google.com/g/2005#batch'
+    type='application/atom+xml'
+    href='http://www.google.com/m8/feeds/contacts/liz%40gmail.com/full/batch' />
+  <link rel='self' type='application/atom+xml'
+    href='http://www.google.com/m8/feeds/contacts/liz%40gmail.com/full?max-results=25' />
+  <author>
+    <name>Elizabeth Bennet</name>
+    <email>liz@gmail.com</email>
+  </author>
+  <generator version='1.0' uri='http://www.google.com/m8/feeds'>
+    Contacts
+  </generator>
+  <openSearch:totalResults>40</openSearch:totalResults>
+  <openSearch:startIndex>26</openSearch:startIndex>
+  <openSearch:itemsPerPage>25</openSearch:itemsPerPage>
+  <entry gd:etag='"Qn04eTVSLyp7ImA9WxRbGEUORAQ."'>
+    <id>
+      http://www.google.com/m8/feeds/contacts/liz%40gmail.com/base/c9012de
+    </id>
+    <updated>2008-12-10T04:45:03.331Z</updated>
+    <app:edited xmlns:app='http://www.w3.org/2007/app'>2008-12-10T04:45:03.331Z</app:edited>
+    <category scheme='http://schemas.google.com/g/2005#kind'
+      term='http://schemas.google.com/contact/2008#contact' />
+    <title>Fitzwilliam Darcy</title>
+    <gd:name>
+      <gd:fullName>Fitzwilliam Darcy</gd:fullName>
+    </gd:name>
+    <link rel='http://schemas.google.com/contacts/2008/rel#photo' type='image/*'
+      href='http://www.google.com/m8/feeds/photos/media/liz%40gmail.com/c9012de'
+      gd:etag='"KTlcZWs1bCp7ImBBPV43VUV4LXEZCXERZAc."' />
+    <link rel='self' type='application/atom+xml'
+      href='http://www.google.com/m8/feeds/contacts/liz%40gmail.com/full/c9012de' />
+    <link rel='edit' type='application/atom+xml'
+      href='http://www.google.com/m8/feeds/contacts/liz%40gmail.com/full/c9012de' />
+    <gd:phoneNumber rel='http://schemas.google.com/g/2005#home'
+      primary='true'>
+      456
+    </gd:phoneNumber>
+    <gd:extendedProperty name='pet' value='hamster' />
+    <gContact:groupMembershipInfo deleted='false'
+      href='http://www.google.com/m8/feeds/groups/liz%40gmail.com/base/270f' />
+  </entry>
+</feed>

data/spec/contact_spec.rb

@@ -84,12 +84,22 @@ describe GoogleContacts::Contact do
       @contact.changed?.should be_true
     end
     
+    it "should have no groups" do
+      @contact.groups.should be_empty
+    end
+    
     it "should be possible to set the default email address" do
       @contact.email = 'foo@bar.com'
       @contact.emails['foo@bar.com'].should be_primary
       @contact.emails.size.should == 1
     end
     
+    it "should provide access to the contact's primary email address" do
+      @contact.email.should be_nil
+      @contact.email = 'foo@bar.com'
+      @contact.email.should == 'foo@bar.com'
+    end
+    
     describe "when updating" do
       it "should update the title-tag" do
         @contact.xml.at('./xmlns:title').should be_nil
@@ -99,4 +109,43 @@ describe GoogleContacts::Contact do
       end
     end
   end
+  
+  describe "operations" do
+    before(:each) do
+      @contact = GoogleContacts::Contact.new(wrapper)
+      @root = @contact.xml.document.root
+    end
+    
+    describe "on groups" do
+      before(:each) do
+        @groups = [stub('group1', :href => 'foo'), stub('group2', :href => 'bar')]
+      end
+      
+      it "should be possible to add an array of groups" do
+        @contact.groups += @groups
+        @contact.groups.should == ['foo', 'bar'].sort
+      end
+
+      it "should be possible to add an array of urls" do
+        @contact.groups += ['foo', 'bar']
+        @contact.groups.should == ['foo', 'bar'].sort
+      end
+      
+      describe "with initial content" do
+        before(:each) do
+          @contact.groups = ['foo', 'bar', 'quux']
+        end
+
+        it "should be possible to remove an array of groups" do
+          @contact.groups -= @groups
+          @contact.groups.should == ['quux']
+        end
+
+        it "should be possible to remove an array of urls" do
+          @contact.groups -= ['foo', 'bar']
+          @contact.groups.should == ['quux']
+        end
+      end
+    end
+  end
 end

data/spec/proxies/emails_spec.rb

@@ -27,6 +27,10 @@ describe GoogleContacts::Proxies::Emails do
       @proxy['fubar@gmail.com'    ]         .should be_primary
     end
     
+    it "should be able to return the primary address" do
+      @proxy.primary.should == @proxy['fubar@gmail.com']
+    end
+    
     it "should initially be unchanged" do
       @proxy.changed?.should be_false
     end

data/spec/wrapper_spec.rb

@@ -2,23 +2,43 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe GoogleContacts::Wrapper do
   describe "fetching" do
+    before(:each) do
+      @options = { 'max-results' => 200, 'start-index' => 1 }
+    end
+    
+    def params(overrides)
+      @options.merge(overrides).map do |tuple|
+        tuple.join('=')
+      end.join('&')
+    end
+    
+    def register(type, options = {})
+      url = "http://www.google.com/m8/feeds/#{type}/default/full?#{params(options)}"
+      FakeWeb.register_uri(:get, url, :body => yield)
+    end
+    
     it "should be able to get list of contacts" do
-      FakeWeb.register_uri(:get,
-        'http://www.google.com/m8/feeds/contacts/default/full',
-        :body => asset('contacts_full')
-      )
-      
+      register(:contacts) { asset('contacts_full') }
       result = wrapper.contacts.find(:all)
       result.should have(1).contact
       result.first.should be_a GoogleContacts::Contact
     end
     
+    it "should be able to get list of contacts when result is paginated" do
+      register(:contacts, 'start-index' =>  1) { asset('contacts_full_page1') }
+      register(:contacts, 'start-index' => 26) { asset('contacts_full_page2') }
+      result = wrapper.contacts.find(:all)
+      result.should have(2).contacts
+    end
+    
+    it "should be possible to specify the max-results parameter" do
+      register(:contacts, 'max-results' => 25) { asset('contacts_full') }
+      result = wrapper.contacts.find(:all, 'max-results' => 25)
+      result.should have(1).contact
+    end
+    
     it "should be able to get list of groups" do
-      FakeWeb.register_uri(:get,
-        'http://www.google.com/m8/feeds/groups/default/full',
-        :body => asset('groups_full')
-      )
-
+      register(:groups) { asset('groups_full') }
       result = wrapper.groups.find(:all)
       result.should have(2).groups
       result.first.should be_a GoogleContacts::Group
@@ -53,6 +73,11 @@ describe GoogleContacts::Wrapper do
       end
     end
     
+    it "should not flush when there are no operations to execute" do
+      wrapper.expects(:post).never
+      wrapper.batch {}
+    end
+    
     it "should raise when mixing contacts and groups in one batch" do
       lambda {
         wrapper.batch {

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: googlecontacts
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Pieter Noordhuis
@@ -9,69 +14,93 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-27 00:00:00 +01:00
+date: 2010-03-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: fakeweb
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 8
         version: 1.2.8
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
         version: 0.9.8
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 4
         version: 2.3.4
-    version: 
+  type: :runtime
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: nokogiri
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 1
         version: 1.4.1
-    version: 
+  type: :runtime
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: oauth
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 6
         version: 0.3.6
-    version: 
+  type: :runtime
+  version_requirements: *id006
 description: Google Contacts API implementation
 email: pcnoordhuis@gmail.com
 executables: []
@@ -101,6 +130,8 @@ files:
 - lib/google_contacts/wrapper.rb
 - lib/googlecontacts.rb
 - spec/assets/contacts_full.xml
+- spec/assets/contacts_full_page1.xml
+- spec/assets/contacts_full_page2.xml
 - spec/assets/groups_full.xml
 - spec/base_spec.rb
 - spec/contact_spec.rb
@@ -126,18 +157,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Contacts API on steroids