justimmo_client 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf4841e8f104288f8d22c0658455dd0531a404e6
+  data.tar.gz: a6a20249b890e68531a598770d3ed4d2a4520e23
+SHA512:
+  metadata.gz: 32bc0852bc996494f3f1ac4890b9dff42a2cec38f47659a58952907fb5d6daa2b709cceda9dc45bb1ef085671a9b77ce8b987b3c7780c0cbe6cc7ca24f7414f4
+  data.tar.gz: c2d6ab04e7d7cf93bee94415722f32e4c3691753228d3b5a9ed8d8a5d72dddd9afbcec4eb9a673999a43f230596211451a2cf7b53699392491c5361ec44b0ca7

data/.editorconfig

@@ -0,0 +1,15 @@
+# for the sake of sanity
+
+# topmost editorconfig file
+root = true
+
+# always use Unix-style newlines,
+# use 4 spaces for indentation
+# and use UTF-8 encoding
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.env*
+coverage

data/.gitlab-ci.yml

@@ -0,0 +1,67 @@
+.test_job: &test_job
+  environment: testing
+  cache:
+    paths:
+      - cache/bundler
+  before_script:
+    - bundle install --without development -j $(nproc) --path=cache/bundler
+  tags:
+    - ruby
+
+.test_job_2_3: &test_job_2_3
+  image: 'ruby:2.3'
+  <<: *test_job
+
+.test_job_2_4: &test_job_2_4
+  image: 'ruby:2.4'
+  <<: *test_job
+
+test:rubocop_2_3:
+  <<: *test_job_2_3
+  script: bundle exec rubocop
+  only:
+    - dev
+
+test:rubocop_2_4:
+  <<: *test_job_2_4
+  script: bundle exec rubocop
+  only:
+    - dev
+
+test:rspec_2_3:
+  <<: *test_job_2_3
+  script: bundle exec rspec
+  artifacts:
+    paths:
+      - coverage/
+
+test:rspec_2_4:
+  <<: *test_job_2_4
+  script: bundle exec rspec
+  artifacts:
+    paths:
+      - coverage/
+
+pages:
+  stage: deploy
+  dependencies:
+    - test:rspec_2_4
+  script:
+    - mv coverage/ public/
+  artifacts:
+    paths:
+      - public
+    expire_in: 30 days
+  only:
+    - master
+
+deploy:rubygems:
+  stage: deploy
+  dependencies:
+    - test:rspec_2_4
+  before_script:
+    - gem install dpl
+  script:
+    - dpl --provider=rubygems --api-key=$RUBYGEMS_API_KEY
+  only:
+    - tags

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,90 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisabledByDefault: true
+  Exclude:
+    - bin/**
+    - cache/**/*
+    - spec/**/*
+
+# [Layout]
+Layout/CaseIndentation:
+  Enabled: true
+
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/EmptyLines:
+  Enabled: true
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/IndentationConsistency:
+  Enabled: true
+
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Layout/Tab:
+  Enabled: true
+
+Layout/TrailingBlankLines:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# [Lint]
+Lint/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+Lint/RequireParentheses:
+  Enabled: true
+
+# [Style]
+Style/AndOr:
+  Enabled: true
+
+Style/BracesAroundHashParameters:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/UnneededPercentQ:
+  Enabled: true

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+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 "dotenv"
+end
+
+group :development do
+  gem "yard"
+  gem "pry"
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Patrick Auernig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+[![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)
+[![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).
+
+## Dependencies
+
+* Ruby 2.3+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "justimmo_client"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install justimmo_client
+
+
+## Usage Example (Rails)
+
+> config/initializers/justimmo.rb
+```ruby
+JustimmoClient.configure do |config|
+  config.username = "your-username"
+  config.password = "your_password"
+  config.cache    = ActiveSupport::Cache.lookup_store(:memory_store)
+end
+```
+
+---
+
+> app/controllers/realty_controller.rb
+```ruby
+class RealtyController < ApplicationController
+  def index
+    @realties = JustimmoClient::Realty.list(zip_code: 6020, limit: 5)
+  end
+end
+```
+
+For other examples see [examples](examples/).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, put your user credentials into a `.env` file and run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and merge requests are welcome on
+[GitLab](https://gitlab.com/exacting/justimmo-client-ruby).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Check the [LICENSE](LICENSE) file for more information.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "yard"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+YARD::Rake::YardocTask.new(:doc)
+
+task default: :test
+
+task test: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "justimmo_client"
+require "dotenv"
+
+Dotenv.load
+
+JustimmoClient.configure do |config|
+  config.username = ENV['JUSTIMMO_USERNAME']
+  config.password = ENV['JUSTIMMO_PASSWORD']
+  config.debug    = ENV['DEBUG']
+end
+
+begin
+    require 'pry'
+    Pry.start
+rescue LoadError
+    require 'irb'
+    IRB.start(__FILE__)
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/client.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "dotenv"
+require "pp"
+require "active_support/cache"
+require "justimmo_client"
+
+Dotenv.load
+
+JustimmoClient.configure do |config|
+  config.username = ENV["JUSTIMMO_USERNAME"]
+  config.password = ENV["JUSTIMMO_PASSWORD"]
+  config.cache    = ActiveSupport::Cache.lookup_store(:memory_store)
+end
+
+pp JustimmoClient::Realty.list(zip_code: 6800, limit: 5)

data/justimmo_client.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "justimmo_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "justimmo_client"
+  spec.version       = JustimmoClient::VERSION
+  spec.author        = "Patrick Auernig"
+  spec.email         = "patrick.auernig@mykolab.com"
+  spec.license       = "MIT"
+  spec.summary       = "API client for Justimmo"
+  spec.homepage      = "https://gitlab.com/exacting/justimmo-client-ruby"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake",    "~> 10.0"
+
+  # requests
+  spec.add_dependency "rest-client", "~> 2"
+  spec.add_dependency "retriable",   "~> 2.0"
+
+  # parsing
+  spec.add_dependency "nokogiri", "~> 1.7"
+  spec.add_dependency "multi_json"
+  spec.add_dependency "representable", "~> 3.0"
+
+  # models
+  spec.add_dependency "virtus"
+  spec.add_dependency "activesupport", "~> 5.1"
+  spec.add_dependency "iso_country_codes"
+  spec.add_dependency "monetize"
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  class City < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :id, Integer
+    attribute :country_id,       Integer
+    attribute :region_id,        Integer
+    attribute :zip_code,         Integer
+    attribute :location,         String
+    attribute :federal_state_id, Integer
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "iso_country_codes"
+
+module JustimmoClient::V1
+  class Country < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :id,     Integer
+    attribute :alpha2, String
+    attribute :alpha2, String
+
+    # @!group Instance Method Summary
+
+    def initialize(**options)
+      super(options)
+      @country = nil
+    end
+
+    def alpha2=(code)
+      @country ||= IsoCountryCodes.find(code)
+      @alpha2 ||= @country.alpha2
+    end
+
+    def alpha3=(code)
+      @country ||= IsoCountryCodes.find(code)
+      @alpha3 ||= @country.alpha3
+    end
+
+    def name
+      @country&.name
+    end
+
+    def to_s
+      @country&.name || ""
+    end
+
+    def inspect
+      "#<#{self.class} #{self}>"
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  class Employee < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :id,          Integer
+    attribute :number,      Integer
+    attribute :email,       String
+    attribute :phone,       String
+    attribute :mobile,      String
+    attribute :fax,         String
+    attribute :last_name,   String
+    attribute :first_name,  String
+    attribute :salutation,  String
+    attribute :company,     String
+    attribute :street,      String
+    attribute :zip_code,    Integer
+    attribute :location,    String
+    attribute :email_feedback, String
+    attribute :website,     String
+    attribute :picture,     Image
+    attribute :attachment,  Image
+    attribute :position,    String
+
+    # @!group Instance Method Summary
+
+    def full_name(surname_first: false, with_salutation: true)
+      name = [first_name, last_name]
+      name.reverse! if surname_first
+      name.unshift(salutation) if with_salutation
+      name.compact.join(" ")
+    end
+
+    def to_s
+      full_name
+    end
+
+    def inspect
+      "#<#{self.class} #{self}>"
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  class FederalState < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :id,         Integer
+    attribute :name,       String
+    attribute :country_id, Integer
+    attribute :fips,       String
+    attribute :iso,        String
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  class File < JustimmoBase
+    BASE_URL = "https://files.justimmo.at/public"
+
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :title,    String
+    attribute :category, Symbol
+    attribute :origin,   Symbol
+    attribute :type,     Symbol
+    attribute :name,     String
+    attribute :format,   String
+
+    # @!group Instance Method Summary
+
+    def initialize(**options)
+      super(options)
+      @settings = []
+    end
+
+    def category=(cat)
+      @category =
+        case cat
+        when "BILD" then :image
+        when "TITELBILD" then :title_image
+        else nil
+        end
+    end
+
+    def origin=(orig)
+      @origin = orig&.downcase&.to_sym
+    end
+
+    def get(setting = nil)
+      return nil if @default.nil? || @settings.empty?
+      setting = (@settings.include?(setting) ? setting : @default)
+      "#{BASE_URL}/#{@type}/#{setting}/#{@name}"
+    end
+
+    alias [] get
+
+    def add_url(url, default: nil)
+      uri_path = URI.parse(url).path
+      @name ||= ::File.basename(uri_path)
+      @format ||= ::File.extname(@name)
+      @settings << ::URI.parse(url).path.split("/")[-2].to_sym
+      @default = default || @settings.last
+    end
+
+    alias path= add_url
+
+    def to_s
+      get
+    end
+
+    def inspect
+      "#<#{self.class} #{self}>"
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "iso_country_codes"
+
+module JustimmoClient::V1
+  class GeoLocation < JustimmoBase
+    # @!group Attributes
+
+    # @!macro [attach] attribute
+    #   @return [$2]
+    attribute :proximity,     String
+    attribute :federal_state, String
+    attribute :country,       String
+    attribute :zip_code,      Integer
+    attribute :latitude,      Float
+    attribute :longitude,     Float
+    attribute :location,      String
+    attribute :proximity,     String
+    attribute :floor,         Integer
+
+    # @!group Instance Method Summary
+
+    def country=(iso3)
+      @country = IsoCountryCodes.find(iso3)
+    end
+
+    def floor=(flr)
+      @floor = flr.to_i
+    end
+
+    def to_s
+      ["#{zip_code} #{location}", federal_state, country&.name].compact.join(", ")
+    end
+
+    def inspect
+      "#<#{self.class} #{self}>"
+    end
+
+    def to_h
+      { latitude: latitude, longitude: longitude }
+    end
+
+    def to_a
+      [latitude, longitude]
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module JustimmoClient::V1
+  class Image < File
+    def initialize(**options)
+      super(options)
+      @type = :pic
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "virtus"
+
+module JustimmoClient::V1
+  # @api private
+  class JustimmoBase
+    include JustimmoClient::Logging
+
+    # :nodoc:
+    include Virtus.model do |mod|
+      mod.coercer.config.string.boolean_map = { "0" => false, "1" => true }
+    end
+  end
+end