justimmo_client 0.6.8 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '084bca84fab7787d4ac96b9031ee4c6fd23cbbdb'
-  data.tar.gz: d035d7659a897e76fc4babcc80279e4c274bba2e
+  metadata.gz: bfa29bb8a0b47ffee48351281374f3a20c196f24
+  data.tar.gz: 18fcb26eab8b27c1e8a9032581b88c4c8487a858
 SHA512:
-  metadata.gz: 739e21cee8d7630d638a55dd7bacddc85f37c44cb83827ff51b0c7fdebadce28ab087cfaf2028a9bb0e1a49d71af06d872918141e9b8435183cd576a987c0238
-  data.tar.gz: be8b3e5adcc8f8448b12f97659be56cc0740fec96eda1e3b6d046f56d88568e5821725593015296469e796ec25441dd0dabb4beb6130c92ebffa84c55331ee3e
+  metadata.gz: 8441bfa96b3ba2c464e195e168483b1c48ee8eacc731da5c9fff57a018a77f27e3bcfe55d20dfc735a71050b8c18c32834ae304cca711ce3e09a05571bb65201
+  data.tar.gz: e86d3766071bff80baeb426ec8c0d5e5a80b899f2d4686dbe68deb0277159bd8d2f8ab88bab428c05ecc67422ce336b34444d3ba067a692279890db35899cb31

data/Gemfile

@@ -2,17 +2,18 @@
 
 source "https://rubygems.org"
 
-group :test do
-  # Test coverage reporting
-  gem "simplecov", require: false
-end
-
 group :test, :development do
-  gem "rspec",   "~> 3.0"
-  gem "rubocop", "~> 0.48"
+  gem "rubocop", "0.51", require: false
   gem "dotenv"
 end
 
+group :test do
+  gem "simplecov", require: false
+  gem "factory_girl", "4.8.1"
+  gem "rspec",        "~> 3.0"
+  gem "webmock",      "~> 3.1.0"
+end
+
 group :development do
   gem "yard"
   gem "pry"

data/Rakefile

@@ -3,8 +3,11 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"
+require "factory_girl"
 require "yard"
 
+require "justimmo_client"
+
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:rubocop)
 YARD::Rake::YardocTask.new(:doc)
@@ -12,3 +15,9 @@ YARD::Rake::YardocTask.new(:doc)
 task default: :test
 
 task test: %i[spec rubocop]
+
+desc "Verify validity of FactoryGirl factories"
+task :factory_lint do
+  FactoryGirl.find_definitions
+  FactoryGirl.lint
+end

data/justimmo_client.gemspec

@@ -9,11 +9,13 @@ Gem::Specification.new do |spec|
   spec.name          = "justimmo_client"
   spec.version       = JustimmoClient::VERSION
   spec.author        = "Patrick Auernig"
-  spec.email         = "patrick.auernig@mykolab.com"
+  spec.email         = "dev.patrick.auernig@gmail.com"
   spec.license       = "MIT"
   spec.summary       = "API client for Justimmo"
   spec.homepage      = "https://gitlab.com/exacting/justimmo-client-ruby"
 
+  spec.required_ruby_version = ">= 2.3"
+
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -26,18 +28,18 @@ Gem::Specification.new do |spec|
 
   # requests
   spec.add_dependency "rest-client", "~> 2"
-  spec.add_dependency "retriable",   "~> 2.0"
+  spec.add_dependency "retriable",   "~> 3.0"
 
   # parsing
-  spec.add_dependency "nokogiri", "~> 1.7"
-  spec.add_dependency "multi_json", "~> 1"
+  spec.add_dependency "nokogiri",      "~> 1.7"
+  spec.add_dependency "multi_json",    "~> 1"
   spec.add_dependency "representable", "~> 3.0"
 
   # models
-  spec.add_dependency "virtus", "~> 1"
-  spec.add_dependency "activesupport", "~> 5.1"
+  spec.add_dependency "virtus",            "~> 1"
+  spec.add_dependency "activesupport",     "~> 5.1"
   spec.add_dependency "iso_country_codes", "~> 0"
-  spec.add_dependency "monetize", "~> 1"
+  spec.add_dependency "monetize",          "~> 1"
 
   # other
   spec.add_dependency "i18n", ">= 0.7", "<= 0.9"

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

@@ -14,10 +14,14 @@ module JustimmoClient::V1
     attribute :format,   String
     attribute :type,     String
     attribute :file,     String
+    attribute :size,     Symbol
 
+    # FIXME: the attachment can be something other than a image file
+    #        maybe move type detection into representer?
     def url=(value)
       path = URI.parse(value).path.sub("/public/", "")
       @type, size, file = path.split("/")
+      return if file.nil?
       @format ||= ::File.extname(file).tr(".", "")
       @file = ::File.basename(file, ".#{@format}")
       @size = size.start_with?("user") ? :user_big : :big

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

@@ -14,7 +14,7 @@ module JustimmoClient::V1
     attribute :fax,            String
     attribute :last_name,      String
     attribute :first_name,     String
-    attribute :salutation,     String
+    attribute :salutation,     String, default: ""
     attribute :company,        String
     attribute :street,         String
     attribute :zip_code,       Integer
@@ -48,9 +48,5 @@ module JustimmoClient::V1
     def to_s
       full_name
     end
-
-    def inspect
-      "#<#{self.class} #{self}>"
-    end
   end
 end

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

@@ -15,7 +15,6 @@ module JustimmoClient::V1
     attribute :latitude,      Float
     attribute :longitude,     Float
     attribute :location,      String
-    attribute :proximity,     String
     attribute :floor,         Integer
 
     # @!group Instance Method Summary
@@ -40,10 +39,6 @@ module JustimmoClient::V1
       "#<#{self.class} #{self}>"
     end
 
-    def to_h
-      { latitude: latitude, longitude: longitude }
-    end
-
     def to_a
       [latitude, longitude]
     end

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

@@ -13,5 +13,41 @@ module JustimmoClient::V1
       mod.nullify_blank = true
       mod.coercer.config.string.boolean_map = { "0" => false, "1" => true }
     end
+
+    # Dummy method for FactoryGirl
+    def save!
+    end
+
+    def to_h
+      deep_to_h
+    end
+
+    def ==(other)
+      return true if equal?(other)
+      return false unless other.is_a?(JustimmoBase)
+      to_h == other.to_h
+    end
+
+    private
+
+    def array_to_h(array)
+      array.map do |elem|
+        if elem.respond_to?(:to_h)
+          elem.to_h
+        else
+          elem
+        end
+      end
+    end
+
+    def deep_to_h
+      attributes.inject({}) do |acc, (key, value)|
+        case value
+        when Array        then acc.update(key => array_to_h(value))
+        when JustimmoBase then acc.update(key => value.to_h)
+        else                   acc.update(key => value)
+        end
+      end
+    end
   end
 end

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

@@ -36,6 +36,17 @@ module JustimmoClient::V1
 
     # @!group Instance Method Summary
 
+    def initialize(**options)
+      super(options)
+      @contact ||= Employee.new
+      @usage ||= RealtyUsage.new
+      @marketing ||= RealtyMarketing.new
+      @geo ||= GeoLocation.new
+      @area ||= RealtyArea.new
+      @room_count ||= RealtyRoomCount.new
+      @price ||= RealtyPrice.new
+    end
+
     def images
       attachments.select { |x| x.type == "pic" }
     end
@@ -58,17 +69,19 @@ module JustimmoClient::V1
         if @teaser.empty?
           parts = desc.partition("</ul>\n")
           self.teaser = parts[0..1].join
-          parts.last
+          parts.last.strip
         else
-          desc
+          desc.strip
         end
     end
 
     def teaser=(tea)
       @teaser =
         case tea
-        when Array then tea
-        when String then tea&.gsub(/<\/?(ul|li)>/, "")&.strip&.split("\n")
+        when Array
+          tea.map(&:strip)
+        when String
+          tea.gsub(/<\/?(ul|li)>/, "").strip.split("\n").map(&:strip)
         else []
         end
     end

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

@@ -147,10 +147,18 @@ module JustimmoClient::V1
         REALTY_ROOMS.each { |k, v| property k, as: v }
       end
 
-      property :documents, as: :dokumente
-      property :videos
-      property :images360, as: :bilder360
-      property :links
+      property :documents,
+        as: :dokumente,
+        parse_filter: ->(fragment, _options) { fragment.empty? ? nil : fragment }
+
+      property :videos,
+        parse_filter: ->(fragment, _options) { fragment.empty? ? nil : fragment }
+
+      property :images360, as: :bilder360,
+        parse_filter: ->(fragment, _options) { fragment.empty? ? nil : fragment }
+
+      property :links,
+        parse_filter: ->(fragment, _options) { fragment.empty? ? nil : fragment }
 
       collection :attachments,
         as: :anhang,

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

@@ -21,7 +21,7 @@ module JustimmoClient::V1
         Authorization: "Basic #{JustimmoClient::Config.credentials}"
       }
 
-      with_retries do
+      Retriable.retriable do
         with_request_error_handler do
           log.debug("Requesting #{uri} with params #{options[:params]}")
           RestClient.proxy = JustimmoClient::Config.proxy
@@ -40,19 +40,5 @@ module JustimmoClient::V1
     rescue RestClient::Exception, SocketError, Errno::ECONNREFUSED => e
       raise JustimmoClient::RetrievalFailed, e
     end
-
-    def with_retries
-      options = {
-        base_interval: 2.0,
-        tries: JustimmoClient::Config.request_retries,
-        on_retry: proc do |exception, try, elapsed_time, next_interval|
-          log.error("#{exception.class}: #{exception}")
-          log.error("Try #{try} in #{elapsed_time} seconds, retrying in #{next_interval} seconds.")
-        end,
-        on: JustimmoClient::RetrievalFailed
-      }
-
-      Retriable.retriable(options) { yield }
-    end
   end
 end

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

@@ -146,9 +146,6 @@ module JustimmoClient::V1
 
     def with_error_handler
       yield
-    rescue JustimmoClient::OptionParserError => e
-      log.error(e)
-      raise JustimmoClient::RetrievalFailed, e
     end
 
     # @!group Option Parsers

data/lib/justimmo_client/autoload.rb

@@ -2,11 +2,12 @@
 
 require "justimmo_client/version"
 require "justimmo_client/errors"
-require "justimmo_client/misc"
 
 module JustimmoClient
   include JustimmoClient::Errors
 
+  require "justimmo_client/misc"
+
   autoload :Config,   "justimmo_client/core/config"
   autoload :Logging,  "justimmo_client/core/logging"
   autoload :Utils,    "justimmo_client/core/utils"

data/lib/justimmo_client/errors.rb

@@ -7,9 +7,6 @@ module JustimmoClient::Errors
   # Raised when configuration validation fails.
   ConfigurationError = Class.new(JustimmoError)
 
-  # Raised when option parsing fails
-  OptionParserError = Class.new(JustimmoError)
-
   # Raised when authentication with the API fails.
   class AuthenticationFailed < JustimmoError
     def initialize
@@ -24,20 +21,6 @@ module JustimmoClient::Errors
     end
   end
 
-  # Raised when the option parser rejects an option
-  class InvalidOption < OptionParserError
-    def initialize(key)
-      super "Option '#{key}' not supported"
-    end
-  end
-
-  # Raised when the option parser rejects a value
-  class InvalidValue < OptionParserError
-    def initialize(value)
-      super "'#{value}' is not in the list of accepted values"
-    end
-  end
-
   # Raised when an unsupported API version is set.
   class UnsupportedAPIVersion < ConfigurationError
     def initialize(version)

data/lib/justimmo_client/misc.rb

@@ -2,11 +2,28 @@
 
 require "active_support/inflector/inflections"
 require "active_support/i18n"
+require "retriable"
+require "justimmo_client/core/config"
+require "justimmo_client/core/logging"
 
-ActiveSupport::Inflector.inflections do |inflect|
-  inflect.acronym "XML"
-  inflect.acronym "JSON"
-end
+module JustimmoClient
+  extend JustimmoClient::Logging
+
+  ActiveSupport::Inflector.inflections do |inflect|
+    inflect.acronym "XML"
+    inflect.acronym "JSON"
+  end
 
-I18n.load_path += Dir[File.expand_path("../../locales/*.yml", __dir__)]
-I18n.default_locale = :en
+  I18n.load_path += Dir[File.expand_path("../../locales/*.yml", __dir__)]
+  I18n.default_locale = :en
+
+  Retriable.configure do |c|
+    c.base_interval = 2.0
+    c.tries = JustimmoClient::Config.request_retries
+    c.on_retry = proc do |exception, try, elapsed_time, next_interval|
+      log.error("#{exception.class}: #{exception}")
+      log.error("Try #{try} in #{elapsed_time} seconds, retrying in #{next_interval} seconds.")
+    end
+    c.on = JustimmoClient::RetrievalFailed
+  end
+end

data/lib/justimmo_client/option_parser.rb

@@ -5,6 +5,29 @@ module JustimmoClient
   class OptionParser
     include JustimmoClient::Logging
 
+    # Raised when option parsing fails
+    OptionParserError = Class.new(StandardError)
+
+    # Raised when the option parser rejects an option
+    class InvalidOption < OptionParserError
+      def initialize(key)
+        super "Option '#{key}' not supported"
+      end
+    end
+
+    # Raised when the option parser rejects a value
+    class InvalidValue < OptionParserError
+      def initialize(value)
+        super "'#{value}' is not in the list of accepted values"
+      end
+    end
+
+    class DuplicateKeyGroup < OptionParserError
+      def initialize(key, group)
+        super "Key #{key} is already in group #{group}"
+      end
+    end
+
     attr_accessor :range_suffix
     attr_accessor :mappings
 
@@ -33,14 +56,14 @@ module JustimmoClient
       out = {}
 
       options.each do |key, value|
-        raise JustimmoClient::InvalidOption, key unless @options.key?(key.to_sym)
+        raise InvalidOption, key unless @options.key?(key.to_sym)
         group = group_of(key)
 
         if group
           out[group] ||= {}
-          out[group].update(parse_option(key.to_sym, value))
+          out[group].update(parse_option(key.to_sym, value).reject { |_k, v| v.nil? })
         else
-          out.update(parse_option(key.to_sym, value))
+          out.update(parse_option(key.to_sym, value).reject { |_k, v| v.nil? })
         end
       end
 
@@ -50,6 +73,9 @@ module JustimmoClient
     private
 
     def add_option(key, **options, &block)
+      group = group_of(key)
+      raise DuplicateKeyGroup.new(key, group) unless group.nil?
+
       @options[key.to_sym] = {
         group: @context,
         type: options[:type],
@@ -94,7 +120,7 @@ module JustimmoClient
 
     def parse_option(key, value)
       values = @options.dig(key, :values)
-      raise JustimmoClient::InvalidValue, value unless values.nil? || values.include?(value)
+      raise InvalidValue, value unless values.nil? || values.include?(value)
 
       key, value = apply_mod(key.to_sym, value) if has_mod?(key)
 

data/lib/justimmo_client/version.rb

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

data/notes.md

@@ -17,3 +17,8 @@
 * objekt/bundeslaender
 * objekt/regionen
 * objekt/plzUndOrte
+
+# Test Todo
+- [ ] models
+- [ ] requests
+- [x] parser

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: justimmo_client
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.6.9
 platform: ruby
 authors:
 - Patrick Auernig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-22 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +185,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: 
-email: patrick.auernig@mykolab.com
+email: dev.patrick.auernig@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -280,7 +280,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="