fakturoid 0.5.0 → 1.0.0

data/lib/fakturoid/oauth.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "oauth/credentials"
+require_relative "oauth/flow"
+require_relative "oauth/request"
+require_relative "oauth/token_response"
+require_relative "oauth/access_token_service"
+
+module Fakturoid
+  class Oauth
+    extend Forwardable
+
+    attr_reader :client, :flow, :access_token_service
+
+    def_delegators :@flow, :authorization_uri, :authorize, :fetch_access_token, :revoke_access, :authorized?
+
+    def initialize(client)
+      @client = client
+      @flow = find_flow
+      @access_token_service = AccessTokenService.new(self)
+    end
+
+    def perform_request(method, path, params)
+      access_token_service.perform_request(method, path, params)
+    end
+
+  private
+
+    def find_flow
+      if client.config.client_credentials_flow?
+        Flow::ClientCredentials.new(client)
+      elsif client.config.authorization_code_flow?
+        Flow::AuthorizationCode.new(client)
+      else
+        raise ConfigurationError, "Unsupported OAuth flow."
+      end
+    end
+  end
+end

data/lib/fakturoid/response.rb

@@ -2,30 +2,32 @@
 
 module Fakturoid
   class Response
-    attr_reader :response, :caller, :env, :body, :request_method
+    attr_reader :response, :caller, :body, :request_method
 
     def initialize(faraday_response, caller, request_method)
       @response = faraday_response
       @caller = caller
-      @env = faraday_response.env
       @request_method = request_method.to_sym
 
+      env = response.env
+
       if !(env.body.nil? || env.body.empty? || (json? && env.body =~ /\A\s+\z/))
         @body = json? ? MultiJson.load(env.body) : env.body
       end
+
       handle_response
     end
 
     def status_code
-      env["status"]
+      response.env["status"]
     end
 
     def json?
-      env.request_headers["Content-Type"] == "application/json"
+      headers["content-type"] =~ %r{\Aapplication/json}
     end
 
     def headers
-      env.response_headers
+      response.env.response_headers.transform_keys(&:downcase)
     end
 
     def inspect
@@ -36,21 +38,7 @@ 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
-          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")
+        when 401 then raise error(AuthenticationError, "Authentication failed")
         else
           raise error(ServerError, "Server error") if status_code >= 500
           raise error(ClientError, "Client error") if status_code >= 400

data/lib/fakturoid/utils.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Utils
+    def self.permit_params(params_hash, *permitted_params)
+      params_hash.select { |param, _value| permitted_params.include?(param.to_sym) }
+    end
+
+    def self.validate_numerical_id(id)
+      raise ArgumentError, "Wrong ID given: #{id}" if !id.is_a?(Integer) && !(id.is_a?(String) && id =~ /\A\d+\z/)
+      true
+    end
+
+    def self.validate_search_query(query: nil, tags: nil, allow_tags: false)
+      if allow_tags && empty?(tags) && empty?(query)
+        raise ArgumentError, "Query or tags parameter is required"
+      elsif !allow_tags && empty?(query)
+        raise ArgumentError, "Query parameter is required"
+      end
+      true
+    end
+
+    def self.empty?(string)
+      string.nil? || string.empty?
+    end
+  end
+end

data/lib/fakturoid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fakturoid
-  VERSION = "0.5.0"
+  VERSION = "1.0.0"
 end

data/lib/fakturoid.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
 require "uri"
+require "forwardable"
+require "time"
 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)
+require_relative "fakturoid/utils"
+require_relative "fakturoid/config"
+require_relative "fakturoid/response"
+require_relative "fakturoid/api"
+require_relative "fakturoid/oauth"
+require_relative "fakturoid/client"
+require_relative "fakturoid/version"
+require_relative "fakturoid/railtie" if defined?(::Rails)
 
 module Fakturoid
   class ApiError < StandardError
@@ -24,25 +26,23 @@ module Fakturoid
     end
   end
 
-  class ContentTypeError        < ApiError; end
-  class UserAgentError          < ApiError; end
+  class ConfigurationError      < ApiError; end
+  class OauthError              < ApiError; end
   class AuthenticationError     < ApiError; end
-  class BlockedAccountError     < ApiError; end
-  class RateLimitError          < ApiError; end
-  class ReadOnlySiteError       < ApiError; end
-  class PaginationError         < ApiError; end
-
-  class RecordNotFoundError     < ApiError; end
-  class InvalidRecordError      < ApiError; end
-  class DestroySubjectError     < ApiError; end
-  class SubjectLimitError       < ApiError; end
-  class GeneratorLimitError     < ApiError; end
-  class UnsupportedFeatureError < ApiError; end
 
   class ClientError < ApiError; end
   class ServerError < ApiError; end
 
+  HTTP_GET    = :get
+  HTTP_POST   = :post
+  HTTP_PATCH  = :patch
+  HTTP_DELETE = :delete
+
   def self.configure(&block)
-    Fakturoid::Api.configure(&block)
+    Client.configure(&block)
+  end
+
+  def self.client
+    @client ||= Client.new
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fakturoid
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Eda Riedl
@@ -11,10 +11,10 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-13 00:00:00.000000000 Z
+date: 2024-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -56,7 +56,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,7 +70,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -84,7 +84,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda-context
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -98,7 +98,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -112,7 +112,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -132,54 +132,58 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/rubocop.yml"
-- ".github/workflows/tests.yml"
-- ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - fakturoid.gemspec
 - lib/fakturoid.rb
 - lib/fakturoid/api.rb
-- lib/fakturoid/api/arguments.rb
-- lib/fakturoid/api/http_methods.rb
+- lib/fakturoid/api/account.rb
+- lib/fakturoid/api/bank_account.rb
+- lib/fakturoid/api/base.rb
+- lib/fakturoid/api/event.rb
+- lib/fakturoid/api/expense.rb
+- lib/fakturoid/api/expense_payment.rb
+- lib/fakturoid/api/generator.rb
+- lib/fakturoid/api/inbox_file.rb
+- lib/fakturoid/api/inventory_item.rb
+- lib/fakturoid/api/inventory_move.rb
+- lib/fakturoid/api/invoice.rb
+- lib/fakturoid/api/invoice_message.rb
+- lib/fakturoid/api/invoice_payment.rb
+- lib/fakturoid/api/number_format.rb
+- lib/fakturoid/api/recurring_generator.rb
+- lib/fakturoid/api/subject.rb
+- lib/fakturoid/api/todo.rb
+- lib/fakturoid/api/user.rb
 - lib/fakturoid/client.rb
-- lib/fakturoid/client/account.rb
-- lib/fakturoid/client/bank_account.rb
-- lib/fakturoid/client/event.rb
-- lib/fakturoid/client/expense.rb
-- lib/fakturoid/client/generator.rb
-- lib/fakturoid/client/inventory_items.rb
-- lib/fakturoid/client/inventory_moves.rb
-- lib/fakturoid/client/invoice.rb
-- lib/fakturoid/client/number_format.rb
-- lib/fakturoid/client/subject.rb
-- lib/fakturoid/client/todo.rb
-- lib/fakturoid/client/user.rb
 - lib/fakturoid/config.rb
-- lib/fakturoid/connection.rb
+- lib/fakturoid/oauth.rb
+- lib/fakturoid/oauth/access_token_service.rb
+- lib/fakturoid/oauth/credentials.rb
+- lib/fakturoid/oauth/flow.rb
+- lib/fakturoid/oauth/flow/authorization_code.rb
+- lib/fakturoid/oauth/flow/base.rb
+- lib/fakturoid/oauth/flow/client_credentials.rb
+- lib/fakturoid/oauth/request.rb
+- lib/fakturoid/oauth/request/api.rb
+- lib/fakturoid/oauth/request/base.rb
+- lib/fakturoid/oauth/request/oauth.rb
+- lib/fakturoid/oauth/token_response.rb
 - lib/fakturoid/railtie.rb
-- lib/fakturoid/request.rb
 - lib/fakturoid/response.rb
+- lib/fakturoid/utils.rb
 - lib/fakturoid/version.rb
-- test/api_test.rb
-- test/config_test.rb
-- test/fixtures/blocked_account.json
-- test/fixtures/invoice.json
-- test/fixtures/invoice.pdf
-- test/fixtures/invoice_error.json
-- test/fixtures/subjects.json
-- test/request_test.rb
-- test/response_test.rb
-- test/test_helper.rb
 homepage: https://github.com/fakturoid/fakturoid-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/fakturoid/fakturoid-ruby
+  source_code_uri: https://github.com/fakturoid/fakturoid-ruby
+  changelog_uri: https://github.com/fakturoid/fakturoid-ruby/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -188,25 +192,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: Ruby client for web based invoicing service www.fakturoid.cz
-test_files:
-- test/api_test.rb
-- test/config_test.rb
-- test/fixtures/blocked_account.json
-- test/fixtures/invoice.json
-- test/fixtures/invoice.pdf
-- test/fixtures/invoice_error.json
-- test/fixtures/subjects.json
-- test/request_test.rb
-- test/response_test.rb
-- test/test_helper.rb
+test_files: []

data/.github/workflows/rubocop.yml

@@ -1,20 +0,0 @@
-# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-ruby
-# https://github.com/actions/starter-workflows/blob/main/ci/ruby.yml
-
-name: Rubocop
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.0
-          bundler-cache: true
-
-      - name: Rubocop
-        run: bundle exec rubocop

data/.github/workflows/tests.yml

@@ -1,27 +0,0 @@
-# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-ruby
-# https://github.com/actions/starter-workflows/blob/main/ci/ruby.yml
-
-name: Tests
-on: [push, pull_request]
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
-
-    steps:
-    - uses: actions/checkout@v3
-
-    - name: Set up Ruby
-      # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-      # change this to (see https://github.com/ruby/setup-ruby#versioning):
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-
-    - name: Run tests
-      run: bundle exec rake

data/.gitignore

@@ -1,7 +0,0 @@
-.bundle/
-Gemfile.lock
-coverage/
-doc/
-pkg/
-.DS_Store
-rubocop.html

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in fakturoid.gemspec
-gemspec

data/lib/fakturoid/api/arguments.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Fakturoid
-  class Api
-    module Arguments
-      def permit_params(params_hash, *permitted_params)
-        params_hash.select { |param, _value| permitted_params.include?(param.to_sym) }
-      end
-
-      def validate_numerical_id(id)
-        raise ArgumentError, "Wrong ID given: #{id}" if !id.is_a?(Integer) && !(id.is_a?(String) && id =~ /\A\d+\z/)
-        true
-      end
-
-      def validate_search_query(query)
-        raise ArgumentError, "Query parameter is required" if query.nil? || query.empty?
-        true
-      end
-    end
-  end
-end

data/lib/fakturoid/api/http_methods.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Fakturoid
-  class Api
-    module HttpMethods
-      def get_request(path, params = {})
-        Request.new(:get, path, self).call(params)
-      end
-
-      def post_request(path, params = {})
-        Request.new(:post, path, self).call(params)
-      end
-
-      def patch_request(path, params = {})
-        Request.new(:patch, path, self).call(params)
-      end
-
-      def delete_request(path, params = {})
-        Request.new(:delete, path, self).call(params)
-      end
-    end
-  end
-end

data/lib/fakturoid/client/account.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Fakturoid
-  module Client
-    class Account < Fakturoid::Api
-      def self.current
-        get_request("account.json")
-      end
-    end
-  end
-end

data/lib/fakturoid/client/bank_account.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Fakturoid
-  module Client
-    class BankAccount < Fakturoid::Api
-      def self.all
-        get_request("bank_accounts.json")
-      end
-    end
-  end
-end

data/lib/fakturoid/client/event.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Fakturoid
-  module Client
-    class Event < Fakturoid::Api
-      def self.all(params = {})
-        request_params = permit_params(params, :page, :since, :subject_id) || {}
-
-        get_request("events.json", request_params: request_params)
-      end
-
-      def self.paid(params = {})
-        request_params = permit_params(params, :page, :since, :subject_id) || {}
-
-        get_request("events/paid.json", request_params: request_params)
-      end
-    end
-  end
-end

data/lib/fakturoid/client/expense.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module Fakturoid
-  module Client
-    class Expense < Fakturoid::Api
-      def self.all(params = {})
-        request_params = permit_params(params, :page, :since, :updated_since, :number, :variable_symbol, :status, :subject_id, :custom_id) || {}
-
-        get_request("expenses.json", request_params: request_params)
-      end
-
-      def self.find(id)
-        validate_numerical_id(id)
-        get_request("expenses/#{id}.json")
-      end
-
-      def self.search(query, params = {})
-        validate_search_query(query)
-
-        request_params = permit_params(params, :page)
-        request_params[:query] = query
-
-        get_request("expenses/search.json", request_params: request_params)
-      end
-
-      def self.fire(id, event, params = {})
-        request_params = permit_params(params, :paid_on, :paid_amount, :variable_symbol, :bank_account_id) || {}
-        request_params[:event] = event
-
-        validate_numerical_id(id)
-        post_request("expenses/#{id}/fire.json", request_params: request_params)
-      end
-
-      def self.create(payload = {})
-        post_request("expenses.json", payload: payload)
-      end
-
-      def self.update(id, payload = {})
-        validate_numerical_id(id)
-        patch_request("expenses/#{id}.json", payload: payload)
-      end
-
-      def self.delete(id)
-        validate_numerical_id(id)
-        delete_request("expenses/#{id}.json")
-      end
-    end
-  end
-end

data/lib/fakturoid/client/generator.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Fakturoid
-  module Client
-    class Generator < Fakturoid::Api
-      def self.all(params = {})
-        request_params = permit_params(params, :page, :since, :updated_since, :subject_id) || {}
-
-        get_request("generators.json", request_params: request_params)
-      end
-
-      def self.recurring(params = {})
-        request_params = permit_params(params, :page, :since, :updated_since, :subject_id) || {}
-
-        get_request("generators/recurring.json", request_params: request_params)
-      end
-
-      def self.template(params = {})
-        request_params = permit_params(params, :page, :since, :updated_since, :subject_id) || {}
-
-        get_request("generators/template.json", request_params: request_params)
-      end
-
-      def self.find(id)
-        validate_numerical_id(id)
-        get_request("generators/#{id}.json")
-      end
-
-      def self.create(payload = {})
-        post_request("generators.json", payload: payload)
-      end
-
-      def self.update(id, payload = {})
-        validate_numerical_id(id)
-        patch_request("generators/#{id}.json", payload: payload)
-      end
-
-      def self.delete(id)
-        validate_numerical_id(id)
-        delete_request("generators/#{id}.json")
-      end
-    end
-  end
-end