immoscout 1.3.1 → 1.4.0

data/lib/immoscout/models/parts/international_country_region.rb

@@ -7,9 +7,12 @@ require_relative '../concerns/renderable'
 module Immoscout
   module Models
     module Parts
+      # Shared country-region-related property definitions.
+      # See: https://bit.ly/3CSGnmN
       class InternationalCountryRegion < Base
         include Immoscout::Models::Concerns::Renderable
         include Immoscout::Models::Concerns::Propertiable
+
         property :country
         property :region
       end

data/lib/immoscout/models/parts/price.rb

@@ -7,9 +7,12 @@ require_relative '../concerns/renderable'
 module Immoscout
   module Models
     module Parts
+      # Shared price-related property definitions.
+      # See: https://bit.ly/3CSGnmN
       class Price < Base
         include Immoscout::Models::Concerns::Renderable
         include Immoscout::Models::Concerns::Propertiable
+
         property :value
         property :currency
         property :marketing_type

data/lib/immoscout/models/parts/publish_channel.rb

@@ -7,9 +7,12 @@ require_relative '../concerns/renderable'
 module Immoscout
   module Models
     module Parts
+      # Shared publish-channel-related property definitions.
+      # See: https://bit.ly/3CSGnmN
       class PublishChannel < Base
         include Immoscout::Models::Concerns::Renderable
         include Immoscout::Models::Concerns::Propertiable
+
         property :id, alias: :@id, default: 10_000
       end
     end

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

@@ -7,9 +7,12 @@ require_relative '../concerns/renderable'
 module Immoscout
   module Models
     module Parts
+      # Shared real-estate-related property definitions.
+      # See: https://bit.ly/3CSGnmN
       class RealEstate < Base
         include Immoscout::Models::Concerns::Renderable
         include Immoscout::Models::Concerns::Propertiable
+
         property :id, alias: :@id
       end
     end

data/lib/immoscout/models/parts/url.rb

@@ -7,9 +7,12 @@ require_relative '../concerns/renderable'
 module Immoscout
   module Models
     module Parts
+      # Shared URL-related property definitions.
+      # See: https://bit.ly/3CSGnmN
       class Url < Base
         include Immoscout::Models::Concerns::Renderable
         include Immoscout::Models::Concerns::Propertiable
+
         property :scale, alias: :@scale
         property :href, alias: :@href
       end

data/lib/immoscout/models/parts/urls.rb

@@ -8,9 +8,12 @@ require_relative 'url'
 module Immoscout
   module Models
     module Parts
+      # Shared URLs-related property definitions.
+      # See: https://bit.ly/3CSGnmN
       class Urls < Base
         include Immoscout::Models::Concerns::Renderable
         include Immoscout::Models::Concerns::Propertiable
+
         property :url, coerce: Immoscout::Models::Parts::Url, array: true
       end
     end

data/lib/immoscout/models/picture.rb

@@ -7,6 +7,8 @@ require_relative 'actions/attachment'
 
 module Immoscout
   module Models
+    # Attachment (picture) of a Real Estate.
+    # See: https://bit.ly/3iE6K9h
     class Picture < Base
       include Immoscout::Models::Concerns::Renderable
       include Immoscout::Models::Concerns::Propertiable
@@ -14,10 +16,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

@@ -8,12 +8,14 @@ require_relative 'parts/publish_channel'
 
 module Immoscout
   module Models
+    # The Publish (object) of a Real Estate.
+    # See: https://bit.ly/3ZFoYYI
     class Publish < Base
       include Immoscout::Models::Concerns::Renderable
       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,6 +1,7 @@
+# frozen_string_literal: true
+
 require_relative 'errors/failed'
 require_relative 'api/client'
-# renderable models
 require_relative 'models/house_buy'
 require_relative 'models/apartment_buy'
 require_relative 'models/contact'

data/lib/immoscout/version.rb

@@ -1,5 +1,23 @@
 # frozen_string_literal: true
 
+# The gem version details.
 module Immoscout
-  VERSION = "1.3.1".freeze
+  # The version of the +immoscout+ gem
+  VERSION = '1.4.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/immoscout.rb

@@ -4,10 +4,11 @@ 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'
 
+# The top-namespace of the +immoscout+ gem.
 module Immoscout
   class << self
     attr_writer :configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: immoscout
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Marcus Geissler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,42 +16,42 @@ 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: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: simple_oauth
   requirement: !ruby/object:Gem::Requirement
@@ -70,280 +70,305 @@ 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'
-    - - "<"
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: countless
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.11'
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.11'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-json_expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: rspec-json_expectations
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.28'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.1
+        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.15'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.15'
+        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:
 email:
-- marcus.geissler@hanseventures.com
+- marcus3006@gmail.com
 executables: []
 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
 - Dockerfile
 - Envfile
 - Gemfile
+- Guardfile
 - LICENSE
 - Makefile
 - README.md
@@ -356,7 +381,6 @@ files:
 - doc/assets/project.svg
 - docker-compose.yml
 - gemfiles/rails_5.2.gemfile
-- gemfiles/rails_6.0.gemfile
 - immoscout.gemspec
 - lib/immoscout.rb
 - lib/immoscout/api/client.rb
@@ -396,18 +420,22 @@ files:
 - lib/immoscout/models/picture.rb
 - lib/immoscout/models/publish.rb
 - lib/immoscout/version.rb
-homepage: https://github.com/hausgold/immoscout
+homepage:
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/hausgold/immoscout
+  source_code_uri: https://github.com/hausgold/immoscout
+  changelog_uri: https://github.com/hausgold/immoscout/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/hausgold/immoscout/issues
+  documentation_uri: https://www.rubydoc.info/gems/immoscout
 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
@@ -416,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 Immobilienscout24 REST API

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

data/gemfiles/rails_6.0.gemfile

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