idid 0.0.3 → 0.0.4

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode

data/README.md

@@ -1,11 +1,15 @@
 # Idid
 
+[![Build Status](https://travis-ci.org/foxycoder/idid.png)](https://travis-ci.org/foxycoder/idid)
+
 Ruby CLI to [iDoneThis](http://idonethis.com).
 
 ## Usage (easy)
 
     $ idid Something awesome that my colleagues should know about.
 
+See `idid -h` for more available options.
+
 ## Installation
 
     $ [sudo] gem install idid
@@ -13,9 +17,8 @@ Ruby CLI to [iDoneThis](http://idonethis.com).
 ## Todo
 
 1. Write some more tests for mail delivery configurations.
-2. Keeping of dones locally for easy review.
-3. Off-line support (queue dones and send later).
-4. Support for iDoneThis personal.
+2. Off-line support (queue dones and send later).
+3. Support for iDoneThis personal.
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+
+desc 'Run all the tests'
+task :default do
+  exit system('bundle exec rspec spec --color')
+end

data/bin/idid

@@ -1,17 +1,42 @@
 #!/usr/bin/env ruby
-
+require 'optparse'
 require File.expand_path('../../lib/idid', __FILE__)
 
+options = {}
+
+OptionParser.new do |opts|
+  # Show help screen
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
 
+  # Show list of done items
+  list_desc = "Show done log for date. Default: today."
+  options[:list] = nil
+  opts.on('-l', '--list [YYYY-MM-DD]', list_desc) do |f|
+    options[:list] = f || Time.now.strftime('%Y-%m-%d')
+  end
+end.parse!
 
-begin
-  config = Idid::Configuration.new
-rescue
-  config = Idid::Interactive.create_config
-  config.write
-end
+if options[:list]
+  puts Idid::Task.list options[:list]
+else
+  begin
+    config = Idid::Configuration.new
+  rescue
+    config = Idid::Interactive.create_config
+    config.write
+    Idid::Interactive.status "Got your settings. Let's record your progress!"
+  end
 
-Idid.configuration = config
-Idid.send ARGV
+  if ARGV.any?
+    task = Idid::Task.new ARGV.join " "
+    task.save
 
-puts 'done'
+    Idid::Delivery.new(config).email task.to_s
+    Idid::Interactive.status "Got it! Let's get some more done!"
+  else
+    Idid::Interactive.fail "Shoot! An empty message cannot be send!"
+  end
+end

data/idid.gemspec

@@ -17,7 +17,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 2.12.0'
+  gem.add_development_dependency 'travis-lint'
 
   gem.add_runtime_dependency 'mail', '~> 2.5.3'
+  gem.add_runtime_dependency 'json', '~> 1.7.5'
 end

data/lib/idid/configuration.rb

@@ -1,7 +1,7 @@
 module Idid
   class Configuration
 
-    SMTP_DEFAULTS = { 
+    SMTP_DEFAULTS = {
       :address => 'smtp.gmail.com',
       :port => '587',
       :user_name => ENV['GMAIL_SMTP_USER'],
@@ -22,26 +22,26 @@ module Idid
     attr_accessor :delivery
 
     # Public: configuration to use with iDoneThis
-    # 
+    #
     # options - Hash with configuration options
     #           project    - Name of the project to post to (e.g.
     #                        project.idonethis.com)
     #           email      - Email address to use when sending mail.
-    #           delivery - Email delivery configuration Hash:
+    #           delivery   - Email delivery configuration Hash:
     #                        method  - Symbol (:smtp|:sendmail|:exim)
     #                        options - Configuration Hash for the
     #                        delivery method (see:
     #                        https://github.com/mikel/mail).
     #
     # Returns a new Idid::Configuration instance
-    def initialize options = {}
-      options = options.merge(read_config) if read_config
-      raise ArgumentError.new("Provide a project to use.") unless options['project']
-      raise ArgumentError.new("Provide an email address.") unless options['email']
-      raise ArgumentError.new("Provide a delivery method.") unless options['delivery']
+    def initialize(options = {})
+      options = read_config.merge options if read_config
+      raise ArgumentError.new "Provide a project to use." unless options['project']
+      raise ArgumentError.new "Provide an email address." unless options['email']
+      raise ArgumentError.new "Provide a delivery method." unless options['delivery']
 
-      @project    = options['project']
-      @email      = options['email']
+      @project = options['project']
+      @email = options['email']
       @delivery = options['delivery']
     end
 
@@ -68,7 +68,7 @@ module Idid
     end
 
     def self.config_file
-      File.join( ENV['HOME'], '.idid.yml' )
+      File.join ENV['HOME'], '.idid.yml'
     end
   end
 end

data/lib/idid/delivery.rb

@@ -0,0 +1,60 @@
+module Idid
+  class Delivery
+
+    attr_accessor :config
+
+    # Public: Initialize a new Delivery. It will automatically set the correct
+    # delivery options
+    #
+    # config - The Hash options to use when sending the email to iDoneThis
+    #
+    # Returns a new instance of Delivery
+    def initialize(config)
+      @config = config
+      setup_delivery
+    end
+
+    # Public: Send email to iDoneThis for logging
+    #
+    # message - The String with the actual activity you want to log
+    #
+    # Returns Mail::Message object
+    def email(message)
+      config = @config # Needed because @config is not in the block scope below
+
+      Mail.deliver do
+        from    config.email
+        to      "#{config.project}@team.idonethis.com"
+        subject "I did this"
+        body    message
+      end
+    end
+
+    private
+    # Private: Set the right delivery options for Mail to use, based on the
+    # settings in the configuration file. Defaults to sending mail via SMTP, if
+    # no or unknown delivery method is specified.
+    #
+    # Returns nothing
+    def setup_delivery
+      method = @config.delivery['method'] || :smtp
+      options = @config.delivery['options'] || {}
+
+      options.keys.each do |key|
+        options[(key.to_sym rescue key) || key] = options.delete(key)
+      end
+
+      options = Idid::Configuration::SMTP_DEFAULTS.merge options if method == :smtp
+      options = Idid::Configuration::EXIM_DEFAULTS.merge options if method == :exim
+
+      mail_defaults_for method, options
+    end
+
+    def mail_defaults_for(method, options = {})
+      Mail.defaults do
+        delivery_method method, options
+      end
+    end
+
+  end
+end

data/lib/idid/interactive.rb

@@ -6,8 +6,7 @@ module Idid
         status "Please take a moment to create a new configuration.."
         config = user_config
         config['delivery'] ||= {}
-        user_config_from_key 'project',
-          "What is the name of your iDoneThis project (look at the url: <project>.idonethis.com)", nil, config
+        user_config_from_key 'project', "What is the name of your iDoneThis project (look at the url: <project>.idonethis.com)", nil, config
         user_config_from_key 'email', "What is your associated email address for this iDoneThis project?", nil, config
         user_config_from_key 'method', "How do you want to send emails to iDoneThis? (smtp, sendmail, exim)", 'smtp', config['delivery']
 
@@ -25,7 +24,7 @@ module Idid
           user_config_from_key key, key.to_s, default, config['delivery']['options']
         end
 
-        Idid::Configuration.new(config)
+        Idid::Configuration.new config
       end
 
       def user_config_from_key(key, text, default, config = nil)
@@ -46,7 +45,7 @@ module Idid
         puts "\e[36m#{text}\e[0m"
       end
 
-      def fail(text='Failed!')
+      def fail(text = 'Failed!')
         puts "\e[31m#{text}\e[0m"
       end
 

data/lib/idid/task.rb

@@ -0,0 +1,90 @@
+require 'date'
+require 'json'
+
+module Idid
+  class Task
+    attr_accessor :contents, :log, :logdate
+
+    # Public: Initialize a new Task
+    #
+    # contents - The String containing the task that has been done
+    #
+    # Returns an instance of Task
+    def initialize(contents, logdate = nil)
+      @contents = contents
+      @log = Task.read_log
+      @logdate = logdate || Date.today
+    end
+
+    # Public: Save a task to the log file. If there were tasks for this day
+    # already, it's appended to that days log. Otherwise, a new day is added to
+    # the log.
+    #
+    # Returns boolean
+    def save
+      logdate = @logdate.strftime '%Y-%m-%d'
+
+      if @log.has_key? logdate
+        @log[logdate].push @contents
+      else
+        @log[logdate] = [@contents]
+      end
+
+      Task.write_log @log
+    end
+
+    # Public: Transform Task into a String
+    #
+    # Returns the String with the contents of the task
+    def to_s
+      @contents
+    end
+
+    # Public: Lists all activities for a given date.
+    #
+    # date - The String date you wish to show the entries of, in the format
+    #        YYYY-MM-DD
+    #
+    # Returns the String showing the logged activities
+    def self.list(date)
+      formatted_date = Date.parse(date).strftime '%e %B %Y'
+      list = read_log[date]
+
+      if list.nil?
+        "Could not find any activity for#{formatted_date}"
+      else
+        formatted_log = list.map{|l| '* ' + l }.join "\n"
+        "Log for#{formatted_date}:\n#{formatted_log}"
+      end
+    end
+
+    private
+    # Private: Location of the log file (~/.idid)
+    #
+    # Returns the String with the location of the log file
+    def self.logfile
+      logfile = File.join ENV['HOME'], '.idid'
+    end
+
+    # Private: Reads the log file into memory.
+    #
+    # Returns the Hash containing all log entries, or an empty hash if no
+    # entries were found
+    def self.read_log
+      if File.exists? logfile
+          JSON.load open(logfile) rescue {}
+      else
+        {}
+      end
+    end
+
+    # Private: Writes the log file to disk in JSON format
+    #
+    # log - The Hash containing the done log
+    #
+    # Returns boolean
+    def self.write_log(log)
+      File.open(logfile, 'w') { |f| f.write log.to_json }
+    end
+  end
+end

data/lib/idid/version.rb

@@ -1,3 +1,3 @@
 module Idid
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/idid.rb

@@ -4,53 +4,4 @@ require 'yaml'
 Dir[File.expand_path("../idid/**/*.rb", __FILE__)].each {|f| require f}
 
 module Idid
-  class << self
-    attr_accessor :configuration
-
-    def send *words
-      setup_delivery
-      Mail.deliver do
-        from    Idid.configuration.email
-        to      "#{Idid.configuration.project}@team.idonethis.com"
-        subject "I did this"
-        body    words.flatten.join(" ")
-      end
-    end
-
-    def setup_delivery
-      method = Idid.configuration.delivery['method']
-      options = Idid.configuration.delivery['options'] || {}
-
-      options.keys.each do |key|
-        options[(key.to_sym rescue key) || key] = options.delete(key)
-      end
-
-      case method
-      when 'smtp'
-        setup_smtp options
-      when 'sendmail'
-        setup_sendmail
-      when 'exim'
-        setup_exim options
-      end
-    end
-
-    def setup_smtp options = {}
-      Mail.defaults do
-        delivery_method :smtp, Idid::Configuration::SMTP_DEFAULTS.merge(options)
-      end
-    end
-
-    def setup_sendmail
-      Mail.defaults do
-        delivery_method :sendmail
-      end
-    end
-
-    def setup_exim options={}
-      Mail.defaults do
-        delivery_method :exim, Idid::Configuration::EXIM_DEFAULTS.merge(options)
-      end
-    end
-  end
 end

data/spec/idid/configuration_spec.rb

@@ -6,23 +6,27 @@ describe Idid::Configuration do
   let(:project) { 'foobar' }
   let(:delivery) { {:method => :sendmail} }
 
-  before { Idid::Configuration.any_instance.stub(:read_config) { nil } }
-
   its('project') { should eq project }
   its('email')   { should eq email   }
 
-  it 'raises ArgumentError if no email option is passed' do
-    expect { Idid::Configuration.new('project' => project, 'delivery' => delivery) }.
-      to raise_error(ArgumentError, /email/)
-  end
+  context "when any of the options are missing" do
+    before do
+      Idid::Configuration.any_instance.stub(:read_config) { nil }
+    end
 
-  it 'raises ArgumentError if no project option is passed' do
-    expect { Idid::Configuration.new('email' => email, 'delivery' => delivery) }.
-      to raise_error(ArgumentError, /project/)
-  end
+    it 'raises ArgumentError if no email option is passed' do
+      expect { Idid::Configuration.new('project' => project, 'delivery' => delivery) }.
+        to raise_error(ArgumentError, /email/)
+    end
+
+    it 'raises ArgumentError if no project option is passed' do
+      expect { Idid::Configuration.new('email' => email, 'delivery' => delivery) }.
+        to raise_error(ArgumentError, /project/)
+    end
 
-  it 'raises ArgumentError if no delivery option is passed' do
-    expect { Idid::Configuration.new('email' => email, 'project' => project) }.
-      to raise_error(ArgumentError, /delivery/)
+    it 'raises ArgumentError if no delivery option is passed' do
+      expect { Idid::Configuration.new('email' => email, 'project' => project) }.
+        to raise_error(ArgumentError, /delivery/)
+    end
   end
 end

data/spec/idid/delivery_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Idid::Delivery do
+
+  subject { delivery }
+
+  let(:delivery) { Idid::Delivery.new config }
+  let(:config) do
+    Idid::Configuration.new(
+      'project' => 'foo',
+      'email' => 'john@example.com',
+      'delivery' => { 'method' => :test }
+    )
+  end
+
+  its('config') { should eq config }
+
+  describe "#email" do
+    subject { delivery.email 'Tested Idid::Deliver.email' }
+    its(:to) { should eq ['foo@team.idonethis.com'] }
+    its(:from) { should eq ['john@example.com'] }
+    its(:body) { should eq 'Tested Idid::Deliver.email' }
+  end
+
+end

data/spec/idid/task_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Idid::Task do
+  subject { task }
+
+  let(:task) { Idid::Task.new contents, logdate }
+  let(:contents) { 'Bar' }
+  let(:logdate) { Date.new 2013,1,1 }
+
+  its(:contents) { should eq contents }
+  its(:log) { should be_a_kind_of Hash }
+  its(:logdate) { should eq Date.new(2013,1,1) }
+
+  describe "#save" do
+    before do
+      Idid::Task.stub(:read_log).and_return log_file
+      Idid::Task.stub(:write_log).and_return true
+      task.save
+    end
+
+    subject { task.log }
+
+    context "date has no logged items yet" do
+      let(:log_file) { {"2013-02-01" => ["Foo"]} }
+      it { should eq({"2013-02-01" => ["Foo"], "2013-01-01" => ["Bar"]}) }
+    end
+
+    context "date has already logged items" do
+      let(:log_file) { {"2013-01-01" => ["Foo"]} }
+      it { should eq({"2013-01-01" => ["Foo", "Bar"]}) }
+    end
+  end
+
+  describe "#to_s" do
+    subject { task.to_s }
+    it { should eq contents }
+  end
+
+  describe ".list" do
+    before do
+      Idid::Task.stub(:read_log).and_return({"2013-01-01" => ["Foo", "Bar"]})
+    end
+
+    subject { Idid::Task.list date }
+
+    context "logged items exist" do
+      let(:date) { '2013-01-01' }
+      it { should match /Log for 1 January 2013/ }
+      it { should match /\* Foo/ }
+      it { should match /\* Bar/ }
+    end
+
+    context "no logged items" do
+      let(:date) { '2013-01-02' }
+      it { should match /Could not find any activity for 2 January 2013/ }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -2,3 +2,9 @@ require 'bundler'
 Bundler.require
 
 Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f}
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.tty = true
+  config.formatter = :progress
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idid
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-04 00:00:00.000000000 Z
+date: 2013-01-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -27,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: travis-lint
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +75,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.5.3
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.5
 description: A Ruby CLI for iDoneThis
 email:
 - wrdevos@gmail.com
@@ -52,6 +100,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -60,9 +109,13 @@ files:
 - idid.gemspec
 - lib/idid.rb
 - lib/idid/configuration.rb
+- lib/idid/delivery.rb
 - lib/idid/interactive.rb
+- lib/idid/task.rb
 - lib/idid/version.rb
 - spec/idid/configuration_spec.rb
+- spec/idid/delivery_spec.rb
+- spec/idid/task_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/foxycoder/idid
 licenses: []
@@ -90,4 +143,6 @@ specification_version: 3
 summary: Post to iDoneThis from your command line.
 test_files:
 - spec/idid/configuration_spec.rb
+- spec/idid/delivery_spec.rb
+- spec/idid/task_spec.rb
 - spec/spec_helper.rb