letsencrypt_webfaction 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9263db07dba22feb90f3728f7da736840de2467a15e58f79a7d56a83ecc59759
-  data.tar.gz: 5c151a918d2ebe3626ade203e93da6245ce5ed6d9828e065bcd1d2e15b758323
+  metadata.gz: 1e3b0f98bf6ed31d880f2bb5f71ebde9eee5f4bfc4ea953321ec1abb94521078
+  data.tar.gz: d0528f7489385550750003ca33f49bd8c86ce6298d7ccaa74f269050ad8e7cc9
 SHA512:
-  metadata.gz: 945e0ff96f7684b062c5021d6671bd3481d0bcb9a4bfe718894dda69e0b45c3b67125b298da0a9ca66bd016192d8fb7650bf415db8fd8de337de0d8d78a83bce
-  data.tar.gz: 22e1cffd4fd0ac8c0f7764a8d7635bbe11ba2b0ce868256c30c895f5636dc1d3a99a278c367b074a1a1f03ad505fbd2734c52375bc7b5390a71676d1fc534e5b
+  metadata.gz: 9ee90ba6301aec0e5a0da927864a1023ef3fe8f9142f62314fd3c3430d7513f46a92e61f8ec99c85566384ec417ab3dd22ecff1482177f8b0602d1545749d12c
+  data.tar.gz: a40f0e3351ec79fd7eb65d1abdbc4e7e54a9bef850f316843fdf1d938f5fd5eba895546f576324bac42b6ece2917f12c8511383e20e01ef5f885abd366862ec1

data/.rubocop.yml

@@ -4,7 +4,7 @@ AllCops:
     - 'bin/*'
     # Keep rubocop from scanning installed gems.
     - 'vendor/**/*'
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.2
 # Line length is something that isn't dogmatic. 80 chars is a good recommendation.
 Metrics/LineLength:
   Enabled: false

data/.travis.yml

@@ -2,7 +2,6 @@ language: ruby
 rvm:
   - 2.3.1
   - 2.2
-  - 2.1
 before_install:
   - gem install bundler
 cache: bundler

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+Unreleased
+
+* Your change here!
+
+v3.1.0
+
+* Set config file permissions to 600 on creation.
+* Output version number with `--version` flag. Fixes [#139](https://github.com/will-in-wi/letsencrypt-webfaction/issues/139)
+* Drop support for Ruby 2.1. It's unsupported upstream and third party libraries are dropping support. Feel free to file a ticket if you need this for some reason.
+* Restore ability to define custom configuration files paths. Fixes [#136](https://github.com/will-in-wi/letsencrypt-webfaction/issues/136)
+* [#144](https://github.com/will-in-wi/letsencrypt-webfaction/pull/144) - Tiny fix so that "default" does what it says on the tin. Thanks to @nootrope for raising this UX issue!
+
 v3.0.1
 
 * Improves messaging when requesting validation fails

data/Gemfile

@@ -7,6 +7,7 @@ group :development, :test do
   gem 'bundler', '~> 1.11'
   gem 'pry', '~> 0.10'
   gem 'pry-byebug', '~> 3.3'
+  gem 'pry-doc'
   gem 'rake', '~> 12.0'
   gem 'rspec', '~> 3.4'
   gem 'rubocop', '~> 0.51'

data/README.md

@@ -67,9 +67,15 @@ After saving `~/.bash_profile`, run the command `source $HOME/.bash_profile` to
 
 Run `letsencrypt_webfaction init` to generate a registration cert and the config file. Open the config file `nano -w ~/letsencrypt_webfaction.toml` and edit to reflect your configuration.
 
-Now, you are ready to run `letsencrypt_webfaction run` from your SSH session to get certificates.
+Now, you are ready to run `letsencrypt_webfaction run` from your SSH session to get certificates. Note that by default the config file `letsencrypt_webfaction.toml` is pointed at the LetsEncrypt staging endpoint (the line that says: `endpoint = "https://acme-staging.api.letsencrypt.org/"`); meaning you will only get "test" certificates installed while using the stage endpoint. To issue live certificates you will need to comment out default line, and uncomment the production endpoint line (the line that says: `endpoint = "https://acme-v01.api.letsencrypt.org/" # Production`).
 
-After you run this command, you will see new certificates in the webfaction admin panel, with the names you have provided. 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.
+When you have tested with staging, you can remove the certificate from WebFaction control panel (make sure no webapps are using it first) and re-run with the production endpoint.
+
+After you run this command, you will see new certificates in the webfaction admin panel (under `Domains / Websites`, then `SSL certificates`), with the names you have provided (ie, the `name = ` variable in the `letsencrypt_webfaction.toml` config file). You need to change your application to point to this certificate after the certificate has been issued. This change will take some time for Webfaction to deploy before you will be able to successfully connect with the `https` version of your site. After a short period, Webfaction will copy your generated certficates into the directory `/home/yourusername/certificates/`. Future runs of this command will update the existing certificate entry and not require a change in the admin panel.
+
+Once you can connect to your site via `https` you might have broken images and CSS files. Such "[mixed content](https://support.cloudflare.com/hc/en-us/articles/200170476-How-do-I-fix-the-SSL-Mixed-Content-Error-Message-)" will need to be fixed: make sure any references to embeded content from your site uses `https` rather than `http`.
+
+Finally, if you would like the `http` site to redirect to your `https`, follow the [Webfaction guidance](https://docs.webfaction.com/software/static.html#redirecting-from-http-to-https).
 
 ## Usage
 

data/docs/upgrading.md

@@ -15,7 +15,7 @@ The basic procedure to upgrade is:
 
 ## Upgrade the program
 
-Follow the [instructions in the readme](README.md#Upgrading).
+Follow the [instructions in the readme](/README.md#Upgrading).
 
 ## Initialize the config file
 

data/letsencrypt_webfaction.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.cert_chain  = ['certs/will_in_wi.pem']
   spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $PROGRAM_NAME.end_with?('gem')
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 2.2.0'
 
   spec.add_runtime_dependency 'acme-client', '~> 1.0'
   spec.add_runtime_dependency 'toml-rb', '~> 1.1'

data/lib/letsencrypt_webfaction.rb

@@ -1,3 +1,3 @@
 module LetsencryptWebfaction
-  VERSION = '3.0.1'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/lib/letsencrypt_webfaction/application.rb

@@ -1,11 +1,13 @@
 require 'letsencrypt_webfaction/application/init'
 require 'letsencrypt_webfaction/application/run'
+require 'letsencrypt_webfaction/application/version'
 
 module LetsencryptWebfaction
   module Application
     SUPPORTED_COMMANDS = {
       'init' => LetsencryptWebfaction::Application::Init,
       'run' => LetsencryptWebfaction::Application::Run,
+      '--version' => LetsencryptWebfaction::Application::Version,
     }.freeze
 
     V2_COMMANDS = %i[key_size endpoint domains public letsencrypt_account_email api_url username password servername cert_name].freeze

data/lib/letsencrypt_webfaction/application/init.rb

@@ -27,6 +27,7 @@ module LetsencryptWebfaction
           puts 'Config file already exists. Skipping copy...'
         else
           FileUtils.cp(source, Dir.home)
+          File.chmod(0o600, File.join(Dir.home, 'letsencrypt_webfaction.toml'))
           puts 'Copied configuration file'
         end
       end

data/lib/letsencrypt_webfaction/application/run.rb

@@ -6,6 +6,7 @@ require 'letsencrypt_webfaction/logger_output'
 
 require 'acme-client'
 require 'optparse'
+require 'pathname'
 
 module LetsencryptWebfaction
   module Application
@@ -13,15 +14,11 @@ module LetsencryptWebfaction
       RENEWAL_DELTA = 14 # days
 
       def initialize(args)
-        parse_quiet(args)
+        @config_path = DefaultConfigPath.new
+        parse_options(args)
+        @config_path.validate!
 
-        # TODO: args should be supported: --config
-        unless Options.default_options_path.exist?
-          $stderr.puts 'The configuration file is missing.'
-          $stderr.puts 'You may need to run `letsencrypt_webfaction init`'
-          raise AppExitError, 'config missing'
-        end
-        @options = LetsencryptWebfaction::Options.from_toml(Options.default_options_path)
+        @options = LetsencryptWebfaction::Options.from_toml(@config_path.path)
       end
 
       def run!
@@ -40,13 +37,50 @@ module LetsencryptWebfaction
 
       private
 
-      def parse_quiet(args)
+      class DefaultConfigPath
+        attr_reader :path
+
+        def initialize
+          @path = Options.default_options_path
+        end
+
+        def validate!
+          return true if @path.exist?
+          print_error
+          raise AppExitError, 'config missing'
+        end
+
+        private
+
+        def print_error
+          $stderr.puts 'The configuration file is missing.'
+          $stderr.puts 'You may need to run `letsencrypt_webfaction init`'
+        end
+      end
+
+      class CustomConfigPath < DefaultConfigPath
+        def initialize(path)
+          @path = Pathname.new(path)
+        end
+
+        private
+
+        def print_error
+          $stderr.puts 'The given configuration file does not exist'
+        end
+      end
+
+      def parse_options(args)
         OptionParser.new do |opts|
           opts.banner = 'Usage: letsencrypt_webfaction run [options]'
 
           opts.on('--quiet', 'Run with minimal output (useful for cron)') do |q|
             Out.quiet = q
           end
+
+          opts.on('--config=CONFIG', 'Alternative configuration path') do |c|
+            @config_path = CustomConfigPath.new(c)
+          end
         end.parse!(args)
       end
 

data/lib/letsencrypt_webfaction/application/version.rb

@@ -0,0 +1,11 @@
+module LetsencryptWebfaction
+  module Application
+    class Version
+      def initialize(_); end # rubocop:disable Naming/UncommunicativeMethodParamName
+
+      def run!
+        puts LetsencryptWebfaction::VERSION
+      end
+    end
+  end
+end

data/templates/letsencrypt_webfaction.toml

@@ -40,7 +40,7 @@ public = "~/webapps/myapp/public_html"
 # the cert common name with the dots replaced by underscores. (Optional)
 # NOTE: If you change this and do not also rename it in the webfaction admin,
 #       a new certificate will be issued.
-name = "mycertname1"
+#name = "mycertname1"
 
 # The size of the private key. 4096 is the default. You can use 2048.
 #key_size = 4096

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: letsencrypt_webfaction
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - William Johnston
@@ -30,7 +30,7 @@ cert_chain:
   ilYPju4QWNSvpNVhV+T7JUvAHXva3Rayfp8SKRpvX8ZpRCjvpYfgbmNxXO2ST1qb
   KBba/yJfCMh+B65HfRUXBQRRDtJ2Vu8i0WmRUKenahAnpkkeVmqhWwY=
   -----END CERTIFICATE-----
-date: 2018-06-14 00:00:00.000000000 Z
+date: 2018-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acme-client
@@ -95,6 +95,7 @@ files:
 - lib/letsencrypt_webfaction/application.rb
 - lib/letsencrypt_webfaction/application/init.rb
 - lib/letsencrypt_webfaction/application/run.rb
+- lib/letsencrypt_webfaction/application/version.rb
 - lib/letsencrypt_webfaction/certificate_installer.rb
 - lib/letsencrypt_webfaction/certificate_issuer.rb
 - lib/letsencrypt_webfaction/domain_validator.rb
@@ -116,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="