jortt 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fb355ea7092b575b6bea7c989535898af0aea62
-  data.tar.gz: 62f389c052bac3710d7abd9672f1c1b86cb2cfb7
+  metadata.gz: 0888e091fcb1156dc527b9cd815d0629b60e411e
+  data.tar.gz: e254535aeb502a1c3358df8b0af23eb782b0691e
 SHA512:
-  metadata.gz: cbcb1bfc7f77b82498ae2c08feb079a95e965b833774b836e77d6866ffe563cbc5637eaeade9e68a42ee7374b64996dc08f370ee312be48009c4d465d20805d9
-  data.tar.gz: 94009c1f00dedb5bc269f6496ed20859f998ce0928f331f34dee9ddd78c664ede83279ca68417ca43a0ded29aee277775980df4ace69dd2cc82d1a962e6b857b
+  metadata.gz: 11c08eb54b2d3b3f844e17df78c2e580bdb2b036a0d6322624ff352e8f5baf8e8c58cfd6db1340c209872e8513f21ae881216aeb65b6ef69d34aeeaa1220f667
+  data.tar.gz: 968c299166179d4d3c43ac37ef500a547c3f9ceea81db998e291dd6bf63593bda65fda12a2252bdbf75dd24bc0cd566cf2f4c93d5c6f3417a87de0f33fec7aaa

data/README.md

@@ -27,6 +27,30 @@ jortt = Jortt.client(
 
 ### 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:
 ```ruby
 [{
@@ -38,6 +62,7 @@ Searching customers (`jortt.customers.search('Jortt')`) returns:
     country_code: "NL"
   }
 },
+{
   company_name: 'ttroj',
   address: {
     street: "Jorttweg",
@@ -62,13 +87,39 @@ jortt.customers.create(
 ```
 
 ### Invoices
+Get invoices by ID (`jortt.invoices.get('934d59dd-76f6-4716-9e0f-82a618e1be21')`) 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,
+    ...
+  }
+  ...
+}
+```
+
+
 Searching invoices (`jortt.invoices.search('201606-012')`) returns:
 ```ruby
 [
   {
     "invoice_id": "934d59dd-76f6-4716-9e0f-82a618e1be21",
     "recipient": {
-      "company_name": "Zilverine B.V.",
+      "company_name": "Zilverline B.V.",
       "attn": null,
       "address": {
         "street": "Cruquisweg 109F",
@@ -188,3 +239,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/jortt.gemspec

@@ -27,7 +27,7 @@ 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'
 
   spec.add_development_dependency 'bundler', '~> 1.0'
   spec.add_development_dependency 'codecov', '~> 0.1'

data/lib/jortt/client/customers.rb

@@ -18,6 +18,18 @@ module Jortt # :nodoc:
         )
       end
 
+      ##
+      # Returns all customers using the GET /customers/all endpoint.
+      #
+      # @example
+      #   Jortt::Client.customers.all(page: 3, per_page: 10)
+      #
+      def all(page: 1, per_page: 50)
+        resource['all'].get(params: {page: page, per_page: per_page}) do |res|
+          JSON.parse(res.body)
+        end
+      end
+
       ##
       # Creates a Customer using the POST /customers endpoint.
       # See https://app.jortt.nl/api-documentatie#klant-aanmaken

data/lib/jortt/client/invoices.rb

@@ -40,8 +40,14 @@ module Jortt # :nodoc:
         end
       end
 
+      def get(id)
+        resource["id/#{id}"].get do |response|
+          JSON.parse(response.body)
+        end
+      end
+
       def search(query)
-        resource["search"].get(params: {query: query}) do |response|
+        resource['search'].get(params: {query: query}) do |response|
           JSON.parse(response.body)
         end
       end

data/lib/jortt/client/version.rb

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

data/spec/jortt/client/customers_spec.rb

@@ -8,6 +8,34 @@ describe Jortt::Client::Customers do
     )
   end
 
+  describe '#all' do
+    context 'without params' do
+      subject { customers.all }
+
+      before do
+        url = 'http://app:secret@foo/customers/all?page=1&per_page=50'
+        stub_request(:get, url).
+          to_return(status: 200, body: '{"customers": ["foo"]}')
+      end
+
+      it { should eq('customers' => ['foo']) }
+    end
+
+    context 'with params' do
+      subject { customers.all(page: page, per_page: per_page) }
+      let(:page) { 3 }
+      let(:per_page) { 25 }
+
+      before do
+        url = 'http://app:secret@foo/customers/all?page=3&per_page=25'
+        stub_request(:get, url).
+          to_return(status: 200, body: '{"customers": ["bar"]}')
+      end
+
+      it { should eq('customers' => ['bar']) }
+    end
+  end
+
   describe '#create' do
     let(:request_body) { JSON.generate(customer: {line_items: []}) }
     let(:response_body) { JSON.generate(customer_id: 'abc') }

data/spec/jortt/client/invoices_spec.rb

@@ -20,6 +20,15 @@ describe Jortt::Client::Invoices do
     it { should eq('invoice_id' => 'abc') }
   end
 
+  describe '#get' do
+    subject { invoices.get('foo') }
+    before do
+      stub_request(:get, 'http://app:secret@foo/invoices/id/foo').
+        to_return(status: 200, body: '{"id": "foo"}')
+    end
+    it { should eq('id' => 'foo') }
+  end
+
   describe '#search' do
     subject { invoices.search('terms') }
     before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jortt
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Bob Forma
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-08 00:00:00.000000000 Z
+date: 2017-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -201,4 +201,3 @@ test_files:
 - spec/jortt/client_spec.rb
 - spec/jortt_spec.rb
 - spec/spec_helper.rb
-has_rdoc: