xero_gateway 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7df3847b8dad3d3d5c593510c72696d7a39763b3
-  data.tar.gz: 5427008d5f2f9d14dfa3834a7125ad84af3db90c
+  metadata.gz: 9c288d4d30be0c8ce139ffd5b3c714f077835e47
+  data.tar.gz: b09d959c33ebacbf10a98509e59cf8e19d53b1f1
 SHA512:
-  metadata.gz: 0fd76a237a99430e26b722736025353481263717be0cc0428e1c50180c6106c11b856f9aae2ea5af5452ebaf519f534f4d8e9638ac59a51b2c1cb8322ff66c73
-  data.tar.gz: 874d4febc34ac826a6df223246c453ae8c74bdf35ecbdffd84d3d6a2ebd94f8d48d9358f8015a5a60118635558303c30ace9868e5732e996c83c48ac5d995ebc
+  metadata.gz: 56dc6a1fc73e3ad5118caa9c10662a64dafeef89e902dc9080053953042cd571895379622be61126c4ecfaeb79c99b5712e14230948aac614ae04dfc0dcc3800
+  data.tar.gz: d3906629a8c6acc8856ac23f3fb1e7f91fca06b9ad22d51d3feb6d455b69ef61cec9381deb8861530c9d860d65b8c5054c30638432e3efa895d3871a7aa20986

data/lib/xero_gateway/gateway.rb

@@ -169,6 +169,7 @@ module XeroGateway
       request_params[:order]         = options[:order] if options[:order]
       request_params[:ModifiedAfter] = options[:modified_since] if options[:modified_since]
       request_params[:ContactIDs]    = Array(options[:contact_ids]).join(",") if options[:contact_ids]
+      request_params[:page]          = options[:page]  if options[:page]
 
       request_params[:where]         = options[:where] if options[:where]
 

data/lib/xero_gateway/invoice.rb

@@ -195,6 +195,7 @@ module XeroGateway
           end
         }
         b.Url url if url
+        b.SentToContact sent_to_contact unless sent_to_contact.nil?
       }
     end
 

data/lib/xero_gateway/oauth.rb

@@ -22,14 +22,16 @@ module XeroGateway
       }.freeze
     end
 
-    extend Forwardable
-    def_delegators :access_token, :get, :post, :put, :delete
-
-    attr_reader   :ctoken, :csecret, :consumer_options, :authorization_expires_at
+    attr_reader   :ctoken, :csecret, :consumer_options, :authorization_expires_at, :expires_at
     attr_accessor :session_handle
 
     def initialize(ctoken, csecret, options = {})
       @ctoken, @csecret = ctoken, csecret
+      
+      # Allow user-agent base val for certification procedure (enforce for PartnerApp)
+      @base_headers = {}
+      @base_headers["User-Agent"] = options.delete(:user_agent) if options.has_key?(:user_agent)
+
       @consumer_options = XERO_CONSUMER_OPTIONS.merge(options)
     end
 
@@ -38,12 +40,16 @@ module XeroGateway
     end
 
     def request_token(params = {})
-      @request_token ||= consumer.get_request_token(params)
+      # Underlying oauth consumer accepts body params and headers for request via positional params - explicit nilling of 
+      #  body parameters allows for correct position for headers
+      @request_token ||= consumer.get_request_token(params, nil, @base_headers)
     end
 
     def authorize_from_request(rtoken, rsecret, params = {})
       request_token     = ::OAuth::RequestToken.new(consumer, rtoken, rsecret)
-      access_token      = request_token.get_access_token(params)
+      # Underlying oauth consumer accepts body params and headers for request via positional params - explicit nilling of 
+      #  body parameters allows for correct position for headers
+      access_token      = request_token.get_access_token(params, nil, @base_headers)
       @atoken, @asecret = access_token.token, access_token.secret
 
       update_attributes_from_token(access_token)
@@ -65,10 +71,12 @@ module XeroGateway
 
       old_token = ::OAuth::RequestToken.new(consumer, access_token, access_secret)
 
+      # Underlying oauth consumer accepts body params and headers for request via positional params - explicit nilling of 
+      #  body parameters allows for correct position for headers
       access_token = old_token.get_access_token({
         :oauth_session_handle => session_handle,
         :token                => old_token
-      })
+      }, nil, @base_headers)
 
       update_attributes_from_token(access_token)
     rescue ::OAuth::Unauthorized => e
@@ -78,6 +86,22 @@ module XeroGateway
       raise XeroGateway::OAuth::TokenInvalid.new(e.message)
     end
 
+    def get(path, headers = {})
+      access_token.get(path, headers.merge(@base_headers))
+    end
+      
+    def post(path, body = '', headers = {})
+      access_token.post(path, body, headers.merge(@base_headers))
+    end
+      
+    def put(path, body = '', headers = {})
+      access_token.put(path, body, headers.merge(@base_headers))
+    end
+    
+    def delete(path, headers = {})
+      access_token.delete(path, headers.merge(@base_headers))
+    end
+
     private
 
       # Update instance variables with those from the AccessToken.

data/lib/xero_gateway/partner_app.rb

@@ -4,11 +4,14 @@ module XeroGateway
     class CertificateRequired < StandardError; end
 
     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, :authorization_expires_at
 
     def initialize(consumer_key, consumer_secret, options = {})
       raise CertificateRequired.new(NO_PRIVATE_KEY_ERROR_MESSAGE) unless options[:private_key_file]
+      
+      #required by Xero for new partner apps, but only issuing warning to keep backward compat for any grandfathered apps
+      puts "WARNING: a unique User-Agent header is required for Xero partner apps, and is missing - this should be supplied as :user_agent" unless options[:user_agent]
 
       defaults = {
         :site             => "https://api.xero.com",

data/lib/xero_gateway/version.rb

@@ -1,3 +1,3 @@
 module XeroGateway
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/test/unit/oauth_test.rb

@@ -75,7 +75,20 @@ class OAuthTest < Test::Unit::TestCase
     xero.stubs(:consumer).returns(consumer)
   
     request_token = mock('request token')
-    consumer.expects(:get_request_token).with(:oauth_callback => "http://callback.com").returns(request_token)
+    consumer.expects(:get_request_token).with({:oauth_callback => "http://callback.com"}, nil, {}).returns(request_token)
+  
+    xero.request_token(:oauth_callback => "http://callback.com")
+  end
+
+  should "be able to create request token with specified base user agent" do
+    xero = XeroGateway::OAuth.new('token', 'secret', {user_agent: 'uagt'})
+    consumer = OAuth::Consumer.new('token', 'secret')
+    xero.stubs(:consumer).returns(consumer)
+  
+    request_token = mock('request token')
+    consumer.expects(:get_request_token)
+            .with({:oauth_callback => "http://callback.com"}, nil, {"User-Agent" => 'uagt'})
+            .returns(request_token)
   
     xero.request_token(:oauth_callback => "http://callback.com")
   end
@@ -91,13 +104,33 @@ class OAuthTest < Test::Unit::TestCase
     access_token.stubs(:params).returns({})
 
     request_token = mock('request token')
-    request_token.expects(:get_access_token).with(:oauth_verifier => "verifier").returns(access_token)
+    request_token.expects(:get_access_token).with({:oauth_verifier => "verifier"}, nil, {}).returns(access_token)
 
     OAuth::RequestToken.expects(:new).with(consumer, 'rtoken', 'rsecret').returns(request_token)
     
     xero.authorize_from_request('rtoken', 'rsecret', :oauth_verifier => "verifier")
   end
   
+  should "be able to create access token with specified base user agent" do
+    xero = XeroGateway::OAuth.new('token', 'secret', {user_agent: 'uagt'})
+    consumer = OAuth::Consumer.new('token', 'secret')
+    xero.stubs(:consumer).returns(consumer)
+    
+    access_token = mock('access token')
+    access_token.expects(:token).twice.returns('atoken')
+    access_token.expects(:secret).twice.returns('asecret')
+    access_token.stubs(:params).returns({})
+
+    request_token = mock('request token')
+    request_token.expects(:get_access_token)
+                  .with({:oauth_verifier => "verifier"}, nil, {"User-Agent" => 'uagt'})
+                  .returns(access_token)
+
+    OAuth::RequestToken.expects(:new).with(consumer, 'rtoken', 'rsecret').returns(request_token)
+    
+    xero.authorize_from_request('rtoken', 'rsecret', :oauth_verifier => "verifier")
+  end  
+  
   should "delegate get to access token" do
     access_token = mock('access token')
     xero = XeroGateway::OAuth.new('token', 'secret')
@@ -113,4 +146,24 @@ class OAuthTest < Test::Unit::TestCase
     access_token.expects(:post).returns(nil)
     xero.post('/foo')
   end
+  
+  should "be able to specify base user-agent header for calls" do
+    xero = XeroGateway::OAuth.new('token', 'secret', user_agent: 'testagt')
+    consumer = OAuth::Consumer.new('token', 'secret')
+    xero.stubs(:consumer).returns(consumer)
+
+    access_token = mock('access token')
+    access_token.expects(:token).twice.returns('atoken')
+    access_token.expects(:secret).twice.returns('asecret')
+    access_token.stubs(:params).returns({})
+
+    request_token = mock('request token')
+    request_token.expects(:get_access_token).returns(access_token)
+    OAuth::RequestToken.expects(:new).with(consumer, 'rtoken', 'rsecret').returns(request_token)
+
+    xero.authorize_from_request('rtoken', 'rsecret')
+    assert xero.access_token.is_a? OAuth::AccessToken
+    assert_equal "atoken",  xero.access_token.token
+    assert_equal "asecret", xero.access_token.secret
+  end  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xero_gateway
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Tim Connor
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2017-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -270,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Enables Ruby based applications to communicate with the Xero API