mite.cmd 0.1.10

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+pkg
+doc
+coverage
+.DS_Store

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Overbryd
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,162 @@
+<pre>
+
+               _                           _ 
+            (_) |                         | |
+   _ __ ___  _| |_ ___   ___ _ __ ___   __| |
+  | '_ ` _ \| | __/ _ \ / __| '_ ` _ \ / _` |
+  | | | | | | | ||  __/| (__| | | | | | (_| |
+  |_| |_| |_|_|\__\___(_)___|_| |_| |_|\__,_|
+
+</pre>
+A simple command line interface for basic mite tasks.
+
+* @mite.@ is an ingeniously sleek time tracking tool: http://mite.yo.lk
+* @mite.cmd@ is a command line interface for it: http://github.com/Overbryd/mite.cmd
+  It provides a system wide command called @mite@.
+
+h3. Installation instructions:
+
+  $ gem install Overbryd-mite.cmd
+  
+I assume github is in your gem sources. You may need @activesupport@ and @activeresource@ too.
+
+  $ gem install activesupport activeresource
+
+h3. After installation instructions:
+
+You'll need to configure the client prior using it.
+To do this, you can just hammer into your console:
+
+  $ mite configure "Your Account Name" "Your API Key"
+
+It will then generate a yml file in ~/.mite.yml with your account information.
+
+The configure command also tries to install the bash auto completion hook into the following files: @~/.bash_completion@, @~/.bash_profile@, @~/.bash_login@, @~/.bashrc@.
+
+If your system doesn't support one of the files above, install the hook by yourself.
+In order to work as expected it needs bash to be configured for auto completion.
+This is actually quite easy, just append this line to your bash config file.
+
+  complete -C "mite auto-complete" mite
+
+You could use this command as an example (replace .bash_login with your bash configuration file):
+
+  $ echo "complete -C \"mite auto-complete\" mite" >> ~/.bash_login
+
+h3. Create new time entries with ease:
+
+  $ mite "project name" "service name" "start time" "note"
+  
+  $ mite "project name" "service name" "note"
+  
+  $ mite "project name" "start time" "note"
+  
+  $ mite "start time" "note"
+
+h4. The magic of the moment err... start_time:
+
+Append a @+@ to the start time and it will start the tracker.
+
+The most convenient syntax to set the start time is @h:mm@. So it will accept all these kinds of values: @1:15@, @0:01@, @24:00@.
+
+Short-hand for hours:
+* @3+@ will set the start time to 3 hours, and start the tracker
+* @3.5@ will set it to 3 hours 30 minutes
+* @0.25+@ will make you look like a floating-point fetish, and start the tracker
+
+h4. Examples:
+
+  $ mite "World Domination"
+
+This will start a timer for the project World Domination.
+
+  $ mite HugEveryone 0:15
+
+The time entry created by this command, is made for the project HugEveryone and is set to 15 minutes. No tracker will be started.
+  
+  $ mite HugEveryone Love 1+
+
+Start a time entry for the project HugEveryone with the service Love and set it to 1 hour. The tracker will be started, because of the @start time@ argument was suffixed with a @+@.
+
+h4. Note:
+
+If a project or a service doesn't exist it will be created.
+You can omit one/some of the arguments, namely: @project name@, @service name@, @note@ or @start time@. But they have to be in order. So you can't set a @service name@ unless you specify a project. This will be fixed in future releases, till then, the arguments rely on their order.
+
+h3. Amazing auto-completion:
+
+This is very nifty. (But maybe you should read the After Installation Instructions before.)
+The client was designed to save keystrokes, so I've baked in a very handy auto-completion feature. It even ignores the typed case.
+
+Try this:
+
+    $ mite [tab]
+
+It will try to auto-complete your projects.
+    
+    $ mite Project1 [tab]
+
+It will try to auto-complete your services.
+    
+    $ mite Project1 "System Administration" [tab]
+
+It will try to auto-complete common times!
+    
+    $ mite Project1 "System Administration" 0:48 [tab]
+
+It will try to auto-complete your notes!
+
+h4. Amazingly fast auto-completion:
+
+The auto-completion feature creates a cache in ~/.mite.cache, if you want to rebuild this cache just hit:
+  
+		$ mite rebuild-cache
+
+h4. Note: The first run without the cache might be a bit slow.
+
+h3. Controlling timers:
+
+	$ mite start
+
+This little cutey will start today's last time entry, if there is one.
+
+  $ mite stop
+
+This will just stop the current timer. (If you like you can use `mite pause` or `mite lunch` too)
+
+h3. Simple reports:
+
+  $ mite today
+
+This will generate a report of today's activity, summarizing your earnings at the bottom.
+
+  $ mite yesterday
+
+This will generate a report of yesterday's activity, summarizing your earnings and the total time at the bottom.
+Also works using @this_week@, @last_week@, @this_month@, @last_month@ as argument.
+
+h3. More simple stuff:
+
+  $ mite
+
+If there is a running timer, it will output it. Otherwise you should better not listen to it.
+
+  $ mite +
+
+Just create a new time entry and start tracking it.
+
+  $ mite open
+
+Opens your mite account in a new browser window (Max OSX only) or prints the url to your account.
+
+h3. Feature Request? Problems? Found a bug? Your girlfriend broke up with you?
+
+Your problems are no longer "problems"! They are called issues now, and github has the solution.
+
+If you want to tell me an idea, I'll happily take care of them in the issues tracker: http://github.com/Overbryd/mite.cmd/issues
+
+|\3. **All time Highscore of people who were involved** |
+| who? |\2. what? |
+| Sebastian Munz (yolk) | 12 issues | found a lot of bugs, did some real use testing. Really cool, thank you! |
+| Julia Soergel (juliasoergel) | 2 issues | found a bug and `I like your hairstyle!´ |
+| Michael Bumann (burmi) | 2 issues | found two bugs and mentioned a security issue which is now fixed. Yea baby! |

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mite.cmd"
+    gem.executables = "mite"
+    gem.summary = "A simple command line interface for basic mite tasks."
+    gem.email = "l.rieder@gmail.com"
+    gem.homepage = "http://github.com/Overbryd/mite.cmd"
+    gem.description = "A simple command line interface for mite, a sleek time tracking webapp."
+    gem.authors = ["Lukas Rieder"]
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+task :spec do
+  spec_files = Dir.glob('spec/**/*_spec.rb').join(' ')
+  sh "spec #{spec_files} --format specdoc --color"
+end
+task :default => :spec
+
+task :rcov do
+  sh "rake run_rcov && open coverage/index.html"
+end
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:run_rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end

data/TODO

@@ -0,0 +1,4 @@
+* Make it soft around the edges
+* Improve auto-completion caching
+* Waiting for some feedback
+* Implementing feedback

data/VERSION

@@ -0,0 +1 @@
+0.1.10

data/bin/mite

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'mite_cmd'
+
+begin
+  MiteCmd.calling_script = __FILE__
+  MiteCmd.run(ARGV)
+rescue MiteCmd::Exception => e
+  puts "#{"Epic fail: #{e.message}".colorize(:color => :red, :background => :black)} Type `mite help` to get help."
+  exit(1)
+end

data/lib/mite_cmd.rb

@@ -0,0 +1,34 @@
+require 'yaml'
+Dir[File.join(File.dirname(__FILE__), *%w[.. vendor * lib])].each do |path|
+  $LOAD_PATH.unshift path
+end
+require 'mite-rb'
+
+require 'string_ext'
+require 'mite_ext'
+require 'mite_cmd/application'
+require 'mite_cmd/autocomplete'
+
+module MiteCmd
+  BASH_COMPLETION = "complete -C \"mite auto-complete\" mite"
+  
+  CONFIG_FILE = File.expand_path '~/.mite.yml'
+  
+  mattr_accessor :calling_script
+  
+  def self.load_configuration
+    if File.exist?(CONFIG_FILE)
+      configuration = YAML.load(File.read(CONFIG_FILE))
+      Mite.account = configuration[:account]
+      Mite.key = configuration[:apikey]
+    else
+      raise Exception.new("Configuration file is missing.")
+    end
+  end
+  
+  def self.run(args)
+    Application.new(args).run
+  end
+  
+  class Exception < StandardError; end
+end

data/lib/mite_cmd/application.rb

@@ -0,0 +1,180 @@
+require 'ftools'
+
+module MiteCmd
+  class Application
+    TIME_FORMAT = /^(\d+(\.\d+)?:?\+?)|(\d+:\d+\+?)|\+$/
+    FLIRTS = [
+      'I like your hairstyle.', 'What a nice console you have.', 'My favorite color is red on black, monospaced.',
+      "What a lovely operation system this #{`uname`} is.", 'What about dinner tonight?', 'Your keystrokes are tingling.'
+    ]
+    
+    def initialize(arguments=[])
+      @arguments = arguments
+      MiteCmd.load_configuration unless ['configure', 'help'].include?(arguments.first)
+    end
+    
+    def run
+      if @arguments.first == 'open'
+        open_or_echo Mite.account_url
+        
+      elsif @arguments.first == 'help'
+        open_or_echo 'http://github.com/Overbryd/mite.cmd'
+        
+      elsif @arguments.first == 'configure'
+        raise MiteCmd::Exception.new('mite configure needs two arguments, the account name and the apikey') if @arguments.size < 3 # lol boobs, err... an ice cone!
+        write_configuration({:account => @arguments[1], :apikey => @arguments[2]})
+        tell("Couldn't set up bash completion. I'm terribly frustrated. Maybe 'mite help' helps out.") unless try_to_setup_bash_completion
+        
+      elsif @arguments.first == 'auto-complete'
+        autocomplete = MiteCmd::Autocomplete.new(MiteCmd.calling_script)
+        autocomplete.completion_table = if File.exist?(cache_file)
+          Marshal.load File.read(cache_file)
+        else
+          rebuild_completion_table
+        end
+        autocomplete.suggestions.map(&:quote_if_spaced).each { |s| tell s }
+        
+      elsif @arguments.first == 'rebuild-cache'
+        File.delete(cache_file) if File.exist? cache_file
+        rebuild_completion_table
+        tell 'The rebuilding of the cache has been done, Master. Your wish is my command.'
+        
+      elsif ['today', 'yesterday', 'this_week', 'last_week', 'this_month', 'last_month'].include? @arguments.first
+        total_minutes = 0
+        total_revenue = Mite::TimeEntry.all(:params => {:at => @arguments.first, :user_id => 'current'}).each do |time_entry|
+          total_minutes += time_entry.minutes
+          tell time_entry.inspect
+        end.map(&:revenue).compact.sum
+        tell ("%s:%.2d" % [total_minutes/60, total_minutes-total_minutes/60*60]).colorize(:lightred) + ", " + ("%.2f $" % (total_revenue/100)).colorize(:lightgreen)
+        
+      elsif ['stop', 'pause', 'lunch'].include? @arguments.first
+        if current_tracker = (Mite::Tracker.current ? Mite::Tracker.current.stop : nil)
+          tell current_tracker.time_entry.inspect
+        end
+        
+      elsif @arguments.first == 'start'
+        if time_entry = Mite::TimeEntry.first(:params => {:at => 'today'})
+          time_entry.start_tracker
+          tell time_entry.inspect
+        else
+          tell "Oh my dear! I tried hard, but I could'nt find any time entry for today."
+        end
+      
+      elsif (1..4).include?(@arguments.size)
+        attributes = {}
+        if time_string = @arguments.select { |a| a =~ TIME_FORMAT }.first
+          attributes[:minutes] = parse_minutes(time_string)
+          start_tracker = (time_string =~ /\+$/)
+        end
+        if project = find_or_create_project(@arguments.first)
+          attributes[:project_id] = project.id
+        end
+        if @arguments[1] && service = find_or_create_service(@arguments[1])
+          attributes[:service_id] = service.id
+        end
+        if note = parse_note(@arguments, time_string)
+          attributes[:note] = note
+        end
+        time_entry = Mite::TimeEntry.create attributes
+        time_entry.start_tracker if start_tracker
+        tell time_entry.inspect
+        
+      elsif @arguments.size == 0
+        tell Mite::Tracker.current ? Mite::Tracker.current.inspect : flirt
+      end
+    end
+    
+    def say(what)
+      puts what
+    end
+    alias_method :tell, :say
+    
+    def flirt
+      FLIRTS[rand(FLIRTS.size)]
+    end
+    
+    private
+    
+    def find_or_create_project(name)
+      project = Mite::Project.first(:params => {:name => name})
+      return nil if name =~ TIME_FORMAT
+      project ? project : Mite::Project.create(:name => name)
+    end
+    
+    def find_or_create_service(name)
+      service = Mite::Service.first(:params => {:name => name})
+      return nil if name =~ TIME_FORMAT
+      service ? service : Mite::Service.create(:name => name)
+    end
+
+    def parse_note(args, time_string)
+      if args[3]
+        args[3]
+      elsif time_string.nil? && args[2]
+        args[2]
+      elsif time_string && args[args.index(time_string)+1]
+        args[args.index(time_string)+1]
+      else
+        nil
+      end
+    end
+
+    def parse_minutes(string)
+      string = string.sub(/\+$/, '')
+      
+      if string.blank?
+        0
+      elsif string =~ /^\d+:\d+$/
+        string.split(':').first.to_i*60 + string.split(':').last.to_i
+      elsif string =~ /^\d+(\.\d+)?:?$/
+        (string.to_f*60).to_i
+      end
+    end
+    
+    def rebuild_completion_table
+      completion_table = {
+        0 => Mite::Project.all.map(&:name),
+        1 => Mite::Service.all.map(&:name),
+        2 => ['0:05', '0:05+', '0:15', '0:15+', '0:30', '0:30+', '1:00', '1:00+'].map(&:quote),
+        3 => Mite::TimeEntry.all.map(&:note).compact
+      }
+      File.open(cache_file, 'w') { |f| Marshal.dump(completion_table, f) }
+      File.chmod(0600, cache_file)
+      completion_table
+    end
+    
+    def cache_file
+      File.expand_path('~/.mite.cache')
+    end
+    
+    def open_or_echo(open_argument)
+      exec "open '#{open_argument}' || echo '#{open_argument}'"
+    end
+    
+    def write_configuration(config)
+      File.open(File.expand_path('~/.mite.yml'), 'w') do |f|
+        YAML.dump(config, f)
+      end
+      File.chmod(0600, File.expand_path('~/.mite.yml'))
+    end
+    
+    def try_to_setup_bash_completion
+      bash_code = "\n\n#{MiteCmd::BASH_COMPLETION}"
+      
+      ['~/.bash_completion', '~/.bash_profile', '~/.bash_login', '~/.bashrc'].each do |file|
+        bash_config_file = File.expand_path file
+        next unless File.file?(bash_config_file)
+        unless File.read(bash_config_file) =~ /#{bash_code}/
+          File.open(bash_config_file, 'a') do |f|
+            f.puts bash_code
+          end
+          return true
+        else
+          return true
+        end
+      end
+      return false
+    end
+    
+  end
+end