jpablobr-freshbooks 0.1.0

data/test/test_connection.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestConnection < Test::Unit::TestCase
+  def setup
+    @connection = FreshBooks::Connection.new("company.freshbooks.com", "auth_token")
+  end
+  
+  def test_connection_accessors
+    assert_equal "company.freshbooks.com", @connection.account_url
+    assert_equal "auth_token", @connection.auth_token
+  end
+  
+  def test_connection_request_headers
+    request_headers = { "key" => "value" }
+    connection = FreshBooks::Connection.new("company.freshbooks.com", "auth_token", request_headers)
+    assert_equal request_headers, connection.request_headers
+  end
+  
+  
+  def test_create_request__array_of_elements
+    request = @connection.send(:create_request, 'mymethod', [['element1', 'value1'], [:element2, :value2]])
+    assert_equal "<?xml version='1.0' encoding='UTF-8'?><request method='mymethod'><element1>value1</element1><element2>value2</element2></request>", request
+  end
+  
+  def test_create_request__base_object_element
+    invoice = FreshBooks::Invoice.new
+    invoice.expects(:to_xml).with().returns("invoice")
+    
+    request = @connection.send(:create_request, 'mymethod', 'invoice' => invoice)
+    assert_equal "<?xml version='1.0' encoding='UTF-8'?><request method='mymethod'><invoice/></request>", request
+  end
+  
+  
+  def test_check_for_api_error__success
+    body = "body xml"
+    response = Net::HTTPSuccess.new("1.1", "200", "message")
+    response.expects(:body).with().returns(body)
+    assert_equal body, @connection.send(:check_for_api_error, response)
+  end
+  
+  def test_check_for_api_error__unknown_system
+    response = Net::HTTPMovedPermanently.new("1.1", "301", "message")
+    response.stubs(:[]).with("location").returns("loginSearch")
+    assert_raise(FreshBooks::UnknownSystemError) do
+      @connection.send(:check_for_api_error, response)
+    end
+  end
+  
+  def test_check_for_api_error__deactivated
+    response = Net::HTTPMovedPermanently.new("1.1", "301", "message")
+    response.stubs(:[]).with("location").returns("deactivated")
+    assert_raise(FreshBooks::AccountDeactivatedError) do
+      @connection.send(:check_for_api_error, response)
+    end
+  end
+  
+  def test_check_for_api_error__unauthorized
+    response = Net::HTTPUnauthorized.new("1.1", "401", "message")
+    assert_raise(FreshBooks::AuthenticationError) do
+      @connection.send(:check_for_api_error, response)
+    end
+  end
+  
+  def test_check_for_api_error__bad_request
+    response = Net::HTTPBadRequest.new("1.1", "401", "message")
+    assert_raise(FreshBooks::ApiAccessNotEnabledError) do
+      @connection.send(:check_for_api_error, response)
+    end
+  end
+  
+  def test_check_for_api_error__internal_error
+    response = Net::HTTPBadGateway.new("1.1", "502", "message")
+    assert_raise(FreshBooks::InternalError) do
+      @connection.send(:check_for_api_error, response)
+    end
+    
+    response = Net::HTTPMovedPermanently.new("1.1", "301", "message")
+    response.stubs(:[]).with("location").returns("somePage")
+    assert_raise(FreshBooks::InternalError) do
+      @connection.send(:check_for_api_error, response)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,32 @@
+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
+  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,122 @@
+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
+    
+    if expanded_form
+      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 "client_view1", invoice.links.client_view
+      assert_equal "view1", invoice.links.view
+      assert_equal "edit1", invoice.links.edit
+      
+      lines = invoice.lines
+      assert_equal number, lines.size
+      lines.each_with_index do |line, index|
+        assert_line(line, index)
+      end
+    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,41 @@
+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
+  
+private 
+  
+  # Create a proc, the array generated will be sequential from 0 to total
+  def create_proc(page, per_page, total)
+    get_page_proc = proc do |page|
+      start_num = (page - 1) * per_page
+      end_num = start_num + per_page
+      if end_num >= total
+        end_num = total
+      end
+      
+      array = Range.new(start_num, end_num, true).to_a
+      [array, FreshBooks::Page.new(page, per_page, total)]
+    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,115 @@
+--- !ruby/object:Gem::Specification 
+name: jpablobr-freshbooks
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jose Pablo Barrantes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-22 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: jpablobr-freshBooks is a Ruby interface to the FreshBooks API. It exposes easy-to-use classes and methods for interacting with your FreshBooks account.
+email: xjpablobrx@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .gitignore
+- 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/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: http://github.com/jpablobr/freshbooks.rb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: jpablobr-freshBooks is a Ruby interface to the FreshBooks API.
+test_files: 
+- 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