immobilienscout 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e94144983edce73e19c3bf4a64b2ab02ef5297e4f10f714ddb7b0e68645aa9b6
-  data.tar.gz: a816281b3268330b43d8a2f7b50ecb25e281d749b79b2172af7068ca64281bcf
+  metadata.gz: 7088e64b433baae893c02d9ac5d3845ec0ed2e66512deb5c881ca381ca2e7a5c
+  data.tar.gz: 9744cf7bb4d0fd051a3912fb5b40cbc6d8c448140bda4717528a8c0b78093721
 SHA512:
-  metadata.gz: 7d4664aaecc0dce42f23d10776a8102a71e7419599254ab36be12ccf594ed049bf7f4d6f4813b5768c9c28b17d61548fabc6b014f2dae03e8dc6dcad51f8053c
-  data.tar.gz: bc3f0ae38c2729544fb49f74a9514c1282accc91171899987c7d4ea5f16643c649dd6d6e9c530f383bc91329c227cacf8273b6b48fda0d7ab96b54748108a627
+  metadata.gz: 1d760a79dc5c852d8186b602b2cd81eab6d88e1b0cca3b3258ba854599dd36ebfaf490b44ebe38b227327e45c07e048def8d487ea5540853497e9c1b610bf6c9
+  data.tar.gz: 0d4e2caf14860b87ea5c911eab45f6cc11551b976cb8716a342dd81aa03f24320fb35bbb40fe0dbf19cdbd5101101c880f408704750e0ec3a278593a8b6ba98f

data/.rubocop.yml

@@ -0,0 +1,68 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  DisabledByDefault: false
+  DisplayCopNames: true
+  TargetRubyVersion: 2.6
+  Exclude:
+    - bin/bundle
+    - 'vendor/**/*'
+    - 'gemfiles/vendor/**/*'
+
+#################### Lint ################################
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: true
+  Max: 100
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 20
+
+Layout/LineLength:
+  Enabled: true
+  Max: 120
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/MixinUsage:
+  Enabled: true
+  Exclude:
+    - bin/setup
+    - bin/update
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false

data/.travis.yml

@@ -5,5 +5,9 @@ cache: bundler
 rvm:
   - 2.4.6
   - 2.5.5
-  - 2.6.3
+  - 2.6.5
+script:
+  - bundle exec rubocop
+  - bundle exec rspec
+
 before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -4,7 +4,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.0.8] - 2020-07-16
+* Added retrieve_all endpoint to attachments to retrieve all attachments of a property
+* Added destroy endpoint to attachments to destroy an attachment of a property
+
+## [0.0.7] - 2020-03-30
+* Improve error handling. Catching a `InvalidRequest` error still works, but now
+  there are additional errors for a more fine-grained error-handling. Namely
+  `ResourceNotFound`, `CommonResourceNotFound` and `ResourceValidation`.
+* Add `rubocop`, `rubocop-rspec` and `rubocop-performance`
+* Build with Ruby `2.6.5` on Travis
+
+## [0.0.6] - 2020-02-18
+Adding update endpoint to update a property
+
+## [0.0.5] - 2020-02-06
+Adding show endpoint to retrieve a single property
+
+## [0.0.4] - 2019-10-17
+Adding endpoint to update order of attachments for a specific property
 
 ## [0.0.3] - 2019-08-15
 Update the response accord to the Immobilienscout changes in the `JSON` structure

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    immobilienscout (0.0.2)
+    immobilienscout (0.0.8)
       activesupport
       json
       multipart-post
@@ -9,46 +9,67 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (5.2.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
     byebug (9.1.0)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    hashdiff (1.0.0)
-    i18n (1.6.0)
+    hashdiff (1.0.1)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    json (2.2.0)
-    minitest (5.11.3)
+    jaro_winkler (1.5.4)
+    json (2.3.1)
+    minitest (5.14.1)
     multipart-post (2.1.1)
-    public_suffix (3.1.1)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    public_suffix (4.0.3)
+    rainbow (3.0.0)
     rake (12.3.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.38.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
     thread_safe (0.3.6)
     timecop (0.8.1)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    vcr (5.0.0)
-    webmock (3.6.2)
+    unicode-display_width (1.6.1)
+    vcr (5.1.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -62,9 +83,12 @@ DEPENDENCIES
   immobilienscout!
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop (~> 0.72)
+  rubocop-performance
+  rubocop-rspec
   timecop (~> 0.8.1)
   vcr (~> 5.0)
   webmock (~> 3.6)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -1,5 +1,9 @@
 # Immobilienscout gem
 
+[![Build Status](https://travis-ci.com/homeday-de/immobilienscout.svg?branch=master)](https://travis-ci.com/homeday-de/immobilienscout)
+[![Gem Version](https://badge.fury.io/rb/immobilienscout.svg)](https://badge.fury.io/rb/immobilienscout)
+[![GitHub license](https://img.shields.io/github/license/homeday-de/immobilienscout)](https://github.com/homeday-de/immobilienscout/blob/master/LICENSE.txt)
+
 This is an interface for Immobilienscout API
 
 ## Example
@@ -28,15 +32,49 @@ Immobilienscout::API::Property.create({params})
 Immobilienscout::API::Property.publish({params})
 ```
 
+- Update property
+```ruby
+Immobilienscout::API::Property.update(is24_id, {params})
+```
+
+_Notes:_
+
+You have to send all attributes, also if only one attribute has changed. Otherwise Immobilienscout cannot interpret if a missing attribute should be filled in with NULL or not.
+
+`is24_id` is the id returned by Immobilienscout when you first created the property.
+
+If you have provided a custom id, you can use `"ext-#{custom_id}"` instead of the is24_id.
+
+
 - Delete property
 ```ruby
 Immobilienscout::API::Property.destroy(is24_id)
 ```
 
+- Show property
+```ruby
+Immobilienscout::API::Property.show(is24_id)
+```
+
 #### Attachment
  - Add attachments to property
 ```ruby
 Immobilienscout::API::Attachment.add(is24_id, binary_file, {metadata})
+```
+
+ - Order attachments for a specific property
+```ruby
+Immobilienscout::API::Attachment.put_order(is24_id, {params})
+```
+
+ - Retrieve all attachments for a specific property
+```ruby
+Immobilienscout::API::Attachment.retrieve_all(is24_id)
+```
+
+ - Delete an attachment for a specific property
+```ruby
+Immobilienscout::API::Attachment.destroy(is24_id, attachment_id)
 ```
 
 #### Report

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "immobilienscout"
+require 'bundler/setup'
+require 'immobilienscout'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "immobilienscout"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/immobilienscout.gemspec

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'immobilienscout/version'
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = 'immobilienscout'
   spec.version       = Immobilienscout::VERSION
@@ -19,21 +22,25 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport'
   spec.add_dependency 'json'
   spec.add_dependency 'multipart-post'
-  spec.add_dependency 'activesupport'
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug', '~> 9.0'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency('rubocop', ['~>0.72'])
+  spec.add_development_dependency('rubocop-performance')
+  spec.add_development_dependency('rubocop-rspec')
   spec.add_development_dependency 'timecop', '~> 0.8.1'
   spec.add_development_dependency 'vcr', '~> 5.0'
   spec.add_development_dependency 'webmock', '~> 3.6'
 end
+# rubocop:enable Metrics/BlockLength

data/lib/immobilienscout.rb

@@ -1,13 +1,19 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'active_support/core_ext'
 require 'immobilienscout/authenticator'
 require 'immobilienscout/request'
+require 'immobilienscout/request_error_handler'
 require 'immobilienscout/response_parser'
 require 'immobilienscout/client'
 require 'immobilienscout/api/property'
 require 'immobilienscout/api/attachment'
 require 'immobilienscout/api/report'
 require 'immobilienscout/errors/invalid_request'
+require 'immobilienscout/errors/common_resource_not_found'
+require 'immobilienscout/errors/resource_not_found'
+require 'immobilienscout/errors/resource_validation'
 
 module Immobilienscout
   class << self

data/lib/immobilienscout/api/attachment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Immobilienscout
   module API
     class Attachment
@@ -10,7 +12,41 @@ module Immobilienscout
           params = { attachment: binary_file, metadata: metadata_file }
           parsed_response = Immobilienscout::Request.new(url, params).post_with_multipart
 
-          raise Immobilienscout::Errors::InvalidRequest, parsed_response.messages.map(&:messages) unless parsed_response.success?
+          unless parsed_response.success?
+            raise Immobilienscout::Errors::InvalidRequest, parsed_response.messages.map(&:messages)
+          end
+
+          parsed_response
+        end
+
+        def put_order(is24_id, params)
+          raise ArgumentError unless params.present?
+
+          parsed_response = Immobilienscout::Request.new(put_order_url(is24_id), params).put
+          unless parsed_response.success?
+            raise Immobilienscout::Errors::InvalidRequest, parsed_response.messages.map(&:messages)
+          end
+
+          parsed_response
+        end
+
+        def retrieve_all(is24_id)
+          raise ArgumentError unless is24_id.present?
+
+          url = retrieve_all_url(is24_id)
+          parsed_response = Immobilienscout::Request.new(url).get
+          Immobilienscout::RequestErrorHandler.handle(parsed_response) unless parsed_response.success?
+
+          parsed_response
+        end
+
+        def destroy(is24_id, attachment_id)
+          raise ArgumentError unless is24_id.present?
+          raise ArgumentError unless attachment_id.present?
+
+          url = destroy_url(is24_id, attachment_id)
+          parsed_response = Immobilienscout::Request.new(url).delete
+          Immobilienscout::RequestErrorHandler.handle(parsed_response) unless parsed_response.success?
 
           parsed_response
         end
@@ -25,6 +61,21 @@ module Immobilienscout
         def add_url(is24_id)
           "#{Immobilienscout::Client.api_url}/restapi/api/offer/v1.0/user/me/realestate/#{is24_id}/attachment"
         end
+
+        def put_order_url(is24_id)
+          "#{Immobilienscout::Client.api_url}/restapi/api/"\
+          "offer/v1.0/user/me/realestate/#{is24_id}/attachment/attachmentsorder"
+        end
+
+        def retrieve_all_url(is24_id)
+          "#{Immobilienscout::Client.api_url}/restapi/api/"\
+          "offer/v1.0/user/me/realestate/#{is24_id}/attachment"
+        end
+
+        def destroy_url(is24_id, attachment_id)
+          "#{Immobilienscout::Client.api_url}/restapi/api/"\
+          "offer/v1.0/user/me/realestate/#{is24_id}/attachment/#{attachment_id}"
+        end
       end
     end
   end

data/lib/immobilienscout/api/property.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Immobilienscout
   module API
     module Property
@@ -8,6 +10,14 @@ module Immobilienscout
           execute_post_request(create_url, params)
         end
 
+        def update(is24_id, params)
+          raise ArgumentError unless params.present?
+
+          update_url = update_url(is24_id)
+
+          execute_put_request(update_url, params)
+        end
+
         def publish(params)
           raise ArgumentError unless params.present?
 
@@ -22,18 +32,40 @@ module Immobilienscout
           execute_delete_request(destroy_url)
         end
 
+        def show(is24_id)
+          raise ArgumentError unless is24_id.present?
+
+          show_url = show_url(is24_id)
+
+          execute_get_request(show_url)
+        end
+
         private
 
         def execute_post_request(url, params)
           parsed_response = Immobilienscout::Request.new(url, params).post
-          raise Immobilienscout::Errors::InvalidRequest, parsed_response.messages.map(&:messages) unless parsed_response.success?
+          Immobilienscout::RequestErrorHandler.handle(parsed_response) unless parsed_response.success?
+
+          parsed_response
+        end
+
+        def execute_put_request(url, params)
+          parsed_response = Immobilienscout::Request.new(url, params).put
+          Immobilienscout::RequestErrorHandler.handle(parsed_response) unless parsed_response.success?
 
           parsed_response
         end
 
         def execute_delete_request(url)
           parsed_response = Immobilienscout::Request.new(url).delete
-          raise Immobilienscout::Errors::InvalidRequest, parsed_response.messages.map(&:messages) unless parsed_response.success?
+          Immobilienscout::RequestErrorHandler.handle(parsed_response) unless parsed_response.success?
+
+          parsed_response
+        end
+
+        def execute_get_request(url)
+          parsed_response = Immobilienscout::Request.new(url).get
+          Immobilienscout::RequestErrorHandler.handle(parsed_response) unless parsed_response.success?
 
           parsed_response
         end
@@ -42,6 +74,10 @@ module Immobilienscout
           "#{Immobilienscout::Client.api_url}/restapi/api/offer/v1.0/user/me/realestate"
         end
 
+        def update_url(is24_id)
+          "#{Immobilienscout::Client.api_url}/restapi/api/offer/v1.0/user/me/realestate/#{is24_id}"
+        end
+
         def publish_url
           "#{Immobilienscout::Client.api_url}/restapi/api/offer/v1.0/publish"
         end
@@ -49,6 +85,10 @@ module Immobilienscout
         def destroy_url(is24_id)
           "#{Immobilienscout::Client.api_url}/restapi/api/offer/v1.0/user/me/realestate/#{is24_id}"
         end
+
+        def show_url(is24_id)
+          "#{Immobilienscout::Client.api_url}/restapi/api/offer/v1.0/user/me/realestate/#{is24_id}"
+        end
       end
     end
   end

data/lib/immobilienscout/api/report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Immobilienscout
   module API
     class Report
@@ -15,7 +17,7 @@ module Immobilienscout
 
         def execute_get_request(url, query_params)
           parsed_response = Immobilienscout::Request.new(url, query_params).get
-          raise Immobilienscout::Errors::InvalidRequest, Array.wrap(parsed_response.messages['message']) unless parsed_response.success?
+          Immobilienscout::RequestErrorHandler.handle(parsed_response) unless parsed_response.success?
 
           parsed_response
         end

data/lib/immobilienscout/authenticator.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'open-uri'
 
 module Immobilienscout
   class Authenticator
-    ALLOWED_METHODS = %w(POST GET DELETE).freeze
-    OAUTH_SIGNATURE_METHOD = 'HMAC-SHA1'.freeze
-    OAUTH_VERSION = '1.0'.freeze
-    HASH_DIGEST = 'sha1'.freeze
+    ALLOWED_METHODS = %w[POST GET DELETE PUT].freeze
+    OAUTH_SIGNATURE_METHOD = 'HMAC-SHA1'
+    OAUTH_VERSION = '1.0'
+    HASH_DIGEST = 'sha1'
 
     def initialize(url, method, query_params = nil)
       @url = url
@@ -40,14 +42,15 @@ module Immobilienscout
     end
 
     def signing_key
-      "#{url_encode(Immobilienscout.configuration.consumer_secret)}&#{url_encode(Immobilienscout.configuration.access_token_secret)}"
+      "#{url_encode(Immobilienscout.configuration.consumer_secret)}&"\
+      "#{url_encode(Immobilienscout.configuration.access_token_secret)}"
     end
 
     def generate_nonce
       Base64.encode64(random_bytes).gsub(/\W/, '')
     end
 
-    def random_bytes(size=7)
+    def random_bytes(size = 7)
       OpenSSL::Random.random_bytes(size)
     end
 
@@ -80,7 +83,7 @@ module Immobilienscout
     end
 
     def auth_header_string(params)
-      header_params = params.each_with_object('OAuth ') do |(key, value), header|
+      header_params = params.each_with_object(+'OAuth ') do |(key, value), header|
         header << "#{key}=#{value},"
       end
       header_params.chop

data/lib/immobilienscout/client.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Immobilienscout
   class Client
-    SANDBOX_URL = 'https://rest.sandbox-immobilienscout24.de'.freeze
-    LIVE_URL = 'https://rest.immobilienscout24.de'.freeze
+    SANDBOX_URL = 'https://rest.sandbox-immobilienscout24.de'
+    LIVE_URL = 'https://rest.immobilienscout24.de'
 
     def self.api_url
       return SANDBOX_URL if Immobilienscout.configuration.use_sandbox

data/lib/immobilienscout/errors/common_resource_not_found.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Immobilienscout
+  module Errors
+    class CommonResourceNotFound < InvalidRequest
+    end
+  end
+end

data/lib/immobilienscout/errors/invalid_request.rb

@@ -1,9 +1,8 @@
+# frozen_string_literal: true
+
 module Immobilienscout
   module Errors
     class InvalidRequest < StandardError
-      def initialize(msg = message)
-        super
-      end
     end
   end
 end

data/lib/immobilienscout/errors/resource_not_found.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Immobilienscout
+  module Errors
+    class ResourceNotFound < InvalidRequest
+    end
+  end
+end

data/lib/immobilienscout/errors/resource_validation.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Immobilienscout
+  module Errors
+    class ResourceValidation < InvalidRequest
+    end
+  end
+end

data/lib/immobilienscout/request.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'net/http/post/multipart'
 require 'uri'
 
 module Immobilienscout
   class Request
-    def initialize(url, params = nil)
+    def initialize(url, params = {})
       @url = url
       @params = params
 
@@ -48,6 +50,19 @@ module Immobilienscout
       execute_request(uri, request)
     end
 
+    def put
+      auth_header = generate_auth_header('PUT')
+      headers = generate_headers(auth_header)
+
+      uri = URI.parse(@url)
+
+      request = Net::HTTP::Put.new(uri)
+      request.body = @params.to_json
+      request.initialize_http_header(headers)
+
+      execute_request(uri, request)
+    end
+
     def delete
       auth_header = generate_auth_header('DELETE')
       headers = generate_headers(auth_header)

data/lib/immobilienscout/request_error_handler.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Immobilienscout
+  module RequestErrorHandler
+    class << self
+      ERROR_RESOURCE_NOT_FOUND = 'ERROR_RESOURCE_NOT_FOUND'
+      ERROR_COMMON_RESOURCE_NOT_FOUND = 'ERROR_COMMON_RESOURCE_NOT_FOUND'
+      ERROR_RESOURCE_VALIDATION = 'ERROR_RESOURCE_VALIDATION'
+
+      def handle(parsed_response)
+        if parsed_response.messages.is_a?(Array)
+          error_code = parsed_response.messages&.first&.code
+          error_messages = parsed_response.messages.map(&:messages)
+        else
+          error_code = parsed_response.messages['messageCode']
+          error_messages = Array.wrap(parsed_response.messages['message'])
+        end
+
+        error_class = error_class(error_code)
+        raise error_class, error_messages
+      end
+
+      private
+
+      def error_class(error_code)
+        case error_code
+        when ERROR_RESOURCE_NOT_FOUND
+          Immobilienscout::Errors::ResourceNotFound
+        when ERROR_COMMON_RESOURCE_NOT_FOUND
+          Immobilienscout::Errors::CommonResourceNotFound
+        when ERROR_RESOURCE_VALIDATION
+          Immobilienscout::Errors::ResourceValidation
+        else
+          Immobilienscout::Errors::InvalidRequest
+        end
+      end
+    end
+  end
+end

data/lib/immobilienscout/response_parser.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Immobilienscout
   class ResponseParser
-    HTTP_OK = %w(200 201).freeze
+    HTTP_OK = %w[200 201].freeze
 
     Message = Struct.new(:success?, :code, :messages, :id)
 

data/lib/immobilienscout/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Immobilienscout
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.8'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: immobilienscout
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Homeday GmbH
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: multipart-post
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: multipart-post
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +109,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '0.72'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '0.72'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -160,6 +202,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -177,8 +220,12 @@ files:
 - lib/immobilienscout/api/report.rb
 - lib/immobilienscout/authenticator.rb
 - lib/immobilienscout/client.rb
+- lib/immobilienscout/errors/common_resource_not_found.rb
 - lib/immobilienscout/errors/invalid_request.rb
+- lib/immobilienscout/errors/resource_not_found.rb
+- lib/immobilienscout/errors/resource_validation.rb
 - lib/immobilienscout/request.rb
+- lib/immobilienscout/request_error_handler.rb
 - lib/immobilienscout/response_parser.rb
 - lib/immobilienscout/version.rb
 homepage: https://github.com/homeday-de/immobilienscout