justimmo_client 0.4.0

data/lib/justimmo_client/realty.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require "json"
+
+module JustimmoClient
+  # Public realty query interface
+  module Realty
+    extend JustimmoClient::Utils
+
+    module_function
+
+    # @option options [Integer] :limit (10)
+    # @option options [Integer] :offset (0)
+    # @option options [Symbol, String] :lang (:de)
+    # @option options [Symbol, String] :orderby
+    # @option options [Symbol, String] :ordertype (:asc)
+    # @option options [Symbol, String] :picturesize (:small)
+    # @option options [Boolean] :with_projects (false)
+    # @option options [Float] :price_min
+    # @option options [Float] :price_max
+    # @option options [Float] :price_per_sqm_min
+    # @option options [Float] :price_per_sqm_max
+    # @option options [Integer] :type_id
+    # @option options [Integer] :sub_type_id
+    # @option options [Symbol, String] :tag
+    # @option options [String, Integer] :zip_code
+    # @option options [String, Integer] :zip_code_min
+    # @option options [String, Integer] :zip_code_max
+    # @option options [Integer] :rooms_min
+    # @option options [Integer] :rooms_max
+    # @option options [Integer] :number
+    # @option options [Integer] :number_min
+    # @option options [Integer] :number_max
+    # @option options [Float] :area_min
+    # @option options [Float] :area_max
+    # @option options [Float] :living_area_min
+    # @option options [Float] :living_area_max
+    # @option options [Float] :floor_area_min
+    # @option options [Float] :floor_area_max
+    # @option options [Float] :surface_area_min
+    # @option options [Float] :surface_area_max
+    # @option options [Symbol, String] :keyword
+    # @option options [Integer] :country_id
+    # @option options [Integer] :federal_state_id
+    # @option options [Integer] :status_id
+    # @option options [Boolean] :rent
+    # @option options [Boolean] :purcase
+    # @option options [Integer] :owner_id
+    # @option options [Integer] :project_id
+    # @option options [Symbol, String] :type
+    # @option options [Integer] :parent_id
+    # @option options [DateTime] :updated_at_min
+    # @option options [DateTime] :updated_at_max
+    # @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.
+    def list(options = {})
+      xml_response = request(:realty).list(options)
+      model = Struct.new(:realties).new
+      representer(:realty_list).new(model).from_xml(xml_response).realties
+    rescue JustimmoClient::RetrievalFailed
+      []
+    end
+
+    # @param [Integer] id
+    # @param [Symbol, String] lang
+    # @return [Object, nil] A detailed realty object, or nil if it could not be found.
+    def detail(id, lang: nil)
+      xml_response = request(:realty).detail(id: id, lang: lang)
+      model = Struct.new(:realty).new
+      representer(:realty_detail).new(model).from_xml(xml_response).realty
+    rescue JustimmoClient::RetrievalFailed
+      nil
+    end
+
+    # @see list
+    # @return [Array<Object>] An array of detailed realty objects, or an empty array on error.
+    def details(options = {})
+      ids(options).map { |id| detail(id) }
+    end
+
+    # @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)
+    rescue JustimmoClient::RetrievalFailed
+      []
+    end
+
+    # @option options [Boolean] :all (false)
+    # @return [Array<Object>]
+    def categories(options = {})
+      xml_response = request(:realty).categories(options)
+      representer(:realty_category).for_collection.new([]).from_xml(xml_response)
+    rescue JustimmoClient::RetrievalFailed
+      []
+    end
+
+    # @option options [Boolean] :all (false)
+    # @return [Array<Object>]
+    def types(options = {})
+      xml_response = request(:realty).types(options)
+      representer(:realty_type).for_collection.new([]).from_xml(xml_response)
+    rescue JustimmoClient::RetrievalFailed
+      []
+    end
+
+    # @option options [Boolean] :all (false)
+    # @return [Array<Object>]
+    def countries(options = {})
+      xml_response = request(:realty).countries(options)
+      representer(:country).for_collection.new([]).from_xml(xml_response)
+    rescue JustimmoClient::RetrievalFailed
+      []
+    end
+
+    # @option options [Boolean] :all (false)
+    # @option options [Integer] :country (nil)
+    # @return [Array<Object>]
+    def federal_states(options = {})
+      xml_response = request(:realty).federal_states(options)
+      representer(:federal_state).for_collection.new([]).from_xml(xml_response)
+    rescue JustimmoClient::RetrievalFailed
+      []
+    end
+
+    # @option options [Boolean] :all (false)
+    # @option options [Integer] :country (nil)
+    # @option options [Integer] :federal_state (nil)
+    # @return [Array<Object>]
+    def regions(options = {})
+      xml_response = request(:realty).regions(options)
+      representer(:region).for_collection.new([]).from_xml(xml_response)
+    rescue JustimmoClient::RetrievalFailed
+      []
+    end
+
+    # @option options [Boolean] :all (false)
+    # @option options [Integer] :country (nil)
+    # @option options [Integer] :federal_state (nil)
+    # @return [Array<Object>]
+    def zip_codes_and_cities(options = {})
+      xml_response = request(:realty).zip_codes_and_cities(options)
+      representer(:city).for_collection.new([]).from_xml(xml_response)
+    rescue JustimmoClient::RetrievalFailed
+      []
+    end
+  end
+end

data/lib/justimmo_client/version.rb

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

data/lib/justimmo_client.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "justimmo_client/autoload"
+
+# The Justimmo API.
+module JustimmoClient
+  module_function
+
+  # Loads configuration and initializes the API.
+  def configure(&block)
+    JustimmoClient::Config.configure(&block)
+    initialize_api
+  end
+
+  def initialize_api
+    api_ver = JustimmoClient::Config.api_ver
+    send :autoload, "V#{api_ver}", "justimmo_client/api/v#{api_ver}"
+  end
+
+  # Initially load the defaul API scope.
+  initialize_api
+end

data/notes.md

@@ -0,0 +1,19 @@
+# Endpoints
+
+## Employees
+* team/list
+* team/detail
+* team/ids
+
+## Projects
+* projekt/list
+* projekt/detail
+* projekt/ids
+
+## Basic Data
+* objekt/kategorien
+* objekt/objektarten
+* objekt/laender
+* objekt/bundeslaender
+* objekt/regionen
+* objekt/plzUndOrte

metadata

@@ -0,0 +1,271 @@
+--- !ruby/object:Gem::Specification
+name: justimmo_client
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Patrick Auernig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: retriable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: representable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: iso_country_codes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: monetize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: patrick.auernig@mykolab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/client.rb
+- justimmo_client.gemspec
+- lib/justimmo_client.rb
+- lib/justimmo_client/api/v1.rb
+- lib/justimmo_client/api/v1/models/city.rb
+- lib/justimmo_client/api/v1/models/country.rb
+- lib/justimmo_client/api/v1/models/employee.rb
+- lib/justimmo_client/api/v1/models/federal_state.rb
+- lib/justimmo_client/api/v1/models/file.rb
+- lib/justimmo_client/api/v1/models/geo_location.rb
+- lib/justimmo_client/api/v1/models/image.rb
+- lib/justimmo_client/api/v1/models/justimmo_base.rb
+- lib/justimmo_client/api/v1/models/realty.rb
+- lib/justimmo_client/api/v1/models/realty_area.rb
+- lib/justimmo_client/api/v1/models/realty_category.rb
+- lib/justimmo_client/api/v1/models/realty_marketing.rb
+- lib/justimmo_client/api/v1/models/realty_price.rb
+- lib/justimmo_client/api/v1/models/realty_room_count.rb
+- lib/justimmo_client/api/v1/models/realty_type.rb
+- 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/contact_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_category_representer.rb
+- lib/justimmo_client/api/v1/representers/json/realty_detail_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
+- lib/justimmo_client/api/v1/representers/xml/country_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/employee_list_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/employee_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/federal_state_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/geo_location_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/justimmo_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/realty_area_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/realty_category_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/realty_detail_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/realty_list_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/realty_price_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/realty_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/realty_room_count_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/realty_type_representer.rb
+- lib/justimmo_client/api/v1/representers/xml/region_representer.rb
+- lib/justimmo_client/api/v1/requests/employee_request.rb
+- lib/justimmo_client/api/v1/requests/justimmo_request.rb
+- lib/justimmo_client/api/v1/requests/realty_request.rb
+- lib/justimmo_client/autoload.rb
+- lib/justimmo_client/core/caching.rb
+- lib/justimmo_client/core/config.rb
+- lib/justimmo_client/core/logging.rb
+- lib/justimmo_client/core/utils.rb
+- lib/justimmo_client/employee.rb
+- lib/justimmo_client/errors.rb
+- lib/justimmo_client/misc.rb
+- lib/justimmo_client/option_parser.rb
+- lib/justimmo_client/realty.rb
+- lib/justimmo_client/version.rb
+- notes.md
+homepage: https://gitlab.com/exacting/justimmo-client-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: API client for Justimmo
+test_files: []