xero-ruby 2.6.2 → 2.7.0

data/lib/xero-ruby/version.rb

@@ -1,5 +1,5 @@
 =begin
-#Accounting API
+#Xero Accounting API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
@@ -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.8.3
+The version of the XeroOpenAPI document: 2.9.3
 =end
 
 module XeroRuby
-  VERSION = '2.6.2'
+  VERSION = '2.7.0'
 end

data/lib/xero-ruby/where.rb

@@ -0,0 +1,65 @@
+module XeroRuby
+  class Where
+    include StringSerialization
+
+    UUID_REGEXP = /\A[0-9a-f]{8}\b-[0-9a-f]{4}\b-[0-9a-f]{4}\b-[0-9a-f]{4}\b-[0-9a-f]{12}\Z/i
+    STRING_FUNCTIONS = %w(Contains StartsWith EndsWith)
+
+    attr_reader :where_opts
+
+    def initialize(where_opts)
+      @where_opts = where_opts
+    end
+
+    def to_param
+      where_opts.map { |key, value| parameterize_option(key, value) }.join(' AND ')
+    end
+
+    private
+
+    def parameterize_option(key, value)
+      quoted_key = quote_key(key)
+
+      case value
+      when Array
+        operator, query = value
+
+        if STRING_FUNCTIONS.include?(camelize_key(operator))
+          "#{quoted_key}.#{camelize_key(operator)}(#{quote_value(query)})"
+        else
+        "#{quoted_key} #{operator} #{quote_value(query)}"
+        end
+      when Range
+        "#{quoted_key} >= #{quote_value(value.first)} AND #{quoted_key} <= #{quote_value(value.last)}"
+      when /^\./
+        "#{quoted_key}#{value}"
+      else
+        "#{quoted_key} #{value}"
+      end
+    end
+
+    def quote_key(key)
+      case key
+      when :contact_id
+        'Contact.ContactID'
+      when :contact_number
+        'Contact.ContactNumber'
+      else
+        camelize_key(key)
+      end
+    end
+
+    def quote_value(value)
+      case value
+      when DateTime, Date, Time
+        "DateTime(#{value.strftime("%Y,%m,%d")})"
+      when Numeric, false, true
+        value.to_s
+      when UUID_REGEXP
+        %{guid("#{value}")}
+      else
+        %{"#{value.to_s.gsub('"', '""')}"}
+      end
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -6,7 +6,7 @@ describe XeroRuby::Configuration do
   describe 'urls' do
     it 'should have the default value' do
       expect(config.login_url).to eq('https://login.xero.com/identity/connect/authorize')
-      expect(config.token_url).to eq('https://identity.xero.com/connect/token')
+      expect(config.token_url).to eq('https://identity.xero.com/connect')
       expect(config.accounting_url).to eq('https://api.xero.com/api.xro/2.0')
       expect(config.asset_url).to eq('https://api.xero.com/assets.xro/1.0')
       expect(config.project_url).to eq('https://api.xero.com/projects.xro/2.0/')

data/spec/where_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe XeroRuby::Where do
+  let(:query) { described_class.new(opts) }
+
+  subject { query.to_param }
+
+  describe "arrays" do
+    describe "a simple equality test" do
+      let(:opts) { { test_field: ['=', 'test'] } }
+
+      it { is_expected.to eq %{TestField = "test"} }
+    end
+
+    describe "a test with a date" do
+      let(:opts) { { test: ['=', Date.parse('2020-02-01')] } }
+
+      it { is_expected.to eq %{Test = DateTime(2020,02,01)} }
+    end
+
+    describe "multiple options" do
+      let(:opts) { { a: ['=', 1], b: ['=', 2] } }
+
+      it { is_expected.to eq %{A = 1 AND B = 2} }
+    end
+
+    describe "special keys" do
+      let(:opts) { { contact_id: 3, contact_number: 4 } }
+
+      it { is_expected.to eq %{Contact.ContactID 3 AND Contact.ContactNumber 4} }
+    end
+
+    describe "string functions" do
+      let(:opts) { { name: ['Contains', 'ero'] } }
+
+      it { is_expected.to eq %{Name.Contains("ero")} }
+    end
+
+    describe "special characters in the search string" do
+      let(:opts) { { a: ['=', 'quote"quote'] } }
+
+      it { is_expected.to eq %{A = "quote""quote"} }
+    end
+
+    describe "numbers" do
+      let(:opts) { { a: ['=', 10], b: ['=', 20.5] } }
+
+      it { is_expected.to eq %{A = 10 AND B = 20.5} }
+    end
+
+    describe "booleans" do
+      let(:opts) { { a: ['=', false], b: ['=', true] } }
+
+      it { is_expected.to eq %{A = false AND B = true} }
+    end
+
+    describe "UUIDs" do
+      let (:opts) { { a: ['=', '62c54cf8-eb9a-450e-8ca2-bb1fa9237940'] } }
+
+      it { is_expected.to eq %{A = guid("62c54cf8-eb9a-450e-8ca2-bb1fa9237940")} }
+    end
+  end
+
+  describe "ranges" do
+    let(:range) { Date.parse('2020-02-01')..Date.parse('2020-02-15') }
+    let(:opts) { { a: range } }
+
+    it { is_expected.to eq %{A >= DateTime(2020,02,01) AND A <= DateTime(2020,02,15)} }
+  end
+
+  describe "operators starting with a dot" do
+    let(:opts) { {a: '.Test("Hello")' } }
+
+    it { is_expected.to eq %{A.Test("Hello")} }
+  end
+
+  describe "unmatched operators" do
+    let(:opts) { {a: 'something unusual'} }
+
+    it { is_expected.to eq %{A something unusual} }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xero-ruby
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 2.7.0
 platform: ruby
 authors:
 - Xero API Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -115,6 +115,7 @@ files:
 - lib/xero-ruby/models/accounting/branding_theme.rb
 - lib/xero-ruby/models/accounting/branding_themes.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
 - lib/xero-ruby/models/accounting/cis_settings.rb
 - lib/xero-ruby/models/accounting/contact.rb
@@ -228,7 +229,6 @@ files:
 - lib/xero-ruby/models/assets/setting.rb
 - lib/xero-ruby/models/files/association.rb
 - lib/xero-ruby/models/files/file_object.rb
-- lib/xero-ruby/models/files/file_response204.rb
 - lib/xero-ruby/models/files/files.rb
 - lib/xero-ruby/models/files/folder.rb
 - lib/xero-ruby/models/files/folders.rb
@@ -521,7 +521,9 @@ files:
 - lib/xero-ruby/models/projects/time_entries.rb
 - lib/xero-ruby/models/projects/time_entry.rb
 - lib/xero-ruby/models/projects/time_entry_create_or_update.rb
+- lib/xero-ruby/string_serialization.rb
 - lib/xero-ruby/version.rb
+- lib/xero-ruby/where.rb
 - spec/accounting/api/accounting_api_spec.rb
 - spec/accounting/models/account_spec.rb
 - spec/accounting/models/account_type_spec.rb
@@ -656,7 +658,6 @@ files:
 - spec/files/api/files_api_spec.rb
 - spec/files/models/association_spec.rb
 - spec/files/models/file_object_spec.rb
-- spec/files/models/file_response204_spec.rb
 - spec/files/models/files_spec.rb
 - spec/files/models/folder_spec.rb
 - spec/files/models/folders_spec.rb
@@ -954,6 +955,7 @@ files:
 - spec/projects/models/time_entry_create_or_update_spec.rb
 - spec/projects/models/time_entry_spec.rb
 - spec/spec_helper.rb
+- spec/where_spec.rb
 homepage: https://developer.xero.com
 licenses:
 - Unlicense
@@ -976,7 +978,7 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Accounting API Ruby Gem
+summary: Xero Accounting API Ruby Gem
 test_files:
 - spec/accounting/models/bank_transfer_spec.rb
 - spec/accounting/models/error_spec.rb
@@ -1114,7 +1116,6 @@ test_files:
 - spec/files/models/object_group_spec.rb
 - spec/files/models/folder_spec.rb
 - spec/files/models/files_spec.rb
-- spec/files/models/file_response204_spec.rb
 - spec/files/models/inline_object_spec.rb
 - spec/files/models/object_type_spec.rb
 - spec/files/models/association_spec.rb
@@ -1410,3 +1411,4 @@ test_files:
 - spec/projects/models/task_create_or_update_spec.rb
 - spec/projects/api/project_api_spec.rb
 - spec/spec_helper.rb
+- spec/where_spec.rb

data/spec/files/models/file_response204_spec.rb

@@ -1,41 +0,0 @@
-=begin
-#Xero Files API
-
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-
-The version of the OpenAPI document: 2.3.7
-Contact: api@xero.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
-
-=end
-
-require 'spec_helper'
-require 'json'
-require 'date'
-
-# Unit tests for XeroRuby::Files::FileResponse204
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'FileResponse204' do
-  before do
-    # run before each test
-    @instance = XeroRuby::Files::FileResponse204.new
-  end
-
-  after do
-    # run after each test
-  end
-
-  describe 'test an instance of FileResponse204' do
-    it 'should create an instance of FileResponse204' do
-      expect(@instance).to be_instance_of(XeroRuby::Files::FileResponse204)
-    end
-  end
-  describe 'test attribute "status"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-end