pgdump_scrambler 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09085520af68283995aeb54b3ae886c303b2ec2a9123b7d76da9a201463bb0d9'
-  data.tar.gz: e7ee185201e95a18b84fa9b9eaafce6e98b0f0187125af647044ff4eb4789058
+  metadata.gz: da5d3c9bc68d351090dfabdab28ad0bd216515554d61f8d4a06381eba5fc1ce4
+  data.tar.gz: 0e01334e4769d064ff9d3e2ebbca847f389ec12157b7ac299f8c89568937e2fc
 SHA512:
-  metadata.gz: 45cf30192e04b4af8f30d90aa753cd52b410f9d51597fd9f9eefbf050a6b15f16abd5c2c6ee3241e8261a1f63c22b4207f88e064e240523c371bec9db2a638b2
-  data.tar.gz: b7a5383078df617610d10eec93049f68194eea2aae21970752059dd632ff5b67b94e7a713a3701a57db3a8886991f86ec1c7d2a085b5d1a0ba97753fea99b52a
+  metadata.gz: 3b12790519c8980cc4b208f3e9ad6b137d83ab970acfc2d03cf21793893ed376a67e7d47c2f0d83afb4c675320ba6548125c22dc2d8e66050c70c1414fa76f89
+  data.tar.gz: 98f6af73aa1b377c4c31e365c65dcefa1b90cb8c6f3b1c69220270a519db0d9b55e0fb9440ba843c0dffb9819d3b0f63592935656feaf18d8fd438d8f314ed82

data/.github/workflows/main.yml

@@ -0,0 +1,40 @@
+name: Ruby
+
+on: [pull_request]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version:
+          - "3.2"
+          - "3.1"
+          - "3.0"
+          # - "3.3.0-preview2"
+
+    # services:
+    #   postgres:
+    #     image: postgres:14
+    #     ports: ["5432:5432"]
+    #     options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    #     env:
+    #       POSTGRES_USER: postgres
+    #       POSTGRES_PASSWORD: postgres
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: rspec
+        run: bundle exec rspec
+      - name: rubocop
+        run: bundle exec rubocop

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.ruby-version

data/.rubocop.yml

@@ -1,2 +1,46 @@
-inherit_from: .rubocop_todo.yml
+require: rubocop-rspec
 
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+# https://docs.rubocop.org/rubocop/cops_layout.html#layoutargumentalignment
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilinemethodcallindentation
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.4.1] - 2023-10-19
+- Fix S3 upload
+
 ## [0.4.0] - 2023-10-18
 - Add scramble functions
 - Support ARM64 Linux/Mac

data/Gemfile

@@ -1,6 +1,17 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in pgdump_scrambler.gemspec
 gemspec
+
+gem 'rails', '~> 7.0'
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.12'
+
+gem 'rubocop', '1.57.1'
+gem 'rubocop-rspec', '2.24.1'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pgdump_scrambler (0.4.0)
+    pgdump_scrambler (0.4.1)
 
 GEM
   remote: https://rubygems.org/
@@ -72,6 +72,7 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
+    base64 (0.1.1)
     builder (3.2.4)
     concurrent-ruby (1.2.2)
     crass (1.0.6)
@@ -83,6 +84,7 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
+    language_server-protocol (3.17.0.3)
     loofah (2.20.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -107,9 +109,10 @@ GEM
     nio4r (2.5.9)
     nokogiri (1.14.3-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.2.2.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
+      racc
     racc (1.6.2)
     rack (2.2.6.4)
     rack-test (2.1.0)
@@ -142,8 +145,8 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -157,24 +160,34 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.50.1)
+    rubocop (1.57.1)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-rspec (2.24.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     thor (1.2.1)
     timeout (0.3.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
@@ -188,7 +201,8 @@ DEPENDENCIES
   rails (~> 7.0)
   rake (~> 13.0)
   rspec (~> 3.12)
-  rubocop
+  rubocop (= 1.57.1)
+  rubocop-rspec (= 2.24.1)
 
 BUNDLED WITH
-   2.4.12
+   2.4.20

data/README.md

@@ -7,7 +7,7 @@ Generate scrambled potgresql dump for rails application.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'pgdump_scrambler', github: 'shunichi/pgdump_scrambler'
+gem 'pgdump_scrambler'
 ```
 
 And then execute:

data/Rakefile

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

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "pgdump_scrambler"
+require 'bundler/setup'
+require 'pgdump_scrambler'
 
 # 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.
@@ -10,5 +11,5 @@ require "pgdump_scrambler"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/pgdump-obfuscator

@@ -1,7 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'English'
 require 'shellwords'
 
-arch = case RUBY_PLATFORM
+arch =
+  case RUBY_PLATFORM
   when /aarch64-linux/
     'linux-arm64'
   when /x86_64-linux/
@@ -12,8 +16,8 @@ arch = case RUBY_PLATFORM
     'darwin-arm64'
   else
     raise "Unsupported platform: #{RUBY_PLATFORM}"
-end
+  end
 
 cmd = File.expand_path "#{File.dirname(__FILE__)}/../libexec/pgdump-obfuscator-#{arch}"
 
-exec "#{cmd} #{Shellwords.join($*)}"
+exec "#{cmd} #{Shellwords.join($ARGV)}"

data/lib/config/table.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module PgdumpScrambler
   class Config
     class Table
@@ -6,7 +7,7 @@ module PgdumpScrambler
 
       def initialize(name, columns)
         @name = name
-        @column_hash = columns.sort_by(&:name).map { |column| [column.name, column] }.to_h
+        @column_hash = columns.sort_by(&:name).to_h { |column| [column.name, column] }
       end
 
       def columns
@@ -39,29 +40,26 @@ module PgdumpScrambler
       SCRAMBLE_CONST_REGEXP = /\Aconst\[.+\]\z/
       NOP_METHODS = %w[unspecified nop].freeze
       UNSPECIFIED = 'unspecified'
-      attr_reader :name
+      attr_reader :name, :scramble_method
 
       def initialize(name, scramble_method = UNSPECIFIED)
         unless self.class.valid_scramble_method?(scramble_method)
           raise ArgumentError, "invalid scramble_method: #{scramble_method}"
         end
+
         @name = name
         @scramble_method = scramble_method
       end
 
-      def scramble_method
-        @scramble_method
-      end
-
       def unspecifiled?
         @scramble_method == UNSPECIFIED
       end
 
       def option
-        unless NOP_METHODS.member?(@scramble_method)
-          m = Shellwords.escape(scramble_method)
-          "#{@name}:#{m}"
-        end
+        return if NOP_METHODS.member?(@scramble_method)
+
+        m = Shellwords.escape(scramble_method)
+        "#{@name}:#{m}"
       end
 
       class << self

data/lib/pgdump_scrambler/config.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'yaml'
 require 'erb'
 require 'set'
@@ -19,14 +20,14 @@ module PgdumpScrambler
       'prefix' => 'YOUR_S3_PATH_PREFIX',
       'access_key_id' => "<%= ENV['AWS_ACCESS_KEY_ID'] %>",
       'secret_key' => "<%= ENV['AWS_SECRET_KEY'] %>"
-    }
+    }.freeze
     attr_reader :dump_path, :s3, :resolved_s3, :exclude_tables, :pgdump_args
 
-    def initialize(tables, dump_path, s3, exclude_tables, pgdump_args)
-      @table_hash = tables.sort_by(&:name).map { |table| [table.name, table] }.to_h
+    def initialize(tables, dump_path, s3, exclude_tables, pgdump_args) # rubocop:disable Naming/MethodParameterName
+      @table_hash = tables.sort_by(&:name).to_h { |table| [table.name, table] }
       @dump_path = dump_path
       @s3 = s3
-      @resolved_s3 = s3.map { |k, v| [k, ERB.new(v).result] }.to_h if s3
+      @resolved_s3 = s3.transform_values { |v| ERB.new(v).result } if s3
       @exclude_tables = exclude_tables
       @pgdump_args = pgdump_args
     end
@@ -45,7 +46,7 @@ module PgdumpScrambler
 
     def update_with(other)
       new_tables = @table_hash.map do |_, table|
-        if other_table = other.table(table.name)
+        if (other_table = other.table(table.name))
           table.update_with(other_table)
         else
           table
@@ -66,15 +67,15 @@ module PgdumpScrambler
       yml = {}
       yml[KEY_DUMP_PATH] = @dump_path
       yml[KEY_S3] = @s3 if @s3
-      yml[KEY_EXCLUDE_TABLES] = @exclude_tables if @exclude_tables.size > 0
+      yml[KEY_EXCLUDE_TABLES] = @exclude_tables if @exclude_tables.size.positive?
       yml[KEY_TABLES] = @table_hash.map do |_, table|
         columns = table.columns
-        unless columns.empty?
-          [
-            table.name,
-            columns.map { |column| [column.name, column.scramble_method] }.to_h,
-          ]
-        end
+        next if columns.empty?
+
+        [
+          table.name,
+          columns.to_h { |column| [column.name, column.scramble_method] }
+        ]
       end.compact.to_h
       YAML.dump(yml, io)
     end
@@ -92,21 +93,22 @@ module PgdumpScrambler
     class << self
       def read(io)
         yml = YAML.safe_load(io, permitted_classes: [], permitted_symbols: [], aliases: true)
-        if yml[KEY_TABLES]
-          tables = yml[KEY_TABLES].map do |table_name, columns|
-            Table.new(
-              table_name,
-              columns.map { |name, scramble_method| Column.new(name, scramble_method) }
-            )
+        tables =
+          if yml[KEY_TABLES]
+            yml[KEY_TABLES].map do |table_name, columns|
+              Table.new(
+                table_name,
+                columns.map { |name, scramble_method| Column.new(name, scramble_method) }
+              )
+            end
+          else
+            []
           end
-        else
-          tables = []
-        end
         Config.new(tables, yml[KEY_DUMP_PATH], yml[KEY_S3], yml[KEY_EXCLUDE_TABLES] || [], yml[KEY_PGDUMP_ARGS])
       end
 
       def read_file(path)
-        open(path, 'r') do |f|
+        File.open(path, 'r') do |f|
           read(f)
         end
       end
@@ -118,18 +120,17 @@ module PgdumpScrambler
           else
             Rails.application.eager_load!
           end
-          klasses_by_table = ActiveRecord::Base.descendants.map { |klass| [klass.table_name, klass] }.to_h
+          klasses_by_table = ActiveRecord::Base.descendants.to_h { |klass| [klass.table_name, klass] }
           table_names = ActiveRecord::Base.connection.tables.sort - IGNORED_ACTIVE_RECORD_TABLES
           tables = table_names.map do |table_name|
             klass = klasses_by_table[table_name]
-            if klass
-              columns = klass.columns.map(&:name).reject do |name|
-                IGNORED_ACTIVE_RECORD_COLUMNS.member?(name)
-              end.map do |name|
-                Column.new(name)
-              end
-              Table.new(table_name, columns)
+            next unless klass
+
+            column_names = klass.columns.map(&:name).reject do |name|
+              IGNORED_ACTIVE_RECORD_COLUMNS.member?(name)
             end
+            columns = column_names.map { |name| Column.new(name) }
+            Table.new(table_name, columns)
           end.compact
           Config.new(tables, 'scrambled.dump.gz', Config::DEFAULT_S3_PROPERTIES, [], nil)
         end

data/lib/pgdump_scrambler/dumper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'open3'
 module PgdumpScrambler
   class Dumper
@@ -9,13 +10,11 @@ module PgdumpScrambler
     end
 
     def run
-      puts "executing pg_dump..."
+      puts 'Executing pg_dump...'
       puts full_command
-      if system(full_command)
-        puts "done!"
-      else
-        raise "pg_dump failed!"
-      end
+      raise 'pg_dump failed!' unless system(full_command)
+
+      puts 'Done!'
     end
 
     private
@@ -25,10 +24,10 @@ module PgdumpScrambler
     end
 
     def obfuscator_command
-      if options = @config.obfuscator_options
-        command = File.expand_path('../../../bin/pgdump-obfuscator', __FILE__)
-        "#{command} #{options}"
-      end
+      return unless (options = @config.obfuscator_options)
+
+      command = File.expand_path('../../bin/pgdump-obfuscator', __dir__)
+      "#{command} #{options}"
     end
 
     def pgdump_command
@@ -39,18 +38,25 @@ module PgdumpScrambler
       command << "--username=#{Shellwords.escape(@db_config['username'])}" if @db_config['username']
       command << "--host='#{@db_config['host']}'" if @db_config['host']
       command << "--port='#{@db_config['port']}'" if @db_config['port']
-      command << @config.exclude_tables.map { |exclude_table| "--exclude-table-data=#{exclude_table}" }.join(' ') if @config.exclude_tables.present?
+      if @config.exclude_tables.present?
+        command << @config.exclude_tables.map do |exclude_table|
+          "--exclude-table-data=#{exclude_table}"
+        end.join(' ')
+      end
       command << @db_config['database']
       command.join(' ')
     end
 
     def load_database_yml
-      if defined?(Rails)
-        db_config = open(Rails.root.join('config', 'database.yml'), 'r') do |f|
-          YAML.safe_load(f, permitted_classes: [], permitted_symbols: [], aliases: true)
-        end
-        db_config[Rails.env]
-      end
+      return unless defined?(Rails)
+
+      db_config = YAML.safe_load_file(
+        Rails.root.join('config', 'database.yml'),
+        permitted_classes: [],
+        permitted_symbols: [],
+        aliases: true
+      )
+      db_config[Rails.env]
     end
   end
 end

data/lib/pgdump_scrambler/railtie.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+
 module PgdumpScrambler
   class Railtie < ::Rails::Railtie
     rake_tasks do
-      load File.expand_path('../../tasks/pgdump_scrambler_tasks.rake', __FILE__)
+      load File.expand_path('../tasks/pgdump_scrambler_tasks.rake', __dir__)
     end
   end
 end

data/lib/pgdump_scrambler/s3_request.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 require 'uri'
 require 'digest'
 require 'openssl'
 
 module PgdumpScrambler
   class S3Request
-    def initialize(s3_path:, verb:, region:, bucket:, access_key_id:, secret_key:, time: nil)
+    def initialize(s3_path:, verb:, region:, bucket:, access_key_id:, secret_key:, time: nil) # rubocop:disable Metrics/ParameterLists
       @s3_path = s3_path.start_with?('/') ? s3_path : "/#{s3_path}"
       @verb = verb
       @time = time || Time.now.utc
@@ -18,7 +19,7 @@ module PgdumpScrambler
     def canonical_request
       [
         @verb,
-        URI.encode(@s3_path),
+        self.class.uri_encode(@s3_path),
         canonical_query_string,
         "host:#{@bucket}.s3.amazonaws.com\n", # canonical headers
         'host', # signed headers
@@ -38,13 +39,15 @@ module PgdumpScrambler
     end
 
     def url
-      File.join("https://#{@bucket}.s3.amazonaws.com/", "#{@s3_path}?#{canonical_query_string}&X-Amz-Signature=#{signature}")
+      encoded_path = self.class.uri_encode(@s3_path)
+      File.join("https://#{@bucket}.s3.amazonaws.com/",
+        "#{encoded_path}?#{canonical_query_string}&X-Amz-Signature=#{signature}")
     end
 
     private
 
     def iso_time
-      @time.strftime("%Y%m%dT%H%M%SZ")
+      @time.strftime('%Y%m%dT%H%M%SZ')
     end
 
     def iso_date
@@ -52,15 +55,17 @@ module PgdumpScrambler
     end
 
     def hmac_sha256(key, message)
-      OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, key, message)
+      OpenSSL::HMAC.digest(OpenSSL::Digest.new('SHA256'), key, message)
     end
 
     def hmac_sha256_hex(key, message)
-      OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new, key, message)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('SHA256'), key, message)
     end
 
     def canonical_query_string
+      # rubocop:disable Layout/LineLength
       "X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=#{@access_key_id}%2F#{iso_date}%2F#{@region}%2Fs3%2Faws4_request&X-Amz-Date=#{iso_time}&X-Amz-Expires=86400&X-Amz-SignedHeaders=host"
+      # rubocop:enable Layout/LineLength
     end
 
     def string_to_sign
@@ -68,39 +73,29 @@ module PgdumpScrambler
         'AWS4-HMAC-SHA256',
         iso_time,
         "#{iso_date}/#{@region}/s3/aws4_request",
-        Digest::SHA256.hexdigest(canonical_request),
+        Digest::SHA256.hexdigest(canonical_request)
       ].join("\n")
     end
-  end
-end
-
-if $0 == __FILE__
-  # https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
-  require "minitest/autorun"
-  class TestS3Request < Minitest::Test
-    def setup
-      @s3_request = PgdumpScrambler::S3Request.new(verb: 'GET', s3_path: '/test.txt', region: 'us-east-1', bucket: 'examplebucket', access_key_id: 'AKIAIOSFODNN7EXAMPLE', secret_key: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY', time: Time.utc(2013, 5, 24, 0, 0, 0))
-    end
-
-    def test_canonical_request
-      assert_equal <<~EOS.chomp, @s3_request.canonical_request
-      GET
-      /test.txt
-      X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20130524%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20130524T000000Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host
-      host:examplebucket.s3.amazonaws.com
-      
-      host
-      UNSIGNED-PAYLOAD
-      EOS
-    end
-
-    def test_signature
-      assert_equal 'aeeed9bbccd4d02ee5c0109b86d86835f995330da4c265957d157751f604d404', @s3_request.signature
-    end
 
-    def test_url
-      exected_url = 'https://examplebucket.s3.amazonaws.com/test.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20130524%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20130524T000000Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=aeeed9bbccd4d02ee5c0109b86d86835f995330da4c265957d157751f604d404'
-      assert_equal exected_url, @s3_request.url
+    class << self
+      # https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
+      # * URI encode every byte except the unreserved characters: 'A'-'Z', 'a'-'z', '0'-'9', '-', '.', '_', and '~'.
+      # * The space character is a reserved character and must be encoded as "%20" (and not as "+").
+      # * Each URI encoded byte is formed by a '%' and the two-digit hexadecimal value of the byte.
+      # * Letters in the hexadecimal value must be uppercase, for example "%1A".
+      # * Encode the forward slash character, '/', everywhere except in the object key name.
+      #   For example, if the object key name is photos/Jan/sample.jpg,
+      #   the forward slash in the key name is not encoded.
+      def uri_encode(str)
+        str.gsub(%r{[^A-Za-z0-9\-._~/]}) do
+          us = Regexp.last_match(0)
+          tmp = +''
+          us.each_byte do |uc|
+            tmp << sprintf('%%%02X', uc)
+          end
+          tmp
+        end.force_encoding(Encoding::US_ASCII)
+      end
     end
   end
 end

data/lib/pgdump_scrambler/s3_uploader.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
+
 require 'net/http'
 require 'uri'
-require_relative './s3_request'
+require_relative 's3_request'
 
 module PgdumpScrambler
   class S3UploadError < StandardError
     attr_reader :response
+
     def initialize(response)
       @response = response
       super "S3 upload failed: #{response.body}"
@@ -13,17 +15,25 @@ module PgdumpScrambler
   end
 
   class S3Uploader
-    def initialize(s3_path:, local_path:, region:, bucket:, access_key_id:, secret_key:)
+    def initialize(s3_path:, local_path:, region:, bucket:, access_key_id:, secret_key:) # rubocop:disable Metrics/ParameterLists
       raise 'missing access_key_id' if access_key_id.nil? || access_key_id.empty?
       raise 'missing secret_key' if secret_key.nil? || secret_key.empty?
-      @s3_request = S3Request.new(s3_path: s3_path, verb: 'PUT', region: region, bucket: bucket, access_key_id: access_key_id, secret_key: secret_key)
+
+      @s3_request = S3Request.new(
+        s3_path: s3_path,
+        verb: 'PUT',
+        region: region,
+        bucket: bucket,
+        access_key_id: access_key_id,
+        secret_key: secret_key
+      )
       @local_path = local_path
     end
 
     def run
       uri = URI.parse(@s3_request.url)
-      puts "upload #{@local_path} to #{uri.host}#{uri.path}"
-      open(@local_path, 'r') do |io|
+      puts "Uploading #{@local_path} to #{uri.host}#{uri.path}"
+      File.open(@local_path, 'r') do |io|
         uri_path = uri.path
         uri_path += "?#{uri.query}" if uri.query
         req = Net::HTTP::Put.new(uri_path)
@@ -33,10 +43,9 @@ module PgdumpScrambler
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
         res = http.request(req)
-        if res.code != '200'
-          raise S3UploadError.new(res)
-        end
+        raise S3UploadError, res if res.code != '200'
       end
+      puts 'Done.'
     end
   end
 end

data/lib/pgdump_scrambler/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module PgdumpScrambler
-  VERSION = "0.4.0"
+  VERSION = '0.4.1'
 end

data/lib/pgdump_scrambler.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
-require "pgdump_scrambler/version"
-require "pgdump_scrambler/config"
-require "pgdump_scrambler/dumper"
-require "pgdump_scrambler/s3_uploader"
-if defined?(Rails)
-  require 'pgdump_scrambler/railtie'
-end
+
+require 'pgdump_scrambler/version'
+require 'pgdump_scrambler/config'
+require 'pgdump_scrambler/dumper'
+require 'pgdump_scrambler/s3_uploader'
+require 'pgdump_scrambler/railtie' if defined?(Rails)
 
 module PgdumpScrambler
 end

data/lib/tasks/pgdump_scrambler_tasks.rake

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 namespace :pgdump_scrambler do
   default_config_path = ENV['SCRAMBLER_CONFIG_PATH'] || 'config/pgdump_scrambler.yml'
 
@@ -6,15 +7,16 @@ namespace :pgdump_scrambler do
   task config_from_db: :environment do
     config =
       if File.exist?(default_config_path)
-        puts "#{default_config_path} found!\nmerge existing config with config from database"
+        puts "#{default_config_path} found!\nMerging existing config with config from database"
         PgdumpScrambler::Config
           .read_file(default_config_path)
           .update_with(PgdumpScrambler::Config.from_db)
       else
-        puts "craete config from database"
+        puts 'Creating a config file from database'
         PgdumpScrambler::Config.from_db
       end
     config.write_file(default_config_path)
+    puts "Wrote to #{default_config_path}"
   end
 
   desc 'check if new columns exist'
@@ -24,7 +26,7 @@ namespace :pgdump_scrambler do
       .update_with(PgdumpScrambler::Config.from_db)
     unspecified_columns = config.unspecified_columns
     count = unspecified_columns.sum { |_, columns| columns.size }
-    if count > 0
+    if count.positive?
       unspecified_columns.each_key do |table_name|
         puts "#{table_name}:"
         unspecified_columns[table_name].each do |column_name|
@@ -34,7 +36,7 @@ namespace :pgdump_scrambler do
       puts "#{count} unspecified columns found!"
       exit 1
     else
-      puts "No unspecified columns found."
+      puts 'No unspecified columns found.'
     end
   end
 
@@ -47,7 +49,7 @@ namespace :pgdump_scrambler do
   desc 'create scrambled dump'
   task clear_dump: :environment do
     config = PgdumpScrambler::Config.read_file(default_config_path)
-    if File.exists? config.dump_path
+    if File.exist? config.dump_path
       File.delete(config.dump_path)
       puts "Dump file #{config.dump_path} has been deleted."
     end
@@ -57,7 +59,7 @@ namespace :pgdump_scrambler do
   task s3_upload: :environment do
     config = PgdumpScrambler::Config.read_file(default_config_path)
     uploader = PgdumpScrambler::S3Uploader.new(
-      s3_path: File.join(config.resolved_s3['prefix'], File::basename(config.dump_path)),
+      s3_path: File.join(config.resolved_s3['prefix'], File.basename(config.dump_path)),
       local_path: config.dump_path,
       region: config.resolved_s3['region'],
       bucket: config.resolved_s3['bucket'],

data/pgdump_scrambler.gemspec

@@ -1,37 +1,30 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "pgdump_scrambler/version"
+require 'pgdump_scrambler/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "pgdump_scrambler"
+  spec.name          = 'pgdump_scrambler'
   spec.version       = PgdumpScrambler::VERSION
-  spec.authors       = ["Shunichi Ikegami"]
-  spec.email         = ["sike.tm@gmail.com"]
+  spec.authors       = ['Shunichi Ikegami']
+  spec.email         = ['sike.tm@gmail.com']
 
-  spec.summary       = %q{scramble pg_dump columns}
-  spec.description   = %q{scramble pg_dump columns.}
+  spec.summary       = 'Scramble pg_dump columns'
+  spec.description   = 'Scramble pg_dump columns.'
   spec.homepage      = 'https://github.com/shunichi/pgdump_scrambler'
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0'
 
-  # 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"] = 'https://rubygems.org'
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/shunichi/pgdump_scrambler'
+  spec.metadata['changelog_uri'] = 'https://github.com/shunichi/pgdump_scrambler/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.12"
-  spec.add_development_dependency "rails", "~> 7.0"
-  spec.add_development_dependency "rubocop"
+  spec.require_paths = ['lib']
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pgdump_scrambler
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Shunichi Ikegami
@@ -9,76 +9,18 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2023-10-19 00:00:00.000000000 Z
-dependencies:
-- !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.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  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: scramble pg_dump columns.
+dependencies: []
+description: Scramble pg_dump columns.
 email:
 - sike.tm@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".ruby-version"
-- ".travis.yml"
 - ".vscode/tasks.json"
 - CHANGELOG.md
 - Gemfile
@@ -107,7 +49,10 @@ homepage: https://github.com/shunichi/pgdump_scrambler
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/shunichi/pgdump_scrambler
+  source_code_uri: https://github.com/shunichi/pgdump_scrambler
+  changelog_uri: https://github.com/shunichi/pgdump_scrambler/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -116,15 +61,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: scramble pg_dump columns
+summary: Scramble pg_dump columns
 test_files: []

data/.rubocop_todo.yml

@@ -1,173 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2018-03-08 00:50:23 +0900 using RuboCop version 0.52.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: Include, TreatCommentsAsGroupSeparators.
-# Include: **/*.gemspec
-Gemspec/OrderedDependencies:
-  Exclude:
-    - 'pgdump_scrambler.gemspec'
-
-# Offense count: 5
-# Cop supports --auto-correct.
-Layout/EmptyLineAfterMagicComment:
-  Exclude:
-    - 'lib/pgdump_scrambler.rb'
-    - 'lib/pgdump_scrambler/railtie.rb'
-    - 'lib/pgdump_scrambler/table.rb'
-    - 'lib/pgdump_scrambler/version.rb'
-    - 'lib/tasks/pgdump_scrambler_tasks.rake'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
-Layout/ExtraSpacing:
-  Exclude:
-    - 'pgdump_scrambler.gemspec'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
-  Exclude:
-    - 'spec/pgdump_scrambler_spec.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment.
-Layout/SpaceAroundOperators:
-  Exclude:
-    - 'pgdump_scrambler.gemspec'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
-# SupportedStyles: space, no_space
-# SupportedStylesForEmptyBraces: space, no_space
-Layout/SpaceInsideBlockBraces:
-  Exclude:
-    - 'Gemfile'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: final_newline, final_blank_line
-Layout/TrailingBlankLines:
-  Exclude:
-    - 'lib/pgdump_scrambler/table.rb'
-    - 'lib/tasks/pgdump_scrambler_tasks.rake'
-
-# Offense count: 4
-# Cop supports --auto-correct.
-Layout/TrailingWhitespace:
-  Exclude:
-    - 'lib/pgdump_scrambler/table.rb'
-
-# Offense count: 1
-# Configuration parameters: AllowSafeAssignment.
-Lint/AssignmentInCondition:
-  Exclude:
-    - 'lib/pgdump_scrambler/table.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
-Lint/UnusedBlockArgument:
-  Exclude:
-    - 'lib/pgdump_scrambler/table.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Security/YAMLLoad:
-  Exclude:
-    - 'lib/pgdump_scrambler/table.rb'
-
-# Offense count: 5
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/pgdump_scrambler.rb'
-    - 'lib/pgdump_scrambler/railtie.rb'
-    - 'lib/pgdump_scrambler/table.rb'
-
-# Offense count: 6
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: when_needed, always, never
-Style/FrozenStringLiteralComment:
-  Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'bin/console'
-    - 'pgdump_scrambler.gemspec'
-    - 'spec/pgdump_scrambler_spec.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
-# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
-Style/HashSyntax:
-  Exclude:
-    - 'Rakefile'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/IfUnlessModifier:
-  Exclude:
-    - 'lib/pgdump_scrambler.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-    - 'pgdump_scrambler.gemspec'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RescueModifier:
-  Exclude:
-    - 'lib/pgdump_scrambler/table.rb'
-
-# Offense count: 32
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'bin/console'
-    - 'lib/pgdump_scrambler.rb'
-    - 'lib/pgdump_scrambler/version.rb'
-    - 'pgdump_scrambler.gemspec'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInLiteral:
-  Exclude:
-    - 'lib/pgdump_scrambler/table.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/UnneededPercentQ:
-  Exclude:
-    - 'pgdump_scrambler.gemspec'
-
-# Offense count: 11
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 96

data/.ruby-version

@@ -1 +0,0 @@
-3.1.3

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.0
-before_install: gem install bundler -v 1.16.1