bitsa 0.20 → 0.30

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e349d67cf9375ec6e32227b26e321d4edcd33ee4
+  data.tar.gz: 35b9220b6a324d289df631bfd31ef388f4d7711e
+SHA512:
+  metadata.gz: 1f5129e82b0321c4ded98e5c8f3ec728d4035e2b8a9a919f88eef38a022aa448ce30e3500629ec52188c31f93e1d7e9f2b698659f6cec6606b1337724470aa68
+  data.tar.gz: 265afe4c6f4eac44420d61426bd9163be95bd2837755dad9cdec8c821c82ae3150c7f4cef51a61850e7d820e2244b0fc4d455d9c19529af676f2b4dd52090640

data/Gemfile.lock

@@ -1,31 +1,37 @@
 PATH
   remote: .
   specs:
-    bitsa (0.20)
+    bitsa (0.30)
       gdata_19 (~> 1.1.3)
-      trollop (= 1.15)
+      trollop (= 2.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
-    fakeweb (1.2.8)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    fakeweb (1.3.0)
     gdata_19 (1.1.5)
-    multi_json (1.3.5)
-    rake (0.9.2.2)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.2)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-    simplecov (0.6.4)
+    multi_json (1.10.1)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
       multi_json (~> 1.0)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
-    trollop (1.15)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    trollop (2.0)
 
 PLATFORMS
   ruby
@@ -33,7 +39,7 @@ PLATFORMS
 DEPENDENCIES
   bitsa!
   bundler (>= 1.0.0)
-  fakeweb (~> 1.2.8)
+  fakeweb (~> 1.3.0)
   rake
-  rspec (~> 2.5.0)
+  rspec (~> 3.1.0)
   simplecov

data/HISTORY

@@ -1,3 +1,14 @@
+=== 0.30
+
+* 1 other:
+  * Remove Ruby 1.8.x support
+  * Upgrade RSPEC to 3.1.0
+  * Upgrade trollop to 2.0
+
+* 1 minor enhancements
+  * Add auto_check_interval_days to configuration file and
+    --auto-check to arguments
+
 === 0.20
 
 * 2 minor enhancements
@@ -20,4 +31,3 @@
 
 * 1 major enhancement:
   * Initial release
-

data/README.rdoc

@@ -1,7 +1,9 @@
 = Bitsa
 
-* http://github.com/colbell/bitsa
+http://github.com/colbell/bitsa
 
+{<img src="https://badge.fury.io/rb/bitsa.png" alt="Gem Version" />}[http://badge.fury.io/rb/bitsa]
+{<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/colbell/bitsa]
 
 A command line tool written in Ruby to access your GMail/Google Apps
 contacts. Designed to be used from Mutt but should be able to be used
@@ -12,6 +14,8 @@ from any email client that supports calling external programs.
 
 Since version 0.20 bitsa should work with both Ruby 1.8.7 and 1.9.x.
 
+Since version 0.30 bitsa should work with Ruby 1.9.x. and above.
+
     gem install bitsa
 
 
@@ -25,6 +29,7 @@ for the login.
     :login: myself@gmail.com
     :password: mypassword
     :cache_file_path: ~/.bitsa_cache.yml
+    :auto_check: 1
 
 The configuration file is not mandatory, you can pass in your email address
 and password on the command line, see Usage.
@@ -32,6 +37,10 @@ and password on the command line, see Usage.
 If you have no configuration file or if <tt>cache_file_path</tt> is not specified in the
 configuration file it will default to <tt>~/.bitsa_cache.yml</tt>
 
+If <tt>auto_check: X</tt> is greater than 0 then
+whenever you run a search it will check if the cache is more than X
+days old and if so will first run the update subcommand. Defaults to 1.
+
 If you store your email password in the configuration file you should
 ensue that it is only readable by you:
 
@@ -132,6 +141,6 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
-along with this program.  If not, see [http://www.gnu.org/licenses/].
+along with this program.  If not, see {http://www.gnu.org/licenses/}[http://www.gnu.org/licenses/].
 
 -----

data/bin/bitsa

@@ -32,4 +32,3 @@ args.parse(ARGV)
 
 app = Bitsa::BitsaApp.new
 app.run(args.global_opts, args.cmd, args.search_data)
-

data/bitsa.gemspec

@@ -12,20 +12,20 @@ Gem::Specification.new do |s|
   s.summary     = %q{Command line GMail Contacts lookup tool.}
   s.description = %q{Allows you to lookup GMail contacts and cache contacts locally from the command line.}
   s.required_rubygems_version = ">= 1.3.6"
-  #s.required_ruby_version = "< 1.9.0"
+  s.required_ruby_version = ">= 1.9.0"
 
   s.extra_rdoc_files = ["README.rdoc", "HISTORY", "COPYING"]
   s.rdoc_options     = ["--main", "README.rdoc"]
 
-  s.add_dependency "trollop", "1.15"
+  s.add_dependency "trollop", "2.0"
 
   # Use the fork until the real one works with Ruby 1.9X
   #s.add_dependency "gdata", "~> 1.1.2"
   s.add_dependency "gdata_19", "~> 1.1.3"
 
   s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "rspec", "~> 2.5.0"
-  s.add_development_dependency "fakeweb", "~> 1.2.8"
+  s.add_development_dependency "rspec", "~> 3.1.0"
+  s.add_development_dependency "fakeweb", "~> 1.3.0"
   s.add_development_dependency "simplecov"
   s.add_development_dependency "rake"
 

data/lib/bitsa.rb

@@ -29,20 +29,30 @@ module Bitsa
     def run(global_opts, cmd, search_data)
       settings = Settings.new
       settings.load(ConfigFile.new(global_opts[:config_file]), global_opts)
-      cache = ContactsCache.new(settings.cache_file_path, 1)
-
-      if cmd == "reload"
-        cache.clear!
-      end
-
-      if ["reload", "update"].include?(cmd) || cache.stale?
-        loader = GmailContactsLoader.new(settings.login, settings.password)
-        loader.update_cache(cache)
-      end
-
-      if cmd == "search"
-        puts "" # Force first entry to be displayed in mutt
-        cache.search(search_data).each {|k,v| puts "#{k}\t#{v}"}
+      cache = ContactsCache.new(settings.cache_file_path, settings.auto_check)
+
+      if cmd == "skel"
+        puts <<-EOS
+---
+:login: myself@gmail.com
+:password: mypassword
+:cache_file_path: ~/.bitsa_cache.yml
+:auto_check: 1
+EOS
+      else
+        if cmd == "reload"
+          cache.clear!
+        end
+
+        if ["reload", "update"].include?(cmd) || cache.stale?
+          loader = GmailContactsLoader.new(settings.login, settings.password)
+          loader.update_cache(cache)
+        end
+
+        if cmd == "search"
+          puts "" # Force first entry to be displayed in mutt
+          cache.search(search_data).each {|k,v| puts "#{k}\t#{v}"}
+        end
       end
     end
   end

data/lib/bitsa/args_processor.rb

@@ -27,7 +27,7 @@ module Bitsa #:nodoc:
   # is used to handle the parsing.
   class ArgsProcessor
     # Valid commands.
-    SUB_COMMANDS = %w(update reload search)
+    SUB_COMMANDS = %w(update reload search skel)
 
     # Global options passed on the command line.
     attr_reader :global_opts
@@ -50,7 +50,10 @@ Usage: bitsa [global-options] [subcommand] [command-opts]
 
 Global options are:
 EOS
-        opt :config_file, "Configuration file", :default => "~/.bitsa_config.yml"
+        opt :config_file, "Configuration file", type: String,
+            default: "~/.bitsa_config.yml"
+        opt :auto_check, "Autocheck interval in days. 0 to disable (default: 1)",
+            type: Integer
         opt :login, "Login", :type => String
         opt :password, "Password", :type => String
 
@@ -62,6 +65,7 @@ bitsa subcommands
    update: get the latest changes from Gmail
    reload: Clear all cached addresses and reload from Gmail
    search: Search for the passed string
+   skel:   Write a skeleton configuration file to standard output
 
 Information about this program
 EOS
@@ -72,7 +76,7 @@ EOS
 
       if cmd == "search"
         @search_data << args.shift unless args.empty?
-      elsif !["search", "update", "reload"].include?(cmd)
+      elsif !ArgsProcessor::SUB_COMMANDS.include?(cmd)
         Trollop::die "unknown subcommand '#{cmd}'"
       end
     end

data/lib/bitsa/contacts_cache.rb

@@ -34,9 +34,10 @@ module Bitsa #:nodoc:
     # Date/Time cache was last updated.
     attr_accessor :source_last_modified
 
-    # Load cache from file system. After <tt>lifespan_days</tt> the cache is considered stale. 
+    # Load cache from file system. After <tt>lifespan_days</tt> the cache
+    # is considered stale.
     def initialize(cache_file_path, lifespan_days)
-      @cache_file_path = File.expand_path(cache_file_path || "~/.bitsa_cache.yml")
+      @cache_file_path = File.expand_path(cache_file_path) # || "~/.bitsa_cache.yml")
       @lifespan_days = lifespan_days
       @addresses = {}
       @source_source_last_modified = nil
@@ -44,8 +45,9 @@ module Bitsa #:nodoc:
     end
 
     def stale?
-      (@source_last_modified.nil? ||
-       (DateTime.parse(@source_last_modified)+@lifespan_days) < DateTime.now)
+      @lifespan_days && @lifespan_days > 0 &&
+        (@source_last_modified.nil? ||
+         (DateTime.parse(@source_last_modified) + @lifespan_days) < DateTime.now)
     end
 
     # Remove all entries from cache.
@@ -59,10 +61,9 @@ module Bitsa #:nodoc:
     end
 
     def search(qry)
-      qry ||= ""
-      rg = Regexp.new(qry, Regexp::IGNORECASE)
+      rg = Regexp.new(qry || "", Regexp::IGNORECASE)
 
-      # Flattens.each_slices to an array with [email1, name1, email2, name2] etc.
+      # Flatten to an array with [email1, name1, email2, name2] etc.
       results = @addresses.values.flatten.each_slice(2).find_all do |e, n|
         e.match(rg) || n.match(rg)
       end

data/lib/bitsa/gmail_contacts_loader.rb

@@ -24,13 +24,13 @@ module Bitsa #:nodoc:
   # Loads Contacts from Gmail into a <tt>ContactsCache</tt> object.
   class GmailContactsLoader
 
-    # Number of contacts to retrieve as a single chunk.
-    @@FETCH_SIZE = 25
-
-    # Ctor specifying the Gmail (or Google Apps) user name and password.
-    def initialize(user, pw) #, lifespan_days)
+    # Ctor specifying the Gmail (or Google Apps) user name and
+    # password and optionally the number of records to retrieve in
+    # each chunk.
+    def initialize(user, pw, fetch_size = 25)
       @user = user
       @pw = pw
+      @fetch_size = fetch_size
     end
 
     # Refresh the passsed <tt>ContactsCache</tt> with the latest contact
@@ -40,8 +40,8 @@ module Bitsa #:nodoc:
       client.clientlogin(@user, @pw)
 
       idx = 1
-      until load_chunk(client, idx, cache) < @@FETCH_SIZE
-        idx += @@FETCH_SIZE
+      until load_chunk(client, idx, cache) < @fetch_size
+        idx += @fetch_size
       end
       cache.source_last_modified = DateTime.now.to_s
       cache.save
@@ -51,12 +51,8 @@ module Bitsa #:nodoc:
 
     def load_chunk(client, idx, cache)
       last_modified = nil
-      url = "https://www.google.com/m8/feeds/contacts/#{@user}/thin"
-      url += "?orderby=lastmodified"
-      url += "&showdeleted=true"
-      url += "&max-results=#{@@FETCH_SIZE}"
-      url += "&start-index=#{idx}"
-      url += "&updated-min=#{CGI.escape(cache.source_last_modified)}" if cache.source_last_modified
+      url = generate_loader_url(idx, cache)
+
       feed = client.get(url).to_xml
       feed.elements.each('entry') do |entry|
         name = entry.elements['title'].text
@@ -76,5 +72,15 @@ module Bitsa #:nodoc:
       end
       feed.elements.count
     end
+
+    def generate_loader_url(idx, cache)
+      url = "https://www.google.com/m8/feeds/contacts/#{@user}/thin"
+      url += "?orderby=lastmodified"
+      url += "&showdeleted=true"
+      url += "&max-results=#{@fetch_size}"
+      url += "&start-index=#{idx}"
+      url += "&updated-min=#{CGI.escape(cache.source_last_modified)}" if cache.source_last_modified
+      url
+    end
   end
 end

data/lib/bitsa/settings.rb

@@ -31,6 +31,9 @@ module Bitsa #:nodoc:
     # Path to file to store cached contact information in.
     attr_reader :cache_file_path
 
+    # Number of days before auto checking
+    attr_reader :auto_check
+
     # Load settings from a hash of data from the configuration file and
     # options passed on the command line.
     #
@@ -40,10 +43,15 @@ module Bitsa #:nodoc:
       @login = config_file_hash.data[:login]
       @password = config_file_hash.data[:password]
       @cache_file_path = config_file_hash.data[:cache_file_path]
+      @auto_check = config_file_hash.data[:auto_check]
 
       @login = options[:login] if options[:login]
       @password = options[:password] if options[:password]
       @cache_file_path = options[:cache_file_path] if options[:cache_file_path]
+      @auto_check = options[:auto_check] if options[:auto_check]
+
+      @auto_check ||= 1
+      @cache_file_path ||= "~/.bitsa_cache.yml"
     end
 
   end

data/lib/bitsa/version.rb

@@ -18,5 +18,5 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module Bitsa  #:nodoc:
-  VERSION = "0.20"
+  VERSION = "0.30"
 end

data/rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p327@bitsa

data/spec/helper.rb

@@ -1,5 +1,9 @@
 #require "rubygems"
-require "rspec"                 # Requied for rcov to work
+
+require "rspec"     # Required for rcov
+require 'simplecov'
+SimpleCov.start
+
 # require "test/unit"
 # require "shoulda"
 # require 'mocha'

data/spec/lib/bitsa/args_processor_spec.rb

@@ -0,0 +1,123 @@
+require "helper"
+require "bitsa/args_processor"
+
+RSpec.shared_examples "a valid set of args" do |ap|
+  context :config_file do
+    specify { expect(ap.global_opts[:config_file]).to eq("somefile") }
+  end
+  context :login do
+    specify { expect(ap.global_opts[:login]).to eq("someone") }
+  end
+  context :password do
+    specify { expect(ap.global_opts[:password]).to eq("mypassword") }
+  end
+  context :autocheck do
+    specify { expect(ap.global_opts[:auto_check]).to eq(1) }
+  end
+end
+
+def valid_long_args
+  args = []
+  args << "--config-file"
+  args << "somefile"
+  args << "--login"
+  args << "someone"
+  args << "--password"
+  args << "mypassword"
+  args << "--auto-check"
+  args << "1"
+  args << "update"
+  args
+end
+
+
+describe Bitsa::ArgsProcessor do
+    let(:ap) { Bitsa::ArgsProcessor.new }
+
+    it "should raise SystemExit if an invalid command passed" do
+      expect { ap.parse(["unknown"]) }.to raise_error(SystemExit)
+    end
+
+    it "should raise SystemExit if nothing passed" do
+      expect { ap.parse([]) }.to raise_error(SystemExit)
+    end
+
+    context "passed" do
+      [["reload"], ['skel'], ["search", "data"], ["update"]].each do |cmd, data|
+        context "#{cmd} command" do
+          before { ap.parse([cmd, data]) }
+          specify {
+            expect(ap.cmd).to eq(cmd)
+          }
+        end
+      end
+    end
+
+  context "passing valid long arguments" do
+    ap = Bitsa::ArgsProcessor.new
+    ap.parse(valid_long_args)
+    it_behaves_like "a valid set of args", ap
+  end
+
+  context "passing valid short arguments" do
+    args = []
+    args << "-c"
+    args << "somefile"
+    args << "-l"
+    args << "someone"
+    args << "-p"
+    args << "mypassword"
+    args << "-a"
+    args << "1"
+    args << "update"
+
+    ap = Bitsa::ArgsProcessor.new
+    ap.parse(args)
+    it_behaves_like "a valid set of args", ap
+  end
+
+  context "Alphabetic --auto-check argument passed" do
+    let(:args) { valid_long_args.map { |x| x == "1" ? "a" : x } }
+
+    specify {
+      expect { Bitsa::ArgsProcessor.new.parse(args) }.to raise_error(SystemExit)
+    }
+  end
+
+  context "Zero --auto-check argument passed" do
+    let(:ap) { Bitsa::ArgsProcessor.new }
+    before(:each) { ap.parse(valid_long_args.map { |x| x == "1" ? "0" : x }) }
+
+    context "auto-check" do
+      specify { expect(ap.global_opts[:auto_check]).to eq(0) }
+    end
+  end
+
+  context "Not passing --auto-check" do
+    let(:ap) { Bitsa::ArgsProcessor.new }
+    before(:each) { ap.parse ['update']}
+
+    context "auto-check" do
+      specify { expect(ap.global_opts[:auto_check]).to be_nil }
+    end
+  end
+
+  context "Not passing --config-file" do
+    before(:each) { ap.parse ['update']}
+    let(:ap) { Bitsa::ArgsProcessor.new }
+
+    context "config_file" do
+      specify { expect(ap.global_opts[:config_file]).to eq("~/.bitsa_config.yml") }
+    end
+  end
+
+  context "passing --search with some search data" do
+    before(:each) { ap.parse ['search', 'something']}
+    let(:ap) { Bitsa::ArgsProcessor.new }
+
+    context "search_data" do
+      specify { expect(ap.search_data).to eq "something" }
+    end
+  end
+
+end