Merge pull request #149 from XeroAPI/issue_patches_april

fix opts mutation, fixes configuration passing, and add docs / specs

Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    xero-ruby (2.4.1)
-      faraday (~> 1.0.1, >= 1.0.1)
+    xero-ruby (2.9.0)
+      faraday (~> 1.0, >= 1.0.1)
       json (~> 2.1, >= 2.1.0)
 
 GEM
@@ -12,10 +12,13 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    faraday (1.0.1)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
     jaro_winkler (1.5.4)
-    json (2.4.1)
+    json (2.5.1)
     method_source (1.0.0)
     multipart-post (2.1.1)
     parallel (1.20.1)
@@ -52,6 +55,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.4)
     unicode-display_width (1.5.0)
 
 PLATFORMS

README.md

@@ -58,6 +58,12 @@ creds = {
 xero_client ||= XeroRuby::ApiClient.new(credentials: creds)
 ```
 
+If you want additional logging or timeout, you can add/override any configuration option by passing the optional named parameter object `config`.
+```ruby
+config = { timeout: 30, debugging: true }
+@xero_client ||= XeroRuby::ApiClient.new(credentials: creds, config: config)
+```
+
 ## User Authorization & Callback
 All API requests require a valid access token to be set on the client.
 

docs/accounting/index.html

@@ -5819,7 +5819,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>2.8.2</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>2.9.0</li>
               <li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
               <li data-group="Accounting" data-name="createAccount" class="">
                 <a href="#api-Accounting-createAccount">createAccount</a>

docs/assets/index.html

@@ -1389,7 +1389,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>2.8.2</li>
+              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>2.9.0</li>
               <li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
               <li data-group="Asset" data-name="createAsset" class="">
                 <a href="#api-Asset-createAsset">createAsset</a>

docs/files/index.html

@@ -1153,7 +1153,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Files"><strong>VSN: </strong>2.8.2</li>
+              <li class="nav-header" data-group="Files"><strong>VSN: </strong>2.9.0</li>
               <li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
               <li data-group="Files" data-name="createFileAssociation" class="">
                 <a href="#api-Files-createFileAssociation">createFileAssociation</a>

docs/payroll_au/index.html

@@ -3231,7 +3231,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>2.8.2</li>
+              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>2.9.0</li>
               <li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
               <li data-group="PayrollAu" data-name="createEmployee" class="">
                 <a href="#api-PayrollAu-createEmployee">createEmployee</a>

docs/payroll_nz/index.html

@@ -3836,7 +3836,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>2.8.2</li>
+              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>2.9.0</li>
               <li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
               <li data-group="PayrollNz" data-name="approveTimesheet" class="">
                 <a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>

docs/payroll_uk/index.html

@@ -3504,7 +3504,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>2.8.2</li>
+              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>2.9.0</li>
               <li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
               <li data-group="PayrollUk" data-name="approveTimesheet" class="">
                 <a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>

docs/projects/index.html

@@ -1466,7 +1466,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Project"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Project"><strong>VSN: </strong>2.8.2</li>
+              <li class="nav-header" data-group="Project"><strong>VSN: </strong>2.9.0</li>
               <li class="nav-header" data-group="Project"><a href="#api-Project">Methods</a></li>
               <li data-group="Project" data-name="createProject" class="">
                 <a href="#api-Project-createProject">createProject</a>