google_contacts_api 0.5.1 → 0.6.0

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/google_contacts_api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "google_contacts_api"
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alvin Liang"]
-  s.date = "2015-05-07"
+  s.date = "2015-06-15"
   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,10 +22,15 @@ module GoogleContactsApi
       _link ? _link.href : nil
     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" }
+    end
+
     # Returns link for photo
     # (still need authentication to get the photo data, though)
     def photo_link
-      _link = self["link"].find { |l| l.rel == "http://schemas.google.com/contacts/2008/rel#photo" }
+      _link = photo_link_entry
       _link ? _link.href : nil
     end
 
@@ -85,6 +90,21 @@ module GoogleContactsApi
       self["gd$im"] ? self["gd$im"].map { |i| i.address } : []
     end
 
+    def photo_with_metadata
+      # etag is always specified if actual photo is present
+      _link = photo_link_entry
+      return nil unless @api && _link['gd$etag']
+
+      response = @api.oauth.get(_link.href)
+      if GoogleContactsApi::Api.parse_response_code(response) == 200
+        {
+            etag: _link['gd$etag'].gsub('"',''),
+            content_type: response.headers['content-type'],
+            data: response.body
+        }
+      end
+    end
+
     # Convenience method to return a nested $t field.
     # If the field doesn't exist, return nil
     def nested_t_field_or_nil(level1, level2)
@@ -110,6 +130,12 @@ module GoogleContactsApi
     def name_suffix
       nested_t_field_or_nil 'gd$name', 'gd$nameSuffix'
     end
+    def birthday
+      if self['gContact$birthday']
+        day, month, year = self['gContact$birthday']['when'].split('-').reverse
+        { year: year == '' ? nil : year.to_i, month: month.to_i, day: day.to_i }
+      end
+    end
 
     def relations
       self['gContact$relation'] ? self['gContact$relation'] : []
@@ -123,46 +149,66 @@ module GoogleContactsApi
 
     # Return an Array of Hashes representing addresses with formatted metadata.
     def addresses
-      self['gd$structuredPostalAddress'] ? self['gd$structuredPostalAddress'].map(&method(:format_address)) : []
+      format_entities('gd$structuredPostalAddress', :format_address)
+    end
+    def organizations
+      format_entities('gd$organization')
+    end
+    def websites
+      format_entities('gContact$website')
     end
 
     # Return an Array of Hashes representing phone numbers with formatted metadata.
     def phone_numbers_full
-      self["gd$phoneNumber"] ? self["gd$phoneNumber"].map(&method(:format_phone_number)) : []
+      format_entities('gd$phoneNumber', :format_phone_number)
     end
 
     # Return an Array of Hashes representing emails with formatted metadata.
     def emails_full
-      self["gd$email"] ? self["gd$email"].map(&method(:format_email)) : []
+      format_entities('gd$email')
     end
 
   private
+    def format_entities(key, format_method=:format_entity)
+      self[key] ? self[key].map(&method(format_method)) : []
+    end
+
+    def format_entity(unformatted, default_rel=nil, text_key=nil)
+      attrs = Hash[unformatted.map { |key, value|
+        case key
+        when 'primary'
+          [:primary, value == true || value == 'true']
+        when 'rel'
+          [:rel, value.gsub('http://schemas.google.com/g/2005#', '')]
+        when '$t'
+          [text_key || key.underscore.to_sym, value]
+        else
+          [key.sub('gd$', '').underscore.to_sym, value['$t'] ? value['$t'] : value]
+        end
+      }]
+      attrs[:rel] ||= default_rel
+      attrs[:primary] = false if attrs[:primary].nil?
+      attrs
+    end
+
     def format_address(unformatted)
-      formatted = {}
-      formatted[:rel] = unformatted['rel'] ? unformatted['rel'].gsub('http://schemas.google.com/g/2005#', '') : 'work'
-      unformatted.delete 'rel'
-      unformatted.each do |key, value|
-        formatted[key.sub('gd$', '').underscore.to_sym] = value['$t']
-      end
-      formatted
+      address = format_entity(unformatted, 'work')
+      address[:street] ||= nil
+      address[:city] ||= nil
+      address[:region] ||= nil
+      address[:postcode] ||= nil
+      address[:country] = format_country(unformatted['gd$country'])
+      address.delete :formatted_address
+      address
     end
 
-    def format_email_or_phone(unformatted)
-      formatted = {}
-      unformatted.each do |key, value|
-        formatted[key.underscore.to_sym] = value ? value.gsub('http://schemas.google.com/g/2005#', '') : value
-      end
-      formatted[:primary] = unformatted['primary'] ? unformatted['primary'] == 'true' : false
-      formatted
+    def format_country(country)
+      return nil unless country
+      country['$t'].nil? || country['$t'] == '' ? country['code'] : country['$t']
     end
 
     def format_phone_number(unformatted)
-      unformatted[:number] = unformatted['$t']
-      unformatted.delete '$t'
-      format_email_or_phone unformatted
-    end
-    def format_email(unformatted)
-      format_email_or_phone unformatted
+      format_entity unformatted, nil, :number
     end
   end
-end
+end

data/spec/google_contacts_api_spec.rb

@@ -266,6 +266,14 @@ describe "GoogleContactsApi" do
     it "should return the right self link" do
       expect(@contact.self_link).to eq("https://www.google.com/m8/feeds/contacts/example%40gmail.com/full/0")
     end
+    it "should return the right photo link entry" do
+      expect(@contact.photo_link_entry).to eq({
+        "rel" => "http://schemas.google.com/contacts/2008/rel#photo",
+        "type" => "image/*",
+        "href" => "https://www.google.com/m8/feeds/photos/media/example%40gmail.com/0",
+        "gd$etag" => "\"dxt2DAEZfCp7ImA-AV4zRxBoPG4UK3owXBM.\""
+      })
+    end
     it "should return the right photo link" do
       expect(@contact.photo_link).to eq("https://www.google.com/m8/feeds/photos/media/example%40gmail.com/0")
     end
@@ -289,6 +297,22 @@ describe "GoogleContactsApi" do
       expect(@oauth).to receive("get").with(@contact.photo_link)
       @contact.photo
     end
+    it "should fetch a photo with metadata" do
+      @oauth = double("oauth")
+      allow(@oauth).to receive(:get).and_return(Hashie::Mash.new({
+         "body" => "some response",
+         "code" => 200,
+         "headers" => { "content-type" => "image/jpeg" }
+       }))
+      @api = double("api")
+      allow(@api).to receive(:oauth).and_return(@oauth)
+      @contact = GoogleContactsApi::Contact.new(@contact_json_hash, nil, @api)
+      expect(@oauth).to receive("get").with(@contact.photo_link)
+      expect(@contact.photo_with_metadata).to eq( { data: 'some response',
+                                                    etag: 'dxt2DAEZfCp7ImA-AV4zRxBoPG4UK3owXBM.',
+                                                    content_type: 'image/jpeg'
+                                                  } )
+    end
     # TODO: there isn't any phone number in here
     pending "should return all phone numbers"
     it "should return all e-mail addresses" do
@@ -331,6 +355,9 @@ describe "GoogleContactsApi" do
             'gd$familyName' => { '$t' => 'Doe' },
             'gd$fullName' => { '$t' => 'John Doe' }
           },
+          'gContact$birthday' => {
+            'when' => '1988-05-12'
+          },
           'gContact$relation' => [ { '$t' => 'Jane', 'rel' => 'spouse' } ],
           'gd$structuredPostalAddress' => [
             {
@@ -343,12 +370,11 @@ describe "GoogleContactsApi" do
             },
             {
               'rel' => 'http://schemas.google.com/g/2005#home',
+              'primary' => 'true',
               'gd$country' => { '$t' => 'United States of America' },
               'gd$formattedAddress' => { '$t' => "123 Far Ln.\nAnywhere\nMO\n67891\nUnited States of America" },
               'gd$city' => { '$t' => 'Anywhere' },
-              'gd$street' => { '$t' => '123 Far Ln.' },
-              'gd$region' => { '$t' => 'MO' },
-              'gd$postcode' => { '$t' => '67891' }
+              'gd$street' => { '$t' => '123 Far Ln.' }
             }
           ],
           'gd$email' => [
@@ -364,6 +390,13 @@ describe "GoogleContactsApi" do
               '$t' => '(123) 334-5158',
               'rel' => 'http://schemas.google.com/g/2005#mobile'
             }
+          ],
+          'gd$organization' => [
+            {
+              'gd$orgTitle' => { '$t' => 'Worker Person' },
+              'gd$orgName' => { '$t' => 'Example, Inc' },
+              'rel' => 'http://schemas.google.com/g/2005#other'
+            }
           ]
         )
       end
@@ -399,29 +432,23 @@ describe "GoogleContactsApi" do
         expect(@partly_empty.spouse).to be_nil
         expect(@contact_v3.spouse).to eq('Jane')
       end
+
+      it 'has birthday' do
+        expect(@empty.birthday).to be_nil
+        expect(@contact_v3.birthday).to eq({ year: 1988, month: 5, day: 12 })
+
+        contact_birthday_no_year = GoogleContactsApi::Contact.new('gContact$birthday' => { 'when' => '--05-12' })
+        expect(contact_birthday_no_year.birthday).to eq({ year: nil, month: 5, day: 12 })
+      end
       
       it 'has addresses' do
         expect(@empty.addresses).to eq([])
 
         formatted_addresses = [
-          {
-              :rel => 'work',
-              :country => 'United States of America',
-              :formatted_address => "2345 Long Dr. #232\nSomwhere\nIL\n12345\nUnited States of America",
-              :city => 'Somwhere',
-              :street => '2345 Long Dr. #232',
-              :region => 'IL',
-              :postcode => '12345'
-          },
-          {
-              :rel => 'home',
-              :country => 'United States of America',
-              :formatted_address => "123 Far Ln.\nAnywhere\nMO\n67891\nUnited States of America",
-              :city => 'Anywhere',
-              :street => '123 Far Ln.',
-              :region => 'MO',
-              :postcode => '67891'
-          }
+          { rel: 'work', primary: false, country: 'United States of America', city: 'Somwhere', street: '2345 Long Dr. #232',
+            region: 'IL', postcode: '12345' },
+          { rel: 'home', primary: true, country: 'United States of America', city: 'Anywhere', street: '123 Far Ln.',
+            region: nil, postcode: nil }
         ]
         expect(@contact_v3.addresses).to eq(formatted_addresses)
       end
@@ -434,6 +461,20 @@ describe "GoogleContactsApi" do
         expect(@empty.emails_full).to eq([])
         expect(@contact_v3.emails_full).to eq([ { :primary => true, :address => 'johnsmith@example.com', :rel => 'other' } ])
       end
+
+      it 'has organizations' do
+        expect(@empty.organizations).to eq([])
+
+        formatted_organizations = [
+          {
+            org_title: 'Worker Person',
+            org_name: 'Example, Inc',
+            primary: false,
+            rel: 'other'
+          }
+        ]
+        expect(@contact_v3.organizations).to eq(formatted_organizations)
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_contacts_api
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-07 00:00:00.000000000 Z
+date: 2015-06-15 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: -2026181777139974429
+      hash: -3275918105127347361
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: