xeroizer 2.15.5 → 2.15.6

data/README.md

@@ -112,10 +112,10 @@ class XeroSessionController < ApplicationController
 						
 			session[:xero_auth] = {
 					:access_token => @xero_client.access_token.token,
-					:access_key => @xero_client.access_token.key }
+					:access_key => @xero_client.access_token.secret }
 															
-			session.data.delete(:request_token)
-			session.data.delete(:request_secret)
+			session[:request_token] = nil
+            session[:request_secret] = nil
 		end
 		
 		def destroy
@@ -549,6 +549,17 @@ client = Xeroizer::PublicApplication.new(YOUR_OAUTH_CONSUMER_KEY,
                                          :rate_limit_sleep => 2)
 ```
 
+Logging
+---------------
+
+You can add an optional paramater to the Xeroizer Application initialization, to pass a logger object that will need to respond_to :info. For example, in a rails app:
+
+```ruby
+XeroLogger = Logger.new('log/xero.log', 'weekly')
+client = Xeroizer::PublicApplication.new(YOUR_OAUTH_CONSUMER_KEY,
+                                         YOUR_OAUTH_CONSUMER_SECRET,
+                                         :logger => XeroLogger)
+```
 
 ### Contributors
 Xeroizer was inspired by the https://github.com/tlconnor/xero_gateway gem created by Tim Connor 

data/lib/xeroizer.rb

@@ -27,6 +27,7 @@ require 'xeroizer/configuration'
 # Include models
 require 'xeroizer/models/account'
 require 'xeroizer/models/address'
+require 'xeroizer/models/allocation'
 require 'xeroizer/models/branding_theme'
 require 'xeroizer/models/bank_transaction'
 require 'xeroizer/models/bank_account'
@@ -35,6 +36,7 @@ require 'xeroizer/models/contact_group'
 require 'xeroizer/models/credit_note'
 require 'xeroizer/models/currency'
 require 'xeroizer/models/employee'
+require 'xeroizer/models/expense_claim'
 require 'xeroizer/models/invoice'
 require 'xeroizer/models/item'
 require 'xeroizer/models/item_purchase_details'
@@ -48,9 +50,12 @@ require 'xeroizer/models/option'
 require 'xeroizer/models/organisation'
 require 'xeroizer/models/payment'
 require 'xeroizer/models/phone'
+require 'xeroizer/models/receipt'
 require 'xeroizer/models/tax_rate'
+require 'xeroizer/models/tax_component'
 require 'xeroizer/models/tracking_category'
 require 'xeroizer/models/tracking_category_child'
+require 'xeroizer/models/user'
 require 'xeroizer/models/journal_line_tracking_category'
 
 require 'xeroizer/report/factory'

data/lib/xeroizer/generic_application.rb

@@ -2,30 +2,34 @@ require 'xeroizer/record/application_helper'
 
 module Xeroizer
   class GenericApplication
-    
+
     include Http
     extend Record::ApplicationHelper
-    
-    attr_reader :client, :xero_url, :logger, :rate_limit_sleep, :rate_limit_max_attempts
-    
+
+    attr_reader :client, :xero_url, :logger, :rate_limit_sleep, :rate_limit_max_attempts, :default_headers
+
     extend Forwardable
     def_delegators :client, :access_token
-    
+
     record :Account
+    record :Attachment
     record :BrandingTheme
     record :Contact
     record :CreditNote
     record :Currency
     record :Employee
+    record :ExpenseClaim
     record :Invoice
     record :Item
     record :Journal
     record :ManualJournal
     record :Organisation
     record :Payment
+    record :Receipt
     record :TaxRate
     record :TrackingCategory
     record :BankTransaction
+    record :User
 
     report :AgedPayablesByContact
     report :AgedReceivablesByContact
@@ -36,9 +40,9 @@ module Xeroizer
     report :ExecutiveSummary
     report :ProfitAndLoss
     report :TrialBalance
-    
+
     public
-    
+
       # Never used directly. Use sub-classes instead.
       # @see PublicApplication
       # @see PrivateApplication
@@ -47,8 +51,10 @@ module Xeroizer
         @xero_url = options[:xero_url] || "https://api.xero.com/api.xro/2.0"
         @rate_limit_sleep = options[:rate_limit_sleep] || false
         @rate_limit_max_attempts = options[:rate_limit_max_attempts] || 5
-        @client   = OAuth.new(consumer_key, consumer_secret, options)
+        @default_headers = options[:default_headers] || {}
+        @client   = OAuth.new(consumer_key, consumer_secret, options.merge({default_headers: default_headers}))
+        @logger = options[:logger] || false
       end
-          
+
   end
 end

data/lib/xeroizer/http.rb

@@ -1,9 +1,9 @@
 # Copyright (c) 2008 Tim Connor <tlconnor@gmail.com>
-# 
+#
 # Permission to use, copy, modify, and/or distribute this software for any
 # purpose with or without fee is hereby granted, provided that the above
 # copyright notice and this permission notice appear in all copies.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
@@ -14,12 +14,13 @@
 
 module Xeroizer
   module Http
-    
+    class BadResponse < StandardError; end
+
     ACCEPT_MIME_MAP = {
       :pdf  => 'application/pdf',
       :json => 'application/json'
     }
-    
+
     # Shortcut method for #http_request with `method` = :get.
     #
     # @param [OAuth] client OAuth client
@@ -48,21 +49,24 @@ module Xeroizer
     def http_put(client, url, body, extra_params = {})
       http_request(client, :put, url, body, extra_params)
     end
-    
+
     private
-    
+
       def http_request(client, method, url, body, params = {})
         # headers = {'Accept-Encoding' => 'gzip, deflate'}
 
-        headers = { 'charset' => 'utf-8' }
+        headers = self.default_headers.merge({ 'charset' => 'utf-8' })
 
         if method != :get
           headers['Content-Type'] ||= "application/x-www-form-urlencoded"
         end
 
+        content_type = params.delete(:content_type)
+        headers['Content-Type'] = content_type if content_type
+
         # HAX.  Xero completely misuse the If-Modified-Since HTTP header.
         headers['If-Modified-Since'] = params.delete(:ModifiedAfter).utc.strftime("%Y-%m-%dT%H:%M:%S") if params[:ModifiedAfter]
-        
+
         # Allow 'Accept' header to be specified with :accept parameter.
         # Valid values are :pdf or :json.
         if params[:response]
@@ -72,7 +76,7 @@ module Xeroizer
             else              response_type
           end
         end
-        
+
         if params.any?
           url += "?" + params.map {|key,value| "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"}.join("&")
         end
@@ -83,19 +87,20 @@ module Xeroizer
 
         begin
           attempts += 1
-          logger.info("\n== [#{Time.now.to_s}] XeroGateway Request: #{method.to_s.upcase} #{uri.request_uri} ") if self.logger
+          logger.info("XeroGateway Request: #{method.to_s.upcase} #{uri.request_uri}") if self.logger
+
+          raw_body = params.delete(:raw_body) ? body : {:xml => body}
 
           response = case method
             when :get   then    client.get(uri.request_uri, headers)
-            when :post  then    client.post(uri.request_uri, { :xml => body }, headers)
-            when :put   then    client.put(uri.request_uri, { :xml => body }, headers)
+            when :post  then    client.post(uri.request_uri, raw_body, headers)
+            when :put   then    client.put(uri.request_uri, raw_body, headers)
           end
 
           if self.logger
-            logger.info("== [#{Time.now.to_s}] XeroGateway Response (#{response.code})")
-
+            logger.info("XeroGateway Response (#{response.code})")
             unless response.code.to_i == 200
-              logger.info("== #{uri.request_uri} Response Body \n\n #{response.plain_body} \n == End Response Body")
+              logger.info("#{uri.request_uri}\n== Response Body\n\n#{response.plain_body}\n== End Response Body")
             end
           end
 
@@ -111,12 +116,12 @@ module Xeroizer
             when 503
               handle_oauth_error!(response)
             else
-              raise "Unknown response code: #{response.code.to_i}"
+              handle_unknown_response_error!(response)
           end
         rescue Xeroizer::OAuth::RateLimitExceeded
           if self.rate_limit_sleep
             raise if attempts > rate_limit_max_attempts
-            logger.info("== Rate limit exceeded, retrying") if self.logger
+            logger.info("Rate limit exceeded, retrying") if self.logger
             sleep_for(self.rate_limit_sleep)
             retry
           else
@@ -124,34 +129,35 @@ module Xeroizer
           end
         end
       end
-       
+
       def handle_oauth_error!(response)
         error_details = CGI.parse(response.plain_body)
         description   = error_details["oauth_problem_advice"].first
-      
+
         # see http://oauth.pbworks.com/ProblemReporting
         # In addition to token_expired and token_rejected, Xero also returns
         # 'rate limit exceeded' when more than 60 requests have been made in
         # a second.
         case (error_details["oauth_problem"].first)
-          when "token_expired"        then raise OAuth::TokenExpired.new(description)
-          when "token_rejected"       then raise OAuth::TokenInvalid.new(description)
-          when "rate limit exceeded"  then raise OAuth::RateLimitExceeded.new(description)
-          else raise OAuth::UnknownError.new(error_details["oauth_problem"].first + ':' + description)
+          when "token_expired"                then raise OAuth::TokenExpired.new(description)
+          when "token_rejected"               then raise OAuth::TokenInvalid.new(description)
+          when "rate limit exceeded"          then raise OAuth::RateLimitExceeded.new(description)
+          when error_details["oauth_problem"] then raise OAuth::UnknownError.new(error_details["oauth_problem"].first + ':' + description)
+          else raise OAuth::UnknownError.new("Xero API may be down or the way OAuth errors are provided by Xero may have changed.")
         end
       end
-      
+
       def handle_error!(response, request_body)
-        
+
         raw_response = response.plain_body
-        
+
         # XeroGenericApplication API Exceptions *claim* to be UTF-16 encoded, but fail REXML/Iconv parsing...
         # So let's ignore that :)
         raw_response.gsub! '<?xml version="1.0" encoding="utf-16"?>', ''
-        
+
         # doc = REXML::Document.new(raw_response, :ignore_whitespace_nodes => :all)
         doc = Nokogiri::XML(raw_response)
-        
+
         if doc && doc.root && doc.root.name == "ApiException"
 
           raise ApiException.new(doc.root.xpath("Type").text,
@@ -161,13 +167,13 @@ module Xeroizer
                                  request_body)
 
         else
-          
-          raise "Unparseable 400 Response: #{raw_response}"
-          
+
+          raise BadResponse.new("Unparseable 400 Response: #{raw_response}")
+
         end
-        
+
       end
-      
+
       def handle_object_not_found!(response, request_url)
         case(request_url)
           when /Invoices/ then raise InvoiceNotFoundError.new("Invoice not found in Xero.")
@@ -176,9 +182,13 @@ module Xeroizer
         end
       end
 
+      def handle_unknown_response_error!(response)
+        raise BadResponse.new("Unknown response code: #{response.code.to_i}")
+      end
+
       def sleep_for(seconds = 1)
         sleep seconds
       end
-      
+
   end
 end

data/lib/xeroizer/models/account.rb

@@ -1,14 +1,18 @@
 module Xeroizer
   module Record
-    
+
     class AccountModel < BaseModel
-        
-      set_permissions :read
-        
+
+      set_permissions :read, :write
+
+      # The Accounts endpoint doesn't support the POST method yet.
+      def create_method
+        :http_put
+      end
     end
-    
+
     class Account < Base
-    
+
       TYPE = {
         'CURRENT' =>        '',
         'FIXED' =>          '',
@@ -32,7 +36,7 @@ module Xeroizer
         'INPUT' =>            'GST on expenses',
         'SRINPUT' =>          'VAT on expenses',
         'ZERORATEDINPUT' =>   'Expense purchased from overseas (UK only)',
-        'RRINPUT' =>          'Reduced rate VAT on expenses (UK Only)', 
+        'RRINPUT' =>          'Reduced rate VAT on expenses (UK Only)',
         'EXEMPTOUTPUT' =>     'VAT on sales exempt from VAT (UK only)',
         'OUTPUT' =>           'OUTPUT',
         'OUTPUT2' =>          'OUTPUT2',
@@ -42,9 +46,9 @@ module Xeroizer
         'ZERORATED' =>        'Zero-rated supplies/sales from overseas (NZ Only)',
         'ECZROUTPUT' =>       'Zero-rated EC Income (UK only)'
       } unless defined?(TAX_TYPE)
-      
+
       set_primary_key :account_id
-            
+
       guid    :account_id
       string  :code
       string  :name
@@ -60,8 +64,8 @@ module Xeroizer
       string  :bank_account_number
       string  :reporting_code
       string  :reporting_code_name
-      
+
     end
-    
+
   end
 end

data/lib/xeroizer/models/allocation.rb

@@ -0,0 +1,13 @@
+module Xeroizer
+  module Record
+    class AllocationModel < BaseModel
+    end
+
+    class Allocation < Base
+      decimal :applied_amount
+      belongs_to :invoice
+
+      validates_presence_of :invoice
+    end
+  end
+end

data/lib/xeroizer/models/attachment.rb

@@ -0,0 +1,93 @@
+module Xeroizer
+  module Record
+
+    class AttachmentModel < BaseModel
+
+      module Extensions
+        def attach_data(id, filename, data, content_type = "application/octet-stream")
+          application.Attachment.attach_data(url, id, filename, data, content_type)
+        end
+
+        def attach_file(id, filename, path, content_type = "application/octet-stream")
+          application.Attachment.attach_file(url, id, filename, path, content_type)
+        end
+
+        def attachments(id)
+          application.Attachment.attachments_for(url, id)
+        end
+      end
+
+      set_permissions :read
+
+      def attach_data(url, id, filename, data, content_type)
+        response_xml = @application.http_put(@application.client,
+                                              "#{url}/#{CGI.escape(id)}/Attachments/#{CGI.escape(filename)}",
+                                              data,
+                                              :raw_body => true, :content_type => content_type
+                                             )
+        response = parse_response(response_xml)
+        if (response_items = response.response_items) && response_items.size > 0
+          response_items.size == 1 ? response_items.first : response_items
+        else
+          response
+        end
+      end
+
+      def attach_file(url, id, filename, path, content_type)
+        attach_data(url, id, filename, File.read(path), content_type)
+      end
+
+      def attachments_for(url, id)
+        response_xml = @application.http_get(@application.client,
+                                             "#{url}/#{CGI.escape(id)}/Attachments")
+
+        response = parse_response(response_xml)
+        if (response_items = response.response_items) && response_items.size > 0
+          response_items
+        else
+          []
+        end
+      end
+
+    end
+
+    class Attachment < Base
+
+      module Extensions
+        def attach_file(filename, path, content_type = "application/octet-stream")
+          parent.attach_file(id, filename, path, content_type)
+        end
+
+        def attach_data(filename, data, content_type = "application/octet-stream")
+          parent.attach_data(id, filename, data, content_type)
+        end
+
+        def attachments
+          parent.attachments(id)
+        end
+      end
+
+      set_primary_key :attachment_id
+
+      guid    :attachment_id
+      string  :file_name
+      string  :url
+      string  :mime_type
+      integer :content_length
+
+      # Retrieve the attachment data.
+      # @param [String] filename optional filename to store the attachment in instead of returning the data.
+      def get(filename = nil)
+        data = parent.application.http_get(parent.application.client, url)
+        if filename
+          File.open(filename, "w") { | fp | fp.write data }
+          nil
+        else
+          data
+        end
+      end
+
+    end
+
+  end
+end