supaspoida-harvest 0.8.2 → 0.8.3

data/lib/harvest/resources/timer.rb

@@ -0,0 +1,96 @@
+module Harvest
+  module Resources
+    # This class is a hack to maintain compatibility with the ActiveResource
+    # API and Harvest's fucked time tracking API.
+    class Timer < Harvest::HarvestResource
+      self.element_name = 'daily'
+      self.prefix = '/daily/:action_hack'
+      self.collection_name = ''
+
+      # Override to not use collection_path
+      def create
+        headers = self.class.headers.merge 'Accept' => 'application/xml'
+        connection.post('/daily/add', encode, headers).tap do |response|
+          self.id = id_from_response(response)
+          load_attributes_from_response(response)
+        end
+      end
+
+      # Override to use POST instead of PUT, and update path
+      def update
+        headers = self.class.headers.merge 'Accept' => 'application/xml'
+        connection.post(element_path(prefix_options.merge(:action_hack => :update)), encode, headers).tap do |response|
+          load_attributes_from_response(response)
+        end
+      end
+
+      # Override to use delete path
+      def destroy
+        connection.delete(element_path(:action_hack => :delete), self.class.headers)
+      end
+
+      # Override to pull day_entry element data into attributes
+      def initialize attributes={}
+        @attributes     = {}
+        @prefix_options = {}
+        load(attributes.has_key?('day_entry') ? attributes['day_entry'] : attributes)
+      end
+
+      # Override to support Harvest's custom XML format
+      def encode options={}
+        massaged_attributes = {
+          :notes => attributes['notes'],
+          :hours => attributes['hours'].to_s,
+          :project_id => (project ? project.id : nil),
+          :task_id => (task ? task.id : nil),
+          :spent_at => attributes['spent_at'] || Date.today
+        }
+        self.class.format.encode(massaged_attributes, {:root => 'request'}.merge(options))
+      end
+
+      def project
+        @project ||= find_project
+      end
+
+      def find_project
+        case p = attributes['project']
+        when Integer then Harvest::Resources::Project.find(p)
+        else; Harvest::Resources::Project.find(:all).find{|pp|pp.name.strip == p.to_s.strip}
+        end
+      end
+
+      def task
+        @task ||= find_task
+      end
+
+      def find_task
+        case t = attributes['task']
+        when Integer then Harvest::Resources::Task.find(t)
+        else; Harvest::Resources::Task.find(:all).find{|tt|tt.name.strip == t.to_s.strip}
+        end
+      end
+
+      class << self
+        # Override to remove file extension
+        def element_path_with_extension_removal id, prefix_options = {}, query_options = nil
+          element_path_without_extension_removal(id, prefix_options, query_options).sub(/\.#{format.extension}/, '')
+        end
+        alias_method_chain :element_path, :extension_removal
+
+        # Override to use show path
+        def find_single_with_action_hack scope, options
+          options ||= {} and options[:params] ||= {}
+          options[:params].merge!(:action_hack => :show)
+          find_single_without_action_hack scope, options
+        end
+        alias_method_chain :find_single, :action_hack
+
+        # Override to use delete path
+        def delete_with_action_hack id, options={}
+          delete_without_action_hack id, options.merge(:action_hack => :delete)
+        end
+        alias_method_chain :delete, :action_hack
+      end
+    end
+  end
+end

data/test/unit/resources/timer_test.rb

@@ -0,0 +1,152 @@
+require File.join(File.dirname(__FILE__), "..", "..", "test_helper")
+
+class TimerTest < Test::Unit::TestCase
+
+  def setup_resources
+    attrs = {
+      :id => 1,
+      :hours => 5,
+      :client => 'Iridesco',
+      :project => 'Harvest',
+      :task => 'Backend Programming',
+      :notes => 'Test api support'
+    }
+    @timer_xml    =  {:day_entry => attrs}.to_xml(:root => "timer")
+    @task         =  {:id => 1, :name => "Backend Programming"}.to_xml(:root => "task")
+    @tasks        = [{:id => 1, :name => "Backend Programming"}].to_xml(:root => "tasks") 
+    @project_xml  =  {:id => 1, :name => "Harvest"}.to_xml(:root => "project")
+    @projects     = [{:id => 1, :name => "Harvest"}].to_xml(:root => "projects")
+  end
+
+  def mock_responses
+    @headers = {
+      'Accept' => 'application/xml'
+    }
+    @post_headers = {
+      'Content-Type' => 'application/xml; charset=utf-8',
+    }.merge @headers
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get    "/daily/show/1",        @headers,       @timer_xml,   200
+      mock.post   "/daily/add",           @post_headers,  @timer_xml,   201, "Location" => "/daily/show/2"
+      mock.post   "/daily/update/1",      @post_headers,  nil,          200
+      mock.delete "/daily/delete/1",      @headers,       nil,          200
+
+      mock.get    "/projects.xml",        {}, @projects
+      mock.get    "/projects/1.xml",      {}, @project_xml
+
+      mock.get    "/tasks.xml",           {}, @tasks
+      mock.get    "/tasks/1.xml",         {}, @task
+    end
+  end
+
+  context "Timer CRUD actions -- " do
+    setup do
+      setup_resources
+      mock_responses
+    end
+
+#    should "get index" do
+#      Harvest::Resources::Daily.find(:all)
+#      expected_request = ActiveResource::Request.new(:get, "/daily/#{@day}/#{@year}")
+#      assert ActiveResource::HttpMock.requests.include?(expected_request)
+#    end
+
+    should "get a single timer" do
+      Harvest::Resources::Timer.find(1)
+      expected_request = ActiveResource::Request.new(:get, "/daily/show/1")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+
+    should "create a new timer" do
+      timer = Harvest::Resources::Timer.new(:hours => 5)
+      timer.save
+      expected_request = ActiveResource::Request.new(:post, "/daily/add", timer.encode, @post_headers)
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+
+    should "update an existing timer" do
+      timer = Harvest::Resources::Timer.find(1)
+      timer.hours = 10
+      timer.save
+      expected_request = ActiveResource::Request.new(:post, "/daily/update/1", timer.encode, @post_headers)
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+
+    should "delete an existing timer" do
+      Harvest::Resources::Timer.delete(1)
+      expected_request = ActiveResource::Request.new(:delete, "/daily/delete/1")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+
+    should "delete an existing timer using an instance" do
+      timer = Harvest::Resources::Timer.find(1)
+      timer.destroy
+      expected_request = ActiveResource::Request.new(:delete, "/daily/delete/1")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+
+    should "load attributes from the day_entry element" do
+      timer = Harvest::Resources::Timer.find(1)
+      assert !timer.id.nil?
+    end
+
+    should "output XML per Harvest's spec" do
+      timer = Harvest::Resources::Timer.find(1)
+      xml = <<-XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <request>
+          <notes>Test api support</notes>
+          <hours>5</hours>
+          <project_id type="integer">1</project_id>
+          <task_id type="integer">1</task_id>
+          <spent_at type="date">#{Date.today.strftime("%a, %e %b %Y")}</spent_at>
+        </request>
+      XML
+      expected = Hash.from_xml(xml)
+      real = Hash.from_xml(timer.encode)
+      assert_equal expected, real
+    end
+  end
+
+  context "Projects" do
+    setup do
+      setup_resources
+      mock_responses
+    end
+
+    should "provide access to the project when set with an id" do
+      timer = Harvest::Resources::Timer.new(:project => 1)
+      assert timer.project.is_a?(Harvest::Resources::Project)
+      assert_equal 1, timer.project.id
+      assert_equal 'Harvest', timer.project.name
+    end
+
+    should "provide access to the project when set with a string" do
+      timer = Harvest::Resources::Timer.new(:project => "Harvest")
+      assert timer.project.is_a?(Harvest::Resources::Project)
+      assert_equal 1, timer.project.id
+      assert_equal 'Harvest', timer.project.name
+    end
+  end
+
+  context "Tasks" do
+    setup do
+      setup_resources
+      mock_responses
+    end
+
+    should "provide access to the task when set with an id" do
+      timer = Harvest::Resources::Timer.new(:task => 1)
+      assert timer.task.is_a?(Harvest::Resources::Task)
+      assert_equal 1, timer.task.id
+      assert_equal 'Backend Programming', timer.task.name
+    end
+
+    should "provide access to the task when set with a string" do
+      timer = Harvest::Resources::Timer.new(:task => "Backend Programming")
+      assert timer.task.is_a?(Harvest::Resources::Task)
+      assert_equal 1, timer.task.id
+      assert_equal 'Backend Programming', timer.task.name
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: supaspoida-harvest
 version: !ruby/object:Gem::Version 
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors: 
 - Kyle Banker
@@ -56,6 +56,7 @@ files:
 - lib/harvest/resources/project.rb
 - lib/harvest/resources/task.rb
 - lib/harvest/resources/task_assignment.rb
+- lib/harvest/resources/timer.rb
 - lib/harvest/resources/user_assignment.rb
 - lib/harvest/base.rb
 - lib/harvest/harvest_resource.rb
@@ -97,6 +98,7 @@ test_files:
 - test/unit/resources/project_test.rb
 - test/unit/resources/task_test.rb
 - test/unit/resources/task_assignment_test.rb
+- test/unit/resources/timer_test.rb
 - test/unit/resources/user_assignment_test.rb
 - test/integration/client_integration.rb
 - test/integration/task_integration.rb