xero-api 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4f9f82ae2a5ed6a1f7431a747d7672d8f6f861fa48df6db20cb9087d4c4d1a4
-  data.tar.gz: f4d7685b2d8a00163614fc34653cf1025f3083032e9ae4a54cea2eddb2fc1694
+  metadata.gz: a0fc58050e51ea774703378f3898262fbe5f7b86d40cf78eee2f34d1777d94da
+  data.tar.gz: ef52a7a96f80dc414840d1fc7067a89077837b2bec376dded13fa560518ed5a4
 SHA512:
-  metadata.gz: 470d2fab8520c56dcc0fa1426f38d68668a43f5bb930283ace9321c14bfa02d38d24ad6621c8c489f5826c15f0244b00e48b4fa1ed97bb420378bcf3ea3c9a01
-  data.tar.gz: 9329f64f58e169ff1528946ecca3b21d494fbe69ce208617400e379d9e1aa5a66ef19d42d6bdc88ee1c87cb5fc5715371a267d65ab347d590d5fea3a771c60f0
+  metadata.gz: 7b1c5d982a4fd25dffd4112d7a4ae7584b7f6a13e7e87fec305bc578a5a99e76db6be487664272f2e054bbfda11cd824fd36175d611dedefedfe8efc4e0e0246
+  data.tar.gz: 16c36a3e6a933e438558b2bcd41ba9e926794e2a57fb1362c5a1c054a1f61309f0cc8ea5a57f34174439fd79be0c37c93f3950866c3b89eacd2b05b9af15b092

data/.env.example_app.oauth2

@@ -0,0 +1 @@
+export XERO_API_OAUTH2_ACCESS_TOKEN=

data/.gitignore

@@ -21,3 +21,4 @@ spec/temp/spec_status.txt
 scrap.txt
 README.md.html
 .DS_Store
+.tool-versions

data/README.md

@@ -2,8 +2,8 @@
 
 ### Ruby client for the Xero API version 2.
 - **Pure JSON-in / JSON-out.** No XML support.
-- 4 main methods: **.get, .create, .update, and .delete**
-- No validation rules built into the gem. **Validation comes from API only**.
+- 4 main methods: **.get, .create, .update, and .delete**.
+- No validation rules built into the gem. **Validation comes from the API only**.
 - Close to the metal experience.
 - First class logging.
 - Robust error handling.
@@ -25,12 +25,12 @@ For example, here are the total code line counts (of `.rb` files):
   - waynerobinson/xeroizer => 6019
   - xero-gateway/xero_gateway => 5545
 
-## Ruby >= 2.4.0 required
+## Ruby >= 2.7.0 required
 
 ## Current Limitations
 
 - Accounting API only.
-- Only for public and partner Xero apps.
+- Only [Custom Connections](https://developer.xero.com/documentation/guides/oauth2/custom-connections) and OAuth2 are supported.
 
 ## Installation
 
@@ -52,11 +52,13 @@ Or install it yourself as:
 ## Initialize
 
 ```ruby
-  creds = account.xero_account # or wherever you are storing the OAuth creds
-  xero_api = Xero::Api.new(token: creds.token,
-                       token_secret: creds.secret,
-                       consumer_key: '*****',
-                       consumer_secret: '********')
+  require 'oauth2'
+  require 'xero/api'
+
+  client = OAuth2::Client.new(ENV['XERO_OAUTH2_CLIENT_ID'), ENV['XERO_OAUTH2_CLIENT_SECRET'], token_url: 'https://identity.xero.com/connect/token' )
+  client_credentials = client.client_credentials.get_token
+
+  api = Xero::Api.new(access_token: client_credentials.token)
 ```
 
 ## .get
@@ -87,8 +89,8 @@ See all the arguments for the [`.get` method](https://github.com/minimul/xero-ap
 ```ruby
   payload = {
       "Type": "ACCREC",
-      "Contact": { 
-        "ContactID": "f477ad8d-44f2-4bb7-a99b-04f28681e849" 
+      "Contact": {
+        "ContactID": "f477ad8d-44f2-4bb7-a99b-04f28681e849"
       },
       "DateString": api.standard_date(Time.utc(2009, 05, 27)),
       "DueDateString": api.standard_date(Time.utc(2009, 06, 06)),
@@ -156,7 +158,7 @@ Xero::Api.logger = Rails.logger
 ### .upload_attachment
 ```ruby
   file_name = 'connect_xero_button_blue_2x.png'
-  resp = api.upload_attachment(:invoices, id: '9eb7b996-4ac6-4cf8-8ee8-eb30d6e572e3', 
+  resp = api.upload_attachment(:invoices, id: '9eb7b996-4ac6-4cf8-8ee8-eb30d6e572e3',
                                file_name: file_name, content_type: 'image/png',
                                attachment: "#{__dir__}/../../../example/public/#{file_name}")
 ```
@@ -177,13 +179,13 @@ Xero::Api.logger = Rails.logger
 ```
 
 ### Spin up an example
+## THIS SECTION NEEDS TO UPDATED TO OAUTH2
 
 1. Follow and do all in Step 1 from the [Getting Started Guide](https://developer.xero.com/documentation/getting-started/getting-started-guide).
 1. `git clone git://github.com/minimul/xero-api && cd xero-api`
 1. `bundle`
 1. Create a `.env` file
-  1. `cp .env.example_app.oauth1 .env`
-  1. Edit the `.env` file values with `consumer_key` and `consumer_secret`.
+  1. `cp .env.example_app.oauth2 .env`
 1. Start up the example app => `ruby example/oauth.rb`
 1. In browser go to `http://localhost:9393`.
 1. Use the `Connect to Xero` button to connect to your Xero account.
@@ -206,13 +208,12 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/minimu
 - `git clone git://github.com/minimul/xero-api && cd xero-api`
 - `bundle`
 - Create a `.env` file
-  - `cp .env.example_app.oauth1 .env`
+  - `cp .env.example_app.oauth2 .env`
 - `bundle exec rake`
 
 #### Creating new specs or modifying existing spec that have been recorded using the VCR gem.
-- All specs that require interaction with the API must be recorded against the Xero Demo Company. 
+- All specs that require interaction with the API must be recorded against the Xero Demo Company.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/xero/api/version.rb

@@ -1,5 +1,5 @@
 module Xero
   class Api
-    VERSION = "1.0.1"
+    VERSION = "2.0.0"
   end
 end

data/lib/xero/api.rb

@@ -24,7 +24,7 @@ module Xero
     LOG_TAG = "[xero-api gem]"
 
     def initialize(attributes = {})
-      raise Xero::Api::Error, "missing or blank keyword: token" unless attributes.key?(:token) and !attributes[:token].nil?
+      raise Xero::Api::Error, "missing or blank keyword: access_token" unless attributes.key?(:access_token) and !attributes[:access_token].nil?
       attributes = default_attributes.merge!(attributes)
       attributes.each do |attribute, value|
         public_send("#{attribute}=", value)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xero-api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Christian Pelczarski
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -178,7 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - christian@minimul.com
 executables: []
@@ -217,7 +217,7 @@ homepage: https://github.com/minimul/xero-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -232,8 +232,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Ruby JSON-only client for Xero API.
 test_files: []