achoo 0.4.2 → 0.5

data/CHANGES

@@ -1,3 +1,16 @@
+2011-06-10: version 0.5
+
+ - Added support for plugins.
+
+ - Added tab completion for the hour registration all projects chooser.
+
+ - Added support for advanced line editing (readline).
+
+ - More user friendly configuration of ical. Merge :host, :port, and
+   :path into :url.
+
+ - Caching the list of all projects in hour registration.
+
 2010-05-11: version 0.4.2
 
  - Fixed problem with identifying the halt event in the awake log.

data/README.rdoc

@@ -5,26 +5,34 @@ works by scraping achievo web pages and sending HTTP requests.
 
 == INSTALL
 
-These instructions are for installing on Ubuntu 9.10 (Karmic Koala),
-but they will probably work with minor adjustments on other systems as
-well.
+These instructions are for installing on Ubuntu but they will probably
+work with minor adjustments on other systems as well.
 
-- Make sure that you have ruby and rubygems installed together with
-  achoo's non-gem requirements:
+I recommend using RVM (http://beginrescueend.com/). This enables you
+to safely mess with ruby without messing with the system ruby. Achoo
+is developed using ruby 1.9.2.
 
-    sudo aptitude install ruby rubygems ruby1.8-dev libxml2 \
-      libxml2-dev libxslt1 libxslt1-dev libopenssl-ruby
+- Make sure that you have achoo's non-gem requirements installed:
+
+    sudo aptitude install libxml2 libxml2-dev libxslt1 libxslt1-dev
+
+- Install RVM
+
+  Need to install some libs required to compile ruby
+
+    sudo aptitude install build-essential libssl-dev libreadline6-dev
+
+  (See http://beginrescueend.com/rvm/install/)
+
+    bash < <(curl -s https://rvm.beginrescueend.com/install/rvm)
+    # ... (follow the instructions for loading rvm into your shell's session)
+    rvm install 1.9.2
+    rvm use 1.9.2 --default
 
 - Install Achoo
 
     gem install achoo
 
-- Make sure that ~/.gem/ruby/1.8/bin is in your PATH environment variable
-
-    if echo $PATH | grep -vq ~/.gem/ruby/1.8/bin; then
-      export PATH=~/.gem/ruby/1.8/bin:$PATH
-      echo 'export PATH=~/.gem/ruby/1.8/bin:$PATH' >> ~/.bashrc
-    fi
 
 === TRACKING THE LATEST CHANGES
 
@@ -56,11 +64,9 @@ Create ~/.achoo from the following template (YAML) and edit it:
   :url      : 'https://example.com/achievo/'
   :user     : 'joe'
   :password : 'geheim'
-  :vcs_dirs : ["/home/joe/projects"],
+  :vcs_dirs : ["/home/joe/projects"]
   :ical :
-    - :host : "foo.example.com"
-      :port : 443
-      :path : "/joe/Calendar"
+    - :url  : "https://foo.example.com/joe/Calendar"
       :user : "joe"
       :pass : 'GeHeIm'
    
@@ -76,11 +82,9 @@ For more usage information, see
 this[http://oierud.name/~kjellm/bliki/AchooTheAchievoCLI.html] blog
 post.
 
-== SET UP DEVELOPMENT ENVIRONMENT
-
-To run the tests you need to install some additional gems:
+== PLUGINS
 
-  rake setup
+FIX
 
 == BUGS
 
@@ -93,4 +97,4 @@ Kjell-Magne Øierud <kjellm AT acm DOT org>
 == LICENSE
 
 This computer program is distributed under the GPL. Please see the
-COPYING file.
+COPYING file part of this distribution.

data/lib/achoo/achievo/hour_administration_form.rb

@@ -7,8 +7,7 @@ module Achoo
 
       include Achievo::DateField('date', 'viewdate')
 
-      def initialize(agent)
-        @agent = agent
+      def initialize
         @page  = nil
       end
 
@@ -53,7 +52,7 @@ module Achoo
       end
   
       def set_page_to_view_for_date(view, date)
-        @page ||= @agent.get(RC[:hour_admin_url])
+        @page ||= AGENT.get(RC[:hour_admin_url])
         
         link = @page.link_with(:text => view.capitalize)
         @form = @page.form(view)

data/lib/achoo/achievo/hour_registration_form.rb

@@ -6,9 +6,8 @@ module Achoo
 
       include Achievo::DateField('date', 'activitydate')
 
-      def initialize(agent)
-        @agent = agent
-        @page  = @agent.get(RC[:hour_registration_url])
+      def initialize
+        @page  = AGENT.get(RC[:hour_registration_url])
         @form  = @page.form('entryform')
 
         if @form.nil?
@@ -17,7 +16,7 @@ module Achoo
           # most cases.
 
           # FIX Ugly call to a private method using send()
-          haf    = HourAdministrationForm.new(@agent)
+          haf    = HourAdministrationForm.new
           @page  = haf.send(:set_page_to_view_for_date, 'dayview', Date.today)
           @form  = @page.form('entryform')
         end
@@ -75,18 +74,12 @@ module Achoo
         collect_options('billpercent')
       end
 
-      def collect_options(field_name, pattern)
+      def collect_options(field_name)
         @form.field_with(:name => field_name).options.collect do |opt|
           [opt.value.match(/#{field_name}\.id='(\d+)'/)[1], opt.text]
         end
       end
 
-      def billing_options
-        @form.field_with(:name => 'billpercent').options.collect do |opt|
-          [opt.value.match(/billpercent\.id='(\d+)'/)[1], opt.text]
-        end
-      end
-
       def phases_for_selected_project
         partial_page = retrieve_project_phases_page
         page         = create_page_from_partial(partial_page)
@@ -120,8 +113,12 @@ module Achoo
       end
 
       def all_projects
+        @@allprojects_cache ||= get_all_projects
+      end
+
+      def get_all_projects
         puts "Getting project page #1..."
-        projects_page = @agent.get(projects_url)
+        projects_page = AGENT.get(projects_url)
         projects = scrape_projects(projects_page)
 
         i = 2
@@ -147,8 +144,8 @@ module Achoo
         printf format, 'phase',    @phases_seen[phase]
         printf format, 'remark',   @form.remark
         printf format, 'hours',    @form.time
-        printf format, 'worktime', @form.field_with(:name => 'workperiod').options.first.text
-        printf format, 'billing',  @form.field_with(:name => 'billpercent').options.first.text
+        printf format, 'worktime', @form.field_with(:name => 'workperiod').selected_options.first.text
+        printf format, 'billing',  @form.field_with(:name => 'billpercent').selected_options.first.text
 
         # @form.fields.each do |field|
         #   printf format, field.name, field.value
@@ -184,7 +181,7 @@ module Achoo
       def create_page_from_partial(partial_page)
         body = "<html><head></head><body><form>#{partial_page.body}</form></body></html>"
         page = Mechanize::Page.new(nil, {'content-type' => 'text/html; charset=iso-8859-1'},
-                                   body, nil, @agent)
+                                   body, nil, AGENT)
       end
 
       def extract_number_from_projectid(projectid)

data/lib/achoo/achievo/hour_registration_form_ranged.rb

@@ -6,10 +6,13 @@ module Achoo
 
       include Achievo::DateField('to_date', 'todate')
 
-      def initialize(agent)
+      def initialize
         super
-        @page = @agent.get(atk_submit_to_url(@page.link_with(:text => 'Select range').href))
+        @page = AGENT.get(atk_submit_to_url(@page.link_with(:text => 'Select range').href))
         @form = @page.form('entryform')
+
+        # Need to preselect this for some reason. FIX duplicated in super 
+        @form.field_with(:name => 'billpercent').options.first.select
       end
 
       def date=(date_range)

data/lib/achoo/achievo/lock_month_form.rb

@@ -4,12 +4,8 @@ module Achoo
   module Achievo
     class LockMonthForm
 
-      def initialize(agent)
-        @agent = agent
-      end
-
       def lock_month(period)
-        page  = @agent.get(RC[:lock_months_url])
+        page  = AGENT.get(RC[:lock_months_url])
         @form  = page.form('entryform')
 
         @form.period = period

data/lib/achoo/achievo/login_form.rb

@@ -4,9 +4,9 @@ module Achoo
   module Achievo
     module LoginForm
 
-      def self.login(agent)
+      def self.login
         puts "Fetching data ..."
-        page = agent.get(RC[:url])
+        page = AGENT.get(RC[:url])
 
         return if page.forms.empty? # already logged in
 
@@ -15,7 +15,7 @@ module Achoo
         form = page.forms.first
         form.auth_user = RC[:user]
         form.auth_pw   = RC[:password]
-        page = agent.submit(form, form.buttons.first)
+        page = AGENT.submit(form, form.buttons.first)
 
         if page.body.match(/Username and\/or password are incorrect. Please try again./)
           raise "Username and/or password are incorrect."

data/lib/achoo/app.rb

@@ -4,9 +4,14 @@ require 'achoo/term'
 require 'achoo/ui'
 require 'logger'
 require 'mechanize'
-
+require 'plugman'
+require 'plugman/finder'
 
 module Achoo
+
+  AGENT   = Mechanize.new
+  PLUGINS = Plugman.new('achoo')
+
   class App
 
     include UI::Commands
@@ -15,19 +20,22 @@ module Achoo
     
 
     def initialize(log=false)
-      @agent = Mechanize.new
+      @last_used_date = Date.today
       if log
-        @agent.log = Logger.new("achoo_http.log")
+        AGENT.log = Logger.new("achoo_http.log")
       end
     end
 
 
     def start
       begin
+        PLUGINS.load_plugins
+        puts PLUGINS.log if ENV['ACHOO_DEBUG']
+        PLUGINS.send_at_startup
         print_welcome
-        warm_up_ical_cache
         login
         scrape_urls
+        #print_homescreen
         command_loop
       rescue SystemExit => e
         raise
@@ -49,6 +57,8 @@ module Achoo
       while true
         begin
           trap("INT", "DEFAULT");
+          PLUGINS.send_before_print_menu(@last_used_date)
+          @last_used_date = Date.today
           choices = ["Register hours",
                      "Show flexitime balance",
                      "Day hour report",
@@ -64,6 +74,7 @@ module Achoo
           dispatch(answer)
         rescue Interrupt
           puts # Add a new line in case we are prompting
+          #print_homescreen
         end
       end
     end
@@ -74,25 +85,26 @@ module Achoo
       when '0', 'q', 'Q'
         exit
       when '1', ''
-        register_hours(@agent)
+        date = register_hours
+        @last_used_date = date.class == Array ? date.first : date
       when '2'
-        show_flexi_time(@agent)
+        show_flexi_time
       when '3'
-        show_registered_hours_for_day(@agent)
+        show_registered_hours_for_day
       when '4'
-        show_registered_hours_for_week(@agent)
+        show_registered_hours_for_week
       when '5'
-        show_holiday_report(@agent)
+        show_holiday_report
       when '6'
-        lock_month(@agent)
+        lock_month
       when '7'
-        view_report(@agent)
+        view_report
       end
     end
 
 
     def scrape_urls 
-      page = @agent.get(@agent.current_page.frames.find {|f| f.name == 'menu'}.href)
+      page = AGENT.get(AGENT.current_page.frames.find {|f| f.name == 'menu'}.href)
       menu_links = page.search('a.menuItemLevel2')
       
       RC[:hour_registration_url] = menu_link_to_url(menu_links, 'Time Registration')
@@ -118,7 +130,7 @@ module Achoo
 
     def login
       load_cookies
-      Achievo::LoginForm.login(@agent)
+      Achievo::LoginForm.login
       save_cookies
     end
 
@@ -126,26 +138,13 @@ module Achoo
     def load_cookies
       cookies_file = "#{ENV['HOME']}/.achoo_cookies.yml"
       if FileTest.exists? cookies_file
-        @agent.cookie_jar.load(cookies_file)
+        AGENT.cookie_jar.load(cookies_file)
       end
     end
 
 
     def save_cookies
-      @agent.cookie_jar.save_as("#{ENV['HOME']}/.achoo_cookies.yml")
-    end
-
-
-    def warm_up_ical_cache
-      Thread.new do 
-        RC[:ical].each do |config|
-          begin
-            ICal.from_http_request(config)
-          rescue Exception => e
-            # Ignore, we are just doing this to populate the cache
-          end
-        end
-      end
+      AGENT.cookie_jar.save_as("#{ENV['HOME']}/.achoo_cookies.yml")
     end
 
   end

data/lib/achoo/awake.rb

@@ -47,7 +47,7 @@ module Achoo
         else # :awake, :boot
           # We don't know the end of the session
           session << Temporal::OpenTimespan.new(g.last.time, g.first.time)
-          g.unshift(System::LogEntry.new(-1, :crash))
+          g.unshift(System::LogEntry.new(Time.at(0), :crash))
         end
       
         raise "Session must consist of even number of events. Found #{g.length}" unless g.length.even?

data/lib/achoo/extensions.rb

@@ -45,3 +45,7 @@ class Integer
   alias minutes minute
 
 end
+
+if RUBY_VERSION < "1.9"
+  Range.send(:alias_method, :cover?, :include?) 
+end

data/lib/achoo/ical.rb

@@ -3,6 +3,7 @@ require 'achoo/temporal'
 require 'achoo/ui'
 require 'net/https'
 require 'ri_cal'
+require 'uri'
 
 module Achoo
   class ICal
@@ -14,13 +15,16 @@ module Achoo
     def self.from_http_request(params)
       return @@cache[params] if @@cache[params]
       
-      http = Net::HTTP.new(params[:host], params[:port])
+      url = URI.parse(params[:url])
+
+      http = Net::HTTP.new(url.host, url.port)
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       ics = http.start do |http|
-        request = Net::HTTP::Get.new(params[:path])
+        request = Net::HTTP::Get.new(url.path)
         request.basic_auth(params[:user], params[:pass])
         response = http.request(request)
+        raise response.message unless response.is_a?(Net::HTTPSuccess)
         response.body
       end
     

data/lib/achoo/plugin/awake.rb

@@ -0,0 +1,23 @@
+require 'achoo/awake'
+require 'achoo/ui'
+
+module Achoo
+  class Plugin
+    class Awake < Plugman::PluginBase
+
+      include UI::ExceptionHandling
+
+      def before_register_hour_hours(date)
+        puts "Awake log:"
+        begin
+          awake = Achoo::Awake.new
+          awake.at(date)
+          puts
+        rescue Exception => e
+          print handle_exception("Failed to retrieve awake log.", e)
+        end
+      end
+      
+    end
+  end
+end

data/lib/achoo/plugin/ical.rb

@@ -0,0 +1,47 @@
+require 'achoo'
+require 'achoo/ical'
+require 'achoo/ui'
+require 'plugman/plugin_base'
+
+module Achoo
+  class Plugin
+    class Ical < Plugman::PluginBase
+
+      include UI::ExceptionHandling
+
+      def state_ok?; RC.has_key?(:ical); end
+      
+      def at_startup
+        warm_up_ical_cache
+      end
+
+      def before_register_hour_remark(date)
+        puts '-' * 80
+        puts "Calendar events for #{date}:"
+        puts '---'
+        begin
+          RC[:ical].each do |config|
+            Achoo::ICal.from_http_request(config).print_events(date)
+          end
+        rescue Exception => e
+          puts handle_exception("Failed to retrieve calendar events.", e)
+        end
+      end
+
+      private
+
+      def warm_up_ical_cache
+        Thread.new do 
+          RC[:ical].each do |config|
+            begin
+              Achoo::ICal.from_http_request(config)
+            rescue Exception => e
+              puts "Failed to fetch calendar data: #{e}"
+            end
+          end
+        end
+      end
+      
+    end
+  end
+end