foucault_http 0.4.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 230f82f3bcdc3ad709f3a2eb94d44b58c560cdf06ca68f6531c0a9687657e399
+  data.tar.gz: e258866c64df1ca8f8274e81df9a4515d7e5bbd9cc79b1fca7dec1ab2319a825
+SHA512:
+  metadata.gz: 3709b74c8248071487dc0dea1f32a5a4b0237c910134effc9e186ec3660316ac8147cec74867b6a4b43d21d3c792f7a3fa8fcdcc43dc35e8ab95dcc0e42144e5
+  data.tar.gz: 895c4695e88caa9191e7ab85beb034028b07b2ee4b0b625c587192e2a65a690911860fb14f425e0353b4bef2207fe87843e66f8c06aa58f329a8dc362cdc4ba5

data/.gitignore

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

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at wild.fauve@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Col Perks
+
+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,127 @@
+# Foucault
+
+Foucault plays with a functional interface for wrapping network service calls.  Not exactly very functional, as the network is a touch mutating.  However, its an attempt to leverage a little of that Ruby lambda magic to describe another method of wrapping classes.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'foucault_http'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install foucault_http
+
+## Usage
+
+`FoucaultHttp::Net` contains the main functions for HTTP wrappers.  All the wrappers are defined as curried functions.  So it is OK to partially apply in the argument order.
+
+## Configuration
+
+You provide configuration through the object
+
+```ruby
+FoucaultHttp::Configuration.configure do |config|
+  config.logger                = SomeLogger         # Any class that responds to the log level methods with a single param
+                                                    # (a string or hash if you're using a structured log format)
+  config.network_log_formatter = SomeLogFormatter   # A class which inherits from Faraday::Logging::Formatter
+  config.logging_level         = :info
+end
+```
+
+### HTTP
+
+#### Post
+
+The `post` fn takes the following arguments in this order:
++ `correlation`. A hash of name value pairs to be logged.  Default is `{}`
++ `service`.  The http host.  It will be combined with the `resource` to form a url.
++ `resource`.  The resource making up the URL.
++ `hdrs`.  A hash of HTTP headers.
++ `enc`.  The default encoding for the body.
++ `body_fn`.  A fn with which to serialise the body.  The functions are available in the `FoucaultHttp::Net` class.  They are:
+  + `json_body_fn`.  Converts the body to JSON.
++ `body`.  The body to send to the service/resource
+
+Example:  This shows the use of partial application.  You can just as easily combine the arguments into a single argument list.
+
+```ruby
+FoucaultHttp::Net.post.({}, "http://api.example.com").("/resource").(nil).(nil).(FoucaultHttp::Net.json_body_fn).({message: "some message"})
+```
+
+#### Get
+
+The `get` fn takes the following arguments in this order:
++ `correlation`
++ `service`
++ `resource`
++ `hdrs`
++ `enc`
++ `query`
+
+For example:
+
+```ruby
+FoucaultHttp::Net.get.({}, "http://api.example.com", "/resource").({authorization: "uid:pwd"}).(:url_encoded).({param1: 1})
+```
+
+#### Helper Functions
+
+1. Basic Authentication Header Encoder.  Creates an `Authorization` header appropriately encoded for basic auth.
+
+```ruby
+FoucaultHttp::Net.basic_auth_header.("client_id").("secret")
+```
+
+2. Header builder.  Takes any number of individual arguments which evaluate to Hashes and combines them into a single hash.  Not really that interesting, you can always throw in your own `merge`
+
+```ruby
+FoucaultHttp::Net.header_builder.(FoucaultHttp::Net.basic_auth_header.("userid", "password"), {content_type: "application/json"})
+```
+
+### Return Object
+
+All network functions return a `FoucaultHttp::NetResponseValue` wrapped in a `Result` monad.
+
+So, for example, you might test and extract the results as follows:
+
+```ruby
+result = FoucaultHttp::Net.post.("http://api.example.com").("/resource").({}).(nil).(FoucaultHttp::Net.json_body_fn).({message: "some message"})
+
+result.success?   # or result.failure?
+result.value_or.status   # => :ok
+result.value_or.body     # => some returned structure.
+```
+
+The `FoucaultHttp::NetResponseValue` generalises the network states as follows:
+
++ `:ok`; its all good.
++ `:fail`; the network request happened, but failed for some reason (such as resource not found)
++ `:unauthorised`; no access to the service.
++ `:system_failure`; a failures before the service; such as network problems.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wildfauve/foucault_http. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Foucault project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/foucault/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "foucault"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start(__FILE__)

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/foucault_http.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "foucault_http/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "foucault_http"
+  spec.version       = FoucaultHttp::VERSION
+  spec.authors       = ["Col Perks"]
+  spec.email         = ["wild.fauve@gmail.com"]
+
+  spec.summary       = %q{Http Network Functions}
+  spec.description   = %q{Http Network Functions.}
+  spec.homepage      = "https://github.com/wildfauve/foucault_http"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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_dependency 'stoplight'
+  spec.add_dependency 'dry-monads', "~> 1.0"
+  spec.add_dependency 'dry-configurable'
+  spec.add_dependency 'funcify'
+  spec.add_dependency 'typhoeus'
+  spec.add_dependency 'faraday', '~> 1.0'
+  spec.add_dependency "dry-types"
+  spec.add_dependency "dry-struct"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/lib/foucault_http.rb

@@ -0,0 +1,27 @@
+require "foucault_http/version"
+require 'dry/monads/result'
+require 'dry/monads/maybe'
+require 'dry-struct'
+require 'dry-types'
+require 'dry-configurable'
+require 'funcify'
+
+module Types
+  include Dry.Types
+end
+
+module FoucaultHttp
+  require 'foucault_http/logger'
+  require 'foucault_http/logging'
+
+  require 'foucault_http/net'
+  require 'foucault_http/circuit'
+  require 'foucault_http/configuration'
+  require 'foucault_http/http_connection'
+  require 'foucault_http/http_port'
+  require 'foucault_http/net_response_value'
+  require 'foucault_http/monad_exception'
+
+  Fn    = Funcify::Fn
+  Monad = Funcify::Monad
+end

data/lib/foucault_http/circuit.rb

@@ -0,0 +1,81 @@
+require 'stoplight'
+
+module FoucaultHttp
+
+  class Circuit
+
+    include Dry::Monads::Result::Mixin
+
+    class MonadFailure < StandardError ; end
+
+    MAX_RETRIES = 3
+
+    include Logging
+
+    attr_reader :circuit
+
+    class << self
+
+      # Provides a wrapper fn that allows a monad result to be thrown as an exception so that
+      # Stoplight can execute retry behaviour.
+      def monad_circuit_wrapper_fn
+        -> caller { result = caller.(); result.success? ? result : raise(FoucaultHttp::MonadException.new(result: result)) }
+      end
+    end
+
+    def initialize(name:, max_retries: MAX_RETRIES)
+      # redis = Redis.new
+      # datastore = Stoplight::DataStore::Redis.new(redis)
+      # Stoplight::Light.default_data_store = datastore
+      @name = name
+      @max_retries = max_retries
+    end
+
+    def call(circuit_fn: , caller: nil)
+      info(msg: "CircuitBreaker: #{circuit_to_s}", service_name: @name)
+      @circuit = if caller.nil?
+                    Stoplight(@name) { circuit_fn.() }.with_threshold(@max_retries).with_cool_off_time(10)
+                  else
+                    Stoplight(@name) { circuit_fn.(caller) }.with_threshold(@max_retries).with_cool_off_time(10)#.with_fallback {|e| binding.pry; e.result}
+                  end
+      run(@circuit)
+    end
+
+    def run(circuit)
+      begin
+        circuit.run
+      rescue Stoplight::Error::RedLight => e
+        info({msg: "CircuitBreaker: #{circuit_to_s}", service_name: @name, circuit_state: "red"})
+        @last_error
+      rescue FoucaultHttp::MonadException => e
+        @last_error = e.result
+        retry
+      rescue StandardError => e
+        @last_error = e
+        retry
+      end
+    end
+
+    def failures
+      Stoplight::Light.default_data_store.get_failures(@circuit)
+    end
+
+    def colour
+      @circuit.color
+    end
+
+    def circuit_failure
+      NetResponseValue.new(
+        status: NetResponseValue::CIRCUIT_RED,
+        body: nil,
+        code: 500
+      )
+    end
+
+    def circuit_to_s
+      "Circuit: #{@name}"
+    end
+
+  end
+
+end

data/lib/foucault_http/configuration.rb

@@ -0,0 +1,15 @@
+module FoucaultHttp
+
+  class Configuration
+
+    extend Dry::Configurable
+
+    setting :type_parsers, {}
+    setting :logger
+    setting :log_formatter
+    setting :network_log_formatter
+    setting :logging_level
+
+  end  # class Configuration
+
+end  # module ScoreCard

data/lib/foucault_http/http_connection.rb

@@ -0,0 +1,71 @@
+require 'faraday'
+require 'faraday/logging/formatter'
+require 'typhoeus'
+
+module FoucaultHttp
+
+  class HttpConnection
+
+    include Dry::Monads::Try::Mixin
+    include Dry::Monads::Result::Mixin
+
+    HTTP_CONNECTION_FAILURE = :http_connection_failure
+
+    def connection(address, encoding, cache_store = nil, instrumenter = nil)
+      @http_connection = Try { http_connection(address, encoding, cache_store, instrumenter) }
+      self
+    end
+
+    def get(hdrs, params)
+      return @http_connection.to_result if @http_connection.failure?
+      Try {
+        @http_connection.value_or.get do |r|
+          r.headers = hdrs if hdrs
+          r.params = params if params
+        end
+      }.to_result
+    end
+
+    def post(hdrs, body)
+      return @http_connection.to_result if @http_connection.failure?
+      Try {
+        @http_connection.value_or.post do |r|
+          r.body = body
+          r.headers = hdrs
+        end
+      }.to_result
+    end
+
+    def delete(hdrs)
+      return @http_connection.to_result if @http_connection.failure?
+      Try {
+        @http_connection.value_or.delete do |r|
+          r.headers = hdrs
+        end
+      }.to_result
+    end
+
+    private
+
+    def http_connection(address, encoding, cache_store, instrumenter)
+      faraday_connection = Faraday.new(:url => address) do |faraday|
+        # faraday.use :http_cache, caching if caching
+        faraday.request  encoding if encoding
+        if Configuration.config.logger && Configuration.config.log_formatter
+          faraday.response :logger, Configuration.config.logger, formatter: Configuration.config.network_log_formatter
+        elsif Configuration.config.logger
+          faraday.response :logger, Configuration.config.logger
+        else
+          faraday.response :logger do |log|
+            log.filter(/(Bearer.)(.+)/, '\1[REMOVED]')
+            log.filter(/(Basic.)(.+)/, '\1[REMOVED]')
+          end
+        end
+        faraday.adapter  :typhoeus
+      end
+      faraday_connection
+    end
+
+  end
+
+end

data/lib/foucault_http/http_port.rb

@@ -0,0 +1,222 @@
+module FoucaultHttp
+
+  class HttpPort
+
+    class NoContentTypeError < StandardError; end
+
+    extend Dry::Monads::Try::Mixin
+    extend Logging
+
+    FAIL                 = :fail
+    OK                   = :ok
+    BAD_REQUEST          = :bad_request
+    UNAUTHORISED         = :unauthorised
+    NOT_FOUND            = :not_found
+    SYSTEM_FAILURE       = :system_failure
+    UNPROCESSABLE_ENTITY = :unprocessable_entity
+
+    class << self
+
+      def post
+        -> correlation, service, resource, hdrs, body_fn, enc, body {
+          ( Fn.either.(net_ok).(Monad.success).(Monad.failure) <<
+            log_response.(correlation, service, resource, __method__) <<
+            response_value <<
+            run_post.(hdrs, body_fn, body) <<
+            addressed.(service, resource)).(connection.(enc))
+        }
+      end
+
+      def get
+        -> correlation, service, resource, hdrs, enc, query {
+          ( Fn.either.(net_ok).(Monad.success).(Monad.failure) <<
+            log_response.(correlation, service, resource, __method__) <<
+            response_value <<
+            run_get.(hdrs, query) <<
+            addressed.(service, resource)).(connection.(enc))
+        }
+      end
+
+      def delete
+        -> correlation, service, resource, hdrs {
+          ( Fn.either.(net_ok).(Monad.success).(Monad.failure) <<
+            log_response.([], service, resource, __method__) <<
+            response_value <<
+            run_delete.(hdrs) <<
+            addressed.(service, resource)).(connection.(nil))
+        }
+      end
+
+
+      def run_post
+        -> hdrs, body_fn, body, connection {
+          connection.post(hdrs, body_fn.(body))
+        }.curry
+      end
+
+      def run_get
+        -> hdrs, query, connection {
+          connection.get(hdrs, query)
+        }.curry
+      end
+
+      def run_delete
+        -> hdrs, connection {
+          connection.delete(hdrs)
+        }.curry
+      end
+
+      def addressed
+        -> service, resource, connection {
+          connection.(address.(service, resource))
+        }.curry
+      end
+
+      def connection
+        -> encoding, address { HttpConnection.new.connection(address, encoding) }.curry
+      end
+
+      def address
+        -> service, resource {
+          (service || "") + (resource || "")
+        }.curry
+      end
+
+      def response_value
+        -> response {
+          response.success? ? try_handle_response(response) : catastrophic_failure(response)
+        }
+      end
+
+      def log_response
+        -> correlation, service, resource, api, response {
+          info(structured_log(service, resource, api, response, correlation))
+          response
+        }.curry
+      end
+
+      def try_handle_response(response)
+        result = Try { returned_response(response) }
+        result.success? ? result.value_or : catastrophic_failure(result)
+      end
+
+      def evalulate_status
+        -> status {
+          case status
+          when 200..300
+            OK
+          when 400
+            BAD_REQUEST
+          when 401, 403
+            UNAUTHORISED
+          when 404
+            NOT_FOUND
+          when 422
+            UNPROCESSABLE_ENTITY
+          when 500..530
+            SYSTEM_FAILURE
+          else
+            FAIL
+          end
+        }
+      end
+
+      # takes a content type and returns a parser; e.g. "application/json; charset=utf-8" returns the json_parser
+      def response_body_parser
+        parser_fn <<
+        Fn.at.(0) <<
+        Fn.split.(";")
+      end
+
+      def parser_fn
+        -> type {
+          case type
+          when "text/html"
+            nil_parser
+          when "text/plain"
+            text_parser
+          when "text/csv"
+            text_parser
+          when "application/json"
+            json_parser
+          when "application/xml", "application/soap+xml", "text/xml"
+            nil_parser
+          else
+            nil_parser
+          end
+        }
+      end
+
+      def returned_response(response)
+        raise(NoContentTypeError.new("Content Type in response is nil")) unless response.value_or.headers["content-type"]
+        OpenStruct.new(
+          status: evalulate_status.(response.value_or.status),
+          code: response.value_or.status,
+          body: response_body_parser.(response.value_or.headers["content-type"]).(response.value_or)
+        )
+      end
+
+      def catastrophic_failure(response)
+        OpenStruct.new(
+          status: SYSTEM_FAILURE,
+          exception: parse_error_response(response),
+          code: 418
+        )
+      end
+
+      def parse_error_response(response)
+        result = response.to_result
+        if result.failure.respond_to?(:exception)
+          {exception_class: result.failure.exception.class.name, exception: result.failure.message}
+        else
+          {execepton: "not-determined"}
+        end
+      end
+
+      def json_parser
+        -> response { JSON.parse(response.body) }
+      end
+
+      def text_parser
+        -> response { response.body }
+      end
+
+      def text_csv
+        -> response { response.body }
+      end
+
+      def nil_parser
+        -> response { response.body }
+      end
+
+      def net_ok
+        -> value { value.status == OK }
+      end
+
+      def structured_log(service, resource, api, response, correlation={})
+        {
+          msg: "Common::Network::Net",
+          context: context_for_log(service, resource, response, correlation),
+          step: api,
+          status: response.status
+        }
+      end
+
+      def context_for_log(service, resource, response, correlation={})
+        {
+          http_code: response.code,
+          resource: address.(service, resource),
+          fail_response: log_of_failure(response)
+        }.merge(correlation || {})
+      end
+
+      def log_of_failure(response)
+        return nil if net_ok.(response)
+        response.body.inspect
+      end
+
+    end
+
+  end
+
+end

data/lib/foucault_http/logger.rb

@@ -0,0 +1,37 @@
+module FoucaultHttp
+
+  class Logger
+
+    FILTERS = ["password"]
+
+    def call(level, message)
+      logger.send(level, filtered(message)) if ( logger && logger.respond_to?(level) )
+    end
+
+    def configured_logger
+      logger
+    end
+
+    private
+
+    def logger
+      @logger ||= configuration.config.logger
+    end
+
+    def filtered(msg)
+      return unless msg.instance_of?(String)
+      filters = FILTERS.map { |f| msg.downcase.include? f }
+      if filters.any?
+        "[FILTERED]"
+      else
+        msg
+      end
+    end
+
+    def configuration
+      Configuration
+    end
+
+  end
+
+end

data/lib/foucault_http/logging.rb

@@ -0,0 +1,27 @@
+module FoucaultHttp
+
+  module Logging
+
+    def error(message)
+      logger.(:debug, message)
+    end
+
+    def debug(message)
+      logger.(:debug, message)
+    end
+
+    def info(message)
+      logger.(:info, message)
+    end
+
+    def fatal(message)
+      logger.(:fatal, message)
+    end
+
+    def logger
+      Logger.new
+    end
+
+  end
+
+end

data/lib/foucault_http/monad_exception.rb

@@ -0,0 +1,24 @@
+module FoucaultHttp
+
+  class MonadException < StandardError
+
+    attr_reader :error_code, :retryable, :result
+
+    def initialize(result: , code: nil, retryable: true)
+      self.error_code = code
+      @retryable = retryable
+      @result = result
+      super(nil)
+    end
+
+    def error_code=(code)
+      if code
+        @error_code = code
+      else
+        @error_code = "urn:port:error:#{self.class.to_s.downcase.gsub("::",":")}"
+      end
+    end
+
+  end
+
+end

data/lib/foucault_http/net.rb

@@ -0,0 +1,93 @@
+require 'base64'
+
+module FoucaultHttp
+
+  class Net
+
+    extend Dry::Monads::Try::Mixin
+
+    class << self
+
+      # Client interface
+      def post
+        -> correlation, service, resource, hdrs, enc, body_fn, body {
+          HttpPort.post.(correlation, service, resource, hdrs, body_fn, enc, body)
+        }.curry
+      end
+
+      def delete
+        -> correlation, service, resource, hdrs {
+          HttpPort.delete.(correlation, service, resource, hdrs)
+        }.curry
+      end
+
+      # @param service String
+      # @param resource String
+      # @param hdrs []
+      # @param enc String
+      # @param query
+      # @return Result(NetResponseValue)
+      # Example
+      # > get.(@env[:host], "/userinfo", {authorization: "Bearer <token> }, :url_encoded, {} )
+      def get
+        -> correlation, service, resource, hdrs, enc, query {
+            HttpPort.get.(correlation, service, resource, hdrs, enc, query)
+        }.curry
+      end
+
+      # That is, not a circuit breaker
+      # @param fn(Llambda)      : A partially applied fn
+      # @param args             : The function's arguments as either an array or hash
+      # @param retries(Integer) : The max number of retries
+      def retryer
+        -> fn, args, retries {
+          result = fn.(*args)
+          return result if result.success?
+          return result if retries == 0
+          retryer.(fn, args, retries - 1)
+        }.curry
+      end
+
+      def bearer_token_header
+        -> token {
+          { authorization: "Bearer #{token}"}
+        }
+      end
+      # (a -> a) -> Hash
+      # @param c [String] : Client or user
+      # @param s [String] : secret or password
+      # @return [Hash{Symbol=>String}]
+      def basic_auth_header
+        -> c, s {
+          { authorization: ("Basic " + Base64::strict_encode64("#{c}:#{s}")).chomp }
+        }.curry
+      end
+
+      def decode_basic_auth
+        -> encoded_auth {
+          result = Try { Base64::strict_decode64(encoded_auth.split(/\s+/).last) }
+          case result.success?
+          when true
+            Try { result.value_or.split(":") }
+          else
+            result
+          end
+        }
+      end
+
+      # @param  Array[Hash]
+      # @return [Hash{Symbol=>String}]
+      def header_builder
+        -> *hdrs { Fn.inject.({}).(Fn.merge).(hdrs) }
+      end
+
+      def json_body_fn
+        -> body { body.to_json }
+      end
+
+
+    end # class self
+
+  end
+
+end

data/lib/foucault_http/net_response_value.rb

@@ -0,0 +1,22 @@
+module FoucaultHttp
+
+  class NetResponseValue < Dry::Struct
+
+    FAIL                 = :fail
+    OK                   = :ok
+    BAD_REQUEST          = :bad_request
+    UNAUTHORISED         = :unauthorised
+    NOT_FOUND            = :not_found
+    SYSTEM_FAILURE       = :system_failure
+    UNPROCESSABLE_ENTITY = :unprocessable_entity
+    CIRCUIT_RED          = :circuit_red
+
+    NET_STATUS           = Types::Strict::Symbol.enum(OK, FAIL, BAD_REQUEST, UNAUTHORISED, NOT_FOUND, SYSTEM_FAILURE, UNPROCESSABLE_ENTITY, CIRCUIT_RED)
+
+    attribute :status,          NET_STATUS
+    attribute :code,            Types::Integer.optional
+    attribute :body,            Types::Nominal::Any.optional
+
+  end
+
+end

data/lib/foucault_http/version.rb

@@ -0,0 +1,3 @@
+module FoucaultHttp
+  VERSION = "0.4.8"
+end

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: foucault_http
+version: !ruby/object:Gem::Version
+  version: 0.4.8
+platform: ruby
+authors:
+- Col Perks
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stoplight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: funcify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !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: pry
+  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'
+description: Http Network Functions.
+email:
+- wild.fauve@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- foucault_http.gemspec
+- lib/.gitignore
+- lib/foucault_http.rb
+- lib/foucault_http/circuit.rb
+- lib/foucault_http/configuration.rb
+- lib/foucault_http/http_connection.rb
+- lib/foucault_http/http_port.rb
+- lib/foucault_http/logger.rb
+- lib/foucault_http/logging.rb
+- lib/foucault_http/monad_exception.rb
+- lib/foucault_http/net.rb
+- lib/foucault_http/net_response_value.rb
+- lib/foucault_http/version.rb
+homepage: https://github.com/wildfauve/foucault_http
+licenses:
+- MIT
+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.3
+signing_key: 
+specification_version: 4
+summary: Http Network Functions
+test_files: []