xero-ruby 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c469455936635d16067b4269ad96bda3ae65b7d8f9a34399532b380a7f34d72b
-  data.tar.gz: '039093400b943441b6f987a279cc981c23052e6575047f301ba9527192b26d34'
+  metadata.gz: 333abb6f3c4cb576451f3fa4f47be4843502e06acb09be2a918ec2f2f313b4c2
+  data.tar.gz: adba7b3e9fac9cd66ea70935598c08fcc3506221fb27219200686d9630a2b3ce
 SHA512:
-  metadata.gz: bcc87f93d7203239d688b12e4d0f7496953fb1563cd4d3865384f3d9a51342d18b44029c8c2af4670d55e71c27e0561df1c4e24d05bea7afd64da1ac679d0610
-  data.tar.gz: 9362cfe1d6822dc0caedad0213ec31c35172503bf8da0af3c145e80c5794dbed5122fc739d02ed7ce4234db8d9e159d7458cea082efe42152a31be4106a7b377
+  metadata.gz: 4a07d78ad0a2f8c3be6f2ee677342a85dfc862b075095820cc193a572329218ad0bc055d0a1d2fe9484e7cf208056dfd55040b2f1b6dd6b6600589caee3253d5
+  data.tar.gz: a7578f993ff86feaa3ef0d221188a64210f5b8ceec35e0fbdb7749424532c8f83a49cfdb9f76cb5b0e832f5d526b9b063a1413743752632906a7f89e332e154a

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    xero-ruby (0.4.1)
-      faraday (~> 0.14, >= 0.14.0)
+    xero-ruby (2.0.1)
+      faraday (~> 1.0.1, >= 1.0.1)
       json (~> 2.1, >= 2.1.0)
 
 GEM
@@ -12,10 +12,10 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.3)
-    faraday (0.17.3)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     jaro_winkler (1.5.4)
-    json (2.3.0)
+    json (2.3.1)
     method_source (1.0.0)
     multipart-post (2.1.1)
     parallel (1.19.1)
@@ -60,7 +60,7 @@ PLATFORMS
 DEPENDENCIES
   pry-byebug
   rake (~> 12.3.3)
-  rspec
+  rspec (~> 3.6, >= 3.6.0)
   rubocop (~> 0.66.0)
   xero-ruby!
 

data/README.md

@@ -129,7 +129,7 @@ Here is the basic workflow of using SDK once you have a valid `access_token` (an
   # reference `Authorization & Callback` to first store a valid token_set on the `xero_client`
   xero_client.refresh_token_set(user.token_set)
 
-  # Accounting API set (https://github.com/XeroAPI/xero-ruby/blob/master/accounting/lib/xero-ruby/api/accounting_api.rb)
+  # Using the Accounting API set (https://github.com/XeroAPI/xero-ruby/blob/master/accounting/lib/xero-ruby/api/accounting_api.rb)
 
   # Examples
   invoices = xero_client.accounting_api.get_invoices(user.active_tenant_id).invoices
@@ -140,10 +140,25 @@ Here is the basic workflow of using SDK once you have a valid `access_token` (an
   invoices = { invoices: [{ type: XeroRuby::Accounting::Invoice::ACCREC, contact: { contact_id: contacts[0].contact_id }, line_items: [{ description: "Acme Tires", quantity: BigDecimal("2.0"), unit_amount: BigDecimal("20.99"), account_code: "600", tax_type: XeroRuby::Accounting::TaxType::NONE }], date: "2019-03-11", due_date: "2018-12-10", reference: "Website Design", status: XeroRuby::Accounting::Invoice::DRAFT }]}
   invoice = xero_client.accounting_api.create_invoices(current_user.active_tenant_id, invoices).invoices.first
 
+  # all money and fields requiring advanced precision utilize BigDecimal
+  puts invoice.unit_amount
+  => 0.2099e2
+  
+  puts invoice.unit_amount.class 
+  => BigDecimal
+
+  puts invoice.unit_amount.to_s("F")
+  => "20.99"
+
+  # or if using Rails https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_to_currency
+  number_to_currency(invoice.unit_amount, :unit => "$")
+
+  # creating an object History record
   payment = xero_client.accounting_api.get_payments(current_user.active_tenant_id).payments.first
   history_records = { history_records:[ { details: "This payment now has some History #{rand(10000)}" } ]}
   payment_history = xero_client.accounting_api.create_payment_history(user.active_tenant_id, payment.payment_id, history_records)
 
+  # creating an object Attachment record
   account = xero_client.accounting_api.get_accounts(current_user.active_tenant_id).accounts.first
   file_name = "an-account-filename.png"
   opts = {
@@ -152,7 +167,7 @@ Here is the basic workflow of using SDK once you have a valid `access_token` (an
   file = File.read(Rails.root.join('app/assets/images/xero-api.png'))
   attachment = xero_client.accounting_api.create_account_attachment_by_file_name(current_user.active_tenant_id, @account.account_id, file_name, file, opts)
 
-  # Asset API set (https://github.com/XeroAPI/xero-ruby/blob/master/accounting/lib/xero-ruby/api/asset_api.rb)
+  # Using the Asset API set (https://github.com/XeroAPI/xero-ruby/blob/master/accounting/lib/xero-ruby/api/asset_api.rb)
   asset = {
     "assetName": "AssetName: #{rand(10000)}",
     "assetNumber": "Asset: #{rand(10000)}",
@@ -160,7 +175,7 @@ Here is the basic workflow of using SDK once you have a valid `access_token` (an
   }
   asset = xero_client.asset_api.create_asset(current_user.active_tenant_id, asset)
 
-  # Project API set (https://github.com/XeroAPI/xero-ruby/blob/master/docs/projects/ProjectApi.md)
+  # Using the Project API set (https://github.com/XeroAPI/xero-ruby/blob/master/docs/projects/ProjectApi.md)
   projects = xero_client.project_api.get_projects(current_user.active_tenant_id).items
 ```
 

data/build_notes.md

@@ -9,9 +9,14 @@ mv xero-ruby-<vsn>.gem xero-ruby.gem
 > xero-ruby-oauth2-app
 
 Replace gem file with local path:
-`gem 'xero-ruby', path: '/Users/chris.knight/code/sdks/xero-ruby/'`
 ```bash
+gem 'xero-ruby', path: '/Users/chris.knight/code/sdks/xero-ruby/'
 bundle install
 ```
 
-Deploying to Rubygems
+Deploying to Rubygems
+
+```bash
+gem build
+gem push xero-ruby-<vsn>.gem 
+```

data/lib/xero-ruby/api_client.rb

@@ -500,30 +500,35 @@ module XeroRuby
       elsif key.is_a? String
         camelize(key, first_upper)
       else
-        key # Awrence can't camelize anything except strings and symbols
+        key # can't camelize anything except strings and symbols
       end
     end
 
-    def camelize(snake_word, first_upper = true)
+    def camelize(word, first_upper = true)
       if first_upper
-        str = snake_word.to_s
+        str = word.to_s
         str = gsubbed(str, /(?:^|_)([^_\s]+)/)
         str = gsubbed(str, %r{/([^/]*)}, "::")
         str
       else
-        parts = snake_word.split("_", 2)
+        parts = word.split("_", 2)
         parts[0] << camelize(parts[1]) if parts.size > 1
         parts[0] || ""
       end
     end
 
     def gsubbed(str, pattern, extra = "")
-      key_map_scronyms = { "id" => "ID" }
+      key_map_scronyms = { "id": "ID" }
       str = str.gsub(pattern) do
-        extra + (key_map_scronyms[Regexp.last_match(1)] || Regexp.last_match(1).capitalize)
+        extra + (key_map_scronyms[Regexp.last_match(1)] || capitalize_first(Regexp.last_match(1)))
       end
       str
     end
+
+    def capitalize_first(word)
+      split = word.split('')
+      "#{split[0].capitalize}#{split[1..-1].join}"
+    end
     # END - Re-serializes snake_cased params to PascalCase required by XeroAPI
 
     # Build parameter value according to the given collection format.

data/lib/xero-ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module XeroRuby
-  VERSION = '2.0.0'
+  VERSION = '2.0.2'
 end

data/spec/api_client_spec.rb

@@ -81,14 +81,103 @@ describe XeroRuby::ApiClient do
   end
 
   describe "#object_to_hash modifies a hash from snake_case to PascalCase" do
-    it 'Maniuplates a contact object correctly' do
+    contact_after = {:Contacts=>[{:Name=>"Bruce Banner", :EmailAddress=>"hulk@avengers.com", :Phones=>[{:PhoneType=>"MOBILE", :PhoneNumber=>"555-1212", :PhoneAreaCode=>"415"}], :PaymentTerms=>{:Bills=>{:Day=>15, :Type=>"OFCURRENTMONTH"}, :Sales=>{:Day=>10, :Type=>"DAYSAFTERBILLMONTH"}}}]}
+
+    it 'Serializes snake_case object correctly' do
       contact_before = {:contacts=>[{:name=>"Bruce Banner", :email_address=>"hulk@avengers.com", :phones=>[{:phone_type=>"MOBILE", :phone_number=>"555-1212", :phone_area_code=>"415"}], :payment_terms=>{:bills=>{:day=>15, :type=>"OFCURRENTMONTH"}, :sales=>{:day=>10, :type=>"DAYSAFTERBILLMONTH"}}}]}
-      contact_after = {:Contacts=>[{:Name=>"Bruce Banner", :EmailAddress=>"hulk@avengers.com", :Phones=>[{:PhoneType=>"MOBILE", :PhoneNumber=>"555-1212", :PhoneAreaCode=>"415"}], :PaymentTerms=>{:Bills=>{:Day=>15, :Type=>"OFCURRENTMONTH"}, :Sales=>{:Day=>10, :Type=>"DAYSAFTERBILLMONTH"}}}]}
       api_client = XeroRuby::ApiClient.new
       expect(api_client.object_to_hash(contact_before)).to eq(contact_after)
     end
 
-    # todo - insert every model PascalCase conversion as they are added as sample app examples
+    it 'Serializes camelCase object correctly' do
+      json_before = {
+        type: "ACCREC",
+        invoiceNumber: "INV-01",
+        dueDate: "2020-01-01",
+        lineItems: [
+          { quantity: 1.0, unitAmount: 20 }
+        ]
+      }
+      json_after = {
+        Type: "ACCREC",
+        InvoiceNumber: "INV-01",
+        DueDate: "2020-01-01",
+        LineItems: [
+          { Quantity: 1.0, UnitAmount: 20 }
+        ]
+      }
+      api_client = XeroRuby::ApiClient.new
+      expect(api_client.object_to_hash(json_before)).to eq(json_after)
+    end
+
+    it 'Serializes json with multiple nested objects correctly' do
+      json_before = {
+        "line_Items":[
+          {
+            "quantity":1.0,
+            "unit_amount":20,
+            "sub_Items":[
+              {
+                "quantity":1.0,
+                "unit_amount":20
+              },
+              {
+                "quantity":1.0,
+                "Unit_amount":20,
+                "Deep_Items":[
+                  {
+                    "quantity":1.0,
+                    "unit_amount":20
+                  },
+                  {
+                    "quantity":1.0,
+                    "unit_Amount":20
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+       
+      json_after = {
+        "LineItems":[
+          {
+            "UnitAmount":20,
+            "Quantity":1.0,
+            "SubItems":[
+              {
+                "UnitAmount":20,
+                "Quantity":1.0
+              },
+              {
+                "UnitAmount":20,
+                "Quantity":1.0,
+                "DeepItems":[
+                  {
+                    "UnitAmount":20,
+                    "Quantity":1.0
+                  },
+                  {
+                    "UnitAmount":20,
+                    "Quantity":1.0
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+      api_client = XeroRuby::ApiClient.new
+      expect(api_client.object_to_hash(json_before)).to eq(json_after)
+    end
+
+    it 'Serializes mixed cased keys correctly' do
+      contact_after = { :Contacts=>[{:Name=>"Bruce Banner", :EmailAddress=>"hulk@avengers.com", :Phones=>[{:PhoneType=>"MOBILE", :PhoneNumber=>"555-1212", :PhoneAreaCode=>"415"}], :PaymentTerms=>{:Bills=>{:Day=>15, :Type=>"OFCURRENTMONTH"}, :Sales=>{:Day=>10, :Type=>"DAYSAFTERBILLMONTH"}}}]}
+      contact_before = {:contacts=>[{:name=>"Bruce Banner", :emailAddress=>"hulk@avengers.com", :phones=>[{:phoneType=>"MOBILE", :phone_number=>"555-1212", :phone_areaCode=>"415"}], :Payment_terms=>{:bills=>{:day=>15, :type=>"OFCURRENTMONTH"}, :sales=>{:day=>10, :type=>"DAYSAFTERBILLMONTH"}}}]}
+      api_client = XeroRuby::ApiClient.new
+      expect(api_client.object_to_hash(contact_before)).to eq(contact_after)
+    end
   end
 
   describe '#build_collection_param' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xero-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Xero API Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday