googlecontacts 0.1.0

data/lib/google_contacts/proxies/emails.rb

@@ -0,0 +1,125 @@
+module GoogleContacts
+  module Proxies
+    class Emails < BlankSlate
+      def initialize(parent)
+        @parent = parent
+        reinitialize
+      end
+      
+      def reinitialize
+        @current = ::Hash[*@parent.xml.xpath("./gd:email").map do |entry|
+          email = Email.new(self, entry.attributes)
+          [email.address, email]
+        end.flatten]
+        
+        # create a deep copy
+        @new = ::Hash[*@current.map do |k,v|
+          [k.dup, v.dup]
+        end.flatten]
+      end
+      
+      def changed?
+        @current != @new
+      end
+      
+      def primary!(address)
+        @new.each do |key, email|
+          if key == address
+            email.primary = true
+          else
+            email.delete(:primary)
+          end
+        end
+      end
+      
+      def <<(address)
+        raise "Duplicate address" if @new[address]
+        add(address)
+      end
+      
+      def [](address)
+        @new[address] || add(address)
+      end
+      
+      def synchronize
+        @parent.remove_xml("./gd:email")
+        @new.each_pair do |address, email|
+          @parent.insert_xml('gd:email', email)
+        end
+      end
+      
+      private
+      def add(address)
+        set_primary = @new.empty?
+        @new[address] = Email.new(self, { :address => address })
+        @new[address].primary = true if set_primary
+        @new[address]
+      end
+      
+      def method_missing(sym, *args, &blk)
+        if [:size, :delete].include?(sym)
+          @new.send(sym, *args, &blk)
+        else
+          super
+        end
+      end
+      
+      class Email < ::HashWithIndifferentAccess
+        DEFAULTS = {
+          :rel => 'http://schemas.google.com/g/2005#home'
+        }.freeze
+        
+        alias_attribute :name, :displayName
+        
+        def initialize(parent, attributes = {})
+          super(DEFAULTS)
+          @parent = parent
+
+          attributes.each do |key, value|
+            send("#{key}=", value)
+          end
+        end
+        
+        def primary!
+          @parent.primary! self[:address]
+        end
+        
+        def rel=(arg)
+          delete(:label)
+          method_missing("rel=", arg)
+        end
+
+        def label=(arg)
+          delete(:rel)
+          method_missing("label=", arg)
+        end
+        
+        def []=(key, value)
+          if "#{key}" == 'address' && self[key]
+            raise "Cannot modify email address"
+          end
+          super(key, value.to_s)
+        end
+
+        def dup
+          self.class.new(@parent, self)
+        end
+
+        def method_missing(sym, *args, &blk)
+          if sym.to_s =~ /^(\w+)(=|\?)?$/
+            case $2
+            when '='
+              send(:[]=, $1, *args)
+            when '?'
+              send(:[], $1) == 'true'
+            else
+              send(:[], $1)
+            end
+          else
+            super
+          end
+        end
+      end # class Email
+    end # class Emails
+  end # module Proxies
+end # module GoogleContacts

data/lib/google_contacts/proxies/hash.rb

@@ -0,0 +1,41 @@
+module GoogleContacts
+  module Proxies
+    class Hash < BlankSlate
+      def initialize(parent, options)
+        @parent = parent
+        @tag    = options[:tag]
+        @key    = options[:key]
+        @value  = options[:value]
+        
+        reinitialize
+      end
+      
+      def reinitialize
+        @current = HashWithIndifferentAccess.new
+        @parent.xml.xpath("./#{@tag}").map do |entry|
+          @current[entry[@key]] = entry[@value]
+        end
+        
+        # create a deep copy
+        @new = HashWithIndifferentAccess.new
+        @current.each { |k,v| @new[k.dup] = v.dup }
+      end
+      
+      def changed?
+        @current != @new
+      end
+      
+      def synchronize
+        @parent.remove_xml("./#{@tag}")
+        @new.each_pair do |key, value|
+          @parent.insert_xml(@tag, @key => key, @value => value)
+        end
+      end
+      
+      private
+      def method_missing(sym, *args, &blk)
+        @new.send(sym, *args, &blk)
+      end
+    end # class Hash
+  end # module Proxies
+end # module GoogleContacts

data/lib/google_contacts/wrapper.rb

@@ -0,0 +1,126 @@
+module GoogleContacts
+  class Wrapper
+    attr_reader :consumer
+
+    CONTACTS_BATCH = "http://www.google.com/m8/feeds/contacts/default/full/batch".freeze
+    GROUPS_BATCH   = "http://www.google.com/m8/feeds/groups/default/full/batch".freeze
+
+    # Proxies for crud
+    attr_reader :contacts
+    attr_reader :groups
+    
+    def initialize(consumer)
+      @consumer = consumer
+      
+      @contacts = CollectionProxy.new(self, 'contacts')
+      @groups   = CollectionProxy.new(self, 'groups')
+    end
+
+    def get(url, options = {})
+      query = options.map { |k,v| "#{k}=#{v}" }.join('&')
+      url += "?#{query}" if query.size > 0
+
+      body = consumer.get(url).body
+      Nokogiri::XML.parse body
+    end
+    
+    def post(url, body)
+      consumer.post(url, body, 'Content-Type' => 'application/atom+xml')
+    end
+    
+    def batch(options = {}, &blk)
+      raise "Nesting of calls to batch is not allowed" if @batching
+      @batching = true
+      @batch ||= []
+
+      yield(blk)
+      @batching = false
+
+      # create documents to be flushed
+      documents = @batch.each_slice(100).map do |chunk|
+        batch_document(chunk)
+      end
+      @batch.clear
+      
+      if options[:return_documents]
+        documents
+      else
+        documents.each do |doc|
+          flush_batch(doc)
+        end
+      end
+    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)
+    end
+    
+    def save(instance)
+      entry = instance.entry_for_batch(instance.new? ? :insert : :update)
+      append_to_batch(entry)
+    end
+    
+    private
+    
+    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
+        end
+
+        @batch << entry
+      else
+        batch do
+          @batch << entry
+        end
+      end
+    end
+
+    # Use the <category/> tag of the first entry to find out
+    # which type we're flushing
+    def flush_batch(document)
+      url = case document.at('./xmlns:entry[1]/xmlns:category')['term']
+      when /#contact$/i
+        CONTACTS_BATCH
+      when /#group$/i
+        GROUPS_BATCH
+      else
+        raise "Unable to determine type for batch"
+      end
+      post(url, document.to_xml)
+    end
+    
+    def batch_document(*operations)
+      batch_feed = Base.feed_for_batch
+      operations.flatten.each do |operation|
+        batch_feed << operation
+      end
+      batch_feed
+    end
+    
+    class CollectionProxy
+      def initialize(wrapper, collection)
+        @wrapper    = wrapper
+        @collection = collection
+        @klass      = collection.singularize.camelcase.constantize
+      end
+      
+      # :what - all, ID, whatever, currently unused
+      def find(what, options = {})
+        @wrapper.find(@collection, options) do |entry|
+          @klass.new(@wrapper, entry)
+        end
+      end
+      
+      def build(attributes = {})
+        @klass.new(@wrapper)
+      end
+      
+    end # class CollectionProxy
+  end # class Wrapper
+end # module GoogleContacts

data/spec/assets/contacts_full.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>1</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/groups_full.xml

@@ -0,0 +1,58 @@
+<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/"D08MQnc-fSp7ImA9WxRbGU0."'>
+  <id>jo@gmail.com</id>
+  <updated>2008-12-10T10:44:43.955Z</updated>
+  <category scheme='http://schemas.google.com/g/2005#kind'
+    term='http://schemas.google.com/contact/2008#group' />
+  <title>Jo March's Contact Groups</title>
+  <link rel='alternate' type='text/html'
+    href='http://www.google.com/' />
+  <link rel='http://schemas.google.com/g/2005#feed'
+    type='application/atom+xml'
+    href='http://www.google.com/m8/feeds/groups/jo%40gmail.com/thin' />
+  <link rel='http://schemas.google.com/g/2005#post'
+    type='application/atom+xml'
+    href='http://www.google.com/m8/feeds/groups/jo%40gmail.com/thin' />
+  <link rel='http://schemas.google.com/g/2005#batch'
+    type='application/atom+xml'
+    href='http://www.google.com/m8/feeds/groups/jo%40gmail.com/thin/batch' />
+  <link rel='self'
+    type='application/atom+xml'
+    href='http://www.google.com/m8/feeds/groups/jo%40gmail.com/thin?max-results=25' />
+  <author>
+    <name>Jo March</name>
+    <email>jo@gmail.com</email>
+  </author>
+  <generator version='1.0'
+    uri='http://www.google.com/m8/feeds'>Contacts</generator>
+  <openSearch:totalResults>5</openSearch:totalResults>
+  <openSearch:startIndex>1</openSearch:startIndex>
+  <openSearch:itemsPerPage>25</openSearch:itemsPerPage>
+  <entry gd:etag='"YDwqeyI."'>
+    <id>http://www.google.com/m8/feeds/groups/jo%40gmail.com/base/6</id>
+    <updated>1970-01-01T00:00:00.000Z</updated>
+    <category scheme='http://schemas.google.com/g/2005#kind'
+      term='http://schemas.google.com/contact/2008#group' />
+    <title>System Group: My Contacts</title>
+    <content>System Group: My Contacts</content>
+    <link rel='self' type='application/atom+xml'
+      href='http://www.google.com/m8/feeds/groups/jo%40gmail.com/thin/6' />
+    <gContact:systemGroup id='Contacts' />
+  </entry>
+  <entry gd:etag='"Rn05fDVSLyp7ImA9WxRbGEUORQM."'>
+    <id>http://www.google.com/m8/feeds/groups/jo%40gmail.com/base/68f415478ba1aa69</id>
+    <updated>2008-12-10T04:44:37.324Z</updated>
+    <category scheme='http://schemas.google.com/g/2005#kind'
+      term='http://schemas.google.com/contact/2008#group' />
+    <title>joggers</title>
+    <content>joggers</content>
+    <link rel='self' type='application/atom+xml'
+      href='http://www.google.com/m8/feeds/groups/jo%40gmail.com/thin/68f415478ba1aa69' />
+    <link rel='edit' type='application/atom+xml'
+      href='http://www.google.com/m8/feeds/groups/jo%40gmail.com/thin/68f415478ba1aa69' />
+  </entry>
+</feed>

data/spec/base_spec.rb

@@ -0,0 +1,78 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class BaseTester < Base
+  CATEGORY_TERM = "i'm not used here"
+end
+
+describe Base do
+  it "should not be possible to create" do
+    lambda {
+      Base.new(wrapper, 'some xml')
+    }.should raise_error(/cannot create instance/i)
+  end
+  
+  describe "with an XML document" do
+    before(:each) do
+      @t = BaseTester.new(wrapper)
+    end
+    
+    it "should default namespace to document default" do
+      node = @t.insert_xml 'tag'
+      node.namespace.href.should == 'http://www.w3.org/2005/Atom'
+      @t.xpath('xmlns:tag').should have(1).node
+    end
+    
+    it "should set namespace when specified in tag" do
+      node = @t.insert_xml 'gd:extendedProperty'
+      node.namespace.href.should == 'http://schemas.google.com/g/2005'
+      @t.xpath('gd:extendedProperty').should have(1).node
+      
+      node = @t.insert_xml 'gContact:birthday'
+      node.namespace.href.should == 'http://schemas.google.com/contact/2008'
+      @t.xpath('gContact:birthday').should have(1).node
+    end
+    
+    it "should raise on unknown namespace" do
+      lambda {
+        @t.insert_xml 'unknown:foo'
+      }.should raise_error(/unknown namespace/i)
+    end
+    
+    it "should also set attributes if given" do
+      node = @t.insert_xml 'tag', :foo => 'bar'
+      node['foo'].should == 'bar'
+    end
+    
+    it "should allow removing xml" do
+      @t.insert_xml 'gd:extendedProperty'
+      @t.xpath('./gd:extendedProperty').should have(1).node
+
+      @t.remove_xml 'gd:extendedProperty'
+      @t.xpath('./gd:extendedProperty').should have(:no).nodes
+    end
+  end
+  
+  describe "prepare for batch operation" do
+    before(:all) do
+      @t = BaseTester.new(wrapper, parsed_asset('contacts_full').at('feed > entry'))
+      @batch = @t.entry_for_batch(:update)
+    end
+    
+    it "should not share the same document" do
+      @batch.document.should_not == @t.xml.document
+    end
+    
+    it "should create a duplicate node without link tags" do
+      @batch.xpath('./xmlns:link').should be_empty
+    end
+    
+    it "should remove the updated tag (not useful when updating)" do
+      @batch.xpath('./xmlns:updated').should be_empty
+    end
+    
+    it "should be possible to combine feed_for_batch and entry_for_batch" do
+      feed = BaseTester.feed_for_batch
+      feed << @t.entry_for_batch(:update)
+    end
+  end
+end