beggar 0.0.5.alpha → 1.0.0

data/.rspec

@@ -1 +1 @@
---color
+--color -f d

data/Gemfile.lock

@@ -1,52 +1,30 @@
 PATH
   remote: .
   specs:
-    beggar (0.0.4.alpha)
-      basecamp
+    beggar (0.0.5.alpha)
+      httparty
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.1.3)
-      activesupport (= 3.1.3)
-      builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activeresource (3.1.3)
-      activemodel (= 3.1.3)
-      activesupport (= 3.1.3)
-    activesupport (3.1.3)
-      multi_json (~> 1.0)
-    addressable (2.2.6)
-    basecamp (0.0.7)
-      activeresource (>= 2.3.0)
-      oauth2
-      xml-simple
-    builder (3.0.0)
     diff-lcs (1.1.3)
-    faraday (0.7.5)
-      addressable (~> 2.2.6)
-      multipart-post (~> 1.1.3)
-      rack (>= 1.1.0, < 2)
-    i18n (0.6.0)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
     multi_json (1.0.4)
-    multipart-post (1.1.4)
-    oauth2 (0.5.1)
-      faraday (~> 0.7.4)
-      multi_json (~> 1.0.3)
-    rack (1.3.5)
-    rspec (2.7.0)
-      rspec-core (~> 2.7.0)
-      rspec-expectations (~> 2.7.0)
-      rspec-mocks (~> 2.7.0)
-    rspec-core (2.7.1)
-    rspec-expectations (2.7.0)
+    multi_xml (0.4.1)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.7.0)
-    xml-simple (1.1.1)
+    rspec-mocks (2.8.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   beggar!
-  rspec
+  rspec (>= 2.7.0)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Bartłomiej Kozal
+Copyright (c) 2012 Bartłomiej Kozal
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,12 +1,39 @@
 # Beggar [![Build Status](https://secure.travis-ci.org/bkzl/beggar.png)](http://travis-ci.org/bkzl/beggar)
 
-Tool for generating time reports from Basecamp
+## Description
 
-## Installation
-  TODO
+Beggar is a tool for generating time reports from your Basecamp account
 
-## Usage
-  TODO
+Example output:
+
+    78% || 140.0h, -12.0h || 5320.0 zł, -456.0 zł
+
+where
+
+    78% - working days progress in current month
+    140.0h, -12.0h - worked hours ratio
+    5320.0 zł, -456.0 zł - salary ratio
+
+### Installation
+
+Install it like any ruby gem
+
+    gem install beggar
+
+and run by
+
+    beggar
+
+### Configuration
+
+Before first use, beggar will try to create configuration file in your home directory (~/.beggar)
+
+Example config:
+
+    company: pear
+    token: abc123
+    rate: 50.0
 
 ## Changelog
-  TODO
+  v1.0.0 - first stable release
+

data/beggar.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_development_dependency "rspec"
-  s.add_runtime_dependency "basecamp"
+  s.add_development_dependency "rspec", ">= 2.7.0"
+  s.add_dependency "httparty"
 end

data/bin/beggar

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
 require "beggar"
-runner = Beggar::CLI.new(ARGV)
-runner.start
+
+Beggar::CLI.run
+

data/lib/beggar/base.rb

@@ -1,20 +1,37 @@
 # encoding: utf-8
-
 module Beggar
   class Base
-    def initialize(config)
-      Basecamp.establish_connection!("#{config['company']}.basecamphq.com", config['token'], 'X', true)
+    attr_accessor :basecamp
+
+    def initialize(basecamp)
+      @basecamp = basecamp
+    end
 
-      Hours.project_id = config['project']['id']
-      Salary.rate = config['project']['rate']
+    def progress
+      "#{CurrentMonth.days_progression}%"
     end
 
-    def self.me
-      @@me ||= Basecamp::Person.me
+    def worked_hours
+      "#{basecamp.worked_hours}h, #{ratio(basecamp.hours_ratio)}h"
+    end
+
+    def salary
+      "#{as_money(basecamp.worked_hours)} zł, #{ratio(as_money(basecamp.hours_ratio))} zł"
     end
 
     def summary
-      [CurrentMonth, Hours, Salary].join(' || ')
+      [progress, worked_hours, salary].join(' || ')
+    end
+
+  private
+
+    def as_money(hours)
+      hours * basecamp.config['rate']
+    end
+
+    def ratio(number)
+      (number > 0) ? "-#{number}" : "+#{number.abs}"
     end
   end
 end
+

data/lib/beggar/basecamp.rb

@@ -0,0 +1,47 @@
+module Beggar
+  class Basecamp
+    include HTTParty
+
+    attr_accessor :config
+
+    def initialize(config)
+      @config = config
+
+      self.class.base_uri("https://#{config['company']}.basecamphq.com")
+      self.class.basic_auth(config['token'], 'X')
+    end
+
+    def time_report(options = {})
+      options.merge!( subject_id: current_user )
+      get(%(/time_entries/report.xml#{params(options)}))
+    end
+
+    def current_user
+      @current_user ||= get('/me.xml')['person']['id']
+    end
+
+    def current_month
+      @current_month ||= time_report(from: CurrentMonth.first_day, to: CurrentMonth.today)
+    end
+
+    def worked_hours
+      current_month['time_entries'].map do |entry|
+        entry['hours']
+      end.inject(:+)
+    end
+
+    def hours_ratio
+      CurrentMonth.weekday_hours_until_today - worked_hours
+    end
+
+  private
+
+    def get(path)
+      self.class.get(path)
+    end
+
+    def params(options)
+      '?' + options.map { |name, value| "#{name}=#{value}" }.join('&')
+    end
+  end
+end

data/lib/beggar/cli.rb

@@ -1,17 +1,43 @@
 module Beggar
   class CLI
-    def initialize(args = nil)
-      @config = load_config
-    end
+    class << self
+      def run
+        begin
+          $stdout.puts Base.new(Basecamp.new(load_config)).summary
+        rescue Errno::ENOENT
+          create_config
+          $stdout.puts "New config has been created in ~/.beggar"
+          $stdout.puts "Please fill it with proper data."
+        rescue URI::InvalidURIError
+          $stdout.puts "Ensure that your config file is proper formatted!" 
+        end
+        exit 0
+      end
 
-    def start
-      $stdout.puts Beggar::Base.new(@config).summary
-    end
+    private
+
+      def load_config
+        YAML.load_file(config)
+      end
 
-  private
+      def create_config
+        File.open(config, "w") do |output|
+          YAML.dump(defaults, output)
+        end
+      end
 
-    def load_config
-      YAML.load_file(File.join(ENV['HOME'], '.beggar'))
+      def defaults
+        {
+          "company" => "___",
+          "token" => "___",
+          "rate" => "___"
+        }
+      end
+
+      def config
+        "#{Dir.home}/.beggar"
+      end
     end
   end
 end
+

data/lib/beggar/current_month.rb

@@ -1,25 +1,50 @@
 module Beggar
   class CurrentMonth
     class << self
+      def weekdays
+        weekdays_until(last_day)
+      end
+
+      def weekdays_until_today
+        weekdays_until(today)
+      end
+
+      def weekday_hours
+        weekdays * 8.0
+      end
+
+      def weekday_hours_until_today
+        weekdays_until_today * 8.0
+      end
+
+      def days_progression
+        (weekdays_until_today * 100.0 / weekdays).round
+      end
+
+      def weekdays_until(date)
+        (first_day..date).reject { |d| [0, 6].include? d.wday }.length
+      end
+
       def first_day
-        Date.new(Date.today.year, Date.today.month, 1)
+        Date.new(year, month, 1)
       end
 
       def last_day
         first_day.next_month - 1
       end
 
-      def working_days(range)
-        range.reject { |d| [0,6].include? d.wday }.size
+      def year
+        today.year
       end
 
-      def working_days_up_today
-        working_days(first_day..Date.today)
+      def month
+        today.month
       end
 
-      def to_s
-        %[#{(working_days_up_today.to_f / working_days(first_day..last_day) * 100).round}%]
+      def today
+        Date.today
       end
     end
   end
 end
+

data/lib/beggar/version.rb

@@ -1,3 +1,4 @@
 module Beggar
-  VERSION = "0.0.5.alpha"
+  VERSION = "1.0.0"
 end
+

data/lib/beggar.rb

@@ -1,8 +1,8 @@
-require 'basecamp'
 require 'yaml'
-require 'beggar/version'
-require 'beggar/cli'
+require 'httparty'
+
 require 'beggar/base'
+require 'beggar/basecamp'
+require 'beggar/cli'
 require 'beggar/current_month'
-require 'beggar/hours'
-require 'beggar/salary'
+

data/spec/base_spec.rb

@@ -1,19 +1,70 @@
-require 'spec_helper'
+# encoding: utf-8
+require 'beggar'
 
 describe Beggar::Base do
-  before do
-    Basecamp.stub(:establish_connection!)
-    Basecamp::Person.stub(me: 'x')
-    Beggar::CurrentMonth.stub(to_s: 'a')
-    Beggar::Hours.stub(to_s: 'b')
-    Beggar::Salary.stub(to_s: 'c')
+  let(:basecamp) { double('Basecamp', config: { 'rate' => 50.0 }) }
+  let(:base) { Beggar::Base.new(basecamp) }
+
+  describe 'displaying weekdays progression as a percents' do
+    it 'returns 62% on 17th February 2012' do
+      Date.stub(today: Date.new(2012, 2, 17))
+      base.progress.should == "62%"
+    end
+
+    it 'returns 9% on 2nd December 2011' do
+      Date.stub(today: Date.new(2011, 12, 2))
+      base.progress.should == "9%"
+    end
+
+    it 'returns 100% on 30th November 1988' do
+      Date.stub(today: Date.new(1988, 11, 30))
+      base.progress.should == "100%"
+    end
+  end
+
+  context 'when 4 days have been free in February 2012 and rate is equal $50' do
+    before do
+      basecamp.stub(worked_hours: 136.0, hours_ratio: 32.0)
+    end
+
+    it 'returns "136.0h, -32.0h"' do
+      base.worked_hours.should == "136.0h, -32.0h"
+    end
+
+    it 'returns "6800.0 zł, -1600.0 zł"' do
+      base.salary.should == "6800.0 zł, -1600.0 zł"
+    end
   end
 
-  subject do
-    config = double(:[] => { company: 'abc', token: 'xyz', project: { id: 1, rate: 1.0 }})
-    Beggar::Base.new(config)
+  context 'when 1 day has been worked extra in February 2012 and rate is equal $50' do
+    before do
+      basecamp.stub(worked_hours: 176.0, hours_ratio: -8.0)
+    end
+
+    it 'returns "176.0h, +8.0h"' do
+      base.worked_hours.should == "176.0h, +8.0h"
+    end
+
+    it 'returns "8800.0 zł, +$400.0 zł"' do
+      base.salary.should == "8800.0 zł, +400.0 zł"
+    end
   end
 
-  its(:summary) { should == %(a || b || c) }
-  its(:me) { should == 'x' }
+  describe 'private methods' do
+    it 'returns formatted ratio' do
+      base.send(:ratio, 1.0).should == "-1.0"
+      base.send(:ratio, -3.0).should == "+3.0"
+    end
+
+    it 'returns hours multiplied by rate' do
+      basecamp.stub(:config).and_return({ 'rate' => 50.0 })
+      base.send(:as_money, 5.0).should == 250.0
+    end
+  end
+
+  it 'returns summary' do
+    base.stub(progress: "78%", worked_hours: "140.0h, -12.0h", salary: "5320.0 zł, -456.0 zł")
+    base.summary.should == "78% || 140.0h, -12.0h || 5320.0 zł, -456.0 zł"
+  end
 end
+

data/spec/basecamp_spec.rb

@@ -0,0 +1,69 @@
+require 'beggar'
+
+describe Beggar::Basecamp do
+  let(:config) { YAML.load_file(File.expand_path('../fixtures/beggar', __FILE__)) }
+  let(:basecamp) { Beggar::Basecamp.new(config) }
+
+  before do
+    Date.stub(today: Date.new(2012, 02, 17))
+  end
+
+  describe 'constructor' do
+    after do
+      Beggar::Basecamp.new(config)
+    end
+
+    it 'set base uri' do
+      Beggar::Basecamp.should_receive(:base_uri).with('https://pear.basecamphq.com')
+    end
+
+    it 'set basic auth credentials' do
+      Beggar::Basecamp.should_receive(:basic_auth).with('abc123', 'X')
+    end
+  end
+
+  it 'returns user id' do
+    response = { 'person' => { 'id' => 1 }}
+    basecamp.class.should_receive(:get).with('/me.xml').and_return(response)
+    basecamp.current_user.should == 1
+  end
+
+  it 'returns time report for current user' do
+    basecamp.stub(current_user: 1)
+    basecamp.class.should_receive(:get).with('/time_entries/report.xml?subject_id=1')
+    basecamp.time_report
+  end
+
+  it 'returns time report for current month' do
+    Date.stub(today: Date.new(2012, 02, 17))
+    basecamp.stub(current_user: 1)
+    basecamp.class.should_receive(:get).with('/time_entries/report.xml?from=2012-02-01&to=2012-02-17&subject_id=1')
+    basecamp.current_month
+  end
+
+  it 'returns worked hours' do
+    response = { "time_entries" =>
+      [{ "hours" => 8.0 }, { "hours" => 6.0 }, { "hours" => 8.0 }]
+    }
+    basecamp.stub(current_month: response)
+    basecamp.worked_hours.should == 22.0
+  end
+
+  it 'returns hours ratio with minus when working hours > weekdays hours' do
+    basecamp.stub(worked_hours: 106.0)
+    basecamp.hours_ratio.should == -2.0
+  end
+
+  it 'returns hours ratio with plus when worked hours < weekdays hours' do
+    basecamp.stub(worked_hours: 96.0)
+    basecamp.hours_ratio.should == 8.0
+  end
+
+  describe 'private methods' do
+    it 'parses options to path params' do
+      basecamp.send(:params, { name: 'bob'}).should == '?name=bob'
+      basecamp.send(:params, { name: 'bob', surname: 'example'}).should == '?name=bob&surname=example'
+    end
+  end
+end
+

data/spec/cli_spec.rb

@@ -0,0 +1,48 @@
+require 'beggar'
+
+describe Beggar::CLI do
+  let(:config) { "#{Dir.home}/.beggar" }
+
+  before do
+    $stdout.stub(:puts)
+    Beggar::Basecamp.stub(new: double('Basecamp'))
+    Beggar::Base.stub_chain(:new, :summary)
+  end
+
+  after do
+    -> { Beggar::CLI.run }.should raise_error { SystemExit }
+  end
+
+  context 'when config file exists' do
+    it "loads it before running" do
+      YAML.should_receive(:load_file).with(config).and_return(double('configuration'))
+    end
+  end
+
+  context 'when config file not exists' do
+    let(:default_config) {
+      {
+        "company" => "___",
+        "token" => "___",
+        "rate" => "___"
+      }
+    }
+
+    before do
+      YAML.should_receive(:load_file).with(config) { raise Errno::ENOENT }
+    end
+    it "creates config with default settings" do
+      output = double('output')
+      File.should_receive(:open).with(config, "w").and_yield(output)
+      YAML.should_receive(:dump).with(default_config, output)
+    end
+
+    it 'displays notification' do
+      $stdout.unstub(:puts)
+      Beggar::CLI.stub(:create_config)
+      $stdout.should_receive(:puts).with("New config has been created in ~/.beggar")
+      $stdout.should_receive(:puts).with("Please fill it with proper data.")
+    end
+  end
+end
+

data/spec/current_month_spec.rb

@@ -1,18 +1,19 @@
-require 'spec_helper'
+require 'beggar'
 
+# FIXME add missing specs
 describe Beggar::CurrentMonth do
-  context 'today is the 24th December 2011' do
-    before { Date.stub(today: Date.new(2011, 12, 24)) }
+  let(:current_month) { Beggar::CurrentMonth }
 
-    let(:first_day) { Date.new(2011, 12, 1) }
-    let(:last_day) { Date.new(2011, 12, 31) }
+  before do
+    Date.stub(today: Date.new(2012, 2, 17))
+  end
 
-    subject { Beggar::CurrentMonth }
+  it 'returns weekdays in hours' do
+    current_month.weekday_hours.should == 168.0
+  end
 
-    its(:first_day) { should == first_day }
-    its(:last_day) { should == last_day }
-    it { subject.working_days(first_day..last_day).should == 22 }
-    its(:working_days_up_today) { should == 17 }
-    its(:to_s) { should == '77%' }
+  it 'returns weekdays in hours until today' do
+    current_month.weekday_hours_until_today.should == 104.0
   end
 end
+

data/spec/fixtures/beggar

@@ -0,0 +1,4 @@
+company: pear
+token: abc123
+rate: 50.0
+

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: beggar
 version: !ruby/object:Gem::Version
-  version: 0.0.5.alpha
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Bartlomiej Kozal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-27 00:00:00.000000000 Z
+date: 2012-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70156177413840 !ruby/object:Gem::Requirement
+  requirement: &70213892896680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70156177413840
+  version_requirements: *70213892896680
 - !ruby/object:Gem::Dependency
-  name: basecamp
-  requirement: &70156177413280 !ruby/object:Gem::Requirement
+  name: httparty
+  requirement: &70213892895980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70156177413280
+  version_requirements: *70213892895980
 description: Tool for generating time reports from Basecamp. You can specify rate
   for each project and get value of your month salary.
 email:
@@ -54,16 +54,15 @@ files:
 - bin/beggar
 - lib/beggar.rb
 - lib/beggar/base.rb
+- lib/beggar/basecamp.rb
 - lib/beggar/cli.rb
 - lib/beggar/current_month.rb
-- lib/beggar/hours.rb
-- lib/beggar/salary.rb
 - lib/beggar/version.rb
 - spec/base_spec.rb
+- spec/basecamp_spec.rb
+- spec/cli_spec.rb
 - spec/current_month_spec.rb
-- spec/hours_spec.rb
-- spec/salary_spec.rb
-- spec/spec_helper.rb
+- spec/fixtures/beggar
 homepage: https://github.com/bkzl/beggar
 licenses: []
 post_install_message: 
@@ -79,9 +78,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: beggar
 rubygems_version: 1.8.11
@@ -90,7 +89,7 @@ specification_version: 3
 summary: Tool for generating time reports from Basecamp
 test_files:
 - spec/base_spec.rb
+- spec/basecamp_spec.rb
+- spec/cli_spec.rb
 - spec/current_month_spec.rb
-- spec/hours_spec.rb
-- spec/salary_spec.rb
-- spec/spec_helper.rb
+- spec/fixtures/beggar

data/lib/beggar/hours.rb

@@ -1,26 +0,0 @@
-# encoding: utf-8
-
-module Beggar
-  class Hours
-    class << self
-      attr_accessor :project_id
-
-      def worked
-        params = { project_id: project_id, from: CurrentMonth.first_day, to: Date.today }
-        @@worked ||= Basecamp::TimeEntry.report(params).select { |te| te.person_id == Base.me.id }.map(&:hours).inject(&:+)
-      end
-
-      def max_up_today
-        CurrentMonth.working_days_up_today * 8
-      end
-
-      def difference
-        max_up_today - worked
-      end
-
-      def to_s
-        %[#{worked}h ± #{difference}h]
-      end
-    end
-  end
-end

data/lib/beggar/salary.rb

@@ -1,25 +0,0 @@
-# encoding: utf-8
-
-module Beggar
-  class Salary
-    class << self
-      attr_accessor :rate
-
-      def today
-        Hours.worked * rate
-      end
-
-      def max_up_today
-        Hours.max_up_today * rate
-      end
-
-      def difference
-        max_up_today - today
-      end
-
-      def to_s
-        %[#{today} PLN ± #{difference} PLN]
-      end
-    end
-  end
-end

data/spec/hours_spec.rb

@@ -1,21 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-describe 'Beggar::Hours' do
-  context 'user was working in current month 2 days (8h and 6h)' do
-    before do
-      time_entries = double(map: [8.0, 6.0])
-      api_response = double(select: time_entries)
-      Basecamp::TimeEntry.stub(report: api_response)
-      Beggar::CurrentMonth.stub(working_days_up_today: 2)
-    end
-
-    subject { Beggar::Hours }
-
-    its(:worked) { should == 14.0 }
-    its(:max_up_today) { should == 16.0 }
-    its(:difference) { should == 2.0 }
-    its(:to_s) { should == '14.0h ± 2.0h' }
-  end
-end

data/spec/salary_spec.rb

@@ -1,19 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-describe 'Beggar::Salary' do
-  context 'user was working 10h (max: 40h) in current month and his rate per h amount 100.0 PLN' do
-    before do
-      Beggar::Hours.stub(worked: 10, max_up_today: 40)
-      Beggar::Salary.stub(rate: 100.0)
-    end
-
-    subject { Beggar::Salary }
-
-    its(:today) { should == 1000.0 }
-    its(:max_up_today) { should == 4000.0 }
-    its(:difference) { should == 3000.0 }
-    its(:to_s) { should == '1000.0 PLN ± 3000.0 PLN' }
-  end
-end

data/spec/spec_helper.rb

@@ -1 +0,0 @@
-require 'beggar'