xeroizer 2.19.0 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ca2b2dffb8f864a2f4c82295bbfddcdeea61c1b
-  data.tar.gz: 4b9f39d61e7027ba84df0d548826cccbc0695d08
+  metadata.gz: 7a2ed7ed5abbb823dc78470a4a50e31768592a42
+  data.tar.gz: 828b5d4e36a703a6f6944f3f183964cf59c19ed8
 SHA512:
-  metadata.gz: 1e27f5e7d6b66833b4ef226ce27c9fd67b26ba434eaa35b2ea750106db4ad6c334e566132d4779192b3ccfa964811657b9ef123b552d8a4a185be0d9f78c899d
-  data.tar.gz: 6ea509718550d68b1560507fc0204c19406df17924c44ba2ebcc2ac0f27d7652929b7fd9716b9a489e564f274304a3d4cb6e72556031186b7150c304aad5a7cc
+  metadata.gz: f66a004449f5e9570fed2098ebdb4deb1d55aa0c27e8b355e05bb79989d20171e849a45b33118d9ddbdde9908c20ece199e16b3eceff10188e7c71b0a2dc620e
+  data.tar.gz: 6a6a3316543a58ec13f448cbeead6ce143f02a6e8799f0eeb125801e2553da2acb1152cd12797906bf53aa33869ad892ddfdf8f312fbd365838f39e6ad06d787

data/README.md

@@ -1,13 +1,13 @@
 Xeroizer API Library ![Project status](http://stillmaintained.com/waynerobinson/xeroizer.png) [![Build Status](https://travis-ci.org/waynerobinson/xeroizer.svg)](https://travis-ci.org/waynerobinson/xeroizer)
 ====================
 
-**Homepage**: 		[http://waynerobinson.github.com/xeroizer](http://waynerobinson.github.com/xeroizer)		
-**Git**: 					[git://github.com/waynerobinson/xeroizer.git](git://github.com/waynerobinson/xeroizer.git)		
-**Github**: 			[https://github.com/waynerobinson/xeroizer](https://github.com/waynerobinson/xeroizer)		
-**Author**: 			Wayne Robinson [http://www.wayne-robinson.com](http://www.wayne-robinson.com)		
+**Homepage**: 		[http://waynerobinson.github.com/xeroizer](http://waynerobinson.github.com/xeroizer)
+**Git**: 					[git://github.com/waynerobinson/xeroizer.git](git://github.com/waynerobinson/xeroizer.git)
+**Github**: 			[https://github.com/waynerobinson/xeroizer](https://github.com/waynerobinson/xeroizer)
+**Author**: 			Wayne Robinson [http://www.wayne-robinson.com](http://www.wayne-robinson.com)
 **Contributors**: See Contributors section below
 **Copyright**:    2007-2013
-**License**:      MIT License		
+**License**:      MIT License
 
 Introduction
 ------------
@@ -69,7 +69,7 @@ client = Xeroizer::PublicApplication.new(YOUR_OAUTH_CONSUMER_KEY, YOUR_OAUTH_CON
 request_token = client.request_token(:oauth_callback => 'http://yourapp.com/oauth/callback')
 
 # 2. Redirect the user to the URL specified by the RequestToken.
-#    
+#
 #    Note: example uses redirect_to method defined in Rails controllers.
 redirect_to request_token.authorize_url
 
@@ -174,6 +174,16 @@ client = Xeroizer::PrivateApplication.new(YOUR_OAUTH_CONSUMER_KEY, YOUR_OAUTH_CO
 contacts = client.Contact.all
 ```
 
+To provide a private key directly, set the path to nil and pass in a `private_key` option instead. For example:
+
+```ruby
+# Using environment variables (e.g. Heroku):
+client = Xeroizer::PrivateApplication.new(key, secret, nil, private_key: ENV["XERO_PRIVATE_KEY"])
+
+# Using Rails Credentials (Rails 5.2+):
+client = Xeroizer::PrivateApplication.new(key, secret, nil, private_key: Rails.application.credentials.xero_private_key)
+```
+
 ### Partner Applications
 
 Partner applications use a combination of 3-legged authorisation and private key message signing.
@@ -200,7 +210,7 @@ client = Xeroizer::PartnerApplication.new(
 request_token = client.request_token(:oauth_callback => 'http://yourapp.com/oauth/callback')
 
 # 2. Redirect the user to the URL specified by the RequestToken.
-#    
+#
 #    Note: example uses redirect_to method defined in Rails controllers.
 redirect_to request_token.authorize_url
 
@@ -224,8 +234,8 @@ access_secret = client.access_token.secret
 
 Two other interesting attributes of the PartnerApplication client are:
 
-> **`#expires_at`**:								Time this AccessToken will expire (usually 30 minutes into the future).		
-> **`#authorization_expires_at`**:	How long this organisation has authorised you to access their data (usually 10 years into the future).		
+> **`#expires_at`**:								Time this AccessToken will expire (usually 30 minutes into the future).
+> **`#authorization_expires_at`**:	How long this organisation has authorised you to access their data (usually 10 years into the future).
 
 #### AccessToken Renewal
 
@@ -586,6 +596,8 @@ Reports are accessed like the following example:
 ```ruby
 trial_balance = xero.TrialBalance.get(:date => DateTime.new(2011,3,21))
 
+profit_and_loss = xero.ProfitAndLoss.get(fromDate: Date.new(2019,4,1), toDate: Date.new(2019,5,1))
+
 # Array containing report headings.
 trial_balance.header.cells.map { | cell | cell.value }
 
@@ -653,7 +665,7 @@ If required, the library can handle these exceptions internally by sleeping 1 se
 You can set this option when initializing an application:
 
 ```ruby
-# Sleep for 2 seconds every time the rate limit is exceeded.
+# Sleep for 1 second and retry up to 3 times when Xero claims the nonce was used.
 client = Xeroizer::PublicApplication.new(YOUR_OAUTH_CONSUMER_KEY,
                                          YOUR_OAUTH_CONSUMER_SECRET,
                                          :nonce_used_max_attempts => 3)

data/lib/xeroizer.rb

@@ -33,6 +33,7 @@ require 'xeroizer/models/allocation'
 require 'xeroizer/models/branding_theme'
 require 'xeroizer/models/bank_transaction'
 require 'xeroizer/models/bank_account'
+require 'xeroizer/models/batch_payment'
 require 'xeroizer/models/from_bank_account'
 require 'xeroizer/models/to_bank_account'
 require 'xeroizer/models/bank_transfer'

data/lib/xeroizer/generic_application.rb

@@ -15,8 +15,9 @@ module Xeroizer
     record :Account
     record :Allocation
     record :Attachment
-    record :BrandingTheme
     record :Balances
+    record :BatchPayment
+    record :BrandingTheme
     record :Contact
     record :ContactGroup
     record :CreditNote

data/lib/xeroizer/models/batch_payment.rb

@@ -0,0 +1,24 @@
+module Xeroizer
+  module Record
+
+    class BatchPaymentModel < BaseModel
+      set_permissions :read
+    end
+
+    class BatchPayment < Base
+      guid    :batch_payment_id
+      string  :reference
+      string  :details
+      date    :date
+      string  :type
+      string  :status
+      decimal :total_amount
+      boolean :is_reconciled
+
+      datetime_utc :updated_date_utc, :api_name => 'UpdatedDateUTC'
+
+      belongs_to :account
+      has_many   :payments
+    end
+  end
+end

data/lib/xeroizer/models/contact_group.rb

@@ -11,8 +11,53 @@ module Xeroizer
       string :name
       string :status
 
+      set_primary_key :contact_group_id
+      list_contains_summary_only true
       has_many :contacts, :list_complete => true
 
+      # Adding Contact uses different API endpoint
+      # https://developer.xero.com/documentation/api/contactgroups#PUT
+      def add_contact(contact)
+        @contacts ||= []
+        @contacts <<  contact
+      end
+
+      def delete
+        status = 'DELETED'
+      end
+
+      def name=(value)
+        @modified = true unless @attributes[:name].nil? or @attributes[:name] == value
+        @attributes[:name] = value
+      end
+
+      def status=(value)
+        @modified = true unless @attributes[:status].nil? or @attributes[:status] == value
+        @attributes[:status] = value
+      end
+
+      def save!
+        super if new_record? or @modified
+        @modified = false
+        if @contacts
+          req = cg_xml
+          app = parent.application
+          res = app.http_put(app.client, "#{parent.url}/#{CGI.escape(id)}/Contacts", req)
+          parse_save_response(res)
+        end
+      end
+
+      def cg_xml
+        b = Builder::XmlMarkup.new(:indent => 2)
+        b.tag!('Contacts') do
+          @contacts.each do |c|
+            b.tag!('Contact') do
+              b.tag!('ContactID', c.id)
+            end
+          end
+        end
+      end
+
     end
 
   end

data/lib/xeroizer/models/line_item.rb

@@ -19,6 +19,7 @@ module Xeroizer
       decimal :tax_amount
       decimal :line_amount, :calculated => true
       decimal :discount_rate
+      decimal :discount_amount
       string  :line_item_id
 
       has_many  :tracking, :model_name => 'TrackingCategoryChild'
@@ -40,8 +41,10 @@ module Xeroizer
 
         if quantity && unit_amount
           total = coerce_numeric(quantity) * coerce_numeric(unit_amount)
-          if discount_rate
+          if discount_rate.nonzero?
             BigDecimal((total * ((100 - discount_rate) / 100)).to_s).round(2)
+          elsif discount_amount
+            BigDecimal((total - discount_amount).to_s).round(2)
           else
             BigDecimal(total.to_s).round(2)
           end

data/lib/xeroizer/report/cell_xml_helper.rb

@@ -1,19 +1,19 @@
 module Xeroizer
   module Report
     module CellXmlHelper
-    
+
       def self.included(base)
         base.extend(ClassMethods)
         base.send :include, InstanceMethods
       end
-    
+
       module ClassMethods
-      
+
         public
-      
+
           # Create an instance of Cell from the node.
           #
-          # Additionally, parse the attributes and return them as a hash to the 
+          # Additionally, parse the attributes and return them as a hash to the
           # cell. If a cell's attributes look like:
           #
           #     <Attributes>
@@ -22,7 +22,7 @@ module Xeroizer
           #         <Id>account</Id>
           #       </Attribute>
           #     </Attributes>
-          # 
+          #
           # Return a hash like:
           #
           #     {
@@ -42,17 +42,17 @@ module Xeroizer
             end
             cell
           end
-          
+
         protected
 
           def parse_value(value)
             case value
-              when /^[-]?\d+(\.\d+)?$/                      then BigDecimal(value)
-              when /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$/  then Time.xmlschema(value)
-              else                                          value
+              when /\A[-]?\d+(\.\d+)?\z/                      then BigDecimal(value)
+              when /\A\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\z/  then Time.xmlschema(value)
+              else                                            value
             end
           end
-        
+
           def parse_attribute(attribute_node)
             id = nil
             value = nil
@@ -65,10 +65,10 @@ module Xeroizer
             [id, value]
           end
       end
-    
+
       module InstanceMethods
       end
-    
+
     end
   end
 end

data/lib/xeroizer/version.rb

@@ -1,3 +1,3 @@
 module Xeroizer
-  VERSION = "2.19.0".freeze
+  VERSION = "2.20.0".freeze
 end

data/test/unit/models/line_item_test.rb

@@ -26,7 +26,7 @@ class LineItemTest < Test::Unit::TestCase
     line_item.unit_amount = BigDecimal("1337.00")
 
     assert_equal "1337.0", line_item.line_amount.to_s,
-      "expected line_amount to equal unit_amount times quantity"
+                 "expected line_amount to equal unit_amount times quantity"
   end
 
   it "line_amount equals unit_amount times quantity minus the discount if there is a discount_rate" do
@@ -36,44 +36,17 @@ class LineItemTest < Test::Unit::TestCase
     line_item.discount_rate = BigDecimal("12.34")
 
     assert_equal "1172.01", line_item.line_amount.to_s,
-      "expected line_amount to equal unit_amount times quantity minus the discount"
+                 "expected line_amount to equal unit_amount times quantity minus the discount"
   end
 
-  it "line_amount is zero when quantity is nil or zero" do
+  it "line_amount equals unit_amount times quantity minus the discount if there is a discount_amount" do
     line_item = LineItem.new(nil)
-
-    line_item.quantity = nil
-    line_item.unit_amount = BigDecimal("1.00")
-
-    assert_equal "0.0", line_item.line_amount.to_s,
-      "expected line amount to be zero when quantity is nil"
-
-    line_item.quantity = 0
-    assert_equal "0.0", line_item.line_amount.to_s,
-      "expected line amount to be zero when quantity is zero"
-  end
-
-  it "is not possible to set unit_amount to zero" do
-    line_item = LineItem.new(nil)
-
-    line_item.unit_amount = nil
-
-    assert_equal 0.0, line_item.unit_amount,
-      "Expected setting unit_amount to nil to be ignored, i.e., it should remain zero"
-  end
-
-  it "line_amount is zero when unit_amount is nil or zero" do
-    line_item = LineItem.new(nil)
-
     line_item.quantity = 1
-    line_item.unit_amount = nil
-
-    assert_equal "0.0", line_item.line_amount.to_s,
-      "expected line amount to be zero when unit_amount is nil"
+    line_item.unit_amount = BigDecimal("1337.00")
+    line_item.discount_amount = BigDecimal("164.99")
 
-    line_item.unit_amount = BigDecimal("0.00")
-    assert_equal "0.0", line_item.line_amount.to_s,
-      "expected line amount to be zero when unit_amount is zero"
+    assert_equal "1172.01", line_item.line_amount.to_s,
+                 "expected line_amount to equal unit_amount times quantity minus the discount amount"
   end
 
   it "coerces decimals when calculating line amount" do
@@ -81,6 +54,6 @@ class LineItemTest < Test::Unit::TestCase
     line_item.quantity = "1"
     line_item.unit_amount = 50
     assert_equal 50, line_item.line_amount,
-      "expected line amount to be calculated from coerced values"
+                 "expected line amount to be calculated from coerced values"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xeroizer
 version: !ruby/object:Gem::Version
-  version: 2.19.0
+  version: 2.20.0
 platform: ruby
 authors:
 - Wayne Robinson
@@ -251,6 +251,7 @@ files:
 - lib/xeroizer/models/bank_account.rb
 - lib/xeroizer/models/bank_transaction.rb
 - lib/xeroizer/models/bank_transfer.rb
+- lib/xeroizer/models/batch_payment.rb
 - lib/xeroizer/models/batch_payments.rb
 - lib/xeroizer/models/bills.rb
 - lib/xeroizer/models/branding_theme.rb