justimmo_client 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca35fda69d2b9c35d6dfa8b7f79b10eb129a2ed7
-  data.tar.gz: b36be58f5d1c265e62ad4bf35664221797df362b
+  metadata.gz: 1111c8bd67a8a48f624bc368fe44db21199b6e1a
+  data.tar.gz: 6d8c62a4cc9e2373ae2ff999b446027ed05998b4
 SHA512:
-  metadata.gz: d16797d4e4d26181d2f4eef09e72df50246a14f1325a9a5a2fdd49bb9a437e050f5ec4648617d62827ffedff06b5b772573cdbe672601d543ac48dc27673dcd0
-  data.tar.gz: 3f80eb73170d6e615dc6a212b5207982e3f9137cba36bf7a8ae7d3bf8ffccde929b80c1ab1bac46a0ce571899af3d841c5f128a3c609fce82e1f149193a61220
+  metadata.gz: 66da6c40804b2acdf9580898fdeccec4dcc0fc04ef4c1b5829754748a8f12d05126609981c1ccd61ad835187eb7e1f1d4a6d945289f284de6c52994e9eddef55
+  data.tar.gz: 19f6be67d186e5e7a4dd3ec56854f6556669624beb53bdb23b9e16cf8ce5745de506c61035d4efc2b6cdf9c5c3b8f6e04f8edfcdf1db0b1fdfb7630e3e29163f

data/.gitlab-ci.yml

@@ -69,8 +69,8 @@ test:rubocop:
   <<: *ruby_2_4
   script:
     - bundle exec rubocop
-  only:
-    - dev
+  except:
+    - master
   tags:
     - ruby
 

data/README.md

@@ -1,9 +1,8 @@
-[![build status](https://gitlab.com/exacting/justimmo-client-ruby/badges/master/build.svg)](https://gitlab.com/exacting/justimmo-client-ruby/pipelines)
-[![coverage report](https://gitlab.com/exacting/justimmo-client-ruby/badges/master/coverage.svg)](https://valeth.gitlab.io/justimmo-client-ruby)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7cfe6c9965214c439470cc0a480e0e49)](https://www.codacy.com/app/exacting/justimmo-client-ruby?utm_source=gitlab.com&utm_medium=referral&utm_content=exacting/justimmo-client-ruby&utm_campaign=Badge_Grade)
+[![pipeline status](https://gitlab.com/exacting/justimmo_client/badges/master/pipeline.svg)](https://gitlab.com/exacting/justimmo_client/commits/master)
+[![coverage report](https://gitlab.com/exacting/justimmo_client/badges/master/coverage.svg)](https://exacting.gitlab.io/justimmo_client)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d3b88fedb58d44048a527234f3541430)](https://www.codacy.com/app/Exacting/justimmo_client?utm_source=gitlab.com&utm_medium=referral&utm_content=exacting/justimmo_client&utm_campaign=Badge_Grade)
 [![Inline docs](http://inch-ci.org/github/exacting/justimmo-client-ruby.svg?branch=master)](http://inch-ci.org/github/exacting/justimmo-client-ruby)
 
-
 # Justimmo Client
 
 Ruby client for the [Justimmo](http://www.justimmo.at) [REST API](http://api-docs.justimmo.at/api/index.html).
@@ -46,7 +45,7 @@ end
 ```ruby
 class RealtyController < ApplicationController
   def index
-    @realties = JustimmoClient::Realty.list(zip_code: 6020, limit: 5)
+    @realties = JustimmoClient.realties(zip_code: 6020, limit: 5)
   end
 end
 ```

data/examples/client.rb

@@ -13,4 +13,4 @@ JustimmoClient.configure do |config|
   config.cache    = ActiveSupport::Cache.lookup_store(:memory_store)
 end
 
-pp JustimmoClient::Realty.list(zip_code: 6800, limit: 5)
+pp JustimmoClient.realties(zip_code: 6800, limit: 5)

data/lib/justimmo_client/api/v1/interfaces/employee_interface.rb

@@ -4,31 +4,53 @@ module JustimmoClient::V1
   # Public employee query interface
   module EmployeeInterface
     extend JustimmoClient::Utils
+    extend JustimmoInterface
 
     module_function
 
     # @return [Array<Employee>]
     def list
-      xml_response = request(:employee).list
-      model = Struct.new(:employees).new
-      representer(:employee_list).new(model).from_xml(xml_response).employees
+      with_cache cache_key("employee/list"),
+        on_hit: ->(cached) do
+          representer(:employee, :json).for_collection.new([]).from_json(cached)
+        end,
+        on_miss: -> do
+          xml_response = request(:employee).list
+          model = Struct.new(:employees).new
+          represented = representer(:employee_list).new(model).from_xml(xml_response).employees
+          new_cache = representer(:employee, :json).for_collection.new(represented).to_json
+          [represented, new_cache]
+        end
     rescue JustimmoClient::RetrievalFailed
       []
     end
 
     # @return [Employee]
     def detail(id)
-      xml_response = request(:employee).detail(id)
-      model = model(:employee).new
-      representer(:employee).new(model).from_xml(xml_response)
+      with_cache cache_key("employee/detail", id: id),
+        on_hit: ->(cached) do
+          representer(:employee, :json).new(model(:employee).new).from_json(cached)
+        end,
+        on_miss: -> do
+          xml_response = request(:employee).detail(id)
+          model = model(:employee).new
+          represented = representer(:employee).new(model).from_xml(xml_response)
+          new_cache = representer(:employee, :json).new(represented).to_json
+          [represented, new_cache]
+        end
     rescue JustimmoClient::RetrievalFailed
       nil
     end
 
     # @return [Array<Integer>]
     def ids
-      json_response = request(:employee).ids
-      ::JSON.parse(json_response).map(&:to_i)
+      with_cache cache_key("employee/ids"),
+        on_hit: ->(cached) { ::JSON.parse(cached) },
+        on_miss: -> do
+          json_response = request(:employee).ids
+          json_parsed = ::JSON.parse(json_response).map(&:to_i)
+          [json_parsed, ::JSON.generate(json_parsed)]
+        end
     rescue JustimmoClient::RetrievalFailed
       []
     end

data/lib/justimmo_client/api/v1/interfaces/justimmo_interface.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JustimmoInterface
+    include JustimmoClient::Caching
+    include JustimmoClient::Logging
+
+    def cache_key(endpoint, params = {})
+      key = Digest::SHA256.new
+      key << endpoint
+      key << params.to_s
+      key.hexdigest
+    end
+
+    def with_cache(key, on_hit:, on_miss:, **options)
+      log.debug("Looking up cache key #{key}")
+      data = nil
+      cached = cache.read(key)
+
+      if cached.nil?
+        log.debug("Cache miss for #{key}")
+        data, new_cache = on_miss.call()
+        cache.write(key, new_cache, options)
+      else
+        log.debug("Cache hit for #{key}")
+        data = on_hit.call(cached)
+      end
+
+      data
+    end
+  end
+end

data/lib/justimmo_client/api/v1/interfaces/realty_interface.rb

@@ -4,8 +4,12 @@ require "json"
 
 module JustimmoClient::V1
   # Public realty query interface
+  #
+  # Glues all components together.
+  # Handles caching, parsing and converting XML and JSON into data models.
   module RealtyInterface
     extend JustimmoClient::Utils
+    extend JustimmoInterface
 
     module_function
 
@@ -55,9 +59,17 @@ module JustimmoClient::V1
     # @option options [String] :location
     # @return [Array<Realty>] An array of basic realty objects, or an empty array on error.
     def list(options = {})
-      xml_response = request(:realty).list(options)
-      model = Struct.new(:realties).new
-      representer(:realty_list).new(model).from_xml(xml_response).realties
+      with_cache cache_key("realty/list", options),
+        on_hit: ->(cached) do
+          representer(:realty, :json).for_collection.new([]).from_json(cached)
+        end,
+        on_miss: -> do
+          model = Struct.new(:realties).new
+          xml_response = request(:realty).list(options)
+          represented = representer(:realty_list).new(model).from_xml(xml_response).realties
+          new_cache = representer(:realty, :json).for_collection.new(realties).to_json
+          [represented, new_cache]
+        end
     rescue JustimmoClient::RetrievalFailed
       []
     end
@@ -66,9 +78,17 @@ module JustimmoClient::V1
     # @param [Symbol, String] lang
     # @return [Realty, nil] A detailed realty object, or nil if it could not be found.
     def detail(id, lang: nil)
-      xml_response = request(:realty).detail(id, lang: lang)
-      model = Struct.new(:realty).new
-      representer(:realty_detail).new(model).from_xml(xml_response).realty
+      with_cache cache_key("realty/detail", options),
+        on_hit: ->(cached) do
+          representer(:realty, :json).new(model(:realty)).from_json(cached)
+        end,
+        on_miss: -> do
+          xml_response = request(:realty).detail(id, lang: lang)
+          model = Struct.new(:realty).new
+          represented = representer(:realty_detail).new(model).from_xml(xml_response).realty
+          new_cache = representer(:realty, :json).new(realty).to_json
+          [represented, new_cache]
+        end
     rescue JustimmoClient::RetrievalFailed
       nil
     end
@@ -82,8 +102,13 @@ module JustimmoClient::V1
     # @option (see list)
     # @return [Array<Integer>] An array of realty ids, empty array if no results.
     def ids(options = {})
-      json_response = request(:realty).ids(options)
-      ::JSON.parse(json_response).map(&:to_i)
+      with_cache cache_key("realty/ids", options),
+        on_hit: ->(cached) { ::JSON.parse(cached) },
+        on_miss: -> do
+          json_response = request(:realty).ids(options)
+          json_parsed = ::JSON.parse(json_response).map(&:to_i)
+          [json_parsed, ::JSON.generate(json_parsed)]
+        end
     rescue JustimmoClient::RetrievalFailed
       []
     end
@@ -91,8 +116,16 @@ module JustimmoClient::V1
     # @option options [Boolean] :all (false)
     # @return [Array<RealtyCategory>]
     def categories(options = {})
-      xml_response = request(:realty).categories(options)
-      representer(:realty_category).for_collection.new([]).from_xml(xml_response)
+      with_cache cache_key("realty/categories", options),
+        on_hit: ->(cached) do
+          representer(:realty_category, :json).for_collection.new([]).from_json(cached)
+        end,
+        on_miss: -> do
+          xml_response = request(:realty).categories(options)
+          represented = representer(:realty_category).for_collection.new([]).from_xml(xml_response)
+          new_cache = representer(:realty_category, :json).for_collection.new(represented).to_json
+          [represented, new_cache]
+        end
     rescue JustimmoClient::RetrievalFailed
       []
     end
@@ -100,8 +133,16 @@ module JustimmoClient::V1
     # @option options [Boolean] :all (false)
     # @return [Array<RealtyType>]
     def types(options = {})
-      xml_response = request(:realty).types(options)
-      representer(:realty_type).for_collection.new([]).from_xml(xml_response)
+      with_cache cache_key("realty/types", options),
+        on_hit: ->(cached) do
+          representer(:realty_type, :json).for_collection.new([]).from_json(cached)
+        end,
+        on_miss: -> do
+          xml_response = request(:realty).types(options)
+          represented = representer(:realty_type).for_collection.new([]).from_xml(xml_response)
+          new_cache = representer(:realty_type, :json).for_collection.new(represented).to_json
+          [represented, new_cache]
+        end
     rescue JustimmoClient::RetrievalFailed
       []
     end
@@ -109,8 +150,16 @@ module JustimmoClient::V1
     # @option options [Boolean] :all (false)
     # @return [Array<Country>]
     def countries(options = {})
-      xml_response = request(:realty).countries(options)
-      representer(:country).for_collection.new([]).from_xml(xml_response)
+      with_cache cache_key("realty/countries", options),
+        on_hit: ->(cached) do
+          representer(:country, :json).for_collection.new([]).from_json(cached)
+        end,
+        on_miss: -> do
+          xml_response = request(:realty).countries(options)
+          represented = representer(:country).for_collection.new([]).from_xml(xml_response)
+          new_cache = representer(:country, :json).for_collection.new(represented).to_json
+          [represented, new_cache]
+        end
     rescue JustimmoClient::RetrievalFailed
       []
     end
@@ -119,8 +168,16 @@ module JustimmoClient::V1
     # @option options [Integer] :country (nil)
     # @return [Array<FederalState>]
     def federal_states(options = {})
-      xml_response = request(:realty).federal_states(options)
-      representer(:federal_state).for_collection.new([]).from_xml(xml_response)
+      with_cache cache_key("realty/federal_states", options),
+        on_hit: ->(cached) do
+          representer(:federal_states, :json).for_collection.new([]).from_json(cached)
+        end,
+        on_miss: -> do
+          xml_response = request(:realty).federal_states(options)
+          represented = representer(:federal_state).for_collection.new([]).from_xml(xml_response)
+          new_cache = representer(:federal_state, :json).for_collection.new(represented).to_json
+          [represented, new_cache]
+        end
     rescue JustimmoClient::RetrievalFailed
       []
     end
@@ -130,8 +187,16 @@ module JustimmoClient::V1
     # @option options [Integer] :federal_state (nil)
     # @return [Array<Region>]
     def regions(options = {})
-      xml_response = request(:realty).regions(options)
-      representer(:region).for_collection.new([]).from_xml(xml_response)
+      with_cache cache_key("realty/regions", options),
+        on_hit: ->(cached) do
+          representer(:region, :json).for_collection.new([]).from_json(cached)
+        end,
+        on_miss: -> do
+          xml_response = request(:realty).regions(options)
+          represented = representer(:region).for_collection.new([]).from_xml(xml_response)
+          new_cache = representer(:region, :json).for_collection.new(represented).to_json
+          [represented, new_cache]
+        end
     rescue JustimmoClient::RetrievalFailed
       []
     end
@@ -141,8 +206,16 @@ module JustimmoClient::V1
     # @option options [Integer] :federal_state (nil)
     # @return [Array<City>]
     def zip_codes_and_cities(options = {})
-      xml_response = request(:realty).zip_codes_and_cities(options)
-      representer(:city).for_collection.new([]).from_xml(xml_response)
+      with_cache cache_key("realty/cities", options),
+        on_hit: ->(cached) do
+          representer(:city, :json).for_collection.new([]).from_json(cached)
+        end,
+        on_miss: -> do
+          xml_response = request(:realty).zip_codes_and_cities(options)
+          represented = representer(:city).for_collection.new([]).from_xml(xml_response)
+          new_cache = representer(:city, :json).for_collection.new(represented).to_json
+          [represented, new_cache]
+        end
     rescue JustimmoClient::RetrievalFailed
       []
     end

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

@@ -10,7 +10,7 @@ module JustimmoClient::V1
     #   @return [$2]
     attribute :id,     Integer
     attribute :alpha2, String
-    attribute :alpha2, String
+    attribute :alpha3, String
 
     # @!group Instance Method Summary
 

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

@@ -10,7 +10,7 @@ module JustimmoClient::V1
     #   @return [$2]
     attribute :proximity,     String
     attribute :federal_state, String
-    attribute :country,       IsoCountryCodes::Code
+    attribute :country,       String
     attribute :zip_code,      Integer
     attribute :latitude,      Float
     attribute :longitude,     Float
@@ -20,8 +20,10 @@ module JustimmoClient::V1
 
     # @!group Instance Method Summary
 
-    def country=(iso3)
-      @country = IsoCountryCodes.find(iso3)
+    def country=(iso3_or_name)
+      @country = IsoCountryCodes.find(iso3_or_name).name
+    rescue IsoCountryCodes::UnknownCodeError
+      @country = iso3_or_name
     end
 
     def floor=(flr)

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

@@ -50,7 +50,7 @@ module JustimmoClient::V1
     # @param date [String]
     # @return [String, DateTime]
     def available=(date)
-      @available = DateTime.parse(date)
+      @available = DateTime.parse(date) unless date.nil?
     rescue ArgumentError
       log.error("Failed to convert date: #{date}")
       @available = date

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

@@ -36,7 +36,7 @@ module JustimmoClient::V1
        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}")
+        # log.debug("Using currency #{currency.name} for #{meth}")
         instance_variable_set("@#{meth}", Monetize.parse(amount))
       end
     end
@@ -57,6 +57,7 @@ module JustimmoClient::V1
     end
 
     def currency=(cur)
+      return if cur.nil?
       @currency = Money::Currency.new(cur)
       Money.default_currency = @currency
       log.debug("Set currency to #{currency.name}")

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

@@ -40,7 +40,7 @@ module JustimmoClient::V1
     end
 
     def to_s
-      map_translated.join(", ")
+      translated.join(", ")
     end
   end
 end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class CityRepresenter < JustimmoRepresenter
+      property :id
+      property :country_id
+      property :region_id
+      property :zip_code
+      property :location
+      property :federal_state_id
+
+      collection_representer class: City
+    end
+  end
+end

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

@@ -2,29 +2,14 @@
 
 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
+    class ContactRepresenter < EmployeeRepresenter
       property :email_feedback
+      property :email
+      property :last_name
       property :company
-      property :street
-      property :zip_code
-      property :location
-      property :website
-
-      property :picture,
-               decorator: AttachmentImageRepresenter,
-               class: AttachmentImage
-
-      property :attachment,
-               decorator: AttachmentRepresenter,
-               class: Attachment
+      property :salutation
+      property :phone
+      property :mobile
     end
   end
 end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class CountryRepresenter < JustimmoRepresenter
+      property :id
+      property :alpha2
+      property :alpha3
+
+      collection_representer class: Country
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class EmployeeRepresenter < JustimmoRepresenter
+      property :id
+      property :number
+      property :first_name
+      property :last_name
+      property :salutation
+      property :position
+      property :phone
+      property :mobile
+      property :fax
+      property :email
+      property :street
+      property :zip_code
+      property :location
+      property :website
+
+      property :picture, class: Image do
+        %i[small medium big pfad_medium].each do |size|
+          property size,
+            setter: ->(represented:, fragment:, **) { represented.add_url(fragment, default: :user_big) },
+            getter: ->(represented:, **) { represented[size] }
+        end
+      end
+
+      collection_representer class: Employee
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class FederalStateRepresenter < JustimmoRepresenter
+      property :id
+      property :name
+      property :country_id
+      property :fips
+      property :iso
+
+      collection_representer class: FederalState
+    end
+  end
+end

data/lib/justimmo_client/api/v1/representers/json/{location_representer.rb → geo_location_representer.rb}

@@ -2,10 +2,11 @@
 
 module JustimmoClient::V1
   module JSON
-    class LocationRepresenter < JustimmoRepresenter
+    class GeoLocationRepresenter < JustimmoRepresenter
       property :zip_code
       property :location
       property :federal_state
+      property :floor
       property :country
       property :latitude
       property :longitude

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class RealtyAreaRepresenter < JustimmoRepresenter
+      %i[
+        balcony_terrace
+        balcony
+        office
+        garage
+        garden
+        total
+        surface
+        property
+        basement
+        storage
+        loggia
+        floor
+        parking
+        terrace
+        buildable
+        sales
+        living
+      ].each { |k| property k }
+    end
+  end
+end

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

@@ -3,19 +3,11 @@
 module JustimmoClient::V1
   module JSON
     class RealtyCategoryRepresenter < JustimmoRepresenter
-      property :usage, class: RealtyUsage do
-        property :living
-        property :business
-        property :investment
-      end
+      property :id
+      property :name
+      property :sortablerank
 
-      property :marketing, class: RealtyMarketing do
-        property :buy
-        property :rent
-      end
-
-      property :type_id
-      property :sub_type_id
+      collection_representer class: RealtyCategory
     end
   end
 end

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

@@ -0,0 +1,31 @@
+module JustimmoClient::V1
+  module JSON
+    class RealtyPriceRepresenter < JustimmoRepresenter
+      property :currency
+      property :purcase
+      property :purcase_net
+      property :on_demand
+
+      property :rent
+      property :rent_net
+      property :rent_vat
+
+      property :deposit
+      property :rent_cold
+      property :rent_including_heating
+      property :rent_per_sqm
+      property :operating_cost_per_sqm
+
+      property :provision
+      property :including_vat
+      property :commission
+
+      property :real_estate_taxes
+      property :land_registry
+
+      property :operating_cost
+      property :operating_cost_net
+      property :operating_cost_vat
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class RealtyRepresenter < 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
+
+      property :id
+      property :number
+      property :created_at
+      property :updated_at
+      property :status_id
+      property :title
+      property :teaser
+      property :description
+      property :floor
+      property :area,
+               decorator: RealtyAreaRepresenter,
+               class: RealtyArea
+      property :geo,
+        decorator: GeoLocationRepresenter,
+        class: GeoLocation
+      property :room_count,
+        decorator: RealtyRoomCountRepresenter,
+        class: RealtyRoomCount
+
+      property :openimmo_id
+      property :available
+      property :construction_year
+      property :contact,
+               decorator: ContactRepresenter,
+               class: Employee
+      property :description_furniture
+      property :furniture
+      property :price,
+        decorator: RealtyPriceRepresenter,
+        class: RealtyPrice
+      collection :images, class: Image do
+        property :category
+        property :origin
+        property :title
+        %i[pfad small medium big2 medium2 s220x155 fullhd].each do |size|
+          property size,
+            setter: ->(represented:, fragment:, **) { represented.add_url(fragment, default: :big) },
+            getter: ->(represented:, **) { represented[size] }
+        end
+      end
+      property :documents
+      property :images360
+      property :videos
+      property :links
+
+      collection_representer class: Realty
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class RealtyRoomCountRepresenter < JustimmoRepresenter
+      %i[
+        store
+        bathroom
+        balcony_terrace
+        balcony
+        garden
+        garage
+        loggia
+        basement
+        toilet
+        parking_space
+        total
+      ].each { |k| property k }
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class RealtyTypeRepresenter < JustimmoRepresenter
+      property :id
+      property :name
+
+      collection_representer class: RealtyType
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  module JSON
+    class RegionRepresenter < JustimmoRepresenter
+      property :id
+      property :name
+
+      collection_representer class: Region
+    end
+  end
+end

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

@@ -8,10 +8,9 @@ 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) }
+      request(path, params)
     end
 
     def request(path, params = {})
@@ -55,12 +54,5 @@ module JustimmoClient::V1
 
       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

data/lib/justimmo_client/core/caching.rb

@@ -35,21 +35,5 @@ module JustimmoClient
     def cache
       JustimmoClient::Caching.cache
     end
-
-    # TODO: JSON serialize/deserialize the cached value
-    def with_cache(key, **options)
-      log.debug("Looking up cache key #{key}")
-      data = cache.read(key)
-
-      if data.nil?
-        log.debug("Cache miss for #{key}")
-        data = yield
-        cache.write(key, data, options)
-      else
-        log.debug("Cache hit for #{key}")
-      end
-
-      data
-    end
   end
 end

data/lib/justimmo_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: justimmo_client
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Patrick Auernig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-19 00:00:00.000000000 Z
+date: 2017-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,6 +206,7 @@ files:
 - lib/justimmo_client.rb
 - lib/justimmo_client/api/v1.rb
 - lib/justimmo_client/api/v1/interfaces/employee_interface.rb
+- lib/justimmo_client/api/v1/interfaces/justimmo_interface.rb
 - lib/justimmo_client/api/v1/interfaces/realty_interface.rb
 - lib/justimmo_client/api/v1/models/city.rb
 - lib/justimmo_client/api/v1/models/country.rb
@@ -225,13 +226,20 @@ files:
 - lib/justimmo_client/api/v1/models/realty_usage.rb
 - lib/justimmo_client/api/v1/models/region.rb
 - lib/justimmo_client/api/v1/representers/json.rb
-- lib/justimmo_client/api/v1/representers/json/attachment_image_representer.rb
-- lib/justimmo_client/api/v1/representers/json/attachment_representer.rb
+- lib/justimmo_client/api/v1/representers/json/city_representer.rb
 - lib/justimmo_client/api/v1/representers/json/contact_representer.rb
+- lib/justimmo_client/api/v1/representers/json/country_representer.rb
+- lib/justimmo_client/api/v1/representers/json/employee_representer.rb
+- lib/justimmo_client/api/v1/representers/json/federal_state_representer.rb
+- lib/justimmo_client/api/v1/representers/json/geo_location_representer.rb
 - lib/justimmo_client/api/v1/representers/json/justimmo_representer.rb
-- lib/justimmo_client/api/v1/representers/json/location_representer.rb
+- lib/justimmo_client/api/v1/representers/json/realty_area_representer.rb
 - lib/justimmo_client/api/v1/representers/json/realty_category_representer.rb
-- lib/justimmo_client/api/v1/representers/json/realty_detail_representer.rb
+- lib/justimmo_client/api/v1/representers/json/realty_price_representer.rb
+- lib/justimmo_client/api/v1/representers/json/realty_representer.rb
+- lib/justimmo_client/api/v1/representers/json/realty_room_count_representer.rb
+- lib/justimmo_client/api/v1/representers/json/realty_type_representer.rb
+- lib/justimmo_client/api/v1/representers/json/region_representer.rb
 - lib/justimmo_client/api/v1/representers/xml.rb
 - lib/justimmo_client/api/v1/representers/xml/city_representer.rb
 - lib/justimmo_client/api/v1/representers/xml/contact_representer.rb

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

@@ -1,16 +0,0 @@
-# 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

@@ -1,15 +0,0 @@
-# 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/realty_detail_representer.rb

@@ -1,69 +0,0 @@
-# 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