letsencrypt_webfaction 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42e083a1af389265e34c4cf101642a5f8cd6c540
-  data.tar.gz: 49284cd35d75161182e0cd3339425151a7c902f6
+  metadata.gz: 720148a070975d55b1b50b4fc1e987fe98ef1943
+  data.tar.gz: 130323d83e8b3a85426ab7bbf08e47950a2296dc
 SHA512:
-  metadata.gz: 16454306b99d75d1ebb393e21945d2778ff771374e83955509b1852c5dca09a5a338256509c98b191b96e0bd514b1a2fa3ff2ac5900095e603f8e39e043fa7e8
-  data.tar.gz: 93872050bf6e81c6948fac2fc762757b9331fdc2db061d117162cc1c360971087441bf37b19988eb3ea1f8b4f007a7a2cec27f9a432e278d3214dd33b2bf7dbd
+  metadata.gz: 472c79571beb51ed3654e34071872008470b116301eea63d1740b896e8a631029e4582e506a9ed0ffdbb3c4d3d207628200c0644c7e11896a9e1875acdac6184
+  data.tar.gz: b25dc311e3a4097958fea417e183c41d635e8b5178f055b8c1ede981cd2467f429bfa21d0d295dcca8c5b2a848f4e67b5641f940d3d22bbfb1bb1d27f22724d2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+v2.2.0
+
+* Output helpful message on success unless `--quiet` flag is used. Fixes #86.
+
 v2.1.0
 
 * Allow multiple public directories to be used. The authorization responses will be duplicated across all of them, allowing a single cert to serve multiple applications. Fixes #96 (thanks @lsemprini for the suggestion!)

data/README.md

@@ -69,7 +69,7 @@ After saving `~/.bash_profile`, run the command `source $HOME/.bash_profile` to
 
 Now, you are ready to run `letsencrypt_webfaction` from your SSH session to get certificates. See below for usage.
 
-### RBEnv
+### RBEnv (advanced)
 
 This method is useful if you are already using RBEnv to manage Ruby, or if you are already a Ruby developer. If neither of these cases are true, just use the system Ruby method.
 
@@ -139,6 +139,8 @@ Here is a basic example which issues one certificate for both yourdomain.com and
 
 *Note: Passing the password via the command line as seen here is insecure. You should use the `--config` mechanism mentioned later.*
 
+After you run this command, you will see a new certificate in the webfaction admin panel, called yourdomain_com (in this case). You need to change your application to point to this certificate after the certificate has been issued. Future runs of this command will update the existing certificate entry and not require a change in the admin. You can change the name in the admin interface using the `--cert_name` parameter.
+
 ### Testing
 
 To test certificate issuance, consider using the [LetsEncrypt staging server](https://community.letsencrypt.org/t/testing-against-the-lets-encrypt-staging-environment/6763). This doesn't have the rate limit of 5 certs per domain every 7 days. You can add the `--endpoint https://acme-staging.api.letsencrypt.org/` parameter to the `letsencrypt_webfaction` command to do so.

data/config.defaults.yml

@@ -10,3 +10,4 @@ username: ''
 password: ''
 servername: ''
 cert_name: ''
+quiet: false

data/lib/letsencrypt_webfaction.rb

@@ -1,3 +1,3 @@
 module LetsencryptWebfaction
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/lib/letsencrypt_webfaction/application.rb

@@ -30,6 +30,8 @@ module LetsencryptWebfaction
 
       # Write the obtained certificates.
       certificate_installer.install!
+
+      output_success_help
     end
 
     private
@@ -79,5 +81,12 @@ module LetsencryptWebfaction
     def private_key
       OpenSSL::PKey::RSA.new(@options.key_size)
     end
+
+    def output_success_help
+      return if @options.quiet?
+      puts 'Your new certificate is now created and installed.'
+      puts "You will need to change your application to use the #{@options.cert_name} certificate."
+      puts 'Add the `--quiet` parameter in your cron task to remove this message.'
+    end
   end
 end

data/lib/letsencrypt_webfaction/args_parser.rb

@@ -26,6 +26,7 @@ module LetsencryptWebfaction
       Field.new(:password, 'The password for your Webfaction account.', [StringValidator.new]),
       Field.new(:servername, 'The server on which this application resides (e.g. Web123).', [StringValidator.new]),
       Field.new(:cert_name, 'The name of the certificate in the Webfaction UI.', [StringValidator.new]),
+      Field::BooleanField.new(:quiet, 'Whether to display text on success.', []),
     ].freeze
 
     # Set up getters.
@@ -33,6 +34,13 @@ module LetsencryptWebfaction
       attr_reader field
     end
 
+    # Set up boolean getters
+    FIELDS.reject(&:value?).map(&:identifier).each do |field|
+      define_method "#{field}?" do
+        instance_variable_get("@#{field}") || false
+      end
+    end
+
     # EMail config is special, as it only comes from the config file, due to complexity.
     attr_reader :email_configuration
 
@@ -100,7 +108,9 @@ module LetsencryptWebfaction
     end
 
     def handle_field(opts, field)
-      opts.on("--#{field.identifier}=#{field.identifier.upcase}", field.description) do |val|
+      argument = "--#{field.identifier}"
+      argument += "=#{field.identifier.upcase}" if field.value?
+      opts.on(argument, field.description) do |val|
         instance_variable_set("@#{field.identifier}", field.sanitize(val))
       end
     end

data/lib/letsencrypt_webfaction/args_parser/field.rb

@@ -17,6 +17,10 @@ module LetsencryptWebfaction
         validators.reject { |validator| validator.valid?(val) }.empty?
       end
 
+      def value?
+        true
+      end
+
       class IntegerField < Field
         def sanitize(val)
           val.to_i
@@ -28,6 +32,16 @@ module LetsencryptWebfaction
           val.split(',').map(&:strip).compact
         end
       end
+
+      class BooleanField < Field
+        def sanitize(val)
+          val || false
+        end
+
+        def value?
+          false
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: letsencrypt_webfaction
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - William Johnston