billomat 0.2.0 → 0.3.0

data/lib/billomat/search.rb

@@ -3,11 +3,9 @@
 require 'uri'
 
 module Billomat
-  ##
-  # This class provides the possibility to query the resources
+  # This class provides the possibility to query the resources.
   class Search
-    ##
-    # Creates a new search object
+    # Creates a new search object.
     #
     # @param [Class] resource The resource class to be queried
     # @param [Hash] hash The query
@@ -16,23 +14,22 @@ module Billomat
       @hash     = hash
     end
 
-    # @return [String] The path including the query
+    # @return [String] the path including the query
     def path
       "#{@resource.base_path}?#{hash_to_query}"
     end
 
-    ##
-    # Runs the query and calls the gateway
-    # Currently it will always return an empty array when no query is provided
+    # Runs the query and calls the gateway.
+    # Currently it will always return an empty array when no query is provided.
     #
     # @return [Array<Billomat::Model::Base>]
     def run
-      return [] if @hash.reject { |k, v| v.nil? }.empty?
+      return [] if @hash.reject { |_k, v| v.nil? }.empty?
+
       to_array(Billomat::Gateway.new(:get, path).run)
     end
 
-    ##
-    # Corrects the response to always return an array
+    # Corrects the response to always return an array.
     #
     # @todo Due to a strange API behaviour we have to fix the reponse here.
     #   This may be fixed in a new API version.
@@ -53,21 +50,22 @@ module Billomat
       end
     end
 
-    # @return [String] The name of the resource
+    # @return [String] the name of the resource
     def name
       @resource.resource_name
     end
 
     # @param [Hash] resp The response from the gateway
-    # @return [Integer] The number of records found
+    # @return [Integer] the number of records found
     def count(resp)
       return 0 if resp.nil?
+
       resp["#{name}s"]['@total'].to_i
     end
 
     private
 
-    # @return [String] The query as www encoded string
+    # @return [String] the query as www encoded string
     def hash_to_query
       URI.encode_www_form(@hash)
     end

data/lib/billomat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Billomat
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'
 end

data/lib/billomat.rb

@@ -7,28 +7,25 @@ require 'billomat/actions'
 require 'billomat/search'
 require 'billomat/gateway'
 
-##
-# An wrapper for the
-# <a href="https://billomat.com">Billomat</a>
-# API
+# An wrapper for the Billomat API.
 module Billomat
   class << self
     attr_writer :configuration
-  end
 
-  # @return [Billomat::Configuration] The global billomat configuration
-  def self.configuration
-    @configuration ||= Billomat::Configuration.new
-  end
+    # @return [Billomat::Configuration] the global billomat configuration
+    def configuration
+      @configuration ||= Billomat::Configuration.new
+    end
 
-  # Class method to set and change the global configuration
-  #
-  # @example
-  #   Billomat.configure do |config|
-  #     config.subdomain = 'your-business-name'
-  #     config.api_key = 'a3b148a61cb642389b4f9953f6233f20'
-  #   end
-  def self.configure
-    yield(configuration)
+    # Class method to set and change the global configuration.
+    #
+    # @example
+    #   Billomat.configure do |config|
+    #     config.subdomain = 'your-business-name'
+    #     config.api_key = 'a3b148a61cb642389b4f9953f6233f20'
+    #   end
+    def configure
+      yield(configuration)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: billomat
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Henning Vogt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -64,6 +64,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,20 +112,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
 - !ruby/object:Gem::Dependency
   name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 0.9.18
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 0.9.18
+- !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:
 email:
 - henning.vogt@hausgold.de
@@ -114,18 +190,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/documentation.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".simplecov"
-- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Dockerfile
+- Envfile
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - billomat.gemspec
 - bin/console
 - bin/setup
+- config/docker/.bash_profile
+- config/docker/.bashrc
+- config/docker/.inputrc
 - doc/assets/project.svg
+- docker-compose.yml
 - lib/billomat.rb
 - lib/billomat/actions.rb
 - lib/billomat/actions/cancel.rb
@@ -139,6 +226,8 @@ files:
 - lib/billomat/models/base.rb
 - lib/billomat/models/client.rb
 - lib/billomat/models/contact.rb
+- lib/billomat/models/credit_note.rb
+- lib/billomat/models/credit_note_item.rb
 - lib/billomat/models/invoice.rb
 - lib/billomat/models/invoice_item.rb
 - lib/billomat/models/invoice_payment.rb
@@ -159,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.travis.yml

@@ -1,19 +0,0 @@
-sudo: false
-env:
-  global:
-    - CC_TEST_REPORTER_ID=0038fa77f81e980be74aed2e240dbcedd853de3a3ea3ff71cbb344e282d284a9
-language: ruby
-rvm:
-  - 2.6
-  - 2.5
-  - 2.4
-  - 2.3
-before_install: gem install bundler
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rspec
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT