goal 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 98340b4a1a1dcf76f5106cb7bcf2acb180628280
+  data.tar.gz: dd95639036b8e938b92e0521e26430023f7bfdbb
+SHA512:
+  metadata.gz: 076510ffa8c199ddba9eb3f2d043dd5b920a92492d9d8dfa170e92757a9df260dec3e7495962404efedc49cde36df18d846136aa69b13b9aeccf2442f280a98e
+  data.tar.gz: 26655283aea051418dce99573167876ffd14bd9489296495d3e61563f0d64c888f0b293316c6bb82762e0f47eb9fa000f99124b25f94895760ddfac1cfa1b1aa

data/.gitignore

@@ -0,0 +1,2 @@
+example.rb
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    goal (0.0.2)
+      ruby-freshbooks (~> 0.4.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.2.2)
+    colorize (0.6.0)
+    diff-lcs (1.2.4)
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    multi_xml (0.5.5)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    ruby-freshbooks (0.4.1)
+      builder (>= 2.1.2)
+      httparty (>= 0.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  colorize (~> 0.6.0)
+  goal!
+  rake
+  rspec (~> 2.14.1)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013
+
+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,47 @@
+Goal
+====
+
+## Examples
+
+1) When do you want to know if you'll reach the goal for the current month.
+   Assuming that my goal is 160 hours/month and we are at the 14 business day from
+   the month that have 23 business days.
+
+```ruby
+g = Goal.new
+
+g.calculate_goal(160) # => 97.39130434782608
+```
+
+So I need to have 97.39 hours to be within my goal.
+
+
+## Using the bin
+
+```bash
+$ goal -u freshbooks_user -t freshbooks_token
+
+| Goals | Estimate | Avg. to Goal |
+| 160   | 97       | 4.93         |
+| 200   | 121      | 9.37         |
+| 250   | 152      | 14.93        |
+| 300   | 182      | 20.48        |
+|_________________________________|
+| Current:   115.66h
+| Average:   8.26h
+| Left days: 9
+```
+
+### Available options
+
+```
+Usage: goal [options]
+    -u, --username=USERNAME          Freshbooks username
+    -t, --token=TOKEN                Freshbooks token
+    -g, --goals=[GOALS]              Your goal list. Ex 160:200:300
+```
+
+Options `-u` and `-t` are required and specify the user and token to access the
+Freshbooks hours.
+
+The `-g` is optional, by default it has the following value `160:200:250:300`

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/bin/goal

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+
+require 'goal'
+require 'colorize'
+require 'optparse'
+
+class MyGoals
+  def initialize(options = {})
+    @base = Goal::Base.new
+    @calculator = Goal::HourCalculator.new
+    @goal_list = options.fetch(:goal_list, [160, 200, 250, 300])
+    @username  = options[:username]
+    @token     = options[:token]
+  end
+
+  def print
+    puts
+    print_header
+    print_data
+    print_footer
+    puts
+  end
+
+  private
+
+  attr_reader :base, :calculator, :goal_list, :username, :token
+
+  def print_header
+    puts '| Goals | Estimate | Avg. to Goal |'
+  end
+
+  def print_data
+    goals.each do |goal|
+      avg = calculator.rate_to_goal(goal[:goal], current_time).round(2)
+
+      puts '| ' + goal[:goal].to_s.ljust(5) + ' | ' + goal[:expected].to_i.to_s.ljust(8) + ' | ' + avg.to_s.ljust(12).colorize(average_color(avg)) + ' |'
+    end
+  end
+
+  def print_footer
+    puts '|_________________________________|'
+    puts "| Current:   " + "#{current_time}h".colorize(current_color)
+    puts "| Average:   " + "#{rate}h".colorize(current_color)
+    puts "| Left days: #{calculator.days_left}"
+  end
+
+  def current_time
+    @current_time ||= base.worked_time(username, token).round(2)
+  end
+
+  def rate
+    @rate ||= calculator.hour_rate(current_time).round(2)
+  end
+
+  def goals
+    base.calculate_goals goal_list
+  end
+
+  def current_color
+    if rate < 8
+      :red
+    elsif rate >= 8 && rate < 9
+      :yellow
+    else
+      :green
+    end
+  end
+
+  def average_color(avg)
+    if avg < 8
+      :green
+    elsif avg >= 8 && avg < 9
+      :yellow
+    else
+      :red
+    end
+  end
+end
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: goal [options]"
+
+  opts.on("-u", "--username=USERNAME", "Freshbooks username") do |u|
+    options[:username] = u
+  end
+
+  opts.on("-t", "--token=TOKEN", "Freshbooks token") do |t|
+    options[:token] = t
+  end
+
+  opts.on("-g", "--goals=[GOALS]", "Your goal list. Ex 160:200:300") do |g|
+    options[:goal_list] = g.split(':').map(&:to_i)
+  end
+end.parse!
+
+MyGoals.new(options).print

data/goal.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "goal/version"
+
+Gem::Specification.new do |s|
+  s.name        = "goal"
+  s.version     = Goal::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ["MIT"]
+  s.summary     = "Keep track of your hour goals"
+  s.email       = "mcomogo@gmail.com"
+  s.homepage    = "http://github.com/comogo/goal"
+  s.description = s.summary
+  s.authors     = ['Mateus Lorandi dos Santos']
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+  s.executables << 'goal'
+
+  s.add_dependency 'ruby-freshbooks', '~> 0.4.1'
+
+  s.add_development_dependency 'colorize', '~> 0.6.0'
+  s.add_development_dependency 'rspec', '~> 2.14.1'
+  s.add_development_dependency 'rake'
+end

data/lib/goal/base.rb

@@ -0,0 +1,32 @@
+module Goal
+  class Base
+    def initialize
+      @calculator = HourCalculator.new
+    end
+
+    def worked_time(username, token)
+      FreshbooksCalculator.new(username, token).hours
+    end
+
+    def calculate_goal(goal)
+      calculator.estimated_for(goal)
+    end
+
+    def calculate_goals(goals)
+      calculated_goals = []
+
+      goals.each do |goal|
+        calculated_goals.push({
+          goal: goal,
+          expected: calculate_goal(goal)
+        })
+      end
+
+      calculated_goals
+    end
+
+    private
+
+    attr_reader :calculator
+  end
+end

data/lib/goal/freshbooks_calculator.rb

@@ -0,0 +1,48 @@
+require 'ruby-freshbooks'
+
+module Goal
+  class FreshbooksCalculator
+    def initialize(freshbooks_username, token)
+      @username = freshbooks_username
+      @token    = token
+    end
+
+    def hours
+      entries_for_month.inject(0) { |sum, entry| sum + entry['hours'].to_f }
+    end
+
+    private
+
+    attr_reader :username, :token
+
+    def entries_for_month
+      entries = connection.time_entry.list(date_from: date_from, date_to: date_to, per_page: per_page)
+
+      if entries.has_key?('time_entries')
+        entries['time_entries']['time_entry']
+      else
+        []
+      end
+    end
+
+    def date_from
+      Date.new Date.today.year, Date.today.month, 1
+    end
+
+    def date_to
+      Date.new Date.today.year, Date.today.month, -1
+    end
+
+    def per_page
+      1000
+    end
+
+    def client_url
+      "#{username}.freshbooks.com"
+    end
+
+    def connection
+      @connection ||= FreshBooks::Client.new(client_url, token)
+    end
+  end
+end

data/lib/goal/hour_calculator.rb

@@ -0,0 +1,43 @@
+module Goal
+  class HourCalculator
+    def total_days_until(date = Date.today)
+      total = 0
+      month = Date.today.month
+      year  = Date.today.year
+      date.day.downto(1) do |day|
+        current = Date.new(year, month, day)
+
+        total += 1 unless current.saturday? || current.sunday?
+      end
+
+      total
+    end
+
+    def estimated_for(goal)
+      current_days = total_days_until
+      total_days   = total_days_until(end_of_month)
+
+      hours_per_day = goal.to_f / total_days.to_f
+
+      current_days * hours_per_day
+    end
+
+    def hour_rate(hours_until_now)
+      hours_until_now.to_f / total_days_until.to_f
+    end
+
+    def rate_to_goal(goal, hours_until_now)
+      (goal - hours_until_now) / days_left
+    end
+
+    def days_left
+      total_days_until(end_of_month) - total_days_until
+    end
+
+    private
+
+    def end_of_month
+      Date.new(Date.today.year, Date.today.month, -1)
+    end
+  end
+end

data/lib/goal/version.rb

@@ -0,0 +1,3 @@
+module Goal
+  VERSION = '0.0.2'.freeze
+end

data/lib/goal.rb

@@ -0,0 +1,6 @@
+require 'goal/hour_calculator'
+require 'goal/freshbooks_calculator'
+require 'goal/base'
+
+module Goal
+end

data/spec/base_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Goal::Base do
+  describe '#worked_time' do
+    it 'should get the worked_time from freshbooks' do
+      freshbooks_instance = double(:freshbooks_instance)
+
+      Goal::FreshbooksCalculator.should_receive(:new).with('username', 'token').and_return(freshbooks_instance)
+      freshbooks_instance.should_receive(:hours).and_return(30)
+
+      expect(subject.worked_time('username', 'token')).to eq 30
+    end
+  end
+
+  describe '#calculate_goal' do
+    it 'should calculate goal using the hour calculator' do
+      Goal::HourCalculator.any_instance.should_receive(:estimated_for).with(200).and_return 10
+
+      expect(subject.calculate_goal(200)).to eq 10
+    end
+  end
+
+  describe '#calculate_goals' do
+    it 'should calculate goals using the hour calculator' do
+      Goal::HourCalculator.any_instance.should_receive(:estimated_for).with(160).and_return 10
+      Goal::HourCalculator.any_instance.should_receive(:estimated_for).with(200).and_return 20
+
+      expect(subject.calculate_goals([160, 200])).to eq([
+        {
+          goal: 160,
+          expected: 10
+        },
+        {
+          goal: 200,
+          expected: 20
+        }
+      ])
+    end
+  end
+end

data/spec/freshbooks_calculator_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Goal::FreshbooksCalculator do
+  let(:time_entry) { double(:time_entry) }
+  let(:connection) { double(:connection, time_entry: time_entry) }
+  let(:end_of_month) { Date.new Date.today.year, Date.today.month, -1 }
+  let(:begin_of_month) { Date.new Date.today.year, Date.today.month, 1 }
+
+  let :entries do
+    {
+      'time_entries' => {
+        'time_entry' => [
+          {
+            'hours' => '10.5'
+          },
+          {
+            'hours' => '5.4'
+          }
+        ]
+      }
+    }
+  end
+
+  let :error_entries do
+    {
+      message: 'error',
+      code: '12345'
+    }
+  end
+
+  subject do
+    described_class.new 'username', 'token'
+  end
+
+  describe '#hours' do
+    context 'when has entries' do
+      it 'should be the sum of entry hours' do
+        FreshBooks::Client.should_receive(:new).with('username.freshbooks.com', 'token').and_return(connection)
+        time_entry.
+          should_receive(:list).
+          with(date_from: begin_of_month, date_to: end_of_month, per_page: 1000).
+          and_return(entries)
+
+        expect(subject.hours).to eq 15.9
+      end
+    end
+
+    context 'when has no entries' do
+      it 'should be 0' do
+        FreshBooks::Client.should_receive(:new).with('username.freshbooks.com', 'token').and_return(connection)
+        time_entry.
+          should_receive(:list).
+          with(date_from: begin_of_month, date_to: end_of_month, per_page: 1000).
+          and_return(error_entries)
+
+        expect(subject.hours).to eq 0
+      end
+    end
+  end
+end

data/spec/hour_calculator_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Goal::HourCalculator do
+  describe '#total_days_until' do
+    it 'should calculate the business days from the beginning of the month until the specified day' do
+      expect(subject.total_days_until Date.new(2013, 10, 17)).to eq 13 # Thursday
+      expect(subject.total_days_until Date.new(2013, 10, 18)).to eq 14 # Friday
+      expect(subject.total_days_until Date.new(2013, 10, 19)).to eq 14 # Saturday
+      expect(subject.total_days_until Date.new(2013, 10, 20)).to eq 14 # Sunday
+      expect(subject.total_days_until Date.new(2013, 10, 21)).to eq 15 # Monday
+    end
+
+    it 'it default option should be the current day' do
+      Date.stub(today: Date.new(2013, 10, 18))
+
+      expect(subject.total_days_until).to eq 14
+    end
+  end
+
+  describe '#estimated_for' do
+    it 'should calculate the calculate the current total time for goal until today' do
+      Date.stub(today: Date.new(2013, 10, 18))
+
+      expect(subject.estimated_for(160)).to eq 97.39130434782608
+      expect(subject.estimated_for(200)).to eq 121.7391304347826
+    end
+  end
+
+  describe '#hour_rate' do
+    it 'should calculate the hour rate from a given time and the past days' do
+      Date.stub(today: Date.new(2013, 10, 18))
+
+      expect(subject.hour_rate(95)).to eq 6.785714285714286
+    end
+  end
+
+  describe '#rate_to_goal' do
+    it 'should calculate the hour per day needed to the goal from the left days of the month' do
+      Date.stub(today: Date.new(2013, 10, 18))
+
+      expect(subject.rate_to_goal(200, 115.66)).to eq 9.371111111111112
+    end
+  end
+
+  describe '#days_left' do
+    it 'should return the days left from de month since today' do
+      Date.stub(today: Date.new(2013, 10, 18))
+
+      expect(subject.days_left).to eq 9
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require "goal"
+require "rspec"
+require "rspec/autorun"
+
+require "rubygems"
+
+Dir["spec/support/**/*.rb"].each { |f| require f }

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: goal
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Mateus Lorandi dos Santos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-freshbooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !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'
+description: Keep track of your hour goals
+email: mcomogo@gmail.com
+executables:
+- goal
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/goal
+- goal.gemspec
+- lib/goal.rb
+- lib/goal/base.rb
+- lib/goal/freshbooks_calculator.rb
+- lib/goal/hour_calculator.rb
+- lib/goal/version.rb
+- spec/base_spec.rb
+- spec/freshbooks_calculator_spec.rb
+- spec/hour_calculator_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/comogo/goal
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Keep track of your hour goals
+test_files: []
+has_rdoc: