achoo 0.3 → 0.4.1

data/CHANGES

@@ -1,3 +1,15 @@
+2010-04-20: version 0.4.1
+
+ - Bug fixes
+
+2010-04-20: version 0.4
+
+ - Converted rc file format to YAML
+
+ - Prefetch and cache iCalendar data in a parallel thread at startup
+
+ - Added support for 'Time Survey' reports
+
 2010-04-05: version 0.3
 
  - More compact time span format in awake log

data/README.rdoc

@@ -9,18 +9,15 @@ These instructions are for installing on Ubuntu 9.10 (Karmic Koala),
 but they will probably work with minor adjustments on other systems as
 well.
 
-- Make sure that you have ruby and rubygems installed
+- Make sure that you have ruby and rubygems installed together with
+  achoo's non-gem requirements:
 
-    sudo aptitude install ruby rubygems
+    sudo aptitude install ruby rubygems ruby1.8-dev libxml2 \
+      libxml2-dev libxslt1 libxslt1-dev libopenssl-ruby
 
-- Install non-gem requirements
+- Install Achoo
 
-    sudo aptitude install ruby1.8-dev libxml2 libxml2-dev libxslt1 libxslt1-dev libopenssl-ruby
-
-- Download achoo-0.2.gem[http://github.com/downloads/kjellm/achoo/achoo-0.2.gem] and install it
-
-    wget http://github.com/downloads/kjellm/achoo/achoo-0.2.gem
-    gem install achoo-0.2.gem
+    gem install achoo
 
 - Make sure that ~/.gem/ruby/1.8/bin is in your PATH environment variable
 
@@ -31,9 +28,9 @@ well.
 
 === TRACKING THE LATEST CHANGES
 
-Requires git and rake
+Requires git
 
-  sudo aptitude install rake git-core
+  sudo aptitude install git-core
 
 Then
 
@@ -45,30 +42,28 @@ Or if you already has cloned achoo, update with
 
 Generate gem and install it
 
-  rake build:gem
-  gem install pkg/achoo-XXX.gem
+  gem build achoo.gemspec
+  gem install achoo-XXX.gem
 
 == USAGE
 
 First, make sure that language in Achievo's user preferences is
 English and theme is 'no value'.
 
-Create ~/.achoo from the following template and edit it:
-
-  RC = {
-    :url      => 'https://example.com/achievo/',
-    :user     => 'joe',
-    :password => 'geheim',
-    :vcs_dirs => ["#{ENV['HOME']}/projects"],
-    :ical     => [{ :host => "foo.example.com",
-                    :port => 443,
-                    :path => "/joe/Calendar",
-                    :user => "joe",
-                    :pass => 'GeHeIm',
-                  },
-                 ],
-  }
-    
+Create ~/.achoo from the following template (YAML) and edit it:
+
+  ---
+  :url      : 'https://example.com/achievo/'
+  :user     : 'joe'
+  :password : 'geheim'
+  :vcs_dirs : ["/home/joe/projects"],
+  :ical :
+    - :host : "foo.example.com"
+      :port : 443
+      :path : "/joe/Calendar"
+      :user : "joe"
+      :pass : 'GeHeIm'
+   
 Then
 
   chmod 0600 ~/.achoo
@@ -78,7 +73,8 @@ You can then run achoo from a shell with the achoo command
   achoo
 
 For more usage information, see
-this[http://oierud.name/~kjellm/bliki/AchooTheAchievoCLI.html] blog.
+this[http://oierud.name/~kjellm/bliki/AchooTheAchievoCLI.html] blog
+post.
 
 == SET UP DEVELOPMENT ENVIRONMENT
 

data/Rakefile

@@ -62,3 +62,6 @@ desc 'Install development dependencies'
 task :setup do
   system 'gem install shoulda rack thin redgreen allison'
 end
+
+desc 'Remove generated files and folders'
+task :clean => ['build:clobber_package', 'doc:clobber_rdoc']

data/bin/achoo

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'achoo'
+require 'achoo/app'
 require 'achoo/rc_loader'
 require 'optparse'
 
@@ -18,7 +18,7 @@ def main
 
   load_rc(options[:rc_file])
 
-  achoo = Achoo.new(options[:log])
+  achoo = Achoo::App.new(options[:log])
   achoo.start
 end
 

data/lib/achoo.rb

@@ -1,140 +1,2 @@
-class Achoo; end
-
-require 'achoo/term'
-require 'achoo/ui'
-require 'logger'
-require 'mechanize'
-
-
-
-class Achoo
-
-  include Achoo::UI::Commands
-  include Achoo::UI::ExceptionHandling
-  include Achoo::UI::RegisterHours
-  
-  def initialize(log=false)
-    @agent = Mechanize.new
-    if log
-      @agent.log = Logger.new("achoo_http.log")
-    end
-  end
-
-  def start
-    begin
-      print_welcome
-      login
-      scrape_urls
-      command_loop
-    rescue SystemExit => e
-      raise
-    rescue Exception => e
-      handle_fatal_exception("Something bad happened. Shutting down.", e)
-    end
-  end
-
-
-  def print_welcome
-    puts Term.shadowbox("Welcome to Achoo!")
-  end
-
-
-  def command_loop
-    while true
-      begin
-        trap("INT", "DEFAULT");
-        answer = Term.choose('[1]',
-                             ["Register hours",
-                              "Show flexitime balance",
-                              "Day hour report",
-                              "Week hour report",
-                              "Holiday balance",
-                              "Lock month",
-                             ],
-                             "Exit",
-                             ['q', 'Q', ''])
-        dispatch(answer)
-      rescue Interrupt
-        puts # Add a new line in case we are prompting
-      end
-    end
-  end
-
-  
-  def dispatch(command)
-      case command
-      when '0', 'q', 'Q'
-        exit
-      when '1', ''
-        register_hours(@agent)
-      when '2'
-        show_flexi_time(@agent)
-      when '3'
-        show_registered_hours_for_day(@agent)
-      when '4'
-        show_registered_hours_for_week(@agent)
-      when '5'
-        show_holiday_report(@agent)
-      when '6'
-        lock_month(@agent)
-      end
-  end
-
-
-  def scrape_urls 
-    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')
-    RC[:lock_months_url]       = menu_link_to_url(menu_links, 'Lock months')
-    RC[:holiday_report_url]    = menu_link_to_url(menu_links, 'Holiday report')
-    RC[:hour_admin_url]        = RC[:hour_registration_url]
-  end
-
-  def menu_link_to_url(menu_links, text)
-    a_tag = menu_links.find {|a| 
-      a.text.strip == text
-    }
-    
-    if a_tag.nil?
-      raise Exception.new("Could not find the '#{text}' link in Achievo.\nMake sure that language is 'English' and theme is 'no value' in Achievo's user preferences.\nYou must delete ~/.achoo_cookies.yml for these changes to take affect.")
-    end
-
-    url = a_tag.attribute('onclick').value.match(/window\.open\('([^']+)/)[1]
-    return "#{RC[:url]}#{url}"
-  end
-
-
-  def login
-    load_cookies
-
-    puts "Fetching data ..."
-    page = @agent.get(RC[:url])
-
-    return if page.forms.empty?
-
-    puts "Logging in ..."
-
-    form = page.forms.first
-    form.auth_user = RC[:user]
-    form.auth_pw   = RC[:password]
-    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."
-    end
-
-    @agent.cookie_jar.save_as("#{ENV['HOME']}/.achoo_cookies.yml")
-  end
-
-
-  def load_cookies
-    cookies_file = "#{ENV['HOME']}/.achoo_cookies.yml"
-    if FileTest.exists? cookies_file
-      @agent.cookie_jar.load(cookies_file)
-    end
-  end
-
-
+module Achoo
 end
-

data/lib/achoo/achievo.rb

@@ -0,0 +1,13 @@
+require 'achoo'
+
+module Achoo
+  module Achievo
+    autoload :Form,                       'achoo/achievo/form.rb'
+    autoload :HourAdministrationForm,     'achoo/achievo/hour_administration_form.rb'
+    autoload :HourRegistrationForm,       'achoo/achievo/hour_registration_form.rb'
+    autoload :HourRegistrationFormRanged, 'achoo/achievo/hour_registration_form_ranged.rb'
+    autoload :LockMonthForm,              'achoo/achievo/lock_month_form.rb'
+    autoload :LoginForm,                  'achoo/achievo/login_form.rb'
+    autoload :Table,                      'achoo/achievo/table.rb'
+  end
+end

data/lib/achoo/achievo/form.rb

@@ -0,0 +1,22 @@
+require 'achoo/achievo'
+
+module Achoo
+  module Achievo
+    class Form
+
+      def date=(date)
+        # Day and month must be prefixed with '0' if single
+        # digit. Date.day and Date.month doesn't do this. Use strftime
+        day_field.value   = date.strftime('%d')
+        month_field.value = date.strftime('%m')
+        year_field.value  = date.year
+      end
+      
+      def date
+        Date.new(year_field.value.to_i, month_field.value.to_i, 
+                 day_field.value.to_i)
+      end
+
+    end
+  end
+end

data/lib/achoo/achievo/hour_administration_form.rb

@@ -0,0 +1,91 @@
+require 'achoo/achievo'
+require 'achoo/term/table'
+
+module Achoo
+  module Achievo
+    class HourAdministrationForm < Form
+
+      def initialize(agent)
+        @agent = agent
+        @page  = nil
+      end
+
+      def show_registered_hours_for_day(date)
+        show_registered_hours(date, 'dayview', '#rl_1 tr')
+      end
+  
+      def show_registered_hours_for_week(date)
+        show_registered_hours(date, 'weekview', '//form[@name="weekview"]/following::table/tr')
+      end
+
+      def flexi_time(date)
+        set_page_to_view_for_date('dayview', date)
+        
+        @page.body.match(/Flexi time balance: (-?\d+:\d+)/)[1]
+      end
+
+      private
+  
+      def show_registered_hours(date, view, query)
+        set_page_to_view_for_date(view, date)
+        
+        table = Table.new(@page.search(query))
+
+        if view == 'weekview'
+          table.first.each {|c| c.gsub!(/\s+/, ' ') }
+        end
+
+        if view == 'dayview'
+          table.select_columns do |c|
+            # '' -> Ruby 1.9, ' ' -> Ruby 1.8
+            !['', ' ', 'Billing billed', 'Billing marked', 'Billing total'].include?(c[0])
+
+          end
+        end
+
+        summaries = table.length > 1 ? table.last : nil
+
+        Term::Table.new(table.first,
+                        table[1 .. table.length-2], 
+                        summaries).print
+      end
+  
+      def set_page_to_view_for_date(view, date)
+        @page ||= @agent.get(RC[:hour_admin_url])
+        
+        link = @page.link_with(:text => view.capitalize)
+        @form = @page.form(view)
+        unless link.nil?
+          puts "Fetching #{view} ..."
+          @page = link.click
+          @form = @page.form(view)
+        end
+        unless date == self.date
+          @page = get_page_for(date)
+          @form = @page.form(view)
+        end
+
+        @page
+      end    
+
+      def get_page_for(date)
+        puts "Fetching data for #{date} ..."
+        self.date = date
+        @page = @form.submit
+      end
+      
+      def day_field
+        @form.field_with(:name => 'viewdate[day]')
+      end
+      
+      def month_field
+        @form.field_with(:name => 'viewdate[month]')
+      end
+      
+      def year_field
+        @form.field_with(:name => 'viewdate[year]')
+      end
+
+    end  
+  end
+end

data/lib/achoo/achievo/hour_registration_form.rb

@@ -0,0 +1,230 @@
+require 'achoo/achievo'
+
+module Achoo
+  module Achievo
+    class HourRegistrationForm < Form
+
+      def initialize(agent)
+        @agent = agent
+        @page  = @agent.get(RC[:hour_registration_url])
+        @form  = @page.form('entryform')
+
+        if @form.nil?
+          # Happens if the user has viewed a day or week report for a
+          # locked month. Fetching todays day report should fix this in
+          # most cases.
+
+          # FIX Ugly call to a private method using send()
+          haf    = HourAdministrationForm.new(@agent)
+          @page  = haf.send(:set_page_to_view_for_date, 'dayview', Date.today)
+          @form  = @page.form('entryform')
+        end
+
+        if @form.nil?
+          raise "Failed to retrieve the hour registration form.\nThe likely cause is that you have locked the current month, which is a silly thing to do."
+        end
+
+        @projects_seen = {}
+        @phases_seen   = {}
+
+        # Need to preselect this for some reason
+        @form.field_with(:name => 'billpercent').options.first.select
+        # Preselecting this one as well, just in case
+        @form.field_with(:name => 'workperiod').options.first.select
+      end
+
+      def project
+        extract_number_from_projectid(@form.projectid)
+      end
+
+      def project=(projectid)
+        @form.projectid = "project.id='#{projectid}'"
+      end
+
+      def remark=(remark)
+        @form.remark = remark
+      end
+
+      def hours=(hours)
+        @form.time = hours
+      end
+
+      def phase
+        @form.phaseid.match(/phase\.id='(\d+)'/)[1]
+      end
+
+      def phase=(phaseid)
+        @form.phaseid   = "phase.id='#{phaseid}'"
+      end
+
+      def workperiod=(workperiod)
+        @form.workperiod = "workperiod.id='#{workperiod}'"
+      end
+
+      def billing=(billing)
+        @form.billpercent = "billpercent.id='#{billing}'"
+      end
+
+
+      def worktime_periods
+        @form.field_with(:name => 'workperiod').options.collect do |opt|
+          [opt.value.match(/workperiod\.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)
+        field        = page.forms.first.field_with(:name => 'phaseid')
+        
+        phases = []
+        if field.respond_to?(:options)
+          field.options.each do |opt|
+            phases << [extract_number_from_phaseid(opt.value), opt.text]
+          end
+        else
+          partial_page.body.match(/(^[^<]+)&nbsp;&nbsp;</)
+          phases << [extract_number_from_phaseid(field.value), $1]
+        end
+        
+        phases.each {|p| @phases_seen[p[0]] = p[1]}
+
+        return phases
+      end
+      
+      def recent_projects
+        projects = []
+        @form.field_with(:name => 'projectid').options.each do |opt|
+          val = opt.value["project.id='".length..-2]
+          projects << [val, opt.text]
+        end
+
+        projects.each {|p| @projects_seen[p[0]] = p[1]}
+
+        projects
+      end
+
+      def all_projects
+        puts "Getting project page #1..."
+        projects_page = @agent.get(projects_url)
+        projects = scrape_projects(projects_page)
+
+        i = 2
+        while (link = projects_page.link_with(:text => 'Next'))
+          puts "Getting project page ##{i}..."
+          projects_page = link.click
+          projects.merge!(scrape_projects(projects_page))
+          i += 1
+        end
+
+        projects.keys.sort.collect do |name|
+          id   = projects[name][0]
+          text = "#{projects[name][1]}: #{name}"
+          @projects_seen[id] = text
+          [id, text]
+        end
+      end
+
+      def print_values
+        format = "%10s: \"%s\"\n"
+        printf format, 'date',     date_to_s
+        printf format, 'project',  @projects_seen[project]
+        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
+
+        # @form.fields.each do |field|
+        #   printf format, field.name, field.value
+        # end
+
+      end
+
+      def submit
+        @form.submit()
+      end
+
+      private
+
+      def date_to_s
+        date.strftime("%Y-%m-%d")
+      end
+
+      def retrieve_project_phases_page
+        old = {
+          :atkaction => @form.atkaction,
+          :action    => @form.action,
+        }
+        
+        @form.action = RC[:url]+"/dispatch.php?atkpartial=attribute.phaseid.refresh"
+        @form.atkaction = 'add'
+        partial_page = @form.submit
+        @form.action    = old[:action]
+        @form.atkaction = old[:atkaction]
+        
+        return partial_page
+      end
+
+      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)
+      end
+
+      def day_field
+        @form.field_with(:name => 'activitydate[day]')
+      end
+
+      def month_field
+        @form.field_with(:name => 'activitydate[month]')
+      end
+
+      def year_field
+        @form.field_with(:name => 'activitydate[year]')
+      end
+
+      def extract_number_from_projectid(projectid)
+        projectid.match(/project\.id='(\d+)'/)[1]
+      end
+
+      def extract_number_from_phaseid(projectid)
+        projectid.match(/phase\.id='(\d+)'/)[1]
+      end
+
+      def projects_url
+        atk_submit_to_url(@page.link_with(:text => 'Select project').href)
+      end
+
+      def atk_submit_to_url(atk_submit)
+        href = atk_submit['javascript:atkSubmit("__'.length..-3]
+        href.gsub!('_13F', '?')
+        href.gsub!('_13D', '=')
+        href.gsub!('_126', '&')
+        href.gsub!('_125', '%')
+        return RC[:url] + '/' + href
+      end
+
+      def scrape_projects(projects_page)
+        projects = {}
+        projects_page.search('table#rl_1 tr').each do |tr|
+          cells = tr.search('td')
+          next if cells.empty?
+          projects[cells[1].text.strip] = [
+                                           cells[1].at_css('a').attribute('href').to_s.match('project.id%3D%27(\d+)%27')[1],
+                                           cells[0].text.strip,
+                                          ]
+        end
+
+        return projects
+      end
+
+    end
+  end
+end