google_contacts_api 0.2.2 → 0.2.3

data/spec/google_contacts_api_spec.rb

@@ -1,7 +1,196 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "Testgem" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+describe "GoogleContactsApi" do
+  describe "Api" do
+    before(:each) do
+      @oauth = double("oauth")
+      @oauth.stub(:get).and_return("get response")
+      @api = GoogleContactsApi::Api.new(@oauth)
+    end
+
+    it "should perform a get request using oauth returning json" do
+      # expectation should come before execution
+      @oauth.should_receive(:get).with(
+        GoogleContactsApi::Api::BASE_URL + "any_url?alt=json&param=param", {"header" => "header"})
+      @api.get("any_url",
+        {"param" => "param"},
+        {"header" => "header"}).should == ("get response")
+    end
+    # Not implemented yet
+    pending "should perform a post request using oauth"
+    pending "should perform a put request using oauth"
+    pending "should perform a delete request using oauth"
+  end
+  
+  describe "User" do
+    before(:each) do
+      @oauth = double("oauth")
+      @user = GoogleContactsApi::User.new(@oauth)
+      @user.api.stub(:get).and_return(Hashie::Mash.new({
+        "body" => "some response", # could use example response here
+        "code" => 200
+      }))
+      GoogleContactsApi::GroupSet.stub(:new).and_return("group set")
+      GoogleContactsApi::ContactSet.stub(:new).and_return("contact set")
+    end
+    # Should hit the right URLs and return the right stuff
+    it "should be able to get groups" do
+      @user.api.should_receive(:get).with("groups/default/full", anything, {"GData-Version" => "2"})
+      @user.groups.should == "group set"
+    end
+    it "should be able to get contacts" do
+      @user.api.should_receive(:get).with("contacts/default/full", anything)
+      @user.contacts.should == "contact set"
+    end
+  end
+  
+  describe "ResultSet" do
+    # no testing, it's just an implementation detail to use inheritance
+  end
+  
+  describe "ContactSet" do
+    before(:all) do
+      @contact_set_json = contact_set_json
+      @contact_set = GoogleContactsApi::ContactSet.new(@contact_set_json)
+    end
+
+    it "should return the right starting index" do
+      @contact_set.start_index.should == 1
+    end
+    it "should return the right number of results per page" do
+      @contact_set.items_per_page.should == 25
+    end
+    it "should return the right number of total results" do
+      @contact_set.total_results.should == 500
+    end
+    it "should tell me if there are more results" do
+      # yeah this is an awkward assertion and matcher
+      @contact_set.should be_has_more
+      @contact_set.has_more?.should == true
+    end
+    it "should parse results into Contacts" do
+      @contact_set.to_a.first.should be_instance_of(GoogleContactsApi::Contact)
+    end
+  end
+  
+  describe "GroupSet" do
+    before(:all) do
+      @group_set_json = group_set_json
+      @group_set = GoogleContactsApi::GroupSet.new(@group_set_json)
+    end
+
+    it "should return the right starting index" do
+      @group_set.start_index.should == 1
+    end
+    it "should return the right number of results per page" do
+      @group_set.items_per_page.should == 25
+    end
+    it "should return the right number of total results" do
+      @group_set.total_results.should == 5
+    end
+    it "should tell me if there are more results" do
+      # yeah this is an awkward assertion and matcher
+      @group_set.should_not be_has_more
+      @group_set.has_more?.should == false
+    end
+    it "should parse results into Groups" do
+      @group_set.to_a.first.should be_instance_of(GoogleContactsApi::Group)
+    end
+  end
+  
+  describe "Result" do
+    # no testing, it's just an implementation detail to inherit
+  end
+  
+  describe "Contact" do
+    before(:all) do
+      @contact_json_hash = contact_json_hash
+      @contact = GoogleContactsApi::Contact.new(@contact_json_hash)
+    end
+    # ok, these tests are kind of silly
+    it "should return the right title" do
+      @contact.title.should == "Contact 1"
+    end
+    it "should return the right id" do
+      @contact.id.should == "http://www.google.com/m8/feeds/contacts/example%40gmail.com/base/0"
+    end
+    it "should return the right content" do
+      # TODO: Nothing in source, oops
+      @contact.content.should == nil
+    end
+    it "should return the right updated time" do
+      # different representation slightly
+      @contact.updated.to_s.should == "2011-07-07T21:02:42+00:00"
+    end
+    it "should return the right self link" do
+      @contact.self_link.should == "https://www.google.com/m8/feeds/contacts/example%40gmail.com/full/0"
+    end
+    it "should return the right photo link" do
+      @contact.photo_link.should == "https://www.google.com/m8/feeds/photos/media/example%40gmail.com/0"
+    end
+    it "should return the right edit link" do
+      @contact.edit_link.should == "https://www.google.com/m8/feeds/contacts/example%40gmail.com/full/0"
+    end
+    it "should return the right edit photo link" do
+      # TODO: there isn't one in this contact, hahah
+      @contact.edit_photo_link.should == nil
+    end
+    it "should try to fetch a photo" do
+      @oauth = mock("oauth")
+      @oauth.stub(:get).and_return(Hashie::Mash.new({
+        "body" => "some response", # could use example response here
+        "code" => 200
+      }))
+      # @api = GoogleContactsApi::Api.new(@oauth)
+      @api = mock("api")
+      @api.stub(:oauth).and_return(@oauth)
+      @contact = GoogleContactsApi::Contact.new(@contact_json_hash, nil, @api)
+      @oauth.should_receive("get").with(@contact.photo_link)
+      @contact.photo
+    end
+    it "should return all e-mail addresses" do
+      @contact.emails.should == ["contact1@example.com"]
+    end
+    it "should return the right primary e-mail address" do
+      @contact.primary_email.should == "contact1@example.com"
+    end
+  end
+  
+  describe "Group" do
+    before(:all) do
+      @group_json_hash = group_json_hash
+      @group = GoogleContactsApi::Group.new(group_json_hash)
+    end
+    # ok, these tests are kind of silly
+    it "should return the right title" do
+      @group.title.should == "System Group: My Contacts"
+    end
+    it "should return the right id" do
+      @group.id.should == "http://www.google.com/m8/feeds/groups/example%40gmail.com/base/6"
+    end
+    it "should return the right content" do
+      # TODO: Nothing in source, oops
+      @group.content.should == "System Group: My Contacts"
+    end
+    it "should return the right updated time" do
+      # different representation slightly
+      @group.updated.to_s.should == "1970-01-01T00:00:00+00:00"
+    end
+    it "should tell me if it's a system group" do
+      @group.should be_system_group
+    end
+    it "should get contacts from the group and cache them" do
+      @api = mock("api")
+      @api.stub(:get).and_return(Hashie::Mash.new({
+        "body" => "some response", # could use example response here
+        "code" => 200
+      }))
+      GoogleContactsApi::ContactSet.stub(:new).and_return("contact set")
+      @group = GoogleContactsApi::Group.new(@contact_json_hash, nil, @api)
+      @api.should_receive("get").with(an_instance_of(String),
+        hash_including({"group" => @group.id})).once
+      @group.contacts
+      @group.contacts
+    end
   end
 end

data/spec/group_set.json

@@ -0,0 +1,213 @@
+{
+    "version": "1.0",
+    "encoding": "UTF-8",
+    "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/\"C0UESXY5eip7ImA9WhdTEkw.\"",
+        "id": {
+            "$t": "example@gmail.com"
+        },
+        "updated": {
+            "$t": "2011-07-09T11:33:28.822Z"
+        },
+        "category": [{
+            "scheme": "http://schemas.google.com/g/2005#kind",
+            "term": "http://schemas.google.com/contact/2008#group"
+        }],
+        "title": {
+            "$t": "Example User's Contact Groups"
+        },
+        "link": [{
+            "rel": "alternate",
+            "type": "text/html",
+            "href": "http://www.google.com/"
+        },
+        {
+            "rel": "http://schemas.google.com/g/2005#feed",
+            "type": "application/atom+xml",
+            "href": "https://www.google.com/m8/feeds/groups/example%40gmail.com/full"
+        },
+        {
+            "rel": "http://schemas.google.com/g/2005#post",
+            "type": "application/atom+xml",
+            "href": "https://www.google.com/m8/feeds/groups/example%40gmail.com/full"
+        },
+        {
+            "rel": "http://schemas.google.com/g/2005#batch",
+            "type": "application/atom+xml",
+            "href": "https://www.google.com/m8/feeds/groups/example%40gmail.com/full/batch"
+        },
+        {
+            "rel": "self",
+            "type": "application/atom+xml",
+            "href": "https://www.google.com/m8/feeds/groups/example%40gmail.com/full?alt\u003djson\u0026max-results\u003d25"
+        }],
+        "author": [{
+            "name": {
+                "$t": "Example User"
+            },
+            "email": {
+                "$t": "example@gmail.com"
+            }
+        }],
+        "generator": {
+            "version": "1.0",
+            "uri": "http://www.google.com/m8/feeds",
+            "$t": "Contacts"
+        },
+        "openSearch$totalResults": {
+            "$t": "5"
+        },
+        "openSearch$startIndex": {
+            "$t": "1"
+        },
+        "openSearch$itemsPerPage": {
+            "$t": "25"
+        },
+        "entry": [{
+            "gd$etag": "\"YDwqeyI.\"",
+            "id": {
+                "$t": "http://www.google.com/m8/feeds/groups/example%40gmail.com/base/6"
+            },
+            "updated": {
+                "$t": "1970-01-01T00:00:00.000Z"
+            },
+            "category": [{
+                "scheme": "http://schemas.google.com/g/2005#kind",
+                "term": "http://schemas.google.com/contact/2008#group"
+            }],
+            "title": {
+                "$t": "System Group: My Contacts"
+            },
+            "content": {
+                "$t": "System Group: My Contacts"
+            },
+            "link": [{
+                "rel": "self",
+                "type": "application/atom+xml",
+                "href": "https://www.google.com/m8/feeds/groups/example%40gmail.com/full/6"
+            }],
+            "gContact$systemGroup": {
+                "id": "Contacts"
+            }
+        },
+        {
+            "gd$etag": "\"YDwqeyI.\"",
+            "id": {
+                "$t": "http://www.google.com/m8/feeds/groups/example%40gmail.com/base/d"
+            },
+            "updated": {
+                "$t": "1970-01-01T00:00:00.000Z"
+            },
+            "category": [{
+                "scheme": "http://schemas.google.com/g/2005#kind",
+                "term": "http://schemas.google.com/contact/2008#group"
+            }],
+            "title": {
+                "$t": "System Group: Friends"
+            },
+            "content": {
+                "$t": "System Group: Friends"
+            },
+            "link": [{
+                "rel": "self",
+                "type": "application/atom+xml",
+                "href": "https://www.google.com/m8/feeds/groups/example%40gmail.com/full/d"
+            }],
+            "gContact$systemGroup": {
+                "id": "Friends"
+            }
+        },
+        {
+            "gd$etag": "\"YDwqeyI.\"",
+            "id": {
+                "$t": "http://www.google.com/m8/feeds/groups/example%40gmail.com/base/e"
+            },
+            "updated": {
+                "$t": "1970-01-01T00:00:00.000Z"
+            },
+            "category": [{
+                "scheme": "http://schemas.google.com/g/2005#kind",
+                "term": "http://schemas.google.com/contact/2008#group"
+            }],
+            "title": {
+                "$t": "System Group: Family"
+            },
+            "content": {
+                "$t": "System Group: Family"
+            },
+            "link": [{
+                "rel": "self",
+                "type": "application/atom+xml",
+                "href": "https://www.google.com/m8/feeds/groups/example%40gmail.com/full/e"
+            }],
+            "gContact$systemGroup": {
+                "id": "Family"
+            }
+        },
+        {
+            "gd$etag": "\"YDwqeyI.\"",
+            "id": {
+                "$t": "http://www.google.com/m8/feeds/groups/example%40gmail.com/base/f"
+            },
+            "updated": {
+                "$t": "1970-01-01T00:00:00.000Z"
+            },
+            "category": [{
+                "scheme": "http://schemas.google.com/g/2005#kind",
+                "term": "http://schemas.google.com/contact/2008#group"
+            }],
+            "title": {
+                "$t": "System Group: Coworkers"
+            },
+            "content": {
+                "$t": "System Group: Coworkers"
+            },
+            "link": [{
+                "rel": "self",
+                "type": "application/atom+xml",
+                "href": "https://www.google.com/m8/feeds/groups/example%40gmail.com/full/f"
+            }],
+            "gContact$systemGroup": {
+                "id": "Coworkers"
+            }
+        },
+        {
+            "gd$etag": "\"Q3c4fjVSLyp7ImA9WB9VEE4PRgQ.\"",
+            "id": {
+                "$t": "http://www.google.com/m8/feeds/groups/example%40gmail.com/base/270f"
+            },
+            "updated": {
+                "$t": "2007-11-25T23:58:22.936Z"
+            },
+            "app$edited": {
+                "xmlns$app": "http://www.w3.org/2007/app",
+                "$t": "2007-11-25T23:58:22.936Z"
+            },
+            "category": [{
+                "scheme": "http://schemas.google.com/g/2005#kind",
+                "term": "http://schemas.google.com/contact/2008#group"
+            }],
+            "title": {
+                "$t": "Non-system Group"
+            },
+            "content": {
+                "$t": "Non-system Group"
+            },
+            "link": [{
+                "rel": "self",
+                "type": "application/atom+xml",
+                "href": "https://www.google.com/m8/feeds/groups/example%40gmail.com/full/270f"
+            },
+            {
+                "rel": "edit",
+                "type": "application/atom+xml",
+                "href": "https://www.google.com/m8/feeds/groups/example%40gmail.com/full/270f"
+            }]
+        }]
+    }
+}

data/spec/spec_helper.rb

@@ -1,12 +1,36 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
+require 'json'
+require 'hashie'
 require 'google_contacts_api'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+# Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  
+  config.mock_framework = :rspec
 end
+
+def contact_set_json
+  f = File.open("#{File.dirname(__FILE__)}/contact_set.json")
+  json = f.read
+  f.close
+  json
+end
+
+def group_set_json
+  f = File.open("#{File.dirname(__FILE__)}/group_set.json")
+  json = f.read
+  f.close
+  json
+end
+
+def contact_json_hash
+  Hashie::Mash.new(JSON.parse(contact_set_json)).feed.entry.first
+end
+
+def group_json_hash
+  Hashie::Mash.new(JSON.parse(group_set_json)).feed.entry.first
+end

metadata

@@ -2,7 +2,7 @@
 name: google_contacts_api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Alvin Liang
@@ -139,7 +139,9 @@ files:
 - lib/google_contacts_api/result.rb
 - lib/google_contacts_api/result_set.rb
 - lib/google_contacts_api/user.rb
+- spec/contact_set.json
 - spec/google_contacts_api_spec.rb
+- spec/group_set.json
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/aliang/google_contacts_api
@@ -155,7 +157,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 620639544924636164
+      hash: 2324905511123203107
       segments: 
       - 0
       version: "0"