justimmo_client 0.4.0

data/lib/justimmo_client/api/v1/models/realty.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  class Realty < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :id,                    Integer
+    attribute :number,                Integer
+    attribute :title,                 String
+    attribute :description,           String, default: ""
+    attribute :teaser,                String, default: ""
+    attribute :usage,                 RealtyUsage
+    attribute :marketing,             RealtyMarketing
+    attribute :type_id,               Integer
+    attribute :sub_type_id,           Integer
+    attribute :geo,                   GeoLocation
+    attribute :area,                  RealtyArea
+    attribute :room_count,            RealtyRoomCount
+    attribute :price,                 RealtyPrice
+    attribute :status_id,             Integer
+    attribute :floor,                 String
+    attribute :openimmo_id,           String
+    attribute :contact,               Employee
+    attribute :description_furniture, Array[String]
+    attribute :furniture,             Array[String]
+    attribute :images,                Array[Image]
+    attribute :documents,             Array
+    attribute :videos,                Array
+    attribute :images360,             Array
+    attribute :links,                 Array
+    attribute :available,             DateTime
+    attribute :created_at,            DateTime
+    attribute :updated_at,            DateTime
+
+    # @!group Instance Method Summary
+
+    def initialize(**options)
+      super(options)
+      @area       = RealtyArea.new
+      @room_count = RealtyRoomCount.new
+      @geo        = GeoLocation.new
+      @usage      = RealtyUsage.new
+      @marketing  = RealtyMarketing.new
+      @price      = RealtyPrice.new
+    end
+
+    # @param date [String]
+    # @return [String, DateTime]
+    def available=(date)
+      @available = DateTime.parse(date)
+    rescue ArgumentError
+      log.error("Failed to convert date: #{date}")
+      @available = date
+    end
+
+    def description=(desc)
+      @description =
+        if @teaser.empty?
+          parts = desc.partition("</ul>\n")
+          @teaser = parts[0..1].join
+          parts.last.empty? ? @teaser : parts.last
+        else
+          desc
+        end
+    end
+
+    def add_image(url, **options)
+      @images ||= []
+      image = Image.new
+      image.add_url(url, options)
+      @images << image
+    end
+
+    def type
+    end
+
+    def sub_type
+    end
+  end
+end

data/lib/justimmo_client/api/v1/models/realty_area.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  class RealtyArea < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :balcony_terrace, Float
+    attribute :balcony,         Float
+    attribute :office,          Float
+    attribute :garage,          Float
+    attribute :garden,          Float
+    attribute :total,           Float
+    attribute :surface,         Float
+    attribute :property,        Float
+    attribute :basement,        Float
+    attribute :storage,         Float
+    attribute :loggia,          Float
+    attribute :floor,           Float
+    attribute :parking,         Float
+    attribute :terrace,         Float
+    attribute :buildable,       Float
+    attribute :sales,           Float
+    attribute :living,          Float
+
+    # @!group Instance Method Summary
+
+    def to_f
+      living || floor
+    end
+
+    def to_s
+      to_f.to_s
+    end
+
+    def inspect
+      "#<#{self.class} #{self}>"
+    end
+
+    def each(&block)
+      attributes.each(&block)
+    end
+
+    def map(&block)
+      attributes.map(&block)
+    end
+  end
+end

data/lib/justimmo_client/api/v1/models/realty_category.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  class RealtyCategory < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :id,           Integer
+    attribute :name,         String
+    attribute :sortablerank, Boolean
+  end
+end

data/lib/justimmo_client/api/v1/models/realty_marketing.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  class RealtyMarketing < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :buy,  Boolean
+    attribute :rent, Boolean
+  end
+end

data/lib/justimmo_client/api/v1/models/realty_price.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "monetize"
+
+module JustimmoClient::V1
+  class RealtyPrice < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :currency,               Money::Currency
+    attribute :provision,              Boolean
+    attribute :including_vat,          Boolean
+    attribute :on_demand,              Boolean
+    attribute :real_estate_taxes,      Float
+    attribute :land_registry,          Float
+    attribute :commission,             Integer
+    attribute :purcase,                Money
+    attribute :purcase_net,            Money
+    attribute :rent_vat,               Integer
+    attribute :rent,                   Money
+    attribute :rent_net,               Money
+    attribute :rent_cold,              Money
+    attribute :rent_including_heating, Money
+    attribute :rent_per_sqm,           Money
+    attribute :deposit,                Money
+    attribute :operating_cost_vat,     Integer
+    attribute :operating_cost,         Money
+    attribute :operating_cost_net,     Money
+    attribute :operating_cost_per_sqm, Money
+
+    # @!group Instance Method Summary
+
+    %w[purcase purcase_net
+       operating_cost operating_cost_net operating_cost_per_sqm
+       rent rent_net rent_cold rent_including_heating rent_per_sqm deposit
+    ].each do |meth|
+      define_method("#{meth}=") do |amount|
+        log.debug("Using currency #{currency.name} for #{meth}")
+        instance_variable_set("@#{meth}", Monetize.parse(amount))
+      end
+    end
+
+    def on_demand?
+      return on_demand unless on_demand.nil?
+      return purcase.zero? unless purcase.nil?
+      return rent.zero? unless rent.nil?
+      true
+    end
+
+    def rent?
+      !rent.nil?
+    end
+
+    def purcase?
+      !purcase.nil?
+    end
+
+    def currency=(cur)
+      @currency = Money::Currency.new(cur)
+      Money.default_currency = @currency
+      log.debug("Set currency to #{currency.name}")
+    end
+
+    # FIXME: this needs some proper analysis of the input string
+    def commission=(text)
+      @commission = text.to_i
+    end
+
+    def commission
+      if purcase?
+        (get / 100 * @commission) * 1.20
+      else
+        (get * @commission) * 1.20
+      end
+    end
+
+    def rent_vat
+      rent_net / 100 * @rent_vat
+    end
+
+    def get
+      @purcase || @rent
+    end
+
+    def to_s
+      on_demand? ? "on demand" : "#{get} #{get.symbol}"
+    end
+
+    def inspect
+      "#<#{self.class} #{self}>"
+    end
+  end
+end

data/lib/justimmo_client/api/v1/models/realty_room_count.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  class RealtyRoomCount < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :store,           Integer
+    attribute :bathroom,        Integer
+    attribute :balcony_terrace, Integer
+    attribute :balcony,         Integer
+    attribute :garden,          Integer
+    attribute :garage,          Integer
+    attribute :loggia,          Integer
+    attribute :basement,        Integer
+    attribute :toilet,          Integer
+    attribute :parking_space,   Integer
+    attribute :total,           Integer
+
+    # @!group Instance Method Summary
+
+    def to_i
+      total
+    end
+
+    def to_s
+      to_i.to_s
+    end
+
+    def inspect
+      "#<#{self.class} #{self}>"
+    end
+  end
+end

data/lib/justimmo_client/api/v1/models/realty_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  class RealtyType < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :id,   Integer
+    attribute :name, String
+  end
+end

data/lib/justimmo_client/api/v1/models/realty_usage.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module JustimmoClient::V1
+  class RealtyUsage < JustimmoBase
+    # @!group Attributes
+
+    # @!method living?
+    #   @api private
+    #   @return [Boolean]
+
+    # @!method business?
+    #   @api private
+    #   @return [Boolean]
+
+    # @!method investment?
+    #   @api private
+    #   @return [Boolean]
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :living,     Boolean
+    attribute :business,   Boolean
+    attribute :investment, Boolean
+  end
+end

data/lib/justimmo_client/api/v1/models/region.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  class Region < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :id,   Integer
+    attribute :name, String
+  end
+end

data/lib/justimmo_client/api/v1/representers/json/attachment_image_representer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class AttachmentImageRepresenter < JustimmoRepresenter
+      property :small
+      property :small2
+      property :medium
+      property :medium2
+      property :big
+      property :big2
+      property :fullhd
+      property :path
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/json/attachment_representer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class AttachmentRepresenter < JustimmoRepresenter
+      property :category
+      property :origin
+      property :title
+      property :format
+      property :data,
+               decorator: AttachmentImageRepresenter,
+               class: AttachmentImage
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/json/contact_representer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class ContactRepresenter < JustimmoRepresenter
+      property :id
+      property :number
+      property :last_name
+      property :first_name
+      property :phone
+      property :phone_mobile
+      property :salutation
+      property :email
+      property :email_feedback
+      property :company
+      property :street
+      property :zip_code
+      property :location
+      property :website
+
+      property :picture,
+               decorator: AttachmentImageRepresenter,
+               class: AttachmentImage
+
+      property :attachment,
+               decorator: AttachmentRepresenter,
+               class: Attachment
+    end
+  end
+end

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

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

data/lib/justimmo_client/api/v1/representers/json/location_representer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class LocationRepresenter < JustimmoRepresenter
+      property :zip_code
+      property :location
+      property :federal_state
+      property :country
+      property :latitude
+      property :longitude
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class RealtyCategoryRepresenter < JustimmoRepresenter
+      property :usage, class: RealtyUsage do
+        property :living
+        property :business
+        property :investment
+      end
+
+      property :marketing, class: RealtyMarketing do
+        property :buy
+        property :rent
+      end
+
+      property :type_id
+      property :sub_type_id
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class RealtyDetailRepresenter < JustimmoRepresenter
+      property :category,
+               decorator: RealtyCategoryRepresenter,
+               class: RealtyCategory
+
+      property :location,
+               decorator: LocationRepresenter,
+               class: Location
+
+      property :contact,
+               decorator: ContactRepresenter,
+               class: Contact
+
+      property :documents
+      property :images360
+      property :videos
+      property :links
+
+      property :title
+      property :description
+      property :description_furniture
+      property :furniture
+
+      property :balcony_terrace_area, as: :balkon_terrasse_flaeche
+      property :balcony_area,         as: :balkons_flaeche
+      property :office_area,          as: :bueroflaeche
+      property :garage_area,          as: :garagen_flaeche
+      property :garden_area,          as: :gartenflaeche
+      property :total_area,           as: :gesamtflaeche
+      property :surface_area,         as: :grundflaeche
+      property :property_area,        as: :grundstueksflaeche
+      property :basement_area,        as: :kellerflaeche
+      property :storage_area,         as: :lagerflaeche
+      property :loggia_area,          as: :loggias_flaeche
+      property :floor_area,           as: :nutzflaeche
+      property :parking_area,         as: :stellplatz_flaeche
+      property :terrace_area,         as: :terrassen_flaeche
+      property :buildable_area,       as: :verbaubare_flaeche
+      property :sales_area,           as: :verkaufsflaeche
+      property :living_area,          as: :wohnflaeche
+      property :store_rooms,          as: :anzahl_abstellraum
+      property :bathrooms,            as: :anzahl_badezimmer
+      property :balconies_terraces,   as: :anzahl_balkon_terrassen
+      property :balconies,            as: :anzahl_balkone
+      property :balconies,            as: :anzahl_balkons
+      property :gardens,              as: :anzahl_garten
+      property :garages,              as: :anzahl_garagen
+      property :loggias,              as: :anzahl_loggias
+      property :basements,            as: :anzahl_keller
+      property :toilet_rooms,         as: :anzahl_sep_wc
+      property :parking_spaces,       as: :anzahl_stellplaetze
+      property :rooms,                as: :anzahl_zimmer
+
+      property :available_from
+      property :status_id
+      property :id
+      property :number
+      property :openimmo_id
+
+      collection :attachments,
+                 decorator: AttachmentRepresenter,
+                 class: Attachment
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  # @api private
+  module JSON
+    extend JustimmoClient::Utils
+
+    autoload_dir "#{__dir__}/json/*_representer.rb"
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class CityRepresenter < JustimmoRepresenter
+      self.representation_wrap = :postleitzahl
+
+      property :id
+      property :country_id, as: :landid
+      property :region_id, as: :regionid
+      property :zip_code, as: :plz
+      property :location, as: :ort
+      property :federal_state_id, as: :bundeslandid
+
+      collection_representer class: City
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class ContactRepresenter < EmployeeRepresenter
+      property :email_feedback
+      property :email, as: :email_direkt
+      property :last_name, as: :name
+      property :company, as: :firma
+      property :salutation, as: :anrede
+      property :phone, as: :tel_zentrale
+      property :mobile, as: :tel_handy
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class CountryRepresenter < JustimmoRepresenter
+      self.representation_wrap = :land
+
+      property :id
+      property :alpha2, as: :iso2
+      property :alpha3, as: :iso3
+
+      collection_representer class: Country
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class EmployeeListRepresenter < JustimmoRepresenter
+      nested :kategorie do
+        collection :employees,
+          as: :mitarbeiter,
+          wraps: :mitarbeiter,
+          class: Employee,
+          decorator: EmployeeRepresenter
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class EmployeeRepresenter < JustimmoRepresenter
+      property :id
+      property :number,       as: :personennummer
+      property :first_name,   as: :vorname
+      property :last_name,    as: :nachname
+      property :salutation,   as: :titel
+      property :position
+      property :phone,        as: :tel
+      property :mobile,       as: :handy
+      property :fax
+      property :email
+      property :street,       as: :strasse
+      property :zip_code,     as: :plz
+      property :location,     as: :ort
+      property :website,      as: :url
+
+      property :picture,
+        as: :bild,
+        class: Image do
+          %i[small medium big pfad_medium].each do |size|
+            property size, setter: ->(represented:, fragment:, **) { represented.add_url(fragment, default: :user_big) }
+          end
+        end
+
+      # NOTE: Just contains the picture again
+      #       Comment it out for now in case we still need it later.
+      #
+      # nested :user_defined_anyfield do
+      #   property :attachment,
+      #     as: :anhang,
+      #     class: Image do
+      #       property :category, as: :gruppe, attribute: true
+      #       property :origin, as: :location, attribute: true
+      #       property :title, as: :anhangtitel
+      #       nested :daten do
+      #         property :path, as: :pfad, setter: ->(represented:, fragment:, **) { represented.add_url(fragment, default: :user_big) }
+      #       end
+      #     end
+      # end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module XML
+    class FederalStateRepresenter < JustimmoRepresenter
+      self.representation_wrap = :bundesland
+
+      property :id
+      property :name
+      property :country_id, as: :landid
+      property :fips, as: :fipscode
+      property :iso, as: :iso31662code
+
+      collection_representer class: FederalState
+    end
+  end
+end