fakturoid 0.4.0 → 1.0.0

data/lib/fakturoid/client/invoice.rb

@@ -1,73 +0,0 @@
-# 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, *INDEX_PARAMS) || {}
-
-        get_request("invoices.json", request_params: request_params)
-      end
-
-      def self.regular(params = {})
-        request_params = permit_params(params, *INDEX_PARAMS) || {}
-
-        get_request("invoices/regular.json", request_params: request_params)
-      end
-
-      def self.proforma(params = {})
-        request_params = permit_params(params, *INDEX_PARAMS) || {}
-
-        get_request("invoices/proforma.json", request_params: request_params)
-      end
-
-      def self.find(id)
-        validate_numerical_id(id)
-        get_request("invoices/#{id}.json")
-      end
-
-      def self.search(query, params = {})
-        validate_search_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" })
-      end
-
-      def self.fire(id, event, params = {})
-        request_params = permit_params(params, :paid_at, :paid_amount, :variable_symbol, :bank_account_id) || {}
-        request_params[:event] = event
-
-        validate_numerical_id(id)
-        post_request("invoices/#{id}/fire.json", request_params: request_params)
-      end
-
-      def self.deliver_message(invoice_id, payload = {})
-        validate_numerical_id(invoice_id)
-        post_request("invoices/#{invoice_id}/message.json", payload: payload)
-      end
-
-      def self.create(payload = {})
-        post_request("invoices.json", payload: payload)
-      end
-
-      def self.update(id, payload = {})
-        validate_numerical_id(id)
-        patch_request("invoices/#{id}.json", payload: payload)
-      end
-
-      def self.delete(id)
-        validate_numerical_id(id)
-        delete_request("invoices/#{id}.json")
-      end
-    end
-  end
-end

data/lib/fakturoid/client/number_format.rb

@@ -1,11 +0,0 @@
-# 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,41 +0,0 @@
-# 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)
-      end
-
-      def self.find(id)
-        validate_numerical_id(id)
-        get_request("subjects/#{id}.json")
-      end
-
-      def self.search(query, params = {})
-        validate_search_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)
-      end
-
-      def self.update(id, payload = {})
-        validate_numerical_id(id)
-        patch_request("subjects/#{id}.json", payload: payload)
-      end
-
-      def self.delete(id)
-        validate_numerical_id(id)
-        delete_request("subjects/#{id}.json")
-      end
-    end
-  end
-end

data/lib/fakturoid/client/todo.rb

@@ -1,18 +0,0 @@
-# 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)
-      end
-
-      def self.toggle_completion(id)
-        validate_numerical_id(id)
-        post_request("todos/#{id}/toggle_completion.json")
-      end
-    end
-  end
-end

data/lib/fakturoid/client/user.rb

@@ -1,20 +0,0 @@
-# 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)
-      end
-
-      def self.find(id)
-        validate_numerical_id(id)
-        get_request("users/#{id}.json")
-      end
-
-      def self.all
-        get_request("users.json")
-      end
-    end
-  end
-end

data/lib/fakturoid/connection.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Fakturoid
-  module Connection
-    DEFAULT_CONTENT_TYPE = "application/json"
-
-    def default_options(options = {})
-      {
-        headers: {
-          content_type: options.dig(:headers, :content_type) || DEFAULT_CONTENT_TYPE,
-          user_agent: Fakturoid::Api.config.user_agent
-        },
-        url: options[:url] || Fakturoid::Api.config.endpoint
-      }
-    end
-
-    def connection(options = {})
-      @connection = Faraday.new default_options(options)
-
-      # 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
-  end
-end

data/lib/fakturoid/request.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Fakturoid
-  class Request
-    include Connection
-
-    attr_reader :method, :path, :caller
-
-    HTTP_METHODS = [:get, :post, :patch, :delete].freeze
-
-    def initialize(method, path, caller)
-      @method = method
-      @path   = path
-      @caller = caller
-    end
-
-    def call(params = {})
-      raise ArgumentError, "Unknown http method: #{method}" unless HTTP_METHODS.include?(method.to_sym)
-
-      request_params = params[:request_params] || {}
-
-      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)
-    end
-  end
-end

data/test/api_test.rb

@@ -1,24 +0,0 @@
-# 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 }
-    permitted_params = Fakturoid::Api.permit_params(hash, :page, :number, :status)
-    assert_equal({ page: 4, number: "2015-0015" }, permitted_params)
-  end
-
-  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 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
-    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")
-  end
-end

data/test/config_test.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-class Fakturoid::ConfigTest < Fakturoid::TestCase
-  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)"
-    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
-  end
-
-  should "use default user agent" do
-    config = Fakturoid::Config.new do |c|
-      c.email   = "test@email.cz"
-      c.api_key = "XXXXXXXXXXX"
-      c.account = "testaccount"
-    end
-
-    assert_equal "Fakturoid ruby gem (test@email.cz)", config.user_agent
-  end
-
-  should "return correct endpoints" do
-    config = Fakturoid::Config.new do |c|
-      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
-  end
-end

data/test/fixtures/blocked_account.json

@@ -1,8 +0,0 @@
-{
-    "status": "Account blocked",
-    "overdue_invoices": [
-        {
-            "invoice_url": "http://app.fakturoid.dev/robot/p/3WfeLRO5HZ/2015-0002"
-        }
-    ]
-}

data/test/fixtures/invoice.json

@@ -1,81 +0,0 @@
-{
-    "id": 5,
-    "proforma": false,
-    "number": "2012-0004",
-    "variable_symbol": "20120004",
-    "your_name": "Alexandr Hejsek",
-    "your_street": "Hopsinkov\u00e1 14",
-    "your_street2": null,
-    "your_city": "Praha",
-    "your_zip": "10000",
-    "your_country": "CZ",
-    "your_registration_no": "87654321",
-    "your_vat_no": "CZ87654321",
-    "client_name": "Microsoft a. s.",
-    "client_street": "Trojanova 1216/46",
-    "client_street2": null,
-    "client_city": "Praha",
-    "client_zip": "11000",
-    "client_country": "CZ",
-    "client_registration_no": "28444501",
-    "client_vat_no": "CZ28444501",
-    "subject_id": 4,
-    "generator_id": 4,
-    "related_id": null,
-    "correction": false,
-    "correction_id": null,
-    "token": "udDTG8Q88M",
-    "status": "paid",
-    "order_number": null,
-    "issued_on": "2011-10-13",
-    "taxable_fulfillment_due": "2011-10-13",
-    "due": 10,
-    "due_on": "2011-10-23",
-    "sent_at": null,
-    "paid_at": "2011-10-20T12:11:37+02:00",
-    "reminder_sent_at": null,
-    "accepted_at": null,
-    "cancelled_at": null,
-    "note": null,
-    "footer_note": null,
-    "bank_account": "1234/1234",
-    "iban": null,
-    "swift_bic": null,
-    "payment_method": "bank",
-    "currency": "CZK",
-    "exchange_rate": "1.0",
-    "language": "cz",
-    "transferred_tax_liability": false,
-    "vat_price_mode": "without_vat",
-    "subtotal": "40000.0",
-    "total": "48400.0",
-    "native_subtotal": "40000.0",
-    "native_total": "48400.0",
-    "lines": [
-        {
-            "id": 1234,
-            "name": "PC",
-            "quantity": "1.0",
-            "unit_name": "",
-            "unit_price": "20000.0",
-            "vat_rate": 21,
-            "unit_price_without_vat": "20000.0",
-            "unit_price_with_vat": "24200.0"
-        },
-        {
-            "id": 1235,
-            "name": "Notebook",
-            "quantity": "1.0",
-            "unit_name": "",
-            "unit_price": "20000.0",
-            "vat_rate": 21,
-            "unit_price_without_vat": "20000.0",
-            "unit_price_with_vat": "24200.0"
-        }
-    ],
-    "html_url": "https://app.fakturoid.cz/applecorp/invoices/9",
-    "public_html_url": "https://app.fakturoid.cz/applecorp/p/udDTG8Q88M/2012-0004",
-    "url": "https://app.fakturoid.cz/api/v2/accounts/applecorp/invoices/9.json",
-    "subject_url": "https://app.fakturoid.cz/api/v2/accounts/applecorp/subjects/4.json",
-    "updated_at": "2012-05-13T12:11:37+02:00"
-}

data/test/fixtures/invoice_error.json

@@ -1,7 +0,0 @@
-{
-    "errors": {
-        "number": [
-            "je povinná položka"
-        ]
-    }
-}

data/test/fixtures/subjects.json

@@ -1,52 +0,0 @@
-[
-    {
-        "id": 6,
-        "custom_id": null,
-        "type": "customer",
-        "name": "Apple Czech s.r.o.",
-        "street": "Klimentská 1216/46",
-        "street2": null,
-        "city": "Praha",
-        "zip": "11000",
-        "country": "CZ",
-        "registration_no": "28897501",
-        "vat_no": "CZ28897501",
-        "bank_account": null,
-        "iban": null,
-        "variable_symbol": "",
-        "full_name": null,
-        "email": "",
-        "email_copy": null,
-        "phone": null,
-        "web": "https://www.apple.cz",
-        "avatar_url": "https://ssl.fakturoid.cz/images/company-contact.png",
-        "html_url": "https://app.fakturoid.cz/applecorp/subjects/6",
-        "url": "https://app.fakturoid.cz/api/v2/accounts/applecorp/subjects/6.json",
-        "updated_at": "2012-05-13T12:11:38+02:00"
-    },
-    {
-        "id": 28,
-        "custom_id": null,
-        "type": "supplier",
-        "name": "MICROSOFT s.r.o.",
-        "street": "Vyskočilova 1461/2a",
-        "street2": null,
-        "city": "Praha",
-        "zip": "14000",
-        "country": "Česká republika",
-        "registration_no": "47123737",
-        "vat_no": "CZ47123737",
-        "bank_account": "",
-        "iban": "",
-        "variable_symbol": "1234567890",
-        "full_name": "",
-        "email": "",
-        "email_copy": "",
-        "phone": "",
-        "web": "",
-        "avatar_url": "https://ssl.fakturoid.cz/images/company-contact.png",
-        "html_url": "https://app.fakturoid.cz/applecorp/subjects/28",
-        "url": "https://app.fakturoid.cz/api/v2/accounts/applecorp/subjects/28.json",
-        "updated_at": "2012-06-02T09:34:47+02:00"
-    }
-]

data/test/request_test.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-class Fakturoid::RequestTest < Fakturoid::TestCase
-  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] }
-      end
-      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
-    assert !response.json?
-    assert_raises(NoMethodError) { response.name }
-  end
-end

data/test/response_test.rb

@@ -1,189 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-class Fakturoid::ResponseTest < Fakturoid::TestCase
-  should "should return json invoice" do
-    json = load_fixture("invoice.json")
-    test_connection = Faraday.new do |builder|
-      builder.adapter :test do |stub|
-        stub.get("invoices/5.json") { |_env| [200, { content_type: "application/json" }, json] }
-      end
-      builder.headers = { content_type: "application/json", user_agent: "Fakturoid gem (email@testmail.cz)" }
-    end
-
-    response = Fakturoid::Response.new(test_connection.get("invoices/5.json"), Fakturoid::Client::Invoice, :get)
-    assert response.json?
-    assert_equal 200, response.status_code
-    assert_equal 5,   response.id
-    assert_equal 5,   response.body["id"]
-    assert response.respond_to?(:body)
-    assert response.respond_to?(:id)
-    assert_raises(NoMethodError) { response.name }
-  end
-
-  context "Exceptions" do
-    should "raise user agent error" do
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.get("invoices/5.json") { |_env| [400, { content_type: "application/json" }, " "] }
-        end
-        builder.headers = { content_type: "application/json", user_agent: "" }
-      end
-
-      assert_raises(Fakturoid::UserAgentError) { Fakturoid::Response.new(test_connection.get("invoices/5.json"), Fakturoid::Client::Invoice, :get) }
-    end
-
-    should "raise pagination error" do
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.get("invoices.json?page=4") { |_env| [400, { content_type: "application/json" }, " "] }
-        end
-        builder.headers = { content_type: "application/json", user_agent: "Fakturoid gem (email@testmail.cz)" }
-      end
-
-      assert_raises(Fakturoid::PaginationError) { Fakturoid::Response.new(test_connection.get("invoices.json?page=4"), Fakturoid::Client::Invoice, :get) }
-    end
-
-    should "raise authentication error" do
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.get("invoices.json?page=4") { |_env| [401, { content_type: "application/json" }, " "] }
-        end
-        builder.headers = { content_type: "application/json", user_agent: "Fakturoid gem (email@testmail.cz)" }
-      end
-
-      assert_raises(Fakturoid::AuthenticationError) { Fakturoid::Response.new(test_connection.get("invoices.json?page=4"), Fakturoid::Client::Invoice, :get) }
-    end
-
-    should "raise blocked account error" do
-      json = load_fixture("blocked_account.json")
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.get("account.json") { |_env| [402, { content_type: "application/json" }, json] }
-        end
-        builder.headers = { content_type: "application/json", user_agent: "Fakturoid gem (email@testmail.cz)" }
-      end
-
-      begin
-        Fakturoid::Response.new(test_connection.get("account.json"), Fakturoid::Client::Account, :get)
-      rescue Fakturoid::BlockedAccountError => e
-        assert_equal 402, e.response_code
-        assert e.response_body.key?("status")
-      rescue => e
-        assert false, "Raised exception was not expected: #{e.class}"
-      else
-        assert false, "Exception was expected"
-      end
-    end
-
-    should "raise destroy subject error" do
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.delete("subjects/5.json") { |_env| [403, { content_type: "application/json" }, " "] }
-        end
-        builder.headers = { content_type: "application/json", user_agent: "Fakturoid gem (email@testmail.cz)" }
-      end
-
-      assert_raises(Fakturoid::DestroySubjectError) { Fakturoid::Response.new(test_connection.delete("subjects/5.json"), Fakturoid::Client::Subject, :delete) }
-    end
-
-    should "raise subject limit error" do
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.post("subjects.json") { |_env| [403, { content_type: "application/json" }, " "] }
-        end
-        builder.headers = { content_type: "application/json", user_agent: "Fakturoid gem (email@testmail.cz)" }
-      end
-
-      assert_raises(Fakturoid::SubjectLimitError) { Fakturoid::Response.new(test_connection.post("subjects.json", name: "Customer s.r.o."), Fakturoid::Client::Subject, :post) }
-    end
-
-    should "raise generator limit error" do
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.post("generators.json") { |_env| [403, { content_type: "application/json" }, " "] }
-        end
-        builder.headers = { content_type: "application/json", user_agent: "Fakturoid gem (email@testmail.cz)" }
-      end
-
-      assert_raises(Fakturoid::GeneratorLimitError) { Fakturoid::Response.new(test_connection.post("generators.json", name: "Customer s.r.o.", recurring: true), Fakturoid::Client::Generator, :post) }
-    end
-
-    should "raise unsupported feature error" do
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.post("invoices/5/message.json") { |_env| [403, { content_type: "application/json" }, " "] }
-        end
-        builder.headers = { content_type: "application/json", user_agent: "Fakturoid gem (email@testmail.cz)" }
-      end
-
-      assert_raises(Fakturoid::UnsupportedFeatureError) { Fakturoid::Response.new(test_connection.post("invoices/5/message.json", email: "customer@email.cz"), Fakturoid::Client::Invoice, :post) }
-    end
-
-    should "raise record not found error" do
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.get("invoices/10.json") { |_env| [404, { content_type: "application/json" }, " "] }
-        end
-        builder.headers = { content_type: "application/json", user_agent: "Fakturoid gem (email@testmail.cz)" }
-      end
-
-      assert_raises(Fakturoid::RecordNotFoundError) { Fakturoid::Response.new(test_connection.get("invoices/10.json"), Fakturoid::Client::Invoice, :get) }
-    end
-
-    should "raise content type error" do
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.get("invoices/5.xml") { |_env| [415, { content_type: "application/xml" }, " "] }
-        end
-        builder.headers = { content_type: "application/xml", user_agent: "Fakturoid gem (email@testmail.cz)" }
-      end
-
-      assert_raises(Fakturoid::ContentTypeError) { Fakturoid::Response.new(test_connection.get("invoices/5.xml"), Fakturoid::Client::Invoice, :get) }
-    end
-
-    should "raise invalid record error" do
-      json = load_fixture("invoice_error.json")
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.patch("invoice/5.json") { |_env| [422, { content_type: "application/json" }, json] }
-        end
-        builder.headers = { content_type: "application/json", user_agent: "Fakturoid gem (email@testmail.cz)" }
-      end
-
-      begin
-        Fakturoid::Response.new(test_connection.patch("invoice/5.json"), Fakturoid::Client::Invoice, :patch)
-      rescue Fakturoid::InvalidRecordError => e
-        assert_equal 422, e.response_code
-        assert e.response_body.key?("errors")
-      rescue => e
-        assert false, "Raised exception was not expected: #{e.class}"
-      else
-        assert false, "Exception was expected"
-      end
-    end
-
-    should "raise rate limit error" do
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.get("invoices/5.json") { |_env| [429, { content_type: "application/json" }, " "] }
-        end
-        builder.headers = { content_type: "application/json", user_agent: "Fakturoid gem (email@testmail.cz)" }
-      end
-
-      assert_raises(Fakturoid::RateLimitError) { Fakturoid::Response.new(test_connection.get("invoices/5.json"), Fakturoid::Client::Invoice, :get) }
-    end
-
-    should "raise read only site error" do
-      test_connection = Faraday.new do |builder|
-        builder.adapter :test do |stub|
-          stub.delete("invoices/5.json") { |_env| [503, { content_type: "application/json" }, " "] }
-        end
-        builder.headers = { content_type: "application/json", user_agent: "Fakturoid gem (email@testmail.cz)" }
-      end
-
-      assert_raises(Fakturoid::ReadOnlySiteError) { Fakturoid::Response.new(test_connection.delete("invoices/5.json"), Fakturoid::Client::Invoice, :delete) }
-    end
-  end
-end