turingstudio-freshbooks-rb 3.0.1

data/lib/freshbooks/estimate.rb

@@ -0,0 +1,30 @@
+module FreshBooks
+  class Estimate < Base
+    attribute :estimate_id, :integer
+    attribute :client_id, :integer
+    attribute :status, :string
+    attribute :date, :string
+    attribute :po_number, :integer
+    attribute :discount, :float
+    attribute :notes, :string
+    attribute :terms, :string
+    attribute :first_name, :string
+    attribute :last_name, :string
+    attribute :organization, :string
+    attribute :p_street1, :string
+    attribute :p_street2, :string
+    attribute :p_city, :string
+    attribute :p_state, :string
+    attribute :p_country, :string
+    attribute :p_code, :string
+    attribute :lines, :array
+    
+    belongs_to :client
+    method :list, :get, :create, :update, :delete, :send_by_email
+    
+    def initialize(data = {})
+      super
+      self.lines ||= []
+    end
+  end
+end

data/lib/freshbooks/expense.rb

@@ -0,0 +1,16 @@
+module FreshBooks
+  class Expense < Base
+    attribute :expense_id,  :integer
+    attribute :staff_id,    :integer
+    attribute :category_id, :integer
+    attribute :project_id,  :integer
+    attribute :client_id,   :integer
+    attribute :amount,      :float
+    attribute :date,        :string
+    attribute :notes,       :string
+    attribute :status,      :string
+    
+    belongs_to :staff, :category, :project, :client
+    method :list, :get, :create, :update, :delete, :send_by_email
+  end
+end

data/lib/freshbooks/invoice.rb

@@ -0,0 +1,34 @@
+module FreshBooks
+  class Invoice < Base
+    attribute :invoice_id,    :integer
+    attribute :client_id,     :integer
+    attribute :number,        :string
+    attribute :date,          :string
+    attribute :po_number,     :integer
+    attribute :terms,         :string
+    attribute :first_name,    :string
+    attribute :last_name,     :string
+    attribute :organization,  :string
+    attribute :p_street1,     :string
+    attribute :p_street2,     :string
+    attribute :p_city,        :string
+    attribute :p_state,       :string
+    attribute :p_country,     :string
+    attribute :p_code,        :string
+    attribute :amount,        :float
+    attribute :lines,         :array
+    attribute :discount,      :float
+    attribute :status,        :string
+    attribute :notes,         :string
+    attribute :url,           :string, :read_only => true
+    
+    belongs_to :client
+    has_many :payments
+    method :list, :get, :create, :update, :delete, :send_by_email, :send_by_snail_mail
+    
+    def initialize(data = {})
+      super
+      self.lines ||= []
+    end
+  end
+end

data/lib/freshbooks/item.rb

@@ -0,0 +1,12 @@
+module FreshBooks
+  class Item < Base
+    attribute :item_id,     :integer
+    attribute :name,        :string
+    attribute :description, :string
+    attribute :unit_cost,   :float
+    attribute :quantity,    :integer
+    attribute :inventory,   :integer
+    
+    method :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/line.rb

@@ -0,0 +1,13 @@
+module FreshBooks
+  class Line < Base
+    attribute :name,          :string
+    attribute :description,   :string
+    attribute :unit_cost,     :float
+    attribute :quantity,      :integer
+    attribute :tax1_name,     :string
+    attribute :tax2_name,     :string
+    attribute :tax1_percent,  :float
+    attribute :tax2_percent,  :float
+    attribute :amount,        :float
+  end
+end

data/lib/freshbooks/payment.rb

@@ -0,0 +1,22 @@
+module FreshBooks  
+  # * If you specify an invoice_id only, the payment will be recorded as an invoice payment.
+  # * If you specify a client_id only, the payment will be recorded as a client credit.
+  # * If you specify both an invoice_id and client_id, the payment will be recorded
+  #   as an invoice payment, and the amount will be subtracted from the client’s credit.
+  #
+  # Payment type must be one of: ‘Check’, ‘Credit’, ‘Bank Transfer’, ‘PayPal’, ‘2Checkout’,
+  # ‘VISA’, ‘MASTERCARD’, ‘DISCOVER’, ‘NOVA’, ‘AMEX’, ‘DINERS’, ‘EUROCARD’, ‘JCB’ or ‘ACH’.
+  
+  class Payment < Base
+    attribute :payment_id,  :integer
+    attribute :client_id,   :integer
+    attribute :invoice_id,  :integer
+    attribute :date,        :string
+    attribute :amount,      :float
+    attribute :type,        :string
+    attribute :notes,       :string
+    
+    belongs_to :client, :invoice
+    method :list, :get, :create, :update
+  end
+end

data/lib/freshbooks/project.rb

@@ -0,0 +1,39 @@
+module FreshBooks
+  # If you specify project-rate or flat-rate for
+  # billing_method when creating a new project, you must supply a rate.
+  # 
+  # Billing Method Types
+  #   * task-rate
+  #   * flat-rate
+  #   * project-rate
+  #   * staff-rate
+
+  class Project < Base
+    attribute :project_id,  :integer
+    attribute :client_id,   :integer
+    attribute :name,        :string
+    attribute :bill_method, :string
+    attribute :rate,        :float
+    attribute :description, :string
+    attribute :tasks,       :array
+    
+    belongs_to :client
+    has_many :expenses
+    method :list, :get, :create, :update, :delete
+    
+    def initialize(data = {})
+      super
+      self.tasks ||= []
+    end
+    
+    protected
+    
+    def tasks_to_xml(root)
+      return if tasks.empty?
+      node = root.add_element('tasks')
+      tasks.each do |task|
+        node.add_element('task_id').text = task.task_id
+      end
+    end
+  end
+end

data/lib/freshbooks/recurring.rb

@@ -0,0 +1,51 @@
+module FreshBooks  
+  # Create a new recurring profile.
+  # 
+  # The method arguments are nearly identical to invoice.create, but include four new fields:
+  # 
+  # * occurrences
+  #   Number of invoices to generate, with zero (0) being infinite
+  # * frequency
+  #   Rate at which to generate invoices - can be one of ‘weekly’, ‘2 weeks’, ‘4 weeks’,
+  #   ‘monthly’, ‘2 months’, ‘3 months’, ‘6 months’, ‘yearly’, ‘2 years’
+  # * stopped
+  #   This profile is no longer generating invoices (1 - stopped, 0 - active)
+  # * send_email
+  #   Notify client by email each time a new invoice is generated (1 or 0)
+  # * send_snail_mail
+  #   Send a copy of your invoice by snail mail, each time it’s generated (1 or 0)
+  
+  class Recurring < Base
+    attribute :recurring_id,    :integer
+    attribute :client_id,       :integer
+    attribute :date,            :string
+    attribute :po_number,       :integer
+    attribute :terms,           :string
+    attribute :first_name,      :string
+    attribute :last_name,       :string
+    attribute :organization,    :string
+    attribute :p_street1,       :string
+    attribute :p_street2,       :string
+    attribute :p_city,          :string
+    attribute :p_state,         :string
+    attribute :p_country,       :string
+    attribute :p_code,          :string
+    attribute :amount,          :float
+    attribute :lines,           :array
+    attribute :discount,        :float
+    attribute :status,          :string
+    attribute :notes,           :string
+    attribute :occurrences,     :integer
+    attribute :frequency,       :string
+    attribute :send_email,      :integer
+    attribute :send_snail_mail, :integer
+    
+    belongs_to :client
+    method :list, :get, :create, :update, :delete
+    
+    def initialize(data = {})
+      super
+      self.lines ||= []
+    end
+  end
+end

data/lib/freshbooks/response.rb

@@ -0,0 +1,25 @@
+module FreshBooks
+  class Response
+    attr_accessor :doc
+    
+    def initialize(xml_raw)
+      @doc = REXML::Document.new(xml_raw)
+    end
+    
+    def elements
+      @doc.root.elements
+    end
+    
+    def success?
+      @doc.root.attributes['status'] == 'ok'
+    end
+    
+    def fail?
+      !success?
+    end
+    
+    def error_msg
+      return @doc.root.elements['error'].text
+    end
+  end
+end

data/lib/freshbooks/staff.rb

@@ -0,0 +1,24 @@
+module FreshBooks
+  class Staff < Base
+    attribute :staff_id,        :integer
+    attribute :username,        :string
+    attribute :first_name,      :string
+    attribute :last_name,       :string
+    attribute :email,           :string
+    attribute :business_phone,  :string
+    attribute :mobile_phone,    :string
+    attribute :rate,            :string
+    attribute :last_login,      :string
+    attribute :number_of_logins,:string
+    attribute :signup_date,     :string
+    attribute :street1,         :string
+    attribute :street2,         :string
+    attribute :city,            :string
+    attribute :state,           :string
+    attribute :country,         :string
+    attribute :code,            :string
+    
+    has_many :expenses
+    method :list, :get
+  end
+end

data/lib/freshbooks/task.rb

@@ -0,0 +1,11 @@
+module FreshBooks
+  class Task < Base
+    attribute :task_id,     :integer
+    attribute :name,        :string
+    attribute :billable,    :string
+    attribute :rate,        :float
+    attribute :description, :string
+    
+    method :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/time_entry.rb

@@ -0,0 +1,13 @@
+module FreshBooks
+  class TimeEntry < Base
+    attribute :time_entry_id, :integer
+    attribute :project_id,    :integer
+    attribute :task_id,       :integer
+    attribute :hours,         :float
+    attribute :notes,         :string
+    attribute :date,          :string
+    
+    belongs_to :project, :task
+    method :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/version.rb

@@ -0,0 +1,6 @@
+module FreshBooks
+  VERSION = '3.0.1'     # Gem version
+  API_VERSION = '2.1'   # FreshBooks API version
+  
+  SERVICE_URL = "/api/#{API_VERSION}/xml-in"
+end

data/spec/lib/freshbooks/base_spec.rb

@@ -0,0 +1,385 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe FreshBooks::Base do
+  class First < FreshBooks::Base
+    attribute :first_id,  :integer
+    attribute :name,      :string
+    attribute :amount,    :float
+    attribute :url,       :string, :read_only => true
+    attribute :seconds,   :array
+  end
+  
+  class Second < FreshBooks::Base
+    attribute :second_id, :integer
+    attribute :first_id, :integer
+    belongs_to :first
+    has_many :tests
+  end
+  
+  class Test < FreshBooks::Base
+    attribute :test_id, :integer
+    method :list, :get, :create, :update, :delete, :send_by_email, :send_by_snail_mail
+  end
+  
+  class TestWithoutMethods < FreshBooks::Base
+    attribute :test_id, :integer
+  end
+  
+  before(:each) do
+    @object = Test.new
+  end
+  
+  it "should return corrent node name" do
+    FreshBooks::Base.node_name.should == 'base'
+    First.node_name.should == 'first'
+    Second.node_name.should == 'second'
+  end
+  
+  it "should has correct attributes" do
+    First.attributes[:first_id].should == { :type => :integer }
+    First.attributes[:name].should == { :type => :string }
+    First.attributes[:amount].should == { :type => :float }
+    First.attributes[:url].should == { :type => :string, :read_only => true }
+    First.attributes[:seconds].should == { :type => :array }
+  end
+
+  it "should has attribure accessors for decalred attributes" do
+    first = First.new
+    lambda { first.first_id }.should_not raise_error
+    lambda { first.first_id = 1 }.should_not raise_error
+    first.first_id.should == 1
+  end
+  
+  it "should provide changed detector for decalred attributes" do
+    first = First.new
+    lambda { first.first_id_changed? }.should_not raise_error
+    first.first_id_changed?.should be_false
+    first.first_id = 1
+    first.first_id_changed?.should be_true
+  end
+  
+  describe "belongs_to association" do
+    before(:each) do
+      First.stub!(:get)
+      @second = Second.new(:first_id => 1)
+    end
+    
+    it "should has method" do
+      lambda { @second.first }.should_not raise_error
+    end
+    
+    it "should find associated object" do
+      First.should_receive(:get).with(1)
+      @second.first
+    end
+  end
+  
+  describe "belongs_to association" do
+    before(:each) do
+      Test.stub!(:list)
+      @second = Second.new(:second_id => 1)
+    end
+    
+    it "should has method" do
+      lambda { @second.tests }.should_not raise_error
+    end
+    
+    it "should find associated object" do
+      Test.should_receive(:list).with({'second_id' => 1, 'name' => 'value'})
+      @second.tests('name' => 'value')
+    end
+  end
+  
+  describe "xml conversion" do
+    before(:each) do
+      @second1 = Second.new(:second_id => 1)
+      @second2 = Second.new(:second_id => 2)
+      @first = First.new(
+        :first_id => 1,
+        :name     => 'name',
+        :url      => 'url',
+        :seconds  => [@second1, @second2]
+      )
+      @xml = @first.to_xml
+    end
+    
+    it "should return correct xml" do
+      @xml.to_s.should =~ Regexp.new(Regexp.escape('<first_id>1</first_id>'))
+      @xml.to_s.should =~ Regexp.new(Regexp.escape('<name>name</name>'))
+      @xml.to_s.should =~ Regexp.new(Regexp.escape('<seconds><second><second_id>1</second_id></second><second><second_id>2</second_id></second></seconds>'))
+    end
+    
+    it "should not include read_only attributes in xml" do
+      @xml.to_s.should_not =~ Regexp.new(Regexp.escape('<url>url</url>'))
+    end
+    
+    it "should not include unchanged attributes in xml" do
+      @xml.to_s.should_not =~ Regexp.new(Regexp.escape('<amount>'))
+    end
+    
+    it "should return correct xml and initialize correctly from xml" do
+      first = First.new_from_xml(@xml)
+      first.first_id.should == 1
+      first.seconds.size.should == 2
+      first.seconds[0].second_id.should == 1
+      first.seconds[1].second_id.should == 2
+    end    
+  end
+  
+  it "should raise an exception when unknown method is being called" do
+    lambda { TestWithoutMethods.list }.should raise_error
+    lambda { TestWithoutMethods.new.create }.should raise_error
+  end
+  
+  describe "create method" do
+    before(:each) do
+      @elem = mock('XmlObj', :text => '123')
+      @resp = mock('XmlResp', :elements => [nil, @elem])
+      @resp.stub!(:success?).and_return(true)
+      FreshBooks::Base.stub!(:call_api).and_return(@resp)
+    end
+    
+    it "should call api method" do
+      FreshBooks::Base.should_receive(:call_api).with('test.create', 'test' => @object).and_return(@resp)
+      @object.create
+    end
+    
+    it "should assign id returned by api if call succeeded" do
+      @object.create
+      @object.test_id.should == 123
+    end
+    
+    it "should not assign id returned by api if call failed" do
+      @resp.stub!(:success?).and_return(false)
+      @object.create
+      @object.test_id.should be_nil
+    end
+    
+    it "should return id if call succeeded" do
+      @object.create.should == 123
+    end
+    
+    it "should return nil if call failed" do
+      @resp.stub!(:success?).and_return(false)
+      @object.create.should be_nil
+    end
+  end
+  
+  describe "update method" do
+    before(:each) do
+      @resp = mock('XmlResp')
+      @resp.stub!(:success?).and_return(true)
+      FreshBooks::Base.stub!(:call_api).and_return(@resp)
+    end
+    
+    it "should call api method" do
+      FreshBooks::Base.should_receive(:call_api).with('test.update', 'test' => @object).and_return(@resp)
+      @object.update
+    end
+    
+    it "should return true if request succeeded" do
+      @resp.stub!(:success?).and_return(true)
+      @object.update.should be_true
+    end
+    
+    it "should return false if request failed" do
+      @resp.stub!(:success?).and_return(false)
+      @object.update.should be_false
+    end
+  end
+
+  describe "delete method" do
+    before(:each) do
+      @object.test_id = 1
+      @resp = mock('XmlResp')
+      @resp.stub!(:success?).and_return(true)
+      FreshBooks::Base.stub!(:call_api).and_return(@resp)
+    end
+    
+    it "should call api method" do
+      FreshBooks::Base.should_receive(:call_api).with('test.delete', 'test_id' => 1).and_return(@resp)
+      @object.delete
+    end
+    
+    it "should return true if request succeeded" do
+      @resp.stub!(:success?).and_return(true)
+      @object.delete.should be_true
+    end
+    
+    it "should return false if request failed" do
+      @resp.stub!(:success?).and_return(false)
+      @object.delete.should be_false
+    end
+  end
+  
+  describe "delete class method" do
+    before(:each) do
+      @resp = mock('XmlResp')
+      @resp.stub!(:success?).and_return(true)
+      FreshBooks::Base.stub!(:call_api).and_return(@resp)
+    end
+    
+    it "should call api method" do
+      FreshBooks::Base.should_receive(:call_api).with('test.delete', 'test_id' => 1).and_return(@resp)
+      Test.delete(1)
+    end
+    
+    it "should return true if request succeeded" do
+      @resp.stub!(:success?).and_return(true)
+      Test.delete(1).should be_true
+    end
+    
+    it "should return false if request failed" do
+      @resp.stub!(:success?).and_return(false)
+      Test.delete(1).should be_false
+    end
+  end
+  
+  describe "get class method" do
+    before(:each) do
+      @resp = mock('XmlResp', :elements => [])
+      @resp.stub!(:success?).and_return(true)
+      FreshBooks::Base.stub!(:call_api).and_return(@resp)
+      Test.stub!(:new_from_xml).and_return(true)
+    end
+    
+    it "should call api method" do
+      FreshBooks::Base.should_receive(:call_api).with('test.get', 'test_id' => 1).and_return(@resp)
+      Test.get(1)
+    end
+    
+    it "should build and return instance from xml if request succeeded" do
+      @resp.stub!(:success?).and_return(true)
+      Test.should_receive(:new_from_xml).and_return(true)
+      Test.get(1).should be_true
+    end
+    
+    it "should return false if request failed" do
+      @resp.stub!(:success?).and_return(false)
+      Test.get(1).should be_nil
+    end
+  end
+  
+  describe "list class method" do
+    before(:each) do
+      @elem1 = mock('XmlElement')
+      @elem2 = mock('XmlElement')
+      @elems = mock('XmlElements', :elements => [@elem1, @elem2])
+      @resp = mock('XmlResp', :elements => [nil, @elems])
+      @resp.stub!(:success?).and_return(true)
+      FreshBooks::Base.stub!(:call_api).and_return(@resp)
+      Test.stub!(:new_from_xml).and_return(true)
+    end
+    
+    it "should call api method" do
+      FreshBooks::Base.should_receive(:call_api).with('test.list', :name => 'value').and_return(@resp)
+      Test.list(:name => 'value')
+    end
+    
+    it "should return nil if request failed" do
+      @resp.stub!(:success?).and_return(false)
+      Test.list.should be_nil
+    end
+    
+    it "should build instances from response records if request succeeded" do
+      @resp.stub!(:success?).and_return(true)
+      Test.should_receive(:new_from_xml).with(@elem1).and_return(1)
+      Test.should_receive(:new_from_xml).with(@elem2).and_return(2)
+      Test.list.should == [1, 2]
+    end
+  end
+  
+  describe "send_by_email method" do
+    before(:each) do
+      @object.test_id = 1
+      @resp = mock('XmlResp')
+      @resp.stub!(:success?).and_return(true)
+      FreshBooks::Base.stub!(:call_api).and_return(@resp)
+    end
+    
+    it "should call api method" do
+      FreshBooks::Base.should_receive(:call_api).with('test.sendByEmail', 'test_id' => 1).and_return(@resp)
+      @object.send_by_email
+    end
+    
+    it "should return true if request succeeded" do
+      @resp.stub!(:success?).and_return(true)
+      @object.send_by_email.should be_true
+    end
+    
+    it "should return false if request failed" do
+      @resp.stub!(:success?).and_return(false)
+      @object.send_by_email.should be_false
+    end
+  end
+  
+  describe "send_by_email class method" do
+    before(:each) do
+      @resp = mock('XmlResp')
+      @resp.stub!(:success?).and_return(true)
+      FreshBooks::Base.stub!(:call_api).and_return(@resp)
+    end
+    
+    it "should call api method" do
+      FreshBooks::Base.should_receive(:call_api).with('test.sendByEmail', 'test_id' => 1).and_return(@resp)
+      Test.send_by_email(1)
+    end
+    
+    it "should return true if request succeeded" do
+      @resp.stub!(:success?).and_return(true)
+      Test.send_by_email(1).should be_true
+    end
+    
+    it "should return false if request failed" do
+      @resp.stub!(:success?).and_return(false)
+      Test.send_by_email(1).should be_false
+    end
+  end
+  
+  describe "send_by_snail_mail method" do
+    before(:each) do
+      @object.test_id = 1
+      @resp = mock('XmlResp')
+      @resp.stub!(:success?).and_return(true)
+      FreshBooks::Base.stub!(:call_api).and_return(@resp)
+    end
+    
+    it "should call api method" do
+      FreshBooks::Base.should_receive(:call_api).with('test.sendBySnailMail', 'test_id' => 1).and_return(@resp)
+      @object.send_by_snail_mail
+    end
+    
+    it "should return true if request succeeded" do
+      @resp.stub!(:success?).and_return(true)
+      @object.send_by_snail_mail.should be_true
+    end
+    
+    it "should return false if request failed" do
+      @resp.stub!(:success?).and_return(false)
+      @object.send_by_snail_mail.should be_false
+    end
+  end
+  
+  describe "send_by_snail_mail class method" do
+    before(:each) do
+      @resp = mock('XmlResp')
+      @resp.stub!(:success?).and_return(true)
+      FreshBooks::Base.stub!(:call_api).and_return(@resp)
+    end
+    
+    it "should call api method" do
+      FreshBooks::Base.should_receive(:call_api).with('test.sendBySnailMail', 'test_id' => 1).and_return(@resp)
+      Test.send_by_snail_mail(1)
+    end
+    
+    it "should return true if request succeeded" do
+      @resp.stub!(:success?).and_return(true)
+      Test.send_by_snail_mail(1).should be_true
+    end
+    
+    it "should return false if request failed" do
+      @resp.stub!(:success?).and_return(false)
+      Test.send_by_snail_mail(1).should be_false
+    end
+  end
+end