xero-ruby 2.9.1 → 3.1.0

data/lib/xero-ruby/models/projects/time_entries.rb

@@ -188,7 +188,7 @@ module XeroRuby::Projects
         value = self.send(attr)
         next if value.nil?
         key = downcase ? attr : param
-        hash[key] = _to_hash(value)
+        hash[key] = _to_hash(value, downcase: downcase)
       end
       hash
     end
@@ -202,15 +202,17 @@ module XeroRuby::Projects
     # For object, use to_hash. Otherwise, just return the value
     # @param [Object] value Any valid value
     # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
+    def _to_hash(value, downcase: false)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
       elsif value.is_a?(Hash)
         {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
         end
       elsif value.respond_to? :to_hash
-        value.to_hash
+        value.to_hash(downcase: downcase)
       else
         value
       end
@@ -218,8 +220,10 @@ module XeroRuby::Projects
 
     def parse_date(datestring)
       if datestring.include?('Date')
-        seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-        Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
       else # handle date 'types' for small subset of payroll API's
         Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
       end

data/lib/xero-ruby/models/projects/time_entry.rb

@@ -44,6 +44,7 @@ module XeroRuby::Projects
     attr_accessor :status
     ACTIVE = "ACTIVE".freeze
     LOCKED = "LOCKED".freeze
+    INVOICED = "INVOICED".freeze
     
     class EnumAttributeValidator
       attr_reader :datatype
@@ -159,7 +160,7 @@ module XeroRuby::Projects
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "LOCKED"])
+      status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "LOCKED", "INVOICED"])
       return false unless status_validator.valid?(@status)
       true
     end
@@ -167,7 +168,7 @@ module XeroRuby::Projects
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["ACTIVE", "LOCKED"])
+      validator = EnumAttributeValidator.new('String', ["ACTIVE", "LOCKED", "INVOICED"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end
@@ -292,7 +293,7 @@ module XeroRuby::Projects
         value = self.send(attr)
         next if value.nil?
         key = downcase ? attr : param
-        hash[key] = _to_hash(value)
+        hash[key] = _to_hash(value, downcase: downcase)
       end
       hash
     end
@@ -306,15 +307,17 @@ module XeroRuby::Projects
     # For object, use to_hash. Otherwise, just return the value
     # @param [Object] value Any valid value
     # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
+    def _to_hash(value, downcase: false)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
       elsif value.is_a?(Hash)
         {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
         end
       elsif value.respond_to? :to_hash
-        value.to_hash
+        value.to_hash(downcase: downcase)
       else
         value
       end
@@ -322,8 +325,10 @@ module XeroRuby::Projects
 
     def parse_date(datestring)
       if datestring.include?('Date')
-        seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-        Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
       else # handle date 'types' for small subset of payroll API's
         Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
       end

data/lib/xero-ruby/models/projects/time_entry_create_or_update.rb

@@ -236,7 +236,7 @@ module XeroRuby::Projects
         value = self.send(attr)
         next if value.nil?
         key = downcase ? attr : param
-        hash[key] = _to_hash(value)
+        hash[key] = _to_hash(value, downcase: downcase)
       end
       hash
     end
@@ -250,15 +250,17 @@ module XeroRuby::Projects
     # For object, use to_hash. Otherwise, just return the value
     # @param [Object] value Any valid value
     # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
+    def _to_hash(value, downcase: false)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
       elsif value.is_a?(Hash)
         {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
         end
       elsif value.respond_to? :to_hash
-        value.to_hash
+        value.to_hash(downcase: downcase)
       else
         value
       end
@@ -266,8 +268,10 @@ module XeroRuby::Projects
 
     def parse_date(datestring)
       if datestring.include?('Date')
-        seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-        Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
       else # handle date 'types' for small subset of payroll API's
         Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
       end

data/lib/xero-ruby/version.rb

@@ -7,9 +7,9 @@ Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
 
-The version of the XeroOpenAPI document: 2.10.5
+The version of the XeroOpenAPI document: 2.13.0
 =end
 
 module XeroRuby
-  VERSION = '2.9.1'
+  VERSION = '3.1.0'
 end

data/spec/api_client_spec.rb

@@ -60,13 +60,26 @@ describe XeroRuby::ApiClient do
           api_client = XeroRuby::ApiClient.new(credentials: creds)
           expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https://mydomain.com/callback&scope=openid+profile+email+accounting.transactions+accounting.settings')
         end
+
+        it "Validates state on callback matches @config.state" do
+          creds = {
+            client_id: 'abc',
+            client_secret: '123',
+            redirect_uri: 'https://mydomain.com/callback',
+            scopes: 'openid profile email accounting.transactions accounting.settings',
+            state: "custom-state"
+          }
+          api_client = XeroRuby::ApiClient.new(credentials: creds)
+          altered_state = {'state': 'not-original-state'}
+          expect{api_client.validate_state(altered_state)}.to raise_error(StandardError, 'WARNING: @config.state: custom-state and OAuth callback state:  do not match!')
+        end
       end
     end
   end
 
   describe 'api_client helper functions' do
     let(:api_client) { XeroRuby::ApiClient.new }
-    let(:token_set) { {access_token: 'eyx.jibberjabber', refresh_token: 'REFRESHMENTS'} }
+    let(:token_set) { {'access_token': 'eyx.authorization.data', 'id_token': 'eyx.authentication.data', 'refresh_token': 'REFRESHMENTS'} }
     let(:connections) {
         [{
         "id" => "xxx-yyy-zzz",
@@ -84,12 +97,17 @@ describe XeroRuby::ApiClient do
 
     it "#set_token_set" do
       api_client.set_token_set(token_set)
-      expect(api_client.token_set).to eq(token_set)
+      expect(api_client.token_set).to eq(token_set.with_indifferent_access)
     end
 
     it "#set_access_token" do
-      api_client.set_access_token(token_set[:access_token])
-      expect(api_client.access_token).to eq(token_set[:access_token])
+      api_client.set_access_token(token_set['access_token'])
+      expect(api_client.access_token).to eq(token_set['access_token'])
+    end
+
+    it "#set_id_token" do
+      api_client.set_id_token(token_set['id_token'])
+      expect(api_client.id_token).to eq(token_set['id_token'])
     end
 
     it "#refresh_token_set" do
@@ -372,6 +390,63 @@ describe XeroRuby::ApiClient do
     end
   end
 
+  describe 'token helper methods' do
+    let(:api_client) { XeroRuby::ApiClient.new }
+    let(:id_token){'eyJhbGciOiJSUzI1NiIsImtpZCI6IjFDQUY4RTY2NzcyRDZEQzAyOEQ2NzI2RkQwMjYxNTgxNTcwRUZDMTkiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJISy1PWm5jdGJjQW8xbkp2MENZVmdWY09fQmsifQ.eyJuYmYiOjE2MTk3MTQwNDMsImV4cCI6MTYxOTcxNDM0MywiaXNzIjoiaHR0cHM6Ly9pZGVudGl0eS54ZXJvLmNvbSIsImF1ZCI6IkFEQjVBNzdEQTZCNjRFOTI4RDg0MDkwOTlBMzlDQTdCIiwiaWF0IjoxNjE5NzE0MDQzLCJhdF9oYXNoIjoiMXJNamVvUTJiOUxUNFU0ZlBXbEZJZyIsInNpZCI6ImY0YTY4ZDc0ZmM3OTQzMjc4YTgzMTg0NGM5ZWRmNzFiIiwic3ViIjoiZGI0ZjBmMzdiNTg1NTMwZTkxZjNiOWNiYjUwMzQwZTgiLCJhdXRoX3RpbWUiOjE2MTk3MTM5ODcsInhlcm9fdXNlcmlkIjoiZmFhODNlYzktZjZhNy00ODlmLTg5MTEtZTNmY2UwM2ExMTg2IiwiZ2xvYmFsX3Nlc3Npb25faWQiOiJmNGE2OGQ3NGZjNzk0MzI3OGE4MzE4NDRjOWVkZjcxYiIsInByZWZlcnJlZF91c2VybmFtZSI6ImNocmlzLmtuaWdodEB4ZXJvLmNvbSIsImVtYWlsIjoiY2hyaXMua25pZ2h0QHhlcm8uY29tIiwiZ2l2ZW5fbmFtZSI6IkNocmlzdG9waGVyIiwiZmFtaWx5X25hbWUiOiJLbmlnaHQifQ.hF04tCE1Qd-al355fQyCjWqTVWKnguor4RD1sC7rKH7zV3r3_nGwnGLMm2A96fov06fig0zusTX8onev0qFLZy-jlEXDp1f19LHhT15sBy0KH6dB0lGMrM14BnDuEP4NUGeP06nAPhQHHLw2oCc9hzYXorRVOSFDw43jgAC0vxRgDvJwgKgv6TDVEmpvwP0S4R7A0VbnFemHP_HY8gLHd7RpN7rrYmpJC4cofztdptDNLTF8Qup8qVlFdQgpJPQEQ95N1m6W-unvrh_dlO6AVMjXBjC1BJ10IGzoCCr8DSVyz2UMPnUT3oIYFVTlDc2K-ZJYkW86pigITMCdvR1hKg'}
+    let(:access_token){'eyJhbGciOiJSUzI1NiIsImtpZCI6IjFDQUY4RTY2NzcyRDZEQzAyOEQ2NzI2RkQwMjYxNTgxNTcwRUZDMTkiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJISy1PWm5jdGJjQW8xbkp2MENZVmdWY09fQmsifQ.eyJuYmYiOjE2MTk3MTQwNDMsImV4cCI6MTYxOTcxNTg0MywiaXNzIjoiaHR0cHM6Ly9pZGVudGl0eS54ZXJvLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWRlbnRpdHkueGVyby5jb20vcmVzb3VyY2VzIiwiY2xpZW50X2lkIjoiQURCNUE3N0RBNkI2NEU5MjhEODQwOTA5OUEzOUNBN0IiLCJzdWIiOiJkYjRmMGYzN2I1ODU1MzBlOTFmM2I5Y2JiNTAzNDBlOCIsImF1dGhfdGltZSI6MTYxOTcxMzk4NywieGVyb191c2VyaWQiOiJmYWE4M2VjOS1mNmE3LTQ4OWYtODkxMS1lM2ZjZTAzYTExODYiLCJnbG9iYWxfc2Vzc2lvbl9pZCI6ImY0YTY4ZDc0ZmM3OTQzMjc4YTgzMTg0NGM5ZWRmNzFiIiwianRpIjoiZmFmNGNkYzQ5MjM0YzhmZDE0OTA0ZjRlOWEyMWY4YmYiLCJhdXRoZW50aWNhdGlvbl9ldmVudF9pZCI6IjI0MmRjNWIyLTIwZTMtNGFjNS05NjU3LWExMGI5ZTI0ZGI1NSIsInNjb3BlIjpbImVtYWlsIiwicHJvZmlsZSIsIm9wZW5pZCIsImFjY291bnRpbmcucmVwb3J0cy5yZWFkIiwiZmlsZXMiLCJwYXlyb2xsLmVtcGxveWVlcyIsInBheXJvbGwucGF5cnVucyIsInBheXJvbGwucGF5c2xpcCIsInBheXJvbGwudGltZXNoZWV0cyIsInByb2plY3RzLnJlYWQiLCJwcm9qZWN0cyIsImFjY291bnRpbmcuc2V0dGluZ3MiLCJhY2NvdW50aW5nLmF0dGFjaG1lbnRzIiwiYWNjb3VudGluZy50cmFuc2FjdGlvbnMiLCJhY2NvdW50aW5nLmpvdXJuYWxzLnJlYWQiLCJhc3NldHMucmVhZCIsImFzc2V0cyIsImFjY291bnRpbmcuY29udGFjdHMiLCJwYXlyb2xsLnNldHRpbmdzIiwib2ZmbGluZV9hY2Nlc3MiXX0.vNV-YsgHFWKFBmyYdhg7tztdsPc9ykObadQcGFoFXJ8qCBerR3h7XXKzWAP3KzFzhOCcIpWU8Q081zuYBNxahPeeLRLUuc_3MwgwE72esE5vGuxa2_-_QidtNvMCgsX-ie_LcX7FE_KI-sXB_EZ8fDk6WAMIPC9d3GejgeuH5Uh6rZkhowN2jm5pZjEOEy_QE7PScBO0XEbiZNUsarvBUSdKuSTvVVLHzHzs0bHMRfgKEkqZySNtZlac-oyaL3PVba1S7A_vbRcNWpYR_VrKGf2g9LHSI3EA5j3Beto4pKukU-bk6rLBGul37u4tM17U-wyJLsFmt6ZC_SEJKgmluQ'}
+    let(:tkn_set) {{'id_token': id_token, 'access_token': access_token, 'refresh_token': 'abc123xyz'}}
+
+    before do
+      api_client.set_token_set(tkn_set)
+    end
+
+    it '#token_expired? for an expired token' do
+      expect(api_client.token_expired?).to eq(true)
+    end
+
+    it '#token_expired? for a just expired token' do
+      allow(api_client).to receive(:decoded_access_token).and_return({"exp"=>Time.now.to_i})
+      expect(api_client.token_expired?).to eq(true)
+    end
+
+    it '#token_expired? for a non-expired token' do
+      allow(api_client).to receive(:decoded_access_token).and_return({"exp"=>(Time.now + 30.minutes).to_i})
+      expect(api_client.token_expired?).to eq(false)
+    end
+
+    it '#token_expired? for an almost expired token' do
+      allow(api_client).to receive(:decoded_access_token).and_return({"exp"=>(Time.now + 30.seconds).to_i})
+      expect(api_client.token_expired?).to eq(false)
+    end
+
+    it '#validate_tokens' do
+      expect(api_client.validate_tokens(tkn_set)).to eq(true)
+    end
+    it '#access_token' do
+      expect(api_client.access_token).to eq(access_token)
+    end
+    it '#decoded_access_token' do
+      expect(api_client.decoded_access_token['aud']).to eq("https://identity.xero.com/resources")
+    end
+    it '#id_token' do
+      expect(api_client.id_token).to eq(tkn_set[:id_token])
+    end
+    it '#decoded_id_token' do
+      expect(api_client.decoded_id_token['email']).to eq('chris.knight@xero.com')
+    end
+
+    it 'decoding an invalid access_token' do
+      api_client.set_access_token("#{access_token}.NotAValidJWTstring")
+      expect{api_client.decoded_access_token}.to raise_error(JSON::JWT::InvalidFormat)
+    end
+
+    it 'decoding an invalid id_token' do
+      api_client.set_id_token("#{id_token}.NotAValidJWTstring")
+      expect{api_client.decoded_id_token}.to raise_error(JSON::JWT::InvalidFormat)
+    end
+  end
+
+
   describe 'thread safety in the XeroClient' do
     let(:creds) {{
       client_id: 'abc',
@@ -383,8 +458,8 @@ describe XeroRuby::ApiClient do
     let(:api_client_2) {XeroRuby::ApiClient.new(credentials: creds)}
     let(:api_client_3) {XeroRuby::ApiClient.new(credentials: creds)}
 
-    let(:tkn_set_1){{id_token: "abc.123.1", access_token: "xxx.yyy.zzz.111"}}
-    let(:tkn_set_2){{id_token: "efg.456.2", access_token: "xxx.yyy.zzz.222"}}
+    let(:tkn_set_1){{'id_token': "abc.123.1", 'access_token': "xxx.yyy.zzz.111"}}
+    let(:tkn_set_2){{'id_token': "efg.456.2", 'access_token': "xxx.yyy.zzz.222"}}
     
     describe 'when configuration is changed, other instantiations of the client are not affected' do
       it 'applies to #set_access_token' do
@@ -426,12 +501,12 @@ describe XeroRuby::ApiClient do
         expect(api_client_2.token_set).to eq(nil)
 
         api_client_1.set_token_set(tkn_set_1)
-        expect(api_client_1.token_set).to eq(tkn_set_1)
+        expect(api_client_1.token_set).to eq(tkn_set_1.with_indifferent_access)
         expect(api_client_2.token_set).to eq(nil)
 
         api_client_2.set_token_set(tkn_set_2)
-        expect(api_client_1.token_set).to eq(tkn_set_1)
-        expect(api_client_2.token_set).to eq(tkn_set_2)
+        expect(api_client_1.token_set).to eq(tkn_set_1.with_indifferent_access)
+        expect(api_client_2.token_set).to eq(tkn_set_2.with_indifferent_access)
       end
       
       it 'applies to #base_url' do

data/spec/helper_methods_spec.rb

@@ -59,6 +59,20 @@ describe 'shared helper methods' do
       )
     }
 
+    let(:contact_capitalized_with_nested_objects) {
+      XeroRuby::Accounting::Contact.new({
+        has_attachments: false,
+        has_validation_errors: false,
+        phones: [
+          XeroRuby::Accounting::Phone.new({
+            phone_type: "MOBILE",
+            phone_number: "555-1212",
+            phone_area_code: "415"
+          })
+        ]
+      })
+    }
+
     describe '#to_hash' do
       it 'can serialize invoice attributes into a PascalCase hash' do
         expect(invoice.to_hash).to eq(:CurrencyCode => "USD", :HasAttachments => false, :HasErrors => false, :InvoiceNumber => "abc-123", :TotalDiscount => 100, :Type => "ACCPAY")
@@ -77,6 +91,20 @@ describe 'shared helper methods' do
       it 'can serialize contact attributes into a snake_case hash' do
         expect(contact.to_attributes).to eq({account_number: "abc-123", contact_status: "ACTIVE", email_address: "email@gmail.com", first_name: 'Contact', has_attachments: false, has_validation_errors: false, last_name: "Name", name: "Contact Name"})
       end
+
+      it 'can serialize nested attributes into a snake_case hash' do
+        expect(contact_capitalized_with_nested_objects.to_attributes).to eq({
+          has_attachments: false,
+          has_validation_errors: false,
+          phones: [
+            {
+              phone_type: "MOBILE",
+              phone_number: "555-1212",
+              phone_area_code: "415"
+            }
+          ]
+        })
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xero-ruby
 version: !ruby/object:Gem::Version
-  version: 2.9.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Xero API Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2021-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -50,6 +50,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: json-jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +134,9 @@ files:
 - lib/xero-ruby/models/accounting/bill.rb
 - lib/xero-ruby/models/accounting/branding_theme.rb
 - lib/xero-ruby/models/accounting/branding_themes.rb
+- lib/xero-ruby/models/accounting/budget.rb
+- lib/xero-ruby/models/accounting/budget_lines.rb
+- lib/xero-ruby/models/accounting/budgets.rb
 - lib/xero-ruby/models/accounting/cis_org_setting.rb
 - lib/xero-ruby/models/accounting/cis_org_settings.rb
 - lib/xero-ruby/models/accounting/cis_setting.rb
@@ -960,7 +983,7 @@ homepage: https://developer.xero.com
 licenses:
 - Unlicense
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -975,8 +998,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Xero Accounting API Ruby Gem
 test_files: