justimmo_client 0.4.0

data/lib/justimmo_client/api/v1/representers/xml/geo_location_representer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class GeoLocationRepresenter < JustimmoRepresenter
+      property :zip_code, as: :plz
+      property :location, as: :ort
+      property :federal_state, as: :bundesland
+      property :floor, as: :etage
+
+      nested :land do
+        property :country, as: :iso_land, attribute: true
+      end
+
+      property :latitude,
+        as: :user_defined_simplefield,
+        parse_filter: ->(_fragment, options) { options[:doc].css("user_defined_simplefield[feldname=geokoordinaten_breitengrad_exakt]").text }
+
+      property :longitude,
+        as: :user_defined_simplefield,
+        parse_filter: ->(_fragment, options) { options[:doc].css("user_defined_simplefield[feldname=geokoordinaten_laengengrad_exakt]").text }
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/xml/justimmo_representer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "representable/xml"
+
+module JustimmoClient::V1
+  module XML
+    class JustimmoRepresenter < Representable::Decorator
+      include Representable::XML
+
+      defaults render_nil: true
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/xml/realty_area_representer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class RealtyAreaRepresenter < JustimmoRepresenter
+      { balcony_terrace:  :balkon_terrasse_flaeche,
+        balcony:          :balkons_flaeche,
+        office:           :bueroflaeche,
+        garage:           :garagen_flaeche,
+        garden:           :gartenflaeche,
+        total:            :gesamtflaeche,
+        surface:          :grundflaeche,
+        property:         :grundstuecksflaeche,
+        basement:         :kellerflaeche,
+        storage:          :lagerflaeche,
+        loggia:           :loggias_flaeche,
+        floor:            :nutzflaeche,
+        parking:          :stellplatz_flaeche,
+        terrace:          :terrassen_flaeche,
+        buildable:        :verbaubare_flaeche,
+        sales:            :verkaufsflaeche,
+        living:           :wohnflaeche
+      }.each do |key, api|
+        property key, as: api
+      end
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/xml/realty_category_representer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class RealtyCategoryRepresenter < JustimmoRepresenter
+      self.representation_wrap = :objektkategorie
+
+      property :id
+      property :name
+      property :sortablerank
+
+      collection_representer class: RealtyCategory
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/xml/realty_detail_representer.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class RealtyDetailItemRepresenter < RealtyRepresenter
+      nested :verwaltung_techn do
+        property :id,          as: :objektnr_intern
+        property :number,      as: :objektnr_extern
+        property :openimmo_id, as: :openimmo_obid
+      end
+
+      nested :verwaltung_objekt do
+        property :available, as: :verfuegbar_ab
+        property :status_id
+        property :created_at,
+          as: :user_defined_simplefield,
+          parse_filter: ->(_fragment, options) { options[:doc].css("user_defined_simplefield[feldname=erstellt_am]").text }
+        property :updated_at,
+          as: :user_defined_simplefield,
+          parse_filter: ->(_fragment, options) { options[:doc].css("user_defined_simplefield[feldname=aktualisiert_am]").text }
+      end
+
+      property :geo,
+        decorator: GeoLocationRepresenter,
+        class: GeoLocation
+
+      property :contact,
+        as: :kontaktperson,
+        decorator: ContactRepresenter,
+        class: Employee
+
+      nested :freitexte do
+        property :title, as: :objekttitel
+        property :description,
+          as: :objektbeschreibung,
+          parse_filter: ->(frag, _opt) { frag.gsub("\r\n", "\n") }
+        property :description_furniture,
+          as: :ausstatt_beschr,
+          parse_filter: ->(frag, _opt) { frag.split(",").map(&:strip) }
+        nested :user_defined_anyfield do
+          property :furniture, as: :justimmo_moeblierung
+        end
+      end
+
+      property :price,
+        as: :preise,
+        decorator: RealtyPriceRepresenter,
+        class: RealtyPrice
+
+      collection :images,
+        as: :anhang,
+        wrap: :anhaenge,
+        class: Image do
+          property :category, as: :gruppe, attribute: true
+          property :origin, as: :location, attribute: true
+          property :title, as: :anhangtitel
+          nested :daten do
+            %i[pfad small medium big2 medium2 s220x155 fullhd].each do |size|
+              property size,
+              setter: ->(represented:, fragment:, **) do
+                represented.add_url(fragment, default: :big)
+              end
+            end
+          end
+        end
+
+      # FIXME: Get rid of duplicate code!
+      #        Duplicates in RealtyListRepresenter
+      property :area,
+        as: :flaechen,
+        decorator: RealtyAreaRepresenter,
+        class: RealtyArea
+
+      property :room_count,
+        as: :flaechen,
+        decorator: RealtyRoomCountRepresenter,
+        class: RealtyRoomCount
+
+      property :documents, as: :dokumente
+      property :images360, as: :bilder360
+      property :videos
+      property :links
+    end
+
+    class RealtyDetailRepresenter < JustimmoRepresenter
+      property :realty,
+        as: :immobilie,
+        decorator: RealtyDetailItemRepresenter,
+        class: Realty
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/xml/realty_list_representer.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class RealtyListItemRepresenter < RealtyRepresenter
+      property :id
+      property :number, as: :objektnummer
+
+      property :created_at, as: :erstellt_am
+      property :updated_at, as: :aktualisiert_am
+      property :status_id
+
+      property :title,  as: :titel
+      property :teaser, as: :dreizeiler
+      property :description,
+        as: :objektbeschreibung,
+        parse_filter: ->(frag, _opt) { frag.gsub("\r\n", "\n") }
+
+      property :floor, as: :etage
+
+      # Move some attributes into "sub-objects"
+
+      { first_image: :erstes_bild, second_image: :zweites_bild }.each do |key, api|
+        property api, setter: ->(represented:, fragment:, **) { represented.add_image(fragment) }
+      end
+
+      { location: :ort,
+        zip_code: :plz,
+        proximity: :naehe
+      }.each do |key, api|
+        property api, setter: ->(represented:, fragment:, **) { represented.geo.send("#{key}=", fragment) }
+      end
+
+      { balcony_terrace:  :balkon_terrasse_flaeche,
+        balcony:          :balkons_flaeche,
+        office:           :bueroflaeche,
+        garage:           :garagen_flaeche,
+        garden:           :gartenflaeche,
+        total:            :gesamtflaeche,
+        surface:          :grundflaeche,
+        property:         :grundstuecksflaeche,
+        basement:         :kellerflaeche,
+        storage:          :lagerflaeche,
+        loggia:           :loggias_flaeche,
+        floor:            :nutzflaeche,
+        parking:          :stellplatz_flaeche,
+        terrace:          :terrassen_flaeche,
+        buildable:        :verbaubare_flaeche,
+        sales:            :verkaufsflaeche,
+        living:           :wohnflaeche
+      }.each do |key, api|
+        property key,
+          as: api,
+          setter: ->(fragment:, represented:, **) { represented.area[key] = fragment },
+          getter: ->(represented:, **) { represented.area[key] }
+      end
+
+      { store: :anzahl_abstellraum,
+        bathroom: :anzahl_badezimmer,
+        balcony_terrace: :anzahl_balkon_terrassen,
+        balcony: :anzahl_balkone,
+        garden: :anzahl_garten,
+        garage: :anzahl_garagen,
+        loggia: :anzahl_loggias,
+        basement: :anzahl_keller,
+        toilet: :anzahl_sep_wc,
+        parking_space: :anzahl_stellplaetze,
+        total: :anzahl_zimmer
+      }.each do |key, api|
+        property key,
+          as: api,
+          setter: ->(fragment:, represented:, **) { represented.room_count[key] = fragment },
+          getter: ->(represented:, **) { represented.room_count[key] }
+      end
+    end
+
+    class RealtyListRepresenter < JustimmoRepresenter
+      collection :realties,
+        as: :immobilie,
+        wraps: :immobilie,
+        decorator: RealtyListItemRepresenter,
+        class: Realty
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/xml/realty_price_representer.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class RealtyPriceRepresenter < JustimmoRepresenter
+      nested :waehrung do
+        property :currency, as: :iso_waehrung, attribute: true
+      end
+
+      property :purcase,     as: :kaufpreis
+      property :purcase_net, as: :kaufpreisnetto
+      nested :kaufpreis do
+        property :on_demand, as: :auf_anfrage, attribute: true
+      end
+
+      nested :miete do
+        property :rent,     as: :brutto
+        property :rent_net, as: :netto
+        property :rent_vat, as: :ust
+      end
+
+      property :deposit,                as: :kaution
+      property :rent_cold,              as: :kaltmiete
+      property :rent_including_heating, as: :warmmiete
+      property :rent_per_sqm,           as: :mietpreis_pro_qm
+      property :operating_cost_per_sqm, as: :betriebskosten_pro_qm
+
+      property :provision,     as: :provisionspflichtig
+      property :including_vat, as: :zzg_mehrwertsteuer
+      property :commission,    as: :aussen_courtage
+
+      property :real_estate_taxes,
+        as: :user_defined_simplefield,
+        parse_filter: ->(_fragment, options) do
+          options[:doc].css("user_defined_simplefield[feldname=grunderwerbssteuer]").text
+        end
+
+      property :land_registry,
+        as: :user_defined_simplefield,
+        parse_filter: ->(_fragment, options) do
+          options[:doc].css("user_defined_simplefield[feldname=grundbucheintragung]").text
+        end
+
+      nested :zusatzkosten do
+        nested :betriebskosten do
+          property :operating_cost,     as: :brutto
+          property :operating_cost_net, as: :netto
+          property :operating_cost_vat, as: :ust
+        end
+      end
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/xml/realty_representer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class RealtyRepresenter < JustimmoRepresenter
+      nested :category, as: :objektkategorie do
+        property :usage, as: :nutzungsart, class: RealtyUsage do
+          property :living,     as: :WOHNEN,  attribute: true
+          property :business,   as: :GEWERBE, attribute: true
+          property :investment, as: :ANLAGE,  attribute: true
+        end
+
+        property :marketing, as: :vermarktungsart, class: RealtyMarketing do
+          property :buy,  as: :KAUF,        attribute: true
+          property :rent, as: :MIETE_PACHT, attribute: true
+        end
+
+        property :type_id,
+          as: :user_defined_simplefield,
+          parse_filter: ->(_fragment, options) do
+            options[:doc].css("user_defined_simplefield[feldname=objektart_id]").text
+          end
+
+        property :sub_type_id,
+          as: :user_defined_simplefield,
+          parse_filter: ->(_fragment, options) do
+            options[:doc].css("user_defined_simplefield[feldname=sub_objektart_id]").text
+          end
+      end
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/xml/realty_room_count_representer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class RealtyRoomCountRepresenter < JustimmoRepresenter
+      { store:            :anzahl_abstellraum,
+        bathroom:         :anzahl_badezimmer,
+        balcony_terrace:  :anzahl_balkon_terrassen,
+        balcony:          :anzahl_balkone,
+        garden:           :anzahl_garten,
+        garage:           :anzahl_garagen,
+        loggia:           :anzahl_loggias,
+        basement:         :anzahl_keller,
+        toilet:           :anzahl_sep_wc,
+        parking_space:    :anzahl_stellplaetze,
+        total:            :anzahl_zimmer
+      }.each do |key, api|
+        property key, as: api
+      end
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/xml/realty_type_representer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class RealtyTypeRepresenter < JustimmoRepresenter
+      self.representation_wrap = :objektart
+
+      property :id
+      property :name
+
+      collection_representer class: RealtyType
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/xml/region_representer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class RegionRepresenter < JustimmoRepresenter
+      self.representation_wrap = :region
+
+      property :id
+      property :name
+
+      collection_representer class: Region
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/xml.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  # @api private
+  # @!visibility hidden
+  module XML
+    extend JustimmoClient::Utils
+
+    autoload_dir "#{__dir__}/xml/*_representer.rb"
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "json"
+
+module JustimmoClient::V1
+  # @api private
+  module EmployeeRequest
+    extend JustimmoRequest
+
+    module_function
+
+    def list
+      get("team/list")
+    end
+
+    def detail(id)
+      get("team/detail", id: id)
+    end
+
+    def ids
+      get("team/ids")
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "rest_client"
+require "digest"
+require "retriable"
+
+module JustimmoClient::V1
+  # @api private
+  module JustimmoRequest
+    include JustimmoClient::Logging
+    include JustimmoClient::Caching
+
+    def get(path, params = {})
+      with_cache(cache_key(path, params)) { request(path, params) }
+    end
+
+    def request(path, params = {})
+      uri = "#{JustimmoClient::Config.url}/#{path}"
+
+      options = {
+        params: params,
+        Authorization: "Basic #{JustimmoClient::Config.credentials}"
+      }
+
+      with_retries do
+        with_error_handler do
+          log.debug("Requesting #{uri} with params #{options[:params]}")
+          response = RestClient.get(uri, options)
+          response.body
+        end
+      end
+    end
+
+    def with_error_handler
+      yield
+    rescue RestClient::Unauthorized
+      log.error("Authentication failed, check your configuration.")
+      raise JustimmoClient::AuthenticationFailed
+    rescue RestClient::BadRequest, RestClient::NotFound, RestClient::InternalServerError => e
+      raise JustimmoClient::RetrievalFailed, e.message
+    end
+
+    def with_retries
+      options = {
+        base_interval: 2.0,
+        tries: JustimmoClient::Config.request_retries,
+        on_retry: proc do |exception, try, elapsed_time, next_interval|
+          log.error("#{exception.class}: #{exception}")
+          log.error("Try #{try} in #{elapsed_time} seconds, retrying in #{next_interval} seconds.")
+        end,
+        on: JustimmoClient::RetrievalFailed
+      }
+
+      Retriable.retriable(options) { yield }
+    end
+
+    def cache_key(path, params)
+      key = Digest::SHA256.new
+      key << path
+      key << params.to_s
+      key.hexdigest
+    end
+  end
+end