jpablobr-freshbooks 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+tmp
+pkg
+*.gem
+test/live_test.rb

data/History.txt

@@ -0,0 +1,8 @@
+== 0.0.1 2009-02-25
+
+* 3.0 major enhancement:
+  * Create connection class
+  * Create gem
+  * Convert xml to ruby type: date, date_time, boolean
+  * Added links to objects
+  * Create DSL to describe FreshBooks actions

data/LICENSE

@@ -0,0 +1,10 @@
+= License
+
+Copyright (c) 2007 Ben Vinegar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Manifest.txt

@@ -0,0 +1,44 @@
+History.txt
+LICENSE
+Manifest.txt
+README
+Rakefile
+lib/freshbooks.rb
+lib/freshbooks/base.rb
+lib/freshbooks/category.rb
+lib/freshbooks/client.rb
+lib/freshbooks/connection.rb
+lib/freshbooks/estimate.rb
+lib/freshbooks/expense.rb
+lib/freshbooks/invoice.rb
+lib/freshbooks/item.rb
+lib/freshbooks/line.rb
+lib/freshbooks/links.rb
+lib/freshbooks/list_proxy.rb
+lib/freshbooks/payment.rb
+lib/freshbooks/project.rb
+lib/freshbooks/recurring.rb
+lib/freshbooks/response.rb
+lib/freshbooks/schema/definition.rb
+lib/freshbooks/schema/mixin.rb
+lib/freshbooks/staff.rb
+lib/freshbooks/task.rb
+lib/freshbooks/time_entry.rb
+lib/freshbooks/xml_serializer.rb
+lib/freshbooks/xml_serializer/serializers.rb
+script/console
+script/destroy
+script/generate
+test/fixtures/invoice_create_response.xml
+test/fixtures/invoice_get_response.xml
+test/fixtures/invoice_list_response.xml
+test/fixtures/success_response.xml
+test/mock_connection.rb
+test/schema/test_definition.rb
+test/schema/test_mixin.rb
+test/test_base.rb
+test/test_connection.rb
+test/test_helper.rb
+test/test_invoice.rb
+test/test_list_proxy.rb
+test/test_page.rb

data/README

@@ -0,0 +1,65 @@
+= About
+
+FreshBooks.rb is a Ruby interface to the FreshBooks API. It exposes easy-to-use classes and methods for interacting with your FreshBooks account. Read more on ELC's blog:
+http://elctech.com/tags/freshbooks
+
+= Examples
+
+Installation:
+  gem install elc-freshbooks.rb --source http://gems.github.com
+
+Initialization:
+
+  FreshBooks::Base.establish_connection( 'sample.freshbooks.com', 'mytoken' )
+
+Updating a client name:
+
+  clients = FreshBooks::Client.list
+  client = clients[0]
+  client.first_name = 'Suzy'
+  client.update
+
+Updating an invoice:
+
+  invoice = FreshBooks::Invoice.get(4)
+  invoice.lines[0].quantity += 1
+  invoice.update
+
+Creating a new item
+
+  item = FreshBooks::Item.new
+  item.name = 'A sample item'
+  item.create
+
+Getting an invoice pdf:
+
+  invoice = FreshBooks::Invoice.get(4)
+  original_status = invoice.status
+  invoice.status = "sent"
+  raise "API Change or error" unless invoice.update
+  html_url = invoice.client_view
+  cookiejar = Tempfile.new("cookies")
+  pdf_file = Tempfile.new("pdf")
+  html_doc = `wget "#{html_url}"  --no-check-certificate --cookies=on --keep-session-cookies --save-cookies='#{cookiejar.path}'  -O -`
+  `wget 'https://#{freshbooks_api_host}/getPDF.php' --post-data='invoice_id[]=#{invoice.number}' --cookies=on --keep-session-cookies 
+    --load-cookies='#{cookiejar.path}'  --no-check-certificate -O '#{pdf_file.path}'"`
+  invoice.status = original_status
+  raise "API Change or error" unless invoice.update
+  pdf_file.path # Here's the PDF!
+
+= License
+
+This work is distributed under the MIT License. Use/modify the code however you like.
+
+= Download
+
+FreshBooks.rb is distributed as a gem via Rubyforge. The easiest way to install it is like so:
+
+  gem install freshbooks
+
+Alternatively, you can download it from the Rubyforge project page.
+
+= Credits
+
+FreshBooks.rb is written and maintained by Ben Vinegar, with contributions from Flinn Meuller, Kenneth Kalmer, and others. 
+

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "jpablobr-freshbooks"
+    gemspec.summary = "jpablobr-freshBooks is a Ruby interface to the FreshBooks API."
+    gemspec.description = "jpablobr-freshBooks is a Ruby interface to the FreshBooks API. It exposes easy-to-use classes and methods for interacting with your FreshBooks account."
+    gemspec.email = "xjpablobrx@gmail.com"
+    gemspec.homepage = "http://github.com/jpablobr/freshbooks.rb"
+    gemspec.authors = ["Jose Pablo Barrantes"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/freshbooks.rb

@@ -0,0 +1,94 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+begin
+  require 'active_support'
+rescue LoadError
+  require 'rubygems'
+  gem 'activesupport'
+  require 'active_support'
+end
+
+require 'freshbooks/base'
+require 'freshbooks/category'
+require 'freshbooks/client'
+require 'freshbooks/connection'
+require 'freshbooks/estimate'
+require 'freshbooks/expense'
+require 'freshbooks/invoice'
+require 'freshbooks/item'
+require 'freshbooks/line'
+require 'freshbooks/links'
+require 'freshbooks/list_proxy'
+require 'freshbooks/payment'
+require 'freshbooks/project'
+require 'freshbooks/recurring'
+require 'freshbooks/response'
+require 'freshbooks/staff'
+require 'freshbooks/task'
+require 'freshbooks/time_entry'
+
+require 'net/https'
+require 'rexml/document'
+require 'logger'
+
+#------------------------------------------------------------------------------
+# FreshBooks.rb - Ruby interface to the FreshBooks API
+#
+# Copyright (c) 2007-2008 Ben Vinegar (http://www.benlog.org)
+#
+# This work is distributed under an MIT License:
+# http://www.opensource.org/licenses/mit-license.php
+#
+#------------------------------------------------------------------------------
+# Usage:
+#
+# FreshBooks.setup('sample.freshbooks.com', 'mytoken')
+#
+# clients = FreshBooks::Client.list
+# client = clients[0]
+# client.first_name = 'Suzy'
+# client.update
+#
+# invoice = FreshBooks::Invoice.get(4)
+# invoice.lines[0].quantity += 1
+# invoice.update
+#
+# item = FreshBooks::Item.new
+# item.name = 'A sample item'
+# item.create
+#
+#==============================================================================
+module FreshBooks
+  VERSION = '3.0.6.1'     # Gem version
+  API_VERSION = '2.1' # FreshBooks API version
+  SERVICE_URL = "/api/#{API_VERSION}/xml-in"
+
+  class Error < StandardError; end;
+  class InternalError < Error; end;
+  class AuthenticationError < Error; end;
+  class UnknownSystemError < Error; end;
+  class InvalidParameterError < Error; end;
+  class ApiAccessNotEnabledError < Error; end;
+  class InvalidAccountUrlError < Error; end;
+  class AccountDeactivatedError < Error; end;
+  
+  class ParseError < StandardError
+    attr_accessor :original_error, :xml
+
+    def initialize(original_error, xml, msg = nil)
+      @original_error = original_error
+      @xml = xml
+      super(msg)
+    end
+
+    def to_s
+      message = super
+
+      "Original Error: #{original_error.to_s}\n" +
+      "XML: #{xml.to_s}\n" +
+      "Message: #{message}\n"
+    end
+  end
+end
+

data/lib/freshbooks/base.rb

@@ -0,0 +1,168 @@
+require 'freshbooks/schema/mixin'
+require 'freshbooks/xml_serializer'
+
+module FreshBooks
+  class Base
+    include FreshBooks::Schema::Mixin
+    
+    @@connection = nil
+    def self.connection
+      @@connection
+    end
+    
+    def self.establish_connection(account_url, auth_token, request_headers = {})
+      @@connection = Connection.new(account_url, auth_token, request_headers)
+    end
+    
+    def self.new_from_xml(xml_root)
+      object = self.new
+      
+      self.schema_definition.members.each do |member_name, member_options|
+        node = xml_root.elements[member_name]
+        next if node.nil?
+        
+        value = FreshBooks::XmlSerializer.to_value(node, member_options[:type])
+        object.send("#{member_name}=", value)
+      end
+      
+      return object
+      
+    rescue => e
+      raise ParseError.new(e, xml_root.to_s)
+    end
+    
+    def to_xml(elem_name = nil)
+      # The root element is the class name underscored
+      elem_name ||= self.class.to_s.split('::').last.underscore
+      root = REXML::Element.new(elem_name)
+      
+      # Add each member to the root elem
+      self.schema_definition.members.each do |member_name, member_options|
+        value = self.send(member_name)
+        next if member_options[:read_only] || value.nil?
+        
+        element = FreshBooks::XmlSerializer.to_node(member_name, value, member_options[:type])
+        root.add_element(element) if element != nil
+      end
+      
+      root.to_s
+    end
+    
+    def primary_key
+      "#{self.class.api_class_name}_id"
+    end
+    
+    def primary_key_value
+      send(primary_key)
+    end
+    
+    def primary_key_value=(value)
+      send("#{primary_key}=", value)
+    end
+    
+    def self.api_class_name
+      klass = class_of_freshbooks_base_descendant(self)
+      
+      # Remove module, underscore between words, lowercase
+      klass.name.
+        gsub(/^.*::/, "").
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        downcase
+    end
+    
+    def self.class_of_freshbooks_base_descendant(klass)
+      if klass.superclass == Base
+        klass
+      elsif klass.superclass.nil?
+        raise "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
+      else
+        self.class_of_freshbooks_base_descendant(klass.superclass)
+      end
+    end
+    
+    def self.define_class_method(symbol, &block)
+      self.class.send(:define_method, symbol, &block)
+    end
+    
+    
+    def self.actions(*operations)
+      operations.each do |operation|
+        method_name = operation.to_s
+        api_action_name = method_name.camelize(:lower)
+        
+        case method_name
+        when "list"
+          define_class_method(method_name) do |*args|
+            args << HashWithIndifferentAccess.new if args.empty? # first param is optional and default to empty hash
+            api_list_action(api_action_name, *args)
+          end
+        when "get"
+          define_class_method(method_name) do |object_id|
+            api_get_action(api_action_name, object_id)
+          end
+        when "create"
+          define_method(method_name) do
+            api_create_action(api_action_name)
+          end
+        when "update"
+          define_method(method_name) do
+            api_update_action(api_action_name)
+          end
+        else
+          define_method(method_name) do
+            api_action(api_action_name)
+          end
+        end
+      end
+    end
+    
+    def self.api_list_action(action_name, options = {})
+      options = HashWithIndifferentAccess.new(options) # NOTE: this is needed so that :page => 10 doesn't end up twice in the options hash (dvd, 10-08-2009)
+      # Create the proc for the list proxy to retrieve the next page
+      list_page_proc = proc do |page|
+        options["page"] = page
+        response = FreshBooks::Base.connection.call_api("#{api_class_name}.#{action_name}", options)
+        raise FreshBooks::InternalError.new("Response was not successful. Error: #{response.error_msg}") unless response.success?
+        
+        root = response.elements[1]
+        array = root.elements.map { |item| self.new_from_xml(item) }
+        current_page = Page.new(root.attributes['page'], root.attributes['per_page'], root.attributes['total'])
+        
+        [array, current_page]
+      end
+      
+      ListProxy.new(list_page_proc)
+    end
+    
+    def self.api_get_action(action_name, object_id)
+      response = FreshBooks::Base.connection.call_api(
+        "#{api_class_name}.#{action_name}",
+        "#{api_class_name}_id" => object_id)
+      response.success? ? self.new_from_xml(response.elements[1]) : nil
+    end
+    
+    def api_action(action_name)
+      response = FreshBooks::Base.connection.call_api(
+        "#{self.class.api_class_name}.#{action_name}", 
+        "#{self.class.api_class_name}_id" => primary_key_value)
+      response.success?
+    end
+    
+    def api_create_action(action_name)
+      response = FreshBooks::Base.connection.call_api(
+        "#{self.class.api_class_name}.#{action_name}",
+        self.class.api_class_name => self)
+      self.primary_key_value = response.elements[1].text.to_i if response.success?
+      response.success?
+    end
+    
+    def api_update_action(action_name)
+      response = FreshBooks::Base.connection.call_api(
+        "#{self.class.api_class_name}.#{action_name}",
+        self.class.api_class_name => self)
+      response.success?
+    end
+    
+  end
+end

data/lib/freshbooks/category.rb

@@ -0,0 +1,11 @@
+module FreshBooks
+  class Category < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :category_id
+      s.float :tax1, :tax2
+      s.string :name
+    end
+    
+    actions :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/client.rb

@@ -0,0 +1,20 @@
+module FreshBooks
+  class Client < FreshBooks::Base
+    define_schema do |s|
+      s.string :first_name, :last_name, :organization, :email
+      s.string :username, :password, :work_phone, :home_phone
+      s.string :mobile, :fax, :notes, :p_street1, :p_street2, :p_city
+      s.string :p_state, :p_country, :p_code, :s_street1, :s_street2
+      s.string :s_city, :s_state, :s_country, :s_code
+      s.fixnum :client_id
+      s.object :links, :read_only => true
+    end
+    
+    actions :list, :get, :create, :update, :delete
+    
+    def invoices(options = {})
+      options.merge('client_id' => self.client_id)
+      Invoice::list(options)
+    end
+  end
+end