billomat 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d9fef7b349e89c146999e6725312eabdf22fd8e75a22ca8f388329d1297f2f9
-  data.tar.gz: 3205b27c8a21272b9bb46cb4991a9460d36ef7a12832ae4ebaa83890ca7a83e9
+  metadata.gz: db8e1e9679da101e6935b9e7d39eb71b690cee55361fc044adaeea8f258035fd
+  data.tar.gz: c6b5715bfb71b6ba5195316fe159c943fc933c3c18f9beeb98dda8f61d365ded
 SHA512:
-  metadata.gz: 88c96ee5c03eacfe8fce57523cac662771469aa716fd60ebb47686143ed20e3a4df30f912d84847b7c235d9b06db75a4ea6eff877f4a8e40f515205b7392d570
-  data.tar.gz: f86c7a69e61f131a2bc778309226c2e9ef9e364853cee4c9369d53e73e5e220dd3060ac583c91e6ae0b1101ef84311de0d7e7e0b0c819a2ae2662c04199c12b2
+  metadata.gz: c3da6248dd1adea3abc0343694576f10ad31af6e3aba3f5bcf99473bc9ff08e00bdd33bf025cd1ef63a96b27fe581e4e042abc88ad31f6ac144f03b1cf4c5b2c
+  data.tar.gz: b7c8e90c897d16409c1ff61606c7f2d41fb8dd8ec439eaaade92641bb9d7956c059b41a39a7474868da08ff89d1bc2db8ad931377ebcab12dd1926df0741a887

data/.github/workflows/documentation.yml

@@ -12,19 +12,20 @@ jobs:
     runs-on: ubuntu-22.04
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Install the correct Ruby version
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.5
+          ruby-version: 2.7
           bundler-cache: true
-          rubygems: '3.3.26'
+          rubygems: '3.4.22'
 
       - name: Prepare the virtual environment
         uses: hausgold/actions/ci@master
         with:
           clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}'
           settings: '${{ github.repository }}'
           target: ci/gem-test
 

data/.github/workflows/release.yml

@@ -18,19 +18,20 @@ jobs:
     runs-on: ubuntu-22.04
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Install Ruby 2.5
+      - name: Install Ruby 2.7
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.5
+          ruby-version: 2.7
           bundler-cache: true
-          rubygems: '3.3.26'
+          rubygems: '3.4.22'
 
       - name: Prepare the virtual environment
         uses: hausgold/actions/ci@master
         with:
           clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}'
           settings: '${{ github.repository }}'
           target: ci/gem-test
 

data/.github/workflows/test.yml

@@ -18,21 +18,22 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.5', '2.7']
+        ruby: ['2.7']
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Install the correct Ruby version
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-          rubygems: '3.3.26'
+          rubygems: '3.4.22'
 
       - name: Prepare the virtual environment
         uses: hausgold/actions/ci@master
         with:
           clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}'
           settings: '${{ github.repository }}'
           target: ci/gem-test
 
@@ -53,6 +54,7 @@ jobs:
         uses: hausgold/actions/ci@master
         with:
           clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}'
           settings: '${{ github.repository }}'
           target: ci/noop
 

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/log/
 /vendor/
 /gemfiles/vendor/
 /Gemfile.lock

data/.rubocop.yml

@@ -12,7 +12,7 @@ AllCops:
   NewCops: enable
   SuggestExtensions: false
   DisplayCopNames: true
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   TargetRailsVersion: 5.2
   Exclude:
     - bin/**/*

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 1.2.0
+
+* Moved the development dependencies from the gemspec to the Gemfile (#19)
+* Introduce `after_response` callback (#22)
+* Fix response parsing for responses exceeding the page size (#23)
+* Dropped support for Ruby <2.7 (#24)
+
 ### 1.1.0
 
 * Added support for Gem release automation

data/Dockerfile

@@ -1,8 +1,8 @@
-FROM hausgold/ruby:2.5
+FROM hausgold/ruby:2.7
 MAINTAINER Hermann Mayer <hermann.mayer@hausgold.de>
 
 # Update system gem
-RUN gem update --system '3.3.26'
+RUN gem update --system '3.4.22'
 
 # Install system packages and the latest bundler
 RUN apt-get update -yqqq && \
@@ -11,7 +11,7 @@ RUN apt-get update -yqqq && \
     ca-certificates \
     bash-completion inotify-tools && \
   echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && /usr/sbin/locale-gen && \
-  gem install bundler -v '~> 2.3.0' --no-document --no-prerelease
+  gem install bundler -v '~> 2.4.22' --no-document --no-prerelease
 
 # Add new web user
 RUN mkdir /app && \

data/Gemfile

@@ -4,3 +4,17 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in billomat.gemspec
 gemspec
+
+# Development dependencies
+gem 'bundler', '~> 2.3'
+gem 'countless', '~> 1.1'
+gem 'guard-rspec', '~> 4.7'
+gem 'irb', '~> 1.2'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.12'
+gem 'rubocop', '~> 1.28'
+gem 'rubocop-rails', '~> 2.14'
+gem 'rubocop-rspec', '~> 2.10'
+gem 'simplecov', '>= 0.22'
+gem 'yard', '>= 0.9.28'
+gem 'yard-activesupport-concern', '>= 0.0.1'

data/Makefile

@@ -23,6 +23,7 @@ GREP ?= grep
 ID ?= id
 MKDIR ?= mkdir
 RM ?= rm
+TEST ?= test
 XARGS ?= xargs
 
 # Container binaries
@@ -33,6 +34,7 @@ RAKE ?= rake
 RSPEC ?= rspec
 RUBOCOP ?= rubocop
 YARD ?= yard
+RUBY_VERSION := ruby-version
 
 # Define a generic shell run wrapper
 # $1 - The command to run
@@ -98,7 +100,8 @@ test-style: \
 
 test-style-ruby:
 	# Run the static code analyzer (rubocop)
-	@$(call run-shell,$(BUNDLE) exec $(RUBOCOP) -a)
+	@$(call run-shell,$(BUNDLE) exec $(RUBOCOP) -a \
+		|| ($(TEST) $$($(RUBY_VERSION)) != '2.7' && true))
 
 clean:
 	# Clean the dependencies

data/README.md

@@ -60,6 +60,11 @@ Billomat.configure do |config|
   # https://www.billomat.com/en/api/basics/rate-limiting/
   config.app_id = '12345'
   config.app_secret = 'c3df...'
+
+  config.after_response = lambda do |response|
+    # API response callback, e.g. for inspecting the rate limit
+    # header via response.headers[:x_rate_limit_remaining]
+  end
 end
 ```
 

data/billomat.gemspec

@@ -31,20 +31,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5'
-
-  spec.add_dependency 'rest-client', '~> 2.1'
-
-  spec.add_development_dependency 'bundler', '~> 2.3'
-  spec.add_development_dependency 'countless', '~> 1.1'
-  spec.add_development_dependency 'guard-rspec', '~> 4.7'
-  spec.add_development_dependency 'irb', '~> 1.2'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.12'
-  spec.add_development_dependency 'rubocop', '~> 1.28'
-  spec.add_development_dependency 'rubocop-rails', '~> 2.14'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.10'
-  spec.add_development_dependency 'simplecov', '>= 0.22'
-  spec.add_development_dependency 'yard', '>= 0.9.28'
-  spec.add_development_dependency 'yard-activesupport-concern', '>= 0.0.1'
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.add_runtime_dependency 'rest-client', '~> 2.1'
 end

data/config/docker/.bashrc

@@ -16,7 +16,9 @@ sudo sed -i 's/autostart=.*/autostart=false/g' /etc/supervisor/conf.d/*
 sudo supervisord >/dev/null 2>&1 &
 
 # Wait for supervisord
-while ! supervisorctl status >/dev/null 2>&1; do sleep 1; done
+while ! (sudo supervisorctl status | grep avahi) >/dev/null 2>&1; do
+  sleep 1
+done
 
 # Boot the mDNS stack
 echo '# Start the mDNS stack'

data/lib/billomat/configuration.rb

@@ -4,5 +4,17 @@ module Billomat
   # The +billomat+ gem configuration.
   class Configuration
     attr_accessor :api_key, :subdomain, :timeout, :app_id, :app_secret
+    attr_reader :after_response
+
+    # Sets a callback to be called for each API response
+    #
+    # @param [Proc] callback The callback
+    def after_response=(callback)
+      unless callback.respond_to?(:call)
+        raise ArgumentError, "callback must respond to `call'"
+      end
+
+      @after_response = callback
+    end
   end
 end

data/lib/billomat/gateway.rb

@@ -68,7 +68,7 @@ module Billomat
         timeout: timeout,
         headers: headers,
         payload: body.to_json
-      )
+      ).tap { |response| Billomat.configuration.after_response&.call(response) }
     end
 
     # @return [String] the complete URL for the request

data/lib/billomat/search.rb

@@ -31,22 +31,20 @@ module Billomat
 
     # Corrects the response to always return an array.
     #
-    # @todo Due to a strange API behaviour we have to fix the reponse here.
+    # @todo Due to a strange API behaviour we have to fix the response here.
     #   This may be fixed in a new API version.
     #
     # @param [Hash] resp The response from the gateway
     # @return [Array<Billomat::Model::Base>]
     def to_array(resp)
-      case count(resp)
-      when 0
-        []
-      when 1
-        # Necessary due to strange API behaviour
-        [@resource.new(resp["#{name}s"][name])]
+      data = resp["#{name}s"][name]
+      case data
+      when Hash
+        [@resource.new(data)]
+      when Array
+        data.map { |d| @resource.new(d) }
       else
-        resp["#{name}s"][name].map do |c|
-          @resource.new(c)
-        end
+        []
       end
     end
 

data/lib/billomat/version.rb

@@ -3,7 +3,7 @@
 # The gem version details.
 module Billomat
   # The version of the +billomat+ gem
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 
   class << self
     # Returns the version of gem as a string.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: billomat
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Hermann Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-24 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -25,174 +25,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: countless
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: irb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.28'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.28'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.10'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.28
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.28
-- !ruby/object:Gem::Dependency
-  name: yard-activesupport-concern
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.1
 description: Wrapper for the Billomat API
 email:
 - hermann.mayer92@gmail.com
@@ -268,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="