letsencrypt-rails-heroku 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0aabfc12bc180268e622c9bace1bf6460b2c73ef
-  data.tar.gz: c4bd799e49433146dc65f55ca0901c5fcad7f0be
+  metadata.gz: 05ee4912e0826370d5e74c310b425ba6e4143921
+  data.tar.gz: 889c2a4c16e672481c1db9d42a5dfe2a45f8424e
 SHA512:
-  metadata.gz: 8a259feabfb24e55ac7a2a499ad565cb33d0088a2aac1fa80773b0a96654a866f336a5bc98977458b289d096d0f3ec0b8e98346890bf4d85c569ba8a2e2b9e7e
-  data.tar.gz: c43da038a91df674e2d9bf57ca45534e0ed671bf0754b2a5638014c17a282c2da83e11b65b5b35921a5a702008cf0b029dd085a0ba02e8111bdc1cfee4a1462f
+  metadata.gz: f0cf0b6f588d1a91fbe590d55d44cc211c51865241392379d8fe8b4ea90f4a4033ba1eff5dbf79ed1c4aa2819fec77b6bf49934a0d61defe9ac5f69a29b876ff
+  data.tar.gz: 82269e1b169a4ddc091882d42b970a82cfe880cd37c183248e3c733129b6bf63a8f740fbc93d3cb266468a8a0443e3a871b8f3ae1a5be0622c166caac755989e

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# 1.0.0
+
+The major version bump reflects the backwards-incompatible change around how
+errors are handled; `abort` vs. custom exception types.
+
+Huge thanks to everyone that contributed to this release, either via raising
+issues or submitting pull requests.
+
+ - Raise exceptions on errors, instead of just `abort`ing. This should help
+   you catch when your certificate renewal fails, before it expires completely.
+   Closes issue #21 and pull request #28. Thanks @abigailmcp!
+
+ - Wait up to 30 seconds for LetsEncrypt to verify a domain challenge. Closes
+   issue #6 and pull requests #30, #25 and #7. Thanks @abigailmcp!
+
+ - Attempt to fetch the challenge URL for up to 30 seconds before giving up.
+   Closes issue #9 and pull request #28. Thanks @abigailmcp!
+
 # 0.3.0
 
  - Remove some Rails-specific methods and code to allow the gem to be used

data/README.md

@@ -26,7 +26,7 @@ Add the gem to your Gemfile:
 ```
 # Until the new API calls are generally available, you must manually specify my fork
 # of the Heroku API gem:
-gem 'platform-api', github: 'jalada/platform-api', branch: 'master'
+gem 'platform-api', git: 'https://github.com/jalada/platform-api', branch: 'master'
 
 gem 'letsencrypt-rails-heroku', group: 'production'
 ```

data/Rakefile

@@ -15,12 +15,12 @@ require 'juwelier'
 Juwelier::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
   gem.name = "letsencrypt-rails-heroku"
-  gem.homepage = "http://github.com/pixielabs/letsencrypt-rails-heroku"
+  gem.homepage = "https://github.com/pixielabs/letsencrypt-rails-heroku"
   gem.license = "MIT"
-  gem.summary = %Q{Automatic LetsEncrypt certs in your Rails app on Heroku}
+  gem.summary = %Q{Automatic LetsEncrypt certificates in your Rails app on Heroku}
   gem.description = %Q{This gem automatically handles creation, renewal, and applying SSL certificates from LetsEncrypt to your Heroku account.}
-  gem.email = "david@pixielabs.co.uk"
-  gem.authors = ["David Somers"]
+  gem.email = "team@pixielabs.io"
+  gem.authors = ["Pixie Labs", "David Somers", "Abigail McPhillips"]
 
   # dependencies defined in Gemfile
 end

data/VERSION

@@ -1 +1 @@
-0.3.0
+1.0.0

data/letsencrypt-rails-heroku.gemspec

@@ -2,18 +2,18 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: letsencrypt-rails-heroku 0.3.0 ruby lib
+# stub: letsencrypt-rails-heroku 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "letsencrypt-rails-heroku"
-  s.version = "0.3.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
-  s.authors = ["David Somers"]
-  s.date = "2016-12-10"
+  s.authors = ["Pixie Labs", "David Somers", "Abigail McPhillips"]
+  s.date = "2017-02-17"
   s.description = "This gem automatically handles creation, renewal, and applying SSL certificates from LetsEncrypt to your Heroku account."
-  s.email = "david@pixielabs.co.uk"
+  s.email = "team@pixielabs.io"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -29,15 +29,16 @@ Gem::Specification.new do |s|
     "VERSION",
     "letsencrypt-rails-heroku.gemspec",
     "lib/letsencrypt-rails-heroku.rb",
+    "lib/letsencrypt-rails-heroku/exceptions.rb",
     "lib/letsencrypt-rails-heroku/letsencrypt.rb",
     "lib/letsencrypt-rails-heroku/middleware.rb",
     "lib/letsencrypt-rails-heroku/railtie.rb",
     "lib/tasks/letsencrypt.rake"
   ]
-  s.homepage = "http://github.com/pixielabs/letsencrypt-rails-heroku"
+  s.homepage = "https://github.com/pixielabs/letsencrypt-rails-heroku"
   s.licenses = ["MIT"]
   s.rubygems_version = "2.5.1"
-  s.summary = "Automatic LetsEncrypt certs in your Rails app on Heroku"
+  s.summary = "Automatic LetsEncrypt certificates in your Rails app on Heroku"
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

data/lib/letsencrypt-rails-heroku.rb

@@ -1,5 +1,6 @@
 require 'letsencrypt-rails-heroku/letsencrypt'
 require 'letsencrypt-rails-heroku/middleware'
+require 'letsencrypt-rails-heroku/exceptions'
 
 if defined?(Rails)
   require 'letsencrypt-rails-heroku/railtie'

data/lib/letsencrypt-rails-heroku/exceptions.rb

@@ -0,0 +1,12 @@
+module Letsencrypt
+  module Error
+    # Exception raised when LetsEncrypt encounters an issue verifying the challenge.
+    class VerificationError < StandardError; end
+    # Exception raised when challenge URL is not available.
+    class ChallengeUrlError < StandardError; end
+    # Exception raised on timeout of challenge verification.
+    class VerificationTimeoutError < StandardError; end
+    # Exception raised when an error occurs adding the certificate to Heroku.
+    class HerokuCertificateError < StandardError; end
+  end
+end

data/lib/tasks/letsencrypt.rake

@@ -8,7 +8,7 @@ namespace :letsencrypt do
   desc 'Renew your LetsEncrypt certificate'
   task :renew do
     # Check configuration looks OK
-    abort "letsencrypt-rails-heroku is configured incorrectly. Are you missing an environment variable or other configuration? You should have a heroku_token, heroku_app, acmp_email and acme_domain configured either via a `Letsencrypt.configure` block in an initializer or as environment variables." unless Letsencrypt.configuration.valid?
+    abort "letsencrypt-rails-heroku is configured incorrectly. Are you missing an environment variable or other configuration? You should have a heroku_token, heroku_app, acme_email and acme_domain configured either via a `Letsencrypt.configure` block in an initializer or as environment variables." unless Letsencrypt.configuration.valid?
 
     # Set up Heroku client
     heroku = PlatformAPI.connect_oauth Letsencrypt.configuration.heroku_token
@@ -42,17 +42,30 @@ namespace :letsencrypt do
       })
       puts "Done!"
 
-      # Wait for request to go through
-      print "Giving config vars time to change..."
-      sleep(5)
-      puts "Done!"
-
       # Wait for app to come up
       print "Testing filename works (to bring up app)..."
 
       # Get the domain name from Heroku
       hostname = heroku.domain.list(heroku_app).first['hostname']
-      open("http://#{hostname}/#{challenge.filename}").read
+      
+      # Wait at least a little bit, otherwise the first request will almost always fail.
+      sleep(2)
+
+      start_time = Time.now
+
+      begin
+        open("http://#{hostname}/#{challenge.filename}").read
+      rescue OpenURI::HTTPError => e
+        if Time.now - start_time <= 30
+          puts "Error fetching challenge, retrying... #{e.message}"
+          sleep(5)
+          retry
+        else
+          failure_message = "Error waiting for response from http://#{hostname}/#{challenge.filename}, Error: #{e.message}"
+          raise Letsencrypt::Error::ChallengeUrlError, failure_message
+        end
+      end
+
       puts "Done!"
 
       print "Giving LetsEncrypt some time to verify..."
@@ -60,12 +73,22 @@ namespace :letsencrypt do
       challenge.request_verification # => true
       challenge.verify_status # => 'pending'
 
-      sleep(3)
+      start_time = Time.now
+
+      while challenge.verify_status == 'pending'
+        if Time.now - start_time >= 30
+          failure_message = "Failed - timed out waiting for challenge verification."
+          raise Letsencrypt::Error::VerificationTimeoutError, failure_message
+        end
+        sleep(3)
+      end
+
       puts "Done!"
 
       unless challenge.verify_status == 'valid'
         puts "Problem verifying challenge."
-        abort "Status: #{challenge.verify_status}, Error: #{challenge.error}"
+        failure_message = "Status: #{challenge.verify_status}, Error: #{challenge.error}"
+        raise Letsencrypt::Error::VerificationError, failure_message
       end
 
       puts ""
@@ -85,7 +108,7 @@ namespace :letsencrypt do
     certificate = client.new_certificate(csr) # => #<Acme::Client::Certificate ....>
 
     # Send certificates to Heroku via API
-    
+
     # First check for existing certificates:
     certificates = heroku.sni_endpoint.list(heroku_app)
 
@@ -107,7 +130,7 @@ namespace :letsencrypt do
       end
     rescue Excon::Error::UnprocessableEntity => e
       warn "Error adding certificate to Heroku. Response from Heroku’s API follows:"
-      abort e.response.body
+      raise Letsencrypt::Error::HerokuCertificateError, e.response.body
     end
 
   end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: letsencrypt-rails-heroku
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
+- Pixie Labs
 - David Somers
+- Abigail McPhillips
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-10 00:00:00.000000000 Z
+date: 2017-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acme-client
@@ -110,7 +112,7 @@ dependencies:
         version: '0'
 description: This gem automatically handles creation, renewal, and applying SSL certificates
   from LetsEncrypt to your Heroku account.
-email: david@pixielabs.co.uk
+email: team@pixielabs.io
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -127,11 +129,12 @@ files:
 - VERSION
 - letsencrypt-rails-heroku.gemspec
 - lib/letsencrypt-rails-heroku.rb
+- lib/letsencrypt-rails-heroku/exceptions.rb
 - lib/letsencrypt-rails-heroku/letsencrypt.rb
 - lib/letsencrypt-rails-heroku/middleware.rb
 - lib/letsencrypt-rails-heroku/railtie.rb
 - lib/tasks/letsencrypt.rake
-homepage: http://github.com/pixielabs/letsencrypt-rails-heroku
+homepage: https://github.com/pixielabs/letsencrypt-rails-heroku
 licenses:
 - MIT
 metadata: {}
@@ -154,5 +157,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Automatic LetsEncrypt certs in your Rails app on Heroku
+summary: Automatic LetsEncrypt certificates in your Rails app on Heroku
 test_files: []