harvest_overtime 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5922899a634a981bdc3748ddbdda615b61c7c31f
+  data.tar.gz: 43548262290ac6a3cc860fe464f5236a46cfa7df
+SHA512:
+  metadata.gz: 151245df2b95315eb3434e7bc899acfc8cb233ad37722c838df8e9db76378bb9f55dc6ac5cce083f89cf1841e039fd6c286c07d213edd04801aa5084c2b51ee1
+  data.tar.gz: 1ae47d19b4da295d94d50946716a768e1c9d4081af3523c7723712eb49369b360428a6bf9f286f90f8d4cb7c19c10ef92a1b74b2b189de33b4a37fad3400b9fc

data/bin/overtime

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'harvest_overtime'
+require 'active_support/time'
+
+ACCOUNT_ID_ENV_VAR = 'HARVEST_ACCOUNT_ID'
+TOKEN_ENV_VAR = 'HARVEST_TOKEN'
+COLUMN_SIZE = 20
+
+def print_in_columns(array, column_size)
+  puts array.map { |e| e.to_s.ljust(column_size, ' ') }.join
+end
+
+harvest_account_id = ENV[ACCOUNT_ID_ENV_VAR]
+harvest_personal_access_token = ENV[TOKEN_ENV_VAR]
+number_of_months = ARGV[0]&.to_i || 3
+
+unless harvest_account_id && harvest_personal_access_token
+  puts "#{ACCOUNT_ID_ENV_VAR} and #{TOKEN_ENV_VAR} environment variables must be set to use #{__FILE__} script!\n\n" \
+       "usage: #{__FILE__} [number_of_months]"
+  exit(1)
+end
+
+end_date = Date.yesterday
+start_date = (end_date - (number_of_months - 1).months).beginning_of_month
+
+overtime = HarvestOvertime.new(account_id: harvest_account_id, personal_access_token: harvest_personal_access_token)
+per_month_stats = overtime.monthly_stats(start_date, end_date)
+
+print_in_columns(['Month', 'Business hours', 'Billed hours', 'Overtime'], COLUMN_SIZE)
+per_month_stats.each do |month, stats|
+  print_in_columns([month, stats.business_hours, stats.billed_hours.round(1), stats.overtime.round(1)], COLUMN_SIZE)
+end
+
+unless per_month_stats.empty?
+  total_overtime = per_month_stats.values.map(&:overtime).reduce(&:+)
+
+  puts "\nTotal overtime: #{total_overtime.round(1)} hour(s) -> #{(total_overtime / 8).floor} day(s)"
+end

data/lib/harvest_overtime/business_days_computer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class BusinessDaysComputer
+  def business_days(start_date, end_date)
+    (start_date..end_date).reject(&:saturday?).reject(&:sunday?)
+  end
+end

data/lib/harvest_overtime/harvest_client.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'json'
+
+class HarvestClient
+  def initialize(account_id:, personal_access_token:)
+    @faraday = Faraday.new(
+      url: 'https://api.harvestapp.com/api/v2',
+      headers: { 'Harvest-Account-ID' => account_id, 'Authorization' => "Bearer #{personal_access_token}" }
+    )
+  end
+
+  def time_entries(start_date, end_date)
+    user_id = retrieve_user_id
+
+    time_entry_hashes = retrieve_time_entries(user_id, start_date, end_date)
+
+    build_time_entry_objects(time_entry_hashes)
+  end
+
+  private
+
+  attr_reader :faraday
+
+  def retrieve_user_id
+    response = faraday.get('users/me')
+
+    response_body_hash = parse_response(response)
+
+    response_body_hash['id']
+  end
+
+  def retrieve_time_entries(user_id, start_date, end_date)
+    time_entry_hashes = []
+
+    response = faraday.get('time_entries', user_id: user_id, from: start_date.iso8601, to: end_date.iso8601)
+    body_hash = parse_response(response)
+    time_entry_hashes.concat(body_hash['time_entries'])
+
+    while (next_page_url = body_hash.dig('links', 'next'))
+      response = faraday.get(next_page_url)
+      body_hash = parse_response(response)
+      time_entry_hashes.concat(body_hash['time_entries'])
+    end
+
+    time_entry_hashes
+  end
+
+  def parse_response(response)
+    raise "Harvest API request error (status #{response.code}): #{response.body}" unless response.success?
+
+    JSON.parse(response.body)
+  end
+
+  def build_time_entry_objects(time_entry_hashes)
+    time_entry_hashes.map do |time_entry_hash|
+      date = Date.parse(time_entry_hash['spent_date'])
+      hours = time_entry_hash['hours']
+
+      TimeEntry.new(date, hours)
+    end
+  end
+end

data/lib/harvest_overtime/structs.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Month = Struct.new(:year, :month) do
+  def self.from_date(date)
+    new(date.year, date.month)
+  end
+
+  def to_s
+    "#{year}-#{month.to_s.rjust(2, '0')}"
+  end
+end
+
+TimeEntry = Struct.new(:date, :hours) do
+  def month
+    Month.new(date.year, date.month)
+  end
+end
+
+TimeStats = Struct.new(:business_hours, :billed_hours) do
+  def overtime
+    billed_hours - business_hours
+  end
+end

data/lib/harvest_overtime.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'date'
+
+require_relative 'harvest_overtime/structs'
+require_relative 'harvest_overtime/business_days_computer'
+require_relative 'harvest_overtime/harvest_client'
+
+class HarvestOvertime
+  HOURS_PER_DAY = 8
+
+  def initialize(account_id: nil, personal_access_token: nil, harvest_client: nil, business_days_computer: nil)
+    @business_days_computer = business_days_computer || BusinessDaysComputer.new
+    @harvest_client = harvest_client || build_default_harvest_client(account_id, personal_access_token)
+  end
+
+  def monthly_stats(start_date, end_date)
+    business_days = business_days_computer.business_days(start_date, end_date)
+    business_hours_number_by_month = compute_per_month_business_hours_number(business_days)
+
+    time_entries = harvest_client.time_entries(start_date, end_date)
+    billed_hours_by_month = sum_billed_hours_by_month(time_entries)
+
+    business_hours_number_by_month.each_with_object({}) do |(month, business_hours), hash|
+      billed_hours = billed_hours_by_month[month] || 0
+
+      hash[month] = TimeStats.new(business_hours, billed_hours)
+    end
+  end
+
+  private
+
+  attr_reader :business_days_computer, :harvest_client
+
+  def build_default_harvest_client(account_id, personal_access_token)
+    raise ArgumentError, 'account_id must be provided' unless account_id
+    raise ArgumentError, 'personal_access_token must be provided' unless personal_access_token
+
+    HarvestClient.new(account_id: account_id, personal_access_token: personal_access_token)
+  end
+
+  def compute_per_month_business_hours_number(business_days)
+    business_days.each_with_object({}) do |date, hash|
+      month = Month.from_date(date)
+
+      hash[month] ||= 0
+      hash[month] += HOURS_PER_DAY
+    end
+  end
+
+  def sum_billed_hours_by_month(time_entries)
+    time_entries.each_with_object({}) do |entry, hash|
+      month = Month.from_date(entry.date)
+
+      hash[month] ||= 0
+      hash[month] += entry.hours
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: harvest_overtime
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marek Mateja
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple command-line tool for tracking overtime in Harvest
+email: matejowy@gmail.com
+executables:
+- overtime
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/overtime
+- lib/harvest_overtime.rb
+- lib/harvest_overtime/business_days_computer.rb
+- lib/harvest_overtime/harvest_client.rb
+- lib/harvest_overtime/structs.rb
+homepage: https://github.com/mmateja/harvest_overtime
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Keep track of your billed hours in Harvest!
+test_files: []