xero_gateway 2.0.12 → 2.0.13

data/examples/partner_app.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'pp'
+
+require File.dirname(__FILE__) + '/../lib/xero_gateway.rb'
+
+XERO_CONSUMER_KEY    = "YOUR CONSUMER KEY"
+XERO_CONSUMER_SECRET = "YOUR CONSUMER SERET"
+
+ENTRUST_CERT_NAME    = "YOUR_ENTRUST_CERT.pem"
+ENTRUST_KEY_NAME     = "YOUR_ENTRUST_KEY.pem"
+PRIVATE_KEY          = "YOUR_PRIVATE_KEY.pem"
+
+gateway = XeroGateway::PartnerApp.new(XERO_CONSUMER_KEY, XERO_CONSUMER_SECRET, 
+                                      :ssl_client_cert  => File.join(File.dirname(__FILE__), ENTRUST_CERT_NAME)
+                                      :ssl_client_key   => File.join(File.dirname(__FILE__), ENTRUST_KEY_NAME),
+                                      :private_key_file => File.join(File.dirname(__FILE__), PRIVATE_KEY))
+
+# authorize in browser
+%x(open #{gateway.request_token.authorize_url})
+
+puts "Enter the verification code from Xero?"
+oauth_verifier = gets.chomp  
+
+gateway.authorize_from_request(gateway.request_token.token, gateway.request_token.secret, :oauth_verifier => oauth_verifier)
+
+puts "Your access token/secret: #{gateway.access_token.token}, #{gateway.access_token.secret}. Expires: #{gateway.authorization_expires_at}"
+puts "(Good for 30 Minutes - but we can renew it!)"
+
+puts "Session Handle: #{gateway.session_handle}"
+
+# Example API Call
+pp gateway.get_contacts.contacts.map(&:name)
+
+# Renew!
+gateway.renew_access_token(gateway.access_token.token, gateway.access_token.secret, gateway.session_handle)
+puts "Your renewed access token/secret is:  #{gateway.access_token.token}, #{gateway.access_token.secret}. Expires: #{gateway.authorization_expires_at}"

data/lib/oauth/oauth_consumer.rb

@@ -0,0 +1,14 @@
+module OAuth
+  class Consumer
+    
+    def http_with_ssl_client_certificates(*args)
+      @http ||= http_without_ssl_client_certificates(*args).tap do |http|
+        http.cert = options[:ssl_client_cert]
+        http.key  = options[:ssl_client_key]
+      end
+    end
+  
+    alias_method_chain :http, :ssl_client_certificates
+    
+  end
+end

data/lib/xero_gateway/gateway.rb

@@ -7,7 +7,7 @@ module XeroGateway
     attr_accessor :client, :xero_url, :logger
     
     extend Forwardable
-    def_delegators :client, :request_token, :access_token, :authorize_from_request, :authorize_from_access
+    def_delegators :client, :request_token, :access_token, :authorize_from_request, :authorize_from_access, :authorization_expires_at
 
     #
     # The consumer key and secret here correspond to those provided

data/lib/xero_gateway/invoice.rb

@@ -39,7 +39,7 @@ module XeroGateway
     attr_accessor :line_items_downloaded
   
     # All accessible fields
-    attr_accessor :invoice_id, :invoice_number, :invoice_type, :invoice_status, :date, :due_date, :reference, :line_amount_types, :currency_code, :line_items, :contact, :payments, :fully_paid_on, :amount_due, :amount_paid, :amount_credited
+    attr_accessor :invoice_id, :invoice_number, :invoice_type, :invoice_status, :date, :due_date, :reference, :line_amount_types, :currency_code, :line_items, :contact, :payments, :fully_paid_on, :amount_due, :amount_paid, :amount_credited, :sent_to_contact
 
     
     def initialize(params = {})
@@ -278,6 +278,7 @@ module XeroGateway
           when "AmountDue" then invoice.amount_due = BigDecimal.new(element.text)
           when "AmountPaid" then invoice.amount_paid = BigDecimal.new(element.text)
           when "AmountCredited" then invoice.amount_credited = BigDecimal.new(element.text)
+          when "SentToContact" then invoice.sent_to_contact = (element.text.strip.downcase == "true")
         end
       end      
       invoice

data/lib/xero_gateway/oauth.rb

@@ -25,7 +25,7 @@ module XeroGateway
     extend Forwardable
     def_delegators :access_token, :get, :post, :put, :delete
     
-    attr_reader :ctoken, :csecret, :consumer_options
+    attr_reader :ctoken, :csecret, :consumer_options, :session_handle, :authorization_expires_at
     
     def initialize(ctoken, csecret, options = {})
       @ctoken, @csecret = ctoken, csecret
@@ -44,6 +44,8 @@ module XeroGateway
       request_token     = ::OAuth::RequestToken.new(consumer, rtoken, rsecret)
       access_token      = request_token.get_access_token(params)
       @atoken, @asecret = access_token.token, access_token.secret
+      
+      update_attributes_from_token(access_token)
     end
     
     def access_token
@@ -53,6 +55,33 @@ module XeroGateway
     def authorize_from_access(atoken, asecret)
       @atoken, @asecret = atoken, asecret
     end
+  
+    # Renewing access tokens only works for Partner applications
+    def renew_access_token(access_token = nil, access_secret = nil, session_handle = nil)
+      access_token   ||= @atoken
+      access_secret  ||= @asecret 
+      session_handle ||= @session_handle
+      
+      old_token = ::OAuth::RequestToken.new(consumer, access_token, access_secret)
+      
+      access_token = old_token.get_access_token({
+        :oauth_session_handle => session_handle,
+        :token                => old_token
+      })
+      
+      update_attributes_from_token(access_token)
+    end
+    
+    private
+    
+      # Update instance variables with those from the AccessToken.
+      def update_attributes_from_token(access_token)
+        @expires_at               = Time.now + access_token.params[:oauth_expires_in].to_i
+        @authorization_expires_at = Time.now + access_token.params[:oauth_authorization_expires_in].to_i
+        @session_handle           = access_token.params[:oauth_session_handle]
+        @atoken, @asecret         = access_token.token, access_token.secret
+        @access_token             = nil
+      end
     
   end
 end

data/lib/xero_gateway/organisation.rb

@@ -3,16 +3,21 @@ module XeroGateway
     
     unless defined? ATTRS
       ATTRS = {
-        "Name" 	             => :string,     # Display name of organisation shown in Xero
-        "LegalName"          => :string,	   # Organisation name shown on Reports
-        "PaysTax" 	         => :boolean,    # Boolean to describe if organisation is registered with a local tax authority i.e. true, false
-        "Version"   	       => :string,     # See Version Types
-        "BaseCurrency"       => :string,     # Default currency for organisation. See Currency types
-        "OrganisationType"   => :string,     # UNDOCUMENTED parameter, only returned for "real" (i.e non-demo) companies
-        "OrganisationStatus" => :string,   # UNDOCUMENTED parameter
-        "IsDemoCompany"      => :boolean,    # UNDOCUMENTED parameter
-        "APIKey"             => :string,     # UNDOCUMENTED paramater, returned if organisations are linked via Xero Network
-        "CountryCode"        => :stirng      # UNDOCUMENTED parameter
+        "Name" 	                => :string,     # Display name of organisation shown in Xero
+        "LegalName"             => :string,	   # Organisation name shown on Reports
+        "PaysTax" 	            => :boolean,    # Boolean to describe if organisation is registered with a local tax authority i.e. true, false
+        "Version"   	          => :string,     # See Version Types
+        "BaseCurrency"          => :string,     # Default currency for organisation. See Currency types
+        "OrganisationType"      => :string,     # UNDOCUMENTED parameter, only returned for "real" (i.e non-demo) companies
+        "OrganisationStatus"    => :string,   # UNDOCUMENTED parameter
+        "IsDemoCompany"         => :boolean,    # UNDOCUMENTED parameter
+        "APIKey"                => :string,     # UNDOCUMENTED paramater, returned if organisations are linked via Xero Network
+        "CountryCode"           => :string,      # UNDOCUMENTED parameter
+        "TaxNumber"             => :string,
+        "FinancialYearEndDay"   => :string,
+        "FinancialYearEndMonth" => :string,
+        "PeriodLockDate"        => :string,
+        "CreatedDateUTC"        => :string        
       }
     end
     
@@ -48,12 +53,18 @@ module XeroGateway
           attribute             = element.name
           underscored_attribute = element.name.underscore
         
-          raise "Unknown attribute: #{attribute}" unless ATTRS.keys.include?(attribute)
-        
-          case (ATTRS[attribute])
-            when :boolean then  org.send("#{underscored_attribute}=", (element.text == "true"))
-            when :float   then  org.send("#{underscored_attribute}=", element.text.to_f)
-            else                org.send("#{underscored_attribute}=", element.text)
+          if ATTRS.keys.include?(attribute)
+                  
+            case (ATTRS[attribute])
+              when :boolean then  org.send("#{underscored_attribute}=", (element.text == "true"))
+              when :float   then  org.send("#{underscored_attribute}=", element.text.to_f)
+              else                org.send("#{underscored_attribute}=", element.text)
+            end
+            
+          else
+            
+            warn "Ignoring unknown attribute: #{attribute}" 
+            
           end
           
         end

data/lib/xero_gateway/partner_app.rb

@@ -0,0 +1,30 @@
+module XeroGateway
+  class PartnerApp < Gateway
+    
+    class CertificateRequired < StandardError; end
+    
+    NO_SSL_CLIENT_CERT_MESSAGE   = "You need to provide a client ssl certificate and key pair (these are the ones you got from Entrust and should not be password protected) as :ssl_client_cert and :ssl_client_key (should be .crt or .pem files)"
+    NO_PRIVATE_KEY_ERROR_MESSAGE = "You need to provide your private key (corresponds to the public key you uploaded at api.xero.com) as :private_key_file (should be .crt or .pem files)"
+    
+    def_delegators :client, :session_handle, :renew_access_token
+     
+    def initialize(consumer_key, consumer_secret, options = {})
+      
+      raise CertificateRequired.new(NO_SSL_CLIENT_CERT_MESSAGE)   unless options[:ssl_client_cert]
+      raise CertificateRequired.new(NO_SSL_CLIENT_CERT_MESSAGE)   unless options[:ssl_client_key]
+      raise CertificateRequired.new(NO_PRIVATE_KEY_ERROR_MESSAGE) unless options[:private_key_file]
+      
+      options.merge!(
+        :site             => "https://api-partner.network.xero.com",
+        :authorize_url    => 'https://api.xero.com/oauth/Authorize', 
+        :signature_method => 'RSA-SHA1',
+        :ssl_client_cert  => OpenSSL::X509::Certificate.new(File.read(options[:ssl_client_cert])),
+        :ssl_client_key   => OpenSSL::PKey::RSA.new(File.read(options[:ssl_client_key])),
+        :private_key_file => options[:private_key_file]
+      )
+      
+      @xero_url = options[:xero_url] || "https://api-partner.xero.com/api.xro/2.0"  
+      @client   = OAuth.new(consumer_key, consumer_secret, options)
+    end
+  end
+end

data/lib/xero_gateway.rb

@@ -7,7 +7,9 @@ require "bigdecimal"
 require "oauth"
 require 'oauth/signature/rsa/sha1'
 require "forwardable"
-require "active_support/inflector"
+require "active_support/all"
+
+require File.join(File.dirname(__FILE__), 'oauth', 'oauth_consumer')
 
 require File.join(File.dirname(__FILE__), 'xero_gateway', 'http_encoding_helper')
 require File.join(File.dirname(__FILE__), 'xero_gateway', 'http')
@@ -32,3 +34,4 @@ require File.join(File.dirname(__FILE__), 'xero_gateway', 'oauth')
 require File.join(File.dirname(__FILE__), 'xero_gateway', 'exceptions')
 require File.join(File.dirname(__FILE__), 'xero_gateway', 'gateway')
 require File.join(File.dirname(__FILE__), 'xero_gateway', 'private_app')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'partner_app')

data/test/integration/get_invoices_test.rb

@@ -28,6 +28,8 @@ class GetInvoicesTest < Test::Unit::TestCase
     assert !result.request_params.nil?
     assert !result.response_xml.nil?  
     assert result.invoices.collect {|i| i.invoice_number}.include?(invoice.invoice_number)
+    assert result.invoices[0].sent_to_contact == true
+    assert result.invoices[1].sent_to_contact == false
   end
   
   def test_get_invoices_with_modified_since_date

data/xero_gateway.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name     = "xero_gateway"
-  s.version  = "2.0.12"
-  s.date     = "2011-05-25"
+  s.version  = "2.0.13"
+  s.date     = "2011-09-14"
   s.summary  = "Enables ruby based applications to communicate with the Xero API"
   s.email    = "tim@connorsoftware.com"
   s.homepage = "http://github.com/tlconnor/xero_gateway"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xero_gateway
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 2
   - 0
-  - 12
-  version: 2.0.12
+  - 13
+  version: 2.0.13
 platform: ruby
 authors: 
 - Tim Connor
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-25 00:00:00 +12:00
+date: 2011-09-14 00:00:00 +12:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,7 +80,9 @@ files:
 - README.textile
 - xero_gateway.gemspec
 - examples/oauth.rb
+- examples/partner_app.rb
 - init.rb
+- lib/oauth/oauth_consumer.rb
 - lib/xero_gateway/account.rb
 - lib/xero_gateway/accounts_list.rb
 - lib/xero_gateway/address.rb
@@ -98,6 +100,7 @@ files:
 - lib/xero_gateway/money.rb
 - lib/xero_gateway/oauth.rb
 - lib/xero_gateway/organisation.rb
+- lib/xero_gateway/partner_app.rb
 - lib/xero_gateway/payment.rb
 - lib/xero_gateway/phone.rb
 - lib/xero_gateway/private_app.rb
@@ -134,7 +137,7 @@ files:
 - test/unit/tax_rate_test.rb
 - test/unit/tracking_category_test.rb
 - lib/xero_gateway/ca-certificates.crt
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/tlconnor/xero_gateway
 licenses: []
 
@@ -164,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.8
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Enables ruby based applications to communicate with the Xero API