immoscout 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 664b02a2761664c3d3e226fab5dbf936dc8b5043a1e539a7547dff443c9a2dda
-  data.tar.gz: 007bf6cc3f73a1c4f9083e1302dd7cccdbc665756684d7c03497bf8501f8ac32
+  metadata.gz: cc74f7180d13859dedf5b42a8502e6d679b6c7348622c5f92de6a41c9daba822
+  data.tar.gz: 39c5063180247dfe8e9e279c0b0dc9f20d7a4204127ee763dd50690c92013fb7
 SHA512:
-  metadata.gz: a55de5d7f9f0ae64219a2fb9e23247a5f4aaec923cefd880fe4464882233b8d28c30d7bd4d6005652134cabb880aa445df581a6e6977a95674026bf28d20ed6c
-  data.tar.gz: 8ed4b442d44937622d0a87c55751a581063d1a7212c914a230b8acd2f8a4839e7aafc885e34c064b19ac6936c914267e0b2e8d0477248f21300c04e426ac331e
+  metadata.gz: 277085348b99e2e1cc4e58157f067a874f78a8fb008970eeb50ca290d121008a8ab2613fc08475ba276d94ca7c62a05236cc68aeabf8cce782742892412639f2
+  data.tar.gz: 0fcd17a5e12f726a74268e270c9e9113c6ba8d455086e764d503c49bc8897d77b2d3e6071fd36d661fb5bd8ca10e5fee70e5a7bebf77a5e17dc108ddedf55e3c

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,62 @@
+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 }}, Rails ${{ matrix.rails }})'
+    runs-on: ubuntu-20.04
+    timeout-minutes: 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7]
+        rails: [5.2, '6.0']
+    env:
+      BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
+    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/.yardopts

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

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 1.3.2
+
+* Migrated to Github Actions
+* Migrated to our own coverage reporting
+* Added the code statistics to the test process
+
 ### 1.3.1
 
 * Corrected the GNU Make release target

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 

data/Makefile

@@ -31,7 +31,6 @@ APPRAISAL ?= appraisal
 GEM ?= gem
 RAKE ?= rake
 YARD ?= yard
-RAKE ?= rake
 RUBOCOP ?= rubocop
 
 # Files
@@ -61,6 +60,11 @@ all:
 	# test               Run the whole test suite
 	# clean              Clean the dependencies
 	#
+	# 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
 
@@ -72,14 +76,18 @@ install:
 		$(GEM) install bundler -v "~> 1.0")
 	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) install)
 
-update: install
+update:
 	# Install the dependencies
 	@$(MKDIR) -p $(VENDOR_DIR)
 	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) update)
 
-test: #install
+test: \
+	test-specs \
+	test-style
+
+test-specs:
 	# Run the whole test suite
-	@$(call run-shell,$(BUNDLE) exec $(RAKE))
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats spec)
 
 $(TEST_GEMFILES): GEMFILE=$(@:test-%=%)
 $(TEST_GEMFILES):
@@ -118,19 +126,27 @@ endif
 
 distclean: clean clean-containers clean-images
 
-shell: install
+shell:
 	# Run an interactive shell on the container
 	@$(call run-shell,$(BASH) -i)
 
-shell-irb: install
+shell-irb:
 	# Run an interactive IRB shell on the container
 	@$(call run-shell,bin/console)
 
-docs: install
+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 @@
 ![Immoscout](doc/assets/project.svg)
 
-[![Build Status](https://travis-ci.com/hausgold/immoscout.svg?branch=master)](https://travis-ci.com/hausgold/immoscout)
+[![Continuous Integration](https://github.com/hausgold/immoscout/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/hausgold/immoscout/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/immoscout.svg)](https://badge.fury.io/rb/immoscout)
-[![Maintainability](https://api.codeclimate.com/v1/badges/97fa2796b76085580c6c/maintainability)](https://codeclimate.com/repos/5cac8bc729ce6b78240071f2/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/97fa2796b76085580c6c/test_coverage)](https://codeclimate.com/repos/5cac8bc729ce6b78240071f2/test_coverage)
-[![API docs](https://img.shields.io/badge/docs-API-blue.svg)](https://www.rubydoc.info/gems/immoscout)
+[![Test Coverage](https://automate-api.hausgold.de/v1/coverage_reports/immoscout/coverage.svg)](https://knowledge.hausgold.de/coverage)
+[![Test Ratio](https://automate-api.hausgold.de/v1/coverage_reports/immoscout/ratio.svg)](https://knowledge.hausgold.de/coverage)
+[![API docs](https://automate-api.hausgold.de/v1/coverage_reports/immoscout/documentation.svg)](https://www.rubydoc.info/gems/immoscout)
 
 This gem provides an API wrapper for the [Immobilienscout24 REST
 API](https://api.immobilienscout24.de/our-apis/import-export.html). It provides

data/Rakefile

@@ -1,8 +1,77 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rails/code_statistics'
+require 'pp'
 
 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(/immoscout)?/[^/]+\.rb$}],
+  [:unshift, 'Top-levels specs', 'spec', %r{spec/_spec\.rb$}],
+
+  [:unshift, 'API', 'lib/immoscout/api'],
+  [:unshift, 'Errors', 'lib/immoscout/errors'],
+
+  [:unshift, 'Models', 'lib/immoscout/models'],
+  [:unshift, 'Models 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/gemfiles/rails_5.2.gemfile

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

data/gemfiles/rails_6.0.gemfile

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

data/immoscout.gemspec

@@ -41,7 +41,7 @@ Gem::Specification.new do |spec|
   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'
+  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'
@@ -49,7 +49,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-json_expectations', '~> 1.4'
   spec.add_development_dependency 'rubocop', '~> 0.63.1'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.31'
-  spec.add_development_dependency 'simplecov', '~> 0.15'
+  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'

data/lib/immoscout/api/client.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'singleton'
-require_relative "connection"
-require_relative "request"
+require_relative 'connection'
+require_relative 'request'
 
 module Immoscout
   module Api

data/lib/immoscout/api/connection.rb

@@ -1,5 +1,7 @@
-require "faraday"
-require "faraday_middleware"
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
 
 module Immoscout
   module Api

data/lib/immoscout/api/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Immoscout
   module Api
     module Request
@@ -17,19 +19,21 @@ module Immoscout
         request(:delete, path, payload, multipart)
       end
 
+      # rubocop:disable Metrics/MethodLength because of the header handling
       def request(method, path, payload = nil, multipart = nil)
         connection.send(method, path, multipart) do |request|
           if multipart
-            request.headers['Content-Type'] = "multipart/form-data"
+            request.headers['Content-Type'] = 'multipart/form-data'
           else
             request.body                    = payload if payload
-            request.headers['Content-Type'] = "application/json;charset=UTF-8"
+            request.headers['Content-Type'] = 'application/json;charset=UTF-8'
           end
-          request.headers['Accept'] = "application/json"
+          request.headers['Accept'] = 'application/json'
           request.headers['User-Agent'] = \
             "HausgoldImmoscout/#{Immoscout::VERSION}"
         end
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/immoscout/configuration.rb

@@ -3,24 +3,24 @@
 module Immoscout
   class Configuration
     include ActiveSupport::Configurable
-    config_accessor(:consumer_key) { ENV["IMMOSCOUT_CONSUMER_KEY"] }
-    config_accessor(:consumer_secret) { ENV["IMMOSCOUT_CONSUMER_SECRET"] }
+    config_accessor(:consumer_key) { ENV['IMMOSCOUT_CONSUMER_KEY'] }
+    config_accessor(:consumer_secret) { ENV['IMMOSCOUT_CONSUMER_SECRET'] }
 
-    config_accessor(:oauth_token) { ENV["IMMOSCOUT_OAUTH_TOKEN"] }
-    config_accessor(:oauth_token_secret) { ENV["IMMOSCOUT_OAUTH_TOKEN_SECRET"] }
+    config_accessor(:oauth_token) { ENV['IMMOSCOUT_OAUTH_TOKEN'] }
+    config_accessor(:oauth_token_secret) { ENV['IMMOSCOUT_OAUTH_TOKEN_SECRET'] }
 
     config_accessor(:use_sandbox) { false }
 
-    config_accessor(:api_version) { "v1.0" }
+    config_accessor(:api_version) { 'v1.0' }
 
     config_accessor(:user_name) { 'me' }
 
     config_accessor(:api_url_live) do
-      "https://rest.immobilienscout24.de/" \
+      'https://rest.immobilienscout24.de/' \
       "restapi/api/offer/#{api_version}"
     end
     config_accessor(:api_url_sandbox) do
-      "https://rest.sandbox-immobilienscout24.de/" \
+      'https://rest.sandbox-immobilienscout24.de/' \
       "restapi/api/offer/#{api_version}"
     end
   end

data/lib/immoscout/errors/failed.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Immoscout
   module Errors
     class Failed < StandardError

data/lib/immoscout/models/actions/attachment.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 require 'json'
 require_relative '../concerns/modelable'
 
+# rubocop:disable Metrics/BlockLength because this is how an ActiveSupport
+#   concern looks like
 module Immoscout
   module Models
     module Actions
@@ -12,11 +16,14 @@ module Immoscout
 
           self.unpack_collection = proc do |hash|
             hash
-              .fetch("common.attachments")
+              .fetch('common.attachments')
               .first
-              .fetch("attachment")
+              .fetch('attachment')
           end
 
+          # rubocop:disable Metrics/AbcSize because this is the
+          #   bare minimum logic
+          # rubocop:disable Metrics/MethodLength dito
           def save
             attachable_id = attachable.try(:id) || attachable
             response = api.post(
@@ -33,11 +40,15 @@ module Immoscout
             self.id = id_from_response(response)
             self
           end
+          # rubocop:enable Metrics/AbcSize
+          # rubocop:enable Metrics/MethodLength
 
           def destroy
             attachable_id = attachable.try(:id) || attachable
             response = api.delete(
-              "user/#{api.user_name}/realestate/#{attachable_id}/attachment/#{id}",
+              "user/#{api.user_name}/" \
+              "realestate/#{attachable_id}/" \
+              "attachment/#{id}"
             )
             handle_response(response)
             self
@@ -61,14 +72,15 @@ module Immoscout
         class_methods do
           def content_type_from_extension(ext)
             {
-              ".jpg"  => "image/jpeg",
-              ".jpeg" => "image/jpeg",
-              ".gif"  => "image/gif",
-              ".png"  => "image/png",
-              ".pdf"  => "application/pdf"
+              '.jpg' => 'image/jpeg',
+              '.jpeg' => 'image/jpeg',
+              '.gif' => 'image/gif',
+              '.png' => 'image/png',
+              '.pdf' => 'application/pdf'
             }.fetch(ext)
           end
 
+          # rubocop:disable Metrics/AbcSize because of the mapping logic
           def all(real_estate_id)
             response = api.get(
               "user/#{api.user_name}/realestate/#{real_estate_id}/attachment"
@@ -79,8 +91,10 @@ module Immoscout
               .map { |object| new(object) }
               .select { |object| object.type =~ /#{name.demodulize}/i }
           end
+          # rubocop:enable Metrics/AbcSize
         end
       end
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/lib/immoscout/models/actions/contact.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 require 'json'
 require_relative '../concerns/modelable'
 
+# rubocop:disable Metrics/BlockLength because this is how an ActiveSupport
+#   concern looks like
 module Immoscout
   module Models
     module Actions
@@ -12,10 +16,12 @@ module Immoscout
 
           self.unpack_collection = proc do |hash|
             hash
-              .fetch("common.realtorContactDetailsList", {})
-              .fetch("realtorContactDetails", nil)
+              .fetch('common.realtorContactDetailsList', {})
+              .fetch('realtorContactDetails', nil)
           end
 
+          # rubocop:disable Metrics/AbcSize because this is the
+          #   bare minimum logic
           def save
             response = \
               if id
@@ -28,6 +34,7 @@ module Immoscout
             self.id = id_from_response(response) unless id
             self
           end
+          # rubocop:enable Metrics/AbcSize
 
           def destroy
             response = api.delete("user/#{api.user_name}/contact/#{id}")
@@ -73,3 +80,4 @@ module Immoscout
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/lib/immoscout/models/actions/publish.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require_relative '../concerns/modelable'
 
@@ -11,7 +13,7 @@ module Immoscout
           include Immoscout::Models::Concerns::Modelable
 
           def save
-            response = api.post("publish", as_json)
+            response = api.post('publish', as_json)
             handle_response(response)
             self
           end

data/lib/immoscout/models/actions/real_estate.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 require 'json'
 require_relative '../concerns/modelable'
 
+# rubocop:disable Metrics/BlockLength because this is how an ActiveSupport
+#   concern looks like
 module Immoscout
   module Models
     module Actions
@@ -12,11 +16,13 @@ module Immoscout
 
           self.unpack_collection = proc do |hash|
             hash
-              .fetch("realestates.realEstates", {})
-              .fetch("realEstateList", {})
-              .fetch("realEstateElement", nil)
+              .fetch('realestates.realEstates', {})
+              .fetch('realEstateList', {})
+              .fetch('realEstateElement', nil)
           end
 
+          # rubocop:disable Metrics/AbcSize because this is the
+          #   bare minimum logic
           def save
             response = \
               if id
@@ -29,6 +35,7 @@ module Immoscout
             self.id = id_from_response(response) unless id
             self
           end
+          # rubocop:enable Metrics/AbcSize
 
           def destroy
             response = api.delete("user/#{api.user_name}/realestate/#{id}")
@@ -93,6 +100,7 @@ module Immoscout
             find("ext-#{external_id}")
           end
 
+          # rubocop:disable Metrics/AbcSize because of the mapping logic
           def all
             response = api.get("user/#{api.user_name}/realestate")
             handle_response(response)
@@ -101,6 +109,7 @@ module Immoscout
               .map { |object| new(object) }
               .select { |object| object.type =~ /#{name.demodulize}/i }
           end
+          # rubocop:enable Metrics/AbcSize
 
           def first
             all.first
@@ -120,3 +129,4 @@ module Immoscout
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/lib/immoscout/models/apartment_buy.rb

@@ -17,7 +17,7 @@ module Immoscout
       include Immoscout::Models::Concerns::Propertiable
       include Immoscout::Models::Actions::RealEstate
 
-      self.json_wrapper = "realestates.apartmentBuy"
+      self.json_wrapper = 'realestates.apartmentBuy'
 
       property :id, alias: :@id
       property :external_id

data/lib/immoscout/models/base.rb

@@ -27,6 +27,7 @@ module Immoscout
             # puts "#{self.class.name} - missing property '#{key}'"
             next
           end
+
           set_property(property, key, value)
         end
       end

data/lib/immoscout/models/concerns/modelable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module Immoscout
@@ -37,16 +39,17 @@ module Immoscout
 
           def handle_response(response)
             return response if response.success?
+
             raise Immoscout::Errors::Failed, response
           end
 
           def id_from_response(response)
             response
               .body
-              .fetch("common.messages")
+              .fetch('common.messages')
               .first
-              .fetch("message", {})
-              .fetch("id", nil)
+              .fetch('message', {})
+              .fetch('id', nil)
           end
         end
       end

data/lib/immoscout/models/concerns/propertiable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Immoscout
   module Models
     module Concerns
@@ -16,7 +18,8 @@ module Immoscout
               match         = Regexp.last_match(1).intern
               properties    = self.class.properties
               coerce_klass  = properties.fetch(match).fetch(:coerce, nil)
-              return super if !properties.keys.include?(match) || !coerce_klass
+              return super if !properties.key?(match) || !coerce_klass
+
               send("#{match}=", coerce_klass.new)
             else
               super

data/lib/immoscout/models/concerns/renderable.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 require 'json'
 
+# rubocop:disable Metrics/BlockLength because this is how an ActiveSupport
+#   concern looks like
 module Immoscout
   module Models
     module Concerns
@@ -22,11 +26,16 @@ module Immoscout
             self.class.try(:json_wrapper)
           end
 
+          # rubocop:disable Metrics/PerceivedComplexity because this is the
+          #   bare minimum logic
+          # rubocop:disable Metrics/MethodLength dito
+          # rubocop:disable Metrics/CyclomaticComplexity dito
           def to_h
             self.class.properties.each_with_object({}) do |(key, value), memo|
               # skip if it's readonly and should not be exposed in #as_json
               readonly = value.fetch(:readonly, false)
               next if readonly.try(:call, self) || readonly == true
+
               # use :alias instead of key as json-key
               property = value.fetch(:alias, key)
               # use :default if present AND value is nil
@@ -42,6 +51,9 @@ module Immoscout
               memo
             end
           end
+          # rubocop:enable Metrics/PerceivedComplexity
+          # rubocop:enable Metrics/MethodLength
+          # rubocop:enable Metrics/CyclomaticComplexity
 
           def to_json_wrapped
             { self.class.try(:json_wrapper) => to_json_unwrapped }
@@ -61,3 +73,4 @@ module Immoscout
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/lib/immoscout/models/contact.rb

@@ -12,7 +12,7 @@ module Immoscout
       include Immoscout::Models::Concerns::Propertiable
       include Immoscout::Models::Actions::Contact
 
-      self.json_wrapper = "common.realtorContactDetail"
+      self.json_wrapper = 'common.realtorContactDetail'
 
       property :id, alias: :@id
       property :email

data/lib/immoscout/models/document.rb

@@ -13,7 +13,7 @@ module Immoscout
 
       attr_accessor :attachable, :file
 
-      self.json_wrapper = "common.attachment"
+      self.json_wrapper = 'common.attachment'
 
       property :id, alias: :@id
       property :type, alias: :'@xsi.type'

data/lib/immoscout/models/house_buy.rb

@@ -19,7 +19,7 @@ module Immoscout
       include Immoscout::Models::Concerns::Propertiable
       include Immoscout::Models::Actions::RealEstate
 
-      self.json_wrapper = "realestates.houseBuy"
+      self.json_wrapper = 'realestates.houseBuy'
 
       property :id, alias: :@id
       property :external_id

data/lib/immoscout/models/picture.rb

@@ -14,10 +14,10 @@ module Immoscout
 
       attr_accessor :attachable, :file
 
-      self.json_wrapper = "common.attachment"
+      self.json_wrapper = 'common.attachment'
 
       property :id, alias: :@id
-      property :type, alias: :'@xsi.type', default: "common:Picture"
+      property :type, alias: :'@xsi.type', default: 'common:Picture'
       property :href, alias: :'@xlink.href'
       property :publish_date, alias: :@publish_date
       property :creation, alias: :@creation

data/lib/immoscout/models/publish.rb

@@ -13,7 +13,7 @@ module Immoscout
       include Immoscout::Models::Concerns::Propertiable
       include Immoscout::Models::Actions::Publish
 
-      self.json_wrapper = "common.publishObject"
+      self.json_wrapper = 'common.publishObject'
 
       property :real_estate, coerce: Immoscout::Models::Parts::RealEstate
       property :publish_channel,

data/lib/immoscout/models.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'errors/failed'
 require_relative 'api/client'
 # renderable models

data/lib/immoscout/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Immoscout
-  VERSION = "1.3.1".freeze
+  VERSION = '1.3.2'
 end

data/lib/immoscout.rb

@@ -4,7 +4,7 @@ require 'active_support/concern'
 require 'active_support/configurable'
 require 'active_support/core_ext/hash'
 
-require "immoscout/version"
+require 'immoscout/version'
 require 'immoscout/configuration'
 require 'immoscout/models'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: immoscout
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Marcus Geissler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2021-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -121,6 +121,9 @@ dependencies:
     - - ">="
       - !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
@@ -128,6 +131,9 @@ dependencies:
     - - ">="
       - !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
@@ -230,16 +236,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -332,12 +338,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/documentation.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".reek"
 - ".rspec"
 - ".rubocop.yml"
 - ".simplecov"
-- ".travis.yml"
+- ".yardopts"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md

data/.travis.yml

@@ -1,23 +0,0 @@
-sudo: false
-
-env:
-  global:
-    - CC_TEST_REPORTER_ID=8615a2f049e99efe606a9121e6344b8d9139390648425cb3a0175696e000670d
-
-language: ruby
-rvm:
-  - 2.7
-  - 2.6
-  - 2.5
-
-gemfile:
-  - gemfiles/rails_5.2.gemfile
-  - gemfiles/rails_6.0.gemfile
-
-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
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT