litestream 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb3230d8ee2ab817e4154a538aac303cf9132bc0795fa8db8eabd5b68cc8f764
-  data.tar.gz: d9adca50074b601e1f1420b1bdc84423213b88a3472a17927a12c3b17bb6fd35
+  metadata.gz: 9040ba433f646b657172cf24527af4d2e5c1fffe9c136f2c5ce47ab61705a1b9
+  data.tar.gz: fae219522ddfbfbd4be157139fc0d72e36188cc0d97ec0dd96ba76f6f0f9d2d3
 SHA512:
-  metadata.gz: 8e69e7545d77005145591cfe2e4f891fd38c091b8fc5765ac79bee8d3ed6476b9ba07949b45400ac83048a465bf8bd412d9223eb8b9cf02c4b0c5b283fc1fdb5
-  data.tar.gz: 66af38abb358bf4189bf447d7929e6ed698e351d25963b13f48f1cb71b716308a322d56c9bed8b90be612d05867e9523143b44304b529170490e2c0315389a93
+  metadata.gz: 48edb08ca4850aab2aba0fa2512c5363c146b77e3ded5eea446a391ba3395512c47b0ee1de41ac889718ab05e6131591adfd03cbb4c97204d09b60f56f924431
+  data.tar.gz: c161e956f4c6696d14bab71d01787e179c896c1732e2d64b97047dc109f1dfa874555316825afded9e2fa666c1b7ae7036f3259c88d9d0497143ef7c97e50c52

data/app/controllers/litestream/application_controller.rb

@@ -3,7 +3,12 @@ module Litestream
     protect_from_forgery with: :exception
     around_action :force_english_locale!
 
-    http_basic_authenticate_with name: Litestream.username, password: Litestream.password if Litestream.password
+    if Litestream.password
+      http_basic_authenticate_with(
+        name: Litestream.username,
+        password: Litestream.password
+      )
+    end
 
     private
 

data/lib/litestream/commands.rb

@@ -118,11 +118,9 @@ module Litestream
       end
 
       def prepare(command, argv = {}, database = nil)
-        if Litestream.configuration
-          ENV["LITESTREAM_REPLICA_BUCKET"] ||= Litestream.configuration.replica_bucket
-          ENV["LITESTREAM_ACCESS_KEY_ID"] ||= Litestream.configuration.replica_key_id
-          ENV["LITESTREAM_SECRET_ACCESS_KEY"] ||= Litestream.configuration.replica_access_key
-        end
+        ENV["LITESTREAM_REPLICA_BUCKET"] ||= Litestream.replica_bucket
+        ENV["LITESTREAM_ACCESS_KEY_ID"] ||= Litestream.replica_key_id
+        ENV["LITESTREAM_SECRET_ACCESS_KEY"] ||= Litestream.replica_access_key
 
         args = {
           "--config" => Rails.root.join("config", "litestream.yml").to_s

data/lib/litestream/engine.rb

@@ -18,5 +18,9 @@ module Litestream
         Litestream.public_send(:"#{name}=", value)
       end
     end
+
+    initializer "deprecator" do |app|
+      app.deprecators[:litestream] = Litestream.deprecator
+    end
   end
 end

data/lib/litestream/generators/litestream/templates/initializer.rb

@@ -4,7 +4,7 @@
 # This allows you to configure Litestream using Rails encrypted credentials,
 # or some other mechanism where the values are only avaialble at runtime.
 
-Litestream.configure do |config|
+Rails.application.configure do
   # An example of using Rails encrypted credentials to configure Litestream.
   # litestream_credentials = Rails.application.credentials.litestream
 
@@ -19,15 +19,15 @@ Litestream.configure do |config|
   # any SFTP server.
   # In this example, we are using Rails encrypted credentials to store the URL to
   # our storage provider bucket.
-  # config.replica_bucket = litestream_credentials.replica_bucket
+  # config.litestream.replica_bucket = litestream_credentials&.replica_bucket
 
   # Replica-specific authentication key.
   # Litestream needs authentication credentials to access your storage provider bucket.
   # In this example, we are using Rails encrypted credentials to store the access key ID.
-  # config.replica_key_id = litestream_credentials.replica_key_id
+  # config.litestream.replica_key_id = litestream_credentials&.replica_key_id
 
   # Replica-specific secret key.
   # Litestream needs authentication credentials to access your storage provider bucket.
   # In this example, we are using Rails encrypted credentials to store the secret access key.
-  # config.replica_access_key = litestream_credentials.replica_access_key
+  # config.litestream.replica_access_key = litestream_credentials&.replica_access_key
 end

data/lib/litestream/version.rb

@@ -1,3 +1,3 @@
 module Litestream
-  VERSION = "0.11.0"
+  VERSION = "0.11.1"
 end

data/lib/litestream.rb

@@ -3,11 +3,25 @@
 require "sqlite3"
 
 module Litestream
+  VerificationFailure = Class.new(StandardError)
+
   class << self
-    attr_accessor :configuration
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new("0.12.0", "Litestream")
+    end
   end
 
   def self.configure
+    deprecator.warn(
+      'Configuring Litestream via Litestream.configure is deprecated. Use Rails.application.configure { config.litestream.* = ... } instead.',
+      caller
+    )
     self.configuration ||= Configuration.new
     yield(configuration)
   end
@@ -19,11 +33,7 @@ module Litestream
     end
   end
 
-  VerificationFailure = Class.new(StandardError)
-
-  mattr_writer :username
-  mattr_writer :password
-  mattr_writer :queue
+  mattr_writer :username, :password, :queue, :replica_bucket, :replica_key_id, :replica_access_key
 
   class << self
     def verify!(database_path)
@@ -55,8 +65,6 @@ module Litestream
       @username ||= ENV["LITESTREAM_USERNAME"] || @@username || "litestream"
     end
 
-    # use method instead of attr_accessor to ensure
-    # this works if variable set after Litestream is loaded
     def password
       @password ||= ENV["LITESTREAM_PASSWORD"] || @@password
     end
@@ -65,6 +73,18 @@ module Litestream
       @queue ||= ENV["LITESTREAM_QUEUE"] || @@queue || "default"
     end
 
+    def replica_bucket
+      @replica_bucket ||= @@replica_bucket || configuration.replica_bucket
+    end
+
+    def replica_key_id
+      @replica_key_id ||= @@replica_key_id || configuration.replica_key_id
+    end
+
+    def replica_access_key
+      @replica_access_key ||= @@replica_access_key || configuration.replica_access_key
+    end
+
     def replicate_process
       info = {}
       if !`which systemctl`.empty?

data/lib/tasks/litestream_tasks.rake

@@ -1,14 +1,9 @@
 namespace :litestream do
   desc "Print the ENV variables needed for the Litestream config file"
   task env: :environment do
-    if Litestream.configuration.nil?
-      warn "You have not configured the Litestream gem with any values to generate ENV variables"
-      next
-    end
-
-    puts "LITESTREAM_REPLICA_BUCKET=#{Litestream.configuration.replica_bucket}"
-    puts "LITESTREAM_ACCESS_KEY_ID=#{Litestream.configuration.replica_key_id}"
-    puts "LITESTREAM_SECRET_ACCESS_KEY=#{Litestream.configuration.replica_access_key}"
+    puts "LITESTREAM_REPLICA_BUCKET=#{Litestream.replica_bucket}"
+    puts "LITESTREAM_ACCESS_KEY_ID=#{Litestream.replica_key_id}"
+    puts "LITESTREAM_SECRET_ACCESS_KEY=#{Litestream.replica_access_key}"
 
     true
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: litestream
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-22 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logfmt
@@ -38,20 +38,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -147,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Integrate Litestream with the RubyGems infrastructure.