bitsa 0.20 → 0.30

data/spec/lib/bitsa/confg_file_spec.rb

@@ -0,0 +1,34 @@
+require "tempfile"
+require "helper"
+require "bitsa/config_file"
+
+describe Bitsa::ConfigFile do
+  context "An existing configuration file should load from disk" do
+    let(:config) { Bitsa::ConfigFile.new("spec/data/config.yml")}
+     context :login do
+       specify { expect(config.data[:login]).to eq("test@gmail.com") }
+     end
+     context :password do
+       specify { expect(config.data[:password]).to eq("myPassword") }
+     end
+  end
+
+  context "data from a non-existent configuration files" do
+    let(:config) { Bitsa::ConfigFile.new("/tmp/i-dont-exist") }
+    specify { expect(config.data).to eq({}) }
+  end
+
+  context "that I have no rights to" do
+    let(:tmp_file) {
+      tmp_file = Tempfile.open("cache")
+      FileUtils.cp("spec/data/config.yml", tmp_file.path)
+      FileUtils.chmod(0000, tmp_file.path)
+      tmp_file
+    }
+
+    context "reading" do
+      specify { expect { Bitsa::ConfigFile.new(tmp_file.path) }.to raise_error(Errno::EACCES) }
+    end
+  end
+
+end

data/spec/lib/bitsa/contacts_cache_spec.rb

@@ -0,0 +1,331 @@
+require "fileutils"
+require "tempfile"
+require "yaml"
+
+require "helper"
+
+require "bitsa/contacts_cache"
+
+def create_empty_temp_file
+  tmp_file = Tempfile.open("cache")
+  File.open(tmp_file.path, "w") do |f|
+    f.write('')
+  end
+  tmp_file
+end
+
+def read_test_data
+  # 4 users, 5 email addresses
+  YAML::load_file("spec/data/bitsa_cache.yml")[1].values.flatten(1).sort
+end
+
+def create_cache(last_modified = nil, lifespan_days = 1)
+  source_last_modified, addresses = YAML::load_file("spec/data/bitsa_cache.yml")
+  source_last_modified = last_modified.to_s if last_modified
+
+  tmp_file = Tempfile.open("cache")
+  File.open(tmp_file.path, "w") do |f|
+    f.write(YAML::dump([source_last_modified, addresses]))
+  end
+  [Bitsa::ContactsCache.new(tmp_file.path, lifespan_days), tmp_file]
+end
+
+RSpec.shared_examples_for "an empty cache" do |c|
+  specify { expect(c).not_to be_nil}
+  context :size do
+    specify { expect(c.size).to eq(0) }
+  end
+  context "last modified date" do
+    specify { expect(c.source_last_modified).to be_nil }
+  end
+  context :stale do
+    specify { expect(c.stale?).to be_truthy }
+  end
+end
+
+RSpec.shared_examples "a full resultset" do |results|
+  specify "should return all entries" do
+    expect(results.size).to eq(5)
+    expect(results.flatten(0).sort).to eq(read_test_data)
+  end
+end
+
+describe Bitsa::ContactsCache do
+  context "empty cache file" do
+    cache = Bitsa::ContactsCache.new(create_empty_temp_file.path, 1)
+    it_behaves_like "an empty cache", cache
+  end
+
+  context "cache file does not exist" do
+    cache = Bitsa::ContactsCache.new("/tmp/idonotexististhatoky", 1)
+    it_behaves_like "an empty cache", cache
+  end
+
+  context "user not authorised to read cache file" do
+    let(:tmp_file) do
+      tmp_file = create_empty_temp_file
+      FileUtils.chmod(0222, tmp_file.path)
+      tmp_file
+    end
+
+    specify {
+      expect {Bitsa::ContactsCache.new(tmp_file.path, 1)}.to raise_error(Errno::EACCES)
+    }
+  end
+
+  context "last updated today and lifespan is 1 day" do
+    context :stale do
+      specify {expect(create_cache(DateTime.now, 1)[0].stale?).to be_falsey}
+    end
+  end
+
+  context "last updated yesterday and lifespan is 1 day" do
+    context :stale do
+      specify {expect(create_cache(DateTime.now-1, 1)[0].stale?).to be_truthy}
+    end
+  end
+
+  context "last updated yesterday and lifespan is 2 days" do
+    context :stale do
+      specify {expect(create_cache(DateTime.now-1, 2)[0].stale?).to be_falsey}
+    end
+  end
+
+  context "last updated 3 days ago and lifespan is 0 days" do
+    context :stale do
+      specify {expect(create_cache(DateTime.now-3, 0)[0].stale?).to be_falsey}
+    end
+  end
+
+  context "last updated 3 days ago and lifespan is -1 days" do
+    context :stale do
+      specify {expect(create_cache(DateTime.now-3, -1)[0].stale?).to be_falsey}
+    end
+  end
+
+  context "after clearing the cache" do
+    before(:each) do
+      expect(cache.size).to be >= 1
+      expect(cache.empty?).to be false
+      cache.clear!
+    end
+    let(:cache) { create_cache[0] }
+
+    context :size do
+      specify {expect(cache.size).to eq(0)}
+    end
+
+    context "empty?" do
+      specify {expect(cache.empty?).to be true}
+    end
+  end
+
+  context "searching the test data" do
+
+    specify "should have read the correct number of contacts" do
+      expect(create_cache[0].size).to eq(4)
+    end
+
+    context "with an empty string" do
+      it_behaves_like "a full resultset", create_cache[0].search("")
+    end
+
+    context "with a nil string" do
+      it_behaves_like "a full resultset", create_cache[0].search(nil)
+    end
+
+    context "searching by start of email address" do
+      context "returning a single result" do
+        let(:expected) { [["test1@example.com", "My Tester"]] }
+
+        specify {expect(create_cache[0].search('test1')).to match_array expected}
+      end
+
+      context "returning multiple results" do
+        let(:expected) {
+          [["john_smith@here.org", ""],
+           ["Joan.bloggs@somewhere.com.au", "Joan Bloggshere"]]
+        }
+
+        specify {expect(create_cache[0].search("jo")).to match_array expected}
+      end
+    end
+
+    context "searching by end of email address" do
+      let (:expected)  {[["john_smith@here.org", ""]]}
+
+      specify {expect(create_cache[0].search('org')).to match_array expected}
+    end
+
+    context "searching by middle of email address" do
+      let (:expected)  {[["john_smith@here.org", ""]]}
+
+      specify {expect(create_cache[0].search('n_s')).to match_array expected}
+    end
+
+    context "searching email using a different case to the actual data" do
+      let (:expected)  {[["john_smith@here.org", ""]]}
+
+      specify {expect(create_cache[0].search('N_sMI')).to match_array expected}
+    end
+
+    context "searching by start of name" do
+      let(:expected) { [["Joan.bloggs@somewhere.com.au", "Joan Bloggshere"]] }
+
+      specify {expect(create_cache[0].search('Joan Blo')).to match_array expected}
+    end
+
+    context "searching by end of name" do
+      let(:expected) { [["Joan.bloggs@somewhere.com.au", "Joan Bloggshere"]] }
+
+      specify {expect(create_cache[0].search('ggshere')).to match_array expected}
+    end
+
+    context "searching by middle of name" do
+      let(:expected) { [["Joan.bloggs@somewhere.com.au", "Joan Bloggshere"]] }
+
+      specify {expect(create_cache[0].search('n Bl')).to match_array expected}
+    end
+
+    context "searching by middle of name" do
+      let(:expected) { [["Joan.bloggs@somewhere.com.au", "Joan Bloggshere"]] }
+
+      specify {expect(create_cache[0].search('n Bl')).to match_array expected}
+    end
+
+    context "searching name using a different case to the actual data" do
+      let(:expected) { [["Joan.bloggs@somewhere.com.au", "Joan Bloggshere"]] }
+
+      specify {expect(create_cache[0].search('N BL')).to match_array expected}
+    end
+
+    context "search with no results" do
+      context :size do
+        specify {expect(create_cache[0].search('nothing is here').size).to eq(0)}
+      end
+    end
+
+    context "search on one contact with two email addresses" do
+      let(:expected) {
+        [["email2@somewhere.com", "Mr Multiple"], ["email1@somewhere.com", "Mr Multiple"]]
+      }
+
+      specify {expect(create_cache[0].search('multip')).to match_array expected}
+    end
+
+    context "searching a contact with multiple email addresses where only 1 email address matches" do
+      let(:expected) {[["email1@somewhere.com", "Mr Multiple"]]}
+
+      specify {expect(create_cache[0].search('email1')).to match_array expected}
+    end
+
+    context "find by ID" do
+      let(:id) {"http://www.google.com/m8/feeds/contacts/person%40example.org/base/685e301a549c176e"}
+      let(:expected) {[["email1@somewhere.com", "Mr Multiple"],
+                       ["email2@somewhere.com", "Mr Multiple"]]}
+
+      specify {expect(create_cache[0].get(id)).to match_array expected}
+    end
+
+    context "find by a non-existent ID" do
+      let(:id) {"http://www.google.com/m8/feeds/contacts/person%40example.org/base/4783783783"}
+
+      specify {expect(create_cache[0].get(id)).to be_nil}
+    end
+  end
+
+  context "updating the test data" do
+    let(:cache) { create_cache[0] }
+    let(:id) {"http://www.google.com/m8/feeds/contacts/person%40example.org/base/637e301a549c176e"}
+
+    specify "should change the data" do
+      expect(cache.get(id)).to match_array [["Joan.bloggs@somewhere.com.au", "Joan Bloggshere"]]
+      cache.update(id, "Tammy Smith", ["tammy5@example.com"])
+      expect(cache.get(id)).to match_array [["tammy5@example.com", "Tammy Smith"]]
+    end
+  end
+
+  context "updating with two email addresses" do
+    let(:cache) { create_cache[0] }
+    let(:id) {"http://www.google.com/m8/feeds/contacts/person%40example.org/base/637e301a549c176e"}
+
+    specify "should update the data" do
+      expected = [["Joan.bloggs@somewhere.com.au", "Joan Bloggshere"]]
+      expect(cache.get(id)).to match_array expected
+
+      cache.update(id, "Tammy Smith", ["tammy5@example.com", "smithtammy@exampel.org"])
+
+      expected = [["smithtammy@exampel.org", "Tammy Smith"], ["tammy5@example.com", "Tammy Smith"]]
+      expect(cache.get(id)).to match_array expected
+    end
+  end
+
+  context "deleting a non-existent entry" do
+    let(:cache) { create_cache[0] }
+
+    specify "should return nil" do
+      expect(cache.delete("NONEXISTENT")).to be_nil
+    end
+
+    specify do
+      expect {
+        cache.delete("NONEXISTENT")
+      }.to_not change(cache, :size)
+    end
+
+  end
+
+  context "deleting an existing entry" do
+    let(:cache) { create_cache[0] }
+    let(:id) { "http://www.google.com/m8/feeds/contacts/person%40example.org/base/637e301a549c176e" }
+
+    specify {expect { cache.delete(id) }.to change(cache, :size).by(-1)}
+
+    specify "should return the deleted entry" do
+      expect(cache.delete(id)).to match_array [["Joan.bloggs@somewhere.com.au", "Joan Bloggshere"]]
+    end
+
+    context "the cache" do
+      specify "should no longer contain the deleted entry" do
+        cache.delete(id)
+        expect(cache.get(id)).to be_nil
+      end
+    end
+  end
+
+  context "saving" do
+    let(:data) { create_cache }
+    let(:cache) { data[0] }
+    let(:cache_file) { data[1] }
+
+    context "changes to existing contacts" do
+      specify {
+        id = "http://www.google.com/m8/feeds/contacts/person%40example.org/base/637e301a549c176e"
+        cache.update(id, "The Changed Name", ["change1@somewhere.org"])
+        cache.save
+        new_cache = Bitsa::ContactsCache.new(cache_file.path, 1)
+        expected = [["change1@somewhere.org", "The Changed Name"]]
+        expect(new_cache.get(id)).to match_array expected
+      }
+    end
+
+    context "adding new entries" do
+      specify {
+        id = "NONEXISTENT"
+        cache.update(id, "The Changed Name", ["change1@somewhere.org"])
+        cache.save
+        new_cache = Bitsa::ContactsCache.new(cache_file.path, 1)
+        expected = [["change1@somewhere.org", "The Changed Name"]]
+        expect(new_cache.get(id)).to match_array expected
+      }
+    end
+
+    context "to a file that I have no write rights to" do
+      before(:each) { FileUtils.chmod(0444, cache_file.path) }
+
+      specify { expect { cache.save }.to raise_error(Errno::EACCES) }
+
+    end
+  end
+
+end

data/spec/lib/bitsa/gmail_contacts_loader_spec.rb

@@ -0,0 +1,203 @@
+require 'helper'
+
+require 'fakeweb'
+
+require "bitsa/contacts_cache"
+require "bitsa/gmail_contacts_loader"
+
+describe Bitsa::GmailContactsLoader do
+  context "Bitsa::GmailContactsLoader" do
+    before(:each) do
+      FakeWeb.allow_net_connect = false
+
+      # Start session.
+      FakeWeb.register_uri(:post, "https://www.google.com/accounts/ClientLogin",
+                           :body => "SID=DQAAAGgA...7Zg8CTN\nLSID=DQAAAGsA...lk8BBbG\nAuth=DQAAAGgA...dk3fA5N")
+
+      # First chunk of contacts
+      FakeWeb.register_uri(:get, "https://www.google.com/m8/feeds/contacts/test/thin?orderby=lastmodified&showdeleted=true&max-results=15&start-index=1",
+                           :body => <<eos
+<feed gd:etag='W/&quot;AkANQXo7eCp7ImA9WxFTGUo.&quot;' xmlns:gContact='http://schemas.google.com/contact/2008' xmlns:gd='http://schemas.google.com/g/2005' xmlns:batch='http://schemas.google.com/gdata/batch' xmlns:openSearch='http://a9.com/-/spec/opensearch/1.1/' xmlns='http://www.w3.org/2005/Atom'>
+  <id>
+    somebody@example.com
+  </id>
+  <updated>
+    2010-04-11T09:39:50.400Z
+  </updated>
+  <category term='http://schemas.google.com/contact/2008#contact' scheme='http://schemas.google.com/g/2005#kind'/>
+  <title>
+    Somebodys's Contacts
+  </title>
+  <link href='http://www.google.com/' rel='alternate' type='text/html'/>
+  <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin' rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml'/>
+  <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin' rel='http://schemas.google.com/g/2005#post' type='application/atom+xml'/>
+  <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin/batch' rel='http://schemas.google.com/g/2005#batch' type='application/atom+xml'/>
+  <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin?max-results=15' rel='self' type='application/atom+xml'/>
+  <author>
+    <name>
+      Somebody
+    </name>
+    <email>
+      somebody@example.com
+    </email>
+  </author>
+  <generator uri='http://www.google.com/m8/feeds' version='1.0'>
+    Contacts
+  </generator>
+  <openSearch:totalResults>
+    1
+  </openSearch:totalResults>
+  <openSearch:startIndex>
+    1
+  </openSearch:startIndex>
+  <openSearch:itemsPerPage>
+    15
+  </openSearch:itemsPerPage>
+  <entry gd:etag='&quot;SHc-fTVSLyp7ImA9WxBaEkwIQAU.&quot;'>
+    <id>
+      http://www.google.com/m8/feeds/contacts/somebody%40example.com/base/0
+    </id>
+    <updated>
+      2010-03-21T23:05:19.955Z
+    </updated>
+    <app:edited xmlns:app='http://www.w3.org/2007/app'>
+      2010-03-21T23:05:19.955Z
+    </app:edited>
+    <category term='http://schemas.google.com/contact/2008#contact' scheme='http://schemas.google.com/g/2005#kind'/>
+    <title>
+      Jpe Bloggs
+    </title>
+    <link href='http://www.google.com/m8/feeds/photos/media/somebody%40example.com/0' gd:etag='&quot;bwR-YldFbCp7ImBIGHMMbBALQAwWIFMBVVc.&quot;' rel='http://schemas.google.com/contacts/2008/rel#photo' type='image/*'/>
+    <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin/0' rel='self' type='application/atom+xml'/>
+    <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin/0' rel='edit' type='application/atom+xml'/>
+    <gd:email address='jbloggs@example.com' rel='http://schemas.google.com/g/2005#other' primary='true'/>
+    <gd:email address='another@example.com' rel='http://schemas.google.com/g/2005#work'/>
+    <gContact:groupMembershipInfo href='http://www.google.com/m8/feeds/groups/somebody%40example.com/base/6' deleted='false'/>
+  </entry>
+</feed>
+eos
+                          )
+
+      # Second chunk of contacts
+      FakeWeb.register_uri(:get, "https://www.google.com/m8/feeds/contacts/test/thin?orderby=lastmodified&showdeleted=true&max-results=15&start-index=16",
+                           :body => <<eos
+<feed gd:etag='W/&quot;AkANQXo7eCp7ImA9WxFTGUo.&quot;' xmlns:gContact='http://schemas.google.com/contact/2008' xmlns:gd='http://schemas.google.com/g/2005' xmlns:batch='http://schemas.google.com/gdata/batch' xmlns:openSearch='http://a9.com/-/spec/opensearch/1.1/' xmlns='http://www.w3.org/2005/Atom'>
+  <id>
+    somebody@example.com
+  </id>
+  <updated>
+    2010-04-11T09:39:50.400Z
+  </updated>
+  <category term='http://schemas.google.com/contact/2008#contact' scheme='http://schemas.google.com/g/2005#kind'/>
+  <title>
+    Somebodys's Contacts
+  </title>
+  <link href='http://www.google.com/' rel='alternate' type='text/html'/>
+  <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin' rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml'/>
+  <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin' rel='http://schemas.google.com/g/2005#post' type='application/atom+xml'/>
+  <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin/batch' rel='http://schemas.google.com/g/2005#batch' type='application/atom+xml'/>
+  <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin?max-results=15' rel='self' type='application/atom+xml'/>
+  <author>
+    <name>
+      Somebody
+    </name>
+    <email>
+      somebody@example.com
+    </email>
+  </author>
+  <generator uri='http://www.google.com/m8/feeds' version='1.0'>
+    Contacts
+  </generator>
+  <openSearch:totalResults>
+    1
+  </openSearch:totalResults>
+  <openSearch:startIndex>
+    1
+  </openSearch:startIndex>
+  <openSearch:itemsPerPage>
+    15
+  </openSearch:itemsPerPage>
+  <entry gd:etag='&quot;SHc-fTVSLyp7ImA9WxBaEkwIQAU.&quot;'>
+    <id>
+      http://www.google.com/m8/feeds/contacts/somebody%40example.com/base/0
+    </id>
+    <gd:deleted/>
+    <updated>
+      2010-03-21T23:05:19.955Z
+    </updated>
+    <app:edited xmlns:app='http://www.w3.org/2007/app'>
+      2010-03-21T23:05:19.955Z
+    </app:edited>
+    <category term='http://schemas.google.com/contact/2008#contact' scheme='http://schemas.google.com/g/2005#kind'/>
+    <title>
+      Jpe Bloggs
+    </title>
+    <link href='http://www.google.com/m8/feeds/photos/media/somebody%40example.com/0' gd:etag='&quot;bwR-YldFbCp7ImBIGHMMbBALQAwWIFMBVVc.&quot;' rel='http://schemas.google.com/contacts/2008/rel#photo' type='image/*'/>
+    <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin/0' rel='self' type='application/atom+xml'/>
+    <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin/0' rel='edit' type='application/atom+xml'/>
+    <gd:email address='jbloggs@example.com' rel='http://schemas.google.com/g/2005#other' primary='true'/>
+    <gd:email address='another@example.com' rel='http://schemas.google.com/g/2005#work'/>
+    <gContact:groupMembershipInfo href='http://www.google.com/m8/feeds/groups/somebody%40example.com/base/6' deleted='false'/>
+  </entry>
+</feed>
+eos
+                          )
+
+      # Third chunk - empty
+      FakeWeb.register_uri(:get, "https://www.google.com/m8/feeds/contacts/test/thin?orderby=lastmodified&showdeleted=true&max-results=15&start-index=31",
+                           :body => <<eos
+<feed gd:etag='W/&quot;AkANQXo7eCp7ImA9WxFTGUo.&quot;' xmlns:gContact='http://schemas.google.com/contact/2008' xmlns:gd='http://schemas.google.com/g/2005' xmlns:batch='http://schemas.google.com/gdata/batch' xmlns:openSearch='http://a9.com/-/spec/opensearch/1.1/' xmlns='http://www.w3.org/2005/Atom'>
+  <id>
+    somebody@example.com
+  </id>
+  <updated>
+    2010-04-11T09:39:50.400Z
+  </updated>
+  <category term='http://schemas.google.com/contact/2008#contact' scheme='http://schemas.google.com/g/2005#kind'/>
+  <title>
+    Somebodys's Contacts
+  </title>
+  <link href='http://www.google.com/' rel='alternate' type='text/html'/>
+  <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin' rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml'/>
+  <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin' rel='http://schemas.google.com/g/2005#post' type='application/atom+xml'/>
+  <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin/batch' rel='http://schemas.google.com/g/2005#batch' type='application/atom+xml'/>
+  <link href='http://www.google.com/m8/feeds/contacts/somebody%40example.com/thin?max-results=15' rel='self' type='application/atom+xml'/>
+  <author>
+    <name>
+      Somebody
+    </name>
+    <email>
+      somebody@example.com
+    </email>
+  </author>
+  <generator uri='http://www.google.com/m8/feeds' version='1.0'>
+    Contacts
+  </generator>
+  <openSearch:totalResults>
+    0
+  </openSearch:totalResults>
+  <openSearch:startIndex>
+    0
+  </openSearch:startIndex>
+  <openSearch:itemsPerPage>
+    15
+  </openSearch:itemsPerPage>
+</feed>
+eos
+                          )
+
+    end
+
+    it "should update cache" do
+      cache = double('Bitsa::ContactsCache')
+      gcl = Bitsa::GmailContactsLoader.new('test', 'pw', 15)
+      expect(cache).to receive(:update).once
+      expect(cache).to receive(:source_last_modified=).once
+      expect(cache).to receive(:source_last_modified).exactly(3)
+      expect(cache).to receive(:save).once
+      expect(cache).to receive(:delete).once
+      gcl.update_cache(cache)
+    end
+
+  end
+end