pricehubble 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a6dec9a50e1bc53530adc56e69bccf3c0309b0c38b8819be5862ac01b78aa24
+  data.tar.gz: edb1ce1a5667290d8d8481edfeb41c39cffc09d35efea6a7e6f1d81f38f00095
+SHA512:
+  metadata.gz: 4c02c6a1153849bbad1f2ba7f171a5b526be7fb6d42001f7419099901df2bf80abb61943948e3a2322e92ab202ef96122533f2c4887fd1c385db6fd3c4c897a9
+  data.tar.gz: ee651835c4f91e894a9967d5477cb44a9efb13dc64dbb3cde557b6315c71b8837806f6a9c3c2356e772c3a4b5e202870a8d7f7e399ea972cc336da1647e91386

data/.editorconfig

@@ -0,0 +1,30 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = true
+
+[*.json]
+indent_style = space
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[Makefile]
+trim_trailing_whitespace = true
+indent_style = tab
+indent_size = 4
+
+[*.sh]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/api/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/gemfiles/vendor/
+/Gemfile.lock
+*.gemfile.lock
+/spec/.credentials
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,62 @@
+require: rubocop-rspec
+
+Rails:
+  Enabled: true
+
+Documentation:
+  Enabled: true
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+    - build/**/*
+    - gemfiles/vendor/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - Rakefile
+    - '*.gemspec'
+    - spec/**/*.rb
+    - '**/*.rake'
+    - doc/**/*.rb
+    # Concerns and middlewares contain by nature long blocks
+    - lib/pricehubble/entity/concern/**/*.rb
+    - lib/pricehubble/client/request/**/*.rb
+    - lib/pricehubble/client/response/**/*.rb
+
+# Document all the things.
+Style/DocumentationMethod:
+  Enabled: true
+  RequireForNonPublicMethods: true
+
+# It's a deliberate idiom in RSpec.
+# See: https://github.com/bbatsov/rubocop/issues/4222
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+# Because +expect_any_instance_of().to have_received()+ is not
+# supported with the +with(hash_including)+ matchers
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Because nesting makes sense here to group the feature tests
+# more effective. This increases maintainability.
+RSpec/NestedGroups:
+  Max: 4
+
+# Disable regular Rails spec paths.
+RSpec/FilePath:
+  Enabled: false
+
+# Because we just implemented the ActiveRecord API.
+Rails/SkipsModelValidations:
+  Enabled: false
+
+# Because of the clean wording on the examples.
+Lint/ShadowingOuterLocalVariable:
+  Exclude:
+    - "doc/**/*"

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start 'test_frameworks' do
+  add_filter '/vendor/bundle/'
+end

data/.travis.yml

@@ -0,0 +1,27 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=e80bc2fc948962da41f411047330599fe2bdafcc378bd99a1c3bffbfae74c20f
+
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6
+  - 2.5
+  - 2.4
+  - 2.3
+
+gemfile:
+  - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.2.gemfile
+
+before_install: gem install bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script: bundle exec rake
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/.yardopts

@@ -0,0 +1,6 @@
+--output-dir=doc/api
+--plugin activesupport-concern
+--markup=rdoc
+-
+README.md
+lib/**/*.rb

data/Appraisals

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+appraise 'rails-4.2' do
+  gem 'activemodel', '~> 4.2.11'
+  gem 'activesupport', '~> 4.2.11'
+  gem 'railties', '~> 4.2.11'
+end
+
+appraise 'rails-5.0' do
+  gem 'activemodel', '~> 5.0.7'
+  gem 'activesupport', '~> 5.0.7'
+  gem 'railties', '~> 5.0.7'
+end
+
+appraise 'rails-5.1' do
+  gem 'activemodel', '~> 5.1.6'
+  gem 'activesupport', '~> 5.1.6'
+  gem 'railties', '~> 5.1.6'
+end
+
+appraise 'rails-5.2' do
+  gem 'activemodel', '~> 5.2.2'
+  gem 'activesupport', '~> 5.2.2'
+  gem 'railties', '~> 5.2.2'
+end

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+### 0.1.0
+
+* Implemented a transparent authentication handling
+* Implemented all shared data types (`PriceHubble::Location`,
+  `PriceHubble::Coordinates`, `PriceHubble::Address`, `PriceHubble::Property`,
+  `PriceHubble::PropertyType`)
+* Implemented the international property valuation
+  (`PriceHubble::ValuationRequest`)
+* Added a set of examples and wrote the usage documentation

data/Dockerfile

@@ -0,0 +1,29 @@
+FROM hausgold/ruby:2.3
+MAINTAINER Hermann Mayer <hermann.mayer@hausgold.de>
+
+# Update system gem
+RUN gem update --system
+
+# Install system packages and the latest bundler
+RUN apt-get update -yqqq && \
+  apt-get install -y \
+    build-essential locales sudo vim \
+    ca-certificates \
+    bash-completion inotify-tools && \
+  echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && /usr/sbin/locale-gen && \
+  gem install bundler -v '~> 2.0' --no-document --no-prerelease && \
+  gem install bundler -v '~> 1.0' --no-document --no-prerelease
+
+# Add new web user
+RUN mkdir /app && \
+  adduser web --home /home/web --shell /bin/bash \
+    --disabled-password --gecos ""
+COPY config/docker/* /home/web/
+RUN chown web:web -R /app /home/web /usr/local/bundle && \
+  mkdir -p /home/web/.ssh
+
+# Set the root password and grant root access to web
+RUN echo 'root:root' | chpasswd
+RUN echo 'web ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
+
+WORKDIR /app

data/Envfile

@@ -0,0 +1,6 @@
+LANG=en_US.UTF-8
+LANGUAGE=en_US.UTF-8
+LC_ALL=en_US.UTF-8
+
+# Just fix this, so Appraisals with Rails 4 are working fine
+BUNDLER_VERSION=1.17.3

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in price_hubble.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 HAUSGOLD | talocasa GmbH
+
+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/Makefile

@@ -0,0 +1,149 @@
+MAKEFLAGS += --warn-undefined-variables -j1
+SHELL := bash
+.SHELLFLAGS := -eu -o pipefail -c
+.DEFAULT_GOAL := all
+.DELETE_ON_ERROR:
+.SUFFIXES:
+.PHONY:
+
+# Environment switches
+MAKE_ENV ?= docker
+COMPOSE_RUN_SHELL_FLAGS ?= --rm
+
+# Directories
+VENDOR_DIR ?= vendor/bundle
+GEMFILES_DIR ?= gemfiles
+
+# Host binaries
+AWK ?= awk
+BASH ?= bash
+COMPOSE ?= docker-compose
+DOCKER ?= docker
+GREP ?= grep
+ID ?= id
+MKDIR ?= mkdir
+RM ?= rm
+XARGS ?= xargs
+
+# Container binaries
+BUNDLE ?= bundle
+APPRAISAL ?= appraisal
+RAKE ?= rake
+YARD ?= yard
+RAKE ?= rake
+RUBOCOP ?= rubocop
+
+# Files
+GEMFILES ?= $(subst _,-,$(patsubst $(GEMFILES_DIR)/%.gemfile,%,\
+	$(wildcard $(GEMFILES_DIR)/*.gemfile)))
+TEST_GEMFILES := $(GEMFILES:%=test-%)
+
+# Define a generic shell run wrapper
+# $1 - The command to run
+ifeq ($(MAKE_ENV),docker)
+define run-shell
+	$(COMPOSE) run $(COMPOSE_RUN_SHELL_FLAGS) \
+		-e LANG=en_US.UTF-8 -e LANGUAGE=en_US.UTF-8 -e LC_ALL=en_US.UTF-8 \
+		-e HOME=/home/web -e BUNDLE_APP_CONFIG=/app/.bundle \
+		-u `$(ID) -u` test bash -c 'sleep 0.1; echo; $(1)'
+endef
+else ifeq ($(MAKE_ENV),baremetal)
+define run-shell
+	$(1)
+endef
+endif
+
+all:
+	# PriceHubble
+	#
+	# install            Install the dependencies
+	# update             Update the local Gemset dependencies
+	# clean              Clean the dependencies
+	#
+	# test               Run the whole test suite
+	# test-style         Test the code styles
+	#
+	# docs               Generate the Ruby documentation of the library
+	# stats              Print the code statistics (library and test suite)
+	# notes              Print all the notes from the code
+	# release            Release a new Gem version (maintainers only)
+	#
+	# shell              Run an interactive shell on the container
+	# shell-irb          Run an interactive IRB shell on the container
+
+install:
+	# Install the dependencies
+	@$(MKDIR) -p $(VENDOR_DIR)
+	@$(call run-shell,$(BUNDLE) check || $(BUNDLE) install --path $(VENDOR_DIR))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) install)
+
+update: install
+	# Install the dependencies
+	@$(MKDIR) -p $(VENDOR_DIR)
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) update)
+
+test: #install
+	# Run the whole test suite
+	@$(call run-shell,$(BUNDLE) exec $(RAKE))
+
+$(TEST_GEMFILES): GEMFILE=$(@:test-%=%)
+$(TEST_GEMFILES):
+	# Run the whole test suite ($(GEMFILE))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RAKE))
+
+test-style: \
+	test-style-ruby
+
+test-style-ruby:
+	# Run the static code analyzer (rubocop)
+	@$(call run-shell,$(BUNDLE) exec $(RUBOCOP) -a)
+
+clean:
+	# Clean the dependencies
+	@$(RM) -rf $(VENDOR_DIR)
+	@$(RM) -rf $(VENDOR_DIR)/Gemfile.lock
+	@$(RM) -rf $(GEMFILES_DIR)/vendor
+	@$(RM) -rf $(GEMFILES_DIR)/*.lock
+	@$(RM) -rf pkg
+	@$(RM) -rf coverage
+
+clean-containers:
+	# Clean running containers
+ifeq ($(MAKE_ENV),docker)
+	@$(COMPOSE) down
+endif
+
+clean-images:
+	# Clean build images
+ifeq ($(MAKE_ENV),docker)
+	@-$(DOCKER) images | $(GREP) price-hubble \
+		| $(AWK) '{ print $$3 }' \
+		| $(XARGS) -rn1 $(DOCKER) rmi -f
+endif
+
+distclean: clean clean-containers clean-images
+
+shell: install
+	# Run an interactive shell on the container
+	@$(call run-shell,$(BASH) -i)
+
+shell-irb: install
+	# Run an interactive IRB shell on the container
+	@$(call run-shell,bin/console)
+
+docs: install
+	# Build the API documentation
+	@$(call run-shell,$(BUNDLE) exec $(YARD) -q && \
+		$(BUNDLE) exec $(YARD) stats --list-undoc --compact)
+
+notes: install
+	# Print the code statistics (library and test suite)
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) notes)
+
+stats: install
+	# Print all the notes from the code
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats)
+
+release:
+	# Release a new gem version
+	@$(RAKE) release