jortt 4.1.0 → 6.1.0

data/lib/jortt/client.rb

@@ -1,23 +1,26 @@
-# encoding: UTF-8
+require 'oauth2'
+
+require 'jortt/client/error'
 require 'jortt/client/customers'
 require 'jortt/client/invoices'
-require 'jortt/client/invoice'
+require 'jortt/client/ledger_accounts'
 
 module Jortt
   ##
   # This class is the main interface used to communicate with the Jortt API.
   # It is by the {Jortt} module to create configured instances.
   class Client
-    BASE_URL = 'https://app.jortt.nl/api'
+    SITE = 'https://api.jortt.nl'
+    OAUTH_PROVIDER_URL = 'https://app.jortt.nl/oauth-provider/oauth'
 
-    attr_accessor :base_url, :app_name, :api_key
+    attr_accessor :token
 
     # Initialize a Jortt client.
     #
     # @example
     #   Jortt::Client.new(
-    #     app_name: <application-name, chosen in jortt.nl>
-    #     api_key: <api-key, as provided by jortt.nl>
+    #     "my-client-id",
+    #     "my-client-secret"
     #   )
     #
     # @params [ Hash ] opts Options for the client,
@@ -26,10 +29,17 @@ module Jortt
     # @return [ Jortt::Client ]
     #
     # @since 1.0.0
-    def initialize(opts)
-      self.base_url = opts.fetch(:base_url, BASE_URL)
-      self.app_name = opts.fetch(:app_name)
-      self.api_key = opts.fetch(:api_key)
+    def initialize(id, secret, opts = {})
+      oauth_provider_url = opts[:oauth_provider_url] || OAUTH_PROVIDER_URL
+
+      client = OAuth2::Client.new(id, secret,
+        site: opts[:site] || SITE,
+        token_url: "#{oauth_provider_url}/token",
+        authorize_url: "#{oauth_provider_url}/authorize",
+        auth_scheme: :basic_auth
+      )
+
+      @token = client.client_credentials.get_token(scope: "invoices:read invoices:write customers:read customers:write")
     end
 
     # Access the customer resource to perform operations.
@@ -56,16 +66,55 @@ module Jortt
       @invoices ||= Jortt::Client::Invoices.new(self)
     end
 
-    # Access a single invoice resource to perform operations.
+    # Access the ledger_accounts resource.
     #
     # @example
-    #   client.invoice('abc')
+    #   client.ledger_accounts
     #
-    # @params [ String ] invoice_id The id of an invoice.
+    # @return [ Jortt::Client::LedgerAccounts ] entry to the leger_accounts resource.
     #
-    # @return [ Jortt::Client::Invoice ] entry to the invoice resource.
-    def invoice(invoice_id)
-      Jortt::Client::Invoice.new(self, invoice_id)
+    # @since 5.0.0
+    def ledger_accounts
+      Jortt::Client::LedgerAccounts.new(self)
+    end
+
+    def get(path, params = {})
+      handle_response { token.get(path, params: params) }
+    end
+
+    def post(path, params = {})
+      handle_response { token.post(path, params: params) }
+    end
+
+    def put(path, params = {})
+      handle_response { token.put(path, params: params) }
+    end
+
+    def delete(path)
+      handle_response { token.delete(path) }
+    end
+
+    def handle_response(&block)
+      response = yield
+      return true if response.status == 204
+      response.parsed.fetch('data')
+    rescue OAuth2::Error => e
+      raise Error.from_response(e.response)
+    end
+
+    def paginated(path, params = {})
+      page = 1
+
+      Enumerator.new do |yielder|
+        loop do
+          response = token.get(path, params: params.merge(page: page)).parsed
+          response['data'].each { |item| yielder << item }
+          break if response['_links']['next'].nil?
+          page += 1
+        end
+      end
+    rescue OAuth2::Error => e
+      raise Error.from_response(e.response)
     end
 
   end

data/lib/jortt.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 require 'jortt/client'
 require 'jortt/client/version'
 

data/spec/fixtures/vcr_cassettes/Jortt/_client/1_1_1.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://app.jortt.nl/oauth-provider/oauth/token
+    body:
+      encoding: UTF-8
+      string: grant_type=client_credentials&scope=invoices%3Aread+invoices%3Awrite+customers%3Aread+customers%3Awrite
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 24 Sep 2020 15:03:37 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      Cache-Control:
+      - private, no-store
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Pragma:
+      - no-cache
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - dfa7330e-2975-4637-8d0b-fee35ed40cac
+      X-Download-Options:
+      - noopen
+      Etag:
+      - W/"97e5c8d5cedcea8cd8407a1a0a6f21c1"
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Runtime:
+      - '0.319627'
+      X-Content-Type-Options:
+      - nosniff
+      X-Powered-By:
+      - Phusion Passenger
+      Server:
+      - nginx + Phusion Passenger
+    body:
+      encoding: UTF-8
+      string: '{"access_token":"OCU8keLfHRLh6MQ1GdpTxDF9fvnRHge-h8IuDo1fx5M","token_type":"Bearer","expires_in":7200,"scope":"invoices:read
+        invoices:write customers:read customers:write","created_at":1600959817}'
+  recorded_at: Thu, 24 Sep 2020 15:03:37 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/vcr_cassettes/Jortt_Client/configured/_customers/1_1_1_1.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://app.jortt.nl/oauth-provider/oauth/token
+    body:
+      encoding: UTF-8
+      string: grant_type=client_credentials&scope=invoices%3Aread+invoices%3Awrite+customers%3Aread+customers%3Awrite
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 24 Sep 2020 15:03:35 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      Cache-Control:
+      - private, no-store
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Pragma:
+      - no-cache
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - 68b40955-bca3-4ef1-a33a-b688de73e738
+      X-Download-Options:
+      - noopen
+      Etag:
+      - W/"c977a25cd5737656d676c943a553cb29"
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Runtime:
+      - '0.319920'
+      X-Content-Type-Options:
+      - nosniff
+      X-Powered-By:
+      - Phusion Passenger
+      Server:
+      - nginx + Phusion Passenger
+    body:
+      encoding: UTF-8
+      string: '{"access_token":"Ck844kAGSr1df34pT_5YnvgKKZxa50ZzDsBHpwDTjk8","token_type":"Bearer","expires_in":7200,"scope":"invoices:read
+        invoices:write customers:read customers:write","created_at":1600959815}'
+  recorded_at: Thu, 24 Sep 2020 15:03:35 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/vcr_cassettes/Jortt_Client/configured/_invoices/1_1_2_1.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://app.jortt.nl/oauth-provider/oauth/token
+    body:
+      encoding: UTF-8
+      string: grant_type=client_credentials&scope=invoices%3Aread+invoices%3Awrite+customers%3Aread+customers%3Awrite
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 24 Sep 2020 15:03:36 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      Cache-Control:
+      - private, no-store
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Pragma:
+      - no-cache
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - 6bc1cab8-2244-4e71-9660-756eb0151c4e
+      X-Download-Options:
+      - noopen
+      Etag:
+      - W/"d0f9e4a84aa7b9af1d36a01aa38cf13a"
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Runtime:
+      - '0.321558'
+      X-Content-Type-Options:
+      - nosniff
+      X-Powered-By:
+      - Phusion Passenger
+      Server:
+      - nginx + Phusion Passenger
+    body:
+      encoding: UTF-8
+      string: '{"access_token":"Ap-1PU0Vghk01uEbz8mEP-Iaoc9eZygDcLwvEphpFqU","token_type":"Bearer","expires_in":7200,"scope":"invoices:read
+        invoices:write customers:read customers:write","created_at":1600959816}'
+  recorded_at: Thu, 24 Sep 2020 15:03:36 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/vcr_cassettes/Jortt_Client/configured/_ledger_accounts/1_1_3_1.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://app.jortt.nl/oauth-provider/oauth/token
+    body:
+      encoding: UTF-8
+      string: grant_type=client_credentials&scope=invoices%3Aread+invoices%3Awrite+customers%3Aread+customers%3Awrite
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 24 Sep 2020 15:03:36 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      Cache-Control:
+      - private, no-store
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Pragma:
+      - no-cache
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - 290ef5a5-d238-4a03-bfdb-5e811fbd9461
+      X-Download-Options:
+      - noopen
+      Etag:
+      - W/"e1784d286681a5ff4135f3ca0a76ee57"
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Runtime:
+      - '0.319839'
+      X-Content-Type-Options:
+      - nosniff
+      X-Powered-By:
+      - Phusion Passenger
+      Server:
+      - nginx + Phusion Passenger
+    body:
+      encoding: UTF-8
+      string: '{"access_token":"tTXpHoM9jl-_hp7rEr3_9SsUQWtvg0Pfw-re3HsbgZo","token_type":"Bearer","expires_in":7200,"scope":"invoices:read
+        invoices:write customers:read customers:write","created_at":1600959816}'
+  recorded_at: Thu, 24 Sep 2020 15:03:36 GMT
+recorded_with: VCR 6.0.0