immoscout 1.0.0

data/lib/immoscout/models/actions/real_estate.rb

@@ -0,0 +1,122 @@
+require 'json'
+require_relative '../concerns/modelable'
+
+module Immoscout
+  module Models
+    module Actions
+      module RealEstate
+        extend ActiveSupport::Concern
+
+        included do
+          include Immoscout::Models::Concerns::Modelable
+
+          self.unpack_collection = proc do |hash|
+            hash
+              .fetch("realestates.realEstates", {})
+              .fetch("realEstateList", {})
+              .fetch("realEstateElement", nil)
+          end
+
+          def save
+            response = \
+              if id
+                api.put("user/#{api.user_name}/realestate/#{id}", as_json)
+              else
+                api.post("user/#{api.user_name}/realestate", as_json)
+              end
+
+            handle_response(response)
+            self.id = id_from_response(response) unless id
+            self
+          end
+
+          def destroy
+            response = api.delete("user/#{api.user_name}/realestate/#{id}")
+            handle_response(response)
+            self
+          end
+
+          def publish(channel = 10_000)
+            publisher = Immoscout::Models::Publish.new(
+              real_estate: { id: id },
+              publish_channel: { id: channel }
+            )
+            publisher.save
+            publisher
+          end
+
+          def unpublish(channel = 10_000)
+            publisher = Immoscout::Models::Publish.new(
+              real_estate: { id: id },
+              publish_channel: { id: channel }
+            )
+            publisher.destroy
+            publisher
+          end
+
+          def place(type)
+            check_placement_type(type)
+            response = api.post(
+              "user/#{api.user_name}/realestate/#{id}/#{type}"
+            )
+            handle_response(response)
+            self
+          end
+
+          def unplace(type)
+            check_placement_type(type)
+            response = api.delete(
+              "user/#{api.user_name}/realestate/#{id}/#{type}"
+            )
+            handle_response(response)
+            self
+          end
+
+          private
+
+          def check_placement_type(type)
+            raise ArgumentError, "Unknown placement type '#{type}'" unless %w[
+              topplacement premiumplacement showcaseplacement
+            ].include?(type.to_s)
+          end
+        end
+
+        class_methods do
+          def find(id)
+            response = api.get("user/#{api.user_name}/realestate/#{id}")
+            handle_response(response)
+            from_raw(response.body)
+          end
+
+          def find_by(hash)
+            external_id = hash.symbolize_keys.fetch(:external_id)
+            find("ext-#{external_id}")
+          end
+
+          def all
+            response = api.get("user/#{api.user_name}/realestate")
+            handle_response(response)
+            objects = unpack_collection.call(response.body)
+            objects
+              .map { |object| new(object) }
+              .select { |object| object.type =~ /#{name.demodulize}/i }
+          end
+
+          def first
+            all.first
+          end
+
+          def last
+            all.last
+          end
+
+          def create(hash)
+            instance = new(hash)
+            instance.save
+            instance
+          end
+        end
+      end
+    end
+  end
+end

data/lib/immoscout/models/apartment_buy.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative 'concerns/renderable'
+require_relative 'concerns/propertiable'
+require_relative 'actions/real_estate'
+require_relative 'parts/api_search_data'
+require_relative 'parts/address'
+require_relative 'parts/contact'
+require_relative 'parts/price'
+require_relative 'parts/courtage'
+require_relative 'parts/energy_source'
+
+module Immoscout
+  module Models
+    class ApartmentBuy < Base
+      include Immoscout::Models::Concerns::Renderable
+      include Immoscout::Models::Concerns::Propertiable
+      include Immoscout::Models::Actions::RealEstate
+
+      self.json_wrapper = "realestates.apartmentBuy"
+
+      property :id, alias: :@id
+      property :external_id
+      property :title
+      property :creation_date
+      property :last_modification_date
+      property :type, alias: :'@xsi.type'
+      property :href, alias: :'@xlink.href'
+      property :publish_date, alias: :@publish_date
+      property :creation, alias: :@creation
+      property :modification, alias: :@modification
+      property :group_number
+      property :real_estate_project_id
+      property :address, coerce: Immoscout::Models::Parts::Address
+      property :api_search_data, coerce: Immoscout::Models::Parts::ApiSearchData
+      property :real_estate_state
+      property :description_note
+      property :furnishing_note
+      property :location_note
+      property :other_note
+      property :show_address
+      property :contact, coerce: Immoscout::Models::Parts::Contact
+      property :apartment_type
+      property :price, coerce: Immoscout::Models::Parts::Price
+      property :courtage, coerce: Immoscout::Models::Parts::Courtage
+      property :energy_sources_enev2014,
+               coerce: Immoscout::Models::Parts::EnergySource
+      property :energy_certificate,
+               coerce: Immoscout::Models::Parts::EnergyCertificate
+      property :firing_types,
+               coerce: Immoscout::Models::Parts::FiringType, array: true
+      property :cellar
+      property :handicapped_accessible
+      property :number_of_parking_spaces
+      property :condition
+      property :last_refurbishment
+      property :interior_quality
+      property :construction_year
+      property :free_from
+      property :heating_type
+      property :heating_type_enev2014
+      property :building_energy_rating_type
+      property :thermal_characteristic
+      property :energy_consumption_contains_warm_water
+      property :number_of_floors
+      property :usable_floor_space
+      property :number_of_bed_rooms
+      property :number_of_bath_rooms
+      property :guest_toilet
+      property :parking_space_type
+      property :rented
+      property :rental_income
+      property :listed
+      property :parking_space_price
+      property :summer_residence_practical
+      property :living_space
+      property :number_of_rooms
+      property :energy_performance_certificate
+      # apartment specific properties
+      property :floor
+      property :lift
+      property :assisted_living
+      property :built_in_kitchen
+      property :balcony
+      property :certificate_of_eligibility_needed
+      property :garden
+      property :service_charge
+    end
+  end
+end

data/lib/immoscout/models/base.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Immoscout
+  module Models
+    class Base
+      attr_reader :base
+
+      def initialize(hash = {})
+        define_singleton_method(:base) { hash }
+        set_properties
+      end
+
+      private
+
+      def prepared_hash
+        base
+          .deep_stringify_keys
+          .deep_transform_keys(&:underscore)
+          .deep_symbolize_keys
+      end
+
+      def set_properties
+        prepared_hash.each do |key, value|
+          property = self.class.find_property(key)
+          unless property
+            # TODO: add optional logger
+            # puts "#{self.class.name} - missing property '#{key}'"
+            next
+          end
+          set_property(property, key, value)
+        end
+      end
+
+      def set_property(property, key, value)
+        coerce_klass = property.fetch(:coerce, nil)
+        if coerce_klass
+          if property.fetch(:array, false)
+            send("#{key}=", value.map { |elem| coerce_klass.new(elem) })
+          else
+            send("#{key}=", coerce_klass.new(value))
+          end
+        else
+          send("#{key}=", value)
+        end
+      end
+    end
+  end
+end

data/lib/immoscout/models/concerns/modelable.rb

@@ -0,0 +1,55 @@
+require 'json'
+
+module Immoscout
+  module Models
+    module Concerns
+      module Modelable
+        extend ActiveSupport::Concern
+
+        included do
+          cattr_accessor :json_wrapper, :unpack_collection
+          cattr_reader :api, instance_accessor: false do
+            Immoscout::Api::Client.instance
+          end
+
+          def api
+            self.class.api
+          end
+
+          def handle_response(response)
+            self.class.handle_response(response)
+          end
+
+          def id_from_response(response)
+            self.class.id_from_response(response)
+          end
+        end
+
+        class_methods do
+          def unpack(hash)
+            hash.values.first
+          end
+
+          def from_raw(raw_hash)
+            hash = raw_hash.is_a?(String) ? JSON.parse(raw_hash) : raw_hash
+            new(unpack(hash))
+          end
+
+          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")
+              .first
+              .fetch("message", {})
+              .fetch("id", nil)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/immoscout/models/concerns/propertiable.rb

@@ -0,0 +1,56 @@
+module Immoscout
+  module Models
+    module Concerns
+      module Propertiable
+        extend ActiveSupport::Concern
+
+        included do
+          cattr_reader :properties, instance_accessor: false do
+            {}
+          end
+
+          # :reek:ControlParameter - standard stuff, reek!
+          # :reek:TooManyStatements
+          def method_missing(method_name, *arguments, &block)
+            if method_name =~ /build\_(\w+)/
+              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
+              send("#{match}=", coerce_klass.new)
+            else
+              super
+            end
+          end
+
+          def attributes
+            self.class.properties.keys.sort
+          end
+
+          # :reek:BooleanParameter - standard stuff, reek!
+          def respond_to_missing?(method_name, include_private = false)
+            method_name.to_s.start_with?('build_') || super
+          end
+        end
+
+        class_methods do
+          def property(name, **opts)
+            attr_accessor(name)
+            alias_name = opts.fetch(:alias, false)
+            if alias_name
+              alias_method alias_name, name
+              alias_method "#{opts.fetch(:alias)}=", "#{name}="
+            end
+            properties[name] = opts
+          end
+
+          def find_property(name)
+            properties[name] || properties.values.detect do |value|
+              value[:alias] == name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/immoscout/models/concerns/renderable.rb

@@ -0,0 +1,63 @@
+require 'json'
+
+module Immoscout
+  module Models
+    module Concerns
+      module Renderable
+        extend ActiveSupport::Concern
+
+        included do
+          def as_json
+            wrapped? ? to_json_wrapped : to_json_unwrapped
+          end
+
+          def to_json
+            as_json.to_json
+          end
+          alias_method :to_s, :to_json
+
+          private
+
+          def wrapped?
+            self.class.try(:json_wrapper)
+          end
+
+          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
+              rendered = send(key) || value.fetch(:default, nil)
+              memo[property] = \
+                if rendered.is_a?(Array)
+                  rendered.map do |elem|
+                    elem.try(:as_json) || elem
+                  end
+                else
+                  rendered.try(:as_json) || rendered
+                end
+              memo
+            end
+          end
+
+          def to_json_wrapped
+            { self.class.try(:json_wrapper) => to_json_unwrapped }
+          end
+
+          def to_json_unwrapped
+            to_h
+              .compact
+              .stringify_keys
+              .deep_transform_keys { |key| key.camelize :lower }
+          end
+        end
+
+        class_methods do
+        end
+      end
+    end
+  end
+end

data/lib/immoscout/models/contact.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative 'concerns/renderable'
+require_relative 'concerns/propertiable'
+require_relative 'actions/contact'
+require_relative 'parts/address'
+
+module Immoscout
+  module Models
+    class Contact < Base
+      include Immoscout::Models::Concerns::Renderable
+      include Immoscout::Models::Concerns::Propertiable
+      include Immoscout::Models::Actions::Contact
+
+      self.json_wrapper = "common.realtorContactDetail"
+
+      property :id, alias: :@id
+      property :email
+      property :salutation
+      property :firstname
+      property :lastname
+      property :fax_number
+      property :fax_number_country_code,
+               readonly: proc { |contact| contact.fax_number.present? }
+      property :fax_number_area_code,
+               readonly: proc { |contact| contact.fax_number.present? }
+      property :fax_number_subscriber,
+               readonly: proc { |contact| contact.fax_number.present? }
+      property :phone_number
+      property :phone_number_country_code,
+               readonly: proc { |contact| contact.phone_number.present? }
+      property :phone_number_area_code,
+               readonly: proc { |contact| contact.phone_number.present? }
+      property :phone_number_subscriber,
+               readonly: proc { |contact| contact.phone_number.present? }
+      property :cell_phone_number
+      property :cell_phone_number_country_code,
+               readonly: proc { |contact| contact.cell_phone_number.present? }
+      property :cell_phone_number_area_code,
+               readonly: proc { |contact| contact.cell_phone_number.present? }
+      property :cell_phone_number_subscriber,
+               readonly: proc { |contact| contact.cell_phone_number.present? }
+      property :address, coerce: Immoscout::Models::Parts::Address
+      property :country_code
+      property :title
+      property :addition_name
+      property :company
+      property :homepage_url
+      property :position
+      property :office_hours
+      property :default_contact
+      property :local_partner_contact
+      property :business_card_contact
+      property :real_estate_reference_count
+      property :external_id
+      property :show_on_profile_page
+    end
+  end
+end