freshbooks.rb 3.0.13

data/test/test_helper.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../lib/freshbooks'
+
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/mock_connection'
+
+begin
+  require 'mocha'
+rescue LoadError
+  require 'rubygems'
+  gem 'mocha'
+  require 'mocha'
+end
+
+class Test::Unit::TestCase
+  
+  @@fixtures = {}
+  def self.fixtures list
+    [list].flatten.each do |fixture|
+      self.class_eval do
+        # add a method name for this fixture type
+        define_method(fixture) do |item|
+          # load and cache the YAML
+          @@fixtures[fixture] ||= YAML::load_file(self.fixture_dir + "/#{fixture.to_s}.yml")
+          @@fixtures[fixture][item.to_s]
+        end
+      end
+    end
+  end
+  
+  
+  def mock_connection(file_name)
+    mock_connection = MockConnection.new(fixture_xml_content(file_name))
+    FreshBooks::Base.stubs(:connection).with().returns(mock_connection)
+    mock_connection
+  end
+  
+  def fixture_xml_content(file_name)
+    # Quick way to remove white space and newlines from xml. Makes it easier to compare in tests
+    open(File.join(fixture_dir, "#{file_name}.xml"), "r").readlines.inject("") do |contents, line|
+      contents + line.strip
+    end
+  end
+  
+  def fixture_dir
+    File.join(File.dirname(__FILE__), "fixtures")
+  end
+end

data/test/test_invoice.rb

@@ -0,0 +1,125 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestInvoice < Test::Unit::TestCase
+  def test_list
+    mock_call_api("invoice.list", { "page" => 1 }, "invoice_list_response")
+    
+    invoices = FreshBooks::Invoice.list
+    assert_equal 3, invoices.size
+    assert_invoice invoices[0], 0
+    assert_invoice invoices[1], 1
+  end
+  
+  def test_get
+    invoice_id = 2
+    mock_call_api("invoice.get", { "invoice_id" => invoice_id }, "invoice_get_response")
+    
+    invoice = FreshBooks::Invoice.get(invoice_id)
+    assert_invoice invoice, 0, true
+  end
+  
+  def test_create
+    invoice = FreshBooks::Invoice.new
+    assert_nil invoice.invoice_id
+    
+    mock_call_api("invoice.create", { "invoice" => invoice }, "invoice_create_response")
+    assert invoice.create
+    assert_equal 1, invoice.invoice_id
+  end
+  
+  def test_update
+    invoice = FreshBooks::Invoice.new
+    invoice.invoice_id = 1
+    
+    mock_call_api("invoice.update", { "invoice" => invoice }, "success_response")
+    assert invoice.update
+  end
+  
+  def test_delete
+    invoice = FreshBooks::Invoice.new
+    invoice.invoice_id = 2
+    mock_call_api("invoice.delete", { "invoice_id" => invoice.invoice_id }, "success_response")
+    
+    assert invoice.delete
+  end
+  
+  def test_send_by_email
+    invoice = FreshBooks::Invoice.new
+    invoice.invoice_id = 2
+    mock_call_api("invoice.sendByEmail", { "invoice_id" => invoice.invoice_id }, "success_response")
+    
+    assert invoice.send_by_email
+  end
+  
+  def test_send_by_snail_mail
+    invoice = FreshBooks::Invoice.new
+    invoice.invoice_id = 2
+    mock_call_api("invoice.sendBySnailMail", { "invoice_id" => invoice.invoice_id }, "success_response")
+    
+    assert invoice.send_by_snail_mail
+  end
+  
+private
+  
+  def mock_call_api(method, options, response_fixture)
+    FreshBooks::Base.connection.
+      expects(:call_api).
+      with(method, options).
+      returns(FreshBooks::Response.new(fixture_xml_content(response_fixture)))
+  end
+  
+  def assert_invoice(invoice, number, expanded_form = false)
+    number = number + 1
+    
+    assert_equal number, invoice.invoice_id
+    assert_equal "number#{number}", invoice.number
+    assert_equal number, invoice.client_id
+    assert_equal number, invoice.recurring_id
+    assert_equal "draft", invoice.status
+    assert_equal (number * 100), invoice.amount
+    assert_equal (number * 100) / 2, invoice.amount_outstanding
+    assert_equal Date.parse("2009-02-0#{number}"), invoice.date
+    
+    assert_equal number, invoice.po_number
+    assert_equal number.to_f, invoice.discount
+    assert_equal "notes#{number}", invoice.notes
+    assert_equal "terms#{number}", invoice.terms
+    assert_equal "first_name#{number}", invoice.first_name
+    assert_equal "last_name#{number}", invoice.last_name
+    assert_equal "p_street1#{number}", invoice.p_street1
+    assert_equal "p_street2#{number}", invoice.p_street2
+    assert_equal "p_city#{number}", invoice.p_city
+    assert_equal "p_state#{number}", invoice.p_state
+    assert_equal "p_country#{number}", invoice.p_country
+    assert_equal "p_code#{number}", invoice.p_code
+    
+    assert_equal "return_uri#{number}", invoice.return_uri
+    assert_equal DateTime.parse("2009-08-#{number} 0#{number}:00:00 -04:00"), invoice.updated
+    
+    
+    
+    assert_equal "client_view#{number}", invoice.links.client_view
+    assert_equal "view#{number}", invoice.links.view
+    assert_equal "edit#{number}", invoice.links.edit
+    
+    lines = invoice.lines
+    assert_equal 1, lines.size
+    lines.each_with_index do |line, index|
+      assert_line(line, index)
+    end
+  end
+  
+  def assert_line(line, number)
+    number = number + 1
+    
+    assert_equal number.to_f, line.amount
+    assert_equal "name#{number}", line.name
+    assert_equal "description#{number}", line.description
+    assert_equal number.to_f, line.unit_cost
+    assert_equal number, line.quantity
+    assert_equal "tax1_name#{number}", line.tax1_name
+    assert_equal "tax2_name#{number}", line.tax2_name
+    assert_equal number.to_f, line.tax1_percent
+    assert_equal number.to_f, line.tax2_percent
+  end
+end

data/test/test_list_proxy.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestListProxy < Test::Unit::TestCase
+  def test_size__should_be_total_size_of_results
+    list_proxy = FreshBooks::ListProxy.new(create_proc(1, 2, 3))
+    assert_equal 3, list_proxy.size
+  end
+  
+  def test_reference_element
+    list_proxy = FreshBooks::ListProxy.new(create_proc(1, 2, 3))
+    assert_equal 0, list_proxy[0]
+    assert_equal 1, list_proxy[1]
+    assert_equal 2, list_proxy[2]
+  end
+  
+  def test_each
+    list_proxy = FreshBooks::ListProxy.new(create_proc(1, 2, 3))
+    count = 0
+    list_proxy.each_with_index do |item, i|
+      assert_equal i, item, "Incorrect item on iteration #{i}"
+      count += 1
+    end
+    assert_equal count, list_proxy.size
+  end
+  
+  def test_each__no_pages_and_items
+    list_proxy = FreshBooks::ListProxy.new(create_proc(0, 0, 0))
+    count = 0
+    list_proxy.each_with_index do |item, i|
+      count += 1
+    end
+    assert_equal 0, list_proxy.size
+    assert_equal 0, count
+  end
+  
+  def test_each__response_doesnt_have_pagination_but_returns_items
+    list_proxy = FreshBooks::ListProxy.new(create_proc(0, 0, 0, 3))
+    count = 0
+    list_proxy.each_with_index do |item, i|
+      count += 1
+    end
+    assert_equal 3, list_proxy.size
+    assert_equal 3, count
+  end
+  
+private 
+  
+  def create_proc(page, per_page, total, total_in_array = total)
+    get_page_proc = proc do |page|
+      start_num = (page - 1) * per_page
+      end_num = start_num + per_page
+      if end_num >= total_in_array || end_num == 0
+        end_num = total_in_array
+      end
+      
+      array = Range.new(start_num, end_num, true).to_a
+      [array, FreshBooks::Page.new(page, per_page, total, total_in_array)]
+    end
+  end
+end

data/test/test_page.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestPage < Test::Unit::TestCase
+  def test_pages
+    page = FreshBooks::Page.new(1, 2, 1)
+    assert_equal 1, page.pages
+    
+    page = FreshBooks::Page.new(1, 2, 2)
+    assert_equal 1, page.pages
+    
+    page = FreshBooks::Page.new(1, 2, 3)
+    assert_equal 2, page.pages
+    
+    page = FreshBooks::Page.new(1, 2, 4)
+    assert_equal 2, page.pages
+  end
+  
+  def test_next_page?
+    list_proxy = FreshBooks::Page.new(1, 2, 1)
+    assert !list_proxy.next_page?
+    
+    list_proxy = FreshBooks::Page.new(1, 2, 3)
+    assert list_proxy.next_page?
+    
+    list_proxy = FreshBooks::Page.new(2, 2, 3)
+    assert !list_proxy.next_page?
+  end
+  
+  def test_page_number
+    list_proxy = FreshBooks::Page.new(1, 2, 1)
+    assert_equal 1, list_proxy.page_number(0)
+    
+    list_proxy = FreshBooks::Page.new(1, 2, 3)
+    assert_equal 1, list_proxy.page_number(1)
+    
+    list_proxy = FreshBooks::Page.new(1, 2, 3)
+    assert_equal 2, list_proxy.page_number(2)
+  end
+  
+  def test_position_number
+    list_proxy = FreshBooks::Page.new(1, 2, 1)
+    assert_equal 0, list_proxy.position_number(0)
+    
+    list_proxy = FreshBooks::Page.new(1, 2, 3)
+    assert_equal 1, list_proxy.position_number(1)
+    
+    list_proxy = FreshBooks::Page.new(2, 2, 3)
+    assert_equal 0, list_proxy.position_number(2)
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification 
+name: freshbooks.rb
+version: !ruby/object:Gem::Version 
+  version: 3.0.13
+platform: ruby
+authors: 
+- Ben Curren
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-15 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: ""
+email: 
+- ben@outright.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README
+- Rakefile
+- lib/freshbooks.rb
+- lib/freshbooks/base.rb
+- lib/freshbooks/category.rb
+- lib/freshbooks/client.rb
+- lib/freshbooks/connection.rb
+- lib/freshbooks/estimate.rb
+- lib/freshbooks/expense.rb
+- lib/freshbooks/invoice.rb
+- lib/freshbooks/item.rb
+- lib/freshbooks/line.rb
+- lib/freshbooks/links.rb
+- lib/freshbooks/list_proxy.rb
+- lib/freshbooks/payment.rb
+- lib/freshbooks/project.rb
+- lib/freshbooks/recurring.rb
+- lib/freshbooks/response.rb
+- lib/freshbooks/schema/definition.rb
+- lib/freshbooks/schema/mixin.rb
+- lib/freshbooks/staff.rb
+- lib/freshbooks/task.rb
+- lib/freshbooks/time_entry.rb
+- lib/freshbooks/xml_serializer.rb
+- lib/freshbooks/xml_serializer/serializers.rb
+- script/console
+- script/destroy
+- script/generate
+- test/fixtures/freshbooks_credentials.sample.yml
+- test/fixtures/invoice_create_response.xml
+- test/fixtures/invoice_get_response.xml
+- test/fixtures/invoice_list_response.xml
+- test/fixtures/success_response.xml
+- test/mock_connection.rb
+- test/schema/test_definition.rb
+- test/schema/test_mixin.rb
+- test/test_base.rb
+- test/test_connection.rb
+- test/test_helper.rb
+- test/test_invoice.rb
+- test/test_list_proxy.rb
+- test/test_page.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: freshbooks.rb
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ""
+test_files: 
+- test/test_connection.rb
+- test/test_list_proxy.rb
+- test/test_page.rb
+- test/test_invoice.rb
+- test/schema/test_mixin.rb
+- test/schema/test_definition.rb
+- test/test_helper.rb
+- test/test_base.rb