timetrap-harvest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03fab5bae6ce25a24e1981f32c5922b288873441
+  data.tar.gz: d8a7d3b7ab8afd04e425b2563ed6b5e34155e126
+SHA512:
+  metadata.gz: d99ff0d276e539a1b7912ed936caad6e0f404161fe9ec945e5475ea195b28fba0fd860954b74588e2f26f32d53920f6d3576fc0b9378515c5131a80e13c0a5fd
+  data.tar.gz: 951ccb521d6f69789ce7a94ffb72b86ac4d23a30b8c516a267e8b590ebd020df8a9a34eae4499da311c22d7a46b582ef568b1c5d8bfcb662b1b7b9aa635c2194

data/lib/timetrap-harvest.rb

@@ -0,0 +1,42 @@
+require_relative './timetrap_harvest/config'
+require_relative './timetrap_harvest/network_client'
+require_relative './timetrap_harvest/formatter'
+require_relative './timetrap_harvest/harvester'
+require_relative './timetrap_harvest/output'
+
+begin
+  Module.const_get('Timetrap')
+rescue NameError
+  module Timetrap;
+    module Formatters; end
+    Config = { 'harvest' => { 'aliases' => {} } }
+  end
+end
+
+class Timetrap::Formatters::Harvest
+  attr_reader :entries
+  attr_writer :client, :config
+
+  def initialize(entries)
+    @entries = entries
+  end
+
+  def output
+    results = entries.map { |entry| TimetrapHarvest::Formatter.new(entry, config).format }
+
+    harvester = TimetrapHarvest::Harvester.new(results, client)
+    results   = harvester.harvest
+
+    TimetrapHarvest::Output.new(results).generate
+  end
+
+  private
+
+  def config
+    @config ||= TimetrapHarvest::Config.new
+  end
+
+  def client
+    @client ||= TimetrapHarvest::NetworkClient.new(config)
+  end
+end

data/lib/timetrap_harvest/config.rb

@@ -0,0 +1,62 @@
+class TimetrapHarvest::Config
+  MissingHarvestConfig     = Class.new(StandardError)
+  MissingHarvestAliases    = Class.new(StandardError)
+  MissingHarvestSubdomain  = Class.new(StandardError)
+  DEFAULT_ROUND_IN_MINUTES = 15
+
+  attr_reader :timetrap_config
+
+  def initialize(timetrap_config = Timetrap::Config)
+    @timetrap_config = timetrap_config
+  end
+
+  def email
+    config['email']
+  end
+
+  def password
+    config['password']
+  end
+
+  def subdomain
+    ensure_subdomain!
+
+    config['subdomain']
+  end
+
+  def round_in_minutes
+    config['round_in_minutes'] || DEFAULT_ROUND_IN_MINUTES
+  end
+
+  def alias_config(code)
+    if config = aliases[code]
+      config = config.split(' ')
+
+      { project_id: config.first, task_id: config.last }
+    end
+  end
+
+  def aliases
+    ensure_aliases!
+
+    config['aliases']
+  end
+
+  def config
+    ensure_config!
+
+    timetrap_config['harvest']
+  end
+
+  def ensure_config!
+    fail(MissingHarvestConfig, 'Missing harvest key in .timetrap.yml config file') if timetrap_config.nil? || timetrap_config['harvest'].nil?
+  end
+
+  def ensure_aliases!
+    fail(MissingHarvestAliases, 'Missing aliases key in .timetrap.yml config file') if config['aliases'].nil?
+  end
+
+  def ensure_subdomain!
+    fail(MissingHarvestSubdomain, 'Missing subdomain key in .timetrap.yml config file') if config['subdomain'].nil?
+  end
+end

data/lib/timetrap_harvest/formatter.rb

@@ -0,0 +1,57 @@
+class TimetrapHarvest::Formatter
+  HARVESTABLE_REGEX = /@(.*)/
+
+  attr_reader :entry, :config
+
+  def initialize(entry, config)
+    @entry  = entry
+    @config = config
+  end
+
+  def format
+    if alias_config
+      { notes:      entry[:note],
+        hours:      hours_for_time(entry[:start], entry[:end]),
+        project_id: project_id.to_i,
+        task_id:    task_id.to_i,
+        spent_at:   entry[:start].strftime('%Y%m%d')
+      }
+    elsif code
+      { error: 'Missing task alias config', note: entry[:note] }
+    else
+      { error: 'No task alias provided', note: entry[:note] }
+    end
+  end
+
+  def project_id
+    alias_config[:project_id]
+  end
+
+  def task_id
+    alias_config[:task_id]
+  end
+
+  def alias_config
+    config.alias_config(code)
+  end
+
+  def round_in_minutes
+    config.round_in_minutes
+  end
+
+  def code
+    if match = HARVESTABLE_REGEX.match(entry[:note])
+      code = match[1]
+    end
+  end
+
+  def hours_for_time(start_time, end_time)
+    minutes = (end_time - start_time) / 60
+    rounded = round(minutes)
+    hours   = (rounded / 60)
+  end
+
+  def round(value, nearest = round_in_minutes)
+    (value % nearest).zero? ? value : (value + nearest) - (value % nearest)
+  end
+end

data/lib/timetrap_harvest/harvester.rb

@@ -0,0 +1,30 @@
+class TimetrapHarvest::Harvester
+  attr_reader :results, :client
+
+  def initialize(results, client)
+    @results = results
+    @client  = client
+  end
+
+  def harvest
+    results.each do |result|
+      if result.key? :error
+        failed << result
+      else
+        client.post(result)
+
+        submitted << result
+      end
+    end
+
+    { submitted: submitted, failed: failed }
+  end
+
+  def submitted
+    @submitted ||= []
+  end
+
+  def failed
+    @failed ||= []
+  end
+end

data/lib/timetrap_harvest/network_client.rb

@@ -0,0 +1,29 @@
+require 'net/http'
+require 'json'
+require 'uri'
+
+class TimetrapHarvest::NetworkClient
+  attr_reader :email, :password, :subdomain
+
+  def initialize(config)
+    @email     = config.email
+    @password  = config.password
+    @subdomain = config.subdomain
+  end
+
+  def post(payload)
+    req = Net::HTTP::Post.new(harvest_add_uri.request_uri)
+    req.basic_auth(email, password)
+    req.body            = payload.to_json
+    req['Content-Type'] = 'application/json'
+    req['Accept']       = 'application/json'
+
+    res = Net::HTTP.start(harvest_add_uri.hostname, harvest_add_uri.port, use_ssl: true) do |http|
+      http.request(req)
+    end
+  end
+
+  def harvest_add_uri
+    URI("https://#{subdomain}.harvestapp.com/daily/add")
+  end
+end

data/lib/timetrap_harvest/output.rb

@@ -0,0 +1,51 @@
+class TimetrapHarvest::Output
+  LINE_DIVIDER     = '-' * 80
+  SUBMITTED_HEADER = "Submitted entries\n#{LINE_DIVIDER}"
+  FAILED_HEADER    = "Failed entries\n#{LINE_DIVIDER}"
+
+  attr_reader :results
+
+  def initialize(results = {})
+    @results = results
+  end
+
+  def generate
+    messages = [stats]
+
+    unless submitted.empty?
+      messages << SUBMITTED_HEADER
+      messages += submitted.map { |submitted| success_message(submitted[:notes]) }
+      messages << "\n"
+    end
+
+    unless failed.empty?
+      messages << FAILED_HEADER
+      messages += failed.map { |failed| failed_message(failed[:note], failed[:error]) }
+      messages << "\n"
+    end
+
+    messages.join("\n")
+  end
+
+  private
+
+  def stats
+    "Submitted: #{submitted.count}\nFailed: #{failed.count}\n"
+  end
+
+  def submitted
+    results.fetch(:submitted, [])
+  end
+
+  def failed
+    results.fetch(:failed, [])
+  end
+
+  def success_message(note)
+    "Submitted: #{note}"
+  end
+
+  def failed_message(note, error)
+    "Failed (#{error}): #{note}"
+  end
+end

data/lib/timetrap_harvest/version.rb

@@ -0,0 +1,3 @@
+module TimetrapHarvest
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: timetrap-harvest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Devon Blandin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: timetrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: |2
+      timetrap-harvest bridges the gap between your entries in Timetrap and your
+      project tasks in Harvest allowing for incredible easy timesheet
+      submissions.
+email: dblandin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/timetrap-harvest.rb
+- lib/timetrap_harvest/config.rb
+- lib/timetrap_harvest/formatter.rb
+- lib/timetrap_harvest/harvester.rb
+- lib/timetrap_harvest/network_client.rb
+- lib/timetrap_harvest/output.rb
+- lib/timetrap_harvest/version.rb
+homepage: https://github.com/dblandin/timetrap-harvest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.3.0
+signing_key: 
+specification_version: 4
+summary: A Harvest formatter for Timetrap
+test_files: []