timetrap_toggl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e4b6a94a6eeec97774861268215f1ab067c7f26
+  data.tar.gz: 7f7fe8f8e2d77187db7e0e92ed6c5348dd315b56
+SHA512:
+  metadata.gz: a82dc3f012b016b12499579d970012bc9723c8109e02edc81c0bfa7c043be070aea0a3353614820d9da342ae2f955e5054497fb9e4c5ba43940dbcd1b5bed39c
+  data.tar.gz: df9e79006be48f7fc3813044ce4db54cb1ef8c0dffa8349df31adcb05b39313ac69c8eda84554651f3484ed574f85174f1ee06296006340f03dbafb952621061

data/lib/timetrap-toggl.rb

@@ -0,0 +1,38 @@
+require_relative './timetrap_toggl/version'
+require_relative './timetrap_toggl/config'
+require_relative './timetrap_toggl/formatter'
+require_relative './timetrap_toggl/toggler'
+require_relative './timetrap_toggl/output'
+
+begin
+  Module.const_get('Timetrap')
+rescue NameError
+  module Timetrap;
+    module Formatters; end
+    Config = { 'toggl' => { 'aliases' => {} } }
+  end
+end
+
+class Timetrap::Formatters::Toggl
+  attr_reader :entries
+  attr_writer :client, :config
+
+  def initialize(entries)
+    @entries = entries
+  end
+
+  def output
+    results = entries.map { |entry| TimetrapToggl::Formatter.new(entry, config).format }
+
+    toggler = TimetrapToggl::Toggler.new(results, config.client)
+    results   = toggler.toggl
+
+    TimetrapToggl::Output.new(results, config.projects).generate
+  end
+
+  private
+
+  def config
+    @config ||= TimetrapToggl::Config.new
+  end
+end

data/lib/timetrap_toggl/config.rb

@@ -0,0 +1,64 @@
+require "togglv8"
+
+class TimetrapToggl::Config
+  MissingTogglConfig     = Class.new(StandardError)
+  MissingTogglAliases    = Class.new(StandardError)
+  MissingTogglSubdomain  = Class.new(StandardError)
+  DEFAULT_ROUND_IN_MINUTES = 15
+
+  attr_reader :timetrap_config
+
+  def initialize(timetrap_config = Timetrap::Config)
+    @timetrap_config = timetrap_config
+  end
+
+  def api_token
+    config['api_token']
+  end
+
+  def subdomain
+    ensure_subdomain!
+
+    config['subdomain']
+  end
+
+  def round_in_minutes
+    config['round_in_minutes'] || DEFAULT_ROUND_IN_MINUTES
+  end
+
+  def client
+    @client ||= TogglV8::API.new(api_token)
+  end
+
+  def workspace
+    @workspace ||= client.workspaces.find { |w| w["name"] == config["workspace"] }
+  end
+
+  def projects
+    @projects ||= client.projects(workspace["id"])
+  end
+
+  def aliases
+    ensure_aliases!
+
+    config['aliases']
+  end
+
+  def config
+    ensure_config!
+
+    timetrap_config['toggl']
+  end
+
+  def ensure_config!
+    fail(MissingTogglConfig, 'Missing toggl key in .timetrap.yml config file') if timetrap_config.nil? || timetrap_config['toggl'].nil?
+  end
+
+  def ensure_aliases!
+    fail(MissingTogglAliases, 'Missing aliases key in .timetrap.yml config file') if config['aliases'].nil?
+  end
+
+  def ensure_subdomain!
+    fail(MissingTogglSubdomain, 'Missing subdomain key in .timetrap.yml config file') if config['subdomain'].nil?
+  end
+end

data/lib/timetrap_toggl/formatter.rb

@@ -0,0 +1,61 @@
+class TimetrapToggl::Formatter
+  TOGGABLE_REGEX = /@(.*)/
+
+  attr_reader :entry, :config
+
+  def initialize(entry, config)
+    @entry  = entry
+    @config = config
+  end
+
+  def format
+    if project["id"]
+      {
+        "description" => description,
+        "duration" => duration,
+        "start" =>   start,
+        "pid" => project["id"],
+        "created_with" => "timetrap-toggl",
+      }
+    else
+      {
+        error: "Project #{project["name"]} does not exist",
+        note: entry[:note]
+      }
+    end
+  end
+
+  def start
+    TogglV8::API.new.iso8601(entry[:start].to_datetime)
+  end
+
+  def project
+    config.projects.find { |p| p["name"].downcase == code.downcase }
+  end
+
+  def task_id
+    alias_config[:task_id]
+  end
+
+  def round_in_minutes
+    config.round_in_minutes
+  end
+
+  def code
+    if match = TOGGABLE_REGEX.match(entry[:note])
+      code = match[1]
+    end
+  end
+
+  def description
+    entry[:note].gsub("@#{code}", '').strip
+  end
+
+  def duration
+    seconds_for_time(entry[:start], entry[:end])
+  end
+
+  def seconds_for_time(start_time, end_time)
+    (end_time - start_time).to_i
+  end
+end

data/lib/timetrap_toggl/output.rb

@@ -0,0 +1,58 @@
+class TimetrapToggl::Output
+  LINE_DIVIDER     = '-' * 80
+  SUBMITTED_HEADER = "Submitted entries\n#{LINE_DIVIDER}"
+  FAILED_HEADER    = "Failed entries\n#{LINE_DIVIDER}"
+
+  attr_reader :results, :projects
+
+  def initialize(results, projects)
+    @results = results
+    @projects = projects
+  end
+
+  def generate
+    messages = [stats]
+
+    unless submitted.empty?
+      messages << SUBMITTED_HEADER
+      messages += submitted.map do |submitted|
+        project = projects.find { |p| p["id"] == submitted["pid"] }
+        success_message("#{project["name"]} - #{submitted["description"]}")
+      end
+      messages << "\n"
+    end
+
+    unless failed.empty?
+      messages << FAILED_HEADER
+      messages += failed.map do |failed|
+        project = projects.find { |p| p["id"] == failed["pid"] }
+        failed_message(failed[:note], failed[:error])
+      end
+      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_toggl/toggler.rb

@@ -0,0 +1,29 @@
+class TimetrapToggl::Toggler
+  attr_reader :entries, :client
+
+  def initialize(entries, client)
+    @entries = entries
+    @client  = client
+  end
+
+  def toggl
+    entries.each do |entry|
+      if entry.key? :error
+        failed << entry
+      else
+        client.create_time_entry(entry)
+        submitted << entry
+      end
+    end
+
+    { submitted: submitted, failed: failed }
+  end
+
+  def submitted
+    @submitted ||= []
+  end
+
+  def failed
+    @failed ||= []
+  end
+end

data/lib/timetrap_toggl/version.rb

@@ -0,0 +1,3 @@
+module TimetrapToggl
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: timetrap_toggl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Miguel Palhas
+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: togglv8
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !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-toggl bridges the gap between your entries in Timetrap and your
+      project tasks in Toggl allowing for incredible easy timesheet
+      submissions.
+email: mpalhas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/timetrap-toggl.rb
+- lib/timetrap_toggl/config.rb
+- lib/timetrap_toggl/formatter.rb
+- lib/timetrap_toggl/output.rb
+- lib/timetrap_toggl/toggler.rb
+- lib/timetrap_toggl/version.rb
+homepage: https://github.com/dblandin/timetrap-toggl
+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.6.7
+signing_key: 
+specification_version: 4
+summary: A toggl formatter for Timetrap
+test_files: []