jortt 4.1.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9fb355ea7092b575b6bea7c989535898af0aea62
-  data.tar.gz: 62f389c052bac3710d7abd9672f1c1b86cb2cfb7
+SHA256:
+  metadata.gz: cfce1585dc32518fb10a2d0bdb712186bb0a2746ba1367454e88601411516697
+  data.tar.gz: bc9d0972988bcaf7d74bd4c3bc2719bbe792cb873cbb294df5226a8bc7163eaa
 SHA512:
-  metadata.gz: cbcb1bfc7f77b82498ae2c08feb079a95e965b833774b836e77d6866ffe563cbc5637eaeade9e68a42ee7374b64996dc08f370ee312be48009c4d465d20805d9
-  data.tar.gz: 94009c1f00dedb5bc269f6496ed20859f998ce0928f331f34dee9ddd78c664ede83279ca68417ca43a0ded29aee277775980df4ace69dd2cc82d1a962e6b857b
+  metadata.gz: 24934871450f27a253940c5757b09e9298f04c9e0d4f62e002db8ea65e4c267923d97e2af8ef10c537ecd68baabcc712287b47e1f22b6468ffdb70448b33b6af
+  data.tar.gz: 8df956433f4b19e82d188382e048f212272acd5d8efdac9eede3cd95da41f07bc77b9c2ae52cfbfef00c010f280649a546b6a0736fb2f5155dda967aaaea80b1

data/.github/workflows/rspec.yml

@@ -0,0 +1,27 @@
+name: rspec
+
+on:
+  [push]
+
+env:
+  RACK_ENV: test
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - ruby-version: 3.0.0
+          - ruby-version: 2.7
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+3.0.0

data/README.md

@@ -1,141 +1,85 @@
 # Jortt REST API client
 
-[![Inline docs](
-http://inch-ci.org/github/jorttbv/jortt-ruby.svg?branch=master&style=flat
-)](http://inch-ci.org/github/jorttbv/jortt-ruby)
-[![Code Climate](
-http://img.shields.io/codeclimate/github/jorttbv/jortt-ruby.svg?style=flat
-)](https://codeclimate.com/github/jorttbv/jortt-ruby)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability)](https://codeclimate.com/github/codeclimate/codeclimate/maintainability)
 [![Code Coverage](
 https://codecov.io/github/jorttbv/jortt-ruby/coverage.svg?branch=master
 )](https://codecov.io/github/jorttbv/jortt-ruby?branch=master)
-[![Build Status](
-http://img.shields.io/travis/jorttbv/jortt-ruby.svg?style=flat
-)](https://travis-ci.org/jorttbv/jortt-ruby)
+[![rspec Actions Status](https://github.com/jorttbv/jortt-ruby/workflows/rspec/badge.svg)](https://github.com/jorttbv/jortt-ruby/actions)
 
 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)
+
+> THIS VERSION ONLY WORKS FOR CLIENT CREDENTIALS CURRENTLY.
+
+## 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
 
-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",
+  ...
 )
 ```
 
 ### Invoices
-Searching invoices (`jortt.invoices.search('201606-012')`) returns:
+Get invoices by ID (`jortt.invoices.get('934d59dd-76f6-4716-9e0f-82a618e1be21')`) returns:
 ```ruby
-[
-  {
-    "invoice_id": "934d59dd-76f6-4716-9e0f-82a618e1be21",
-    "recipient": {
-      "company_name": "Zilverine 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_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"
       }
-    ],
-    "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
+    },
+    "email": "ben@jortt.nl",
+    "customer_id": "e1c5e15b-e34e-423e-a291-4ed43226a190",
+    "extra_information": null,
+    ...
   }
-]
+  ...
+}
+```
+
+
+Searching invoices (`jortt.invoices.index(query: '202001-002')`) returns:
+```ruby
+[{
+  "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",
+  ...
+}]
 
 ```
 
@@ -143,35 +87,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_percentage: "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
@@ -188,3 +128,5 @@ by `require 'jortt/client'` and do your stuff).
 Make a fix, commit and push. Make sure the build is green. Then bump the
 version (edit `lib/jortt/client/version.rb`). Now `rake release` and follow
 the instructions (you need a rubygems.org account and permissions ;-)).
+
+Otherwise `gem build jortt.gemspec` and `gem push jortt-[version].gem`.

data/Rakefile

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

data/jortt.gemspec

@@ -27,14 +27,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rest-client', '~> 1.6'
+  spec.add_runtime_dependency 'rest-client', ['>= 2.0', '< 2.2']
+  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/client/customers.rb

@@ -1,72 +1,101 @@
-# 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
+
+      ##
+      # 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
 
-      def initialize(config)
-        @resource = RestClient::Resource.new(
-          "#{config.base_url}/customers",
-          user: config.app_name,
-          password: config.api_key,
-        )
+      ##
+      # Returns a customer using the GET /customers/{customer_id} endpoint.
+      # https://developer.jortt.nl/#get-customer-by-id
+      #
+      # @example
+      #   client.customers.show("9afcd96e-caf8-40a1-96c9-1af16d0bc804")
+      #
+      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.
+      ##
+      # Updates a Customer using the PUT /customers/{customer_id} endpoint.
+      # https://developer.jortt.nl/#update-customer
       #
       # @example
-      #   customers.search('Zilverline')
+      #   client.customers.update(
+      #     "9afcd96e-caf8-40a1-96c9-1af16d0bc804",
+      #     { address_extra_information: 'foobar' }
+      #   )
+      #
+      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
       #
       # @example
-      #   customers.search('Zilverline') do |response|
-      #     # Roll your own response handler
-      #   end
+      #   client.customers.delete("9afcd96e-caf8-40a1-96c9-1af16d0bc804")
       #
-      # @param [ Hash ] query A hash containing the fields to search for.
-      # @param [ Proc ] block A custom response handler.
+      def delete(id)
+        client.delete("/customers/#{id}")
+      end
+
+      ##
+      # 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
       #
-      # @return [ Array<Hash> ] By default, a JSON parsed response body.
+      # @example
+      #   client.customers.direct_debit_mandate("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 direct_debit_mandate(id)
+        client.post("/customers/#{id}/direct_debit_mandate")
       end
 
-    private
-
-      attr_reader :resource
-
+      ##
+      # Get vat percentages for a Customer using the GET /customers/{customer_id}/vat-percentages endpoint.
+      # https://developer.jortt.nl/#get-vat-percentages-for-a-customer-by-id
+      #
+      # @example
+      #   client.customers.vat_percentages("9afcd96e-caf8-40a1-96c9-1af16d0bc804")
+      #
+      def vat_percentages(id)
+        client.get("/customers/#{id}/vat-percentages")
+      end
     end
   end
 end

data/lib/jortt/client/error.rb

@@ -0,0 +1,33 @@
+module Jortt # :nodoc:
+  class Client # :nodoc:
+    class Error < StandardError # :nodoc:
+      attr_reader :response, :code, :key, :message, :details
+
+      def self.from_response(response)
+        Error.new(
+            response.parsed.dig('error', 'code'),
+            response.parsed.dig('error', 'key'),
+            response.parsed.dig('error', 'message'),
+            response.parsed.dig('error', 'details')
+        )
+      end
+
+      def initialize(code, key, message, details)
+        @code = code
+        @key = key
+        @message = message
+        @details = details
+
+        super(error_message)
+      end
+
+      def error_message
+        [message].tap do |m|
+          details.each do |detail|
+            m << "#{detail['param']} #{detail['message']}"
+          end
+        end.join("\n")
+      end
+    end
+  end
+end

data/lib/jortt/client/invoices.rb

@@ -1,56 +1,80 @@
-# encoding: UTF-8
-require 'rest-client'
-
 module Jortt # :nodoc:
   class Client # :nodoc:
-
     ##
     # Exposes the operations available for a collection of invoices.
     #
     # @see { Jortt::Client.invoices }
     class Invoices
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
 
-      def initialize(config)
-        @resource = RestClient::Resource.new(
-          "#{config.base_url}/invoices",
-          user: config.app_name,
-          password: config.api_key,
-        )
+      ##
+      # Returns all invoices using the GET /invoices endpoint.
+      # https://developer.jortt.nl/#list-invoices
+      #
+      # @example
+      #   client.invoices.index(query: 'Jane')
+      #
+      def index(query: nil, invoice_status: nil)
+        client.paginated('/invoices', query: query, invoice_status: invoice_status)
+      end
+
+      ##
+      # Returns a invoice using the GET /invoices/{invoice_id} endpoint.
+      # https://developer.jortt.nl/#get-invoice-by-id
+      #
+      # @example
+      #   client.invoices.show("9afcd96e-caf8-40a1-96c9-1af16d0bc804")
+      #
+      def show(id)
+        client.get("/invoices/#{id}")
       end
 
       ##
       # Creates an Invoice using the POST /invoices endpoint.
-      # See https://app.jortt.nl/api-documentatie#factuur-aanmaken
+      # https://developer.jortt.nl/#create-and-optionally-send-an-invoice
       #
       # @example
-      #   Jortt::Client.invoices.create(
-      #     customer_id: 'customer_id', # optional
-      #     delivery_period: '31-12-2015', # optional
-      #     reference: 'reference', # optional
+      #   client.invoices.create(
       #     line_items: [{
-      #       vat: 21, # mandatory, percentage
-      #       amount: 499, # mandatory, ex vat
-      #       quantity: 4, # mandatory
-      #       description: 'Your Thinkas' # mandatory
+      #       vat_percentage: "21.0",
+      #       amount: 499,
+      #       number_of_units: "4",
+      #       description: 'Your product'
       #     }]
       #   )
       def create(payload)
-        resource.post(JSON.generate('invoice' => payload)) do |response|
-          JSON.parse(response.body)
-        end
+        client.post('/invoices', payload)
       end
 
-      def search(query)
-        resource["search"].get(params: {query: query}) do |response|
-          JSON.parse(response.body)
-        end
+      ##
+      # Credits an Invoice using the POST /invoices/{invoice_id}/credit endpoint.
+      # https://developer.jortt.nl/#create-and-optionally-send-an-invoice
+      #
+      # @example
+      #   client.invoices.credit(
+      #     "9afcd96e-caf8-40a1-96c9-1af16d0bc804",
+      #     {
+      #       send_method: 'email'
+      #     }
+      #   )
+      def credit(id, payload)
+        client.post("/invoices/#{id}/credit", payload)
       end
 
-    private
-
-      attr_reader :resource
-
+      ##
+      # Returns an invoice PDF download link using the GET /invoices/{invoice_id}/download endpoint.
+      # https://developer.jortt.nl/#download-invoice-pdf
+      #
+      # @example
+      #   client.invoices.download("9afcd96e-caf8-40a1-96c9-1af16d0bc804")
+      #
+      def download(id)
+        client.get("/invoices/#{id}/download")
+      end
     end
-
   end
 end

data/lib/jortt/client/ledger_accounts.rb

@@ -0,0 +1,27 @@
+module Jortt # :nodoc:
+  class Client # :nodoc:
+    ##
+    # Exposes the operations available for a collection of customers.
+    #
+    # @see { Jortt::Client.customers }
+    class LedgerAccounts
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      ##
+      # Returns the list of Ledger Accounts that can be used to categorize Line Items on an Invoice
+      # for in your Profit and Loss report using the GET /ledger_accounts/invoices endpoint.
+      # https://developer.jortt.nl/#list-invoice-ledger-accounts
+      #
+      # @example
+      #   client.ledger_accounts.index
+      #
+      def index
+        client.get('/ledger_accounts/invoices')
+      end
+    end
+  end
+end

data/lib/jortt/client/version.rb

@@ -1,7 +1,6 @@
-# encoding: UTF-8
 module Jortt
   # Define the version of +Jortt::Client+
   class Client
-    VERSION = '4.1.0'
+    VERSION = '6.1.0'
   end
 end