immoscout 1.1.0 → 1.3.2

data/gemfiles/rails_6.0.gemfile

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

data/immoscout.gemspec

@@ -1,47 +1,59 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "immoscout/version"
+require 'immoscout/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "immoscout"
+  spec.name          = 'immoscout'
   spec.version       = Immoscout::VERSION
-  spec.authors       = ["Marcus Geissler"]
-  spec.email         = ["marcus.geissler@hanseventures.com"]
+  spec.authors       = ['Marcus Geissler']
+  spec.email         = ['marcus.geissler@hanseventures.com']
 
   spec.summary       = 'Ruby client for the Immobilienscout24 REST API'
-  spec.homepage      = "https://github.com/hausgold/immoscout"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/hausgold/immoscout'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '~> 2.5'
 
   # Prevent pushing this gem to RubyGems.org.
   # To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this
   # section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.add_dependency "activesupport", ">= 3.2.0"
-  spec.add_dependency "faraday", "~> 0.13.0"
-  spec.add_dependency "faraday_middleware", "~> 0.12.0"
-  spec.add_dependency "simple_oauth", ">= 0.3"
+  spec.require_paths = ['lib']
+  spec.add_dependency 'activesupport', '>= 5.2.0'
+  spec.add_dependency 'faraday', '~> 1.0'
+  spec.add_dependency 'faraday_middleware', '~> 1.0'
+  spec.add_dependency 'simple_oauth', '>= 0.3'
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-json_expectations", "~> 1.4.0"
-  spec.add_development_dependency "vcr", "~> 3.0.0"
-  spec.add_development_dependency "webmock", "~> 2.3.0"
-  spec.add_development_dependency "simplecov"
+  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 '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.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'
 end

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,17 +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,28 +16,39 @@ 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(
               "user/#{api.user_name}/realestate/#{attachable_id}/attachment",
               nil,
               attachment: Faraday::UploadIO.new(file, content_type, file_name),
-              metadata: as_json
+              metadata: Faraday::UploadIO.new(
+                StringIO.new(to_json),
+                'application/json',
+                'metadata.json'
+              )
             )
             handle_response(response)
             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
@@ -57,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"
@@ -75,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.1.0".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'