google_contacts_api 0.6.0 → 0.7.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Alvin Liang
+Copyright (c) 2011-15 Alvin Liang
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.markdown

@@ -78,7 +78,7 @@ by jeweler).
 
 ## Copyright
 
-Copyright (c) 2011-14 Alvin Liang (aliang). See LICENSE.txt for further details.
+Copyright (c) 2011-15 Alvin Liang (aliang). See LICENSE.txt for further details.
 
 Some code based on a few bugfixes in lfittl and fraudpointer forks.
 

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/google_contacts_api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "google_contacts_api"
-  s.version = "0.6.0"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alvin Liang"]
-  s.date = "2015-06-15"
+  s.date = "2015-07-24"
   s.description = "Lets you read from the Google Contacts API. Posting to come later."
   s.email = "ayliang@gmail.com"
   s.extra_rdoc_files = [

data/lib/google_contacts_api/contact.rb

@@ -22,6 +22,10 @@ module GoogleContactsApi
       _link ? _link.href : nil
     end
 
+    def etag
+      self['gd$etag']
+    end
+
     # Returns link entry for the photo
     def photo_link_entry
       self["link"].find { |l| l.rel == "http://schemas.google.com/contacts/2008/rel#photo" }
@@ -113,16 +117,25 @@ module GoogleContactsApi
       end
     end
     def given_name
-      nested_t_field_or_nil 'gd$name', 'gd$givenName'
+      nested_field_name_only 'gd$name', 'gd$givenName'
+    end
+    def given_name_yomi
+      nested_field_yomi_only 'gd$name', 'gd$givenName'
     end
     def family_name
-      nested_t_field_or_nil 'gd$name', 'gd$familyName'
+      nested_field_name_only 'gd$name', 'gd$familyName'
+    end
+    def family_name_yomi
+      nested_field_yomi_only 'gd$name', 'gd$familyName'
     end
     def full_name
       nested_t_field_or_nil 'gd$name', 'gd$fullName'
     end
     def additional_name
-      nested_t_field_or_nil 'gd$name', 'gd$additionalName'
+      nested_field_name_only 'gd$name', 'gd$additionalName'
+    end
+    def additional_name_yomi
+      nested_field_yomi_only 'gd$name', 'gd$additionalName'
     end
     def name_prefix
       nested_t_field_or_nil 'gd$name', 'gd$namePrefix'
@@ -152,7 +165,13 @@ module GoogleContactsApi
       format_entities('gd$structuredPostalAddress', :format_address)
     end
     def organizations
-      format_entities('gd$organization')
+      format_entities('gd$organization').map do |org|
+        if org[:org_name]
+          org[:org_name_yomi] = org[:org_name]['yomi'] if org[:org_name]['yomi']
+          org[:org_name] = name_only(org[:org_name])
+        end
+        org
+      end
     end
     def websites
       format_entities('gContact$website')
@@ -168,7 +187,42 @@ module GoogleContactsApi
       format_entities('gd$email')
     end
 
+    def group_membership_info
+      if self['gContact$groupMembershipInfo']
+        self['gContact$groupMembershipInfo'].map(&method(:format_group_membership))
+      else
+        []
+      end
+    end
+    def format_group_membership(membership)
+      { deleted: membership['deleted'] == 'true', href: membership['href'] }
+    end
+    def group_memberships
+      group_membership_info.select { |info| !info[:deleted] }.map { |info| info[:href] }
+    end
+    def deleted_group_memberships
+      group_membership_info.select { |info| info[:deleted] }.map { |info| info[:href] }
+    end
+
   private
+    def nested_field_name_only(level1, level2)
+      name_only(self[level1][level2]) if self[level1]
+    end
+
+    # Certain fields allow an optional Japanese yomigana subfield (making it
+    # sometimes be a hash which can cause a bug if you're expecteding a string)
+    # This normalizes the field to a string whether the yomi is present or not
+    # This method also accounts for any other unexpected fields
+    def name_only(name)
+      return name if name.blank?
+      return name if name.is_a?(String)
+      name['$t']
+    end
+
+    def nested_field_yomi_only(level1, level2)
+      self[level1][level2]['yomi'] if self[level1]
+    end
+
     def format_entities(key, format_method=:format_entity)
       self[key] ? self[key].map(&method(format_method)) : []
     end

data/lib/google_contacts_api/group.rb

@@ -8,6 +8,11 @@ module GoogleContactsApi
       !self["gContact$systemGroup"].nil?
     end
 
+    def system_group_id
+      return unless self.system_group?
+      self['gContact$systemGroup']['id']
+    end
+
     # Return the contacts in this group and cache them.
     def contacts(params = {})
       # contacts in this group
@@ -36,4 +41,4 @@ module GoogleContactsApi
       _link ? _link.href : nil
     end
   end
-end
+end

data/lib/google_contacts_api/result.rb

@@ -46,11 +46,11 @@ module GoogleContactsApi
     end
     
     def deleted?
-      raise NotImplementedError
+      self.key?('gd$deleted')
     end
     
     def inspect
       "<#{self.class}: #{title}>"
     end
   end
-end
+end

data/spec/google_contacts_api_spec.rb

@@ -240,7 +240,10 @@ describe "GoogleContactsApi" do
   end
 
   describe "Result" do
-    # no testing, it's just an implementation detail to inherit
+    it 'supports the deleted? method' do
+      expect(GoogleContactsApi::Result.new('gd$deleted' => {}).deleted?).to eq(true)
+      expect(GoogleContactsApi::Result.new.deleted?).to eq(false)
+    end
   end
 
   describe "Contact" do
@@ -397,6 +400,16 @@ describe "GoogleContactsApi" do
               'gd$orgName' => { '$t' => 'Example, Inc' },
               'rel' => 'http://schemas.google.com/g/2005#other'
             }
+          ],
+          'gContact$groupMembershipInfo' => [
+            {
+              'deleted' => 'false',
+              'href' => 'http://www.google.com/m8/feeds/groups/test.user%40gmail.com/base/111'
+            },
+            {
+              'deleted' => 'true',
+              'href' => 'http://www.google.com/m8/feeds/groups/test.user%40gmail.com/base/222'
+            }
           ]
         )
       end
@@ -408,13 +421,11 @@ describe "GoogleContactsApi" do
       end
 
       it 'has given_name' do
-        expect(@contact_v3).to receive(:nested_t_field_or_nil).with('gd$name', 'gd$givenName').and_return('val')
-        expect(@contact_v3.given_name).to eq('val')
+        expect(@contact_v3.given_name).to eq('John')
       end
 
       it 'has family_name' do
-        expect(@contact_v3).to receive(:nested_t_field_or_nil).with('gd$name', 'gd$familyName').and_return('val')
-        expect(@contact_v3.family_name).to eq('val')
+        expect(@contact_v3.family_name).to eq('Doe')
       end
 
       it 'has full_name' do
@@ -475,6 +486,56 @@ describe "GoogleContactsApi" do
         ]
         expect(@contact_v3.organizations).to eq(formatted_organizations)
       end
+
+      it 'has group membership info' do
+        expect(@empty.group_membership_info).to eq([])
+
+        group_membership_info = [
+          { deleted: false, href: 'http://www.google.com/m8/feeds/groups/test.user%40gmail.com/base/111' },
+          { deleted: true, href: 'http://www.google.com/m8/feeds/groups/test.user%40gmail.com/base/222' }
+        ]
+        expect(@contact_v3.group_membership_info).to eq(group_membership_info)
+      end
+
+      it 'has group memberships' do
+        expect(@contact_v3.group_memberships).to eq(['http://www.google.com/m8/feeds/groups/test.user%40gmail.com/base/111'])
+      end
+
+      it 'has deleted group memberships' do
+        expect(@contact_v3.deleted_group_memberships).to eq(['http://www.google.com/m8/feeds/groups/test.user%40gmail.com/base/222'])
+      end
+    end
+
+    # The Google Contacts API (https://developers.google.com/gdata/docs/2.0/elements)
+    # specifies an optional yomi field for orgName, givenName, additionalName and familyName
+    it 'handles Japanese yomigana "yomi" name values' do
+      contact_params = {
+        'gd$name' => {
+          'gd$givenName' => {'$t' => 'John' },
+          'gd$additionalName' => {'$t' => 'Text name', 'yomi' => 'And yomi chars' },
+          'gd$familyName' => { 'yomi' => 'Yomi chars only' },
+        },
+        'gd$organization' => [{
+          'rel' => 'http://schemas.google.com/g/2005#other',
+          'primary' => 'true',
+          'gd$orgName' => {
+            'yomi' => 'Yomigana'
+          }
+        }],
+      }
+      contact = GoogleContactsApi::Contact.new(contact_params, nil, @api)
+
+      expect(contact.given_name).to eq('John')
+      expect(contact.given_name_yomi).to be_nil
+
+      expect(contact.additional_name).to eq('Text name')
+      expect(contact.additional_name_yomi).to eq('And yomi chars')
+
+      expect(contact.family_name).to be_nil
+      expect(contact.family_name_yomi).to eq('Yomi chars only')
+
+      expect(contact.organizations.first[:org_name]).to be_nil
+      expect(contact.organizations.first[:org_name_yomi]).to eq('Yomigana')
     end
   end
 
@@ -501,6 +562,14 @@ describe "GoogleContactsApi" do
     it "should tell me if it's a system group" do
       expect(@group).to be_system_group
     end
+    it 'tells the system group id or nil if not a system group' do
+      expect(@group).to be_system_group
+      expect(@group.system_group_id).to eq('Contacts')
+
+      @group.delete('gContact$systemGroup')
+      expect(@group).to_not be_system_group
+      expect(@group.system_group_id).to be_nil
+    end
     describe ".contacts" do
       before(:each) do
         @api = double("api")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_contacts_api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-15 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -236,7 +236,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3275918105127347361
+      hash: -2507649345760241403
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: