easybill-rest-client 2.0.2

data/lib/easybill_rest_client/generic_api.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  class GenericApi
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    def find(id)
+      build(api_client.request(:get, "/#{resource_name}/#{id}"))
+    end
+
+    def find_all(params = {})
+      api_client.request_collection(:get, "/#{resource_name}", params).map { |d| build(d) }
+    end
+
+    def save(entity)
+      entity.id ? update(entity) : create(entity)
+    end
+
+    def create(entity)
+      build(api_client.request(:post, "/#{resource_name}", entity.attributes))
+    end
+
+    def update(entity)
+      build(api_client.request(:put, "/#{resource_name}/#{entity.id}", entity.attributes))
+    end
+
+    def delete(id)
+      api_client.request(:delete, "/#{resource_name}/#{id}")
+    end
+
+    def build(params)
+      resource_class.new(params)
+    end
+
+    attr_reader :api_client
+  end
+end

data/lib/easybill_rest_client/pdf.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  class Pdf
+    attr_reader :content
+    attr_writer :filename
+
+    def initialize(filename:, content:)
+      @filename = filename
+      @content = content
+    end
+
+    def empty?
+      content.empty?
+    end
+
+    def filename
+      @filename[/\.pdf\Z/i] ? @filename : "#{@filename}.pdf"
+    end
+  end
+end

data/lib/easybill_rest_client/post_box.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  class PostBox
+    include Virtus.model
+    values do
+      attribute :id, Integer
+    end
+    attribute :cc, String
+    attribute :created_at, DateTime
+    attribute :date, Date
+    attribute :document_id, Integer
+    attribute :from, String
+    attribute :message, String
+    attribute :processed_at, DateTime
+    attribute :send_by_self, Boolean
+    attribute :send_with_attachment, Boolean
+    attribute :status_info, String
+    attribute :status, String
+    attribute :subject, String
+    attribute :to, String
+    attribute :type, String
+  end
+end

data/lib/easybill_rest_client/post_box_api.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'easybill_rest_client/generic_api'
+
+module EasybillRestClient
+  class PostBoxApi < GenericApi
+    def resource_name
+      'post-boxes'
+    end
+
+    def resource_class
+      PostBox
+    end
+  end
+end

data/lib/easybill_rest_client/request.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'easybill_rest_client/request_logger'
+require 'easybill_rest_client/retry_on'
+
+module EasybillRestClient
+  class Request
+    BASE_URL = 'https://api.easybill.de/rest/v1'
+    USERNAME = 'rest-api@easybill.de'
+    SUPPORTED_METHODS = %i[get post put delete].freeze
+    OPEN_TIMEOUT = 30
+
+    def initialize(opts = {})
+      unless SUPPORTED_METHODS.include?(opts.fetch(:method).to_sym)
+        raise ArgumentError, "Unsupported HTTP method '#{method}'"
+      end
+
+      @api_key = opts.fetch(:api_key)
+      @method = opts.fetch(:method)
+      @endpoint = opts.fetch(:endpoint)
+      @params = opts.fetch(:params)
+      @logger = opts.fetch(:logger)
+      @tries = opts.fetch(:tries)
+      @retry_cool_off_time = opts.fetch(:retry_cool_off_time)
+    end
+
+    def run
+      request_logger.info("#{method.to_s.upcase} #{endpoint} #{request_details}")
+      retry_on(TooManyRequests) do
+        retry_on(Net::OpenTimeout) do
+          response = perform_request
+          raise TooManyRequests if response.is_a?(Net::HTTPTooManyRequests)
+          response
+        end
+      end
+    end
+
+    def request_details
+      body_allowed? ? request.body : uri.query
+    end
+
+    private
+
+    attr_reader :api_key, :method, :endpoint, :params, :logger, :tries, :retry_cool_off_time
+
+    def perform_request
+      http_opts = { use_ssl: uri.scheme == 'https', open_timeout: OPEN_TIMEOUT }
+      Net::HTTP.start(uri.host, uri.port, http_opts) do |http|
+        http.request(request)
+      end
+    end
+
+    def uri
+      return @uri if @uri
+      @uri = URI.parse(BASE_URL)
+      @uri.path << endpoint
+      @uri.query = URI.encode_www_form(query_params) unless body_allowed?
+      @uri
+    end
+
+    def query_params
+      params.map { |key, value| [key, translate_query_value(value)] }.to_h
+    end
+
+    def translate_query_value(value)
+      case value
+      when Array
+        value.join(',')
+      when nil
+        'null'
+      else
+        value
+      end
+    end
+
+    def request
+      return @request if @request
+      @request = request_class.new(uri)
+      @request.body = params.reject { |_k, v| v.nil? }.to_json if body_allowed?
+      @request.basic_auth(USERNAME, api_key)
+      @request
+    end
+
+    def request_class
+      Net::HTTP.const_get(method.to_s.capitalize)
+    end
+
+    def body_allowed?
+      request_class::REQUEST_HAS_BODY
+    end
+
+    def retry_on(exception, &block)
+      @retry_on ||= RetryOn.new(request_logger, tries, retry_cool_off_time)
+      @retry_on.retry_on(exception, &block)
+    end
+
+    def request_logger
+      @request_logger ||= RequestLogger.new(logger: logger, request_id: request_id)
+    end
+
+    def request_id
+      @request_id ||= SecureRandom.hex(3)
+    end
+  end
+
+  class TooManyRequests < StandardError; end
+end

data/lib/easybill_rest_client/request_logger.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  class RequestLogger
+    def initialize(logger:, request_id:)
+      @logger = logger
+      @request_id = request_id
+    end
+
+    %i[info warn error].each do |method|
+      define_method(method) do |msg|
+        logger.public_send(method, format_message(msg))
+      end
+    end
+
+    private
+
+    attr_reader :request_id, :logger
+
+    def format_message(msg)
+      "[easybill-rest-client] RequestId=#{request_id} #{msg}"
+    end
+  end
+end

data/lib/easybill_rest_client/response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  class Response
+    def initialize(response)
+      @response = response
+    end
+
+    def body
+      body = extract_response_body(response)
+      unless response.is_a?(Net::HTTPSuccess)
+        raise ApiError, body.inspect
+      end
+      body && !body.empty? ? body : nil
+    end
+
+    private
+
+    attr_reader :response
+
+    def extract_response_body(response)
+      return unless response.class.body_permitted?
+      case response.content_type
+      when 'application/json'
+        JSON.parse(response.body, symbolize_names: true)
+      when 'application/pdf'
+        /\Wfilename="(?<filename>.*?)"/ =~ response.fetch('content-disposition')
+        Pdf.new(filename: filename, content: response.body)
+      else
+        response.body
+      end
+    end
+  end
+
+  class ApiError < RuntimeError; end
+end

data/lib/easybill_rest_client/retry_on.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'retryable'
+
+module EasybillRestClient
+  class RetryOn
+    def initialize(logger, tries, retry_cool_off_time)
+      @logger = logger
+      @tries = tries
+      @retry_cool_off_time = retry_cool_off_time
+    end
+
+    def retry_on(klass, &block)
+      Retryable.retryable(retryable_opts(klass), &block)
+    end
+
+    private
+
+    attr_reader :logger, :tries, :retry_cool_off_time
+
+    def retryable_opts(klass)
+      {
+        EasybillRestClient::TooManyRequests => {
+          tries: tries,
+          sleep: retry_cool_off_time,
+          on: klass,
+          exception_cb: method(:log_too_many_requests)
+        },
+        Net::OpenTimeout => {
+          tries: tries,
+          sleep: 0,
+          on: klass,
+          exception_cb: method(:log_open_timeout)
+        }
+      }.fetch(klass)
+    end
+
+    def log_open_timeout(_exception)
+      logger.warn("Unable to open connection after #{Request::OPEN_TIMEOUT}s, retrying...")
+    end
+
+    def log_too_many_requests(_exception)
+      logger.warn('Too many requests!')
+    end
+  end
+end

data/lib/easybill_rest_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  VERSION = '2.0.2'
+end