freshbooks.rb 3.0.18 → 3.0.25

data/lib/freshbooks/contact.rb

@@ -0,0 +1,9 @@
+module FreshBooks
+  class Contact < FreshBooks::Base
+    define_schema do |s|
+      s.string :email, :username, :first_name, :last_name, :phone1, :phone2
+    end
+    
+    actions :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/credits.rb

@@ -0,0 +1,7 @@
+module FreshBooks
+  class Credits < FreshBooks::Base
+    define_schema do |s|
+      s.string :credit, :currency, :read_only => true
+    end
+  end
+end

data/lib/freshbooks/estimate.rb

@@ -1,10 +1,10 @@
 module FreshBooks
   class Estimate < FreshBooks::Base
     define_schema do |s|
-      s.string :estimate_id, :status, :date, :notes, :terms, :first_name
+      s.string :estimate_id, :status, :date, :notes, :terms, :first_name, :number
       s.string :last_name, :organization, :p_street1, :p_street2, :p_city
-      s.string :p_state, :p_country, :p_code
-      s.fixnum :client_id, :po_number
+      s.string :p_state, :p_country, :p_code, :currency_code, :language
+      s.fixnum :client_id, :po_number, :staff_id
       s.float :discount, :amount
       s.array :lines
       s.object :links, :read_only => true

data/lib/freshbooks/expiration.rb

@@ -0,0 +1,8 @@
+module FreshBooks
+  class Expiration < FreshBooks::Base
+
+    define_schema do |s|
+      s.string :month, :year
+    end
+  end
+end

data/lib/freshbooks/gateway.rb

@@ -0,0 +1,10 @@
+module FreshBooks
+  class Gateway < FreshBooks::Base
+    define_schema do |s|
+      s.string :name
+      s.boolean :autobill_capable
+    end
+    
+    actions :list
+  end
+end

data/lib/freshbooks/gateway_transaction.rb

@@ -0,0 +1,8 @@
+module FreshBooks
+  class GatewayTransaction < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :reference_id
+      s.string :gateway_name
+    end
+  end
+end

data/lib/freshbooks/invoice.rb

@@ -1,7 +1,7 @@
 module FreshBooks
   class Invoice < FreshBooks::Base
     define_schema do |s|
-      s.fixnum :invoice_id, :client_id, :po_number
+      s.fixnum :invoice_id, :client_id, :po_number, :staff_id
       s.fixnum :recurring_id, :read_only => true
       s.float :amount, :discount
       s.float :amount_outstanding, :paid, :read_only => true
@@ -9,7 +9,7 @@ module FreshBooks
       s.date_time :updated, :read_only => true
       s.array :lines
       s.object :links, :read_only => true
-      s.string :number, :organization, :status, :notes, :terms, :first_name, :last_name
+      s.string :number, :organization, :status, :notes, :terms, :first_name, :last_name, :currency_code, :language
       s.string :p_street1, :p_street2, :p_city, :p_state, :p_country, :p_code
       s.string :return_uri
     end

data/lib/freshbooks/language.rb

@@ -0,0 +1,9 @@
+module FreshBooks
+  class Language < FreshBooks::Base
+    define_schema do |s|
+      s.string :code, :name
+    end
+    
+    actions :list
+  end
+end

data/lib/freshbooks/line.rb

@@ -1,7 +1,9 @@
 module FreshBooks
   class Line < FreshBooks::Base
+    
     define_schema do |s|
       s.string :name, :description, :tax1_name, :tax2_name
+      s.string :type
       s.float :unit_cost, :tax1_percent, :tax2_percent
       s.float :amount, :read_only => true
       s.float :quantity

data/lib/freshbooks/links.rb

@@ -1,7 +1,7 @@
 module FreshBooks
   class Links < FreshBooks::Base
     define_schema do |s|
-      s.string :client_view, :view, :edit, :read_only => true
+      s.string :client_view, :view, :edit, :statement, :read_only => true
     end
   end
 end

data/lib/freshbooks/payment.rb

@@ -5,7 +5,8 @@ module FreshBooks
       s.float :amount
       s.date :date
       s.date_time :updated, :read_only => true
-      s.string :type, :notes
+      s.string :type, :notes, :currency_code
+      s.object :gateway_transaction
     end
     
     actions :list, :get, :create, :update, :delete

data/lib/freshbooks/project.rb

@@ -3,10 +3,11 @@ module FreshBooks
     define_schema do |s|
       s.string :name, :bill_method, :description
       s.fixnum :project_id, :client_id
-      s.float :rate
-      s.array :tasks
+      s.float :rate, :hour_budget
+      s.array :tasks, :staff
+      s.object :budget
     end
     
     actions :list, :get, :create, :update, :delete
   end
-end
+end

data/lib/freshbooks/recurring.rb

@@ -2,14 +2,17 @@ module FreshBooks
   class Recurring < FreshBooks::Base
     define_schema do |s|
       s.string :first_name, :last_name, :organization, :p_street1, :p_street2, :p_city
-      s.string :p_state, :p_country, :p_code, :lines, :status, :notes, :terms, :frequency
+      s.string :p_state, :p_country, :p_code, :lines, :notes, :terms, :frequency
+      s.string :currency_code, :language
       s.date :date
       s.fixnum :recurring_id, :client_id, :po_number, :occurrences
       s.float :discount, :amount
       s.array :lines
       s.boolean :stopped, :send_email, :send_snail_mail
+      s.string :return_uri
+      s.object :autobill
     end
-    
+
     actions :list, :get, :create, :update, :delete
   end
 end

data/lib/freshbooks/schema/definition.rb

@@ -4,7 +4,7 @@ module FreshBooks
       attr_reader :members
       
       def initialize
-        @members = {}
+        @members = ActiveSupport::OrderedHash.new
       end
       
       def method_missing(method, *attributes)
@@ -17,4 +17,4 @@ module FreshBooks
       end
     end
   end
-end
+end

data/lib/freshbooks/staff.rb

@@ -9,5 +9,10 @@ module FreshBooks
     end
     
     actions :list, :get
+    
+    def self.current
+      response = FreshBooks::Base.connection.call_api("#{api_class_name}.current")
+      response.success? ? self.new_from_xml(response.elements[1]) : nil
+    end
   end
 end

data/lib/freshbooks/system.rb

@@ -0,0 +1,14 @@
+module FreshBooks
+  class System < FreshBooks::Base
+    define_schema do |s|
+      s.string :company_name, :profession
+      s.object :address
+      s.object :api
+    end
+    
+    def self.current
+      response = FreshBooks::Base.connection.call_api("#{api_class_name}.current")
+      response.success? ? self.new_from_xml(response.elements[1]) : nil
+    end
+  end
+end

data/lib/freshbooks/tax.rb

@@ -0,0 +1,12 @@
+module FreshBooks
+  class Tax < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :tax_id
+      s.float :rate
+      s.boolean :compound
+      s.string :name, :number
+    end
+    
+    actions :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/time_entry.rb

@@ -5,6 +5,7 @@ module FreshBooks
       s.float :hours
       s.date :date
       s.string :notes
+      s.boolean :billed
     end
     
     actions :list, :get, :create, :update, :delete

data/lib/freshbooks/xml_serializer.rb

@@ -13,5 +13,10 @@ module FreshBooks
     def self.create_serializer(type)
       "FreshBooks::XmlSerializer::#{type.to_s.classify}Serializer".constantize
     end
+    
+    def self.deprecated?(node)
+      !node.attribute('deprecated').nil?
+    end
+    
   end
 end

data/lib/freshbooks/xml_serializer/serializers.rb

@@ -86,8 +86,8 @@ module FreshBooks
       
       def self.to_value(xml_val)
         xml_val.elements.map { |elem|
-          FreshBooks::const_get(elem.name.camelize)::new_from_xml(elem)
-        }
+          FreshBooks::const_get(elem.name.camelize)::new_from_xml(elem) unless XmlSerializer.deprecated? elem
+        }.compact
       end
     end
     

data/test/fixtures/freshbooks_credentials.yml

@@ -0,0 +1,3 @@
+fresh_books_test_account:
+  account_url: outright.freshbooks.com
+  api_key: 569916aa36f9f52a3a84424a8e55fc05

data/test/fixtures/recurring_create_response.xml

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

data/test/fixtures/recurring_get_response.xml

@@ -0,0 +1,59 @@
+<?xml version="1.0"?>
+<response status="ok">
+  <recurring>
+    <recurring_id>1</recurring_id>
+
+    <frequency>m</frequency>
+    <occurrences>1</occurrences>
+    <stopped>0</stopped>
+
+    <client_id>1</client_id>
+    <amount>100.0</amount>
+    <date>2011-04-01</date>
+
+    <po_number>1</po_number>
+    <discount>1.0</discount>
+    <notes>notes1</notes>
+    <terms>terms1</terms>
+
+    <first_name>first_name1</first_name>
+    <last_name>last_name1</last_name>
+    <organization>organization1</organization>
+    <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>
+    <send_email>1</send_email>
+    <send_snail_mail>0</send_snail_mail>
+
+    <autobill>
+      <gateway_name>gateway1</gateway_name>
+      <card>
+        <number>1</number>
+        <name>name1</name>
+        <expiration>
+          <month>01</month>
+          <year>2001</year>
+        </expiration>
+      </card>
+    </autobill>
+
+    <lines>
+      <line>
+        <amount>1.0</amount>
+        <name>name1</name>
+        <description>description1</description>
+        <tax1_name>tax1_name1</tax1_name>
+        <tax2_name>tax2_name1</tax2_name>
+        <unit_cost>1.0</unit_cost>
+        <tax1_percent>1.0</tax1_percent>
+        <tax2_percent>1.0</tax2_percent>
+        <quantity>1</quantity>
+      </line>
+    </lines>
+  </recurring>
+</response>

data/test/fixtures/recurring_list_response.xml

@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="utf-8"?>
+<response xmlns="http://www.freshbooks.com/api/" status="ok">
+  <recurrings page="1" per_page="1" pages="1" total="1">
+    <recurring>
+      <recurring_id>1</recurring_id>
+
+      <frequency>m</frequency>
+      <occurrences>1</occurrences>
+      <stopped>0</stopped>
+
+      <client_id>1</client_id>
+      <amount>100.0</amount>
+      <date>2011-04-01</date>
+
+      <po_number>1</po_number>
+      <discount>1.0</discount>
+      <notes>notes1</notes>
+      <terms>terms1</terms>
+
+      <first_name>first_name1</first_name>
+      <last_name>last_name1</last_name>
+      <organization>organization1</organization>
+      <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>
+      <send_email>1</send_email>
+      <send_snail_mail>0</send_snail_mail>
+
+      <autobill>
+        <gateway_name>gateway1</gateway_name>
+        <card>
+          <number>1</number>
+          <name>name1</name>
+          <expiration>
+            <month>01</month>
+            <year>2001</year>
+          </expiration>
+        </card>
+      </autobill>
+
+      <lines>
+        <line>
+          <amount>1.0</amount>
+          <name>name1</name>
+          <description>description1</description>
+          <tax1_name>tax1_name1</tax1_name>
+          <tax2_name>tax2_name1</tax2_name>
+          <unit_cost>1.0</unit_cost>
+          <tax1_percent>1.0</tax1_percent>
+          <tax2_percent>1.0</tax2_percent>
+          <quantity>1</quantity>
+        </line>
+      </lines>
+    </recurring>
+  </recurrings>
+</response>

data/test/live_connection_test.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+# this tests a live conection
+class LiveConnectionTest < Test::Unit::TestCase
+  fixtures :freshbooks_credentials
+  
+  def setup
+    fb_account_info = freshbooks_credentials(:fresh_books_test_account)
+    FreshBooks::Base.establish_connection(fb_account_info['account_url'], fb_account_info['api_key'])
+  end
+
+  # just go out there and get a live connection and see if it returns anything
+  def test_live_connection_with_start_session
+    FreshBooks::Base.connection.start_session do
+      clients = FreshBooks::Client.list("per_page" => 1)
+      FreshBooks::Invoice.list("per_page" => 100).collect do |invoice|
+        assert FreshBooks::Invoice.get(invoice.invoice_id)
+      end 
+    end
+  end
+  
+  def test_live_connection_without_start_session
+    clients = FreshBooks::Client.list("per_page" => 1)
+    FreshBooks::Invoice.list("per_page" => 100).collect do |invoice|
+      assert FreshBooks::Invoice.get(invoice.invoice_id)
+    end 
+  end
+end

data/test/test_base.rb

@@ -66,6 +66,56 @@ class TestBase < Test::Unit::TestCase
     assert xml_out.include?("<my_lines><my_line><description>description</description></my_line></my_lines>")
   end
   
+  def test_create_objects_with_initializer_arguments
+    invoice_1 = FreshBooks::Invoice.new
+    invoice_1.client_id = 1
+    invoice_1.lines = [FreshBooks::Line.new, FreshBooks::Line.new]
+    invoice_1.lines[0].name = "Awesomeness"
+    invoice_1.lines[0].unit_cost = 9999
+    invoice_1.lines[0].quantity = 42
+    invoice_1.lines[1].name = "Ninja skills"
+    invoice_1.lines[1].unit_cost = 349
+    invoice_1.lines[1].quantity = 100
+    
+    invoice_2 = FreshBooks::Invoice.new(
+      :client_id => 1,
+      :lines => [
+        FreshBooks::Line.new(
+          :name => "Awesomeness",
+          :unit_cost => 9999,
+          :quantity => 42
+        ),
+        FreshBooks::Line.new(
+          :name => "Ninja skills",
+          :unit_cost => 349,
+          :quantity => 100
+        )
+      ]
+    )
+    
+    assert_equal invoice_1.to_xml, invoice_2.to_xml
+  end
+  
+  def test_can_handle_all_zero_updated_at
+    xml = <<-END_XML
+      <my_client>
+        <client_id>3</client_id>
+        <first_name>Test</first_name>
+        <last_name>User</last_name>
+        <organization>User Testing</organization>
+        <updated>0000-00-00 00:00:00</updated>
+      </my_client>
+    END_XML
+    doc = REXML::Document.new(xml)
+    
+    item = FreshBooks::MyClient.new_from_xml(doc.root)
+    assert_equal nil, item.updated
+  end
+  
+  def test_actions
+    assert FreshBooks::MyItem.respond_to?(:get)
+    assert !Class.new.respond_to?(:get)
+  end
 end
 
 module FreshBooks
@@ -81,6 +131,15 @@ module FreshBooks
       s.object :my_address
       s.array :my_lines
     end
+    actions :get
+  end
+
+  class MyClient < FreshBooks::Base
+    define_schema do |s|
+      s.string :first_name, :last_name, :organization
+      s.fixnum :client_id
+      s.date_time :updated
+    end
   end
 
   class MyAddress < FreshBooks::Base