jortt 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08466fe7b01ea7758a6fecfecb4851ca0a4b091b
-  data.tar.gz: dfad854f25b7303b2015831b8b9aceb9f7e727ba
+  metadata.gz: 7faec2150bcc8753be6af239ea3efcb49ca5d5c3
+  data.tar.gz: 3d5e611607ae2e4bfe21a2dd24419ea355cd4c61
 SHA512:
-  metadata.gz: 499973d4e8032da74eba391c06d95ab62f298567b5cb50a9957e10a0e70f23e664501e5b34fbece628b1bbf88a59d54532bbcd7a20ec9def573f91783f44e2ad
-  data.tar.gz: c9522fd7d8485e967d14dce03d153b726a8459557ca616df9fcc0bc2de45d3fa484827e8c41385c119143dc6f400d4b34a6c2e3909b5ec4f509f1485b1e893b0
+  metadata.gz: b1d1e1c59783b565a28c4056006811288e007b27860a41a67a3b75bcc29f0cc7560a23fe7f16193e9267f589bab2260bed4e73c02f93d4faf349a65c2b7543d1
+  data.tar.gz: 35e95f431f5a10dd0fa92c13caeef7125ec6e7bb19862d139885adc97ba030709612c1c022f6a304d476b8fc1350bc99077e4e18e8a8a5b0a81b4258d9b93362

data/jortt.gemspec

@@ -32,9 +32,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.0'
   spec.add_development_dependency 'codecov', '~> 0.1'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.4.0'
-  spec.add_development_dependency 'rspec-its', '~> 1.2.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  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.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.1'
 end

data/lib/jortt/client.rb

@@ -1,5 +1,7 @@
 # encoding: UTF-8
-require 'jortt/client/resource'
+require 'jortt/client/customers'
+require 'jortt/client/invoices'
+require 'jortt/client/invoice'
 
 module Jortt
   ##
@@ -30,39 +32,40 @@ module Jortt
       self.api_key = opts.fetch(:api_key)
     end
 
-    # Access the customer resource.
+    # Access the customer resource to perform operations.
     #
     # @example
     #   client.customers
     #
-    # @return [ Jortt::Client::Resource ] entry to the customer resource.
+    # @return [ Jortt::Client::Customers ] entry to the customer resource.
     #
     # @since 1.0.0
     def customers
-      @customers ||= new_resource(self, :customer, :customers)
+      @customers ||= Jortt::Client::Customers.new(self)
     end
 
-    # Access the invoice resource.
+    # Access the invoices resource to perform operations.
     #
     # @example
     #   client.invoices
     #
-    # @return [ Jortt::Client::Resource ] entry to the invoice resource.
+    # @return [ Jortt::Client::Invoices ] entry to the invoice resource.
     #
     # @since 1.0.0
     def invoices
-      @invoices ||= new_resource(self, :invoice, :invoices)
+      @invoices ||= Jortt::Client::Invoices.new(self)
     end
 
-  private
-
-    # Creates a jortt client resource based on the passed configuration
+    # Access a single invoice resource to perform operations.
+    #
+    # @example
+    #   client.invoice('abc')
     #
-    # @return [ Jortt::Client::Resource ] entry to a resource.
+    # @params [ String ] invoice_id The id of an invoice.
     #
-    # @since 1.0.1
-    def new_resource(*args)
-      Jortt::Client::Resource.new(*args)
+    # @return [ Jortt::Client::Invoice ] entry to the invoice resource.
+    def invoice(invoice_id)
+      Jortt::Client::Invoice.new(self, invoice_id)
     end
 
   end

data/lib/jortt/client/customers.rb

@@ -0,0 +1,72 @@
+# 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
+
+      def initialize(config)
+        @resource = RestClient::Resource.new(
+          "#{config.base_url}/customers",
+          user: config.app_name,
+          password: config.api_key,
+        )
+      end
+
+      ##
+      # Creates a Customer using the POST /customers endpoint.
+      # See https://app.jortt.nl/api-documentatie#klant-aanmaken
+      #
+      # @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
+      #     }
+      #   )
+      def create(payload)
+        resource.post(JSON.generate('customer' => payload)) do |response|
+          JSON.parse(response.body)
+        end
+      end
+
+      # Performs a search on this resource, given a query.
+      #
+      # @example
+      #   customers.search('Zilverline')
+      #
+      # @example
+      #   customers.search('Zilverline') do |response|
+      #     # Roll your own response handler
+      #   end
+      #
+      # @param [ Hash ] query A hash containing the fields to search for.
+      # @param [ Proc ] block A custom response handler.
+      #
+      # @return [ Array<Hash> ] By default, a JSON parsed response body.
+      #
+      # @since 1.0.0
+      def search(query)
+        resource.get(params: {query: query}) do |response|
+          JSON.parse(response.body)
+        end
+      end
+
+    private
+
+      attr_reader :resource
+
+    end
+  end
+end

data/lib/jortt/client/invoice.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+require 'rest-client'
+
+module Jortt # :nodoc:
+  class Client # :nodoc:
+
+    ##
+    # Exposes the operations available for a single invoice.
+    #
+    # @see { Jortt::Client.invoice }
+    class Invoice
+
+      def initialize(config, id)
+        @config = config
+        @id = id
+      end
+
+      ##
+      # Sends an Invoice using the POST /invoices/id/:invoice_id/send endpoint.
+      #
+      # @example
+      #   Jortt::Client.invoice(:invoice_id).send(
+      #     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
+      #   )
+      def send_invoice(payload = {})
+        resource = RestClient::Resource.new(
+          "#{config.base_url}/invoices/id/#{id}/send",
+          user: config.app_name,
+          password: config.api_key,
+        )
+        resource.post(JSON.generate(payload)) do |response|
+          JSON.parse(response.body)
+        end
+      end
+
+    private
+
+      attr_reader :config, :id
+    end
+
+  end
+end

data/lib/jortt/client/invoices.rb

@@ -0,0 +1,50 @@
+# 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
+
+      def initialize(config)
+        @resource = RestClient::Resource.new(
+          "#{config.base_url}/invoices",
+          user: config.app_name,
+          password: config.api_key,
+        )
+      end
+
+      ##
+      # Creates an Invoice using the POST /invoices endpoint.
+      # See https://app.jortt.nl/api-documentatie#factuur-aanmaken
+      #
+      # @example
+      #   Jortt::Client.invoices.create(
+      #     customer_id: 'customer_id', # optional
+      #     delivery_period: '31-12-2015', # optional
+      #     reference: 'reference', # optional
+      #     line_items: [{
+      #       vat: 21, # mandatory, percentage
+      #       amount: 499, # mandatory, ex vat
+      #       quantity: 4, # mandatory
+      #       description: 'Your Thinkas' # mandatory
+      #     }]
+      #   )
+      def create(payload)
+        resource.post(JSON.generate('invoice' => payload)) do |response|
+          JSON.parse(response.body)
+        end
+      end
+
+    private
+
+      attr_reader :resource
+
+    end
+
+  end
+end

data/lib/jortt/client/version.rb

@@ -2,6 +2,6 @@
 module Jortt
   # Define the version of +Jortt::Client+
   class Client
-    VERSION = '3.0.0'
+    VERSION = '4.0.0'
   end
 end

data/spec/jortt/client/customers_spec.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Jortt::Client::Customers do
+  let(:customers) do
+    described_class.new(
+      double(base_url: 'foo', app_name: 'app', api_key: 'secret'),
+    )
+  end
+
+  describe '#create' do
+    let(:request_body) { JSON.generate(customer: {line_items: []}) }
+    let(:response_body) { JSON.generate(customer_id: 'abc') }
+    subject { customers.create(line_items: []) }
+    before do
+      stub_request(:post, 'http://app:secret@foo/customers').
+        with(body: request_body).
+        to_return(status: 200, body: response_body)
+    end
+    it { should eq('customer_id' => 'abc') }
+  end
+
+  describe '#search' do
+    subject { customers.search('terms') }
+    before do
+      stub_request(:get, 'http://app:secret@foo/customers?query=terms').
+        to_return(status: 200, body: '{"customers": []}')
+    end
+    it { should eq('customers' => []) }
+  end
+end

data/spec/jortt/client/invoice_spec.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Jortt::Client::Invoice do
+  let(:invoice) do
+    described_class.new(
+      double(base_url: 'foo', app_name: 'app', api_key: 'secret'),
+      'bar',
+    )
+  end
+
+  describe '#send_invoice' do
+    let(:request_body) { JSON.generate(mail_data: {to: 'ben@jortt.nl'}) }
+    let(:response_body) { JSON.generate(invoice_number: '2016-001') }
+    subject { invoice.send_invoice(mail_data: {to: 'ben@jortt.nl'}) }
+    before do
+      stub_request(:post, 'http://app:secret@foo/invoices/id/bar/send').
+        with(body: request_body).
+        to_return(status: 200, body: response_body)
+    end
+    it { should eq('invoice_number' => '2016-001') }
+  end
+end

data/spec/jortt/client/invoices_spec.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Jortt::Client::Invoices do
+  let(:invoices) do
+    described_class.new(
+      double(base_url: 'foo', app_name: 'app', api_key: 'secret'),
+    )
+  end
+
+  describe '#create' do
+    let(:request_body) { JSON.generate(invoice: {line_items: []}) }
+    let(:response_body) { JSON.generate(invoice_id: 'abc') }
+    subject { invoices.create(line_items: []) }
+    before do
+      stub_request(:post, 'http://app:secret@foo/invoices').
+        with(body: request_body).
+        to_return(status: 200, body: response_body)
+    end
+    it { should eq('invoice_id' => 'abc') }
+  end
+end

data/spec/jortt/client_spec.rb

@@ -28,16 +28,17 @@ describe Jortt::Client do
 
     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 '#invoice' do
+      subject { client.invoice('foo') }
+      it { should be_instance_of(described_class::Invoice) }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jortt
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Bob Forma
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
+date: 2016-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -75,28 +75,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -131,14 +131,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
 description: 
 email:
 - bforma@zilverline.com
@@ -160,11 +160,15 @@ files:
 - jortt.gemspec
 - lib/jortt.rb
 - lib/jortt/client.rb
-- lib/jortt/client/resource.rb
+- lib/jortt/client/customers.rb
+- lib/jortt/client/invoice.rb
+- lib/jortt/client/invoices.rb
 - lib/jortt/client/version.rb
-- spec/freemle_spec.rb
-- spec/jortt/client/resource_spec.rb
+- spec/jortt/client/customers_spec.rb
+- spec/jortt/client/invoice_spec.rb
+- spec/jortt/client/invoices_spec.rb
 - spec/jortt/client_spec.rb
+- spec/jortt_spec.rb
 - spec/spec_helper.rb
 homepage: https://app.jortt.nl/api-documentatie
 licenses:
@@ -191,7 +195,10 @@ signing_key:
 specification_version: 4
 summary: jortt.nl REST API client
 test_files:
-- spec/freemle_spec.rb
-- spec/jortt/client/resource_spec.rb
+- spec/jortt/client/customers_spec.rb
+- spec/jortt/client/invoice_spec.rb
+- spec/jortt/client/invoices_spec.rb
 - spec/jortt/client_spec.rb
+- spec/jortt_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/jortt/client/resource.rb

@@ -1,140 +0,0 @@
-# encoding: UTF-8
-require 'rest-client'
-
-module Jortt # :nodoc:
-  class Client # :nodoc:
-    ##
-    # This class is used by {Jortt::Client} internally.
-    # It wraps rest API calls of a single resource,
-    # so they can easily be used using the client DSL.
-    #
-    # @see { Jortt::Client.customer }
-    class Resource
-
-      # Details needed to connect to this resource, see
-      # +Jortt::Client#initialize+
-      #
-      # @since 1.0.0
-      attr_accessor :config
-
-      # The singular form, posted to and returned when describing
-      # a single member of this resource.
-      #
-      # @since 1.0.0
-      attr_accessor :singular
-
-      # Used to describe multiple members of this resource.
-      #
-      # @since 1.0.0
-      attr_accessor :plural
-
-      # Creates a new resource instance.
-      #
-      # @see { Jortt::Client#new_resource }
-      #
-      # @returns [ Jortt::Client::Resource ] bound to the resource
-      # defined by +singular+ & +plural+
-      #
-      # @since 1.0.0
-      def initialize(config, singular, plural)
-        self.config = config
-        self.singular = singular
-        self.plural = plural
-      end
-
-      # Performs a search on this resource, given a query.
-      #
-      # @example
-      #   customers.search('Zilverline')
-      #
-      # @example
-      #   customers.search('Zilverline') do |response|
-      #     # Roll your own response handler
-      #   end
-      #
-      # @param [ Hash ] query A hash containing the fields to search for.
-      # @param [ Proc ] block A custom response handler.
-      #
-      # @return [ Array<Hash> ] By default, a JSON parsed response body.
-      #
-      # @since 1.0.0
-      def search(query, &block)
-        block = default_handler unless block_given?
-        request.get(params: {query: query}, &block)
-      end
-
-      # Persists a resource on app.jortt.nl, given a payload.
-      #
-      # @example
-      #   customers.create(
-      #     company_name: "Zilverline B.V.",
-      #     address: {
-      #       street: "Cruquiusweg 109 F",
-      #       postal_code: "1019 AG",
-      #       city: "Amsterdam",
-      #       country_code: "NL"
-      #     }
-      #   )
-      #
-      # @example
-      #   customers.create(
-      #     company_name: "Zilverline B.V.",
-      #     address: {
-      #       street: "Cruquiusweg 109 F",
-      #       postal_code: "1019 AG",
-      #       city: "Amsterdam",
-      #       country_code: "NL"
-      #     }
-      #   ) do |response|
-      #     # Roll your own response handler
-      #   end
-      #
-      # @param [ Hash ] payload A hash containing the fields to set.
-      # @param [ Proc ] block A custom response handler.
-      #
-      # @return [ Hash ] By default, a JSON parsed response body.
-      #
-      # @since 1.0.0
-      def create(payload, &block)
-        block = default_handler unless block_given?
-        request.post(json.generate(singular => payload), &block)
-      end
-
-    private
-
-      # Returns a response handler, which parses the response body as JSON.
-      #
-      # @return [ Proc ] Default response handler.
-      #
-      # @since 1.0.0
-      def default_handler
-        proc { |response| json.parse(response.body) }
-      end
-
-      # Returns a new request handler for this resource.
-      #
-      # @return [ RestClient::Resource ] A request handler.
-      #
-      # @since 1.0.0
-      def request
-        RestClient::Resource.new(
-          "#{config.base_url}/#{plural}",
-          user: config.app_name,
-          password: config.api_key,
-        )
-      end
-
-      # Returns the JSON library used in request/default-response handling.
-      #
-      # @return [ Class ] A JSON library.
-      #
-      # @since 1.0.0
-      def json
-        return @json if @json
-        require 'json'
-        @json = JSON
-      end
-
-    end
-  end
-end

data/spec/jortt/client/resource_spec.rb

@@ -1,31 +0,0 @@
-# encoding: UTF-8
-require 'spec_helper'
-
-describe Jortt::Client::Resource do
-  let(:resource) do
-    described_class.new(
-      double('client', base_url: 'foo', app_name: 'app', api_key: 'secret'),
-      :person,
-      :people,
-    )
-  end
-
-  describe '#search' do
-    subject { resource.search('terms') }
-    before do
-      stub_request(:get, 'http://app:secret@foo/people?query=terms').
-        to_return(status: 200, body: '{"people": []}')
-    end
-    it { should eq('people' => []) }
-  end
-
-  describe '#create' do
-    subject { resource.create(foo: :bar) }
-    before do
-      stub_request(:post, 'http://app:secret@foo/people').
-        with(body: '{"person":{"foo":"bar"}}').
-        to_return(status: 201, body: '{"person_id": "123"}')
-    end
-    it { should eq('person_id' => '123') }
-  end
-end