freshbookstimestats 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bba95bba59822e0df7d3f6187da642a167363ba
+  data.tar.gz: 8112cbdf0b675d6a6cdfdbe808333b378f1f2906
+SHA512:
+  metadata.gz: c305ede55d96feebdc120b74d16a982ccc7e2aab1e4e74840535b600bdaa676ab39db66729ca666906d42d4c7d03fa8da9377a8d63c13b4a5324b2384cbb9999
+  data.tar.gz: cad6a12999783a34ec83221dd88124bd915158c9fd71055aba742456a9fcf4b0b6dabb20f4867ee5d1bfbe4bee6dd837207ac776487ce50248703d8b88ad9253

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Amiel Martin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Project Stats
+
+Connect to Freshbooks API to enumerate time spent on one project.
+
+## Installation
+
+```
+gem install freshbookstimestats
+```
+
+## Configuration
+
+Create a `~/.freshbooks` with the following:
+
+```shell
+FESHBOOKS_DOMAIN="<subdomain>.freshbooks.com"
+FRESHBOOKS_AUTH_TOKEN="<auth_token>"
+```
+
+Fill in `<subdomain>` and `<auth_token>`. Your `auth_token` can be found on the
+profile page under API Access -> Authentication Token.
+
+## Usage
+
+Run
+
+```shell
+freshbookstimestats
+```
+
+and follow the instructions.
+
+
+That's it!
+

data/bin/freshbookstimestats

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'freshbookstimestats'
+Freshbookstimestats.load '~/.freshbooks'
+Freshbookstimestats.run

data/lib/freshbookstimestats.rb

@@ -0,0 +1,156 @@
+require 'freshbooks.rb'
+require 'dotenv'
+require 'terminal-table'
+
+
+class Task
+  def self.find(id)
+    memoize :task, id do
+      FreshBooks::Task.get id
+    end
+  end
+
+  def self.memoize(*keys)
+    @_cache ||= {}
+    @_cache[keys.join('-')] ||= yield
+  end
+end
+
+class Projects
+  Project = Struct.new(:number, :id, :name)
+
+  def self.pick_project
+    new.select_project
+  end
+
+  def select_project
+    puts project_table
+    print "\nChoose a project number: "
+    project = ask_project_select
+    FreshBooks::Project.get project.id if project
+  end
+
+  private
+
+  def project_table
+    Terminal::Table.new do |t|
+      t << ['Number', 'Project']
+      t << :separator
+
+      puts "Loading projects..."
+      projects.each do |project|
+        t << [project.number, project.name]
+      end
+    end
+  end
+
+  def ask_project_select
+    project_number = gets.chomp
+    project = find_project_by_number project_number.to_i
+    puts "Project not found" if project.nil?
+    project
+  end
+
+  def projects
+    @_projects ||= FreshBooks::Project.list.map { |project|
+      Project.new next_number, project.project_id, project.name
+    }
+  end
+
+  def find_project_by_number(number)
+    projects.find { |project| project.number == number }
+  end
+
+  def next_number
+    @n ||= 0
+    @n += 1 # always increment. This way we'll start with 1
+  end
+end
+
+
+class TimeEntries
+  def self.render_project(project)
+    new(project).render
+  end
+
+  def initialize(project)
+    @project = project
+    @total_hours = 0
+  end
+
+  def render
+    puts time_entries_table
+  end
+
+  private
+
+  attr_reader :project
+
+  def time_entries_table
+    @_time_entries_table ||= Terminal::Table.new title: title do |t|
+      add_header t
+      t.add_separator
+      add_entries t
+      t.add_separator
+      add_totals t
+    end
+  end
+
+  def title
+    project.name
+  end
+
+  def add_header(t)
+    t << ['Task', 'Date', 'Hours', 'Notes']
+  end
+
+  def add_entries(t)
+    entries.each do |entry|
+      task = Task.find entry.task_id
+      @total_hours += entry.hours
+      t << [task.name, entry.date.inspect, render_hours(entry.hours), entry.notes]
+    end
+  end
+
+  def add_totals(t)
+    t << [{ value: 'Project Budget', colspan: 2 }, '%7.2f' % project_budget, '']
+    t << [{ value: 'Total Hours', colspan: 2 }, '%7.2f' % @total_hours, '']
+
+    if !project_budget.zero?
+      remaining = project_budget - @total_hours
+      t << [{ value: 'Time Remaining', colspan: 2 }, '%7.2f' % remaining, '']
+    end
+  end
+
+  def render_hours(hours)
+    '%7.2f' % hours
+  end
+
+  def project_budget
+    @_project_budget ||= project.budget.hours.to_f
+  end
+
+  def entries
+    puts "\nLoading...\n\n"
+    FreshBooks::TimeEntry.list project_id: project_id
+  end
+
+  def project_id
+    project.project_id
+  end
+end
+
+
+module Freshbookstimestats
+  def self.load(dir = nil)
+    Dotenv.load(*Array(dir))
+    FreshBooks::Base.establish_connection(ENV['FRESHBOOKS_DOMAIN'], ENV['FRESHBOOKS_AUTH_TOKEN'])
+  end
+
+  def self.run
+    project = Projects.pick_project
+    TimeEntries.render_project project if project
+  end
+end
+
+

data/lib/freshbookstimestats/version.rb

@@ -0,0 +1,3 @@
+module Freshbookstimestats
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: freshbookstimestats
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Amiel Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: freshbooks.rb
+  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: dotenv
+  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: terminal-table
+  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'
+description: "\n    Freshbookstimestats is a simple command line script that asks
+  shows a nice table\n    of your time entries for a given project.\n  "
+email:
+- amiel@carnesmedia.com
+executables:
+- freshbookstimestats
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/freshbookstimestats
+- lib/freshbookstimestats.rb
+- lib/freshbookstimestats/version.rb
+homepage: https://github.com/carnesmedia/freshbookstimestats
+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.2.0
+signing_key: 
+specification_version: 4
+summary: A simple command-line utility to breakdown project hours
+test_files: []