harvest-ruby-v2 0.3.3 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 657bfe3e49665ad68a2d7498b8b775b6d7704701a807cbce5739d52e677e405b
-  data.tar.gz: 9ced52a03ca53b10967c20e87ad156259c457d957a134196f89c403b6e97fc01
+  metadata.gz: cffdd572f038a6df6e90e8f2380d03c0b035dc687bd7ad49748a5e93c936095c
+  data.tar.gz: 60e6607a331fd3d6a892d803f7663050ccd61456bec9b84089d279f9c9b7a9fd
 SHA512:
-  metadata.gz: 257341d20fd30a3e582784368020e32a903d9a87e9b6487aa6f6d1e85a57d170ccaf8082b9818da285d93c079bfad65925780e779430039e194fc85ffde426da
-  data.tar.gz: 40a10bf4c46b6d48db61e4a4a8eeef8afd1db7e5a37c1018279967a1e02b6ace9314e12759d72080ba55fce393f8271a8b5874c83d8724d39de7f97f85a8146d
+  metadata.gz: 516bd47d51be828209b10d602c67bf2845a619bbbbacaa51b10ca2aeda4ad639a761455b6e6ff83f87854c06943ab6743eb42878b746e6276d624f90cd96bbe2
+  data.tar.gz: d42421df510e3d08e7a9e1ff8d9410911c3897a069e2270cabc966da8cc4c564afffd804b03b331d45791b7fa9e4a2dc1c6bbed4e66c8213447abaa681079244

data/CHANGELOG.rst

@@ -0,0 +1,13 @@
+##########################
+Changelog for harvest-ruby
+##########################
+
+0.5.1
+^^^^^
+
+* Harvest API external_reference on time entries now contains account_id, updated Struct
+
+0.5.0
+^^^^^
+
+* Fixed bug with ApiCall which caused query params to not be passed to the underlying call.

data/Gemfile

@@ -8,6 +8,7 @@ gemspec
 gem 'activesupport', '~> 6.0'
 gem 'configparser', '~> 0.1.7', group: :development
 gem 'pry', '~> 0.13.1', group: :development
+gem 'pry-stack_explorer', '~> 0.5.1', group: :development
 gem 'rake', '~> 12.0', group: :development
 gem 'redcarpet', '~> 3.5', group: :development
 gem 'reek', '~> 6.0', group: :development

data/Rakefile

@@ -9,6 +9,8 @@ RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:spec) do |rubocop|
   rubocop.options << '--auto-correct'
   rubocop.options << '--display-cop-names'
+  rubocop.options << '--extra-details'
+  rubocop.options << '--display-style-guide'
 end
 
 YARD::Rake::YardocTask.new do |t|

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'pry'
+require 'pry-stack_explorer'
 require 'configparser'
 require 'date'
 require "bundler/setup"

data/lib/harvest.rb

@@ -11,9 +11,11 @@ require 'harvest/exceptions'
 require 'harvest/finders'
 require 'harvest/discovers'
 require 'harvest/creates'
+require 'harvest/changers'
 
 # Conform to naming pattern of Finder, Discover, Creators.
 # @param key [Symbol] symbol of state
+# @return [Symbol] Symbol to use in class lookups
 def to_class_name(key)
   key.to_s.split('_').map(&:capitalize).join.to_sym
 end
@@ -38,14 +40,17 @@ module Harvest
       @client = Harvest::HTTP::Api.new(**@config)
       @factory = Harvest::ResourceFactory.new
       @state = state
-      @active_user = @factory.user(@client.api_call(@client.api_caller('/users/me')))
-      @admin_api = if @active_user.is_admin
+      @admin_api = if active_user.is_admin
                      config.admin_api
                    else
                      false
                    end
     end
 
+    def active_user
+      @state[:active_user] ||= @factory.user(@client.api_call(@client.api_caller('/users/me')))
+    end
+
     def allowed?(meth)
       %i[
         projects
@@ -90,6 +95,16 @@ module Harvest
       self
     end
 
+    # Find single instance of resource
+    def change(**kwargs)
+      @state[@state[:active]].map do |_obj|
+        Harvest::Changers.const_get(to_class_name(@state[:active])).new.change(
+          @factory, @client, active_user, @state, kwargs
+        )
+      end
+      self
+    end
+
     # Discover resources
     def discover(**params)
       @state[@state[:active]] = Harvest::Discovers
@@ -101,6 +116,16 @@ module Harvest
       self
     end
 
+    # Create an instance of object based on state
+    def create(**kwargs)
+      @state[@state[:active]] = Harvest::Create.const_get(
+        to_class_name(@state[:active])
+      ).new.create(
+        @factory, @client, active_user, @state, kwargs
+      )
+      self
+    end
+
     # Select a subset of all items depending on state
     def select(&block)
       @state[@state[:active]] = @state[@state[:active]].select(&block)
@@ -116,15 +141,5 @@ module Harvest
     def data
       @state[@state[:active]]
     end
-
-    # Create an instance of object based on state
-    def create(**kwargs)
-      @state[@state[:active]] = Harvest::Create.const_get(
-        to_class_name(@state[:active])
-      ).new.create(
-        @factory, @client, active_user, @state, kwargs
-      )
-      self
-    end
   end
 end

data/lib/harvest/changers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Harvest
+  module Changers
+    class TimeEntry
+      def change(factory, client, _active_user, state, kwargs)
+        # binding.pry
+        state[state[:active]].map do |te|
+          send(kwargs[:action].to_sym, factory, client, te)
+        end
+      end
+
+      private
+
+      def restart(factory, client, te)
+        # PATCH /v2/time_entries/{TIME_ENTRY_ID}/restart
+        # binding.pry
+        [factory.time_entry(client.api_call(client.api_caller("time_entries/#{te.id}/restart", http_method: 'patch')))]
+      end
+
+      def stop(factory, client, te)
+        # PATCH /v2/time_entries/{TIME_ENTRY_ID}/stop
+        [factory.time_entry(client.api_call(client.api_caller("time_entries/#{te.id}/stop", http_method: 'patch')))]
+      end
+    end
+  end
+end

data/lib/harvest/creates.rb

@@ -34,8 +34,8 @@ module Harvest
 
       # @api private
       def time_entry_payload(kwargs)
-        possible_keys = %i[spent_date notes external_reference user_id]
-        payload = kwargs.map { |k, v| [k, v] if possible_keys.include?(k) }.to_h
+        possible_keys = %i[spent_date notes external_reference user_id project_id task_id]
+        payload = kwargs.each { |k, v| [k, v] if possible_keys.include?(k) }.to_h
         payload[:user_id] ||= @active_user.id
         payload[:task_id] = @state[:project_tasks][0].task.id
         payload[:project_id] = true_project(@state[:projects][0]).id

data/lib/harvest/discovers.rb

@@ -43,6 +43,9 @@ module Harvest
         paginator.path = 'time_entries'
         paginator.data_key = 'time_entries'
         paginator.param = params
+
+        # require 'pry'; binding.pry
+
         client.pagination(paginator).map do |time_entry|
           factory.time_entry(time_entry)
         end

data/lib/harvest/finders.rb

@@ -10,7 +10,7 @@ module Harvest
 
     class TimeEntry
       def find(factory, client, id)
-        [factory.time_entry(client.api_call(client.api_caller("time_entry/#{id}")))]
+        [factory.time_entry(client.api_call(client.api_caller("time_entries/#{id}")))]
       end
     end
   end

data/lib/harvest/httpclient.rb

@@ -71,7 +71,7 @@ module Harvest
 
       # Make a api call to an endpoint.
       # @api public
-      # @param struct [Struct::ApiCall]
+      # @param struct [ApiCall]
       def api_call(struct)
         JSON.parse(
           send(struct.http_method.to_sym, struct).tap do
@@ -85,7 +85,9 @@ module Harvest
       # @param struct [Struct::Pagination]
       def pagination(struct)
         struct.param[:page] = struct.page_count
-        page = api_call(struct.to_api_call)
+        page = api_call(struct.to_api_call).tap do
+          # require 'pry'; binding.pry
+        end
         struct.rows.concat(page[struct.data_key])
 
         return struct.rows if struct.page_count >= page['total_pages']
@@ -108,11 +110,11 @@ module Harvest
       end
 
       def api_caller(path, http_method: 'get', param: {}, payload: nil, headers: {})
-        Struct::ApiCall.new(
+        ApiCall.new(
           {
             path: path,
             http_method: http_method.to_sym,
-            param: param,
+            params: param,
             payload: payload,
             headers: headers
           }
@@ -125,22 +127,43 @@ module Harvest
         client[struct.path].get(struct.headers)
       end
 
+      def delete(struct)
+        client[struct.path].delete(struct.headers)
+      end
+
       def post(struct)
         client[struct.path].post(struct.payload, struct.headers)
       end
+
+      def patch(struct)
+        client[struct.path].patch(struct.payload, struct.headers)
+      end
     end
 
-    Struct.new(
-      'ApiCall',
-      :path,
-      :http_method,
-      :param,
-      :payload,
-      :headers,
-      keyword_init: true
-    ) do
-      def param(params)
-        headers['params'] = params
+    class NoOptionProvided; end
+
+    class ApiCall
+      attr_accessor :path, :http_method, :payload, :headers
+
+      def initialize(path:, payload: {}, http_method: 'get', headers: {}, params: {})
+        @path = path
+        @http_method = http_method
+        @payload = payload
+        @headers = headers
+        param(params)
+      end
+
+      def param(params = NoOptionProvided)
+        if params == NoOptionProvided
+          @headers['params']
+        else
+          @headers['params'] = params
+        end
+      end
+
+      def param=(params)
+        param(params)
+        self
       end
     end
 
@@ -157,11 +180,11 @@ module Harvest
       keyword_init: true
     ) do
       def to_api_call
-        Struct::ApiCall.new(
-          {
+        ApiCall.new(
+          **{
             path: path,
             http_method: http_method,
-            param: param,
+            params: param,
             payload: payload,
             headers: headers
           }

data/lib/harvest/resources/timeentry.rb

@@ -26,6 +26,8 @@ module Harvest
     #   associated invoice's id and number.
     # @param hours [decimal]
     #   Number of (decimal time) hours tracked in this time entry.
+    # @param hours_without_timer [decimal]
+    #   Number of (decimal time) hours already tracked in this time entry, before the timer was last started.
     # @param rounded_hours [decimal]
     #   Number of (decimal time) hours tracked in this time entry used in summary
     #   reports and invoices. This value is rounded according to the Time Rounding
@@ -73,6 +75,7 @@ module Harvest
       :external_reference,
       :invoice,
       :hours,
+      :hours_without_timer,
       :rounded_hours,
       :notes,
       :is_locked,
@@ -95,6 +98,7 @@ module Harvest
     TimeEntryExternalReference = Struct.new(
       'TimeEntryExternalReference',
       :id,
+      :account_id,
       :group_id,
       :permalink,
       :service,

data/lib/harvest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Harvest
-  VERSION = '0.3.3'
+  VERSION = '0.5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: harvest-ruby-v2
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.5.2
 platform: ruby
 authors:
 - Craig Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -61,6 +61,7 @@ files:
 - bin/setup
 - harvest-ruby-v2.gemspec
 - lib/harvest.rb
+- lib/harvest/changers.rb
 - lib/harvest/client.rb
 - lib/harvest/config.rb
 - lib/harvest/creates.rb