rails-response-dumper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 128dc602db14db13c5fbfaf4b5baa317ff28bbb8907a698c6006b38eeb240e9d
+  data.tar.gz: 740b654ff4838c1979c9e3498ef580a0ea7ea1c260933b717592e5896da66e3e
+SHA512:
+  metadata.gz: 9f43fe15f24e03916e29ee87b7c8958c2a1676fd5d10468118502e2768e944175823fbf22c060f6356420b181131d9a719ccf5bbee4c2767b4dc7c1fb4e49269
+  data.tar.gz: 721bee79824fde20d7899ba96d7a60c83d7cb61a6f15a670977da9490a8fb0738be8f9fa2d58aafc952ac56a38ef01bb59be4772c277a96895708e0304cbcdcc

data/bin/rails-response-dumper

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'mime/types'
+
+ENV['RAILS_ENV'] ||= 'test'
+require "#{Dir.pwd}/config/environment"
+
+class ResponseDumper
+  include ActionDispatch::Integration::Runner
+
+  attr_reader :expected_status_code
+
+  def self.inherited(subclass)
+    super
+    dumpers << subclass
+  end
+
+  def self.dumpers
+    @dumpers ||= []
+  end
+
+  def self.reset_models(*models)
+    @reset_models ||= []
+    @reset_models += models
+  end
+
+  def self.reset_models!
+    reset_models.each do |model|
+      model.connection.exec_query "TRUNCATE #{model.quoted_table_name} RESTART IDENTITY CASCADE"
+    end
+  end
+
+  # Delegates to `Rails.application`.
+  def app
+    Rails.application
+  end
+
+  def expect_status_code!(status_code)
+    @expected_status_code = Rack::Utils::SYMBOL_TO_STATUS_CODE[status_code]
+  end
+end
+
+def run_dumps
+  dumps_dir = Rails.root.join('dumps')
+  FileUtils.rm_rf dumps_dir
+  FileUtils.mkdir_p dumps_dir
+
+  Dir[Rails.root.join('dumpers/**/*.rb')].each { |f| require f }
+
+  ResponseDumper.dumpers.each do |klass|
+    klass_path = klass.name.underscore
+    dumper_dir = "#{dumps_dir}/#{klass_path}"
+    FileUtils.mkdir_p dumper_dir
+
+    dumper = klass.new
+    dumper.methods.each do |method|
+      next unless method.start_with?('dump_')
+
+      klass.reset_models!
+
+      ActiveRecord::Base.transaction do
+        dumper.expect_status_code!(:ok)
+        dumper.send(method)
+        raise ActiveRecord::Rollback
+      end
+
+      response = dumper.response
+
+      unless response.status == dumper.expected_status_code
+        raise <<~ERROR.squish
+          Dumped response has unexpected status code #{response.status} #{response.status_message}
+          (expected #{dumper.expected_status_code})
+        ERROR
+      end
+
+      mime = response.content_type.split(/ *; */).first
+      extension = MIME::Types[mime].first.preferred_extension
+      File.write("#{dumper_dir}/#{method}.#{extension}", response.body)
+    end
+  end
+end
+
+# Prevent database truncation if the environment is production.
+abort 'The Rails environment is running in production mode!' if Rails.env.production?
+ActiveRecord::Migration.maintain_test_schema!
+run_dumps

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: rails-response-dumper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pioneer Valley Books
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: |
+  Rails Response Dumper is a library and command line tool to dump HTTP
+  responses from a Rails application to the file system. These responses can
+  then be consumed by other tools for testing and verification purposes.
+email:
+executables:
+- rails-response-dumper
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/rails-response-dumper
+homepage: https://github.com/Pioneer-Valley-Books/rails-response-dumper
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Dump HTTP responses from a Rails application to the file system
+test_files: []