googlecontacts 0.1.4 → 0.1.5

data/.autotest

@@ -0,0 +1,18 @@
+Autotest.add_hook :initialize do |at|
+  at.clear_mappings
+
+  # scope to google_contacts directory
+  at.add_mapping(%r%^lib/google_contacts/(.*)\.rb$%) do |_, m|
+    at.files_matching %r%^spec/#{m[1]}_spec\.rb$%
+  end
+  
+  # run specs on change
+  at.add_mapping(%r%^spec/(.*)_spec\.rb$%) do |filename, _|
+    filename
+  end
+  
+  # run all specs when helper changes
+  at.add_mapping(%r%^spec/spec_helper\.rb$%) do
+    at.files_matching %r%^spec/.*_spec\.rb$%
+  end
+end

data/README.md

@@ -39,3 +39,14 @@
       # Set the last one as primary
       john.emails.primary('fuckinghipster@hotmail.com')
     end
+
+
+@wrapper.batch do
+	1000.times do |i|
+		c = @wrapper.contacts.build
+		c.name = "John %03d" % i
+		c.email = "foo%03d@bar.com" % i
+		c.save
+	end
+end
+

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/lib/google_contacts/base.rb

@@ -8,75 +8,55 @@ module GoogleContacts
       'gd'          => 'http://schemas.google.com/g/2005',
     }.freeze
 
-    # DEFAULT_NAMESPACE = 'http://www.w3.org/2005/Atom'.freeze
-    
     attr_reader :xml
     def initialize(wrapper, xml = nil)
       raise "Cannot create instance of Base" if self.class.name.split(/::/).last == 'Base'
       @wrapper = wrapper
-      @xml     = self.class.decorate_with_namespaces(xml || initialize_xml_document)
-      @proxies = HashWithIndifferentAccess.new
-    end
-    
-    def self.namespace(node, prefix)
-      node.namespace_definitions.find do |ns|
-        ns.prefix == prefix
+
+      # If a root node is given, create a new XML document based on
+      # a deep copy. Otherwise, initialize a new XML document.
+      @xml = if xml.present?
+        self.class.new_xml_document(xml).root
+      else
+        self.class.initialize_xml_document.root
       end
+
+      @proxies = HashWithIndifferentAccess.new
     end
-    
-    def self.insert_xml(parent, tag, attributes = {}, &blk)
-      # Construct new node with the right namespace
-      matches = tag.match /^((\w+):)?(\w+)$/
-      ns      = matches[2] == 'xmlns' ? 'atom' : (matches[2] || 'atom')
-      tag     = matches[3]
-      node = Nokogiri::XML::Node.new(tag, parent)
-      node.namespace = namespace(parent, ns) || raise("Unknown namespace: #{ns}")
 
-      attributes.each_pair do |k,v|
-        node[k.to_s] = v.to_s
+    def attributes=(attrs)
+      attrs.each_pair do |key, value|
+        send("#{key}=", value)
       end
-      
-      parent << node
-      yield node if block_given?
-      node
-    end
-    
-    def remove_xml(tag)
-      @xml.xpath(tag).remove
     end
     
     def insert_xml(tag, attributes = {}, &blk)
       self.class.insert_xml(@xml, tag, attributes, &blk)
     end
     
-    def self.feed_for_batch
-      xml = Nokogiri::XML::Document.new
-      xml.root = decorate_with_namespaces(Nokogiri::XML::Node.new('feed', xml))
-      xml.root
+    def remove_xml(tag)
+      @xml.xpath(tag).remove
     end
     
-    def xml_copy
-      doc = Nokogiri::XML::Document.new
-      doc.root = self.class.decorate_with_namespaces(xml.dup)
-      doc.root
+    def self.feed_for_batch
+      new_xml_document('feed').root
     end
     
     # Create new XML::Document that can be used in a
     # Google Contacts batch operation.
     def entry_for_batch(operation)
-      doc = Nokogiri::XML::Document.new
-      doc.root = self.class.decorate_with_namespaces(xml.dup) # This automatically dups xml
-      doc.root.xpath('./xmlns:link'   ).remove
-      doc.root.xpath('./xmlns:updated').remove
+      root = self.class.new_xml_document(xml).root
+      root.xpath('./xmlns:link'   ).remove
+      root.xpath('./xmlns:updated').remove
 
-      if operation == :update || operation == :destroy
-        doc.root.at('./xmlns:id').content = url(:edit)
+      if operation == :update || operation == :delete
+        root.at('./xmlns:id').content = url(:edit)
       end
       
-      self.class.insert_xml(doc.root, 'batch:id')
-      self.class.insert_xml(doc.root, 'batch:operation', :type => operation)
+      self.class.insert_xml(root, 'batch:id')
+      self.class.insert_xml(root, 'batch:operation', :type => operation)
       
-      doc.root
+      root
     end
     
     def new?
@@ -97,13 +77,18 @@ module GoogleContacts
     end
     
     def changed?
-      new? || @proxies.values.any?(&:changed?)
+      @proxies.values.any?(&:changed?)
     end
     
     def save
       return unless changed?
       synchronize_proxies
-      @wrapper.save(self)
+      @wrapper.append_operation(self, new? ? :insert : :update)
+    end
+    
+    def delete
+      return if new?
+      @wrapper.append_operation(self, :delete)
     end
     
     protected
@@ -128,24 +113,55 @@ module GoogleContacts
       end
     end
     
-    def initialize_xml_document
-      xml = Nokogiri::XML::Document.new
-      xml.root = Nokogiri::XML::Node.new('entry', xml)
-
-      category = Nokogiri::XML::Node.new('category', xml)
-      category['scheme'] = 'http://schemas.google.com/g/2005#kind'
-      category['term'  ] = self.class.const_get(:CATEGORY_TERM)
-      xml.root << category
+    def self.namespace(node, prefix)
+      node.namespace_definitions.find do |ns|
+        ns.prefix == prefix
+      end
+    end
+    
+    def self.insert_xml(parent, tag, attributes = {}, &blk)
+      # Construct new node with the right namespace
+      matches = tag.match /^((\w+):)?(\w+)$/
+      ns      = matches[2] == 'xmlns' ? 'atom' : (matches[2] || 'atom')
+      tag     = matches[3]
+      node = Nokogiri::XML::Node.new(tag, parent)
+      node.namespace = namespace(parent, ns) || raise("Unknown namespace: #{ns}")
 
-      xml.root
+      attributes.each_pair do |k,v|
+        node[k.to_s] = v.to_s
+      end
+      
+      parent << node
+      yield node if block_given?
+      node
     end
     
-    def self.decorate_with_namespaces(node)
-      node.default_namespace = NAMESPACES['atom']
+    def self.new_xml_document(root)
+      doc = Nokogiri::XML::Document.new
+      if root.is_a?(Nokogiri::XML::Element)
+        doc.root = root.dup(1)
+      else
+        doc.root = Nokogiri::XML::Node.new(root, doc)
+      end
+      decorate_document_with_namespaces(doc)
+      doc
+    end
+    
+    def self.initialize_xml_document
+      doc = new_xml_document('entry')
+      insert_xml(doc.root, 'atom:category', {
+        :scheme => 'http://schemas.google.com/g/2005#kind',
+        :term   => const_get(:CATEGORY_TERM)
+      })
+      doc
+    end
+    
+    def self.decorate_document_with_namespaces(doc)
+      doc.root.default_namespace = NAMESPACES['atom']
       NAMESPACES.each_pair do |prefix, href|
-        node.add_namespace(prefix, href)
+        doc.root.add_namespace(prefix, href)
       end
-      node
+      doc
     end
   end
 end

data/lib/google_contacts/group.rb

@@ -2,6 +2,12 @@ module GoogleContacts
   class Group < Base
     CATEGORY_TERM = 'http://schemas.google.com/g/2005#group'
     
+    alias_attribute :name, :title
+    def initialize(*args)
+      super
+      register_proxy :title,  Proxies::Tag.new(self, :tag => 'xmlns:title')
+    end
+
     def system_group?
       @xml.xpath('.//gContact:systemGroup').size > 0
     end

data/lib/google_contacts/wrapper.rb

@@ -8,10 +8,10 @@ module GoogleContacts
     # Proxies for crud
     attr_reader :contacts
     attr_reader :groups
-    
+
     def initialize(consumer)
       @consumer = consumer
-      
+
       @contacts = CollectionProxy.new(self, Contact)
       @groups   = CollectionProxy.new(self, Group)
     end
@@ -23,11 +23,11 @@ module GoogleContacts
       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
@@ -41,7 +41,7 @@ module GoogleContacts
         batch_document(chunk)
       end
       @batch.clear
-      
+
       if options[:return_documents]
         documents
       else
@@ -50,16 +50,16 @@ module GoogleContacts
         end
       end
     end
-    
+
     def find(what, options = {}, &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
@@ -68,19 +68,19 @@ module GoogleContacts
 
       result
     end
-    
-    def save(instance)
-      entry = instance.entry_for_batch(instance.new? ? :insert : :update)
+
+    def append_operation(instance, operation)
+      entry = instance.entry_for_batch(operation)
       append_to_batch(entry)
     end
-    
+
     private
-    
+
     def append_to_batch(entry)
       if @batching
         if @batch.present?
-          batch_term = @batch.last.at('./category')['term']
-          entry_term =       entry.at('./category')['term']
+          batch_term = @batch.last.at('./atom:category')['term']
+          entry_term =       entry.at('./atom:category')['term']
           raise "Cannot mix Contact and Group in one batch" if batch_term != entry_term
         end
 
@@ -105,7 +105,7 @@ module GoogleContacts
       end
       post(url, document.to_xml)
     end
-    
+
     def batch_document(*operations)
       batch_feed = Base.feed_for_batch
       operations.flatten.each do |operation|
@@ -113,25 +113,27 @@ module GoogleContacts
       end
       batch_feed
     end
-    
+
     class CollectionProxy
       def initialize(wrapper, klass)
         @wrapper    = wrapper
         @klass      = klass
         @collection = klass.name.demodulize.pluralize.underscore
       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)
+        returning(@klass.new(@wrapper)) do |instance|
+          instance.attributes = attributes
+        end
       end
-      
+
     end # class CollectionProxy
   end # class Wrapper
 end # module GoogleContacts

data/spec/base_spec.rb

@@ -19,7 +19,7 @@ describe GoogleContacts::Base do
     it "should default namespace to document default" do
       node = @t.insert_xml 'tag'
       node.namespace.href.should == 'http://www.w3.org/2005/Atom'
-      @t.xml.xpath('xmlns:tag').should have(1).node
+      @t.xml.xpath('atom:tag').should have(1).node
     end
     
     it "should set namespace when specified in tag" do
@@ -52,6 +52,44 @@ describe GoogleContacts::Base do
     end
   end
   
+  describe "basic crud" do
+    before(:each) do
+      @wrapper = wrapper
+      @entry   = GoogleContacts::BaseTester.new(@wrapper)
+    end
+    
+    # It is not sane to try and save a default entry
+    it "should not save when an entry is new but has no changed fields" do
+      @entry.stubs(:new? => true, :changed? => false)
+      @wrapper.expects(:append_operation).never
+      @entry.save
+    end
+    
+    it "should save when an entry is new and has changed fields" do
+      @entry.stubs(:new? => true, :changed? => true)
+      @wrapper.expects(:append_operation).with(@entry, :insert)
+      @entry.save
+    end
+    
+    it "should save when an entry has changed fields" do
+      @entry.stubs(:new? => false, :changed? => true)
+      @wrapper.expects(:append_operation).with(@entry, :update)
+      @entry.save
+    end
+    
+    it "should not delete when an entry is new" do
+      @entry.stubs(:new? => true)
+      @wrapper.expects(:append_operation).never
+      @entry.delete
+    end
+    
+    it "should delete when an entry is not new" do
+      @entry.stubs(:new? => false)
+      @wrapper.expects(:append_operation).with(@entry, :delete)
+      @entry.delete
+    end
+  end
+  
   describe "prepare for batch operation" do
     before(:all) do
       @t = GoogleContacts::BaseTester.new(wrapper, parsed_asset('contacts_full').at('feed > entry'))
@@ -63,16 +101,27 @@ describe GoogleContacts::Base do
     end
     
     it "should create a duplicate node without link tags" do
-      @batch.xpath('./xmlns:link').should be_empty
+      @batch.xpath('./atom:link').should be_empty
+    end
+    
+    it "should not touch the category tag" do
+      @batch.xpath('./atom:category').should_not be_nil
     end
     
     it "should remove the updated tag (not useful when updating)" do
-      @batch.xpath('./xmlns:updated').should be_empty
+      @batch.xpath('./atom:updated').should be_empty
     end
     
     it "should be possible to combine feed_for_batch and entry_for_batch" do
       feed = GoogleContacts::BaseTester.feed_for_batch
       feed << @t.entry_for_batch(:update)
     end
+    
+    it "should corretly set the batch:operation tag" do
+      %(insert update delete).each do |op|
+        batch = @t.entry_for_batch(op.to_sym)
+        batch.at('./batch:operation')['type'].should == op
+      end
+    end
   end
 end

data/spec/contact_spec.rb

@@ -49,10 +49,10 @@ describe GoogleContacts::Contact do
     
     describe "updating" do
       it "should update the title-tag" do
-        @contact.xml.at('./xmlns:title').content.should == 'Fitzwilliam Darcy'
+        @contact.xml.at('./atom:title').content.should == 'Fitzwilliam Darcy'
         @contact.title = 'foo'
         @contact.title.synchronize
-        @contact.xml.at('./xmlns:title').content.should == 'foo'
+        @contact.xml.at('./atom:title').content.should == 'foo'
       end
     end
   end
@@ -69,7 +69,7 @@ describe GoogleContacts::Contact do
     end
     
     it "should set the right category term" do
-      @root.at_xpath('./category')['term'].should == 'http://schemas.google.com/contact/2008#contact'
+      @root.at_xpath('./atom:category')['term'].should == 'http://schemas.google.com/contact/2008#contact'
     end
     
     it "should not have an id" do
@@ -80,8 +80,12 @@ describe GoogleContacts::Contact do
       @contact.updated_at.should be_nil
     end
     
-    it "should always be changed" do
-      @contact.changed?.should be_true
+    it "should be new" do
+      @contact.new?.should be_true
+    end
+    
+    it "should not be changed" do
+      @contact.changed?.should be_false
     end
     
     it "should have no groups" do
@@ -102,10 +106,10 @@ describe GoogleContacts::Contact do
     
     describe "when updating" do
       it "should update the title-tag" do
-        @contact.xml.at('./xmlns:title').should be_nil
+        @contact.xml.at('./atom:title').should be_nil
         @contact.title = 'foo'
         @contact.title.synchronize
-        @contact.xml.at('./xmlns:title').content.should == 'foo'
+        @contact.xml.at('./atom:title').content.should == 'foo'
       end
     end
   end

data/spec/group_spec.rb

@@ -11,6 +11,10 @@ describe GoogleContacts::Group do
     @group.id.should == 'http://www.google.com/m8/feeds/groups/jo%40gmail.com/base/6'
   end
   
+  it "should initialize the title tag" do
+    @group.title.should == 'System Group: My Contacts'
+  end
+  
   it "should know when it is a system group" do
     @groups[0].system_group?.should be_true
     @groups[1].system_group?.should be_false

data/spec/wrapper_spec.rb

@@ -55,8 +55,8 @@ describe GoogleContacts::Wrapper do
     it "should collect operations in a batch" do
       wrapper.expects(:post).never
       document = wrapper.batch(:return_documents => true) do
-        wrapper.contacts.build.save
-        wrapper.contacts.build.save
+        wrapper.contacts.build(:name => 'c1').save
+        wrapper.contacts.build(:name => 'c2').save
       end.first
       
       document.xpath('.//xmlns:entry').should have(2).entries
@@ -68,7 +68,7 @@ describe GoogleContacts::Wrapper do
     it "should flush batches in chunks of 100" do
       wrapper.expects(:post).with(regexp_matches(%r!/contacts/!), is_a(String)).twice
       wrapper.batch do
-        contact = wrapper.contacts.build
+        contact = wrapper.contacts.build(:name => 'contact')
         101.times { contact.save }
       end
     end
@@ -81,20 +81,20 @@ describe GoogleContacts::Wrapper do
     it "should raise when mixing contacts and groups in one batch" do
       lambda {
         wrapper.batch {
-          wrapper.contacts.build.save
-          wrapper.groups.build.save
+          wrapper.contacts.build(:name => 'contact').save
+          wrapper.groups.build(:name => 'group').save
         }
       }.should raise_error(/cannot mix/i)
     end
     
     it "should POST a single-operation batch to contacts when not batching" do
       wrapper.expects(:post).with(regexp_matches(%r!/contacts/!), is_a(String))
-      wrapper.contacts.build.save
+      wrapper.contacts.build(:name => 'contact').save
     end
 
     it "should POST a single-operation batch to groups when not batching" do
       wrapper.expects(:post).with(regexp_matches(%r!/groups/!), is_a(String))
-      wrapper.groups.build.save
+      wrapper.groups.build(:name => 'group').save
     end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Pieter Noordhuis
@@ -112,6 +112,7 @@ extra_rdoc_files:
 - README.md
 - README.rdoc
 files: 
+- .autotest
 - .document
 - .gitignore
 - LICENSE