jortt 4.2.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0888e091fcb1156dc527b9cd815d0629b60e411e
-  data.tar.gz: e254535aeb502a1c3358df8b0af23eb782b0691e
+SHA256:
+  metadata.gz: 4034de85abfce8b8e5116576441272434c1435d4d51c7f86a2c01d7f87da5506
+  data.tar.gz: 764eba179889e670fc8f0c1a7620dfcefdba8735612ef002c67c7ce4817eea66
 SHA512:
-  metadata.gz: 11c08eb54b2d3b3f844e17df78c2e580bdb2b036a0d6322624ff352e8f5baf8e8c58cfd6db1340c209872e8513f21ae881216aeb65b6ef69d34aeeaa1220f667
-  data.tar.gz: 968c299166179d4d3c43ac37ef500a547c3f9ceea81db998e291dd6bf63593bda65fda12a2252bdbf75dd24bc0cd566cf2f4c93d5c6f3417a87de0f33fec7aaa
+  metadata.gz: aaa6c20cfeedfdf18f2eeafa90e46ae7c8e0402bad48ad6b3849d10ca1caaa919697b7e7881e9333b41426cecd235f9f78206737c535f8f4e6ccafca92e7c96c
+  data.tar.gz: 022c967a77e8d5ac6db87ed7ba8eb4613de35d0ac62f09762476f2423e5a97333bcb5c7b4c28ac780595d0d9945e52a2e8fa401e1fe24c77cd941eafdf1ca596

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.7.1

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
-  - 2.2.4
-  - 2.3.0
+  - 2.4.3
 script:
   - bundle exec rspec
-  - bundle exec rubocop

data/README.md

@@ -15,74 +15,36 @@ http://img.shields.io/travis/jorttbv/jortt-ruby.svg?style=flat
 
 A Ruby interface to the [Jortt](https://www.jortt.nl/) REST API.
 
-## Usage
+Check https://developer.jortt.nl/ for more info.
+
+> THIS VERSION IS FOR THE NEW OAUTH API. STILL ON THE LEGACY API? USE VERSION 4.x OF THIS GEM: [CLICK HERE](https://github.com/jorttbv/jortt-ruby/tree/v4.2.0)
+
+## Usage examples
 
 To create a jortt client:
 ```ruby
-jortt = Jortt.client(
-  app_name: "application-name-as-chosen-on-jortt.nl",
-  api_key: "api-key-as-provided-by-jortt.nl"
-)
+jortt = Jortt.client('<your-client-id>', '<your-client-secret>')
 ```
 
 ### Customers
 
-All customers (`jortt.customers.all(page: 2, per_page: 25)`) returns:
-```ruby
-[{
-  company_name: 'Jortt',
-  address: {
-    street: "Transistorstraat 71C",
-    postal_code: "1322 CK",
-    city: "Almere",
-    country_code: "NL"
-  }
-},
-{
-  company_name: 'Zilverline',
-  address: {
-    street: "Cruquiusweg",
-    ...
-  }
-},
-...
-page: 2,
-per_page: 25
-]
-```
-
-Searching customers (`jortt.customers.search('Jortt')`) returns:
+All customers (`jortt.customers.index(page: 2)`) returns:
 ```ruby
 [{
-  company_name: 'Jortt',
-  address: {
-    street: "Transistorstraat 71C",
-    postal_code: "1322 CK",
-    city: "Almere",
-    country_code: "NL"
-  }
-},
-{
-  company_name: 'ttroj',
-  address: {
-    street: "Jorttweg",
-    ...
-  }
+  "id": "f8fd3e4e-da1c-43a7-892f-1410ac13e38a",
+  "is_private": true,
+  "customer_name": "Jortt",
+  "address_street": "Rozengracht 75a",
+  ...
 }]
 ```
 
 Adding customers:
 ```ruby
 jortt.customers.create(
-  company_name: "Jortt B.V.",
-  attn: "Vibiemme", # Optional
-  extra_information: "The best cofee maker!", # Optional
-  address: {
-    street: "Transistorstraat 71C",
-    postal_code: "1322 CK",
-    city: "Almere",
-    country_code: "NL"
-  }
+  "is_private": true,
+  "customer_name": "Jortt",
+  ...
 )
 ```
 
@@ -113,80 +75,16 @@ Get invoices by ID (`jortt.invoices.get('934d59dd-76f6-4716-9e0f-82a618e1be21')`
 ```
 
 
-Searching invoices (`jortt.invoices.search('201606-012')`) returns:
+Searching invoices (`jortt.invoices.index(query: '202001-002')`) returns:
 ```ruby
-[
-  {
-    "invoice_id": "934d59dd-76f6-4716-9e0f-82a618e1be21",
-    "recipient": {
-      "company_name": "Zilverline B.V.",
-      "attn": null,
-      "address": {
-        "street": "Cruquisweg 109F",
-        "city": "Amsterdam",
-        "postal_code": "1111SX",
-        "country": {
-          "code": "NL",
-          "name": "Nederland"
-        }
-      },
-      "email": "ben@jortt.nl",
-      "customer_id": "e1c5e15b-e34e-423e-a291-4ed43226a190",
-      "extra_information": null,
-      "shift_vat": null,
-      "vat_number": null,
-      "payment_term": 30
-    },
-    "recipient_in_eu": true,
-    "organization": {
-      "company_name": "Jortt BV",
-      "company_name_line_2": null,
-      "address": {
-        "street": "Straat 1",
-        "city": "Amsterdam",
-        "postal_code": "1000 AA",
-        "country": {
-          "code": "NL",
-          "name": "Nederland"
-        }
-      },
-      "phonenumber": null,
-      "bank_information": {
-        "bic": "RABONL2U",
-        "iban": "NL50RABO0150000001",
-        "in_the_name_of": "Jortt B.V.",
-        "description": null
-      },
-      "coc_number": "unique number",
-      "vat_number": "NL821898279B01",
-      "profession": null,
-      "healthcare_data": null,
-      "free_of_vat": false,
-      "finance_email": "Jortt BV <compleet@jortt.nl>"
-    },
-    "line_items": [
-      {
-        "description": "Scrum",
-        "vat": "0.21",
-        "amount": "-100.0",
-        "total_amount_ex_vat": "-100.0",
-        "currency": "EUR",
-        "quantity": "1.0"
-      }
-    ],
-    "invoice_currency": null,
-    "invoice_total": "-100.0",
-    "invoice_total_incl_vat": "-121.0",
-    "invoice_number": "201607-011",
-    "invoice_status": "paid",
-    "invoice_due_date": "2016-08-06",
-    "invoice_date": "2016-07-07",
-    "invoice_delivery_period": "2016-07-01",
-    "invoice_remarks": null,
-    "invoice_language": "nl",
-    "invoice_reference": null
-  }
-]
+[{
+  "id": "f8fd3e4e-da1c-43a7-892f-1410ac13e38a",
+  "invoice_status": "draft",
+  "customer_id": "f8fd3e4e-da1c-43a7-892f-1410ac13e38a",
+  "invoice_number": "202001-002",
+  "invoice_date": "2020-02-23",
+  ...
+}]
 
 ```
 
@@ -194,35 +92,31 @@ Searching invoices (`jortt.invoices.search('201606-012')`) returns:
 Adding invoices:
 ```ruby
 jortt.invoices.create(
-  customer_id: "123456789", # Optional
-  delivery_period: "31-12-1234", # Optional
-  reference: "my-reference", # Optional
+  customer_id: "f8fd3e4e-da1c-43a7-892f-1410ac13e38a",
+  invoice_date: "2020-02-23",
+  delivery_period: "2020-02-01",
+  payment_term: 14,
+  net_amounts: true,
+  send_method: "email",
+  introduction: "example",
+  remarks: "example",
+  payment_method: "pay_later",
   line_items: [
-    {vat: 21, amount: 1359.50, quantity: 1, description: "Scrum Training"}
-  ]
-)
-```
-
-Sending invoices:
-```ruby
-jortt.invoice(:invoice_id).send_invoice(
-  mail_data: {
-    to: 'ben@jortt.nl', # optional
-    subject: 'Thank you for your assignment', # optional
-    body: 'I hereby send you the invoice', # optional
-  },
-  invoice_date: Date.today, # optional
-  payment_term: 7, # optional
-  language: 'nl', # optional
-  send_method: 'email', # optional
+    {
+      description: "this is a description example",
+      units: 3.14,
+      amount_per_unit: {
+        value: "365.00",
+        currency: "EUR"
+      },
+      vat: 21,
+      ledger_account_id: "f8fd3e4e-da1c-43a7-892f-1410ac13e38a"
+    }
+  ],
+  reference: "123"
 )
 ```
 
-
-## Documentation
-
-Check https://app.jortt.nl/api-documentatie for more info.
-
 ## Development
 
 ### Running tests

data/Rakefile

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/jortt.gemspec

@@ -28,13 +28,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'rest-client', '~> 2.0'
+  spec.add_runtime_dependency 'oauth2', '~> 1.4.4'
 
-  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'codecov', '~> 0.1'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
-  spec.add_development_dependency 'webmock', '~> 1.17'
-  spec.add_development_dependency 'rubocop', '~> 0.24.1'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.1'
+  spec.add_development_dependency 'webmock', '~> 3.3'
+  spec.add_development_dependency 'vcr', '~> 6.0'
 end

data/lib/jortt.rb

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

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/client/customers.rb

@@ -1,84 +1,91 @@
-# encoding: UTF-8
-require 'rest-client'
-
 module Jortt # :nodoc:
   class Client # :nodoc:
-
     ##
     # Exposes the operations available for a collection of customers.
     #
     # @see { Jortt::Client.customers }
     class Customers
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
 
-      def initialize(config)
-        @resource = RestClient::Resource.new(
-          "#{config.base_url}/customers",
-          user: config.app_name,
-          password: config.api_key,
-        )
+      ##
+      # Returns all customers using the GET /customers endpoint.
+      # https://developer.jortt.nl/#list-customers
+      #
+      # @example
+      #   client.customers.index(query: 'Jane')
+      #
+      def index(query: nil)
+        client.paginated('/customers', query: query)
       end
 
       ##
-      # Returns all customers using the GET /customers/all endpoint.
+      # Returns a customer using the GET /customers/{customer_id} endpoint.
+      # https://developer.jortt.nl/#get-customer-by-id
       #
       # @example
-      #   Jortt::Client.customers.all(page: 3, per_page: 10)
+      #   client.customers.show("9afcd96e-caf8-40a1-96c9-1af16d0bc804")
       #
-      def all(page: 1, per_page: 50)
-        resource['all'].get(params: {page: page, per_page: per_page}) do |res|
-          JSON.parse(res.body)
-        end
+      def show(id)
+        client.get("/customers/#{id}")
       end
 
       ##
       # Creates a Customer using the POST /customers endpoint.
-      # See https://app.jortt.nl/api-documentatie#klant-aanmaken
+      # https://developer.jortt.nl/#create-customer
       #
       # @example
-      #   Jortt::Client.customers.create(
-      #     company_name: "Jortt B.V.", # mandatory
-      #     attn: "Finance department", # optional
-      #     email: "support@jortt.nl", # optional
-      #     extra_information: "Our valued customer", # optional
-      #     address: {
-      #       street: "Street 100", # mandatory
-      #       postal_code: "1000 AA", # mandatory
-      #       city: "Amsterdam", # mandatory
-      #       country_code: "NL" # mandatory
-      #     }
+      #   client.customers.create(
+      #     is_private: false,
+      #     customer_name: 'Nuka-Cola Corporation',
+      #     address_street: 'Vault 11',
+      #     address_postal_code: '1111AA',
+      #     address_city: 'Mojave Wasteland'
       #   )
+      #
       def create(payload)
-        resource.post(JSON.generate('customer' => payload)) do |response|
-          JSON.parse(response.body)
-        end
+        client.post('/customers', payload)
       end
 
-      # Performs a search on this resource, given a query.
-      #
-      # @example
-      #   customers.search('Zilverline')
+      ##
+      # Updates a Customer using the PUT /customers/{customer_id} endpoint.
+      # https://developer.jortt.nl/#update-customer
       #
       # @example
-      #   customers.search('Zilverline') do |response|
-      #     # Roll your own response handler
-      #   end
+      #   client.customers.update(
+      #     "9afcd96e-caf8-40a1-96c9-1af16d0bc804",
+      #     { address_extra_information: 'foobar' }
+      #   )
       #
-      # @param [ Hash ] query A hash containing the fields to search for.
-      # @param [ Proc ] block A custom response handler.
+      def update(id, payload)
+        client.put("/customers/#{id}", payload)
+      end
+
+      ##
+      # Deletes a Customer using the DELETE /customers/{customer_id} endpoint.
+      # https://developer.jortt.nl/#delete-a-customer
       #
-      # @return [ Array<Hash> ] By default, a JSON parsed response body.
+      # @example
+      #   client.customers.delete("9afcd96e-caf8-40a1-96c9-1af16d0bc804")
       #
-      # @since 1.0.0
-      def search(query)
-        resource.get(params: {query: query}) do |response|
-          JSON.parse(response.body)
-        end
+      def delete(id)
+        client.delete("/customers/#{id}")
       end
 
-    private
-
-      attr_reader :resource
+      ##
+      # Send direct debit authorization to a Customer using POST /customers/{customer_id}/direct_debit_mandate.
+      # https://developer.jortt.nl/#send-direct-debit-authorization-to-a-customer
+      #
+      # @example
+      #   client.customers.direct_debit_mandate("9afcd96e-caf8-40a1-96c9-1af16d0bc804")
+      #
 
+      def direct_debit_mandate(id)
+        client.post("/customers/#{id}/direct_debit_mandate")
+      end
     end
   end
 end