sea_shanty 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1c54c6748c4dffae4228506da66710eb949c6fc92dccefa5c655d0a1d22efb
-  data.tar.gz: 666c4702a8665c1da5c667d8b64e2bd044fd60ea166e658feacb835ec67a53b8
+  metadata.gz: 513c49610891e98faecb14e58daf7a675f865facece11474daa7142bf359beaf
+  data.tar.gz: b2e9f9018c06a2c33aaa72bf8be87487118f1782d01406c28ce60ff6b087ddce
 SHA512:
-  metadata.gz: a9bd23109117bf23895dd6b6119249b00440a2a5ecca97ff07667e183b52dfe0b180014dbaa6d1f1ad4204d5ea5abb13138f99ffec2ae0dca2f7d826ebcc9985
-  data.tar.gz: ca8d9adec42adf5ec95a3940bf54b1da295e0d2366a501616420b5b97ceb82ef188cf038b6e4e42f249ca86d6aaa54aab07248dc2ed01fb08d1c8f407628ead1
+  metadata.gz: 83d95071d3a20a5c574dcc2a6d0df123fd90bedd7216099e9c71451b3c984ba2b660c539092ab3912213d75c2a9f27db273a50c39e303863245736f18b09fc7c
+  data.tar.gz: e091a14764d18ada33fb273139db862a7cf715ad081c2233be05991af6b991207f48e1f8d76de441714da0601f19f157c4e670bb2b50cc1272881ed4a4cafbc9

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.0] - 2023-03-16
+
+- Add a bit of logging ([#3])
+- Update CI to run against MRI 3.2.1 instead of 3.2.0
+
 ## [0.1.1] - 2023-01-05
 
 - Permit `Time` and `DateTime` when loading an interaction from yaml ([#2])

data/Gemfile.lock

@@ -1,48 +1,48 @@
 PATH
   remote: .
   specs:
-    sea_shanty (0.1.1)
+    sea_shanty (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    faraday (2.7.2)
+    faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
     json (2.6.3)
-    language_server-protocol (3.17.0.2)
-    minitest (5.16.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.18.0)
     parallel (1.22.1)
-    parser (3.1.3.0)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
-    rubocop (1.40.0)
+    rubocop (1.44.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.15.1)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.15.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    standard (1.20.0)
+    standard (1.24.3)
       language_server-protocol (~> 3.17.0.2)
-      rubocop (= 1.40.0)
-      rubocop-performance (= 1.15.1)
-    unicode-display_width (2.3.0)
+      rubocop (= 1.44.1)
+      rubocop-performance (= 1.15.2)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   x86_64-darwin-21

data/README.md

@@ -87,6 +87,9 @@ Any HTTP requests made before the call to `SeaShanty.intercept` will not be hand
   * A callable object with an arity of 2
   * Is called once with each header name and value
   * Must return the filtered value
+* `log`
+  * Is the destination, where SeaShanty should log to
+  * Must be either an object that responds to `write` or a path to a file to write log entries to
 
 ### Creating your own interceptor
 

data/lib/sea_shanty/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "sea_shanty/errors"
+require "sea_shanty/util/logger"
 
 module SeaShanty
   class Configuration
@@ -8,6 +9,14 @@ module SeaShanty
     alias_method :bypass?, :bypass
     alias_method :readonly?, :readonly
 
+    def log=(destination)
+      @logger = Logger.new(destination)
+    end
+
+    def logger
+      @logger ||= Logger::NullLogger.new
+    end
+
     def generic_responses=(responses)
       unless Hash === responses
         raise(

data/lib/sea_shanty/request_store.rb

@@ -18,50 +18,49 @@ module SeaShanty
       if configuration.bypass?
         raise ConfigurationError, "Bypass and readonly are both true - please set only one of them." if configuration.readonly?
         yield
-      elsif configuration.readonly?
-        load_response(request)
-      elsif has_response_for?(request)
-        load_response(request)
       else
-        response = yield
-        store(request, response) unless configuration.bypass?
-        response
+        path = request_file_path(request)
+        if configuration.readonly? || path.exist?
+          load_response(path, request)
+        else
+          response = yield
+          store(path, request, response) unless configuration.bypass?
+          response
+        end
       end
     end
 
-    def has_response_for?(request)
-      request_file_path(request).exist?
-    end
-
-    def load_response(request)
-      raise UnknownRequest, "SeaShanty: Unknown request #{request.method.to_s.upcase} to #{request.url}" unless has_response_for?(request)
-      contents = YAML.safe_load(request_file_path(request).read, permitted_classes: [Symbol, Time, DateTime])
+    def load_response(path, request)
+      raise UnknownRequest, "SeaShanty: Unknown request #{request.method.to_s.upcase} to #{request.url}" unless path.exist?
+      log("Loading response for #{request.url} from #{path}")
+      contents = YAML.safe_load(Pathname(path).read, permitted_classes: [Symbol, Time, DateTime])
       Response.from_h(contents.fetch(:response))
     end
 
-    def store(request, response)
-      file_path = request_file_path(request)
-      file_path.dirname.mkpath
-      file_path.open("w+") do |file|
+    def store(path, request, response)
+      log("Storing response for #{request.url} in #{path}")
+      path.dirname.mkpath
+      path.open("w+") do |file|
         file.write(YAML.dump(serialize(request, response)))
       end
     end
 
-    private
-
-    attr_reader :configuration, :generic_responses, :storage_dir, :request_serializer
-
     def request_file_path(request)
       _, generic_file_path = generic_responses.find { |matcher, path| matcher.match?(request.url.to_s) }
       file_path = if generic_file_path.nil?
-        request_serializer.file_path(request)
+        request_serializer.file_path(request).tap { |path| log("Generated #{path} for request to #{request.url}") }
       else
+        log("Found a generic response in #{generic_file_path} for request to #{request.url}")
         Pathname.new(generic_file_path.to_s)
       end
 
       storage_dir.join(file_path)
     end
 
+    private
+
+    attr_reader :configuration, :generic_responses, :storage_dir, :request_serializer
+
     def serialize(request, response)
       {
         request: request_serializer.serialize(request),
@@ -69,5 +68,9 @@ module SeaShanty
         stored_at: DateTime.now.to_s
       }
     end
+
+    def log(message)
+      configuration.logger.log(message)
+    end
   end
 end

data/lib/sea_shanty/util/logger.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SeaShanty
+  class Logger
+    attr_reader :destination
+
+    def initialize(destination)
+      @destination = if destination.respond_to? :printf
+        destination
+      else
+        File.open(destination.to_s, "a+")
+      end
+    end
+
+    def log(message)
+      destination.write(message)
+      destination.write("\n") unless message.end_with?("\n")
+    end
+
+    class NullLogger
+      def log(*)
+      end
+    end
+  end
+end

data/lib/sea_shanty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SeaShanty
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/sea_shanty.rb

@@ -56,7 +56,12 @@ module SeaShanty
   end
 
   def request_store
-    @request_store ||= RequestStore.new(configuration)
+    RequestStore.new(configuration)
+  end
+
+  def reset!
+    @configuration = Configuration.new
+    configure {}
   end
 
   def configuration_overwrite(env_var, value)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sea_shanty
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Rasmus Bang Grouleff
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies: []
 description: SeaShanty is a minimalistic library for recording HTTP requests and responses
   and replaying responses for already seen requests in an unobtrusive and test framework
@@ -40,6 +40,7 @@ files:
 - lib/sea_shanty/request_serializer.rb
 - lib/sea_shanty/request_store.rb
 - lib/sea_shanty/response.rb
+- lib/sea_shanty/util/logger.rb
 - lib/sea_shanty/version.rb
 - sea_shanty.gemspec
 - sig/sea_shanty.rbs