easybill-rest-client 2.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92b006244a9142506053278b0b9c56fbb96e6b3cf58856cfd8a5296b08e7dbd1
+  data.tar.gz: a5ddb7245844485df70f46dd09d366790b957d97b6a413cb1bf0bf14be9f754f
+SHA512:
+  metadata.gz: 190c9feb979a54ce7fcf84f4873956c9293a79a69ccaaac7e45df9b14b15427bb6605023c2b6ee3f2206195f96dbfe4afeddd68087cb1164b02b03f8c22b3594
+  data.tar.gz: 5bcc9802b9af857911cd7af7e92a4a4f20a2ff61092511297b06b9fb24289b1b1cba0b0f845b3e8604d48287df603161178efe5e17fcb7521e5abae7fc212471

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec
+
+gem 'rubocop-ci', git: 'https://github.com/ad2games/rubocop-ci'

data/Gemfile.lock

@@ -0,0 +1,152 @@
+GIT
+  remote: https://github.com/ad2games/rubocop-ci
+  revision: 7a87c0c6579154915ad94e1ecfd7185b0c04d202
+  specs:
+    rubocop-ci (1.0.1)
+      brakeman-min (~> 4.0.1)
+      coffeelint (~> 1.16.0)
+      highline
+      rake
+      rubocop (~> 0.52.0)
+      rubocop-rspec (= 1.19.0)
+      scss_lint (~> 0.56.0)
+      slim_lint (~> 0.15.0)
+      terminal-table
+
+PATH
+  remote: .
+  specs:
+    easybill-rest-client (2.0.2)
+      retryable (~> 2.0)
+      virtus (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    brakeman-min (4.0.1)
+      ruby2ruby (~> 2.4.0)
+      ruby_parser (~> 3.10.0)
+      safe_yaml (>= 1.0)
+      sexp_processor (~> 4.7)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.12.2)
+    coffeelint (1.16.1)
+      coffee-script
+      execjs
+      json
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    execjs (2.7.0)
+    ffi (1.9.23)
+    hashdiff (0.3.7)
+    highline (1.7.10)
+    ice_nine (0.11.2)
+    json (2.1.0)
+    method_source (0.9.0)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    retryable (2.0.4)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.19.0)
+      rubocop (>= 0.51.0)
+    ruby-progressbar (1.9.0)
+    ruby2ruby (2.4.1)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.6)
+    ruby_parser (3.10.1)
+      sexp_processor (~> 4.9)
+    safe_yaml (1.0.4)
+    sass (3.5.6)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    scss_lint (0.56.0)
+      rake (>= 0.9, < 13)
+      sass (~> 3.5.3)
+    sexp_processor (4.11.0)
+    slim (3.0.9)
+      temple (>= 0.7.6, < 0.9)
+      tilt (>= 1.3.3, < 2.1)
+    slim_lint (0.15.1)
+      rake (>= 10, < 13)
+      rubocop (>= 0.50.0)
+      slim (~> 3.0)
+      sysexits (~> 1.1)
+    sysexits (1.2.0)
+    temple (0.8.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    unicode-display_width (1.3.3)
+    vcr (3.0.3)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  easybill-rest-client!
+  pry
+  rspec (~> 3.4)
+  rubocop-ci!
+  vcr (~> 3.0)
+  webmock (~> 2.1)
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -0,0 +1,8 @@
+# easybill-rest-client [![Circle CI](https://circleci.com/gh/ad2games/easybill-rest-client/tree/master.svg?style=svg)](https://circleci.com/gh/ad2games/easybill-rest-client/tree/master)
+
+A client library for the Easybill REST API
+
+## TODO
+
+* Add more integration tests
+* Add usage information

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop-ci'

data/config.json

@@ -0,0 +1,5 @@
+{
+  "gemName": "easybill-rest-client",
+  "moduleName": "EasybillRestClient",
+  "gemVersion": "1.0.0"
+}

data/easybill-rest-client.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'easybill_rest_client/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'easybill-rest-client'
+  s.version     = EasybillRestClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['ad2games GmbH']
+  s.email       = ['developers@ad2games.com']
+  s.homepage    = 'http://ad2games.com'
+  s.summary     = 'A ruby wrapper for the Easybill REST API'
+  s.description = 'A ruby wrapper for the Easybill REST API'
+  s.license     = 'MIT'
+
+  s.add_runtime_dependency 'retryable', '~> 2.0'
+  s.add_runtime_dependency 'virtus', '~> 1.0'
+
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rspec', '~> 3.4'
+  s.add_development_dependency 'vcr', '~> 3.0'
+  s.add_development_dependency 'webmock', '~> 2.1'
+
+  s.files         = `find *`.split("\n").uniq.sort.reject(&:empty?)
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = %w[lib]
+end

data/lib/easybill-rest-client.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'virtus'
+
+require 'easybill_rest_client/customer'
+require 'easybill_rest_client/document_address'
+require 'easybill_rest_client/document_item'
+require 'easybill_rest_client/document_recurring_options'
+require 'easybill_rest_client/document_service_date'
+require 'easybill_rest_client/document'
+require 'easybill_rest_client/post_box'
+require 'easybill_rest_client/document_payment'
+require 'easybill_rest_client/pdf'
+
+require 'easybill_rest_client/client'

data/lib/easybill_rest_client/api_client.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'logger'
+require 'net/http'
+require 'securerandom'
+
+require 'easybill_rest_client/request'
+require 'easybill_rest_client/response'
+
+module EasybillRestClient
+  class ApiClient
+    DEFAULT_RETRY_COOL_OFF_TIME = 15
+    DEFAULT_TRIES = 5
+    MAX_PAGE_SIZE = 1000
+
+    def initialize(options = {})
+      @api_key = options.fetch(:api_key)
+      @retry_cool_off_time = options.fetch(:retry_cool_off_time, DEFAULT_RETRY_COOL_OFF_TIME)
+      @tries = options.fetch(:tries, DEFAULT_TRIES)
+      @logger = options.fetch(:logger, Logger.new($stdout))
+    end
+
+    def request_collection(method, endpoint, params = {})
+      fetch_pages do |page|
+        request(method, endpoint, params.merge(page: page, limit: MAX_PAGE_SIZE))
+      end
+    end
+
+    def request(method, endpoint, params = {})
+      request = Request.new(
+        api_key: api_key,
+        method: method,
+        endpoint: endpoint,
+        params: params,
+        logger: logger,
+        tries: tries,
+        retry_cool_off_time: retry_cool_off_time
+      )
+      Response.new(request.run).body
+    end
+
+    private
+
+    def fetch_pages
+      Enumerator.new do |y|
+        page = 1
+        loop do
+          collection = yield(page)
+          collection[:items].each do |item|
+            y << item
+          end
+          break if collection[:page] >= collection[:pages]
+          page += 1
+        end
+      end.lazy
+    end
+
+    attr_reader :api_key, :retry_cool_off_time, :tries, :logger
+  end
+end

data/lib/easybill_rest_client/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'easybill_rest_client/api_client'
+require 'easybill_rest_client/customer_api'
+require 'easybill_rest_client/document_api'
+require 'easybill_rest_client/post_box_api'
+require 'easybill_rest_client/document_payment_api'
+
+module EasybillRestClient
+  class Client
+    def initialize(options = {})
+      @options = options
+    end
+
+    def customers
+      @customers ||= CustomerApi.new(api_client)
+    end
+
+    def documents
+      @documents ||= DocumentApi.new(api_client)
+    end
+
+    def post_boxes
+      @post_boxes ||= PostBoxApi.new(api_client)
+    end
+
+    def document_payments
+      @document_payments ||= DocumentPaymentApi.new(api_client)
+    end
+
+    private
+
+    attr_reader :options
+
+    def api_client
+      @api_client ||= ApiClient.new(options)
+    end
+  end
+end

data/lib/easybill_rest_client/customer.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  class Customer
+    include Virtus.model
+    values do
+      attribute :id, Integer
+    end
+    attribute :acquire_options, String # a digit 1..8
+    attribute :bank_account, String
+    attribute :bank_account_owner, String
+    attribute :bank_bic, String
+    attribute :bank_code, String
+    attribute :bank_iban, String
+    attribute :bank_name, String
+    attribute :birth_date, String
+    attribute :cash_allowance, String
+    attribute :cash_allowance_days, String
+    attribute :cash_discount, String
+    attribute :cash_discount_type, String
+    attribute :city, String
+    attribute :company_name, String
+    attribute :country, String
+    attribute :delivery_city, String
+    attribute :delivery_company_name, String
+    attribute :delivery_country, String
+    attribute :delivery_first_name, String
+    attribute :delivery_last_name, String
+    attribute :delivery_personal, String
+    attribute :delivery_salutation, String
+    attribute :delivery_street, String
+    attribute :delivery_suffix_1, String
+    attribute :delivery_suffix_2, String
+    attribute :delivery_zip_code, String
+    attribute :emails, Array[String]
+    attribute :fax, String
+    attribute :first_name, String
+    attribute :grace_period, String
+    attribute :group_id, String
+    attribute :info_1, String
+    attribute :info_2, String
+    attribute :internet, String
+    attribute :last_name, String
+    attribute :mobile, String
+    attribute :note, String
+    attribute :number, String
+    attribute :payment_options, String
+    attribute :personal, Boolean
+    attribute :phone_1, String
+    attribute :phone_2, String
+    attribute :postbox, String
+    attribute :postbox_city, String
+    attribute :postbox_country, String
+    attribute :postbox_zip_code, String
+    attribute :sale_price_level, String
+    attribute :salutation, String
+    attribute :sepa_agreement, String
+    attribute :sepa_agreement_date, String
+    attribute :sepa_mandate_reference, String
+    attribute :since_date, String
+    attribute :street, String
+    attribute :suffix_1, String
+    attribute :suffix_2, String
+    attribute :tax_number, String
+    attribute :tax_options, String
+    attribute :title, String
+    attribute :vat_identifier, String
+    attribute :zip_code, String
+  end
+end

data/lib/easybill_rest_client/customer_api.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'easybill_rest_client/generic_api'
+
+module EasybillRestClient
+  class CustomerApi < GenericApi
+    def resource_name
+      'customers'
+    end
+
+    def resource_class
+      Customer
+    end
+  end
+end

data/lib/easybill_rest_client/document.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  class Document
+    include Virtus.model
+    values do
+      attribute :id, Integer
+    end
+    attribute :address, DocumentAddress
+    attribute :amount_net, Integer
+    attribute :amount, Integer
+    attribute :bank_debit_form, String
+    attribute :cancel_id, Integer
+    attribute :cash_allowance_days, Integer
+    attribute :cash_allowance, String
+    attribute :cash_allowance_text, String
+    attribute :contact_id, Integer
+    attribute :contact_label, String
+    attribute :contact_text, String
+    attribute :created_at, DateTime
+    attribute :currency, String
+    attribute :customer_id, Integer
+    attribute :discount, String
+    attribute :discount_type, String
+    attribute :document_date, Date
+    attribute :due_date, Date
+    attribute :edited_at, String
+    attribute :grace_period, Integer
+    attribute :is_archive, Boolean
+    attribute :is_draft, Boolean
+    attribute :items, [DocumentItem]
+    attribute :label_address, DocumentAddress
+    attribute :number, String
+    attribute :paid_amount, Integer
+    attribute :paid_at, Date
+    attribute :pdf_pages, Integer
+    attribute :pdf_template, String
+    attribute :project_id, String
+    attribute :recurring_options, DocumentRecurringOptions
+    attribute :ref_id, Integer
+    attribute :service_date, DocumentServiceDate
+    attribute :status, String # TODO: enum
+    attribute :text_prefix, String
+    attribute :text, String
+    attribute :title, String
+    attribute :type, String # .enum(
+    #   'INVOICE', 'RECURRING', 'CREDIT', 'OFFER', 'REMINDER', 'DUNNING',
+    #   'STORNO', 'DELIVERY', 'CHARGE', 'CHARGE_CONFIRM', 'LETTER', 'ORDER'
+    # )
+    attribute :use_shipping_address, Boolean
+    attribute :vat_option, String
+  end
+end

data/lib/easybill_rest_client/document_address.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  class DocumentAddress
+    include Virtus.model
+    attribute :salutation, String
+    attribute :personal, Boolean
+    attribute :title, String
+    attribute :first_name, String
+    attribute :last_name, String
+    attribute :suffix_1, String
+    attribute :suffix_2, String
+    attribute :company_name, String
+    attribute :street, String
+    attribute :zip_code, String
+    attribute :city, String
+    attribute :country, String
+  end
+end

data/lib/easybill_rest_client/document_api.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'easybill_rest_client/generic_api'
+
+module EasybillRestClient
+  class DocumentApi < GenericApi
+    def resource_name
+      'documents'
+    end
+
+    def resource_class
+      Document
+    end
+
+    def get_pdf(document_id)
+      api_client.request(:get, "/#{resource_name}/#{document_id}/pdf")
+    end
+
+    def send_email(document_id, email_params = {})
+      api_client.request(:post, "/#{resource_name}/#{document_id}/send/email", email_params)
+    end
+
+    def finish(document_id)
+      build(api_client.request(:put, "/#{resource_name}/#{document_id}/done"))
+    end
+
+    def cancel(document_id)
+      build(api_client.request(:post, "/documents/#{document_id}/cancel"))
+    end
+  end
+end

data/lib/easybill_rest_client/document_item.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  class DocumentItem
+    include Virtus.model
+    values do
+      attribute :id, Integer
+    end
+    attribute :number, String
+    attribute :description, String
+    attribute :quantity, Integer
+    attribute :unit, String
+    attribute :type, String # TODO: enum
+    attribute :position, Integer
+    attribute :single_price_net, Float
+    attribute :single_price_gross, Float # TODO: Should we round here?
+    attribute :vat_percent, Integer
+    attribute :discount, Integer
+    attribute :discount_type, String
+    attribute :position_id, Integer
+    attribute :total_price_net, Float
+    attribute :total_price_gross, Float # TODO: Should we round here?
+    attribute :total_vat, Integer
+    attribute :serial_number_id, String
+    attribute :serial_number, String
+    attribute :booking_account, String
+    attribute :export_cost_1, String
+    attribute :export_cost_2, String
+    attribute :cost_price_net, Integer
+    attribute :cost_price_total, Integer
+    attribute :cost_price_charge, Integer
+    attribute :cost_price_charge_type, String
+  end
+end

data/lib/easybill_rest_client/document_payment.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  class DocumentPayment
+    include Virtus.model
+    values do
+      attribute :id, Integer
+    end
+    attribute :amount, Integer
+    attribute :document_id, Integer
+    attribute :notice, String
+    attribute :payment_at, Date
+    attribute :type, String
+  end
+end

data/lib/easybill_rest_client/document_payment_api.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'easybill_rest_client/generic_api'
+
+module EasybillRestClient
+  class DocumentPaymentApi < GenericApi
+    def resource_name
+      'document-payments'
+    end
+
+    def resource_class
+      DocumentPayment
+    end
+  end
+end

data/lib/easybill_rest_client/document_recurring_options.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  class DocumentRecurringOptions
+    include Virtus.model
+    attribute :end_date_or_count, String
+    attribute :frequency_special, String # TODO: enum
+    attribute :frequency, String
+    attribute :interval, Integer
+    attribute :is_draft, Boolean
+    attribute :is_notify, Boolean
+    attribute :is_paid, Boolean
+    attribute :is_sepa, Boolean
+    attribute :is_sign, Boolean
+    attribute :next_date, Date
+    attribute :send_as, String # TODO: enum
+    attribute :sepa_local_instrument, String # TODO: enum
+    attribute :sepa_reference, String
+    attribute :sepa_remittance_information, String
+    attribute :sepa_sequence_type, String # TODO: enum
+    attribute :status, String # TODO: enum
+  end
+end

data/lib/easybill_rest_client/document_service_date.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module EasybillRestClient
+  class DocumentServiceDate
+    include Virtus.model
+    attribute :type, String # TODO: enum
+    attribute :date, Date
+    attribute :date_from, Date
+    attribute :date_to, Date
+    attribute :text, String
+  end
+end