jortt 3.0.0 → 6.0.0

data/spec/fixtures/vcr_cassettes/Jortt_Client_LedgerAccounts/_index/returns_invoices.yml

@@ -0,0 +1,118 @@
+---
+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:
+      - d83ae9ab-c629-46a3-8536-3d48345bbc24
+      X-Download-Options:
+      - noopen
+      Etag:
+      - W/"0fb39157c79bce6700240fe1ea97876e"
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Runtime:
+      - '0.333943'
+      X-Content-Type-Options:
+      - nosniff
+      X-Powered-By:
+      - Phusion Passenger
+      Server:
+      - nginx + Phusion Passenger
+    body:
+      encoding: UTF-8
+      string: '{"access_token":"-OQjJQikSmMhA9USfhfgESp3DKCWUUOGBfclpyF0oic","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
+- request:
+    method: get
+    uri: https://api.jortt.nl/ledger_accounts/invoices
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      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
+      Content-Length:
+      - '1011'
+      Connection:
+      - keep-alive
+      Server:
+      - Apache
+      Status:
+      - 200 OK
+      Content-Security-Policy:
+      - 'default-src ''self'' ''unsafe-inline'' blob: data: *.jortt.nl;     script-src
+        ''self'' ''unsafe-eval'' blob: ''unsafe-inline'' files.jortt.nl *.googletagmanager.com
+        *.uservoice.com inlinemanual.com *.google-analytics.com *.googleadservices.com
+        bat.bing.com tapfiliate.com static.ads-twitter.com tagmanager.google.com analytics.twitter.com
+        https://connect.facebook.net https://app.inlinemanual.com;     connect-src
+        ''self'' https://*.jortt.nl wss://*.jortt.nl analytics.inlinemanual.com files.jortt.nl
+        www.google-analytics.com stats.g.doubleclick.net file-storage-app-production.s3.eu-central-1.amazonaws.com
+        https://app.inlinemanual.com;     style-src ''self'' ''unsafe-inline'' fonts.googleapis.com
+        files.jortt.nl tagmanager.google.com https://app.inlinemanual.com;     font-src
+        ''self'' data: fonts.gstatic.com files.jortt.nl https://app.inlinemanual.com;     frame-src
+        ''self'' *.jortt.nl files.jortt.nl b.frstre.com beacon.tapfiliate.com jortt.uservoice.com
+        *.vimeo.com https://connect.facebook.net;     img-src ''self'' blob: data:
+        *.jortt.nl https://www.facebook.com files.jortt.nl www.google-analytics.com
+        stats.g.doubleclick.net www.google.nl www.google.com bat.bing.com googleads.g.doubleclick.net
+        https://www.googletagmanager.com https://widget.uservoice.com www.google.de
+        t.co *.gstatic.com https://ssl.google-analytics.com https://app.inlinemanual.com'
+    body:
+      encoding: UTF-8
+      string: '{"data":[{"ledger_account_id":"05a59e27-489f-466d-adf7-fc06f576d4ec","parent_ledger_account_id":"105ea7d7-8bb5-499e-9823-8324826b6563","name":"Omzet","selectable":false},{"ledger_account_id":"fcabf6bf-cccc-4a6d-b04e-7b2369d04a79","parent_ledger_account_id":"05a59e27-489f-466d-adf7-fc06f576d4ec","name":"Diverse
+        omzet","selectable":true},{"ledger_account_id":"05ba2a61-a0cc-4736-9000-89fb361e85c8","parent_ledger_account_id":"05a59e27-489f-466d-adf7-fc06f576d4ec","name":"Omzet
+        uit facturen","selectable":true},{"ledger_account_id":"92cb5ad4-e2e7-4c41-8e17-bf7db69c7b9a","parent_ledger_account_id":"986e5b45-dae6-48cc-b4c9-a2f30fbd7bfe","name":"Inkoopkosten","selectable":false},{"ledger_account_id":"424d222d-f8cb-4d38-82c0-24674a2dcf75","parent_ledger_account_id":"92cb5ad4-e2e7-4c41-8e17-bf7db69c7b9a","name":"Inkoop","selectable":true},{"ledger_account_id":"a5c08fb4-0a22-4f53-9ee2-d7682bba10f7","parent_ledger_account_id":"92cb5ad4-e2e7-4c41-8e17-bf7db69c7b9a","name":"Uitbesteed
+        werk","selectable":true}]}'
+  recorded_at: Thu, 24 Sep 2020 15:03:35 GMT
+recorded_with: VCR 6.0.0

data/spec/jortt/client/customers_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe Jortt::Client::Customers, :vcr do
+  let(:client) { Jortt.client(ENV['JORTT_CLIENT_ID'], ENV['JORTT_CLIENT_SECRET']) }
+
+  let(:params) do
+    {
+        is_private: false,
+        customer_name: 'Nuka-Cola Corporation',
+        address_street: 'Vault 11',
+        address_postal_code: '1111AA',
+        address_city: 'Mojave Wasteland'
+    }
+  end
+
+  let!(:jane) { client.customers.create(is_private: true, customer_name: 'Jane Doe')['id'] }
+  let!(:john) { client.customers.create(is_private: true, customer_name: 'John Doe')['id'] }
+
+  after do
+    client.customers.delete(jane)
+    client.customers.delete(john)
+  end
+
+  describe '#index' do
+    context 'without params' do
+      subject { client.customers.index.to_a }
+
+      it "returns customers" do
+        expect(subject.count).to eq(3)
+        expect(subject[0]['customer_name']).to eq('Jane Doe')
+        expect(subject[1]['customer_name']).to eq('John Doe')
+        expect(subject[2]['customer_name']).to eq('Search target')
+      end
+    end
+
+    context 'query' do
+      subject { client.customers.index(query: 'Search target') }
+
+      it "returns the queried customers" do
+        expect(subject.count).to eq(1)
+        expect(subject.first['customer_name']).to eq("Search target")
+      end
+    end
+  end
+
+  describe '#show' do
+    subject { client.customers.show(jane) }
+
+    it "returns the customer" do
+      expect(subject['customer_name']).to eq("Jane Doe")
+    end
+  end
+
+  describe '#create' do
+    context "valid payload" do
+      subject { client.customers.create(params) }
+      after { client.customers.delete(subject['id']) }
+
+      it "creates the customer" do
+        uuid_length = 36
+        expect(subject['id'].length).to eq(uuid_length)
+      end
+    end
+
+    context "faulty payload" do
+      subject { client.customers.create({}) }
+
+      it "shows a nice error" do
+        expect { subject }.to raise_error(Jortt::Client::Error)
+      end
+    end
+  end
+
+  describe '#update' do
+    let(:uuid) { client.customers.create(params).fetch('id') }
+    subject { client.customers.update(uuid, params.merge(address_extra_information: 'Extra...')) }
+    after { client.customers.delete(uuid) }
+
+    it "updates the customer" do
+      expect(subject).to eq(true)
+    end
+  end
+
+  describe '#delete' do
+    let(:uuid) { client.customers.create(params).fetch('id') }
+    subject { client.customers.delete(uuid) }
+
+    it "deletes the customer" do
+      expect(subject).to eq(true)
+    end
+  end
+
+  describe '#direct_debit_mandate' do
+    subject { client.customers.direct_debit_mandate(jane) }
+
+    it "sends direct debit mandate to the customer or responds with an error when not possible" do
+      begin
+        subject
+      rescue Jortt::Client::Error => e
+        expect(e.details.first['key']).to eq("DirectDebit::NotEnabled")
+      end
+    end
+  end
+end

data/spec/jortt/client/invoices_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe Jortt::Client::Invoices, :vcr do
+  let(:client) { Jortt.client(ENV['JORTT_CLIENT_ID'], ENV['JORTT_CLIENT_SECRET']) }
+
+  let(:customer) { client.customers.index(query: 'Search target').first }
+
+  let(:params) do
+    {
+      customer_id: customer.fetch('id'),
+      send_method: 'self',
+      line_items: [{
+        vat: 21,
+        amount_per_unit: {
+          value: 499,
+          currency: 'EUR'
+        },
+        units: 4,
+        description: 'Your product'
+      }]
+    }
+  end
+
+  describe '#index' do
+    context 'pagination', vcr: false do
+      subject { client.invoices.index }
+
+      before do
+        VCR.turn_off!
+
+        stub_request(:any, "https://app.jortt.nl/oauth-provider/oauth/token").
+          to_return(
+            headers: {content_type: 'application/json'},
+            body: {access_token: 'abc'}.to_json)
+
+        stub_request(:get, "https://api.jortt.nl/invoices?invoice_status&page=1&query").
+          to_return(
+            headers: {content_type: 'application/json'},
+            body: {
+              'data': [{id: 1}, {id: 2}],
+              _links: {next: "https://api.jortt.nl/invoices?page=2"}
+            }.to_json
+          )
+
+        stub_request(:get, "https://api.jortt.nl/invoices?invoice_status&page=2&query").
+          to_return(
+            headers: {content_type: 'application/json'},
+            body: {
+              data: [{id: 3}, {id: 4}],
+              _links: {next: "https://api.jortt.nl/invoices?page=3"}
+            }.to_json
+          )
+
+        stub_request(:get, "https://api.jortt.nl/invoices?invoice_status&page=3&query").
+          to_return(
+            headers: {content_type: 'application/json'},
+            body: {
+              data: [{id: 5}],
+              _links: {next: nil}
+            }.to_json
+          )
+      end
+
+      after { VCR.turn_on! }
+
+      it "returns the first page" do
+        expect(subject.first.fetch('id')).to eq(1)
+      end
+
+      it "seamlessly returns results from the other pages" do
+        expect(subject.to_a.count).to eq(5)
+      end
+    end
+
+    context 'invoice_status' do
+      subject { client.invoices.index(invoice_status: 'sent') }
+
+      it "returns those invoices" do
+        expect(subject.count).to be > 0
+        expect(subject.first.fetch('invoice_status')).to eq('sent')
+      end
+    end
+
+    context 'query' do
+      subject { client.invoices.index(query: 'Search target') }
+
+      it "returns the queried invoices" do
+        expect(subject.first.dig('invoice_due_amount', 'value')).to eq("2415.16")
+      end
+    end
+  end
+
+  describe '#create' do
+    subject { client.invoices.create(params) }
+
+    it "creates the invoice" do
+      uuid_length = 36
+      expect(subject['id'].length).to eq(uuid_length)
+    end
+  end
+
+  describe '#show' do
+    let(:uuid) { client.invoices.index(query: 'Search target').first.fetch('id') }
+    subject { client.invoices.show(uuid) }
+
+    it "returns the invoice" do
+      expect(subject.dig('invoice_due_amount', 'value')).to eq("2415.16")
+    end
+  end
+
+  describe '#download' do
+    let(:uuid) { client.invoices.index(query: 'Download test').first.fetch('id') }
+    subject { client.invoices.download(uuid) }
+
+    it "returns the invoice download link" do
+      expect(subject.fetch('download_location')).to match(/https:\/\/files\.jortt\.nl\/.*/)
+    end
+  end
+
+  describe '#credit' do
+    let(:uuid) { client.invoices.index(query: 'Search target').first.fetch('id') }
+    subject { client.invoices.credit(uuid, {send_method: 'self'}) }
+
+    it "credits the invoice" do
+      uuid_length = 36
+      expect(subject['id'].length).to eq(uuid_length)
+    end
+  end
+end

data/spec/jortt/client/ledger_accounts_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Jortt::Client::LedgerAccounts, :vcr do
+  let(:client) { Jortt.client(ENV['JORTT_CLIENT_ID'], ENV['JORTT_CLIENT_SECRET']) }
+
+  describe '#index' do
+    subject { client.ledger_accounts.index }
+
+    it "returns invoices" do
+      expect(subject.count).to be > 0
+      expect(subject.first).to eq(
+        "ledger_account_id" => "05a59e27-489f-466d-adf7-fc06f576d4ec",
+        "name" => "Omzet",
+        "parent_ledger_account_id" => "105ea7d7-8bb5-499e-9823-8324826b6563",
+        "selectable" => false
+      )
+    end
+  end
+end

data/spec/jortt/client_spec.rb

@@ -1,43 +1,22 @@
-# encoding: UTF-8
 require 'spec_helper'
 
-describe Jortt::Client do
-  describe '#initialize' do
-    subject { described_class.new(opts) }
-    let(:opts) { {} }
-
-    specify { expect { subject }.to raise_error(KeyError) }
-
-    context 'given app_name' do
-      before { opts[:app_name] = 'name' }
-
-      specify { expect { subject }.to raise_error(KeyError) }
-
-      context 'and api_key' do
-        before { opts[:api_key] = 'secret' }
-        it { should be_instance_of(described_class) }
-        its(:base_url) { should eq(described_class::BASE_URL) }
-        its(:app_name) { should eq('name') }
-        its(:api_key) { should eq('secret') }
-      end
-    end
-  end
-
+describe Jortt::Client, :vcr do
   context 'configured' do
-    let(:client) { described_class.new(app_name: 'app', api_key: 'secret') }
+    let(:client) { described_class.new(ENV['JORTT_CLIENT_ID'], ENV['JORTT_CLIENT_SECRET']) }
 
     describe '#customers' do
       subject { client.customers }
-      it { should be_instance_of(described_class::Resource) }
-      its(:singular) { should eq(:customer) }
-      its(:plural) { should eq(:customers) }
+      it { should be_instance_of(described_class::Customers) }
     end
 
     describe '#invoices' do
       subject { client.invoices }
-      it { should be_instance_of(described_class::Resource) }
-      its(:singular) { should eq(:invoice) }
-      its(:plural) { should eq(:invoices) }
+      it { should be_instance_of(described_class::Invoices) }
+    end
+
+    describe '#ledger_accounts' do
+      subject { client.ledger_accounts }
+      it { should be_instance_of(described_class::LedgerAccounts) }
     end
   end
 end

data/spec/{freemle_spec.rb → jortt_spec.rb}

@@ -1,9 +1,8 @@
-# encoding: UTF-8
 require 'spec_helper'
 
-describe Jortt do
+describe Jortt, :vcr do
   describe '.client' do
-    subject { described_class.client(app_name: 'name', api_key: 'secret') }
+    subject { described_class.client(ENV['JORTT_CLIENT_ID'], ENV['JORTT_CLIENT_SECRET']) }
     it { should be_instance_of(described_class::Client) }
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,9 @@
 require 'simplecov'
+require 'rspec'
+require 'rspec/its'
+require 'webmock/rspec'
+require 'vcr'
+require 'jortt'
 
 SimpleCov.start
 if ENV['CI'] == 'true'
@@ -6,8 +11,17 @@ if ENV['CI'] == 'true'
   SimpleCov.formatter = SimpleCov::Formatter::Codecov
 end
 
-require 'rspec'
-require 'rspec/its'
-require 'webmock/rspec'
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.default_cassette_options = { record: :once }
 
-require 'jortt'
+  c.before_record do |i|
+    i.response.headers.delete('Set-Cookie')
+    i.request.headers.delete('Authorization')
+  end
+end
+
+ENV['JORTT_CLIENT_ID'] ||= 'client-id'
+ENV['JORTT_CLIENT_SECRET'] ||= 'client-secret'