fakturoid 0.2.0 → 0.4.0

data/lib/fakturoid/client/invoice.rb

@@ -1,22 +1,26 @@
+# frozen_string_literal: true
+
 module Fakturoid
   module Client
     class Invoice < Fakturoid::Api
+      INDEX_PARAMS = [:page, :since, :until, :updated_since, :updated_until, :number, :status, :subject_id, :custom_id].freeze
+
       def self.all(params = {})
-        request_params = permit_params(params, :page, :since, :updated_since, :number, :status, :subject_id) || {}
+        request_params = permit_params(params, *INDEX_PARAMS) || {}
 
-        get_request('invoices.json', request_params: request_params)
+        get_request("invoices.json", request_params: request_params)
       end
 
       def self.regular(params = {})
-        request_params = permit_params(params, :page, :since, :updated_since, :number, :status, :subject_id) || {}
+        request_params = permit_params(params, *INDEX_PARAMS) || {}
 
-        get_request('invoices/regular.json', request_params: request_params)
+        get_request("invoices/regular.json", request_params: request_params)
       end
 
       def self.proforma(params = {})
-        request_params = permit_params(params, :page, :since, :updated_since, :number, :status, :subject_id) || {}
+        request_params = permit_params(params, *INDEX_PARAMS) || {}
 
-        get_request('invoices/proforma.json', request_params: request_params)
+        get_request("invoices/proforma.json", request_params: request_params)
       end
 
       def self.find(id)
@@ -24,18 +28,22 @@ module Fakturoid
         get_request("invoices/#{id}.json")
       end
 
-      def self.search(query)
+      def self.search(query, params = {})
         validate_search_query(query)
-        get_request('invoices/search.json', request_params: { query: query })
+
+        request_params = permit_params(params, :page)
+        request_params[:query] = query
+
+        get_request("invoices/search.json", request_params: request_params)
       end
 
       def self.download_pdf(id)
         validate_numerical_id(id)
-        get_request("invoices/#{id}/download.pdf", headers: { content_type: 'application/pdf' })
+        get_request("invoices/#{id}/download.pdf", headers: { content_type: "application/pdf" })
       end
 
       def self.fire(id, event, params = {})
-        request_params = permit_params(params, :paid_at) || {}
+        request_params = permit_params(params, :paid_at, :paid_amount, :variable_symbol, :bank_account_id) || {}
         request_params[:event] = event
 
         validate_numerical_id(id)
@@ -48,7 +56,7 @@ module Fakturoid
       end
 
       def self.create(payload = {})
-        post_request('invoices.json', payload: payload)
+        post_request("invoices.json", payload: payload)
       end
 
       def self.update(id, payload = {})

data/lib/fakturoid/client/number_format.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Client
+    class NumberFormat < Fakturoid::Api
+      def self.invoices
+        get_request("number_formats/invoices.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/client/subject.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Fakturoid
   module Client
     class Subject < Fakturoid::Api
       def self.all(params = {})
         request_params = permit_params(params, :page, :since, :updated_since, :custom_id) || {}
 
-        get_request('subjects.json', request_params: request_params)
+        get_request("subjects.json", request_params: request_params)
       end
 
       def self.find(id)
@@ -12,13 +14,17 @@ module Fakturoid
         get_request("subjects/#{id}.json")
       end
 
-      def self.search(query)
+      def self.search(query, params = {})
         validate_search_query(query)
-        get_request('subjects/search.json', request_params: { query: query })
+
+        request_params = permit_params(params, :page)
+        request_params[:query] = query
+
+        get_request("subjects/search.json", request_params: request_params)
       end
 
       def self.create(payload = {})
-        post_request('subjects.json', payload: payload)
+        post_request("subjects.json", payload: payload)
       end
 
       def self.update(id, payload = {})

data/lib/fakturoid/client/todo.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Fakturoid
   module Client
     class Todo < Fakturoid::Api
       def self.all(params = {})
         request_params = permit_params(params, :page, :since) || {}
 
-        get_request('todos.json', request_params: request_params)
+        get_request("todos.json", request_params: request_params)
       end
 
       def self.toggle_completion(id)

data/lib/fakturoid/client/user.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Fakturoid
   module Client
     class User < Api
       def self.current
-        get_request('user.json', url: Fakturoid::Api.config.endpoint_without_account)
+        get_request("user.json", url: Fakturoid::Api.config.endpoint_without_account)
       end
 
       def self.find(id)
@@ -11,7 +13,7 @@ module Fakturoid
       end
 
       def self.all
-        get_request('users.json')
+        get_request("users.json")
       end
     end
   end

data/lib/fakturoid/client.rb

@@ -1,9 +1,12 @@
-require 'fakturoid/client/account'
-require 'fakturoid/client/bank_account'
-require 'fakturoid/client/user'
-require 'fakturoid/client/subject'
-require 'fakturoid/client/invoice'
-require 'fakturoid/client/expense'
-require 'fakturoid/client/generator'
-require 'fakturoid/client/event'
-require 'fakturoid/client/todo'
+# frozen_string_literal: true
+
+require "fakturoid/client/account"
+require "fakturoid/client/bank_account"
+require "fakturoid/client/number_format"
+require "fakturoid/client/user"
+require "fakturoid/client/subject"
+require "fakturoid/client/invoice"
+require "fakturoid/client/expense"
+require "fakturoid/client/generator"
+require "fakturoid/client/event"
+require "fakturoid/client/todo"

data/lib/fakturoid/config.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module Fakturoid
   class Config
     attr_accessor :email, :api_key, :account
     attr_writer :user_agent
 
-    ENDPOINT = 'https://app.fakturoid.cz/api/v2'
+    ENDPOINT = "https://app.fakturoid.cz/api/v2"
 
     def initialize(&_block)
       yield self
     end
 
     def user_agent
-      if @user_agent.nil? || @user_agent.empty?
+      if !defined?(@user_agent) || @user_agent.nil? || @user_agent.empty?
         "Fakturoid ruby gem (#{email})"
       else
         @user_agent
@@ -24,5 +26,15 @@ module Fakturoid
     def endpoint_without_account
       ENDPOINT
     end
+
+    def faraday_v1?
+      major_faraday_version == "1"
+    end
+
+  private
+
+    def major_faraday_version
+      @major_faraday_version ||= Faraday::VERSION.split(".").first
+    end
   end
 end

data/lib/fakturoid/connection.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Fakturoid
   module Connection
+    DEFAULT_CONTENT_TYPE = "application/json"
 
     def default_options(options = {})
-      content_type = options[:headers] && options[:headers][:content_type]
       {
         headers: {
-          content_type: content_type || 'application/json',
+          content_type: options.dig(:headers, :content_type) || DEFAULT_CONTENT_TYPE,
           user_agent: Fakturoid::Api.config.user_agent
         },
         url: options[:url] || Fakturoid::Api.config.endpoint
@@ -14,7 +16,13 @@ module Fakturoid
 
     def connection(options = {})
       @connection = Faraday.new default_options(options)
-      @connection.basic_auth(Fakturoid::Api.config.email, Fakturoid::Api.config.api_key)
+
+      # https://lostisland.github.io/faraday/middleware/authentication
+      if Fakturoid::Api.config.faraday_v1?
+        @connection.request :basic_auth, Fakturoid::Api.config.email, Fakturoid::Api.config.api_key
+      else
+        @connection.request :authorization, :basic, Fakturoid::Api.config.email, Fakturoid::Api.config.api_key
+      end
 
       @connection
     end

data/lib/fakturoid/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fakturoid
   class Railtie < Rails::Railtie
   end

data/lib/fakturoid/request.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Fakturoid
   class Request
     include Connection
 
     attr_reader :method, :path, :caller
-    HTTP_METHODS = [:get, :post, :patch, :delete]
+
+    HTTP_METHODS = [:get, :post, :patch, :delete].freeze
 
     def initialize(method, path, caller)
       @method = method
@@ -19,6 +22,7 @@ module Fakturoid
       http_connection = connection(params)
       response = http_connection.send(method) do |req|
         req.url path, request_params
+        req.headers["X-Client-Env"] = "Ruby #{RUBY_VERSION}"
         req.body = MultiJson.dump(params[:payload]) if params.key?(:payload)
       end
       Response.new(response, caller, method)

data/lib/fakturoid/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fakturoid
   class Response
     attr_reader :response, :caller, :env, :body, :request_method
@@ -15,11 +17,11 @@ module Fakturoid
     end
 
     def status_code
-      env['status']
+      env["status"]
     end
 
     def json?
-      env.request_headers['Content-Type'] == 'application/json'
+      env.request_headers["Content-Type"] == "application/json"
     end
 
     def headers
@@ -35,23 +37,23 @@ module Fakturoid
     def handle_response
       case status_code
         when 400
-          raise error(UserAgentError,  'User-Agent header missing') if env.request_headers['User-Agent'].nil? || env.request_headers['User-Agent'].empty?
-          raise error(PaginationError, 'Page does not exist')
-        when 401 then raise error(AuthenticationError, 'Authentification failed')
-        when 402 then raise error(BlockedAccountError, 'Account is blocked')
-        when 403 then
-          raise error(DestroySubjectError, 'Cannot destroy subject with invoices')          if caller == Client::Subject && request_method == :delete
-          raise error(SubjectLimitError,   'Subject limit for account reached')             if caller == Client::Subject && request_method == :post
-          raise error(GeneratorLimitError, 'Recurring generator limit for account reached') if caller == Client::Generator
-          raise error(UnsupportedFeatureError, 'Feature unavailable for account plan')
-        when 404 then raise error(RecordNotFoundError, 'Record not found')
-        when 415 then raise error(ContentTypeError,    'Unsupported Content-Type')
-        when 422 then raise error(InvalidRecordError,  'Invalid record')
-        when 429 then raise error(RateLimitError,      'Rate limit reached')
-        when 503 then raise error(ReadOnlySiteError,   'Fakturoid is in read only state')
+          raise error(UserAgentError,  "User-Agent header missing") if env.request_headers["User-Agent"].nil? || env.request_headers["User-Agent"].empty?
+          raise error(PaginationError, "Page does not exist")
+        when 401 then raise error(AuthenticationError, "Authentification failed")
+        when 402 then raise error(BlockedAccountError, "Account is blocked")
+        when 403
+          raise error(DestroySubjectError, "Cannot destroy subject with invoices")          if caller == Client::Subject && request_method == :delete
+          raise error(SubjectLimitError,   "Subject limit for account reached")             if caller == Client::Subject && request_method == :post
+          raise error(GeneratorLimitError, "Recurring generator limit for account reached") if caller == Client::Generator
+          raise error(UnsupportedFeatureError, "Feature unavailable for account plan")
+        when 404 then raise error(RecordNotFoundError, "Record not found")
+        when 415 then raise error(ContentTypeError,    "Unsupported Content-Type")
+        when 422 then raise error(InvalidRecordError,  "Invalid record")
+        when 429 then raise error(RateLimitError,      "Rate limit reached")
+        when 503 then raise error(ReadOnlySiteError,   "Fakturoid is in read only state")
         else
-          raise error(ServerError, 'Server error') if status_code >= 500
-          raise error(ClientError, 'Client error') if status_code >= 400
+          raise error(ServerError, "Server error") if status_code >= 500
+          raise error(ClientError, "Client error") if status_code >= 400
       end
     end
 
@@ -72,7 +74,7 @@ module Fakturoid
     end
 
     def body_has_key?(key)
-      body && body.is_a?(Hash) && body.key?(key.to_s)
+      body.is_a?(Hash) && body.key?(key.to_s)
     end
   end
 end

data/lib/fakturoid/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fakturoid
-  VERSION = '0.2.0'
+  VERSION = "0.4.0"
 end

data/lib/fakturoid.rb

@@ -1,15 +1,17 @@
-require 'uri'
-require 'multi_json'
-require 'faraday'
-
-require 'fakturoid/config'
-require 'fakturoid/connection'
-require 'fakturoid/request'
-require 'fakturoid/response'
-require 'fakturoid/api'
-require 'fakturoid/client'
-require 'fakturoid/version'
-require 'fakturoid/railtie' if defined?(::Rails)
+# frozen_string_literal: true
+
+require "uri"
+require "multi_json"
+require "faraday"
+
+require "fakturoid/config"
+require "fakturoid/connection"
+require "fakturoid/request"
+require "fakturoid/response"
+require "fakturoid/api"
+require "fakturoid/client"
+require "fakturoid/version"
+require "fakturoid/railtie" if defined?(::Rails)
 
 module Fakturoid
   class ApiError < StandardError

data/test/api_test.rb

@@ -1,22 +1,24 @@
-require 'test_helper'
+# frozen_string_literal: true
+
+require "test_helper"
 
 class Fakturoid::ApiTest < Fakturoid::TestCase
-  should 'permit only required arguments' do
-    hash = { page: 4, number: '2015-0015', account: 15 }
+  should "permit only required arguments" do
+    hash = { page: 4, number: "2015-0015", account: 15 }
     permitted_params = Fakturoid::Api.permit_params(hash, :page, :number, :status)
-    assert_equal({ page: 4, number: '2015-0015' }, permitted_params)
+    assert_equal({ page: 4, number: "2015-0015" }, permitted_params)
   end
 
-  should 'raise argument error if id is in wrong format' do
+  should "raise argument error if id is in wrong format" do
     assert_raises(ArgumentError) { Fakturoid::Api.validate_numerical_id(nil) }
-    assert_raises(ArgumentError) { Fakturoid::Api.validate_numerical_id('nil') }
+    assert_raises(ArgumentError) { Fakturoid::Api.validate_numerical_id("nil") }
     assert Fakturoid::Api.validate_numerical_id(15)
-    assert Fakturoid::Api.validate_numerical_id('15')
+    assert Fakturoid::Api.validate_numerical_id("15")
   end
 
-  should 'raise argument error if search query is not given' do
+  should "raise argument error if search query is not given" do
     assert_raises(ArgumentError) { Fakturoid::Api.validate_search_query(nil) }
-    assert_raises(ArgumentError) { Fakturoid::Api.validate_search_query('') }
-    assert Fakturoid::Api.validate_search_query('Company name')
+    assert_raises(ArgumentError) { Fakturoid::Api.validate_search_query("") }
+    assert Fakturoid::Api.validate_search_query("Company name")
   end
 end

data/test/config_test.rb

@@ -1,38 +1,40 @@
-require 'test_helper'
+# frozen_string_literal: true
+
+require "test_helper"
 
 class Fakturoid::ConfigTest < Fakturoid::TestCase
-  should 'configure with block param' do
+  should "configure with block param" do
     config = Fakturoid::Config.new do |c|
-      c.email   = 'test@email.cz'
-      c.api_key = 'XXXXXXXXXXX'
-      c.account = 'testaccount'
-      c.user_agent = 'My test app (test@email.cz)'
+      c.email   = "test@email.cz"
+      c.api_key = "XXXXXXXXXXX"
+      c.account = "testaccount"
+      c.user_agent = "My test app (test@email.cz)"
     end
 
-    assert_equal 'test@email.cz', config.email
-    assert_equal 'XXXXXXXXXXX',   config.api_key
-    assert_equal 'testaccount',   config.account
-    assert_equal 'My test app (test@email.cz)', config.user_agent
+    assert_equal "test@email.cz", config.email
+    assert_equal "XXXXXXXXXXX",   config.api_key
+    assert_equal "testaccount",   config.account
+    assert_equal "My test app (test@email.cz)", config.user_agent
   end
 
-  should 'use default user agent' do
+  should "use default user agent" do
     config = Fakturoid::Config.new do |c|
-      c.email   = 'test@email.cz'
-      c.api_key = 'XXXXXXXXXXX'
-      c.account = 'testaccount'
+      c.email   = "test@email.cz"
+      c.api_key = "XXXXXXXXXXX"
+      c.account = "testaccount"
     end
 
-    assert_equal 'Fakturoid ruby gem (test@email.cz)', config.user_agent
+    assert_equal "Fakturoid ruby gem (test@email.cz)", config.user_agent
   end
 
-  should 'return correct endpoints' do
+  should "return correct endpoints" do
     config = Fakturoid::Config.new do |c|
-      c.email   = 'test@email.cz'
-      c.api_key = 'XXXXXXXXXXX'
-      c.account = 'testaccount'
+      c.email   = "test@email.cz"
+      c.api_key = "XXXXXXXXXXX"
+      c.account = "testaccount"
     end
 
-    assert_equal 'https://app.fakturoid.cz/api/v2/accounts/testaccount', config.endpoint
-    assert_equal 'https://app.fakturoid.cz/api/v2', config.endpoint_without_account
+    assert_equal "https://app.fakturoid.cz/api/v2/accounts/testaccount", config.endpoint
+    assert_equal "https://app.fakturoid.cz/api/v2", config.endpoint_without_account
   end
 end

data/test/request_test.rb

@@ -1,17 +1,19 @@
-require 'test_helper'
+# frozen_string_literal: true
+
+require "test_helper"
 
 class Fakturoid::RequestTest < Fakturoid::TestCase
-  should 'should return pdf' do
-    pdf = load_fixture('invoice.pdf')
+  should "should return pdf" do
+    pdf = load_fixture("invoice.pdf")
     test_connection = Faraday.new do |builder|
       builder.adapter :test do |stub|
-        stub.get('invoices/5/download.pdf') { |_env| [200, { content_type: 'application/pdf' }, pdf] }
+        stub.get("invoices/5/download.pdf") { |_env| [200, { content_type: "application/pdf" }, pdf] }
       end
-      builder.headers = { content_type: 'application/pdf' }
+      builder.headers = { content_type: "application/pdf" }
     end
     Fakturoid::Request.any_instance.stubs(:connection).returns(test_connection)
 
-    response = Fakturoid::Request.new(:get, 'invoices/5/download.pdf', Fakturoid::Client::Invoice).call
+    response = Fakturoid::Request.new(:get, "invoices/5/download.pdf", Fakturoid::Client::Invoice).call
     assert !response.json?
     assert_raises(NoMethodError) { response.name }
   end