google_contacts_api 0.4.2 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/google_contacts_api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "google_contacts_api"
-  s.version = "0.4.2"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alvin Liang"]
-  s.date = "2014-09-26"
+  s.date = "2014-09-27"
   s.description = "Lets you read from the Google Contacts API. Posting to come later."
   s.email = "ayliang@gmail.com"
   s.extra_rdoc_files = [
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
     "lib/google_contacts_api/contacts.rb",
     "lib/google_contacts_api/group.rb",
     "lib/google_contacts_api/group_set.rb",
+    "lib/google_contacts_api/groups.rb",
     "lib/google_contacts_api/result.rb",
     "lib/google_contacts_api/result_set.rb",
     "lib/google_contacts_api/user.rb",

data/lib/google_contacts_api/contacts.rb

@@ -2,7 +2,7 @@
 module GoogleContactsApi
   module Contacts
     # Retrieve the contacts for this user or group
-    def contacts(params = {})
+    def get_contacts(params = {})
       # TODO: Should return empty ContactSet (haven't implemented one yet)
       return [] unless @api
       params = params.with_indifferent_access

data/lib/google_contacts_api/group.rb

@@ -11,13 +11,14 @@ module GoogleContactsApi
     # Return the contacts in this group and cache them.
     def contacts(params = {})
       # contacts in this group
-      @contacts ||= super({"group" => self.id}.merge(params))
+      @contacts ||= get_contacts({"group" => self.id}.merge(params))
     end
 
     # Return the contacts in this group, retrieving them again from the server.
     def contacts!(params = {})
       # contacts in this group
-      @contacts = super({"group" => self.id}.merge(params))
+      @contacts = nil
+      contacts
     end
 
     # Returns the array of links, as link is an array for Hashie.

data/lib/google_contacts_api/groups.rb

@@ -0,0 +1,33 @@
+# Module that implements a method to get groups for a user
+module GoogleContactsApi
+  module Groups
+    # Retrieve the contacts for this user or group
+    def get_groups(params = {})
+      params = params.with_indifferent_access
+      # compose params into a string
+      # See http://code.google.com/apis/contacts/docs/3.0/reference.html#Parameters
+      # alt, q, max-results, start-index, updated-min,
+      # orderby, showdeleted, requirealldeleted, sortorder
+      params["max-results"] = 100000 unless params.key?("max-results")
+
+      # Set the version, for some reason the header is not effective on its own?
+      params["v"] = 2
+
+      url = "groups/default/full"
+      # TODO: So weird thing, version 3 doesn't return system groups
+      # When it does, uncomment this line and use it to request instead
+      # response = @api.get(url, params)
+      response = @api.get(url, params)
+
+      case GoogleContactsApi::Api.parse_response_code(response)
+      # TODO: Better handle 401, 403, 404
+      when 401; raise
+      when 403; raise
+      when 404; raise
+      when 400...500; raise
+      when 500...600; raise
+      end
+      GoogleContactsApi::GroupSet.new(response.body, @api)
+    end
+  end
+end

data/lib/google_contacts_api/user.rb

@@ -1,39 +1,35 @@
 module GoogleContactsApi
   class User
     include GoogleContactsApi::Contacts
+    include GoogleContactsApi::Groups
     
     attr_reader :api
     def initialize(oauth)
       @api = GoogleContactsApi::Api.new(oauth)
     end
 
-    # Retrieve the groups for this user.
-    def groups(params = {})
-      params = params.with_indifferent_access
-      # compose params into a string
-      # See http://code.google.com/apis/contacts/docs/3.0/reference.html#Parameters
-      # alt, q, max-results, start-index, updated-min,
-      # orderby, showdeleted, requirealldeleted, sortorder
-      params["max-results"] = 100000 unless params.key?("max-results")
+    # Return the contacts for this user and cache them.
+    def contacts(params = {})
+      # contacts in this group
+      @contacts ||= get_contacts(params)
+    end
 
-      # Set the version, for some reason the header is not effective on its own?
-      params["v"] = 2
+    # Return the contacts for this user, retrieving them again from the server.
+    def contacts!(params = {})
+      # contacts in this group
+      @contacts = nil
+      contacts
+    end
 
-      url = "groups/default/full"
-      # TODO: So weird thing, version 3 doesn't return system groups
-      # When it does, uncomment this line and use it to request instead
-      # response = @api.get(url, params)
-      response = @api.get(url, params)
+    # Return the groups for this user and cache them.
+    def groups(params = {})
+      @groups ||= get_groups(params)
+    end
 
-      case GoogleContactsApi::Api.parse_response_code(response)
-      # TODO: Better handle 401, 403, 404
-      when 401; raise
-      when 403; raise
-      when 404; raise
-      when 400...500; raise
-      when 500...600; raise
-      end
-      GoogleContactsApi::GroupSet.new(response.body, @api)
+    # Return the groups for this user, retrieving them again from the server.
+    def groups!(params = {})
+      @groups = nil
+      groups
     end
   end
 end

data/lib/google_contacts_api/version.rb

@@ -1,8 +1,8 @@
 module GoogleContactsApi
   module Version
     MAJOR = 0
-    MINOR = 4
-    PATCH = 2
+    MINOR = 5
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/google_contacts_api.rb

@@ -1,5 +1,6 @@
 require 'google_contacts_api/api'
 require 'google_contacts_api/contacts'
+require 'google_contacts_api/groups'
 require 'google_contacts_api/user'
 require 'google_contacts_api/result_set'
 require 'google_contacts_api/group_set'

data/spec/google_contacts_api_spec.rb

@@ -75,30 +75,90 @@ describe "GoogleContactsApi" do
     end
   end
 
-  describe "User" do
-    before(:each) do
-      @oauth = double("oauth")
-      @user = GoogleContactsApi::User.new(@oauth)
-      allow(@user.api).to receive(:get).and_return(Hashie::Mash.new({
-        "body" => "some response", # could use example response here
-        "code" => 200
-      }))
-      allow(GoogleContactsApi::GroupSet).to receive(:new).and_return("group set")
-      allow(GoogleContactsApi::ContactSet).to receive(:new).and_return("contact set")
+  describe GoogleContactsApi::Contacts do
+    let(:api) { double("api") }
+    let(:test_class) {
+      Class.new do
+        include GoogleContactsApi::Contacts
+        def initialize(api)
+          @api = api
+        end
+      end
+    }
+    describe ".get_contacts" do
+      it "should get the contacts using the internal @api object" do
+        expect(api).to receive(:get).with("contacts/default/full", kind_of(Hash)).and_return(Hashie::Mash.new({
+          "body" => "some response", # could use example response here
+          "code" => 200
+        }))
+        allow(GoogleContactsApi::ContactSet).to receive(:new).and_return("contact set")
+        expect(test_class.new(api).get_contacts).to eq("contact set")
+      end
+    end
+  end
+
+  describe GoogleContactsApi::Groups do
+    let(:api) { double("api") }
+    let(:test_class) {
+      Class.new do
+        include GoogleContactsApi::Groups
+        def initialize(api)
+          @api = api
+        end
+      end
+    }
+    describe ".get_groups" do
+      it "should get the groups using the internal @api object" do
+        expect(api).to receive(:get).with("groups/default/full", hash_including(:v => 2)).and_return(Hashie::Mash.new({
+          "body" => "some response", # could use example response here
+          "code" => 200
+        }))
+        allow(GoogleContactsApi::GroupSet).to receive(:new).and_return("group set")
+        expect(test_class.new(api).get_groups).to eq("group set")
+      end
     end
+  end
+
+  describe GoogleContactsApi::User do
+    let(:oauth) { double ("oauth") }
+    let(:user) { GoogleContactsApi::User.new(@oauth) }
+
     # Should hit the right URLs and return the right stuff
-    it "should be able to get groups including system groups" do
-      expect(@user.api).to receive(:get).with("groups/default/full", hash_including(:v => 2))
-      expect(@user.groups).to eq("group set")
+    describe ".groups" do
+      it "should be able to get groups including system groups" do
+        expect(user).to receive(:get_groups).and_return("group set")
+        expect(user.groups).to eq("group set")
+      end
     end
-    it "should be able to get contacts" do
-      expect(@user.api).to receive(:get).with("contacts/default/full", anything)
-      expect(@user.contacts).to eq("contact set")
+    describe ".contacts" do
+      it "should be able to get contacts" do
+        expect(user).to receive(:get_contacts).and_return("contact set")
+        expect(user.contacts).to eq("contact set")
+      end
+      it "should use the contact cache for subsequent access" do
+        expect(user).to receive(:get_contacts).and_return("contact set").once
+        user.contacts
+        contacts = user.contacts
+        expect(contacts).to eq("contact set")
+      end
+    end
+    describe ".contacts!" do
+      it "should be able to get contacts" do
+        expect(user).to receive(:get_contacts).and_return("contact set")
+        expect(user.contacts!).to eq("contact set")
+      end
+      it "should reload the contacts" do
+        expect(user).to receive(:get_contacts).and_return("contact set").twice
+        user.contacts
+        contacts = user.contacts!
+        expect(contacts).to eq("contact set")
+      end
     end
   end
 
   describe "ResultSet" do
-    # no testing, it's just an implementation detail to use inheritance
+    pending ".each"
+    pending ".has_more?"
   end
 
   describe "ContactSet" do
@@ -357,7 +417,7 @@ describe "GoogleContactsApi" do
     end
   end
 
-  describe "Group" do
+  describe GoogleContactsApi::Group do
     before(:all) do
       @group_json_hash = group_json_hash
       @group = GoogleContactsApi::Group.new(group_json_hash)
@@ -380,18 +440,39 @@ describe "GoogleContactsApi" do
     it "should tell me if it's a system group" do
       expect(@group).to be_system_group
     end
-    it "should get contacts from the group and cache them" do
-      @api = double("api")
-      allow(@api).to receive(:get).and_return(Hashie::Mash.new({
-        "body" => "some response", # could use example response here
-        "code" => 200
-      }))
-      allow(GoogleContactsApi::ContactSet).to receive(:new).and_return("contact set")
-      @group = GoogleContactsApi::Group.new(@contact_json_hash, nil, @api)
-      expect(@api).to receive("get").with(an_instance_of(String),
-        hash_including({"group" => @group.id})).once
-      @group.contacts
-      @group.contacts
+    describe ".contacts" do
+      before(:each) do
+        @api = double("api")
+        @group = GoogleContactsApi::Group.new(@contact_json_hash, nil, @api)
+        allow(@group).to receive(:id).and_return("group id")
+      end
+      it "should be able to get contacts" do
+        expect(@group).to receive(:get_contacts).with(hash_including({"group" => "group id"})).and_return("contact set")
+        expect(@group.contacts).to eq("contact set")
+      end
+      it "should use the contact cache for subsequent access" do
+        expect(@group).to receive(:get_contacts).with(hash_including({"group" => "group id"})).and_return("contact set").once
+        @group.contacts
+        contacts = @group.contacts
+        expect(contacts).to eq("contact set")
+      end
+    end
+    describe ".contacts!" do
+      before(:each) do
+        @api = double("api")
+        @group = GoogleContactsApi::Group.new(@contact_json_hash, nil, @api)
+        allow(@group).to receive(:id).and_return("group id")
+      end
+      it "should be able to get contacts" do
+        expect(@group).to receive(:get_contacts).with(hash_including({"group" => "group id"})).and_return("contact set")
+        expect(@group.contacts!).to eq("contact set")
+      end
+      it "should use the contact cache for subsequent access" do
+        expect(@group).to receive(:get_contacts).with(hash_including({"group" => "group id"})).and_return("contact set").twice
+        @group.contacts
+        contacts = @group.contacts!
+        expect(contacts).to eq("contact set")
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_contacts_api
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2014-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -210,6 +210,7 @@ files:
 - lib/google_contacts_api/contacts.rb
 - lib/google_contacts_api/group.rb
 - lib/google_contacts_api/group_set.rb
+- lib/google_contacts_api/groups.rb
 - lib/google_contacts_api/result.rb
 - lib/google_contacts_api/result_set.rb
 - lib/google_contacts_api/user.rb
@@ -235,7 +236,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1381068612794242354
+      hash: 1433605714673791610
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: