justimmo_client 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f74e4f934c4b4a0d3d9e84414ada4785a6a908ab
-  data.tar.gz: b10b66166909331951bbce4c7a33c7be2f798bc0
+  metadata.gz: 6889b2849895ac84cbda9609a4d40847104acd88
+  data.tar.gz: a90c60aef5e69d154704b24a15b13f7eef656f0c
 SHA512:
-  metadata.gz: d966a8283487c6549a23436df247501bf9509628bdac52a80256fe12190f78367b6293fba837d151d21bf29ab7af3b9f3984b14d78cad20cf0a9949992e514ce
-  data.tar.gz: 680da3354939fbf771cb11e5efda8b98d3eb08a6854be401ccdccc6a7877605e40b2041d7f1f77c4d5180cc1cd587114cdd81f38b1c74d872896afa88eef02b5
+  metadata.gz: 7168d63aa6ff0d8c4901f0893c78b268840457d048caffb9d271c6e658f4ed030caa779dcf1299eb88cae19d9d18e4d3ad1142f02e4c652e24e14853a78fffc0
+  data.tar.gz: 48f3d5ba3187aa261ea3ae2f72cf946ce9c616e8abbeb1c40734c2d2bacd58a7fd686e3288c5d3b0c8727206946fbff40c0c6742fe90945ae065397760c8b5a2

data/lib/justimmo_client/api/v1/requests/realty_request.rb

@@ -18,7 +18,7 @@ module JustimmoClient::V1
       type: :objektart,
       subtype: :subobjektart,
       tag: :tagname,
-      room_count: :zimmer,
+      rooms: :zimmer,
       area: :flaeche,
       living_area: :wohnflaeche,
       floor_area: :nutzflaeche,
@@ -36,7 +36,9 @@ module JustimmoClient::V1
       last_name: :nachname,
       phone: :tel,
       location: :ort,
-      all: :alle
+      all: :alle,
+      rent: :miete,
+      purcase: :kauf
     }.freeze
 
     module_function
@@ -46,34 +48,44 @@ module JustimmoClient::V1
     # @param [Hash] params
     # @return [String] The requested XML.
     def list(**params)
-      get("objekt/list", list_option_parser.parse(params))
+      with_error_handler do
+        get("objekt/list", list_option_parser.parse(params))
+      end
     end
 
     # @param [Integer] id
     # @param [String, Symbol] lang
     # @return [String] The requested XML.
     def detail(id, lang: nil)
-      get("objekt/detail", detail_option_parser.parse(id: id, lang: lang))
+      with_error_handler do
+        get("objekt/detail", detail_option_parser.parse(id: id, lang: lang))
+      end
     end
 
     # @param [Integer] id
     # @param [Hash] params
     # @return [String] The requested XML.
     def inquiry(id, **params)
-      get("objekt/anfrage", inquiry_option_parser.parse(params.update(id: id)))
+      with_error_handler do
+        get("objekt/anfrage", inquiry_option_parser.parse(params.update(id: id)))
+      end
     end
 
     # @param [Hash] params
     # @return [String] A JSON string containing an array of ids.
     def ids(**params)
-      get("objekt/ids", list_option_parser.parse(params))
+      with_error_handler do
+        get("objekt/ids", list_option_parser.parse(params))
+      end
     end
 
     # @todo implement this
     # @param [Hash] params
     # @return [File] The PDF file.
     def expose(**params)
-      get("objekt/expose", params)
+      with_error_handler do
+        get("objekt/expose", params)
+      end
     end
 
     # @!group Basic Data Requests
@@ -81,26 +93,34 @@ module JustimmoClient::V1
     # @param [Boolean] all (false)
     # @return [String] The requested XML.
     def categories(all: false)
-      get("objekt/kategorien", alle: all ? 1 : 0)
+      with_error_handler do
+        get("objekt/kategorien", alle: all ? 1 : 0)
+      end
     end
 
     # @param [Boolean] all (false)
     # @return [String] The requested XML.
     def types(all: false)
-      get("objekt/objektarten", alle: all ? 1 : 0)
+      with_error_handler do
+        get("objekt/objektarten", alle: all ? 1 : 0)
+      end
     end
 
     # @param [Boolean] all (false)
     # @return [String] The requested XML.
     def countries(all: false)
-      get("objekt/laender", alle: all ? 1 : 0)
+      with_error_handler do
+        get("objekt/laender", alle: all ? 1 : 0)
+      end
     end
 
     # @param [Boolean] all (false)
     # @param [Integer, String] country
     # @return [String] The requested XML.
     def federal_states(country:, all: false)
-      get("objekt/bundeslaender", land: country, alle: all ? 1 : 0)
+      with_error_handler do
+        get("objekt/bundeslaender", land: country, alle: all ? 1 : 0)
+      end
     end
 
     # @param [Boolean] all (false)
@@ -108,7 +128,9 @@ module JustimmoClient::V1
     # @param [Integer] federal_state
     # @return [String] The requested XML.
     def regions(country: nil, federal_state: nil, all: false)
-      get("objekt/regionen", land: country, bundesland: federal_state, alle: all ? 1 : 0)
+      with_error_handler do
+        get("objekt/regionen", land: country, bundesland: federal_state, alle: all ? 1 : 0)
+      end
     end
 
     # @param [Boolean] all (false)
@@ -116,7 +138,16 @@ module JustimmoClient::V1
     # @param [Integer] federal_state
     # @return [String] The requested XML.
     def zip_codes_and_cities(country: nil, federal_state: nil, all: false)
-      get("objekt/plzsUndOrte", land: country, bundesland: federal_state, alle: all ? 1 : 0)
+      with_error_handler do
+        get("objekt/plzsUndOrte", land: country, bundesland: federal_state, alle: all ? 1 : 0)
+      end
+    end
+
+    def with_error_handler
+      yield
+    rescue JustimmoClient::OptionParserError => e
+      log.error(e)
+      raise JustimmoClient::RetrievalFailed, e
     end
 
     # @!group Option Parsers
@@ -131,9 +162,9 @@ module JustimmoClient::V1
         options.add :limit
         options.add :offset
         options.add :lang
-        options.add :orderby, values: %w[price zip_code number created_at updated_at published_at]
-        options.add :ordertype, values: %w[asc desc]
-        options.add :picturesize, values: %w[small_unbranded small2_unbranded small3_unbranded medium_unbranded big_unbranded big2_unbranded medium big bin2]
+        options.add :orderby, values: %i[price zip_code number created_at updated_at published_at]
+        options.add :ordertype, values: %i[asc desc]
+        options.add :picturesize, values: %i[small_unbranded small2_unbranded small3_unbranded medium_unbranded big_unbranded big2_unbranded medium big big2]
         options.add :with_projects, type: :bool
         options.group :filter do |f|
           f.add :price_min
@@ -146,8 +177,8 @@ module JustimmoClient::V1
           f.add :zip_code
           f.add :zip_code_min
           f.add :zip_code_max
-          f.add :room_count_min
-          f.add :room_count_max
+          f.add :rooms_min
+          f.add :rooms_max
           f.add :number
           f.add :number_min
           f.add :number_max
@@ -166,8 +197,14 @@ module JustimmoClient::V1
           f.add :project_id
           f.add :type
           f.add :parent_id
+          f.add :rent, type: :bool
+          f.add :purcase, type: :bool
           f.add :updated_at_min, as: :aktualisiert_am_von
           f.add :updated_at_max, as: :aktualisiert_am_bis
+          f.add :location do |key, value|
+            cities = JustimmoClient::Realty.zip_codes_and_cities
+            [:zip_code, cities.select { |x| x.location == value }.first&.zip_code]
+          end
         end
       end
     end

data/lib/justimmo_client/core/config.rb

@@ -32,10 +32,10 @@ module JustimmoClient
 
       def validate
         missing = REQUIRED.select { |r| @_config[r].nil? }
-        raise MissingConfiguration, missing unless missing.empty?
+        raise JustimmoClient::MissingConfiguration, missing unless missing.empty?
 
         supported_ver = SUPPORTED_API_VERSIONS.include?(api_ver)
-        raise UnsupportedAPIVersion, api_ver unless supported_ver
+        raise JustimmoClient::UnsupportedAPIVersion, api_ver unless supported_ver
       end
 
       def url

data/lib/justimmo_client/errors.rb

@@ -3,11 +3,13 @@
 # Exceptions for internal use
 module JustimmoClient::Errors
   JustimmoError = Class.new(StandardError)
-  InitializationError = Class.new(JustimmoError)
 
   # Raised when configuration validation fails.
   ConfigurationError = Class.new(JustimmoError)
 
+  # Raised when option parsing fails
+  OptionParserError = Class.new(JustimmoError)
+
   # Raised when authentication with the API fails.
   class AuthenticationFailed < JustimmoError
     def initialize
@@ -22,37 +24,31 @@ module JustimmoClient::Errors
     end
   end
 
-  # A mapping could not be found in the mappings hash.
-  class MappingNotFound < JustimmoError
-    def initialize(map)
-      super("Could not find #{map} mapping.")
-    end
-  end
-
-  # A key could not be found in the specified mapping.
-  class KeyNotFound < JustimmoError
-    def initialize(key, map)
-      super("Key #{key} not found in #{map} mapping.")
+  # Raised when the option parser rejects an option
+  class InvalidOption < OptionParserError
+    def initialize(key)
+      super("Option '#{key}' not supported")
     end
   end
 
-  class NotImplemented < JustimmoError
-    def initialize(meth)
-      super("Method #{meth} not implemented!")
+  # Raised when the option parser rejects a value
+  class InvalidValue < OptionParserError
+    def initialize(value)
+      super("'#{value}' is not in the list of accepted values")
     end
   end
 
   # Raised when an unsupported API version is set.
   class UnsupportedAPIVersion < ConfigurationError
     def initialize(version)
-      super("API Version #{version} not supported.")
+      super("API Version #{version} not supported")
     end
   end
 
   # Raised on missing required configuration options.
   class MissingConfiguration < ConfigurationError
     def initialize(missing)
-      super("Required configuration missing: #{missing}.")
+      super("Required configuration missing: #{missing}")
     end
   end
 end

data/lib/justimmo_client/option_parser.rb

@@ -19,8 +19,8 @@ module JustimmoClient
       parse unless options.empty?
     end
 
-    def add(key, **options)
-      add_option(key, options)
+    def add(key, **options, &block)
+      add_option(key, options, &block)
     end
 
     def group(groupname)
@@ -33,7 +33,7 @@ module JustimmoClient
       out = {}
 
       options.each do |key, value|
-        raise ArgumentError, "Invalid option: #{key}" unless @options.key?(key.to_sym)
+        raise JustimmoClient::InvalidOption, key unless @options.key?(key.to_sym)
         group = group_of(key)
 
         if group
@@ -49,12 +49,13 @@ module JustimmoClient
 
     private
 
-    def add_option(key, **options)
+    def add_option(key, **options, &block)
       @options[key.to_sym] = {
         group: @context,
         type: options[:type],
         as: options[:as],
-        values: options[:values]
+        values: options[:values],
+        mod: block_given? ? block : nil
       }
     end
 
@@ -62,6 +63,15 @@ module JustimmoClient
       @options.dig(key, :group)
     end
 
+    def has_mod?(key)
+      @options.dig(key, :mod).is_a?(Proc)
+    end
+
+    def apply_mod(key, value)
+      new_key, new_value = @options.dig(key, :mod).call(key, value)
+      [(new_key || key), (new_value || value)]
+    end
+
     def mapping(key)
       @mappings.fetch(key, key)
     end
@@ -84,7 +94,9 @@ module JustimmoClient
 
     def parse_option(key, value)
       values = @options.dig(key, :values)
-      raise ArgumentError, "Value #{value} not supported" unless values.nil? || values.include?(value)
+      raise JustimmoClient::InvalidValue, value unless values.nil? || values.include?(value)
+
+      key, value = apply_mod(key.to_sym, value) if has_mod?(key)
 
       coerced =
         case @options.dig(key, :type)

data/lib/justimmo_client/realty.rb

@@ -51,6 +51,7 @@ module JustimmoClient
     # @option options [Integer] :parent_id
     # @option options [DateTime] :updated_at_min
     # @option options [DateTime] :updated_at_max
+    # @option options [String] :location
     # @example Filter by zip code and limit to three results.
     #    JustimmoClient::Realty.list(zip_code: 6800, limit: 3)
     # @return [Array<Object>] An array of basic realty objects, or an empty array on error.

data/lib/justimmo_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JustimmoClient
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: justimmo_client
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Patrick Auernig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-16 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler