fs_api 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca3bb7dc2c987a120ce68ac01b80eab0b7b3019a
-  data.tar.gz: 970a45f66ea754a021d2849d57dfd34ee423a40a
+  metadata.gz: 8378c1eb029c90743d0468a0d328bd30af5fd4ad
+  data.tar.gz: b2273c9e8c5a425cb111cc6097eb0e5f00eb6042
 SHA512:
-  metadata.gz: c639cc53020597dfc81fcbc366aacd5d73dd1ae213ef715c7a73355f15004f41e3ef0080a191f43dc6836f91cb8d630bb888d8df806f28f22a0e4b70237e0379
-  data.tar.gz: 89b839e992d6671db8359e023750600202456a1dfd24e44792f1f490913778ce77a3cd18c49a55ecd7f60ea72c27a699972c47d45a0277f3fbab31a082e53099
+  metadata.gz: b9ceb21d331970ae0b1f9c03ab3d0715b6919dd987cf57e66a6adcc5e2a03efb7876e3f5263ffe85c752e60595b93a0d196e648a2ea346e0cb6c146ff4491200
+  data.tar.gz: ec0eb197c15885f757c41f79bcfd0f295b7ec0b77f1d129123980afae67c10d35107eea35dd8873c6d93a6fce1ebc5f705e699ada9c25921a027655bddcd6727

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.1.0
+  - 2.2.0
+script: bundle exec rspec

data/README.md

@@ -1,5 +1,5 @@
 # FsApi
-
+[![Build Status](https://travis-ci.org/maartenvanvliet/fs_api.svg)](https://travis-ci.org/maartenvanvliet/fs_api)
 Gem to interface with the [factuursturen.nl](https://www.factuursturen.nl/?a=1552)
 invoicing API
 
@@ -42,6 +42,9 @@ api_client.clients.all
 # Retrieve all invoices
 api_client.invoices.all
 
+# Find an invoice
+api_client.invoices.find(invoice_number)
+
 # Create an invoice
 invoice = api_client.invoices.build({clientnr: '1'})
 api_client.invoices.save(invoice)
@@ -55,8 +58,8 @@ api_client.invoices.save(invoice)
 # Has the errors of the last api operation
 invoice.errors
 
-# Find an invoice
-api_client.invoices.find(invoice_number)
+# Delete an invoice
+api_client.invoices.delete(invoice)
 
 ```
 

data/lib/fs_api/client.rb

@@ -70,6 +70,14 @@ class FsApi::Client
     FsApi::Service::Product.new(self)
   end
 
+  def invoices_payments
+    FsApi::Service::InvoicesPayment.new(self)
+  end
+
+  def saved_invoices
+    FsApi::Service::InvoicesSaved.new(self)
+  end
+
   private
     def perform(request)
       request.basic_auth username, password

data/lib/fs_api/resource/client.rb

@@ -53,6 +53,6 @@ class FsApi::Resource::Client
     timestamp
   )
   def path
-    "/clients/#{clientnr}"
+    persisted? ? "/#{clientnr}" : ""
   end
 end

data/lib/fs_api/resource/invoice.rb

@@ -40,15 +40,28 @@ class FsApi::Resource::Invoice
     action
     savename
     sendmethod
+    name
+    profile_name
+    datesaved
+    tax_type
+    tax_shifted
   )
 
   has_datetime_attributes %w(
     duedate
+    datesaved
+  )
+
+  has_boolean_attributes %w(
+    tax_shifted
   )
   def path
-    "/invoices/#{id}"
+    persisted? ? "/#{id}" : ""
   end
 
+  def saved?
+    !datesaved.nil? && datesaved != ''
+  end
 
   # invoices cannot be updated
   def updateable?

data/lib/fs_api/resource/invoices_payment.rb

@@ -0,0 +1,20 @@
+class FsApi::Resource::InvoicesPayment
+  include FsApi::Resource
+  extend FsApi::Resource::ClassMethods
+
+  has_attributes %i(
+    id
+    invoicenr
+    date
+    amount
+  )
+
+  def remote_id
+    id || invoicenr
+  end
+
+  def path
+    "/#{remote_id}"
+  end
+
+end

data/lib/fs_api/resource/product.rb

@@ -12,7 +12,7 @@ class FsApi::Resource::Product
   )
 
   def path
-    "/products/#{id}"
+    persisted? ? "/#{id}" : ""
   end
 
 end

data/lib/fs_api/service/base_service.rb

@@ -20,6 +20,10 @@ module FsApi
         "/#{resource_type_plural}"
       end
 
+      def instance_path(instance)
+        [path, instance.path].join
+      end
+
       def find(id)
         if response = @api_client.get([path,id].join('/'))
           if response.code.to_i == success_status_code
@@ -41,7 +45,7 @@ module FsApi
       end
 
       def delete(instance)
-        @api_client.delete(instance.path)
+        @api_client.delete(instance_path(instance))
         if api_client._last_response.code.to_i != success_status_code
           instance.errors = api_client._last_response.body
           return false
@@ -51,13 +55,13 @@ module FsApi
       def save(instance)
         return false if instance.persisted? && !instance.updateable?
         if instance.persisted?
-          @api_client.put(instance.path, instance.to_json)
+          @api_client.put(instance_path(instance), instance.to_json)
           if api_client._last_response.code.to_i != success_status_code
             instance.errors = api_client._last_response
             return false
           end
         else
-          @api_client.post(path, instance.to_json)
+          @api_client.post(instance_path(instance), instance.to_json)
           if api_client._last_response.code.to_i != create_success_status_code
             instance.errors = api_client._last_response.body
             return false

data/lib/fs_api/service/client.rb

@@ -1,6 +1,8 @@
 module FsApi
   module Service
     class Client < BaseService
+      include FsApi::Service::Searchable
+
       def collection_class
         FsApi::Resource::Client
       end

data/lib/fs_api/service/invoice.rb

@@ -1,6 +1,8 @@
 module FsApi
   module Service
     class Invoice < BaseService
+      include FsApi::Service::Searchable
+
       def collection_class
         FsApi::Resource::Invoice
       end

data/lib/fs_api/service/invoices_payment.rb

@@ -0,0 +1,13 @@
+module FsApi
+  module Service
+    class InvoicesPayment < BaseService
+      def collection_class
+        FsApi::Resource::InvoicesPayment
+      end
+
+      def resource_type_plural
+        "invoices_payment"
+      end
+    end
+  end
+end

data/lib/fs_api/service/invoices_saved.rb

@@ -0,0 +1,17 @@
+module FsApi
+  module Service
+    class InvoicesSaved < BaseService
+      def collection_class
+        FsApi::Resource::Invoice
+      end
+
+      def resource_type_plural
+        "invoices_saved"
+      end
+
+      def resource_type
+        'invoice'
+      end
+    end
+  end
+end

data/lib/fs_api/service/product.rb

@@ -1,6 +1,8 @@
 module FsApi
   module Service
     class Product < BaseService
+      include FsApi::Service::Searchable
+
       def collection_class
         FsApi::Resource::Product
       end

data/lib/fs_api/service/searchable.rb

@@ -0,0 +1,24 @@
+module FsApi
+  module Service
+    module Searchable
+      def search(options)
+        if options.is_a? String
+          field = 'all'
+          value = options
+        elsif options.is_a? Hash
+          field, value = options.first
+        end
+
+        search_path = ["search#{path}", field, value].join('/')
+
+        if response = api_client.get(search_path)
+          if response.code.to_i == success_status_code
+            JSON.parse(response.body).map do |attributes|
+              collection_class.new(attributes.merge(from_api: true))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fs_api/version.rb

@@ -1,3 +1,3 @@
 module FsApi
-  VERSION = "0.7.0"
+  VERSION = "1.0.0"
 end

data/lib/fs_api.rb

@@ -1,13 +1,17 @@
 require 'json'
 
 require "fs_api/client"
+require "fs_api/service/searchable"
 require "fs_api/service/base_service"
 require "fs_api/service/client"
 require "fs_api/service/invoice"
+require "fs_api/service/invoices_payment"
+require "fs_api/service/invoices_saved"
 require "fs_api/service/product"
 require "fs_api/resource/resource"
 require "fs_api/resource/client"
 require "fs_api/resource/invoice"
+require "fs_api/resource/invoices_payment"
 require "fs_api/resource/product"
 
 module FsApi

data/spec/lib/fs_api/service/client_spec.rb

@@ -53,4 +53,26 @@ describe FsApi::Service::Client do
       service.save(client)
     end
   end
+
+  describe "search" do
+    it "searches in all fields" do
+      stub_request(:get, "https://username:api_key@www.factuursturen.nl/api/v1/search/clients/all/john").
+        to_return(body: [json_response(:client)].to_json )
+
+      clients = service.search('john')
+
+      expect(clients.size).to eq 1
+      expect(clients.first.clientnr).to eq '1'
+    end
+
+    it "searches in a fields" do
+      stub_request(:get, "https://username:api_key@www.factuursturen.nl/api/v1/search/clients/city/john").
+        to_return(body: [json_response(:client)].to_json )
+
+      clients = service.search(city: 'john')
+
+      expect(clients.size).to eq 1
+      expect(clients.first.clientnr).to eq '1'
+    end
+  end
 end

data/spec/lib/fs_api/service/invoice_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe FsApi::Service::Client do
+describe FsApi::Service::Invoice do
 
   let(:api_client) { FsApi::Client.new('username', 'api_key') }
   let(:service) { FsApi::Service::Invoice.new(api_client) }
@@ -43,4 +43,26 @@ describe FsApi::Service::Client do
       expect(invoice.invoicenr).to eq 2
     end
   end
+
+  describe "search" do
+    it "searches in all fields" do
+      stub_request(:get, "https://username:api_key@www.factuursturen.nl/api/v1/search/invoices/all/john").
+        to_return(body: [json_response(:invoice)].to_json )
+
+      invoices = service.search('john')
+
+      expect(invoices.size).to eq 1
+      expect(invoices.first.invoicenr).to eq 'F20150001'
+    end
+
+    it "searches in a fields" do
+      stub_request(:get, "https://username:api_key@www.factuursturen.nl/api/v1/search/invoices/city/john").
+        to_return(body: [json_response(:invoice)].to_json )
+
+      invoices = service.search(city: 'john')
+
+      expect(invoices.size).to eq 1
+      expect(invoices.first.invoicenr).to eq 'F20150001'
+    end
+  end
 end

data/spec/lib/fs_api/service/invoices_payment_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe FsApi::Service::InvoicesPayment do
+
+  let(:api_client) { FsApi::Client.new('username', 'api_key') }
+  let(:service) { FsApi::Service::InvoicesPayment.new(api_client) }
+  let(:invoice) { FsApi::Resource::Invoice.new(json_response(:invoice).merge('from_api' => true)) }
+
+  describe "creation" do
+    it "creates a invoice" do
+      stub_request(:post, "https://username:api_key@www.factuursturen.nl/api/v1/invoices_payment/2").
+         to_return(status: 201)
+
+
+      response = service.create({'id' => 2, date: Time.now, amount: 'full'})
+      expect(response.amount).to eq 'full'
+      expect(response.errors).to be_nil
+    end
+  end
+end

data/spec/lib/fs_api/service/invoices_saved_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe FsApi::Service::InvoicesSaved do
+
+  let(:api_client) { FsApi::Client.new('username', 'api_key') }
+  let(:service) { FsApi::Service::InvoicesSaved.new(api_client) }
+  let(:invoice) { FsApi::Resource::Invoice.new(json_response(:invoice).merge('from_api' => true)) }
+
+  describe "retrieval" do
+    it "retrieves all invoices" do
+      stub_request(:get, "https://username:api_key@www.factuursturen.nl/api/v1/invoices_saved").to_return(body: [json_response(:invoice)].to_json )
+
+      invoices = service.all
+
+      expect(invoices.size).to eq 1
+      expect(invoices.first.invoicenr).to eq 'F20150001'
+    end
+
+    it "retrieves a invoice" do
+      stub_request(:get, "https://username:api_key@www.factuursturen.nl/api/v1/invoices_saved/20150001").to_return(body: { 'invoice' => json_response(:invoice)}.to_json )
+
+      invoice = service.find('20150001')
+
+      expect(invoice.invoicenr).to eq 'F20150001'
+    end
+  end
+
+  describe "deletion" do
+    it "deletes a invoice" do
+      stub_request(:delete, "https://username:api_key@www.factuursturen.nl/api/v1/invoices_saved/20150001")
+
+      service.delete(invoice)
+    end
+  end
+end

data/spec/lib/fs_api/service/product_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe FsApi::Service::Client do
+describe FsApi::Service::Product do
   let(:api_client) { FsApi::Client.new('username', 'api_key') }
 
   let(:service) { FsApi::Service::Product.new(api_client) }
@@ -52,4 +52,26 @@ describe FsApi::Service::Client do
       service.save(product)
     end
   end
+
+  describe "search" do
+    it "searches in all fields" do
+      stub_request(:get, "https://username:api_key@www.factuursturen.nl/api/v1/search/products/all/john").
+        to_return(body: [json_response(:product)].to_json )
+
+      products = service.search('john')
+
+      expect(products.size).to eq 1
+      expect(products.first.code).to eq "product code"
+    end
+
+    it "searches in a fields" do
+      stub_request(:get, "https://username:api_key@www.factuursturen.nl/api/v1/search/products/city/john").
+        to_return(body: [json_response(:product)].to_json )
+
+      products = service.search(city: 'john')
+
+      expect(products.size).to eq 1
+      expect(products.first.code).to eq "product code"
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fs_api
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Maarten van Vliet
@@ -49,6 +49,7 @@ files:
 - ".gitignore"
 - ".kick"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -57,16 +58,22 @@ files:
 - lib/fs_api/client.rb
 - lib/fs_api/resource/client.rb
 - lib/fs_api/resource/invoice.rb
+- lib/fs_api/resource/invoices_payment.rb
 - lib/fs_api/resource/product.rb
 - lib/fs_api/resource/resource.rb
 - lib/fs_api/service/base_service.rb
 - lib/fs_api/service/client.rb
 - lib/fs_api/service/invoice.rb
+- lib/fs_api/service/invoices_payment.rb
+- lib/fs_api/service/invoices_saved.rb
 - lib/fs_api/service/product.rb
+- lib/fs_api/service/searchable.rb
 - lib/fs_api/version.rb
 - spec/lib/fs_api/client_spec.rb
 - spec/lib/fs_api/service/client_spec.rb
 - spec/lib/fs_api/service/invoice_spec.rb
+- spec/lib/fs_api/service/invoices_payment_spec.rb
+- spec/lib/fs_api/service/invoices_saved_spec.rb
 - spec/lib/fs_api/service/product_spec.rb
 - spec/spec_helper.rb
 - spec/support/json_response_helper.rb
@@ -101,6 +108,8 @@ test_files:
 - spec/lib/fs_api/client_spec.rb
 - spec/lib/fs_api/service/client_spec.rb
 - spec/lib/fs_api/service/invoice_spec.rb
+- spec/lib/fs_api/service/invoices_payment_spec.rb
+- spec/lib/fs_api/service/invoices_saved_spec.rb
 - spec/lib/fs_api/service/product_spec.rb
 - spec/spec_helper.rb
 - spec/support/json_response_helper.rb