freshbooks.rb 3.0.13

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/freshbooks.rb'}"
+puts "Loading freshbooks.rb gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/fixtures/freshbooks_credentials.sample.yml

@@ -0,0 +1,3 @@
+fresh_books_test_account:
+  account_url: <insert your account url>
+  api_key: <insert your api key>

data/test/fixtures/invoice_create_response.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<response status="ok">
+  <invoice_id>1</invoice_id>
+</response>

data/test/fixtures/invoice_get_response.xml

@@ -0,0 +1,54 @@
+<?xml version="1.0"?>
+<response status="ok">
+  <invoice>
+    <invoice_id>1</invoice_id>
+    <client_id>1</client_id>
+    <number>number1</number>
+    <recurring_id>1</recurring_id>
+    <organization>Organization 1</organization>
+    <status>draft</status>
+    <amount>100.00</amount>
+    <amount_outstanding>50.00</amount_outstanding>
+    <date>2009-02-01</date>
+    
+    <po_number>1</po_number>
+    <discount>1</discount>
+    <notes>notes1</notes>
+    <terms>terms1</terms>
+    
+    <first_name>first_name1</first_name>
+    <last_name>last_name1</last_name>
+    <p_street1>p_street11</p_street1>
+    <p_street2>p_street21</p_street2>
+    <p_city>p_city1</p_city>
+    <p_state>p_state1</p_state>
+    <p_country>p_country1</p_country>
+    <p_code>p_code1</p_code>
+    
+    <return_uri>return_uri1</return_uri>
+    <updated>2009-08-1 01:00:00</updated>
+    
+    <links>
+      <client_view>client_view1</client_view>
+      <view>view1</view>
+      <edit>edit1</edit>
+    </links>
+    
+    <lines>
+      <line>
+        <amount>1</amount>
+        <name>name1</name>
+        <description>description1</description>
+        <unit_cost>1</unit_cost>
+        <quantity>1</quantity>
+        <tax1_name>tax1_name1</tax1_name>
+        <tax2_name>tax2_name1</tax2_name>
+        <tax1_percent>1</tax1_percent>
+        <tax2_percent>1</tax2_percent>
+      </line>
+    </lines>
+    
+    <url deprecated="true">https://sample.freshbooks.com/inv/12345-1-6d30b</url>
+    <auth_url deprecated="true">https://sample.freshbooks.com/inv/12345-1-6d30b-z</auth_url>
+  </invoice>
+</response>

data/test/fixtures/invoice_list_response.xml

@@ -0,0 +1,109 @@
+<?xml version="1.0" encoding="utf-8"?>
+<response status="ok">
+  <invoices page="1" per_page="2" pages="2" total="3">
+    <invoice>
+      <invoice_id>1</invoice_id>
+      <number>number1</number>
+      <client_id>1</client_id>
+      <recurring_id>1</recurring_id>
+      <organization>Organization 1</organization>
+      <status>draft</status>
+      <amount>100.00</amount>
+      <amount_outstanding>50.00</amount_outstanding>
+      <date>2009-02-01</date>
+      
+      <po_number>1</po_number>
+      <discount>1</discount>
+      <notes>notes1</notes>
+      <terms>terms1</terms>
+
+      <first_name>first_name1</first_name>
+      <last_name>last_name1</last_name>
+      <p_street1>p_street11</p_street1>
+      <p_street2>p_street21</p_street2>
+      <p_city>p_city1</p_city>
+      <p_state>p_state1</p_state>
+      <p_country>p_country1</p_country>
+      <p_code>p_code1</p_code>
+      
+      <return_uri>return_uri1</return_uri>
+      <updated>2009-08-1 01:00:00</updated>
+      
+      <links>
+        <client_view>client_view1</client_view>
+        <view>view1</view>
+        <edit>edit1</edit>
+      </links>
+
+      <lines>
+        <line>
+          <amount>1</amount>
+          <name>name1</name>
+          <description>description1</description>
+          <unit_cost>1</unit_cost>
+          <quantity>1</quantity>
+          <tax1_name>tax1_name1</tax1_name>
+          <tax2_name>tax2_name1</tax2_name>
+          <tax1_percent>1</tax1_percent>
+          <tax2_percent>1</tax2_percent>
+        </line>
+      </lines>
+
+      <url deprecated="true">https://sample.freshbooks.com/inv/12345-1-6d30b</url>
+      <auth_url deprecated="true">https://sample.freshbooks.com/inv/12345-1-6d30b-z</auth_url>
+      
+    </invoice>
+    <invoice>
+      <invoice_id>2</invoice_id>
+      <number>number2</number>
+      <client_id>2</client_id>
+      <recurring_id>2</recurring_id>
+      <organization>Organization 2</organization>
+      <status>draft</status>
+      <amount>200.00</amount>
+      <amount_outstanding>100.00</amount_outstanding>
+      <date>2009-02-02</date>
+
+      <po_number>2</po_number>
+      <discount>2</discount>
+      <notes>notes2</notes>
+      <terms>terms2</terms>
+
+      <first_name>first_name2</first_name>
+      <last_name>last_name2</last_name>
+      <p_street1>p_street12</p_street1>
+      <p_street2>p_street22</p_street2>
+      <p_city>p_city2</p_city>
+      <p_state>p_state2</p_state>
+      <p_country>p_country2</p_country>
+      <p_code>p_code2</p_code>
+
+      <return_uri>return_uri2</return_uri>
+      <updated>2009-08-2 02:00:00</updated>
+
+      <links>
+        <client_view>client_view2</client_view>
+        <view>view2</view>
+        <edit>edit2</edit>
+      </links>
+
+      <lines>
+        <line>
+          <amount>1</amount>
+          <name>name1</name>
+          <description>description1</description>
+          <unit_cost>1</unit_cost>
+          <quantity>1</quantity>
+          <tax1_name>tax1_name1</tax1_name>
+          <tax2_name>tax2_name1</tax2_name>
+          <tax1_percent>1</tax1_percent>
+          <tax2_percent>1</tax2_percent>
+        </line>
+      </lines>
+
+      <url deprecated="true">https://sample.freshbooks.com/inv/12345-1-6d30b</url>
+      <auth_url deprecated="true">https://sample.freshbooks.com/inv/12345-1-6d30b-z</auth_url>
+
+    </invoice>
+  </invoices>
+</response>

data/test/fixtures/success_response.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<response status="ok"/>

data/test/mock_connection.rb

@@ -0,0 +1,13 @@
+require 'freshbooks/connection'
+
+class MockConnection < FreshBooks::Connection
+  def initialize(response_body)
+    @response_body = response_body
+  end
+  
+protected
+  
+  def post(request_body)
+    @response_body
+  end
+end

data/test/schema/test_definition.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+module Schema
+  class TestDefinition < Test::Unit::TestCase
+    def setup
+      @definition = FreshBooks::Schema::Definition.new
+    end
+    
+    def test_method_missing
+      # Empty
+      assert_equal 0, @definition.members.size
+      
+      # One type
+      @definition.string :name
+      assert_equal 1, @definition.members.size
+      assert_equal({ :type => :string, :read_only => false }, @definition.members["name"])
+      
+      # Multiple attributes
+      @definition.fixnum :version, :po_number
+      assert_equal 3, @definition.members.size
+      assert_equal({ :type => :fixnum, :read_only => false }, @definition.members["version"])
+      assert_equal({ :type => :fixnum, :read_only => false }, @definition.members["po_number"])
+      
+      # Multiple times
+      @definition.fixnum :lock_number
+      assert_equal 4, @definition.members.size
+      assert_equal({ :type => :fixnum, :read_only => false }, @definition.members["lock_number"])
+    end
+    
+    def test_method_missing_extra_options
+      @definition.fixnum :version, :po_number, :read_only => true
+      assert_equal({ :type => :fixnum, :read_only => true }, @definition.members["version"])
+      assert_equal({ :type => :fixnum, :read_only => true }, @definition.members["po_number"])
+    end
+  end
+end

data/test/schema/test_mixin.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+module Schema
+  class TestMixin < Test::Unit::TestCase
+    def test_define_schema__unique_definition_per_class
+      assert MyItem.schema_definition.members.include?("name")
+      assert !MyItem.schema_definition.members.include?("name2")
+    
+      assert MyItem2.schema_definition.members.include?("name2")
+      assert !MyItem2.schema_definition.members.include?("name")
+    end
+    
+    def test_define_schema__creates_attr_accessors
+      assert MyItem.public_method_defined?("name")
+      assert MyItem.public_method_defined?("name=")
+      
+      assert MyItem2.public_method_defined?("name2")
+      assert MyItem2.public_method_defined?("name2=")
+    end
+    
+    def test_define_schema__creates_read_only_attr_accessors
+      assert MyItem.public_method_defined?("read_only_name")
+      assert MyItem.protected_method_defined?("read_only_name=")
+    end
+  end
+
+  class MyItem < FreshBooks::Base
+    define_schema do |s|
+      s.string :name
+      s.string :read_only_name, :read_only => true
+    end
+  end
+
+  class MyItem2 < FreshBooks::Base
+    define_schema do |s|
+      s.string :name2
+    end
+  end
+end

data/test/test_base.rb

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestBase < Test::Unit::TestCase
+  def test_establish_connection
+    assert_nil FreshBooks::Base.connection
+    
+    FreshBooks::Base.establish_connection("company.freshbooks.com", "auth_token")
+    connection = FreshBooks::Base.connection
+    assert_not_nil connection
+    assert_equal "company.freshbooks.com", connection.account_url
+    assert_equal "auth_token", connection.auth_token
+    
+    FreshBooks::Base.establish_connection("company2.freshbooks.com", "auth_token2")
+    connection = FreshBooks::Base.connection
+    assert_not_nil connection
+    assert_equal "company2.freshbooks.com", connection.account_url
+    assert_equal "auth_token2", connection.auth_token
+  end
+  
+  def test_new_from_xml_to_xml__round_trip
+    xml = <<-EOS
+      <my_item>
+        <name>name1</name>
+        <amount>4.5</amount>
+        <read_only_number>5</read_only_number>
+        <number>6</number>
+        <visible>1</visible>
+        <date>2008-02-01</date>
+        <created_at>2008-10-22 13:57:00</created_at>
+        <my_address>
+          <street1>street1</street1>
+        </my_address>
+        <my_lines>
+          <my_line>
+            <description>description</description>
+          </my_line>
+        </my_lines>
+      </my_item>
+    EOS
+    doc = REXML::Document.new(xml)
+    
+    item = FreshBooks::MyItem.new_from_xml(doc.root)
+    assert_equal "name1", item.name
+    assert_equal 5, item.read_only_number
+    assert_equal 6, item.number
+    assert_equal 4.5, item.amount
+    assert_equal true, item.visible
+    assert_equal Date.new(2008, 2, 1), item.date
+    assert_equal DateTime.parse("2008-10-22 13:57:00 -04:00"), item.created_at
+    assert_equal "street1", item.my_address.street1
+    assert_equal 1, item.my_lines.size
+    assert_equal "description", item.my_lines.first.description
+    
+    # If someone knows a good way to compare xml docs where ordering doesn't matter
+    # let me know. This can be refactored and improved greatly.
+    xml_out = item.to_xml.to_s.strip
+    assert_equal "<my_item>", xml_out.first(9)
+    assert xml_out.include?("<name>name1</name>")
+    assert xml_out.include?("<amount>4.5</amount>")
+    assert xml_out.include?("<visible>1</visible>")
+    assert !xml_out.include?("<read_only_number>5</read_only_number>") # this is read only
+    assert xml_out.include?("<number>6</number>")
+    assert xml_out.include?("<date>2008-02-01</date>")
+    assert xml_out.include?("<created_at>2008-10-22 13:57:00</created_at>")
+    assert xml_out.include?("<my_address><street1>street1</street1></my_address>")
+    assert xml_out.include?("<my_lines><my_line><description>description</description></my_line></my_lines>")
+  end
+  
+end
+
+module FreshBooks
+  class MyItem < FreshBooks::Base
+    define_schema do |s|
+      s.string :name
+      s.fixnum :read_only_number, :read_only => true
+      s.fixnum :number
+      s.float :amount
+      s.boolean :visible
+      s.date :date
+      s.date_time :created_at
+      s.object :my_address
+      s.array :my_lines
+    end
+  end
+
+  class MyAddress < FreshBooks::Base
+    define_schema do |s|
+      s.string :street1
+    end
+  end
+  
+  class MyLine < FreshBooks::Base
+    define_schema do |s|
+      s.string :description
+    end
+  end
+end

data/test/test_connection.rb

@@ -0,0 +1,145 @@
+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><number>23</number></invoice>")
+    
+    request = @connection.send(:create_request, 'mymethod', 'invoice' => invoice)
+    assert_equal "<?xml version='1.0' encoding='UTF-8'?><request method='mymethod'><invoice><number>23</number></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
+  
+  def test_close_is_only_called_once_in_ntexted_start_sessions
+    @connection.expects(:obtain_connection)
+    @connection.expects(:close)
+    
+    @connection.start_session { @connection.start_session { } }
+  end
+  
+  def test_reconnect
+    connection = stub()
+    
+    @connection.expects(:close).with()
+    @connection.expects(:obtain_connection).with(true).returns(connection)
+    
+    assert_equal connection, @connection.send(:reconnect)
+  end
+  
+  def test_post_request_successfull_request
+    request = "<request></request>"
+    response = "<response></response>"
+    
+    http_connection = stub()
+    http_connection.expects(:request).with(request).returns(response)
+    @connection.expects(:start_session).with().yields(http_connection)
+    
+    assert_equal response, @connection.send(:post_request, request)
+  end
+  
+  def test_post_request_eof_error_retry
+    request = "<request></request>"
+    response = "<response></response>"
+    eof_error = EOFError.new("End of file error")
+    
+    bad_http_connection = stub()
+    bad_http_connection.expects(:request).with(request).raises(eof_error)
+    
+    new_http_connection = stub()
+    new_http_connection.expects(:request).with(request).returns(response)
+    
+    @connection.expects(:start_session).with().yields(bad_http_connection)
+    @connection.expects(:reconnect).with().returns(new_http_connection)
+    
+    assert_equal response, @connection.send(:post_request, request)
+  end
+  
+  def test_post_request_eof_error_retry_only_retry_once
+    request = "<request></request>"
+    response = "<response></response>"
+    eof_error = EOFError.new("End of file error")
+    
+    bad_http_connection = stub()
+    bad_http_connection.expects(:request).with(request).raises(eof_error)
+    
+    new_http_connection = stub()
+    new_http_connection.expects(:request).with(request).raises(eof_error)
+    
+    @connection.expects(:start_session).with().yields(bad_http_connection)
+    @connection.expects(:reconnect).with().returns(new_http_connection)
+    
+    assert_raises(EOFError, eof_error.message) do 
+      @connection.send(:post_request, request)
+    end
+  end
+end