justimmo_client 0.4.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e15b372bb14b581f41d8d71b5f9886c7c8240c3
-  data.tar.gz: f31c58d987586ce4c2cef6aee84b8cf84a0ebd3f
+  metadata.gz: b165d1e85b2806d6a48d4549205b005bdb24ae3d
+  data.tar.gz: 9095e7b611ba1ba1d3cc9b2fc9d9fe5bde5dd66f
 SHA512:
-  metadata.gz: 9d5ac18de60aa2c2c498c79a8fedacf7a801f273df5ce89be60ef78e9b10246c37f460970f8f3188a0d554b06134105782461fcc2f08177d631739fb5dabadaa
-  data.tar.gz: 93ae8c831522281f4db7e7e7cfcc6c586a4377bab9fad325626992ab5f7a7d1983dd0801d2993cfc0a402a695606d943cdaf4cdce4c9004234457a7208f94d81
+  metadata.gz: 81adda6c7d8369c9f7b8750e9436b23311a7b9c2358ec464cdced91bd83fbbfd1beac8fde7857ad905aa9d981867361ab1abcb2f66e4c71e77b17c2807c9ec7c
+  data.tar.gz: e09286bf5cc8089d57153396677bbe8fc561fb135a2ac6552c35f7cab68554d92ea6ac567ad78d34e177f3eb06c504252a2319b9995ccfe86fa23a6b000c20be

data/.gitlab-ci.yml

@@ -1,46 +1,99 @@
-.test_job: &test_job
-  environment: testing
+image: "ruby:2.4"
+
+stages:
+  - prepare
+  - test
+  - deploy
+
+# Templates
+
+.ruby_2_4_cache: &ruby_2_4_cache
   cache:
+    key: "$CI_COMMIT_REF_NAME-ruby_2_4"
     paths:
-      - cache/bundler
-  before_script:
-    - bundle install --without development -j $(nproc) --path=cache/bundler
+      - vendor/bundle
+
+.ruby_2_3_cache: &ruby_2_3_cache
+  cache:
+    key: "$CI_COMMIT_REF_NAME-ruby_2_3"
+    paths:
+      - vendor/bundle
+
+.pull_cache: &pull_cache
+  cache:
+    policy: pull
+
+.push_cache: &push_cache
+  cache:
+    policy: push
+
+.ruby_2_3: &ruby_2_3
+  image: "ruby:2.3"
+  <<: *ruby_2_3_cache
+
+.ruby_2_4: &ruby_2_4
+  image: "ruby:2.4"
+  <<: *ruby_2_4_cache
+
+.test_job: &test_job
+  <<: *pull_cache
+  variables:
+    BUNDLE_PATH: "vendor/bundle"
+  stage: test
+  environment: testing
+
+.prepare_job: &prepare_job
+  <<: *push_cache
+  variables:
+    BUNDLE_PATH: "vendor/bundle"
+  stage: prepare
+  script:
+    - bundle install -j $(nproc)
   tags:
     - ruby
 
-.test_job_2_3: &test_job_2_3
-  image: 'ruby:2.3'
-  <<: *test_job
+# Jobs: Prepare
 
-.test_job_2_4: &test_job_2_4
-  image: 'ruby:2.4'
-  <<: *test_job
+prepare:bundler_2_4:
+  <<: *prepare_job
+  <<: *ruby_2_4
 
-test:rubocop_2_3:
-  <<: *test_job_2_3
-  script: bundle exec rubocop
-  only:
-    - dev
+prepare:bundler_2_3:
+  <<: *prepare_job
+  <<: *ruby_2_3
+
+# Jobs: Test
 
-test:rubocop_2_4:
-  <<: *test_job_2_4
-  script: bundle exec rubocop
+test:rubocop:
+  <<: *test_job
+  <<: *ruby_2_4
+  script:
+    - bundle exec rubocop
   only:
     - dev
+  tags:
+    - ruby
 
 test:rspec_2_3:
-  <<: *test_job_2_3
-  script: bundle exec rspec
-  artifacts:
-    paths:
-      - coverage/
+  <<: *test_job
+  <<: *ruby_2_3
+  script:
+    - bundle exec rspec
+  tags:
+    - ruby
 
 test:rspec_2_4:
-  <<: *test_job_2_4
-  script: bundle exec rspec
+  <<: *test_job
+  <<: *ruby_2_4
+  script:
+    - bundle exec rspec
   artifacts:
     paths:
       - coverage/
+  tags:
+    - ruby
+
+# Jobs: deploy
 
 pages:
   stage: deploy
@@ -57,8 +110,6 @@ pages:
 
 deploy:rubygems:
   stage: deploy
-  dependencies:
-    - test:rspec_2_4
   before_script:
     - gem install dpl
   script:

data/lib/justimmo_client/{employee.rb → api/v1/interfaces/employee_interface.rb}

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
-module JustimmoClient
+module JustimmoClient::V1
   # Public employee query interface
-  module Employee
+  module EmployeeInterface
     extend JustimmoClient::Utils
 
     module_function
 
-    # Retrieve a list of employee data.
-    # @return [Array<Object>]
+    # @return [Array<Employee>]
     def list
       xml_response = request(:employee).list
       model = Struct.new(:employees).new
@@ -17,9 +16,7 @@ module JustimmoClient
       []
     end
 
-    # Retrieve detailed information about a single employee.
-    # @param id [Integer] The ID of the employee
-    # @return [Object]
+    # @return [Employee]
     def detail(id)
       xml_response = request(:employee).detail(id)
       model = model(:employee).new
@@ -28,7 +25,7 @@ module JustimmoClient
       nil
     end
 
-    # @return [Array<Integer>] An array of employee IDs
+    # @return [Array<Integer>]
     def ids
       json_response = request(:employee).ids
       ::JSON.parse(json_response).map(&:to_i)

data/lib/justimmo_client/{realty.rb → api/v1/interfaces/realty_interface.rb}

@@ -2,9 +2,9 @@
 
 require "json"
 
-module JustimmoClient
+module JustimmoClient::V1
   # Public realty query interface
-  module Realty
+  module RealtyInterface
     extend JustimmoClient::Utils
 
     module_function
@@ -53,9 +53,7 @@ module JustimmoClient
     # @option options [DateTime] :updated_at_min
     # @option options [DateTime] :updated_at_max
     # @option options [String] :location
-    # @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.
+    # @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
@@ -66,7 +64,7 @@ module JustimmoClient
 
     # @param [Integer] id
     # @param [Symbol, String] lang
-    # @return [Object, nil] A detailed realty object, or nil if it could not be found.
+    # @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
@@ -76,12 +74,12 @@ module JustimmoClient
     end
 
     # @see list
-    # @return [Array<Object>] An array of detailed realty objects, or an empty array on error.
+    # @return [Array<Realty>] An array of detailed realty objects, or an empty array on error.
     def details(options = {})
       ids(options).map { |id| detail(id) }
     end
 
-    # @see list
+    # @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)
@@ -91,7 +89,7 @@ module JustimmoClient
     end
 
     # @option options [Boolean] :all (false)
-    # @return [Array<Object>]
+    # @return [Array<RealtyCategory>]
     def categories(options = {})
       xml_response = request(:realty).categories(options)
       representer(:realty_category).for_collection.new([]).from_xml(xml_response)
@@ -100,7 +98,7 @@ module JustimmoClient
     end
 
     # @option options [Boolean] :all (false)
-    # @return [Array<Object>]
+    # @return [Array<RealtyType>]
     def types(options = {})
       xml_response = request(:realty).types(options)
       representer(:realty_type).for_collection.new([]).from_xml(xml_response)
@@ -109,7 +107,7 @@ module JustimmoClient
     end
 
     # @option options [Boolean] :all (false)
-    # @return [Array<Object>]
+    # @return [Array<Country>]
     def countries(options = {})
       xml_response = request(:realty).countries(options)
       representer(:country).for_collection.new([]).from_xml(xml_response)
@@ -119,7 +117,7 @@ module JustimmoClient
 
     # @option options [Boolean] :all (false)
     # @option options [Integer] :country (nil)
-    # @return [Array<Object>]
+    # @return [Array<FederalState>]
     def federal_states(options = {})
       xml_response = request(:realty).federal_states(options)
       representer(:federal_state).for_collection.new([]).from_xml(xml_response)
@@ -130,7 +128,7 @@ module JustimmoClient
     # @option options [Boolean] :all (false)
     # @option options [Integer] :country (nil)
     # @option options [Integer] :federal_state (nil)
-    # @return [Array<Object>]
+    # @return [Array<Region>]
     def regions(options = {})
       xml_response = request(:realty).regions(options)
       representer(:region).for_collection.new([]).from_xml(xml_response)
@@ -141,7 +139,7 @@ module JustimmoClient
     # @option options [Boolean] :all (false)
     # @option options [Integer] :country (nil)
     # @option options [Integer] :federal_state (nil)
-    # @return [Array<Object>]
+    # @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)

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

@@ -176,7 +176,7 @@ module JustimmoClient::V1
           f.add :type do |key, *values|
             values = [values].flatten.map(&:to_sym)
             log.debug(values)
-            types = JustimmoClient::Realty.types
+            types = RealtyInterface.types
             [:type_id, types.select { |x| values.include?(x.name) }.map(&:id)]
           end
           f.add :sub_type_id
@@ -209,7 +209,7 @@ module JustimmoClient::V1
           f.add :updated_at_min, as: :aktualisiert_am_von
           f.add :updated_at_max, as: :aktualisiert_am_bis
           f.add :location do |key, value|
-            cities = JustimmoClient::Realty.zip_codes_and_cities
+            cities = RealtyInterface.zip_codes_and_cities
             [:zip_code, cities.select { |x| x.location == value }.first&.zip_code]
           end
         end

data/lib/justimmo_client/api/v1.rb

@@ -12,5 +12,6 @@ module JustimmoClient
     autoload_dir "#{API_PATH}/models/*.rb"
     autoload_dir "#{API_PATH}/representers/*.rb"
     autoload_dir "#{API_PATH}/requests/*_request.rb"
+    autoload_dir "#{API_PATH}/interfaces/*_interface.rb"
   end
 end

data/lib/justimmo_client/autoload.rb

@@ -11,7 +11,5 @@ module JustimmoClient
   autoload :Logging,  "justimmo_client/core/logging"
   autoload :Utils,    "justimmo_client/core/utils"
   autoload :Caching,  "justimmo_client/core/caching"
-  autoload :Realty,   "justimmo_client/realty"
-  autoload :Employee, "justimmo_client/employee"
   autoload :OptionParser, "justimmo_client/option_parser"
 end

data/lib/justimmo_client/core/utils.rb

@@ -34,5 +34,9 @@ module JustimmoClient
     def request(name)
       versioned_api("#{name.to_s.classify}Request")
     end
+
+    def interface(name)
+      versioned_api("#{name.to_s.classify}Interface")
+    end
   end
 end

data/lib/justimmo_client/interface.rb

@@ -0,0 +1,98 @@
+module JustimmoClient
+  extend JustimmoClient::Utils
+
+  module_function
+
+  # @!group Realty
+
+  # Get a list of realty objects with limited information.
+  # @see V1::RealtyInterface.list query parameters (API Version 1)
+  # @option (see V1::RealtyInterface.list)
+  # @example Filter by zip code and limit to three results.
+  #    JustimmoClient.realties(zip_code: 6800, limit: 3)
+  # @return (see V1::RealtyInterface.list)
+  def realties(**options)
+    interface(:realty).list(options)
+  end
+
+  # Get detailed information about a single realty.
+  # @see V1::RealtyInterface.detail query parameters (API Version 1)
+  # @param (see V1::RealtyInterface.detail)
+  # @return (see V1::RealtyInterface.detail)
+  def realty(id, lang: nil)
+    interface(:realty).detail(id, lang: lang)
+  end
+
+  # Get a list of all realty ids.
+  # @see V1::RealtyInterface.ids query parameters (API Version 1)
+  # @option (see V1::RealtyInterface.ids)
+  # @return (see V1::RealtyInterface.ids)
+  def realty_ids(options = {})
+    interface(:realty).ids(options)
+  end
+
+  # @!group Employee
+
+  # Retrieve a list of employee data.
+  # @return (see V1::EmployeeInterface.list)
+  def employees
+    interface(:employee).list
+  end
+
+  # Retrieve detailed information about a single employee.
+  # @param (see V1::EmployeeInterface.detail)
+  # @return (see V1::EmployeeInterface.detail)
+  def employee(id)
+    interface(:employee).detail(id)
+  end
+
+  # Get a list of all employee IDs.
+  # @return (see V1::EmployeeInterface.ids)
+  def employee_ids
+    interface(:employee).ids
+  end
+
+  # @!group Basic Data
+
+  # Get a list of available categories.
+  # @see V1::RealtyInterface.categories query parameters (API Version 1)
+  # @return (see V1::RealtyInterface.categories)
+  def realty_categories(**options)
+    interface(:realty).categories(options)
+  end
+
+  # Get a list of available realty types.
+  # @see V1::RealtyInterface.types query parameters (API Version 1)
+  # @return (see V1::RealtyInterface.types)
+  def realty_types(**options)
+    interface(:realty).types(options)
+  end
+
+  # Get a list of countries.
+  # @see V1::RealtyInterface.countries query parameters (API Version 1)
+  # @return (see V1::RealtyInterface.countries)
+  def countries(**options)
+    interface(:realty).countries(options)
+  end
+
+  # Get a list of federal states.
+  # @see V1::RealtyInterface.federal_states query parameters (API Version 1)
+  # @return (see V1::RealtyInterface.federal_states)
+  def federal_states(**options)
+    interface(:realty).federal_states(options)
+  end
+
+  # Get a list of regions.
+  # @see V1::RealtyInterface.regions query parameters (API Version 1)
+  # @return (see V1::RealtyInterface.regions)
+  def regions(**options)
+    interface(:realty).regions(options)
+  end
+
+  # Get a list of cities and their zip codes.
+  # @see V1::RealtyInterface.zip_codes_and_cities query parameters (API Version 1)
+  # @return (see V1::RealtyInterface.zip_codes_and_cities)
+  def cities(**options)
+    interface(:realty).zip_codes_and_cities(options)
+  end
+end

data/lib/justimmo_client/version.rb

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

data/lib/justimmo_client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "justimmo_client/autoload"
+require "justimmo_client/interface"
 
 # The Justimmo API.
 module JustimmoClient

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: justimmo_client
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Patrick Auernig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-15 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -185,6 +185,8 @@ files:
 - justimmo_client.gemspec
 - 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/realty_interface.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
@@ -236,11 +238,10 @@ files:
 - 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/interface.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
@@ -263,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: API client for Justimmo