Merge pull request #46 from zenhob/faraday

Switch to a Faraday-based JSON API client for Harvest.

8 files changed, 121 insertions, 131 deletions

diff --git a/lib/hcl.rb b/lib/hcl.rb
index 8f7be26..5d6f108 100644
--- a/lib/hcl.rb
+++ b/lib/hcl.rb
@@ -1,10 +1,12 @@
 module HCl
   autoload :VERSION, 'hcl/version'
   autoload :App, 'hcl/app'
+  autoload :Net, 'hcl/net'
   autoload :Commands, 'hcl/commands'
   autoload :TimesheetResource, 'hcl/timesheet_resource'
   autoload :Utility, 'hcl/utility'
   autoload :Project, 'hcl/project'
   autoload :Task, 'hcl/task'
   autoload :DayEntry, 'hcl/day_entry'
+  autoload :HarvestMiddleware, 'hcl/harvest_middleware'
 end
diff --git a/lib/hcl/app.rb b/lib/hcl/app.rb
index 1bceab8..1f641d5 100644
--- a/lib/hcl/app.rb
+++ b/lib/hcl/app.rb
@@ -62,15 +62,15 @@ module HCl
       rescue SocketError => e
         $stderr.puts "Connection failed. (#{e.message})"
         exit 1
-      rescue TimesheetResource::ThrottleFailure => e
+      rescue HarvestMiddleware::ThrottleFailure => e
         $stderr.puts "Too many requests, retrying in #{e.retry_after+5} seconds..."
         sleep e.retry_after+5
         run
-      rescue TimesheetResource::AuthFailure => e
+      rescue HarvestMiddleware::AuthFailure => e
         $stderr.puts "Unable to authenticate: #{e}"
         request_config
         run
-      rescue TimesheetResource::Failure => e
+      rescue HarvestMiddleware::Failure => e
         $stderr.puts "API failure: #{e}"
         exit 1
       end
@@ -140,7 +140,7 @@ EOM
         if has_security_command?
           load_password config
         end
-        TimesheetResource.configure config
+        Net.configure config
       else
         request_config
       end
@@ -153,7 +153,7 @@ EOM
       config['password'] = ask("Password: ") { |q| q.echo = false }.to_s
       config['subdomain'] = ask("Subdomain: ").to_s
       config['ssl'] = /^y/.match(ask("Use SSL? (y/n): ").downcase)
-      TimesheetResource.configure config
+      Net.configure config
       write_config config
     end
 
diff --git a/lib/hcl/commands.rb b/lib/hcl/commands.rb
index e9fd847..98daff5 100644
--- a/lib/hcl/commands.rb
+++ b/lib/hcl/commands.rb
@@ -7,8 +7,7 @@ module HCl
 
     # Display a sanitized view of your auth credentials.
     def config
-      TimesheetResource.config_hash.merge(password:'***').
-        map {|k,v| "#{k}: #{v}" }.join("\n")
+      Net.config_hash.merge(password:'***').map {|k,v| "#{k}: #{v}" }.join("\n")
     end
 
     def tasks project_code=nil
diff --git a/lib/hcl/day_entry.rb b/lib/hcl/day_entry.rb
index 6ef1708..645bb3d 100644
--- a/lib/hcl/day_entry.rb
+++ b/lib/hcl/day_entry.rb
@@ -1,5 +1,3 @@
-require 'rexml/document'
-
 module HCl 
   class DayEntry < TimesheetResource
     include Utility
@@ -8,7 +6,9 @@ module HCl
     # defaults to today.
     def self.all date = nil
       url = date.nil? ? 'daily' : "daily/#{date.strftime '%j/%Y'}"
-      from_xml get(url)
+      doc = Net.get url
+      Task.cache_tasks_hash doc
+      doc[:day_entries].map {|e| new e}
     end
 
     def to_s
@@ -19,19 +19,10 @@ module HCl
       @data[:task]
     end
 
-    def self.from_xml xml
-      doc = REXML::Document.new xml
-      raise Failure, "No root node in XML document: #{xml}" if doc.root.nil?
-      Task.cache_tasks doc
-      doc.root.elements.collect('//day_entry') do |day|
-        new xml_to_hash(day)
-      end
-    end
-
     def cancel
       begin
         DayEntry.delete("daily/delete/#{id}")
-      rescue TimesheetResource::Failure
+      rescue HarvestMiddleware::Failure
         return false
       end
       true
@@ -46,8 +37,7 @@ module HCl
       # If I don't include hours it gets reset.
       # This doens't appear to be the case for task and project.
       (self.notes << "\n#{new_notes}").lstrip!
-      DayEntry.post "daily/update/#{id}",
-        %{<request><notes>#{notes}</notes><hours>#{hours}</hours></request>}
+      Net.post "daily/update/#{id}", notes:notes, hours:hours
     end
 
     def self.with_timer date=nil
@@ -73,7 +63,7 @@ module HCl
     end
 
     def toggle
-      DayEntry.get("daily/timer/#{id}")
+      Net.get("daily/timer/#{id}")
       self
     end
 
diff --git a/lib/hcl/harvest_middleware.rb b/lib/hcl/harvest_middleware.rb
new file mode 100644
index 0000000..4d742ed
--- /dev/null
+++ b/lib/hcl/harvest_middleware.rb
@@ -0,0 +1,47 @@
+require 'faraday_middleware/response_middleware'
+require 'multi_json'
+require 'cgi'
+
+class HCl::HarvestMiddleware < FaradayMiddleware::ResponseMiddleware
+  class Failure < StandardError; end
+  class AuthFailure < StandardError; end
+  class ThrottleFailure < StandardError
+    attr_reader :retry_after
+    def initialize env
+      @retry_after = env[:response_headers]['retry-after'].to_i
+      super "Too many requests! Try again in #{@retry_after} seconds."
+    end
+  end
+
+  def call(env)
+    @app.call(env).on_complete do |env|
+      case env[:status]
+      when 200..299
+        begin 
+          env[:body] = unescape(MultiJson.load(env[:body], symbolize_keys:true))
+        rescue MultiJson::LoadError
+          env[:body]
+        end
+      when 300..399
+        raise Failure, "Redirected! Perhaps your ssl configuration variable is set incorrectly?"
+      when 400..499
+        raise AuthFailure, "Login failed."
+      when 503
+       raise ThrottleFailure, env
+      else
+        raise Failure, "Unexpected response from the upstream API."
+      end
+    end
+  end
+
+  def unescape obj
+    if obj.kind_of? Hash
+      obj.inject({}){|o,(k,v)| o[k] = unescape(v);o}
+    elsif obj.kind_of? Array
+      obj.inject([]){|o,v| o << unescape(v);o}
+    else
+      CGI.unescape_html(obj.to_s)
+    end
+  end
+
+end
diff --git a/lib/hcl/net.rb b/lib/hcl/net.rb
new file mode 100644
index 0000000..874240c
--- /dev/null
+++ b/lib/hcl/net.rb
@@ -0,0 +1,48 @@
+require 'faraday_middleware'
+
+module HCl
+  module Net
+    class << self
+      # configuration accessors
+      CONFIG_VARS = [ :login, :password, :subdomain, :ssl ].freeze
+      CONFIG_VARS.each { |config_var| attr_accessor config_var }
+
+      def config_hash
+        CONFIG_VARS.inject({}) {|c,k| c.update(k => send(k)) }
+      end
+
+      def configure opts = nil
+        if opts
+          self.login = opts['login']
+          self.password = opts['password']
+          self.subdomain = opts['subdomain']
+          self.ssl = opts['ssl']
+        end
+      end
+
+      def faraday
+        @faraday ||= Faraday.new(
+          "http#{ssl && 's'}://#{subdomain}.harvestapp.com"
+        ) do |f|
+          f.headers['Accept'] = 'application/json'
+          f.request :json
+          f.request :basic_auth, login, password
+          f.use HCl::HarvestMiddleware, content_type: /\bjson\b/
+          f.adapter Faraday.default_adapter
+        end
+      end
+
+      def get action
+        faraday.get(action).body
+      end
+
+      def post action, data
+        faraday.post(action, data).body
+      end
+
+      def delete action
+        faraday.delete(action).body
+      end
+    end
+  end
+end
diff --git a/lib/hcl/task.rb b/lib/hcl/task.rb
index 79b9917..e1d5b58 100644
--- a/lib/hcl/task.rb
+++ b/lib/hcl/task.rb
@@ -3,18 +3,13 @@ require 'fileutils'
 
 module HCl
   class Task < TimesheetResource
-    def self.cache_tasks doc
-      tasks = []
-      doc.root.elements.collect('projects/project') do |project_elem|
-        project = Project.new xml_to_hash(project_elem)
-        tasks.concat(project_elem.elements.collect('tasks/task') do |task|
-          new xml_to_hash(task).merge(:project => project)
-        end)
-      end
+    def self.cache_tasks_hash day_entry_hash
+      tasks = day_entry_hash[:projects].
+        map { |p| p[:tasks].map {|t| new t.merge(project:Project.new(p)) } }.flatten.uniq
       unless tasks.empty?
         FileUtils.mkdir_p(cache_dir)
         File.open(cache_file, 'w') do |f|
-          f.write tasks.uniq.to_yaml
+          f.write tasks.to_yaml
         end
       end
     end
@@ -55,16 +50,13 @@ module HCl
     def add opts
       notes = opts[:note]
       starting_time = opts[:starting_time] || 0
-      days = DayEntry.from_xml Task.post("daily/add", <<-EOT)
-      <request>
-        <notes>#{notes}</notes>
-        <hours>#{starting_time}</hours>
-        <project_id type="integer">#{project.id}</project_id>
-        <task_id type="integer">#{id}</task_id>
-        <spent_at type="date">#{Date.today}</spent_at>
-      </request>
-      EOT
-      days.first
+      DayEntry.new Net.post("daily/add", {
+        notes: notes,
+        hours: starting_time,
+        project_id: project.id,
+        task_id: id,
+        spent_at: Date.today
+      })
     end
 
     def start opts
@@ -72,7 +64,7 @@ module HCl
       if day.running?
         day
       else
-        DayEntry.from_xml(Task.get("daily/timer/#{day.id}")).first
+        DayEntry.new Net.get("daily/timer/#{day.id}")
       end
     end
   end
diff --git a/lib/hcl/timesheet_resource.rb b/lib/hcl/timesheet_resource.rb
index 8fa7f5c..28e5378 100644
--- a/lib/hcl/timesheet_resource.rb
+++ b/lib/hcl/timesheet_resource.rb
@@ -1,90 +1,9 @@
-require 'net/http'
-require 'net/https'
-require 'cgi'
-
 module HCl
   class TimesheetResource
-    class Failure < StandardError; end
-    class AuthFailure < StandardError; end
-    class ThrottleFailure < StandardError
-      attr_reader :retry_after
-      def initialize response
-        @retry_after = response.headers['Retry-After'].to_i
-        super "Too many requests! Try again in #{@retry_after} seconds."
-      end
-    end
-
-    def self.configure opts = nil
-      if opts
-        self.login = opts['login']
-        self.password = opts['password']
-        self.subdomain = opts['subdomain']
-        self.ssl = opts['ssl']
-      end
-    end
-
-    # configuration accessors
-    CONFIG_VARS = [ :login, :password, :subdomain, :ssl ].freeze
-    CONFIG_VARS.each do |config_var|
-      class_eval <<-EOC
-        def self.#{config_var}= arg
-          @@#{config_var} = arg
-        end
-        def self.#{config_var}
-          @@#{config_var}
-        end
-      EOC
-    end
-
-    # @return [Hash]
-    def self.config_hash
-      CONFIG_VARS.inject({}) {|c,k| c.update(k => TimesheetResource.send(k)) }
-    end
-
     def initialize params
       @data = params
     end
 
-    def self.get action
-      http_do Net::HTTP::Get, action
-    end
-
-    def self.post action, data
-      http_do Net::HTTP::Post, action, data
-    end
-
-    def self.delete action
-      http_do Net::HTTP::Delete, action
-    end
-
-    def self.connect
-      Net::HTTP.new("#{subdomain}.harvestapp.com", (ssl ? 443 : 80)).tap do |https|
-        https.use_ssl = ssl
-        https.verify_mode = OpenSSL::SSL::VERIFY_NONE if ssl
-      end
-    end
-
-    def self.http_do method_class, action, data = nil
-      https = connect
-      request = method_class.new "/#{action}"
-      request.basic_auth login, password
-      request.content_type = 'application/xml'
-      request['Accept']    = 'application/xml'
-      response = https.request request, data
-      case response
-      when Net::HTTPSuccess
-        response.body
-      when Net::HTTPFound
-        raise Failure, "Redirected! Perhaps your ssl configuration variable is set incorrectly?"
-      when Net::HTTPServiceUnavailable
-        raise ThrottleFailure, response
-      when Net::HTTPUnauthorized
-        raise AuthFailure, "Login failed."
-      else
-        raise Failure, "Unexpected response from the upstream API."
-      end
-    end
-
     def id
       @data[:id]
     end
@@ -96,12 +15,5 @@ module HCl
     def respond_to? method
       (@data && @data.key?(method.to_sym)) || super
     end
-
-    def self.xml_to_hash elem
-      elem.elements.map { |e| e.name }.inject({}) do |a, f|
-        a[f.to_sym] = CGI.unescape_html(elem.elements[f].text || '') if elem.elements[f]
-        a
-      end
-    end
   end
 end