billomat 0.1.4 → 0.3.0

data/billomat.gemspec

@@ -1,40 +1,46 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "billomat/version"
+require 'billomat/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "billomat"
+  spec.name          = 'billomat'
   spec.version       = Billomat::VERSION
   spec.licenses      = ['MIT']
-  spec.authors       = ["Henning Vogt"]
-  spec.email         = ["henning.vogt@hausgold.de"]
+  spec.authors       = ['Henning Vogt']
+  spec.email         = ['henning.vogt@hausgold.de']
 
-  spec.summary       = %q{Wrapper for the Billomat API}
-  spec.homepage      = "https://github.com/hausgold/billomat"
+  spec.summary       = 'Wrapper for the Billomat API'
+  spec.homepage      = 'https://github.com/hausgold/billomat'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing
+  # to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = '>= 2.0'
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "simplecov", "~> 0.15"
-  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency 'bundler', '>= 1.15', '< 3'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'railties', '>= 4.2.0', '< 6.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.63.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.31'
+  spec.add_development_dependency 'simplecov', '< 0.18'
+  spec.add_development_dependency 'yard', '~> 0.9.18'
+  spec.add_development_dependency 'yard-activesupport-concern', '~> 0.0.1'
 end

data/config/docker/.bash_profile

@@ -0,0 +1,3 @@
+if [ -f ~/.bashrc ]; then
+  . ~/.bashrc
+fi

data/config/docker/.bashrc

@@ -0,0 +1,48 @@
+# ~/.bashrc: executed by bash(1) for non-login shells.
+# see /usr/share/doc/bash/examples/startup-files (in the package bash-doc)
+# for examples
+
+_GEM_PATHS=$(ls -d1 ${HOME}/.gem/ruby/*/bin 2>/dev/null | paste -sd ':')
+_APP_PATHS=$(ls -d1 /app/vendor/bundle/ruby/*/bin 2>/dev/null | paste -sd ':')
+
+export PATH="${_GEM_PATHS}:${_APP_PATHS}:${PATH}"
+export PATH="/app/node_modules/.bin:${HOME}/.bin:/app/bin:${PATH}"
+export MAKE_ENV=baremetal
+
+# Disable the autostart of all supervisord units
+sudo sed -i 's/autostart=.*/autostart=false/g' /etc/supervisor/conf.d/*
+
+# Start the supervisord (empty, no units)
+sudo supervisord >/dev/null 2>&1 &
+
+# Wait for supervisord
+while ! supervisorctl status >/dev/null 2>&1; do sleep 1; done
+
+# Boot the mDNS stack
+echo '# Start the mDNS stack'
+sudo supervisorctl start dbus avahi
+echo
+
+function watch-make-test()
+{
+  while [ 1 ]; do
+    inotifywait --quiet -r `pwd` -e close_write --format '%e -> %w%f'
+    make test
+  done
+}
+
+function watch-make()
+{
+  while [ 1 ]; do
+    inotifywait --quiet -r `pwd` -e close_write --format '%e -> %w%f'
+    make $@
+  done
+}
+
+function watch-run()
+{
+  while [ 1 ]; do
+    inotifywait --quiet -r `pwd` -e close_write --format '%e -> %w%f'
+    bash -c "$@"
+  done
+}

data/config/docker/.inputrc

@@ -0,0 +1,17 @@
+# mappings for Ctrl-left-arrow and Ctrl-right-arrow for word moving
+"\e[1;5C": forward-word
+"\e[1;5D": backward-word
+"\e[5C": forward-word
+"\e[5D": backward-word
+"\e\e[C": forward-word
+"\e\e[D": backward-word
+
+# handle common Home/End escape codes
+"\e[1~": beginning-of-line
+"\e[4~": end-of-line
+"\e[7~": beginning-of-line
+"\e[8~": end-of-line
+"\eOH": beginning-of-line
+"\eOF": end-of-line
+"\e[H": beginning-of-line
+"\e[F": end-of-line

data/doc/assets/project.svg

@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   version="1.1"
+   id="Ebene_1"
+   x="0px"
+   y="0px"
+   viewBox="0 0 800 200"
+   xml:space="preserve"
+   width="800"
+   height="200"><metadata
+   id="metadata33"><rdf:RDF><cc:Work
+       rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
+         rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title></dc:title></cc:Work></rdf:RDF></metadata><defs
+   id="defs31" />
+<style
+   type="text/css"
+   id="style2">
+    .st0{fill-rule:evenodd;clip-rule:evenodd;fill:#E73E11;}
+    .st1{fill-rule:evenodd;clip-rule:evenodd;fill:#0371B9;}
+    .st2{fill:#132E48;}
+    .st3{font-family:'OpenSans-Bold';}
+    .st4{font-size:29.5168px;}
+    .st5{fill-rule:evenodd;clip-rule:evenodd;fill:none;}
+    .st6{opacity:0.5;fill:#132E48;}
+    .st7{font-family:'OpenSans';}
+    .st8{font-size:12px;}
+</style>
+<g
+   transform="translate(0,1.53584)"
+   id="g828"><g
+   transform="translate(35.93985,35.66416)"
+   id="g8">
+    <path
+   style="clip-rule:evenodd;fill:#e73e11;fill-rule:evenodd"
+   id="path4"
+   d="m -0.1,124.4 c 0,0 33.7,-123.2 66.7,-123.2 12.8,0 26.9,21.9 38.8,47.2 -23.6,27.9 -66.6,59.7 -94,76 -7.1,0 -11.5,0 -11.5,0 z"
+   class="st0" />
+    <path
+   style="clip-rule:evenodd;fill:#0371b9;fill-rule:evenodd"
+   id="path6"
+   d="m 88.1,101.8 c 13.5,-10.4 18.4,-16.2 27.1,-25.4 10,25.7 16.7,48 16.7,48 0,0 -41.4,0 -78,0 14.6,-7.9 18.7,-10.7 34.2,-22.6 z"
+   class="st1" />
+</g><text
+   y="106.40316"
+   x="192.43155"
+   style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:29.51733398px;font-family:'Open Sans', sans-serif;-inkscape-font-specification:'OpenSans-Bold, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:start;writing-mode:lr-tb;text-anchor:start;fill:#132e48"
+   id="text10"
+   class="st2 st3 st4">Billomat</text>
+<rect
+   style="clip-rule:evenodd;fill:none;fill-rule:evenodd"
+   id="rect12"
+   height="24"
+   width="314.5"
+   class="st5"
+   y="118.06416"
+   x="194.23985" /><text
+   y="127.22146"
+   x="194.21715"
+   style="font-size:12px;font-family:'Open Sans', sans-serif;opacity:0.5;fill:#132e48;-inkscape-font-specification:'Open Sans, sans-serif, Normal';font-weight:normal;font-style:normal;font-stretch:normal;font-variant:normal;text-anchor:start;text-align:start;writing-mode:lr;font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;"
+   id="text14"
+   class="st6 st7 st8">API wrapper for billomat.com</text>
+</g>
+</svg>

data/docker-compose.yml

@@ -0,0 +1,9 @@
+version: "3"
+services:
+  test:
+    build: .
+    env_file: Envfile
+    network_mode: bridge
+    working_dir: /app
+    volumes:
+      - .:/app

data/lib/billomat/actions/cancel.rb

@@ -2,17 +2,15 @@
 
 module Billomat
   module Actions
-    ##
     # This actions cancels an invoice
     class Cancel
-      # @param [String] invoice_id The invoice ID
+      # @param invoice_id [String] the invoice ID
       # @return [Billomat::Actions::Cancel]
       def initialize(invoice_id)
         @invoice_id = invoice_id
       end
 
-      ##
-      # Calls the gateway
+      # Calls the gateway.
       #
       # @return [TrueClass]
       def call
@@ -21,7 +19,7 @@ module Billomat
         true
       end
 
-      # @return [String] The cancel path with the invoice_id
+      # @return [String] the cancel path with the invoice_id
       def path
         "/invoices/#{@invoice_id}/cancel"
       end

data/lib/billomat/actions/complete.rb

@@ -2,14 +2,12 @@
 
 module Billomat
   module Actions
-    ##
-    # Completes an invoice by calling the /complete path on a resource
+    # Completes an invoice by calling the /complete path on a resource.
     class Complete
-      ##
-      # Returns a Complete object
+      # Returns a Complete object.
       #
-      # @param [String] invoice_id The ID of the invoice
-      # @param [Hash] opts The options for this request
+      # @param invoice_id [String] the ID of the invoice
+      # @param opts [Hash] the options for this request
       # @return [Billomat::Actions::Complete]
       #
       # @example
@@ -19,8 +17,7 @@ module Billomat
         @opts = opts
       end
 
-      ##
-      # Calls the gateway
+      # Calls the gateway.
       #
       # @return [TrueClass]
       def call
@@ -29,15 +26,14 @@ module Billomat
         true
       end
 
-      ##
-      # The given options have to be wrapped
+      # The given options have to be wrapped.
       #
-      # @return [Hash] The payload for the complete request
+      # @return [Hash] the payload for the complete request
       def wrapped_data
         { complete: @opts }
       end
 
-      # @return [String] The complete path with the invoice_id
+      # @return [String] the complete path with the invoice_id
       def path
         "/invoices/#{@invoice_id}/complete"
       end

data/lib/billomat/actions/email.rb

@@ -2,25 +2,22 @@
 
 module Billomat
   module Actions
-    ##
     # This actions sends an invoice email.
     # Recipients must be passed like this:
-    # { recipients: { to: 'bob@example.org' } }
+    #   { recipients: { to: 'bob@example.org' } }
     #
     # @example
     #   Billomat::Actions::Email.new('1235', { recipiens: { to: 'a@b.org' } })
     class Email
-      # @param [String] invoice_id The invoice ID
-      # @param [Hash] opts The options for this action
-      #
+      # @param invoice_id [String] the invoice ID
+      # @param opts [Hash] the options for this action
       # @return [Billomat::Actions::Email]
       def initialize(invoice_id, opts = {})
         @invoice_id = invoice_id
         @opts = opts
       end
 
-      ##
-      # Calls the gateway
+      # Calls the gateway.
       #
       # @return [TrueClass]
       def call
@@ -29,15 +26,14 @@ module Billomat
         true
       end
 
-      ##
       # Wraps the options
       #
-      # @return [Hash] The wrapped email options
+      # @return [Hash] the wrapped email options
       def wrapped_data
         { email: @opts }
       end
 
-      # @return [String] The path for the email action
+      # @return [String] the path for the email action
       def path
         "/invoices/#{@invoice_id}/email"
       end

data/lib/billomat/actions/pdf.rb

@@ -2,21 +2,18 @@
 
 module Billomat
   module Actions
-    ##
     # This class allows to download the invoice as a pdf.
     # The PDF comes in a base64 encoded string in the response body.
     class Pdf
-      # @param [String] invoice_id The invoice ID
-      # @param [Hash] opts The options for this action
-      #
+      # @param invoice_id [String] the invoice ID
+      # @param opts [Hash] the options for this action
       # @return [Billomat::Actions::Pdf]
       def initialize(invoice_id, opts = {})
         @invoice_id = invoice_id
         @opts = opts
       end
 
-      ##
-      # Calls the gateway
+      # Calls the gateway.
       #
       # @return [TrueClass]
       def call
@@ -24,10 +21,7 @@ module Billomat
         resp['pdf']
       end
 
-      ##
-      # Wraps the options
-      #
-      # @return [Hash] The wrapped email options
+      # @return [String] the path for the PDF action
       def path
         "/invoices/#{@invoice_id}/pdf"
       end

data/lib/billomat/actions/uncancel.rb

@@ -2,21 +2,18 @@
 
 module Billomat
   module Actions
-    ##
     # This actions uncancels an canceld invoice.
     #
     # @example
     #   Billomat::Actions::Uncancel.new('1235')
     class Uncancel
-      # @param [String] invoice_id The invoice ID
-      #
+      # @param invoice_id [String] the invoice ID
       # @return [Billomat::Actions::Uncancel]
       def initialize(invoice_id)
         @invoice_id = invoice_id
       end
 
-      ##
-      # Calls the gateway
+      # Calls the gateway.
       #
       # @return [TrueClass]
       def call
@@ -25,7 +22,7 @@ module Billomat
         true
       end
 
-      # @return [String] The path for the uncancel action
+      # @return [String] the path for the uncancel action
       def path
         "/invoices/#{@invoice_id}/uncancel"
       end

data/lib/billomat/actions.rb

@@ -7,7 +7,6 @@ require 'billomat/actions/cancel'
 require 'billomat/actions/uncancel'
 
 module Billomat
-  ##
   # Actions are API calls that do not directly represent a resource.
   # They are mostly non-RESTful actions that are called on a resources.
   module Actions; end

data/lib/billomat/configuration.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module Billomat
+  # The +billomat+ gem configuration.
   class Configuration
-    attr_accessor :api_key, :subdomain, :timeout
+    attr_accessor :api_key, :subdomain, :timeout, :app_id, :app_secret
   end
 end

data/lib/billomat/gateway.rb

@@ -4,16 +4,32 @@ require 'rest-client'
 require 'json'
 
 module Billomat
-  ##
-  # Raised if something goes wrong during an API call
-  class GatewayError < StandardError; end
+  # Raised if something goes wrong during an API call.
+  class GatewayError < StandardError
+    attr_reader :original_exception
 
-  ##
-  # This class can be used by the gem to communicate with the API
+    # Create a new GatewayError from a RestClient exception.
+    #
+    # @param original_exception [RestClient::Exception] the original exception
+    def initialize(original_exception)
+      # Extract the error from the response if it is present. If no error
+      # could be extracted, use the whole body
+      body = original_exception.response&.body
+      response_error = JSON.parse(body).dig('errors', 'error') || body if body
+
+      # Use the default message and append our detailed error
+      message = original_exception.default_message
+      message += " ('#{response_error}')" if response_error
+
+      super(message)
+      @original_exception = original_exception
+    end
+  end
+
+  # This class can be used by the gem to communicate with the API.
   class Gateway
     attr_reader :method, :path, :body
 
-    ##
     # Creates a new Gateway
     #
     # @param [Symbol] method The HTTP verb
@@ -29,25 +45,33 @@ module Billomat
       @body     = body
     end
 
-    ##
-    # Executes the API call
-    # @return [Hash] The response body
+    # Executes the API call and parse the response.
+    #
+    # @return [Hash] the response body
     def run
-      resp = RestClient::Request.execute(
-        method:   method,
-        url:      url,
-        timeout:  timeout,
-        headers:  headers,
-        payload:  body.to_json
-      )
+      resp = response
 
-      raise GatewayError, resp.body if resp.code > 299
       return nil if resp.body.empty?
 
       JSON.parse(resp.body)
+    rescue RestClient::Exception => e
+      raise GatewayError, e
+    end
+
+    # Executes the API call and return the response.
+    #
+    # @return [RestClient::Response] the API response
+    def response
+      RestClient::Request.execute(
+        method: method,
+        url: url,
+        timeout: timeout,
+        headers: headers,
+        payload: body.to_json
+      )
     end
 
-    # @return [String] The complete URL for the request
+    # @return [String] the complete URL for the request
     def url
       "https://#{config.subdomain}.billomat.net/api#{path}"
     end
@@ -57,16 +81,20 @@ module Billomat
       config.timeout || 5
     end
 
-    # @return [Hash] The headers for the request.
+    # @return [Hash] the headers for the request
     def headers
       {
-        'Accept'           => 'application/json',
-        'Content-Type'     => 'application/json',
-        'X-BillomatApiKey' => config.api_key
-      }
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json',
+        'X-BillomatApiKey' => config.api_key,
+        'X-AppId' => config.app_id,
+        'X-AppSecret' => config.app_secret
+      }.reject { |_, val| val.nil? }
     end
 
-    # @return [Billomat::Configuration] The global gem configuration
+    # @return [Billomat::Configuration] the global gem configuration
+    #
+    # :reek:UtilityFunction because it's a shorthand
     def config
       Billomat.configuration
     end