mirror42-freshbooks.rb 3.0.25

data/lib/freshbooks/schema/mixin.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/definition'
+
+module FreshBooks
+  module Schema
+    module Mixin
+      def self.included(base)
+        base.extend ClassMethods
+      end
+    
+      module ClassMethods
+        def define_schema
+          # Create the class method accessor for the schema definition
+          cattr_accessor :schema_definition
+          self.schema_definition ||= FreshBooks::Schema::Definition.new
+          
+          # Yield to the block for the user to define the schema
+          yield self.schema_definition
+          
+          # Process the schema additions
+          schema_definition.members.each do |member|
+            process_schema_member(member)
+          end
+        end
+        
+        def process_schema_member(member)
+          member_name = member.first
+          member_options = member.last
+          
+          # Create accessor
+          attr_accessor member_name
+          
+          # Protect write if read only
+          if member_options[:read_only]
+            protected "#{member_name}="
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freshbooks/staff.rb

@@ -0,0 +1,13 @@
+module FreshBooks
+  class Staff < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :staff_id, :number_of_logins
+      s.string :username, :first_name, :last_name, :email, :business_phone, :mobile_phone
+      s.string :street1, :street2, :city, :state, :country, :code
+      s.float :rate
+      s.date_time :last_login, :signup_date
+    end
+    
+    actions :list, :get
+  end
+end

data/lib/freshbooks/task.rb

@@ -0,0 +1,12 @@
+module FreshBooks
+  class Task < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :task_id
+      s.string :name, :description
+      s.float :rate
+      s.boolean :billable
+    end
+    
+    actions :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/time_entry.rb

@@ -0,0 +1,12 @@
+module FreshBooks
+  class TimeEntry < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :time_entry_id, :project_id, :task_id, :staff_id
+      s.float :hours
+      s.date :date
+      s.string :notes
+    end
+    
+    actions :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/xml_serializer.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/xml_serializer/serializers'
+
+module FreshBooks
+  module XmlSerializer
+    def self.to_value(node, type)
+      create_serializer(type).to_value(node)
+    end
+    
+    def self.to_node(member_name, value, type)
+      create_serializer(type).to_node(member_name, value)
+    end
+    
+    def self.create_serializer(type)
+      "FreshBooks::XmlSerializer::#{type.to_s.classify}Serializer".constantize
+    end
+  end
+end

data/lib/freshbooks/xml_serializer/serializers.rb

@@ -0,0 +1,116 @@
+module FreshBooks
+  module XmlSerializer
+    class FixnumSerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        element.text = value.to_s
+        element
+      end
+      
+      def self.to_value(xml_val)
+        xml_val.text.to_i
+      end
+    end
+    
+    class FloatSerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        element.text = value.to_s
+        element
+      end
+      
+      def self.to_value(xml_val)
+        xml_val.text.to_f 
+      end
+    end
+    
+    class DateSerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        element.text = value.to_s
+        element
+      end
+      
+      def self.to_value(xml_val)
+        begin
+          Date.parse(xml_val.text.to_s) 
+        rescue ArgumentError => e
+          # Sometimes freshbooks gives dates that look like this 0000-00-00 00:00:00
+          nil
+        end
+      end
+    end
+    
+    class StringSerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        element.text = value.to_s
+        element
+      end
+      
+      def self.to_value(xml_val)
+        xml_val.text.to_s
+      end
+    end
+    
+    class BooleanSerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        element.text = value ? '1' : '0'
+        element
+      end
+      
+      def self.to_value(xml_val)
+        xml_val.text.to_s == "1" 
+      end
+    end
+    
+    class ObjectSerializer
+      def self.to_node(member_name, value)
+        REXML::Document.new(value.to_xml(member_name))
+      end
+      
+      def self.to_value(xml_val)
+        FreshBooks::const_get(xml_val.name.camelize)::new_from_xml(xml_val) 
+      end
+    end
+    
+    class ArraySerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        value.each { |array_elem|
+          element.add_element(REXML::Document.new(array_elem.to_xml))
+        }
+        element
+      end
+      
+      def self.to_value(xml_val)
+        xml_val.elements.map { |elem|
+          FreshBooks::const_get(elem.name.camelize)::new_from_xml(elem)
+        }
+      end
+    end
+    
+    # FreshBooks datetimes are specified in gmt-4. This library assumes utc and
+    # will convert to the appropriate timezone.
+    class DateTimeSerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        element.text = (value.utc + time_offset.to_i.hours).to_s(:db) # hack to convert to gmt-4, any better way?
+        element
+      end
+      
+      def self.to_value(xml_val)
+        DateTime.parse(xml_val.text.to_s + " #{time_offset}").utc # hack to convert from gmt-4 to utc
+      rescue ArgumentError => e
+        # Sometimes freshbooks gives dates that look like this 0000-00-00 00:00:00
+        nil
+      end
+      
+    private
+      def self.time_offset
+        ENV['FRESHBOOKS_TIMEZONE'] || "-04:00"
+      end
+    end
+  end
+end

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