alchemrest 3.1.0

data/gemfiles/rails_8_0.gemfile.lock

@@ -0,0 +1,385 @@
+PATH
+  remote: ..
+  specs:
+    alchemrest (3.1.0)
+      activerecord (>= 7.2, < 8.1)
+      activesupport (>= 7.2, < 8.1)
+      circuitbox (~> 2.0.0)
+      faraday (>= 1.10, < 3.0)
+      memosa (>= 0.8.2)
+      money (>= 6.0)
+      morpher (>= 0.4.1)
+      multi_json (~> 1.0)
+      mustermann-contrib (>= 1.0)
+      railties (>= 7.2, < 8.1)
+      sentry-ruby
+      sorbet-runtime (>= 0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    actionpack (8.0.1)
+      actionview (= 8.0.1)
+      activesupport (= 8.0.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actionview (8.0.1)
+      activesupport (= 8.0.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activemodel (8.0.1)
+      activesupport (= 8.0.1)
+    activerecord (8.0.1)
+      activemodel (= 8.0.1)
+      activesupport (= 8.0.1)
+      timeout (>= 0.4.0)
+    activesupport (8.0.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    anima (0.3.2)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2)
+      equalizer (~> 0.0.11)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    betterlint (1.18.0)
+      rubocop (~> 1.71)
+      rubocop-graphql (~> 1.5)
+      rubocop-performance (~> 1.23)
+      rubocop-rails (~> 2.29)
+      rubocop-rake (~> 0.6)
+      rubocop-rspec (~> 2.29)
+    bigdecimal (3.1.9)
+    builder (3.3.0)
+    circuitbox (2.0.0)
+    coderay (1.1.3)
+    combustion (1.5.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concord (0.1.6)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    crass (1.0.6)
+    date (3.4.1)
+    diff-lcs (1.6.2)
+    drb (2.2.1)
+    equalizer (0.0.11)
+    erubi (1.13.1)
+    factory_bot (6.5.0)
+      activesupport (>= 5.0.0)
+    faraday (1.10.4)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.1.0)
+      multipart-post (~> 2.0)
+    faraday-net_http (1.0.2)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    hansi (0.2.1)
+    hashdiff (1.1.2)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.9.1)
+    language_server-protocol (3.17.0.3)
+    logger (1.6.5)
+    loofah (2.24.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    memosa (0.8.2)
+    method_source (1.1.0)
+    minitest (5.25.4)
+    moneta (1.6.0)
+    money (6.19.0)
+      i18n (>= 0.6.4, <= 2)
+    morpher (0.4.2)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      anima (~> 0.3.0)
+      concord (~> 0.1.5)
+      equalizer (~> 0.0.9)
+      mprelude (~> 0.1.0)
+      procto (~> 0.0.2)
+    mprelude (0.1.0)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      equalizer (~> 0.0.9)
+      ice_nine (~> 0.11.1)
+      procto (~> 0.0.2)
+    multi_json (1.15.0)
+    multipart-post (2.4.1)
+    mustermann (3.0.3)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-contrib (3.0.3)
+      hansi (~> 0.2.0)
+      mustermann (= 3.0.3)
+    mutant (0.13.4)
+      diff-lcs (~> 1.3)
+      irb (~> 1.15.2)
+      parser (~> 3.3.0)
+      regexp_parser (~> 2.10)
+      sorbet-runtime (~> 0.5.0)
+      unparser (~> 0.8.0)
+    mutant-rspec (0.13.4)
+      mutant (= 0.13.4)
+      rspec-core (>= 3.8.0, < 4.0.0)
+    netrc (0.11.0)
+    nokogiri (1.18.8-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.8-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.8-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-linux-musl)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.7.0)
+      ast (~> 2.4.1)
+      racc
+    pg (1.5.9)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.5.1)
+    procto (0.0.3)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    psych (5.2.3)
+      date
+      stringio
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rack (3.1.14)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.1)
+      actionpack (= 8.0.1)
+      activesupport (= 8.0.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rbi (0.2.3)
+      prism (~> 1.0)
+      sorbet-runtime (>= 0.5.9204)
+    rdoc (6.13.1)
+      psych (>= 4.0.0)
+    regexp_parser (2.11.3)
+    reline (0.6.0)
+      io-console (~> 0.5)
+    rexml (3.4.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.71.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.21.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-graphql (1.5.4)
+      rubocop (>= 1.50, < 2)
+    rubocop-performance (1.23.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.29.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.52.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.31.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    securerandom (0.4.1)
+    sentry-ruby (5.22.1)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+    sorbet (0.5.11763)
+      sorbet-static (= 0.5.11763)
+    sorbet-runtime (0.5.11763)
+    sorbet-static (0.5.11763-aarch64-linux)
+    sorbet-static (0.5.11763-universal-darwin)
+    sorbet-static (0.5.11763-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11763)
+      sorbet (= 0.5.11763)
+      sorbet-runtime (= 0.5.11763)
+    spoom (1.5.1)
+      erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    stringio (3.1.2)
+    tapioca (0.16.8)
+      benchmark
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.2)
+    thread_safe (0.3.6)
+    timecop (0.9.10)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.6.0)
+    unparser (0.8.0)
+      diff-lcs (~> 1.6)
+      parser (>= 3.3.0)
+      prism (>= 1.4)
+    uri (1.0.3)
+    useragent (0.16.11)
+    webmock (3.24.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.37)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
+    zeitwerk (2.7.1)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  activemodel
+  activerecord (~> 8.0.0)
+  activesupport (~> 8.0.0)
+  alchemrest!
+  appraisal
+  betterlint
+  combustion
+  factory_bot
+  faraday (~> 1.10)
+  moneta
+  mutant-rspec (~> 0.13.4)
+  pg
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+  rubocop
+  rubocop-rspec
+  sorbet
+  tapioca (>= 0.16.6)
+  timecop
+  webmock
+
+BUNDLED WITH
+   2.6.9

data/lib/alchemrest/circuit_breaker.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Alchemrest
+  class CircuitBreaker
+    extend Memosa
+    include Anima.new(
+      :service_name,
+      :sleep_window,
+      :time_window,
+      :error_threshold,
+      :volume_threshold,
+      :disabled_when,
+    )
+
+    class RequestFailed < StandardError; end
+
+    DEFAULTS = {
+      # number of seconds the circuit stays open once we pass the error threshold
+      sleep_window: 90,
+      # length of interval (in seconds) over which it calculates the error rate
+      time_window: 60,
+      # number of requests within `time_window` seconds before it calculates
+      # error rates (checked on failures)
+      volume_threshold: 5,
+      # exceeding this rate will open the circuit (checked on failures)
+      error_threshold: 50,
+      disabled_when: nil,
+    }.freeze
+
+    def initialize(args)
+      super(**DEFAULTS, **args)
+    end
+
+    def enabled?
+      !service_name.nil? && (disabled_when.nil? || !disabled_when.call)
+    end
+
+    def open?
+      enabled? && circuit_box.open?
+    end
+
+    def monitor!(result:)
+      return unless enabled?
+
+      outcome = circuit_box.run(exception: false) do
+        raise RequestFailed if request_failed?(result:)
+
+        :success
+      end
+
+      outcome || :failure
+    end
+
+    private
+
+    def request_failed?(result:)
+      case result
+        in Alchemrest::Result::Error(Alchemrest::ServerError | Alchemrest::RequestFailedError)
+          true
+        else
+          false
+      end
+    end
+
+    memoize def circuit_box
+      Circuitbox.circuit(service_name, circuit_box_options)
+    end
+
+    def circuit_box_options
+      {
+        # number of seconds the circuit stays open once we pass the error threshold
+        sleep_window:,
+        # length of interval (in seconds) over which it calculates the error rate
+        time_window:,
+        # number of requests within `time_window` seconds before it calculates
+        # error rates (checked on failures)
+        volume_threshold:,
+        # exceeding this rate will open the circuit (checked on failures)
+        error_threshold:,
+        exceptions: [RequestFailed],
+      }
+    end
+  end
+end

data/lib/alchemrest/client/configuration/connection.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "faraday/request/json"
+
+module Alchemrest
+  class Client
+    class Configuration
+      class Connection
+        attr_accessor :url, :headers, :customize_block
+        attr_reader :client_configuration, :use_default_middleware
+
+        def initialize(client_configuration)
+          @client_configuration = client_configuration
+          @use_default_middleware = true
+        end
+
+        def customize(use_default_middleware: true, &block)
+          @use_default_middleware = use_default_middleware
+          self.customize_block = block
+        end
+
+        def create_new_connection
+          unless frozen?
+            raise ConfigurationNotReadyError, "Don't use configuration to build connections until the configuration has been frozen"
+          end
+
+          Faraday.new(url: url, headers: headers) do |c|
+            c.use Faraday::Request::Json
+
+            apply_configuration(c)
+          end
+        end
+
+        def freeze
+          validate!
+          super
+        end
+
+        private
+
+        def use_default_middleware?
+          @use_default_middleware
+        end
+
+        def use_kill_switch?
+          client_configuration.kill_switch_enabled?
+        end
+
+        def underscore_response_body_keys?
+          client_configuration.underscore_response_body_keys
+        end
+
+        def kill_switch_adapter_ready?
+          Alchemrest.kill_switch_adapter.ready?
+        end
+
+        def validate!
+          raise InvalidConfigurationError, "No url provided" if url.blank?
+        end
+
+        def apply_configuration(connection)
+          customize_block.call(connection) if customize_block
+          apply_middleware(connection)
+        end
+
+        def apply_middleware(connection)
+          if use_default_middleware?
+            if client_configuration.service_name
+              if use_kill_switch? && kill_switch_adapter_ready?
+                connection.use FaradayMiddleware::KillSwitch, service_name: client_configuration.service_name
+              end
+
+              connection.use FaradayMiddleware::ExternalApiInstrumentation, external_service: client_configuration.service_name
+            end
+
+            connection.use FaradayMiddleware::UnderScoreResponse if underscore_response_body_keys?
+            connection.use FaradayMiddleware::JsonParser
+          end
+        end
+      end
+    end
+  end
+end

data/lib/alchemrest/client/configuration.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Alchemrest
+  class Client
+    class Configuration
+      attr_accessor :service_name,
+                    :underscore_response_body_keys
+
+      attr_reader :circuit_breaker,
+                  :kill_switch_enabled
+
+      def kill_switch_enabled? = kill_switch_enabled
+
+      def initialize
+        @underscore_response_body_keys = true
+      end
+
+      def connection
+        @connection ||= Connection.new(self)
+      end
+
+      def freeze
+        connection.freeze
+
+        # enable defaults if they haven't been explicitly configured
+        unless circuit_breaker
+          use_circuit_breaker
+        end
+
+        if kill_switch_enabled.nil?
+          use_kill_switch
+        end
+
+        super()
+      end
+
+      def ready?
+        frozen?
+      end
+
+      def use_circuit_breaker(circuit_breaker_option = nil)
+        ensure_service_name!
+        raise InvalidConfigurationError, "already called `use_circuit_breaker`" unless circuit_breaker.nil?
+
+        @circuit_breaker = case circuit_breaker_option
+                             in CircuitBreaker
+                               circuit_breaker_option
+                             in Hash => options
+                               build_default_circuit_breaker(**options)
+                             in true | nil
+                               build_default_circuit_breaker
+                             in false
+                               build_default_circuit_breaker(disabled_when: -> { true })
+                           end
+      end
+
+      def use_kill_switch(value = true) # rubocop:disable Style/OptionalBooleanParameter
+        ensure_service_name!
+        raise InvalidConfigurationError, "already called `use_kill_switch`" unless kill_switch_enabled.nil?
+
+        @kill_switch_enabled = value
+      end
+
+      private
+
+      def ensure_service_name!
+        return if service_name
+
+        unless connection.url
+          raise InvalidConfigurationError,
+                "You must set `config.service_name` or `config.connection.url` before trying to use circuit breakers or kill switches"
+        end
+
+        @service_name = default_service_name
+      end
+
+      def default_service_name
+        URI(connection.url).hostname
+      end
+
+      def build_default_circuit_breaker(options = {})
+        CircuitBreaker.new(
+          service_name:,
+          **options,
+        )
+      end
+    end
+  end
+end

data/lib/alchemrest/client.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Alchemrest
+  class Client
+    def self.inherited(subclass) # rubocop:disable Lint/MissingSuper
+      subclass.class_eval do
+        def connection
+          self.class.connection
+        end
+
+        def self.connection
+          @connection ||= configuration.connection.create_new_connection
+        end
+      end
+    end
+
+    def self.configuration
+      raise InvalidConfigurationError, "Call `configure` in your client class to setup connection details" unless @configuration
+
+      @configuration
+    end
+
+    def self.configure(&configuration_block)
+      @configuration = begin
+        config = Alchemrest::Client::Configuration.new
+        class_exec(config, &configuration_block)
+        config.freeze
+        config
+      end
+    end
+
+    def self.kill_switch
+      KillSwitch.new(service_name: configuration.service_name)
+    end
+
+    def configuration
+      self.class.configuration
+    end
+
+    def build_http_request(request)
+      HttpRequest.new(request, self)
+    end
+
+    def build_response(raw_response)
+      Response.new(raw_response)
+    end
+  end
+end

data/lib/alchemrest/cop.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative '../rubocop/cop/alchemrest/request_hash_returning_block'
+require_relative '../rubocop/cop/alchemrest/define_request_using_with_params'
+require_relative '../rubocop/cop/alchemrest/endpoint_definition_using_generic_params'
+require_relative '../rubocop/cop/alchemrest/time_transform_with_no_zone'