dhc 1.0.0

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DHC'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+end
+
+Bundler::GemHelper.install_tasks

data/dhc.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+# Maintain your gem's version:
+require 'dhc/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'dhc'
+  s.version     = DHC::VERSION
+  s.authors     = ['https://github.com/DePayFi/dhc/contributors']
+  s.email       = ['engineering@depay.fi']
+  s.homepage    = 'https://github.com/DePayFi/dhc'
+  s.summary     = 'Advanced HTTP Client for Ruby, fueled with interceptors'
+  s.description = 'DHC is an advanced HTTP client. Implementing basic http-communication enhancements like interceptors, exception handling, format handling, accessing response data, configuring endpoints and placeholders and fully compatible, RFC-compliant URL-template support.'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.requirements << 'Ruby >= 2.0.0'
+  s.required_ruby_version = '>= 2.7.0'
+
+  s.add_dependency 'activesupport', '>= 5.2'
+  s.add_dependency 'addressable'
+  s.add_dependency 'typhoeus', '>= 0.11'
+
+  s.add_development_dependency 'prometheus-client', '~> 0.7.1'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rails', '>= 5.2'
+  s.add_development_dependency 'redis'
+  s.add_development_dependency 'rspec-rails', '>= 3.0.0'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'timecop'
+  s.add_development_dependency 'webmock'
+
+  s.license = 'GPL-3.0'
+end

data/lib/core_ext/hash/deep_transform_values.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# This was copied from: https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/deep_transform_values.rb
+class Hash
+  # Returns a new hash with all values converted by the block operation.
+  # This includes the values from the root hash and from all
+  # nested hashes and arrays.
+  #
+  #  hash = { person: { name: 'Rob', age: '28' } }
+  #
+  #  hash.deep_transform_values{ |value| value.to_s.upcase }
+  #  # => {person: {name: "ROB", age: "28"}}
+  def deep_transform_values(&block)
+    _deep_transform_values_in_object(self, &block)
+  end
+
+  # Destructively converts all values by using the block operation.
+  # This includes the values from the root hash and from all
+  # nested hashes and arrays.
+  def deep_transform_values!(&block)
+    _deep_transform_values_in_object!(self, &block)
+  end
+
+  private
+
+  # support methods for deep transforming nested hashes and arrays
+  def _deep_transform_values_in_object(object, &block)
+    case object
+    when Hash
+      object.transform_values { |value| _deep_transform_values_in_object(value, &block) }
+    when Array
+      object.map { |e| _deep_transform_values_in_object(e, &block) }
+    else
+      yield(object)
+    end
+  end
+
+  def _deep_transform_values_in_object!(object, &block)
+    case object
+    when Hash
+      object.transform_values! { |value| _deep_transform_values_in_object!(value, &block) }
+    when Array
+      object.map! { |e| _deep_transform_values_in_object!(e, &block) }
+    else
+      yield(object)
+    end
+  end
+end

data/lib/dhc.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'typhoeus'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/keys'
+
+module DHC
+  autoload :BasicMethodsConcern, 'dhc/concerns/dhc/basic_methods_concern'
+  autoload :ConfigurationConcern, 'dhc/concerns/dhc/configuration_concern'
+  autoload :FixInvalidEncodingConcern, 'dhc/concerns/dhc/fix_invalid_encoding_concern'
+  autoload :FormatsConcern, 'dhc/concerns/dhc/formats_concern'
+
+  include BasicMethodsConcern
+  include ConfigurationConcern
+  include FormatsConcern
+
+  autoload :Auth, 'dhc/interceptors/auth'
+  autoload :Caching, 'dhc/interceptors/caching'
+  autoload :DefaultTimeout, 'dhc/interceptors/default_timeout'
+  autoload :Logging, 'dhc/interceptors/logging'
+  autoload :Prometheus, 'dhc/interceptors/prometheus'
+  autoload :Retry, 'dhc/interceptors/retry'
+  autoload :Throttle, 'dhc/interceptors/throttle'
+
+  autoload :Config, 'dhc/config'
+  autoload :Endpoint, 'dhc/endpoint'
+
+  autoload :Error, 'dhc/error'
+  autoload :ClientError, 'dhc/errors/client_error'
+  autoload :BadRequest, 'dhc/errors/client_error'
+  autoload :Unauthorized, 'dhc/errors/client_error'
+  autoload :PaymentRequired, 'dhc/errors/client_error'
+  autoload :Forbidden, 'dhc/errors/client_error'
+  autoload :Forbidden, 'dhc/errors/client_error'
+  autoload :NotFound, 'dhc/errors/client_error'
+  autoload :MethodNotAllowed, 'dhc/errors/client_error'
+  autoload :NotAcceptable, 'dhc/errors/client_error'
+  autoload :ProxyAuthenticationRequired, 'dhc/errors/client_error'
+  autoload :RequestTimeout, 'dhc/errors/client_error'
+  autoload :Conflict, 'dhc/errors/client_error'
+  autoload :Gone, 'dhc/errors/client_error'
+  autoload :LengthRequired, 'dhc/errors/client_error'
+  autoload :PreconditionFailed, 'dhc/errors/client_error'
+  autoload :RequestEntityTooLarge, 'dhc/errors/client_error'
+  autoload :RequestUriToLong, 'dhc/errors/client_error'
+  autoload :UnsupportedMediaType, 'dhc/errors/client_error'
+  autoload :RequestedRangeNotSatisfiable, 'dhc/errors/client_error'
+  autoload :ExpectationFailed, 'dhc/errors/client_error'
+  autoload :UnprocessableEntity, 'dhc/errors/client_error'
+  autoload :Locked, 'dhc/errors/client_error'
+  autoload :FailedDependency, 'dhc/errors/client_error'
+  autoload :UpgradeRequired, 'dhc/errors/client_error'
+  autoload :ParserError, 'dhc/errors/parser_error'
+  autoload :ServerError, 'dhc/errors/server_error'
+  autoload :InternalServerError, 'dhc/errors/server_error'
+  autoload :NotImplemented, 'dhc/errors/server_error'
+  autoload :BadGateway, 'dhc/errors/server_error'
+  autoload :ServiceUnavailable, 'dhc/errors/server_error'
+  autoload :GatewayTimeout, 'dhc/errors/server_error'
+  autoload :HttpVersionNotSupported, 'dhc/errors/server_error'
+  autoload :InsufficientStorage, 'dhc/errors/server_error'
+  autoload :NotExtended, 'dhc/errors/server_error'
+  autoload :Timeout, 'dhc/errors/timeout'
+  autoload :UnknownError, 'dhc/errors/unknown_error'
+
+  autoload :Interceptor, 'dhc/interceptor'
+  autoload :Interceptors, 'dhc/interceptors'
+  autoload :Formats, 'dhc/formats'
+  autoload :Format, 'dhc/format'
+  autoload :Monitoring, 'dhc/interceptors/monitoring'
+  autoload :Request, 'dhc/request'
+  autoload :Response, 'dhc/response'
+  autoload :Rollbar, 'dhc/interceptors/rollbar'
+  autoload :Zipkin, 'dhc/interceptors/zipkin'
+
+  require 'dhc/railtie' if defined?(Rails)
+end

data/lib/dhc/concerns/dhc/basic_methods_concern.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+module DHC
+  module BasicMethodsConcern
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def request(options)
+        if options.is_a? Array
+          parallel_requests(options)
+        else
+          DHC::Request.new(options).response
+        end
+      end
+
+      %i[get post put delete].each do |http_method|
+        define_method(http_method) do |url, options = {}|
+          request(options.merge(
+                    url: url,
+                    method: http_method
+                  ))
+        end
+      end
+
+      private
+
+      def parallel_requests(options)
+        hydra = Typhoeus::Hydra.new # do not use memoization !
+        requests = []
+        options.each do |option|
+          request = DHC::Request.new(option, false)
+          requests << request
+          hydra.queue request.raw unless request.response.present?
+        end
+        hydra.run
+        requests.map(&:response)
+      end
+    end
+  end
+end

data/lib/dhc/concerns/dhc/configuration_concern.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+module DHC
+  module ConfigurationConcern
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def config
+        DHC::Config.instance
+      end
+
+      def configure
+        DHC::Config.instance.reset
+        yield config
+      end
+    end
+  end
+end

data/lib/dhc/concerns/dhc/fix_invalid_encoding_concern.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+module DHC
+  module FixInvalidEncodingConcern
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # fix strings that contain non-UTF8 encoding in a forceful way
+      # should none of the fix-attempts be successful,
+      # an empty string is returned instead
+      def fix_invalid_encoding(string)
+        return string unless string.is_a?(String)
+        result = string.dup
+
+        # we assume it's ISO-8859-1 first
+        if !result.valid_encoding? || !utf8?(result)
+          result.encode!('UTF-8', 'ISO-8859-1', invalid: :replace, undef: :replace, replace: '')
+        end
+
+        # if it's still an issue, try with BINARY
+        if !result.valid_encoding? || !utf8?(result)
+          result.encode!('UTF-8', 'BINARY', invalid: :replace, undef: :replace, replace: '')
+        end
+
+        # if its STILL an issue, return an empty string :(
+        if !result.valid_encoding? || !utf8?(result)
+          result = ''
+        end
+
+        result
+      end
+
+      private
+
+      def utf8?(string)
+        string.encoding == Encoding::UTF_8
+      end
+    end
+  end
+end

data/lib/dhc/concerns/dhc/formats_concern.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DHC
+  module FormatsConcern
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def form
+        DHC::Formats::Form
+      end
+
+      def json
+        DHC::Formats::JSON
+      end
+
+      def multipart
+        DHC::Formats::Multipart
+      end
+
+      def plain
+        DHC::Formats::Plain
+      end
+    end
+  end
+end

data/lib/dhc/concerns/dhc/request/user_agent_concern.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'dhc/version'
+
+module DHC
+  class Request
+    module UserAgentConcern
+      extend ActiveSupport::Concern
+
+      included do
+        Typhoeus::Config.user_agent = begin
+          version = DHC::VERSION
+          application = nil
+          if defined?(Rails)
+            app_class = Rails.application.class
+            application = (ActiveSupport.gem_version >= Gem::Version.new('6.0.0')) ? app_class.module_parent_name : app_class.parent_name
+          end
+
+          "DHC (#{[version, application].compact.join('; ')}) [https://github.com/DePayFi/dhc]"
+        end
+      end
+    end
+  end
+end

data/lib/dhc/config.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+class DHC::Config
+  include Singleton
+
+  def initialize
+    @endpoints = {}
+    @placeholders = {}
+  end
+
+  def endpoint(name, url, options = {})
+    name = name.to_sym
+    raise 'Endpoint already exists for that name' if @endpoints[name]
+    @endpoints[name] = DHC::Endpoint.new(url, options)
+  end
+
+  def endpoints
+    @endpoints.dup
+  end
+
+  def placeholder(name, value)
+    name = name.to_sym
+    raise 'Placeholder already exists for that name' if @placeholders[name]
+    @placeholders[name] = value
+  end
+
+  def placeholders
+    @placeholders.dup
+  end
+
+  def interceptors
+    (@interceptors || []).dup
+  end
+
+  def interceptors=(interceptors)
+    raise 'Default interceptors already set and can only be set once' if @interceptors
+    @interceptors = interceptors
+  end
+
+  def reset
+    @endpoints = {}
+    @placeholders = {}
+    @interceptors = nil
+  end
+end

data/lib/dhc/endpoint.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'addressable/template'
+
+# An endpoint is an url that leads to a backend resource.
+# The url can also be an url-template (https://tools.ietf.org/html/rfc6570).
+class DHC::Endpoint
+  attr_accessor :url
+  attr_writer :options
+
+  def initialize(url, options = nil)
+    self.url = url
+    self.options = options
+  end
+
+  def uri
+    @uri ||= Addressable::Template.new(url)
+  end
+
+  def compile(params)
+    context = DHC.config.placeholders.deep_dup
+    context.merge!(params) if params.is_a?(Hash)
+    expanded = uri.partial_expand(context)
+
+    if expanded.variables.empty?
+      expanded.pattern
+    else
+      raise("Compilation incomplete. Unable to find value for #{expanded.variables.join(', ')}.")
+    end
+  end
+
+  # Endpoint options are immutable
+  def options
+    @options.deep_dup
+  end
+
+  # Removes keys from provided params hash
+  # when they are used for interpolation.
+  def remove_interpolated_params!(params)
+    params ||= {}
+    removed = params.slice(*placeholders)
+    params.except!(*placeholders)
+
+    removed
+  end
+
+  # Returns all placeholders found in the url-template.
+  # They are alphabetically sorted.
+  def placeholders
+    uri.variables.sort.map(&:to_sym)
+  end
+
+  # Compares a concrete url with a template
+  # Returns true if concrete url is covered by the template
+  # Example: {+datastore}/contracts/{id} == http://depay.fi/contracts/1
+  def match?(url)
+    return true if url == uri.pattern
+    match_data = match_data(url)
+    return false if match_data.nil?
+
+    first = match_data.values.first
+    last = match_data.values.last
+    url_format = File.extname(url)
+
+    # eliminate false positives in form:
+    # http://host/feedbacks matches {+service}/{entry_id}/feedbacks (service: http:/, entry_id: host)
+    first&.match(%(https?:/$)).nil? &&
+      # eliminates false positives in form:
+      # http://host/entries/123.json matches {+service}/entries/{id} (service: http://host, id: 123.json)
+      (url_format.blank? || !last&.ends_with?(url_format))
+  end
+
+  # Extracts the values from url and
+  # creates params according to template
+  def values_as_params(url)
+    match_data = match_data(url)
+    return if match_data.nil?
+    Hash[match_data.variables.map(&:to_sym).zip(match_data.values)]
+  end
+
+  # Checks if the name has a match in the current context
+  def find_value(name, mapping)
+    context = DHC.config.placeholders.deep_dup
+    context.merge!(mapping)
+
+    context[name]
+  end
+
+  # Compares a concrete url with a template
+  # Returns true if concrete url is covered by the template
+  # Example: {+datastore}/contracts/{id} == http://depay.fi/contracts/1
+  def self.match?(url, template)
+    new(template).match?(url)
+  end
+
+  # Returns all placeholders found in the url-template.
+  # They are alphabetically sorted.
+  def self.placeholders(template)
+    new(template).placeholders
+  end
+
+  # Extracts the values from url and
+  # creates params according to template
+  def self.values_as_params(template, url)
+    raise("#{url} does not match the template: #{template}") unless match?(url, template)
+    new(template).values_as_params(url)
+  end
+
+  private
+
+  def match_data(url)
+    parsed = URI.parse(url)
+    parsed.query = parsed.fragment = nil
+
+    uri.match(parsed)
+  rescue URI::InvalidURIError
+    nil
+  end
+end