fs_api 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8378c1eb029c90743d0468a0d328bd30af5fd4ad
-  data.tar.gz: b2273c9e8c5a425cb111cc6097eb0e5f00eb6042
+  metadata.gz: 6a52ab0e49975acfd0375aceb668af719979dc70
+  data.tar.gz: e91f6223ec78f1a2c042693135d70101feb54d96
 SHA512:
-  metadata.gz: b9ceb21d331970ae0b1f9c03ab3d0715b6919dd987cf57e66a6adcc5e2a03efb7876e3f5263ffe85c752e60595b93a0d196e648a2ea346e0cb6c146ff4491200
-  data.tar.gz: ec0eb197c15885f757c41f79bcfd0f295b7ec0b77f1d129123980afae67c10d35107eea35dd8873c6d93a6fce1ebc5f705e699ada9c25921a027655bddcd6727
+  metadata.gz: 8f3a459ffa206839f3fc45ee9b9f43fd29c9c397b44a3f9cdb44c0cc9936847edad964c154f2a09a8fa5e7d5bab30bbb7a977cec7e51ce9bf88680ee7c5dec32
+  data.tar.gz: d788390a2bc06be9b0404e3b0cf94799080e2aa93d63b04b5049a0be5682c3cc03ef43dd461692eae12992c55e902813fbecea2272dc0c27d656121855de4019

data/README.md

@@ -61,13 +61,19 @@ invoice.errors
 # Delete an invoice
 api_client.invoices.delete(invoice)
 
+# Search in all fields of invoices
+api_client.invoices.search('john')
+
+# Search in city field of invoices
+api_client.invoices.search(city: 'john')
 ```
 
 ## Todo
 * Handle rate limiting
-* Implement saved invoices resource
-* Implement search
-* Implement invoice payment registration
+* Refactor base service so services can choose to implement parts
+* ~~Implement saved invoices resource~~
+* ~~Implement search~~
+* ~~Implement invoice payment registration~~
 
 ## Contributing
 

data/fs_api.gemspec

@@ -9,13 +9,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Maarten van Vliet"]
   spec.email         = ["maartenvanvliet@gmail.com"]
   spec.summary       = %q{Ruby-Api library for factuursturen.nl }
-  spec.description   = %q{Ruby-Api library for factuursturen.nl. As of yet incomplete support for the api, but functional }
-  spec.homepage      = ""
+  spec.description   = %q{Ruby-Api library for factuursturen.nl }
+  spec.homepage      = "https://github.com/maartenvanvliet/fs_api"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "rspec", "~> 3.2"

data/lib/fs_api/client.rb

@@ -1,86 +1,88 @@
-class FsApi::Client
-  attr_reader :username, :password, :_last_response
-  attr_accessor :errors
+module FsApi
+  class Client
+    attr_reader :username, :password, :_last_response
+    attr_accessor :errors
 
-  def initialize(username, password)
-    @username = username
-    @password = password
-  end
-
-  def base_url
-    "https://www.factuursturen.nl:443/api/v1"
-  end
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
 
-  def http
-    @http ||= begin
-      uri = uri_for_path(base_url)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = uri.scheme == 'https'
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      http
+    def base_url
+      "https://www.factuursturen.nl:443/api/v1"
     end
-  end
 
-  def headers
-    {
-      'Accept' => 'application/json',
-      'Content-Type' => 'application/json'
-    }
-  end
+    def http
+      @http ||= begin
+        uri = uri_for_path(base_url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == 'https'
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http
+      end
+    end
 
-  def uri_for_path(path)
-    URI.parse(File.join(base_url, path))
-  end
+    def headers
+      {
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+    end
 
-  def get(path, headers={})
-    uri = uri_for_path(path)
-    http = Net::HTTP::Get.new(uri.request_uri, self.headers.merge(headers))
-    perform(http)
-  end
+    def uri_for_path(path)
+      URI.parse(File.join(base_url, path))
+    end
 
-  def put(path, body=nil, headers={})
-    uri = uri_for_path(path)
-    http = Net::HTTP::Put.new(uri.request_uri, self.headers.merge(headers))
-    http.body = body
-    perform(http)
-  end
+    def get(path, headers={})
+      uri = uri_for_path(path)
+      http = Net::HTTP::Get.new(uri.request_uri, self.headers.merge(headers))
+      perform(http)
+    end
 
-  def post(path, body=nil, headers={})
-    uri = uri_for_path(path)
-    http = Net::HTTP::Post.new(uri.request_uri, self.headers.merge(headers))
-    http.body = body
-    perform(http)
-  end
+    def put(path, body=nil, headers={})
+      uri = uri_for_path(path)
+      http = Net::HTTP::Put.new(uri.request_uri, self.headers.merge(headers))
+      http.body = body
+      perform(http)
+    end
 
-  def delete(path, headers={})
-    uri = uri_for_path(path)
-    http = Net::HTTP::Delete.new(uri.request_uri, self.headers.merge(headers))
-    perform(http)
-  end
+    def post(path, body=nil, headers={})
+      uri = uri_for_path(path)
+      http = Net::HTTP::Post.new(uri.request_uri, self.headers.merge(headers))
+      http.body = body
+      perform(http)
+    end
 
-  def invoices
-    FsApi::Service::Invoice.new(self)
-  end
+    def delete(path, headers={})
+      uri = uri_for_path(path)
+      http = Net::HTTP::Delete.new(uri.request_uri, self.headers.merge(headers))
+      perform(http)
+    end
 
-  def clients
-    FsApi::Service::Client.new(self)
-  end
+    def invoices
+      FsApi::Service::Invoice.new(self)
+    end
 
-  def products
-    FsApi::Service::Product.new(self)
-  end
+    def clients
+      FsApi::Service::Client.new(self)
+    end
 
-  def invoices_payments
-    FsApi::Service::InvoicesPayment.new(self)
-  end
+    def products
+      FsApi::Service::Product.new(self)
+    end
 
-  def saved_invoices
-    FsApi::Service::InvoicesSaved.new(self)
-  end
+    def invoices_payments
+      FsApi::Service::InvoicesPayment.new(self)
+    end
 
-  private
-    def perform(request)
-      request.basic_auth username, password
-      @_last_response = http.request(request)
+    def saved_invoices
+      FsApi::Service::InvoicesSaved.new(self)
     end
+
+    private
+      def perform(request)
+        request.basic_auth username, password
+        @_last_response = http.request(request)
+      end
+  end
 end

data/lib/fs_api/service/base_service.rb

@@ -70,8 +70,10 @@ module FsApi
         true
       end
 
-      def all
-        if response = api_client.get(path)
+      def all(params = {})
+        query_path = params.empty? ? path : "#{path}?#{URI.encode_www_form(params)}"
+
+        if response = api_client.get(query_path)
           if response.code.to_i == success_status_code
             JSON.parse(response.body).map do |attributes|
               collection_class.new(attributes.merge(from_api: true))

data/lib/fs_api/version.rb

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

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

@@ -16,6 +16,15 @@ describe FsApi::Service::Invoice do
       expect(invoices.first.invoicenr).to eq 'F20150001'
     end
 
+    it "retrieves all invoices with filter" do
+      stub_request(:get, "https://username:api_key@www.factuursturen.nl/api/v1/invoices?filter=overdue").to_return(body: [json_response(:invoice)].to_json )
+
+      invoices = service.all(filter: :overdue)
+
+      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/20150001").to_return(body: { 'invoice' => json_response(:invoice)}.to_json )
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fs_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - Maarten van Vliet
@@ -38,8 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
-description: 'Ruby-Api library for factuursturen.nl. As of yet incomplete support
-  for the api, but functional '
+description: 'Ruby-Api library for factuursturen.nl '
 email:
 - maartenvanvliet@gmail.com
 executables: []
@@ -80,7 +79,7 @@ files:
 - spec/support/responses/client.json
 - spec/support/responses/invoice.json
 - spec/support/responses/product.json
-homepage: ''
+homepage: https://github.com/maartenvanvliet/fs_api
 licenses:
 - MIT
 metadata: {}