freshbooks.rb 3.0.18 → 3.0.25

data/test/test_connection.rb

@@ -4,39 +4,39 @@ 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")
@@ -44,7 +44,7 @@ class TestConnection < Test::Unit::TestCase
       @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")
@@ -52,94 +52,101 @@ class TestConnection < Test::Unit::TestCase
       @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 
+
+    assert_raises(EOFError, eof_error.message) do
       @connection.send(:post_request, request)
     end
   end
+
+  def test_format_of_account_url_establish_connection
+    exception = assert_raise(FreshBooks::InvalidAccountUrlError) do
+      FreshBooks::Connection.new("https://company.freshbooks.com", "auth_token")
+    end
+    assert_equal "account_url is expected to be in the form www.example.com without any protocol string or trailing query parameters", exception.message
+  end
 end

data/test/test_helper.rb

@@ -3,6 +3,7 @@ require File.dirname(__FILE__) + '/../lib/freshbooks'
 require 'stringio'
 require 'test/unit'
 require File.dirname(__FILE__) + '/mock_connection'
+require 'active_support/all'
 
 begin
   require 'mocha'
@@ -13,7 +14,7 @@ rescue LoadError
 end
 
 class Test::Unit::TestCase
-  
+
   @@fixtures = {}
   def self.fixtures list
     [list].flatten.each do |fixture|
@@ -27,22 +28,36 @@ class Test::Unit::TestCase
       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
+
+  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_invoice.rb

@@ -3,74 +3,74 @@ 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
@@ -79,7 +79,7 @@ private
     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
@@ -92,34 +92,20 @@ private
     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_recurring.rb

@@ -0,0 +1,98 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestRecurring < Test::Unit::TestCase
+  def test_list
+    mock_call_api("recurring.list", { "page" => 1 }, "recurring_list_response")
+
+    recurrings = FreshBooks::Recurring.list
+    assert_equal 1, recurrings.size
+    assert_recurring recurrings[0], 0
+  end
+
+  def test_get
+    recurring_id = 2
+    mock_call_api("recurring.get", { "recurring_id" => recurring_id }, "recurring_get_response")
+
+    recurring = FreshBooks::Recurring.get(recurring_id)
+    assert_recurring recurring, 0, true
+  end
+
+  def test_create
+    recurring = FreshBooks::Recurring.new
+    assert_nil recurring.recurring_id
+
+    mock_call_api("recurring.create", { "recurring" => recurring }, "recurring_create_response")
+    assert recurring.create
+    assert_equal 1, recurring.recurring_id
+  end
+
+  def test_update
+    recurring = FreshBooks::Recurring.new
+    recurring.recurring_id = 1
+
+    mock_call_api("recurring.update", { "recurring" => recurring }, "success_response")
+    assert recurring.update
+  end
+
+  def test_delete
+    recurring = FreshBooks::Recurring.new
+    recurring.recurring_id = 2
+    mock_call_api("recurring.delete", { "recurring_id" => recurring.recurring_id }, "success_response")
+
+    assert recurring.delete
+  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_recurring(recurring, number, expanded_form = false)
+    number = number + 1
+
+    assert_equal number, recurring.recurring_id
+
+    assert_equal 'm', recurring.frequency
+    assert_equal number, recurring.occurrences
+    assert_equal false, recurring.stopped
+
+    assert_equal number, recurring.client_id
+    assert_equal (number * 100), recurring.amount
+    assert_equal Date.parse("2011-04-0#{number}"), recurring.date
+
+    assert_equal number, recurring.po_number
+    assert_equal number.to_f, recurring.discount
+    assert_equal "notes#{number}", recurring.notes
+    assert_equal "terms#{number}", recurring.terms
+
+    assert_equal "first_name#{number}", recurring.first_name
+    assert_equal "last_name#{number}", recurring.last_name
+    assert_equal "organization#{number}", recurring.organization
+    assert_equal "p_street1#{number}", recurring.p_street1
+    assert_equal "p_street2#{number}", recurring.p_street2
+    assert_equal "p_city#{number}", recurring.p_city
+    assert_equal "p_state#{number}", recurring.p_state
+    assert_equal "p_country#{number}", recurring.p_country
+    assert_equal "p_code#{number}", recurring.p_code
+
+    assert_equal "return_uri#{number}", recurring.return_uri
+    assert_equal true, recurring.send_email
+    assert_equal false, recurring.send_snail_mail
+
+    assert_autobill recurring.autobill, number
+
+    lines = recurring.lines
+    assert_equal 1, lines.size
+    lines.each_with_index do |line, index|
+      assert_line(line, index)
+    end
+  end
+
+  def assert_autobill(autobill, number)
+    assert "gateway_name#{number}", autobill.gateway_name
+  end
+end