pricehubble 0.4.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c029e790cdf1ec21949212567077f03271666ca6332a3b84a902a262ae6625e
-  data.tar.gz: 3df77cae40f611c456283a23e215a840ce88936748aefb9c729a205c61ebd7d8
+  metadata.gz: 3f1ed8db96f0efa1edf1011116a4269e35a075b9b162b13d68a4e6c08d81d9cb
+  data.tar.gz: 00b1e03b3c0f76e577c2fdea0108c03d9743a6bfe73c00d71b4183e2f9b0aa05
 SHA512:
-  metadata.gz: 6421682c63aa011271eca9931587badf8fbf7ad1c64aadbfa9bccef42dd170e68dd3dee5ed9f8e965ee47e2055e0fdca398ed355370bd91c8a28e045fbc26729
-  data.tar.gz: ebe7f75db3e959c48074e0c74092ca6a9a94789645aba5051ab1a972fb8be66295092fe1a07f62a680f53c977152724e8aef31ae06e32afc316b47092e46c66f
+  metadata.gz: 8822ad28938b426cd42242cbeebacf6c4697eb17187343c3478e415a9ade67add42c13d0c01bd378efaab3f0252d6e7916e7ce9a48055b5bb9060553467bffb3
+  data.tar.gz: 0fcc8813a696d6c64e9dc8ba70676ee129621189bee80da841c3d02b96f6587fa99a4d72bf312dc300fa484798d801c46152543d7136c9a7880dfd34baeae6bc

data/.github/workflows/documentation.yml

@@ -9,16 +9,17 @@ concurrency:
 jobs:
   docs:
     name: Build gem documentation
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Install the correct Ruby version
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.5
           bundler-cache: true
+          rubygems: '3.3.26'
 
       - name: Prepare the virtual environment
         uses: hausgold/actions/ci@master

data/.github/workflows/test.yml

@@ -13,23 +13,24 @@ concurrency:
 jobs:
   test:
     name: 'Test the gem (Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }})'
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 5
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5, 2.6, 2.7]
-        rails: [5.2, '6.0']
+        ruby: ['2.5', '2.7']
+        rails: ['5.2']
     env:
       BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Install the correct Ruby version
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
+          rubygems: '3.3.26'
 
       - name: Prepare the virtual environment
         uses: hausgold/actions/ci@master
@@ -46,7 +47,7 @@ jobs:
 
   trigger-docs:
     name: Trigger the documentation upload
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 2
     needs: test
     if: github.ref == 'refs/heads/master'

data/.rspec

@@ -1,3 +1,3 @@
+--backtrace
+--force-color
 --format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,19 +1,24 @@
-require: rubocop-rspec
+require:
+  - rubocop-rspec
+  - rubocop-rails
 
 Rails:
   Enabled: true
 
-Documentation:
+Style/Documentation:
   Enabled: true
 
 AllCops:
+  NewCops: enable
+  SuggestExtensions: false
   DisplayCopNames: true
   TargetRubyVersion: 2.5
+  TargetRailsVersion: 5.2
   Exclude:
     - bin/**/*
     - vendor/**/*
     - build/**/*
-    - gemfiles/vendor/**/*
+    - gemfiles/**/*
 
 Metrics/BlockLength:
   Exclude:
@@ -27,6 +32,10 @@ Metrics/BlockLength:
     - lib/pricehubble/client/request/**/*.rb
     - lib/pricehubble/client/response/**/*.rb
 
+# MFA is not yet enabled for our gems yet.
+Gemspec/RequireMFA:
+  Enabled: false
+
 # Document all the things.
 Style/DocumentationMethod:
   Enabled: true
@@ -63,5 +72,20 @@ Lint/ShadowingOuterLocalVariable:
 
 # We stay at 80 characters per line.
 # See: https://rubystyle.guide/#max-line-length
-Metrics/LineLength:
+Layout/LineLength:
   Max: 80
+
+# We use memoized helpers all over the place to construct inputs and output
+# which can be customized at nested contexts easily.
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+# That are false-positives because we implement similar working
+# helpers for associations like +.has_one+.
+Rails/ReflectionClassName:
+  Enabled: false
+
+# A very nice feature, but it does not work for non-method code parts atow.
+# So just disabling it for now.
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false

data/.simplecov

@@ -1,3 +1,15 @@
+# frozen_string_literal: true
+
+require 'simplecov-html'
+require 'simplecov_json_formatter'
+
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter
+  ]
+)
+
 SimpleCov.start 'test_frameworks' do
   add_filter '/vendor/bundle/'
 end

data/Appraisals

@@ -1,13 +1,6 @@
 # frozen_string_literal: true
 
 appraise 'rails-5.2' do
-  gem 'activemodel', '~> 5.2.2'
-  gem 'activesupport', '~> 5.2.2'
-  gem 'railties', '~> 5.2.2'
-end
-
-appraise 'rails-6.0' do
-  gem 'activemodel', '~> 6.0.0'
-  gem 'activesupport', '~> 6.0.0'
-  gem 'railties', '~> 6.0.0'
+  gem 'activemodel', '~> 5.2.0'
+  gem 'activesupport', '~> 5.2.0'
 end

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### 1.0.0
+
+* Bundler >= 2.3 is from now on required as minimal version (#5)
+* Dropped support for Ruby < 2.5 (#5)
+* Dropped support for Rails < 5.2 (#5)
+* Updated all development/runtime gems to their latest
+  Ruby 2.5 compatible version (#5)
+* [Breaking Change] The `sanitize` argument of the
+  `PriceHubble::BaseEntity#attributes(sanitize = false)` method has changed to
+  a keyword argument `PriceHubble::BaseEntity#attributes(sanitize: false)` (#5)
+
 ### 0.4.2
 
 * Migrated to Github Actions

data/Dockerfile

@@ -2,7 +2,7 @@ FROM hausgold/ruby:2.5
 MAINTAINER Hermann Mayer <hermann.mayer@hausgold.de>
 
 # Update system gem
-RUN gem update --system
+RUN gem update --system '3.3.26'
 
 # Install system packages and the latest bundler
 RUN apt-get update -yqqq && \
@@ -11,8 +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.0' --no-document --no-prerelease && \
-  gem install bundler -v '~> 1.0' --no-document --no-prerelease
+  gem install bundler -v '~> 2.3.0' --no-document --no-prerelease
 
 # Add new web user
 RUN mkdir /app && \

data/Guardfile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+(directories %w[lib spec]).select do |d|
+  if Dir.exist?(d)
+    d
+  else
+    UI.warning("Directory #{d} does not exist")
+  end
+end
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{^lib/pricehubble.rb}) { 'spec' }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/pricehubble/([^\\]+)\.rb$}) do |m|
+    "spec/pricehubble/#{m[1]}_spec.rb"
+  end
+  watch(%r{^lib/pricehubble/([^\\]+)/(.*)\.rb$}) do |m|
+    "spec/#{m[1]}/#{m[2]}_spec.rb"
+  end
+end

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 HAUSGOLD | talocasa GmbH
+Copyright (c) 2023 HAUSGOLD | talocasa GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Makefile

@@ -9,6 +9,7 @@ SHELL := bash
 # Environment switches
 MAKE_ENV ?= docker
 COMPOSE_RUN_SHELL_FLAGS ?= --rm
+BASH_RUN_SHELL_FLAGS ?=
 
 # Directories
 VENDOR_DIR ?= vendor/bundle
@@ -26,12 +27,14 @@ RM ?= rm
 XARGS ?= xargs
 
 # Container binaries
-BUNDLE ?= bundle
 APPRAISAL ?= appraisal
+BUNDLE ?= bundle
 GEM ?= gem
+GUARD ?= guard
 RAKE ?= rake
-YARD ?= yard
+RSPEC ?= rspec
 RUBOCOP ?= rubocop
+YARD ?= yard
 
 # Files
 GEMFILES ?= $(subst _,-,$(patsubst $(GEMFILES_DIR)/%.gemfile,%,\
@@ -45,7 +48,8 @@ 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)'
+		-u `$(ID) -u` test \
+		bash $(BASH_RUN_SHELL_FLAGS) -c 'sleep 0.1; echo; $(1)'
 endef
 else ifeq ($(MAKE_ENV),baremetal)
 define run-shell
@@ -62,6 +66,7 @@ all:
 	#
 	# test               Run the whole test suite
 	# test-style         Test the code styles
+	# watch              Watch for code changes and rerun the test suite
 	#
 	# docs               Generate the Ruby documentation of the library
 	# stats              Print the code statistics (library and test suite)
@@ -71,27 +76,37 @@ all:
 	# shell              Run an interactive shell on the container
 	# shell-irb          Run an interactive IRB shell on the container
 
+.interactive:
+	@$(eval BASH_RUN_SHELL_FLAGS = --login)
+
 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")
 	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) install)
 
 update:
 	# Install the dependencies
 	@$(MKDIR) -p $(VENDOR_DIR)
+	@$(call run-shell,$(BUNDLE) update)
 	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) update)
 
-test:
+watch: install .interactive
+	# Watch for code changes and rerun the test suite
+	@$(call run-shell,$(BUNDLE) exec $(GUARD))
+
+test: \
+	test-specs \
+	test-style
+
+test-specs:
 	# Run the whole test suite
 	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats spec)
 
 $(TEST_GEMFILES): GEMFILE=$(@:test-%=%)
 $(TEST_GEMFILES):
 	# Run the whole test suite ($(GEMFILE))
-	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RAKE))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RSPEC))
 
 test-style: \
 	test-style-ruby
@@ -106,8 +121,8 @@ clean:
 	@$(RM) -rf $(VENDOR_DIR)/Gemfile.lock
 	@$(RM) -rf $(GEMFILES_DIR)/vendor
 	@$(RM) -rf $(GEMFILES_DIR)/*.lock
-	@$(RM) -rf pkg
-	@$(RM) -rf coverage
+	@$(RM) -rf .bundle .yardoc coverage pkg Gemfile.lock doc/api \
+		.rspec_status
 
 clean-containers:
 	# Clean running containers
@@ -118,7 +133,7 @@ endif
 clean-images:
 	# Clean build images
 ifeq ($(MAKE_ENV),docker)
-	@-$(DOCKER) images | $(GREP) pricehubble \
+	@-$(DOCKER) images | $(GREP) $(shell basename "`pwd`") \
 		| $(AWK) '{ print $$3 }' \
 		| $(XARGS) -rn1 $(DOCKER) rmi -f
 endif

data/Rakefile

@@ -2,84 +2,30 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'rails/code_statistics'
-require 'pp'
+require 'countless/rake_tasks'
 
 RSpec::Core::RakeTask.new(: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(/pricehubble)?/[^/]+\.rb$}],
-  [:unshift, 'Top-levels specs', 'spec',
-   %r{spec/pricehubble(_spec\.rb|/[^/]+\.rb$)}],
-
-  [:unshift, 'Clients', 'lib/pricehubble/client'],
-  [:unshift, 'Clients specs', 'spec/client'],
-
-  [:unshift, 'Entities', 'lib/pricehubble/entity'],
-  [:unshift, 'Entities specs', 'spec/entity'],
-
-  [:unshift, 'Utilities', 'lib/pricehubble/utils'],
-  [:unshift, 'Utilities specs', 'spec/utils'],
-
-  [:unshift, 'Instrumentation', 'lib/pricehubble/instrumentation'],
-  [:unshift, 'Core Extensions', 'lib/pricehubble/core_ext']
-].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
+Countless.configure do |config|
+  config.stats_base_directories = [
+    { name: 'Top-levels', dir: 'lib',
+      pattern: %r{/lib(/pricehubble)?/[^/]+\.rb$} },
+    { name: 'Top-levels specs', test: true, dir: 'spec',
+      pattern: %r{/spec(/pricehubble)?/[^/]+_spec\.rb$} },
+    { name: 'Clients', pattern: 'lib/pricehubble/client/**/*.rb' },
+    { name: 'Clients specs', test: true,
+      pattern: 'spec/client/**/*_spec.rb' },
+    { name: 'Entities', pattern: 'lib/pricehubble/entity/**/*.rb' },
+    { name: 'Entities specs', test: true,
+      pattern: 'spec/entity/**/*_spec.rb' },
+    { name: 'Utilities', pattern: 'lib/pricehubble/utils/**/*.rb' },
+    { name: 'Utilities specs', test: true,
+      pattern: 'spec/utils/**/*_spec.rb' },
+    { name: 'Instrumentation',
+      pattern: 'lib/pricehubble/instrumentation/**/*.rb' },
+    { name: 'Core Extensions', pattern: 'lib/pricehubble/core_ext/**/*.rb' }
+  ]
 end

data/gemfiles/rails_5.2.gemfile

@@ -1,11 +1,8 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'activemodel', '~> 5.2.2'
-gem 'activesupport', '~> 5.2.2'
-gem 'railties', '~> 5.2.2'
+gem "activemodel", "~> 5.2.0"
+gem "activesupport", "~> 5.2.0"
 
-gemspec path: '../'
+gemspec path: "../"

data/lib/pricehubble/client/dossiers.rb

@@ -65,8 +65,7 @@ module PriceHubble
       # @param entity [PriceHubble::Dossier] the entity to delete
       # @param args [Hash{Symbol => Mixed}] additional arguments
       #
-      # rubocop:disable Metrics/MethodLength because thats the bare minimum
-      # rubocop:disable Metrics/AbcSize because the decission
+      # rubocop:disable Metrics/MethodLength because thats the bare minimumbecause the decission
       #  handling is quite complex
       def delete_dossier(entity, **args)
         res = connection.delete do |req|
@@ -82,9 +81,8 @@ module PriceHubble
           successful?(res)
         end
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
 
+      # rubocop:enable Metrics/MethodLength
       # Update a dossier entity.
       #
       # TODO: Implement this.

data/lib/pricehubble/client/request/data_sanitization.rb

@@ -18,7 +18,7 @@ module PriceHubble
           # Perform the data compaction and the hash key transformation,
           # when the body is available and a hash
           env[:body] = body.deep_compact.deep_camelize_keys \
-            if body&.is_a?(Hash)
+            if body.is_a?(Hash)
 
           @app.call(env)
         end

data/lib/pricehubble/client/utils/request.rb

@@ -8,15 +8,15 @@ module PriceHubble
       module Request
         extend ActiveSupport::Concern
 
-        included do
-          # A common HTTP content type to symbol
-          # mapping for correct header settings.
-          CONTENT_TYPE = {
-            json: 'application/json',
-            multipart: 'multipart/form-data',
-            url_encoded: 'application/x-www-form-urlencoded'
-          }.freeze
+        # A common HTTP content type to symbol
+        # mapping for correct header settings.
+        CONTENT_TYPE = {
+          json: 'application/json',
+          multipart: 'multipart/form-data',
+          url_encoded: 'application/x-www-form-urlencoded'
+        }.freeze
 
+        included do
           # Use the configured identity to authenticate the given request.
           #
           # @param req [Faraday::Request] the request to manipulate

data/lib/pricehubble/client/valuation.rb

@@ -12,8 +12,9 @@ module PriceHubble
       #   or +nil+ on error
       #
       # rubocop:disable Metrics/MethodLength because of the request handling
+      # rubocop:disable Metrics/AbcSize dito
       def property_value(request, **args)
-        data = request.attributes(true)
+        data = request.attributes(sanitize: true)
         res = connection.post do |req|
           req.path = '/api/v1/valuation/property_value'
           req.body = data
@@ -27,6 +28,7 @@ module PriceHubble
         end
       end
       # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
 
       # Map and assign the valuation response to our local
       # +PriceHubble::Valuation+ representation. While taking care of the
@@ -42,6 +44,7 @@ module PriceHubble
       #
       # rubocop:disable Metrics/MethodLength because of the request
       #   to response mapping
+      # rubocop:disable Metrics/AbcSize dito
       def assign_valuations(data, request)
         lambda do
           # valuations[i][j] contains the valuation for property i on date j
@@ -60,6 +63,7 @@ module PriceHubble
         end
       end
       # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
 
       # Generate bang method variants
       bangers :property_value

data/lib/pricehubble/core_ext/hash.rb

@@ -38,8 +38,8 @@ class Hash
   def deep_compact_in_object(object)
     case object
     when Hash
-      object = object.compact.each_with_object({}) do |(key, value), result|
-        result[key] = deep_compact_in_object(value)
+      object = object.compact.transform_values do |value|
+        deep_compact_in_object(value)
       end
       object.empty? ? nil : object.compact
     when Array

data/lib/pricehubble/entity/base_entity.rb

@@ -55,6 +55,7 @@ module PriceHubble
       #
       # @param child_class [Class] the child class which inherits us
       def inherited(child_class)
+        super
         match = ->(sym) { sym.to_s.start_with? 'inherited_setup_' }
         trigger = ->(sym) { send(sym, child_class) }
         methods.select(&match).each(&trigger)

data/lib/pricehubble/entity/concern/associations.rb

@@ -45,8 +45,8 @@ module PriceHubble
           key = opts[:from]
 
           # Initialize an object on the association, even without data
-          if opts[:initialize] && send(attribute).nil?
-            hash[key] = {} unless hash.key? key
+          if opts[:initialize] && send(attribute).nil? && !(hash.key? key)
+            hash[key] = {}
           end
 
           return [struct, hash] unless hash.key? key
@@ -92,8 +92,8 @@ module PriceHubble
           key = opts[:fallback_from] if opts[:fallback_from] && !hash.key?(key)
 
           # Initialize an empty array on the association
-          if opts[:initialize] && send(attribute).nil?
-            hash[key] = [] unless hash.key? key
+          if opts[:initialize] && send(attribute).nil? && !(hash.key? key)
+            hash[key] = []
           end
 
           return [struct, hash] unless hash.key? key
@@ -156,6 +156,7 @@ module PriceHubble
           associations[entity] = opts
           # Generate getters and setters
           attr_accessor entity
+
           # Add the entity to the tracked attributes if it should be persisted
           tracked_attr entity if opts[:persist]
         end
@@ -187,6 +188,7 @@ module PriceHubble
           associations[entity] = opts
           # Generate getters and setters
           attr_accessor entity
+
           # Add the entity to the tracked attributes if it should be persisted
           tracked_attr entity if opts[:persist]
         end

data/lib/pricehubble/entity/concern/attributes.rb

@@ -27,7 +27,7 @@ module PriceHubble
         #
         # rubocop:disable Metrics/MethodLength because of the
         #   key/value sanitization handling
-        def attributes(sanitize = false)
+        def attributes(sanitize: false)
           attribute_names.each_with_object({}) do |key, memo|
             reader = key
 
@@ -43,8 +43,8 @@ module PriceHubble
             memo[key.to_s] = result
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
+        # rubocop:enable Metrics/MethodLength
         # A wrapper for the +ActiveModel#assign_attributes+ method with support
         # for unmapped attributes. These attributes are put into the
         # +_unmapped+ struct and all the known attributes are assigned like
@@ -73,20 +73,26 @@ module PriceHubble
         # @param obj [Mixed] the object to resolve its attributes
         # @param sanitize [Boolean] whenever to sanitize the data for transport
         # @return [Mixed] the attribute(s) data
-        def resolve_attributes(obj, sanitize = false)
+        #
+        # rubocop:disable Metrics/MethodLength because thats the pure minimum
+        def resolve_attributes(obj, sanitize: false)
           if obj.respond_to? :attributes
             obj = if obj.method(:attributes).arity == 1
-                    obj.attributes(sanitize)
+                    obj.attributes(sanitize: sanitize)
                   else
                     obj.attributes
                   end
           end
 
-          obj = obj.map { |elem| resolve_attributes(elem, sanitize) } \
-            if obj.is_a? Array
+          if obj.is_a? Array
+            obj = obj.map do |elem|
+              resolve_attributes(elem, sanitize: sanitize)
+            end
+          end
 
           obj
         end
+        # rubocop:enable Metrics/MethodLength
 
         # Explicitly convert the given struct to an +RecursiveOpenStruct+ and a
         # deep symbolized key copy for further usage.
@@ -144,6 +150,7 @@ module PriceHubble
           self.attribute_names += args
           # Define getters/setters
           attr_reader(*args)
+
           args.each do |arg|
             class_eval <<-RUBY, __FILE__, __LINE__ + 1
               def #{arg}=(value)

data/lib/pricehubble/entity/valuation_request.rb

@@ -43,7 +43,7 @@ module PriceHubble
     #
     # @return [Array<Hash{String => Mixed}>] the sanitized properties
     def sanitize_attr_properties
-      properties.map { |prop| { property: prop.attributes(true) } }
+      properties.map { |prop| { property: prop.attributes(sanitize: true) } }
     end
 
     # Perform the property valuation request.

data/lib/pricehubble/identity.rb

@@ -6,6 +6,7 @@ module PriceHubble
   # rubocop:disable Style/ClassVars because we split module code
   module Identity
     extend ActiveSupport::Concern
+
     class_methods do
       # Reset the current identity.
       def reset_identity!

data/lib/pricehubble/utils/decision.rb

@@ -49,7 +49,7 @@ module PriceHubble
         def initialize(on_error: :fail)
           @on_error = on_error
           @bang_proc = -> { StandardError.new }
-          @fail_proc = @good_proc = -> { nil }
+          @fail_proc = @good_proc = -> {}
         end
 
         # Register a new error (bang) way. Requires a block.

data/lib/pricehubble/version.rb

@@ -1,6 +1,23 @@
 # frozen_string_literal: true
 
+# The gem version details.
 module PriceHubble
   # The version of the +price-hubble+ gem
-  VERSION = '0.4.2'
+  VERSION = '1.0.0'
+
+  class << self
+    # Returns the version of gem as a string.
+    #
+    # @return [String] the gem version as string
+    def version
+      VERSION
+    end
+
+    # Returns the version of the gem as a +Gem::Version+.
+    #
+    # @return [Gem::Version] the gem version as object
+    def gem_version
+      Gem::Version.new VERSION
+    end
+  end
 end

data/lib/pricehubble.rb

@@ -13,7 +13,6 @@ require 'active_model'
 require 'recursive-open-struct'
 require 'faraday'
 require 'faraday_middleware'
-require 'pp'
 
 # Load polyfills if needed
 require 'pricehubble/core_ext/hash'

data/pricehubble.gemspec

@@ -5,45 +5,56 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pricehubble/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'pricehubble'
-  spec.version       = PriceHubble::VERSION
-  spec.authors       = ['Hermann Mayer']
-  spec.email         = ['hermann.mayer92@gmail.com']
+  spec.name = 'pricehubble'
+  spec.version = PriceHubble::VERSION
+  spec.authors = ['Hermann Mayer']
+  spec.email = ['hermann.mayer92@gmail.com']
 
-  spec.summary       = 'Ruby client for the PriceHubble REST API'
-  spec.description   = 'Ruby client for the PriceHubble REST API'
-  spec.homepage      = 'https://github.com/hausgold/pricehubble'
+  spec.license = 'MIT'
+  spec.summary = 'Ruby client for the PriceHubble REST API'
+  spec.description = 'Ruby client for the PriceHubble REST API'
 
-  spec.required_ruby_version = '~> 2.5'
+  base_uri = "https://github.com/hausgold/#{spec.name}"
+  spec.metadata = {
+    'homepage_uri' => base_uri,
+    'source_code_uri' => base_uri,
+    'changelog_uri' => "#{base_uri}/blob/master/CHANGELOG.md",
+    'bug_tracker_uri' => "#{base_uri}/issues",
+    'documentation_uri' => "https://www.rubydoc.info/gems/#{spec.name}"
+  }
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activemodel', '>= 5.2.0'
-  spec.add_runtime_dependency 'activesupport', '>= 5.2.0'
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.add_runtime_dependency 'activemodel', '>= 5.2'
+  spec.add_runtime_dependency 'activesupport', '>= 5.2'
   spec.add_runtime_dependency 'faraday', '~> 1.0'
   spec.add_runtime_dependency 'faraday_middleware', '~> 1.0'
   spec.add_runtime_dependency 'recursive-open-struct', '~> 1.1'
 
-  spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'bundler', '>= 1.16', '< 3'
-  spec.add_development_dependency 'factory_bot', '~> 4.11'
-  spec.add_development_dependency 'railties', '>= 4.2.0', '< 6.1'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rdoc', '~> 6.1'
-  spec.add_development_dependency 'redcarpet', '~> 3.4'
-  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 'terminal-table', '~> 1.8'
-  spec.add_development_dependency 'timecop', '~> 0.9.1'
-  spec.add_development_dependency 'vcr', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 3.5'
-  spec.add_development_dependency 'yard', '~> 0.9.18'
-  spec.add_development_dependency 'yard-activesupport-concern', '~> 0.0.1'
+  spec.add_development_dependency 'appraisal', '~> 2.4'
+  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'countless', '~> 1.1'
+  spec.add_development_dependency 'factory_bot', '~> 6.2'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.5'
+  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 'terminal-table', '~> 3.0'
+  spec.add_development_dependency 'timecop', '>= 0.9.6'
+  spec.add_development_dependency 'vcr', '~> 6.0'
+  spec.add_development_dependency 'webmock', '~> 3.18'
+  spec.add_development_dependency 'yard', '>= 0.9.28'
+  spec.add_development_dependency 'yard-activesupport-concern', '>= 0.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pricehubble
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Hermann Mayer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -84,250 +84,252 @@ dependencies:
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: countless
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.11'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.11'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   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'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.1
+        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: 0.63.1
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.31'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.31'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.6
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.18'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        version: 0.9.28
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        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: Ruby client for the PriceHubble REST API
@@ -350,6 +352,7 @@ files:
 - Dockerfile
 - Envfile
 - Gemfile
+- Guardfile
 - LICENSE
 - Makefile
 - README.md
@@ -369,7 +372,6 @@ files:
 - doc/examples/simple_property_valuations.rb
 - docker-compose.yml
 - gemfiles/rails_5.2.gemfile
-- gemfiles/rails_6.0.gemfile
 - lib/price_hubble.rb
 - lib/pricehubble.rb
 - lib/pricehubble/client.rb
@@ -418,16 +420,22 @@ files:
 - lib/pricehubble/utils/decision.rb
 - lib/pricehubble/version.rb
 - pricehubble.gemspec
-homepage: https://github.com/hausgold/pricehubble
-licenses: []
-metadata: {}
+homepage:
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hausgold/pricehubble
+  source_code_uri: https://github.com/hausgold/pricehubble
+  changelog_uri: https://github.com/hausgold/pricehubble/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/hausgold/pricehubble/issues
+  documentation_uri: https://www.rubydoc.info/gems/pricehubble
 post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -436,7 +444,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.3.8
 signing_key:
 specification_version: 4
 summary: Ruby client for the PriceHubble REST API

data/gemfiles/rails_6.0.gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-# This file was generated by Appraisal
-
-source 'https://rubygems.org'
-
-gem 'activemodel', '~> 6.0.0'
-gem 'activesupport', '~> 6.0.0'
-gem 'railties', '~> 6.0.0'
-
-gemspec path: '../'