spohlenz-freshbooksrb 0.3

data/lib/freshbooks/api.rb

@@ -0,0 +1,50 @@
+require 'httparty'
+require 'builder'
+
+module FreshBooks
+  class APIError < Exception; end
+  
+  class API
+    include HTTParty
+  
+    format :xml
+  
+    def self.call(method, params={})
+      result = post('/xml-in', :body => build_request(method, params))['response']
+    
+      if result['status'] == 'ok'
+        result
+      else
+        raise APIError.new(result['error'])
+      end
+    end
+  
+    def self.configure(url, token)
+      self.base_uri "#{url}:443/api/2.1"
+      self.basic_auth token, 'X'
+    end
+  
+  private
+    def self.build_request(method, params)
+      returning '' do |result|
+        xml = Builder::XmlMarkup.new(:target => result)
+        xml.instruct!
+        xml.request(:method => method) { build_xml(xml, params) }
+      end
+    end
+    
+    def self.build_xml(xml, val={})
+      val.each do |k, v|
+        if v.is_a?(Hash)
+          xml.tag!(k) { build_xml(xml, v) }
+        elsif v.is_a?(Array)
+          xml.tag!(k) {
+            v.each { |i| xml.tag!(k.to_s.singularize, i) }
+          }
+        else
+          xml.tag!(k, v)
+        end
+      end
+    end
+  end
+end

data/lib/freshbooks/base.rb

@@ -0,0 +1,105 @@
+module FreshBooks
+  class Base
+    def initialize(attributes={})
+      @attributes = attributes.inject({}) { |result, pair|
+        result[pair.first] = self.class.normalize(*pair)
+        result
+      }
+    end
+    
+    def method_missing(method, *args, &block)
+      if @attributes.has_key?(method.to_s)
+        @attributes[method.to_s]
+      else
+        super
+      end
+    end
+    
+    def id
+      @attributes[self.class.id_field]
+    end
+    
+    def self.map(mappings={})
+      @mappings ||= {}
+      @mappings.merge!(mappings)
+    end
+    
+    # API methods
+    
+    def self.create(params={})
+      call_api('create', params)[id_field]
+    end
+    
+    def self.update(id, params={})
+      call_api_with_id('update', id, params)
+    end
+    
+    def self.get(id)
+      result = call_api_with_id('get', id)
+      new(result[prefix]) if result[prefix]
+    end
+    
+    def self.delete(id)
+      call_api_with_id('delete', id)
+    end
+    
+    def self.list(params={})
+      result = call_api('list', params)
+      if result[prefix.pluralize] && result[prefix]
+        result[prefix.pluralize][prefix].map { |p| new(p) }
+      else
+        []
+      end
+    end
+    
+    def self.has_many(model)
+      class_eval <<-EOF
+        def #{model}(params={})
+          FreshBooks::#{model.to_s.classify}.list(params.merge(self.class.id_field => id))
+        end
+      EOF
+    end
+    
+    def self.belongs_to(model)
+      class_eval <<-EOF
+        def #{model}
+          FreshBooks::#{model.to_s.classify}.get(#{model}_id)
+        end
+      EOF
+    end
+    
+  private
+    def self.call_api_with_id(method, id, params={})
+      call_api(method, params.merge(id_field => id))
+    end
+  
+    def self.call_api(method, params={})
+      API.call("#{prefix}.#{method}", params)
+    end
+  
+    def self.normalize(key, value)
+      return value.to_i if key.ends_with?('_id')
+      
+      case @mappings[key.to_sym]
+      when :integer
+        value.to_i
+      when :float
+        value.to_f
+      when :date
+        Date.parse(value)
+      when :boolean
+        value == '1'
+      else
+        value
+      end
+    end
+    
+    def self.prefix
+      self.name.demodulize.underscore
+    end
+    
+    def self.id_field
+      "#{prefix}_id"
+    end
+  end
+end

data/lib/freshbooksrb.rb

@@ -0,0 +1,117 @@
+require File.dirname(__FILE__) + '/freshbooks/api'
+require File.dirname(__FILE__) + '/freshbooks/base'
+
+module FreshBooks
+  
+  # Must be called before invoking API methods
+  
+  def self.setup(url, token)
+    @url = url
+    API.configure(url, token)
+  end
+
+  def self.url
+    @url
+  end
+  
+  # Models exposed by FreshBooks API
+  
+  class Client < Base
+    has_many :recurrings
+    has_many :invoices
+    has_many :estimates
+    has_many :payments
+  end
+  
+  class Invoice < Base
+    map :date     => :date,
+        :amount   => :float,
+        :discount => :float
+    
+    has_many :payments
+    belongs_to :client
+    
+    def send_by_email
+      self.class.send_by_email(invoice_id)
+    end
+    
+    def send_by_snail_mail
+      self.class.send_by_snail_mail(invoice_id)
+    end
+    
+    def self.send_by_email(id)
+      call_api_with_id('sendByEmail', id)
+    end
+    
+    def self.send_by_snail_mail(id)
+      call_api_with_id('sendBySnailMail', id)
+    end
+  end
+  
+  class Estimate < Base
+    map :date     => :date,
+        :amount   => :float,
+        :discount => :float
+    
+    belongs_to :client
+    
+    def send_by_email
+      self.class.send_by_email(invoice_id)
+    end
+    
+    def self.send_by_email(id)
+      call_api_with_id('sendByEmail', id)
+    end
+  end
+  
+  class Recurring < Base
+    map :date            => :date,
+        :discount        => :float,
+        :send_email      => :boolean,
+        :send_snail_mail => :boolean
+    
+    has_many :invoices
+    belongs_to :client
+  end
+  
+  class Item < Base
+    map :unit_cost => :float,
+        :quantity  => :integer,
+        :inventory => :integer
+  end
+  
+  class Payment < Base
+    map :date   => :date,
+        :amount => :float
+    
+    belongs_to :client
+    belongs_to :invoice
+    
+    def self.delete(id)
+      raise 'Payments may not be deleted'
+    end
+  end
+  
+  class TimeEntry < Base
+    map :hours => :float,
+        :date  => :date
+    
+    belongs_to :project
+    belongs_to :task
+  end
+  
+  class Project < Base
+    map :rate => :float
+    
+    has_many :time_entries
+    has_many :tasks
+  end
+  
+  class Task < Base
+    map :rate     => :float,
+        :billable => :boolean
+    
+    has_many :time_entries
+  end
+  
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: spohlenz-freshbooksrb
+version: !ruby/object:Gem::Version 
+  version: "0.3"
+platform: ruby
+authors: 
+- Sam Pohlenz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.2
+    version: 
+description: FreshBooksRb is a Ruby library for integrating your apps with the FreshBooks API (http://developers.freshbooks.com/overview/)
+email: sam@sampohlenz.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/freshbooks/base.rb
+- lib/freshbooks/api.rb
+- lib/freshbooksrb.rb
+has_rdoc: false
+homepage: http://github.com/spohlenz/freshbooksrb
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby client for FreshBooks
+test_files: []
+