billomat 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17a9ee09e73616ee7ad1742d020dfeb57d3c526873cd164e7d79a2ed2d0952c5
-  data.tar.gz: dc647e0eda845c5d32737c718ea2fb15e44f1b036a2acef8bfc67518c7efdd44
+  metadata.gz: 1d00f8873b7ea8c178761b0ebca4200541d9eaa25ac2cb67500f0b22caf29482
+  data.tar.gz: e7e0f542aa48d665ef1957676b785dc801e27b0f9e754b7ea31318e869142a92
 SHA512:
-  metadata.gz: 99b36daa45bf11cb37e524032d44120f7aa2fbcec5c49ca2bc305803a90ea43b022173b464b6849c72b4125ee4dffcddf96dc23bac62727b0724b5f084249eb8
-  data.tar.gz: 34fd75ef5f5a83b47bd495d0bed039f5c4e78b040f0f95a5f12bd4f1fda9d9e6a64c90ac750d1313bfbfd3ab42f926000fa8df3c78618fc0c1aada646dada152
+  metadata.gz: fff72d6a694ed3b199999291aac06da32f5517de090426b8190467a1a404076095deeae152a007dd96ff4c7722433ab6916523905fd68f5fccfee00456d634cb
+  data.tar.gz: 1e5d35d889fbba13ee6fbca7193a21ea4bf8d10e6baab532b9ad989bcc55c70990801d7558969d79531ad3c8d58f1b10f0b61bf947957a39e58782d096d347c0

data/.github/workflows/documentation.yml

@@ -0,0 +1,38 @@
+name: Build Documentation
+on:
+  repository_dispatch:
+    types: [documentation]
+
+concurrency:
+  group: 'docs'
+
+jobs:
+  docs:
+    name: Build gem documentation
+    runs-on: ubuntu-20.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Build gem documentation
+        run: make docs
+
+      - name: Upload the code coverage report
+        run: coverage
+
+      - name: Add this job to the commit status
+        run: commit-status '${{ job.status }}'
+        if: always()

data/.github/workflows/test.yml

@@ -0,0 +1,59 @@
+name: Test
+on:
+  push:
+    branches:
+      - '**'
+  schedule:
+    - cron: '0 0 * * MON'
+
+concurrency:
+  group: '${{ github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: 'Test the gem (Ruby ${{ matrix.ruby }})'
+    runs-on: ubuntu-20.04
+    timeout-minutes: 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.3, 2.4, 2.5, 2.6]
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Run the gem tests
+        run: make test
+
+      - name: Upload the code coverage report
+        run: coverage
+
+  trigger-docs:
+    name: Trigger the documentation upload
+    runs-on: ubuntu-20.04
+    timeout-minutes: 2
+    needs: test
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/noop
+
+      - name: Trigger the documentation upload
+        run: workflow documentation

data/.gitignore

@@ -3,9 +3,14 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
+/doc/api/
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
+/gemfiles/vendor/
+/Gemfile.lock
+*.gemfile.lock
 
 billomat*.gem
 

data/.rubocop.yml

@@ -0,0 +1,53 @@
+require: rubocop-rspec
+
+Rails:
+  Enabled: true
+
+Documentation:
+  Enabled: true
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+    - build/**/*
+    - gemfiles/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - Rakefile
+    - '*.gemspec'
+    - spec/**/*.rb
+    - '**/*.rake'
+    - doc/**/*.rb
+
+# Document all the things.
+Style/DocumentationMethod:
+  Enabled: true
+  RequireForNonPublicMethods: true
+
+# It's a deliberate idiom in RSpec.
+# See: https://github.com/bbatsov/rubocop/issues/4222
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+# Because +expect_any_instance_of().to have_received()+ is not
+# supported with the +with(hash_including)+ matchers
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Because nesting makes sense here to group the feature tests
+# more effective. This increases maintainability.
+RSpec/NestedGroups:
+  Max: 4
+
+# Disable regular Rails spec paths.
+RSpec/FilePath:
+  Enabled: false
+
+# Because we just implemented the ActiveRecord API.
+Rails/SkipsModelValidations:
+  Enabled: false

data/.yardopts

@@ -0,0 +1,6 @@
+--output-dir=doc/api
+--plugin activesupport-concern
+--markup=rdoc
+-
+README.md
+lib/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+### 0.3.0
+
+* Improve error handling (breaking change, as we are now raising
+  `Billomat::GatewayError`s rather than just the client's
+  `RestClient::Exception`) (#15)
+* Added bang variants to API methods
+  (`Billomat::Models::Base#{save!,create!,update!,delete!}`) (#16)
+* Added `CreditNote` and `CreditNoteItem` models (#14)
+* Moved to GitHub Actions
+* Migrated to our own coverage reporting
+
+### 0.2.0
+
+* Add codeclimate test runner
+* Update codeclimate reporter id
+* Switched to SVG project teasers
+* Updated Travis CI and Code Climate configs (#11)
+* Changed travis-ci.org to travis-ci.com links
+* Adds templates and tags to models (#13)
+
+### 0.1.6
+
+* Support registered apps
+* Added `app_id` and `app_secret` to configuration (#9)
+
+### 0.1.5
+
+* Added contact support
+
+### 0.1.4
+
+* Made timeout configurable
+
+### 0.1.3
+
+* Added `#as_json` to base model
+
+### 0.1.2
+
+* Small fixes and code coverage
+
+### 0.1.1
+
+* Improved documentation and README
+
+### 0.1.0
+
+* Initial release

data/Dockerfile

@@ -0,0 +1,29 @@
+FROM hausgold/ruby:2.5
+MAINTAINER Hermann Mayer <hermann.mayer@hausgold.de>
+
+# Update system gem
+RUN gem update --system
+
+# Install system packages and the latest bundler
+RUN apt-get update -yqqq && \
+  apt-get install -y \
+    build-essential locales sudo vim \
+    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.0' --no-document --no-prerelease && \
+  gem install bundler -v '~> 1.0' --no-document --no-prerelease
+
+# Add new web user
+RUN mkdir /app && \
+  adduser web --home /home/web --shell /bin/bash \
+    --disabled-password --gecos ""
+COPY config/docker/* /home/web/
+RUN chown web:web -R /app /home/web /usr/local/bundle && \
+  mkdir -p /home/web/.ssh
+
+# Set the root password and grant root access to web
+RUN echo 'root:root' | chpasswd
+RUN echo 'web ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
+
+WORKDIR /app

data/Envfile

@@ -0,0 +1,6 @@
+LANG=en_US.UTF-8
+LANGUAGE=en_US.UTF-8
+LC_ALL=en_US.UTF-8
+
+# Just fix this, so Appraisals with Rails 4 are working fine
+BUNDLER_VERSION=1.17.3

data/Gemfile

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

data/Makefile

@@ -0,0 +1,135 @@
+MAKEFLAGS += --warn-undefined-variables -j1
+SHELL := bash
+.SHELLFLAGS := -eu -o pipefail -c
+.DEFAULT_GOAL := all
+.DELETE_ON_ERROR:
+.SUFFIXES:
+.PHONY:
+
+# Environment switches
+MAKE_ENV ?= docker
+COMPOSE_RUN_SHELL_FLAGS ?= --rm
+
+# Directories
+VENDOR_DIR ?= vendor/bundle
+
+# Host binaries
+AWK ?= awk
+BASH ?= bash
+COMPOSE ?= docker-compose
+DOCKER ?= docker
+GREP ?= grep
+ID ?= id
+MKDIR ?= mkdir
+RM ?= rm
+XARGS ?= xargs
+
+# Container binaries
+BUNDLE ?= bundle
+GEM ?= gem
+RAKE ?= rake
+RUBOCOP ?= rubocop
+YARD ?= yard
+
+# Define a generic shell run wrapper
+# $1 - The command to run
+ifeq ($(MAKE_ENV),docker)
+define run-shell
+	$(COMPOSE) run $(COMPOSE_RUN_SHELL_FLAGS) \
+		-e LANG=en_US.UTF-8 -e LANGUAGE=en_US.UTF-8 -e LC_ALL=en_US.UTF-8 \
+		-e HOME=/home/web -e BUNDLE_APP_CONFIG=/app/.bundle \
+		-u `$(ID) -u` test bash -c 'sleep 0.1; echo; $(1)'
+endef
+else ifeq ($(MAKE_ENV),baremetal)
+define run-shell
+	$(1)
+endef
+endif
+
+all:
+	# Billomat
+	#
+	# install            Install the dependencies
+	# update             Update the local Gemset dependencies
+	# clean              Clean the dependencies
+	#
+	# test               Run the whole test suite
+	# test-style         Test the code styles
+	#
+	# docs               Generate the Ruby documentation of the library
+	# stats              Print the code statistics (library and test suite)
+	# notes              Print all the notes from the code
+	# release            Release a new Gem version (maintainers only)
+	#
+	# shell              Run an interactive shell on the container
+	# shell-irb          Run an interactive IRB shell on the container
+
+install:
+	# Install the dependencies
+	@$(MKDIR) -p $(VENDOR_DIR)
+	@$(call run-shell,$(BUNDLE) check || $(BUNDLE) install --path $(VENDOR_DIR))
+	@$(call run-shell,GEM_HOME=vendor/bundle/ruby/$${RUBY_MAJOR}.0 \
+		$(GEM) install bundler -v "~> 1.0")
+
+test: \
+	test-specs \
+	test-style
+
+test-specs:
+	# Run the whole test suite
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats spec)
+
+test-style: \
+	test-style-ruby
+
+test-style-ruby:
+	# Run the static code analyzer (rubocop)
+	@$(call run-shell,$(BUNDLE) exec $(RUBOCOP) -a)
+
+clean:
+	# Clean the dependencies
+	@$(RM) -rf $(VENDOR_DIR)
+	@$(RM) -rf $(VENDOR_DIR)/Gemfile.lock
+	@$(RM) -rf pkg
+	@$(RM) -rf coverage
+
+clean-containers:
+	# Clean running containers
+ifeq ($(MAKE_ENV),docker)
+	@$(COMPOSE) down
+endif
+
+clean-images:
+	# Clean build images
+ifeq ($(MAKE_ENV),docker)
+	@-$(DOCKER) images | $(GREP) rimless \
+		| $(AWK) '{ print $$3 }' \
+		| $(XARGS) -rn1 $(DOCKER) rmi -f
+endif
+
+distclean: clean clean-containers clean-images
+
+shell:
+	# Run an interactive shell on the container
+	@$(call run-shell,$(BASH) -i)
+
+shell-irb:
+	# Run an interactive IRB shell on the container
+	@$(call run-shell,bin/console)
+
+docs:
+	# Build the API documentation
+	@$(call run-shell,$(BUNDLE) exec $(YARD) -q && \
+		$(BUNDLE) exec $(YARD) stats --list-undoc --compact)
+
+notes:
+	# Print the code statistics (library and test suite)
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) notes)
+
+stats:
+	# Print all the notes from the code
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats)
+
+release:
+	# Release a new gem version
+	@$(BUNDLE) exec $(RAKE) release

data/README.md

@@ -1,10 +1,10 @@
 ![Billomat](doc/assets/project.svg)
 
-[![Build Status](https://travis-ci.com/hausgold/billomat.svg?branch=master)](https://travis-ci.com/hausgold/billomat)
+[![Continuous Integration](https://github.com/hausgold/billomat/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/hausgold/billomat/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/billomat.svg)](https://badge.fury.io/rb/billomat)
-[![Maintainability](https://api.codeclimate.com/v1/badges/21ac719680afa0a102c0/maintainability)](https://codeclimate.com/repos/5cac8ab2feb8e979a4008130/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/21ac719680afa0a102c0/test_coverage)](https://codeclimate.com/repos/5cac8ab2feb8e979a4008130/test_coverage)
-[![API docs](https://img.shields.io/badge/docs-API-blue.svg)](https://www.rubydoc.info/gems/billomat)
+[![Test Coverage](https://automate-api.hausgold.de/v1/coverage_reports/billomat/coverage.svg)](https://knowledge.hausgold.de/coverage)
+[![Test Ratio](https://automate-api.hausgold.de/v1/coverage_reports/billomat/ratio.svg)](https://knowledge.hausgold.de/coverage)
+[![API docs](https://automate-api.hausgold.de/v1/coverage_reports/billomat/documentation.svg)](https://www.rubydoc.info/gems/billomat)
 
 This gem provides a Ruby API for [billomat.com](https://billomat.com) - an
 online accounting service.

data/Rakefile

@@ -1,6 +1,77 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rails/code_statistics'
+require 'pp'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
+
+# Load some railties tasks
+load 'rails/tasks/statistics.rake'
+load 'rails/tasks/annotations.rake'
+
+# Clear the default statistics directory constant
+#
+# rubocop:disable Style/MutableConstant because we define it
+Object.send(:remove_const, :STATS_DIRECTORIES)
+::STATS_DIRECTORIES = []
+# rubocop:enable Style/MutableConstant
+
+# Monkey patch the Rails +CodeStatistics+ class to support configurable
+# patterns per path. This is reuqired to support top-level only file matches.
+class CodeStatistics
+  DEFAULT_PATTERN = /^(?!\.).*?\.(rb|js|coffee|rake)$/.freeze
+
+  # Pass the possible +pattern+ argument down to the
+  # +calculate_directory_statistics+ method call.
+  def calculate_statistics
+    Hash[@pairs.map do |pair|
+      [pair.first, calculate_directory_statistics(*pair[1..-1])]
+    end]
+  end
+
+  # Match the pattern against the individual file name and the relative file
+  # path. This allows top-level only matches.
+  def calculate_directory_statistics(directory, pattern = DEFAULT_PATTERN)
+    stats = CodeStatisticsCalculator.new
+
+    Dir.foreach(directory) do |file_name|
+      path = "#{directory}/#{file_name}"
+
+      if File.directory?(path) && (/^\./ !~ file_name)
+        stats.add(calculate_directory_statistics(path, pattern))
+      elsif file_name =~ pattern || path =~ pattern
+        stats.add_by_file_path(path)
+      end
+    end
+
+    stats
+  end
+end
+
+# Configure all code statistics directories
+vendors = [
+  [:unshift, 'Top-levels', 'lib', %r{lib(/billomat)?/[^/]+\.rb$}],
+  [:unshift, 'Top-levels specs', 'spec', %r{spec/[^/]+_spec\.rb$}],
+
+  [:unshift, 'Actions', 'lib/billomat/actions'],
+
+  [:unshift, 'Models matchers', 'lib/billomat/models'],
+  [:unshift, 'Models matchers specs', 'spec/models']
+].reverse
+
+vendors.each do |method, type, dir, pattern|
+  ::STATS_DIRECTORIES.send(method, [type, dir, pattern].compact)
+  ::CodeStatistics::TEST_TYPES << type if type.include? 'specs'
+end
+
+# Setup annotations
+ENV['SOURCE_ANNOTATION_DIRECTORIES'] = 'spec,doc'
+
+desc 'Enumerate all annotations'
+task :notes do
+  SourceAnnotationExtractor.enumerate '@?OPTIMIZE|@?FIXME|@?TODO', tag: true
+end

data/billomat.gemspec

@@ -31,13 +31,16 @@ 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.0'
-
   spec.add_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
 
   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 'simplecov', '~> 0.15'
+  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/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