pricehubble 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85745808382e5b8d332d66c00b5a15c5b31677d5969655951a987a3c1a877b4d
-  data.tar.gz: 2269357cd88afc29a2dcf145a9a579542d2b33ae88b09cb88771442f960aba9c
+  metadata.gz: c76e2916270f0c409b580c65d1eb2fa643d8f12c8ea99c78eaa70e5c0d269e55
+  data.tar.gz: 7b868dd15db432d2c1265f0e16cd77355302fcff81b08b31846bc5e427bd54b9
 SHA512:
-  metadata.gz: 0e647a10162f859a8ea645b0ffc2cb2da064fc0e3802e4f4646b877221e56e2930894ba189d74837ec097a1bb26dd48cce4b343d5e60271d6cb6cdc366f19c14
-  data.tar.gz: e040750996b8266d30174b7c6bf692477b8467aa852791e67b2ab864800b267136deb77a86baeebcc038944bedf4b3492d6e379a70887160e3cbdd7e797f129b
+  metadata.gz: 9bdb415913b515caff0277c5b6eea96b39a161dfc1591fd49ef68de7434500071051276fb32adbd594f55295a8b7e7e56e4b0b6feac270deb0f96736bdb41919
+  data.tar.gz: e7ca73eb5a014d3d184c569425a9c0e561175361c0aaae3b58e04ab6b3d62a2669c2bcf8a561887a2f55d7ef093195751aae4f81817461146bb5f2bd4a406485

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
 
@@ -45,3 +46,9 @@ jobs:
 
       - name: Push the release Git commit/tag and package to the registry
         run: make release
+
+      - name: Build and upload application documentation
+        run: api-docs && coverage --docs-only
+        env:
+          WORKFLOW_DISPATCH_TOKEN: '${{ secrets.WORKFLOW_DISPATCH_TOKEN }}'
+          GITHUB_TAG: 'v${{ github.event.inputs.VERSION }}'

data/.github/workflows/test.yml

@@ -18,24 +18,25 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.5', '2.7']
-        rails: ['5.2']
+        ruby: ['2.7']
+        rails: ['5.2', '6.1', '7.1']
     env:
       BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
     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
 
@@ -44,20 +45,3 @@ jobs:
 
       - name: Upload the code coverage report
         run: coverage
-
-  trigger-docs:
-    name: Trigger the documentation upload
-    runs-on: ubuntu-22.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

@@ -6,6 +6,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/**/*
@@ -28,9 +28,9 @@ Metrics/BlockLength:
     - '**/*.rake'
     - doc/**/*.rb
     # Concerns and middlewares contain by nature long blocks
-    - lib/pricehubble/entity/concern/**/*.rb
-    - lib/pricehubble/client/request/**/*.rb
-    - lib/pricehubble/client/response/**/*.rb
+    - lib/price*hubble/entity/concern/**/*.rb
+    - lib/price*hubble/client/request/**/*.rb
+    - lib/price*hubble/client/response/**/*.rb
 
 # Our examples use +pp+ a lot
 Lint/Debugger:

data/Appraisals

@@ -4,3 +4,13 @@ appraise 'rails-5.2' do
   gem 'activemodel', '~> 5.2.0'
   gem 'activesupport', '~> 5.2.0'
 end
+
+appraise 'rails-6.1' do
+  gem 'activemodel', '~> 6.1.0'
+  gem 'activesupport', '~> 6.1.0'
+end
+
+appraise 'rails-7.1' do
+  gem 'activemodel', '~> 7.1.0'
+  gem 'activesupport', '~> 7.1.0'
+end

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 1.2.1
+
+* Added API docs building to continuous integration (#9)
+
+### 1.2.0
+
+* Moved the development dependencies from the gemspec to the Gemfile (#7)
+* Dropped support for Ruby <2.7 (#8)
+
 ### 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

@@ -6,3 +6,25 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in price_hubble.gemspec
 gemspec
+
+# Development dependencies
+gem 'appraisal', '~> 2.4'
+gem 'bundler', '~> 2.3'
+gem 'countless', '~> 1.1'
+# TODO: Remove the upper lock when
+#       https://github.com/thoughtbot/factory_bot/issues/1614 is solved.
+gem 'factory_bot', '~> 6.2', '< 6.4.5'
+gem 'guard-rspec', '~> 4.7'
+gem 'rake', '~> 13.0'
+gem 'redcarpet', '~> 3.5'
+gem 'rspec', '~> 3.12'
+gem 'rubocop', '~> 1.28'
+gem 'rubocop-rails', '~> 2.14'
+gem 'rubocop-rspec', '~> 2.10'
+gem 'simplecov', '>= 0.22'
+gem 'terminal-table', '~> 3.0'
+gem 'timecop', '>= 0.9.6'
+gem 'vcr', '~> 6.0'
+gem 'webmock', '~> 3.18'
+gem 'yard', '>= 0.9.28'
+gem 'yard-activesupport-concern', '>= 0.0.1'

data/Makefile

@@ -24,6 +24,7 @@ GREP ?= grep
 ID ?= id
 MKDIR ?= mkdir
 RM ?= rm
+TEST ?= test
 XARGS ?= xargs
 
 # Container binaries
@@ -35,6 +36,7 @@ RAKE ?= rake
 RSPEC ?= rspec
 RUBOCOP ?= rubocop
 YARD ?= yard
+RUBY_VERSION := ruby-version
 
 # Files
 GEMFILES ?= $(subst _,-,$(patsubst $(GEMFILES_DIR)/%.gemfile,%,\
@@ -113,7 +115,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/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/doc/examples/authentication.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative './config'
+require_relative 'config'
 
 # Fetch the authentication/identity for the first time, subsequent calls
 # to this method will return the cached authentication instance until it

data/doc/examples/complex_property_valuations.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative './config'
+require_relative 'config'
 
 # Build a property with all relevant information for the valuation. This
 # example reflects not the full list of supported fields, [see the API

data/doc/examples/dossiers.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative './config'
+require_relative 'config'
 
 # The property to create a dossier for
 apartment = {

data/doc/examples/property_valuations_errors.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative './config'
+require_relative 'config'
 
 begin
   # Fetch the valuations for a single property (sale) for today (defaults).

data/doc/examples/simple_property_valuations.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative './config'
+require_relative 'config'
 
 # Fetch the valuations for a single property (sale) for today (defaults).
 # This is the bare minimum variant, as a starting point.

data/gemfiles/rails_5.2.gemfile

@@ -2,6 +2,24 @@
 
 source "https://rubygems.org"
 
+gem "appraisal", "~> 2.4"
+gem "bundler", "~> 2.3"
+gem "countless", "~> 1.1"
+gem "factory_bot", "~> 6.2", "< 6.4.5"
+gem "guard-rspec", "~> 4.7"
+gem "rake", "~> 13.0"
+gem "redcarpet", "~> 3.5"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.28"
+gem "rubocop-rails", "~> 2.14"
+gem "rubocop-rspec", "~> 2.10"
+gem "simplecov", ">= 0.22"
+gem "terminal-table", "~> 3.0"
+gem "timecop", ">= 0.9.6"
+gem "vcr", "~> 6.0"
+gem "webmock", "~> 3.18"
+gem "yard", ">= 0.9.28"
+gem "yard-activesupport-concern", ">= 0.0.1"
 gem "activemodel", "~> 5.2.0"
 gem "activesupport", "~> 5.2.0"
 

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,26 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.4"
+gem "bundler", "~> 2.3"
+gem "countless", "~> 1.1"
+gem "factory_bot", "~> 6.2", "< 6.4.5"
+gem "guard-rspec", "~> 4.7"
+gem "rake", "~> 13.0"
+gem "redcarpet", "~> 3.5"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.28"
+gem "rubocop-rails", "~> 2.14"
+gem "rubocop-rspec", "~> 2.10"
+gem "simplecov", ">= 0.22"
+gem "terminal-table", "~> 3.0"
+gem "timecop", ">= 0.9.6"
+gem "vcr", "~> 6.0"
+gem "webmock", "~> 3.18"
+gem "yard", ">= 0.9.28"
+gem "yard-activesupport-concern", ">= 0.0.1"
+gem "activemodel", "~> 6.1.0"
+gem "activesupport", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,26 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.4"
+gem "bundler", "~> 2.3"
+gem "countless", "~> 1.1"
+gem "factory_bot", "~> 6.2", "< 6.4.5"
+gem "guard-rspec", "~> 4.7"
+gem "rake", "~> 13.0"
+gem "redcarpet", "~> 3.5"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.28"
+gem "rubocop-rails", "~> 2.14"
+gem "rubocop-rspec", "~> 2.10"
+gem "simplecov", ">= 0.22"
+gem "terminal-table", "~> 3.0"
+gem "timecop", ">= 0.9.6"
+gem "vcr", "~> 6.0"
+gem "webmock", "~> 3.18"
+gem "yard", ">= 0.9.28"
+gem "yard-activesupport-concern", ">= 0.0.1"
+gem "activemodel", "~> 7.1.0"
+gem "activesupport", "~> 7.1.0"
+
+gemspec path: "../"

data/lib/{pricehubble → price_hubble}/client/response/recursive_open_struct.rb

@@ -21,7 +21,7 @@ module PriceHubble
             body = {} if res[:status] == 204 || res[:body].blank?
 
             # Looks like we have some actual data we can wrap
-            res[:body] = \
+            res[:body] =
               ::RecursiveOpenStruct.new(body, recurse_over_arrays: true)
           end
         end

data/lib/{pricehubble → price_hubble}/entity/concern/associations.rb

@@ -144,12 +144,12 @@ module PriceHubble
         def has_one(entity, **args)
           # Sanitize options
           entity = entity.to_sym
-          opts = { class_name: nil, from: entity, persist: false } \
+          opts = { class_name: nil, from: entity, persist: false }
                  .merge(args).merge(type: :has_one)
           # Resolve the given entity to a class name, when no explicit class
           # name was given via options
           if opts[:class_name].nil?
-            opts[:class_name] = \
+            opts[:class_name] =
               entity.to_s.camelcase.prepend('PriceHubble::').constantize
           end
           # Register the association
@@ -176,7 +176,7 @@ module PriceHubble
         def has_many(entity, **args)
           # Sanitize options
           entity = entity.to_sym
-          opts = { class_name: nil, from: entity, persist: false } \
+          opts = { class_name: nil, from: entity, persist: false }
                  .merge(args).merge(type: :has_many)
           # Resolve the given entity to a class name, when no explicit class
           # name was given via options

data/lib/{pricehubble → price_hubble}/entity/concern/attributes.rb

@@ -32,11 +32,11 @@ module PriceHubble
             reader = key
 
             if sanitize
-              sanitizer = "sanitize_attr_#{key}".to_sym
+              sanitizer = :"sanitize_attr_#{key}"
               reader = methods.include?(sanitizer) ? sanitizer : key
 
-              key_sanitizer = "sanitize_attr_key_#{key}".to_sym
-              key = methods.include?(key_sanitizer) ? send(key_sanitizer) : key
+              key_sanitizer = :"sanitize_attr_key_#{key}"
+              key = send(key_sanitizer) if methods.include?(key_sanitizer)
             end
 
             result = resolve_attributes(send(reader))
@@ -124,7 +124,7 @@ module PriceHubble
           # Substract known keys, to move them to the +_unmapped+ variable
           attribute_names.each { |key| struct.delete_field(key) }
           # Merge the previous unmapped struct and the given data
-          self._unmapped = \
+          self._unmapped =
             ::RecursiveOpenStruct.new(_unmapped.to_h.merge(struct.to_h),
                                       recurse_over_arrays: true)
           # Allow mass assignment of known attributes

data/lib/{pricehubble → price_hubble}/version.rb

@@ -3,7 +3,7 @@
 # The gem version details.
 module PriceHubble
   # The version of the +price-hubble+ gem
-  VERSION = '1.1.0'
+  VERSION = '1.2.1'
 
   class << self
     # Returns the version of gem as a string.

data/lib/price_hubble.rb

@@ -1,3 +1,113 @@
 # frozen_string_literal: true
 
-require 'pricehubble'
+require 'active_support'
+require 'active_support/concern'
+require 'active_support/configurable'
+require 'active_support/time'
+require 'active_support/time_with_zone'
+require 'active_support/core_ext/object'
+require 'active_support/core_ext/module'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/string'
+require 'active_model'
+require 'recursive-open-struct'
+require 'faraday'
+require 'faraday_middleware'
+
+# Load polyfills if needed
+require 'price_hubble/core_ext/hash'
+
+# The top level namespace for the PriceHubble gem.
+module PriceHubble
+  # Top level elements
+  autoload :Configuration, 'price_hubble/configuration'
+  autoload :ConfigurationHandling, 'price_hubble/configuration_handling'
+  autoload :Client, 'price_hubble/client'
+  autoload :Identity, 'price_hubble/identity'
+  autoload :Instrumentation, 'price_hubble/instrumentation'
+
+  # Entities
+  autoload :BaseEntity, 'price_hubble/entity/base_entity'
+  autoload :Authentication, 'price_hubble/entity/authentication'
+  autoload :Valuation, 'price_hubble/entity/valuation'
+  autoload :ValuationScores, 'price_hubble/entity/valuation_scores'
+  autoload :ValuationRequest, 'price_hubble/entity/valuation_request'
+  autoload :Property, 'price_hubble/entity/property'
+  autoload :PropertyConditions, 'price_hubble/entity/property_conditions'
+  autoload :PropertyQualities, 'price_hubble/entity/property_qualities'
+  autoload :PropertyType, 'price_hubble/entity/property_type'
+  autoload :Location, 'price_hubble/entity/location'
+  autoload :Address, 'price_hubble/entity/address'
+  autoload :Coordinates, 'price_hubble/entity/coordinates'
+  autoload :Dossier, 'price_hubble/entity/dossier'
+
+  # Some general purpose utilities
+  module Utils
+    autoload :Decision, 'price_hubble/utils/decision'
+    autoload :Bangers, 'price_hubble/utils/bangers'
+  end
+
+  # Instrumentation
+  module Instrumentation
+    autoload :LogSubscriber, 'price_hubble/instrumentation/log_subscriber'
+  end
+
+  # Dedicated application HTTP (low level) client
+  module Client
+    # All our utilities used for the low level client
+    module Utils
+      autoload :Request, 'price_hubble/client/utils/request'
+      autoload :Response, 'price_hubble/client/utils/response'
+    end
+
+    # Faraday request middlewares
+    module Request
+      autoload :DataSanitization,
+               'price_hubble/client/request/data_sanitization'
+      autoload :DefaultHeaders, 'price_hubble/client/request/default_headers'
+    end
+
+    # Faraday response middlewares
+    module Response
+      autoload :DataSanitization,
+               'price_hubble/client/response/data_sanitization'
+      autoload :RecursiveOpenStruct,
+               'price_hubble/client/response/recursive_open_struct'
+    end
+
+    autoload :Base, 'price_hubble/client/base'
+    autoload :Authentication, 'price_hubble/client/authentication'
+    autoload :Valuation, 'price_hubble/client/valuation'
+    autoload :Dossiers, 'price_hubble/client/dossiers'
+  end
+
+  # Separated features of an entity instance
+  module EntityConcern
+    autoload :Callbacks, 'price_hubble/entity/concern/callbacks'
+    autoload :Attributes, 'price_hubble/entity/concern/attributes'
+    autoload :Associations, 'price_hubble/entity/concern/associations'
+    autoload :Client, 'price_hubble/entity/concern/client'
+    autoload :Persistence, 'price_hubble/entity/concern/persistence'
+
+    # Some custom typed attribute helpers
+    module Attributes
+      base = 'price_hubble/entity/concern/attributes'
+      autoload :DateArray, "#{base}/date_array"
+      autoload :Enum, "#{base}/enum"
+      autoload :Range, "#{base}/range"
+      autoload :StringInquirer, "#{base}/string_inquirer"
+    end
+  end
+
+  # Load standalone code
+  require 'price_hubble/version'
+  require 'price_hubble/errors'
+  require 'price_hubble/faraday'
+  require 'price_hubble/railtie' if defined? Rails
+
+  # Include top-level features
+  include PriceHubble::ConfigurationHandling
+  include PriceHubble::Client
+  include PriceHubble::Identity
+  include PriceHubble::Instrumentation
+end

data/lib/pricehubble

@@ -0,0 +1 @@
+price_hubble