loco_bill 0.0.1

data/README

@@ -0,0 +1,16 @@
+An interface for interacting with Bill.com's API. Expects the following constants to be set (in environment.rb or an initializer or what have you):
+
+BILL_API_APPLICATION_KEY
+BILL_API_USERNAME
+BILL_API_PASSWORD
+BILL_API_ORG_ID
+
+Requires Nokogiri.
+
+Use like so:
+
+  login = LocoBill.login
+  login.result.inspect => #<BillApi::RequestResult status="OK", sessionId="xxx", orgID="yyy">
+  
+  vendor = BillApi.create_vendor :vendor => {:name => 'Test'} # will auto-login for you, if you're not already logged in
+  vendor.result.inspect => #<BillApi::RequestResult transactionId="Transaction1", status="OK", id="xxy">

data/init.rb

@@ -0,0 +1 @@
+require 'loco_bill'

data/lib/loco_bill/login.rb

@@ -0,0 +1,5 @@
+module LocoBill
+  def self.login
+    Request.new(:login, :username => BILL_API_USERNAME, :password => BILL_API_PASSWORD, :orgID => BILL_API_ORG_ID)
+  end
+end

data/lib/loco_bill/request.rb

@@ -0,0 +1,100 @@
+module LocoBill
+  class Request
+    attr_accessor :result
+    @@api_domain = 'api.bill.com'
+    @@api_endpoint = "/crudApi"
+    @@session_id = nil
+    @@transaction_id = 0
+    NON_OPERATION_WRAPPED_ACTIONS = [:login, :logout, :getorglist]
+    INLINE_PARAMS_ACTIONS = {:get_list => :object}
+    
+    def initialize(action, params={})
+      @action = action.to_sym
+      # auto-login & grab session id if we don't already have one.
+      if @@session_id.nil? && @action != :login
+        @@session_id = LocoBill.login.result.sessionId
+      end
+      @params = params
+      @result = process_response(api(build_request_xml))
+    end
+    
+    def build_request_xml
+      operation_wrapped = !NON_OPERATION_WRAPPED_ACTIONS.include?(@action)
+      
+      Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        xml.request(:version => '1.0', :applicationkey => BILL_API_APPLICATION_KEY) {
+          if operation_wrapped
+            # gotta wrap most of the api calls in an "operation" block with a transaction id & session id
+            xml.operation(:transactionId => transaction_id, :sessionId => @@session_id) { action_xml(xml) }
+          else
+            action_xml(xml)
+          end
+        }
+      end.to_xml
+    end
+    
+    # called from build_request_xml, just the xml related to the action we're doing
+    # TODO: refactor into a method that takes a wrapper &block
+    def action_xml(xml)
+      inline_params = INLINE_PARAMS_ACTIONS.has_key?(@action) ? {INLINE_PARAMS_ACTIONS[@action] => @params[INLINE_PARAMS_ACTIONS[@action]]} : nil
+      xml.send(@action, inline_params) do
+        params_xml(xml, @params)
+      end
+    end
+    
+    # recursive, so you can do things like:
+    # BillApi.create_vendor :vendor => {:name => 'Test'}
+    def params_xml(xml, params)
+      params.each do |k, v|
+        if v.is_a?(Hash)
+          xml.send(k) { params_xml(xml, v) }
+        else
+          xml.send(k) { xml.text(v) }
+        end
+      end
+    end
+    
+    # generate a transaction id for operation requests
+    def transaction_id
+      @@transaction_id += 1
+      "Transaction#{@@transaction_id}"
+    end
+    
+    def api(xml_body)
+      # puts "XML BODY: #{xml_body}"
+      https = Net::HTTP.new(@@api_domain, 443)
+      https.use_ssl = true
+      https.read_timeout=5 # 5 second timeout
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      req = Net::HTTP::Post.new(@@api_endpoint)
+      req.body = "request=#{req.send(:urlencode, xml_body)}" # prefixing the request with "request=" showed up in the docs absolutely nowhere. thanks, bill.com.
+      req.content_type = 'application/x-www-form-urlencoded'
+      
+      resp = https.start {|http|
+        http.request(req)
+      }
+      case resp
+      when Net::HTTPSuccess
+        resp.body
+      else
+        resp.error!
+      end
+    end
+    
+    def process_response(raw_response)
+      # puts "RAW RESPONSE: #{raw_response}"
+      res = Hash.from_xml(raw_response)['response']
+      res = res["#{@action}result"] || res["operationresult"]
+      res.symbolize_keys!
+      
+      if res[:status] == 'OK'
+        RequestResult.new(res)
+      else
+        raise RequestError.new "#{res[:errorcode]}: #{res[:errormessage]}"
+      end
+    end
+  end
+  
+  class RequestResult < OpenStruct; end
+  class RequestError < StandardError; end
+end

data/lib/loco_bill.rb

@@ -0,0 +1,13 @@
+require 'nokogiri'
+require 'ostruct'
+require 'bill_api/request'
+require 'bill_api/login'
+
+module LocoBill
+  # might not be 100% correct
+  ALLOWED_METHODS = [:login, :logout, :getorglist, :operationbatch, :filter, :expression, :get_list, :org_info, :pay_bill, :vendor, :create_vendor, :update_vendor, :create_chartofaccount, :update_chartofaccount, :create_department, :update_department, :create_job, :update_job, :billpay, :bill, :billLineItem, :billLineItems, :create_bill, :chartOfAccount, :department, :job, :upload_document]
+  
+  def self.method_missing(m, *args, &block)
+    ALLOWED_METHODS.include?(m) ? Request.new(m, *args) : super
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: loco_bill
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- chris mcc
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.3
+    version: 
+description: A ruby wrapper for interacting with Bill.com's developer API
+email: 
+- cmcclelland@digitaladvisor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/loco_bill/login.rb
+- lib/loco_bill/request.rb
+- lib/loco_bill.rb
+- README
+- init.rb
+has_rdoc: true
+homepage: http://github.com/DigitalAdvisor/loco_bill
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: loco_bill
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for interacting with Bill.com's developer API
+test_files: []
+