pricehubble 0.1.0

data/lib/pricehubble/utils/decision.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module PriceHubble
+  module Utils
+    # Provides an easy to use decision DSL which works like a flow control.
+    # (eg. if conditions, or a switch statement) It should DRY out the
+    # processing logic on clients, while make decisions about the status of the
+    # response. The decision helper evaluates the answers to: Should we raise
+    # an error or return a default value? Was the response any good?
+    #
+    # Example:
+    #
+    #   decision(bang: true) do |result|
+    #     result.fail { nil }
+    #     result.bang { Hausgold::AuthenticationError.new(nil, res, res.body) }
+    #     result.good { Hausgold::Jwt.new(res.body).clear_changes }
+    #     successful?(res)
+    #   end
+    module Decision
+      extend ActiveSupport::Concern
+
+      included do
+        # Allow users to build decision paths and run them according to the
+        # result. This is a kind of flow control like an if condition, or a
+        # switch statement. It contains three decision result paths, the happy
+        # case (good), an error case for regular issues (fail) and a error case
+        # for fatal issues (bang). You can configure the decision which error
+        # behaiviour you prefer by setting the +bang+ argument to true or
+        # false.
+        #
+        # @param bang [Boolean] whenever to bang or not
+        # @yield Runtime to collect the settings and the result
+        # @return [Mixed] the result of the decision (good|fail|bang) block
+        def decision(bang: false, &block)
+          runtime = Runtime.new(on_error: bang ? :bang : :fail)
+          runtime.evaluate(&block)
+        end
+      end
+
+      # An inline runtime class to abstract the decision making.
+      class Runtime
+        # Generate getters for the runtime settings
+        attr_reader :on_error, :bang_proc, :fail_proc, :good_proc
+
+        # Create a new decision runtime object which collect all the result
+        # paths, and then evaluates the decision.
+        #
+        # @param on_error [Symbol] the error way
+        def initialize(on_error: :fail)
+          @on_error = on_error
+          @bang_proc = -> { StandardError.new }
+          @fail_proc = @good_proc = -> { nil }
+        end
+
+        # Register a new error (bang) way. Requires a block.
+        #
+        # @param block [Proc] the block to run in case of errors
+        def bang(&block)
+          @bang_proc = block
+        end
+
+        # Register a new error (fail) way. Requires a block.
+        #
+        # @param block [Proc] the block to run in case of errors
+        def fail(&block)
+          @fail_proc = block
+        end
+
+        # Register a new success (good) way. Requires a block.
+        #
+        # @param block [Proc] the block to run in case of success
+        def good(&block)
+          @good_proc = block
+        end
+
+        # Returns the prefered error method block, based on the +on_error+
+        # setting.
+        #
+        # @return [Proc] the error block we should use
+        def error_proc
+          return fail_proc if on_error == :fail
+
+          -> { raise bang_proc.call }
+        end
+
+        # Evaluate the decision.
+        #
+        # @yield Runtime to collect the settings and the result
+        # @return [Mixed] the result of the decision (good|fail|bang) block
+        def evaluate
+          result = yield(self)
+          result ? good_proc.call : error_proc.call
+        end
+      end
+    end
+  end
+end

data/lib/pricehubble/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module PriceHubble
+  # The version of the +price-hubble+ gem
+  VERSION = '0.1.0'
+end

data/lib/pricehubble.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/concern'
+require 'active_support/configurable'
+require 'active_support/time'
+require 'active_support/time_with_zone'
+require 'active_support/core_ext/object'
+require 'active_support/core_ext/module'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/string'
+require 'active_model'
+require 'recursive-open-struct'
+require 'faraday'
+require 'faraday_middleware'
+require 'pp'
+
+# Load polyfills if needed
+require 'pricehubble/core_ext/hash'
+
+# The top level namespace for the PriceHubble gem.
+module PriceHubble
+  # Top level elements
+  autoload :Configuration, 'pricehubble/configuration'
+  autoload :ConfigurationHandling, 'pricehubble/configuration_handling'
+  autoload :Client, 'pricehubble/client'
+  autoload :Identity, 'pricehubble/identity'
+
+  # Entities
+  autoload :BaseEntity, 'pricehubble/entity/base_entity'
+  autoload :Authentication, 'pricehubble/entity/authentication'
+  autoload :Valuation, 'pricehubble/entity/valuation'
+  autoload :ValuationScores, 'pricehubble/entity/valuation_scores'
+  autoload :ValuationRequest, 'pricehubble/entity/valuation_request'
+  autoload :Property, 'pricehubble/entity/property'
+  autoload :PropertyConditions, 'pricehubble/entity/property_conditions'
+  autoload :PropertyQualities, 'pricehubble/entity/property_qualities'
+  autoload :PropertyType, 'pricehubble/entity/property_type'
+  autoload :Location, 'pricehubble/entity/location'
+  autoload :Address, 'pricehubble/entity/address'
+  autoload :Coordinates, 'pricehubble/entity/coordinates'
+
+  # Some general purpose utilities
+  module Utils
+    autoload :Decision, 'pricehubble/utils/decision'
+    autoload :Bangers, 'pricehubble/utils/bangers'
+  end
+
+  # Dedicated application HTTP (low level) client
+  module Client
+    # All our utilities used for the low level client
+    module Utils
+      autoload :Request, 'pricehubble/client/utils/request'
+      autoload :Response, 'pricehubble/client/utils/response'
+    end
+
+    # Faraday request middlewares
+    module Request
+      autoload :DataSanitization, 'pricehubble/client/request/data_sanitization'
+      autoload :DefaultHeaders, 'pricehubble/client/request/default_headers'
+    end
+
+    # Faraday response middlewares
+    module Response
+      autoload :DataSanitization,
+               'pricehubble/client/response/data_sanitization'
+      autoload :RecursiveOpenStruct,
+               'pricehubble/client/response/recursive_open_struct'
+    end
+
+    autoload :Base, 'pricehubble/client/base'
+    autoload :Authentication, 'pricehubble/client/authentication'
+    autoload :Valuation, 'pricehubble/client/valuation'
+  end
+
+  # Separated features of an entity instance
+  module EntityConcern
+    autoload :Callbacks, 'pricehubble/entity/concern/callbacks'
+    autoload :Attributes, 'pricehubble/entity/concern/attributes'
+    autoload :Associations, 'pricehubble/entity/concern/associations'
+    autoload :Client, 'pricehubble/entity/concern/client'
+
+    # Some custom typed attribute helpers
+    module Attributes
+      base = 'pricehubble/entity/concern/attributes'
+      autoload :DateArray, "#{base}/date_array"
+      autoload :Enum, "#{base}/enum"
+      autoload :Range, "#{base}/range"
+      autoload :StringInquirer, "#{base}/string_inquirer"
+    end
+  end
+
+  # Load standalone code
+  require 'pricehubble/version'
+  require 'pricehubble/errors'
+  require 'pricehubble/faraday'
+  require 'pricehubble/railtie' if defined? Rails
+
+  # Include top-level features
+  include PriceHubble::ConfigurationHandling
+  include PriceHubble::Client
+  include PriceHubble::Identity
+end

data/pricehubble.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pricehubble/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pricehubble'
+  spec.version       = PriceHubble::VERSION
+  spec.authors       = ['Hermann Mayer']
+  spec.email         = ['hermann.mayer92@gmail.com']
+
+  spec.summary       = 'Ruby client for the PriceHubble REST API'
+  spec.description   = 'Ruby client for the PriceHubble REST API'
+  spec.homepage      = 'https://github.com/hausgold/pricehubble'
+
+  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_runtime_dependency 'activemodel', '>= 4.2.0'
+  spec.add_runtime_dependency 'activesupport', '>= 4.2.0'
+  spec.add_runtime_dependency 'faraday', '~> 0.15'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.12'
+  spec.add_runtime_dependency 'recursive-open-struct', '~> 1.1'
+
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'bundler', '>= 1.16', '< 3'
+  spec.add_development_dependency 'factory_bot', '~> 4.11'
+  spec.add_development_dependency 'railties', '>= 4.2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rdoc', '~> 6.1'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.63.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.31'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+  spec.add_development_dependency 'terminal-table', '~> 1.8'
+  spec.add_development_dependency 'timecop', '~> 0.9.1'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.5'
+  spec.add_development_dependency 'yard', '~> 0.9.18'
+  spec.add_development_dependency 'yard-activesupport-concern', '~> 0.0.1'
+end

metadata

@@ -0,0 +1,432 @@
+--- !ruby/object:Gem::Specification
+name: pricehubble
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hermann Mayer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+- !ruby/object:Gem::Dependency
+  name: yard-activesupport-concern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: Ruby client for the PriceHubble REST API
+email:
+- hermann.mayer92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- ".yardopts"
+- Appraisals
+- CHANGELOG.md
+- Dockerfile
+- Envfile
+- Gemfile
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/run
+- bin/setup
+- config/docker/.bash_profile
+- config/docker/.bashrc
+- config/docker/.inputrc
+- doc/assets/project.svg
+- doc/examples/authentication.rb
+- doc/examples/complex_property_valuations.rb
+- doc/examples/config.rb
+- doc/examples/property_valuations_errors.rb
+- doc/examples/simple_property_valuations.rb
+- docker-compose.yml
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
+- lib/price_hubble.rb
+- lib/pricehubble.rb
+- lib/pricehubble/client.rb
+- lib/pricehubble/client/authentication.rb
+- lib/pricehubble/client/base.rb
+- lib/pricehubble/client/request/data_sanitization.rb
+- lib/pricehubble/client/request/default_headers.rb
+- lib/pricehubble/client/response/data_sanitization.rb
+- lib/pricehubble/client/response/recursive_open_struct.rb
+- lib/pricehubble/client/utils/request.rb
+- lib/pricehubble/client/utils/response.rb
+- lib/pricehubble/client/valuation.rb
+- lib/pricehubble/configuration.rb
+- lib/pricehubble/configuration_handling.rb
+- lib/pricehubble/core_ext/hash.rb
+- lib/pricehubble/entity/address.rb
+- lib/pricehubble/entity/authentication.rb
+- lib/pricehubble/entity/base_entity.rb
+- lib/pricehubble/entity/concern/associations.rb
+- lib/pricehubble/entity/concern/attributes.rb
+- lib/pricehubble/entity/concern/attributes/date_array.rb
+- lib/pricehubble/entity/concern/attributes/enum.rb
+- lib/pricehubble/entity/concern/attributes/range.rb
+- lib/pricehubble/entity/concern/attributes/string_inquirer.rb
+- lib/pricehubble/entity/concern/callbacks.rb
+- lib/pricehubble/entity/concern/client.rb
+- lib/pricehubble/entity/coordinates.rb
+- lib/pricehubble/entity/location.rb
+- lib/pricehubble/entity/property.rb
+- lib/pricehubble/entity/property_conditions.rb
+- lib/pricehubble/entity/property_qualities.rb
+- lib/pricehubble/entity/property_type.rb
+- lib/pricehubble/entity/valuation.rb
+- lib/pricehubble/entity/valuation_request.rb
+- lib/pricehubble/entity/valuation_scores.rb
+- lib/pricehubble/errors.rb
+- lib/pricehubble/faraday.rb
+- lib/pricehubble/identity.rb
+- lib/pricehubble/railtie.rb
+- lib/pricehubble/utils/bangers.rb
+- lib/pricehubble/utils/decision.rb
+- lib/pricehubble/version.rb
+- pricehubble.gemspec
+homepage: https://github.com/hausgold/pricehubble
+licenses: []
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Ruby client for the PriceHubble REST API
+test_files: []