rails-letsencrypt 0.7.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ca4da4df960626f011a2fb59be5a35c19873c242b563e7813fde925ad20d22f
-  data.tar.gz: b3eb2890ea970a471ef1c396da8b989d77c0de14f810dbd5571137c38c57e976
+  metadata.gz: 9fcc6f31e49bb320d23f8dc89e768de5c88edc1cfcb65540d3ff294337908aa6
+  data.tar.gz: 88ebaa8808ab982309be5d3a903b39ba731d68a2f0f7d33fee336316ac0b7ade
 SHA512:
-  metadata.gz: b34a33043a5bc381a02034db0192b32f89b4a2e1a6cef8b2b84f76ccf9a12861cb004d887ef9705d4bbfc5eba7d6783bae66f864b0a67aec2865a6c352c5996e
-  data.tar.gz: 00ed2cf4294b7517b2c82e665a8312e8e859365686c1f094fd7385b4a2bc704165e31f525c92b648fd4ec8b6a0fb0bb380bbc70b1d53782375843661fbe369f9
+  metadata.gz: 37ba93909e4ec5d883c4d84a41a8b64060079b87c491765736c0d325a8d9df7759f5d9fc21945d3769ccd12388a154eb56604c4dc06c89a01cdc3ebd68189ed0
+  data.tar.gz: 819e3498c99f2037ab520114bc2e1bfa2f6bbce50d05a948dfa3ac1b43fc9cab0630bca1b6d1df294bc89ac4f43b1df18ab417a286f38dec60f2caa5ae66649f

data/README.md

@@ -2,6 +2,11 @@
 
 Provide manageable Let's Encrypt Certificate for Rails.
 
+## Requirement
+
+* Rails 5+
+* Ruby 2.5+
+
 ## Installation
 
 Puts this in your Gemfile:
@@ -56,6 +61,10 @@ LetsEncrypt.config do |config|
   # The redis server url
   # Default is nil
   config.redis_url = 'redis://localhost:6379/1'
+
+  # Enable it if you want to customize the model
+  # Default is LetsEncrypt::Certificate
+  #config.certificate_model = 'MyCertificate'
 end
 ```
 

data/app/controllers/lets_encrypt/verifications_controller.rb

@@ -17,7 +17,7 @@ module LetsEncrypt
     end
 
     def certificate
-      LetsEncrypt::Certificate.find_by(verification_path: filename)
+      LetsEncrypt.certificate_model.find_by(verification_path: filename)
     end
 
     def filename

data/app/jobs/lets_encrypt/renew_certificates_job.rb

@@ -6,7 +6,7 @@ module LetsEncrypt
     queue_as :default
 
     def perform
-      LetsEncrypt::Certificate.renewable.each do |certificate|
+      LetsEncrypt.certificate_model.renewable.each do |certificate|
         next if certificate.renew
         certificate.update(renew_after: 1.day.from_now)
       end

data/app/models/concerns/lets_encrypt/certificate_issuable.rb

@@ -10,7 +10,7 @@ module LetsEncrypt
       logger.info "Getting certificate for #{domain}"
       create_certificate
       # rubocop:disable Metrics/LineLength
-      logger.info "Certificate issued (expires on #{expires_at}, will renew after #{renew_after})"
+      logger.info "Certificate issued for #{domain} (expires on #{expires_at}, will renew after #{renew_after})"
       # rubocop:enable Metrics/LineLength
       true
     end

data/app/models/concerns/lets_encrypt/certificate_verifiable.rb

@@ -35,7 +35,7 @@ module LetsEncrypt
       until @challenge.status != 'pending'
         checks += 1
         if checks > 30
-          logger.info 'Status remained at pending for 30 checks'
+          logger.info "#{domain}: Status remained at pending for 30 checks"
           return false
         end
         sleep 1
@@ -45,7 +45,7 @@ module LetsEncrypt
 
     def check_verify_status
       unless @challenge.status == 'valid'
-        logger.info "Status was not valid (was: #{@challenge.status})"
+        logger.info "#{domain}: Status was not valid (was: #{@challenge.status})"
         return false
       end
 
@@ -56,11 +56,11 @@ module LetsEncrypt
       @retries ||= 0
       if e.is_a?(Acme::Client::Error::BadNonce) && @retries < 5
         @retries += 1
-        logger.info "Bad nounce encountered. Retrying (#{@retries} of 5 attempts)"
+        logger.info "#{domain}: Bad nounce encountered. Retrying (#{@retries} of 5 attempts)"
         sleep 1
         verify
       else
-        logger.info "Error: #{e.class} (#{e.message})"
+        logger.info "#{domain}: Error: #{e.class} (#{e.message})"
         return false
       end
     end

data/app/models/lets_encrypt/certificate.rb

@@ -34,6 +34,7 @@ module LetsEncrypt
 
     before_create -> { self.key = OpenSSL::PKey::RSA.new(4096).to_s }
     after_save -> { save_to_redis }, if: -> { LetsEncrypt.config.use_redis? && active? }
+    after_destroy -> { delete_from_redis }, if: -> { LetsEncrypt.config.use_redis? && active? }
 
     # Returns false if certificate is not issued.
     #
@@ -57,7 +58,7 @@ module LetsEncrypt
 
     # Returns full-chain bundled certificates
     def bundle
-      certificate + intermediaries
+      (certificate || '') + (intermediaries || '')
     end
 
     def certificate_object
@@ -73,6 +74,11 @@ module LetsEncrypt
       LetsEncrypt::Redis.save(self)
     end
 
+    # Delete certificate from redis
+    def delete_from_redis
+      LetsEncrypt::Redis.delete(self)
+    end
+
     protected
 
     def logger

data/lib/generators/lets_encrypt/install_generator.rb

@@ -21,12 +21,12 @@ module LetsEncrypt
                            'db/migrate/create_letsencrypt_certificates.rb'
       end
 
-      def rails5?
-        Rails::VERSION::MAJOR == 5
+      def required_migration_version?
+        Rails::VERSION::MAJOR >= 5
       end
 
       def migration_version
-        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if rails5?
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if required_migration_version?
       end
     end
   end

data/lib/letsencrypt.rb

@@ -86,5 +86,9 @@ module LetsEncrypt
     def table_name_prefix
       'letsencrypt_'
     end
+
+    def certificate_model
+      @certificate_model ||= config.certificate_model.constantize
+    end
   end
 end

data/lib/letsencrypt/configuration.rb

@@ -16,6 +16,10 @@ module LetsEncrypt
     config_accessor :save_to_redis
     config_accessor :redis_url
 
+    config_accessor :certificate_model do
+      'LetsEncrypt::Certificate'
+    end
+
     # Returns true if enabled `save_to_redis` feature
     def use_redis?
       save_to_redis == true

data/lib/letsencrypt/redis.rb

@@ -10,10 +10,18 @@ module LetsEncrypt
 
       # Save certificate into redis.
       def save(cert)
-        return unless cert.key.present? && cert.certificate.present?
-        LetsEncrypt.logger.info "Save #{cert.domain}'s certificate to redis"
+        return unless cert.key.present? && cert.bundle.present?
+        LetsEncrypt.logger.info "Save #{cert.domain}'s certificate (bundle) to redis"
         connection.set "#{cert.domain}.key", cert.key
-        connection.set "#{cert.domain}.crt", cert.certificate
+        connection.set "#{cert.domain}.crt", cert.bundle
+      end
+
+      # Delete certificate from redis.
+      def delete(cert)
+        return unless cert.key.present? && cert.certificate.present?
+        LetsEncrypt.logger.info "Delete #{cert.domain}'s certificate from redis"
+        connection.del "#{cert.domain}.key"
+        connection.del "#{cert.domain}.crt"
       end
     end
   end

data/lib/letsencrypt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LetsEncrypt
-  VERSION = '0.7.0'
+  VERSION = '0.10.1'
 end

data/lib/tasks/letsencrypt_tasks.rake

@@ -1,17 +1,20 @@
 # frozen_string_literal: true
 
 namespace :letsencrypt do
-  desc 'Renew the certificates will epxired'
+  desc "Renew certificates that already expired or expiring soon"
   task renew: :environment do
     count = 0
     failed = 0
-    LetsEncrypt::Certificate.renewable do |certificate|
+
+    LetsEncrypt.certificate_model.renewable.each do |certificate|
       count += 1
+
       next if certificate.renew
+
       failed += 1
-      log "Could not renew domain: #{certificate.domain}"
+      puts "Could not renew domain: #{certificate.domain}"
     end
 
-    puts "Total #{count} domains should renew, and #{failed} domains cannot be renewed."
+    puts "Renewed #{count - failed} out of #{count} domains"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-letsencrypt
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.10.1
 platform: ruby
 authors:
 - 蒼時弦也
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-12 00:00:00.000000000 Z
+date: 2021-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: acme-client
   requirement: !ruby/object:Gem::Requirement
@@ -84,30 +84,30 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.23
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.23
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -156,7 +156,7 @@ homepage: https://github.com/elct9620/rails-letsencrypt
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,9 +171,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: The Let's Encrypt certificate manager for rails
 test_files: []