letsencrypt_webfaction 2.2.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4b883c5a06ee4a755c4a926a4bb975191b7d975c
-  data.tar.gz: 21a1981e3cec9caf86c53d1823b78f72dbcbb259
+SHA256:
+  metadata.gz: fa98a88605708bc64a6842f8e635c0ea29a322c5eec5bb1f6b8d5f3e85b56c41
+  data.tar.gz: c85262377c899db7f910b704bed118cc2196baba6bb73e70634b43384084f238
 SHA512:
-  metadata.gz: bcd3f8322875e3a8e3350ff0ba7ebdba8c1edca79c77b8cfb2f4f4ceb18a9fe8f7ac76567e55abf049fdf3e027d540766c21de663e64ba6b25e137f436de0177
-  data.tar.gz: 949201a7be7d429f95fd6808d2df4de4fd397e2c39644eec78029593088afcc8282c36f39a5802ea81466923193feb5967dfeb7439b39f20818e5f0519635bff
+  metadata.gz: f6a3167252ad9df84a9bdca843a75fae8a6b11092ec460c8a974cfe100c3701ba6511d65c05ce17178d2be9a6b1e8ea341af2d602dff7eb4523bbc7cc5a097bb
+  data.tar.gz: ae9e5ef5bacd3a65ec1d55071df2ea79a1bb3e68cd4088157903c0e7667ca057e7c8bf330acab45ab3e146eb67a7cfb6e4aa332995d62a5966eab95a7e31e5be

data/.rubocop.yml

@@ -19,6 +19,10 @@ Metrics/BlockLength:
   Exclude:
     # Tests involve long blocks.
     - 'spec/**/*'
+Metrics/ModuleLength:
+  Exclude:
+    # Tests involve piles of code.
+    - 'spec/**/*'
 
 # I'm not pulling in a library, or forcing Ruby 2.3+
 Layout/IndentHeredoc:
@@ -59,3 +63,8 @@ Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: consistent_comma
+
+
+# Seems buggy for now.
+Layout/ClosingHeredocIndentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+v3.0.0
+
+*NOTE: Backwards incompatible, and requires changes to upgrade*
+
+* One command to update all certs
+* Checks cert validity and only renews if needed (Run daily instead of every other month)
+* Uses config file instead of command line arguments
+* Creates a single private key to serve as the registration cert, and reuses. (fixes #122)
+
 v2.2.3
 
 * Fix issue where Acme::Client v0.5.0 changed API. Require newer version and use differently. Fixes #120

data/Gemfile

@@ -11,5 +11,6 @@ group :development, :test do
   gem 'rspec', '~> 3.4'
   gem 'rubocop', '~> 0.51'
   gem 'simplecov', '~> 0.11'
+  gem 'timecop', '~> 0.9.1'
   gem 'webmock', '~> 2.1'
 end

data/README.md

@@ -2,6 +2,8 @@
 
 LetsEncrypt utility client for WebFaction hosts.
 
+*NOTE: Version 3 is out and requires some manual changes. See [the upgrade guide for details](docs/upgrading.md).*
+
 This tool automates the process of using LetsEncrypt on WebFaction hosts. It can be added to the Cron scheduled task runner where it will validate your domains automatically, obtain the certificates, and then install them using the Webfaction API.
 
 For more documentation, as well as walkthroughs, [see the wiki](https://github.com/will-in-wi/letsencrypt-webfaction/wiki)!
@@ -44,11 +46,7 @@ This utility works on [CentOS 6 and 7 boxes](https://docs.webfaction.com/user-gu
 
 All places where you need to substitute a value specific to your setup will be denoted with square brackets, e.g. [yourdomain.com]. There are cases where shell variables are used, such as `$HOME`. These should be typed verbatim.
 
-You can install LetsEncrypt WebFaction using the system Ruby or using RBEnv.
-
-### System Ruby
-
-This is the simpler method and is preferred.
+*NOTE: You can install letsencrypt_webfaction using rbenv if you are an advanced Ruby user. Replace the following section with [these instructions](docs/rbenv.md) if you choose to do so.*
 
 Run the following command in an SSH session to install the letsencrypt_webfaction package via the [RubyGems package management site](https://rubygems.org/gems/letsencrypt_webfaction):
 
@@ -67,23 +65,11 @@ This will simplify the running of the LetsEncrypt WebFaction command, by setting
 
 After saving `~/.bash_profile`, run the command `source $HOME/.bash_profile` to apply the new settings.
 
-Now, you are ready to run `letsencrypt_webfaction` from your SSH session to get certificates. See below for usage.
-
-### 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.
-
-Follow the instructions to [set up RBEnv](https://github.com/rbenv/rbenv) and [Ruby Build](https://github.com/rbenv/ruby-build#readme) on your WebFaction server.
+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.
 
-Once you have done so, install Ruby 2.1+, but <2.4 (probably 2.3.1 at time of writing). Then set the local Ruby and install the Gem. Finally unset the local Ruby so that you don't run into problems.
+Now, you are ready to run `letsencrypt_webfaction run` from your SSH session to get certificates.
 
-    $ rbenv install 2.3.1 # Installs Ruby 2.3.1
-    $ rbenv local 2.3.1 # Sets Ruby 2.3.1 as the default version in the current folder.
-    $ gem install letsencrypt_webfaction # Installs this utility from RubyGems.
-    $ rbenv rehash # Makes RBenv aware of the letsencrypt_webfaction utility.
-    $ rm .ruby-version # Unsets Ruby 2.3.1 as the default version in the current folder.
-
-*Ruby 2.4.0+ is not supported since they removed the XMLRPC library from core and moved it to a gem. This Gem doesn't work in Ruby <2.3, leaving us with an issue as the majority of system Rubies used with this project are <2.4. So don't use 2.4 for now. If you absolutely want to, make sure you install the xmlrpc gem manually.*
+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.
 
 ## Usage
 
@@ -91,91 +77,35 @@ Once you have done so, install Ruby 2.1+, but <2.4 (probably 2.3.1 at time of wr
 
 The syntax of the letsencrypt_webfaction command is as follows:
 
-    $ letsencrypt_webfaction --letsencrypt_account_email <email-address> --domains <domain[,domain[,domain...]]> --public <server-folder> --username <webfaction-username> --password <webfaction-password>
-
-
-### Options:
-
-The basic parameters are as follows:
-
-* `--letsencrypt_account_email`
-
-    The email address you want associated with the issued certificates.
-
-* `--domains`
-
-    The domains for which you want to create certificates, separated by commas (with no spaces). The domains must be served from the same folder. There is one certificate per WebFaction Website, regardless of how many domains are served from it.
-
-* `--public`
-
-    A folder which is directly served at `http://[yourdomain.com]/` into which the ACME verification files can be placed.
-
-    In the case of a PHP site, such as Drupal or Wordpress, look for the folder with `index.php` in it. This is usually in `/home/[myuser]/webapps/[yourapp/]`.
-
-    In the case of a Rails app, look for a folder called `public/`. If you are deploying your app with Capistrano, this could show up in `/home/myuser/webapps/[yourapp]/current/public/`.
-
-    In some cases (such as with some Node.js or Python applications), you may need to create this folder. See [here](https://github.com/will-in-wi/letsencrypt-webfaction/issues/24) for an example of this workaround.
-
-    You can specify multiple public directories in this option, separated by commas. This is useful when you want to create a single certificate that serves multiple domains that happen to be backed by multiple different public directories. During Let's Encrypt's http01 challenge-response, letsencrypt-webfaction will copy all the challenge files for all domains into all the public directories. Let's Encrypt supports up to 100 domains per certificate, and they discuss the pros and cons of the multiple-domain technique here: https://letsencrypt.org/docs/integration-guide/
-
-* `--username`
-
-    The username you use to log into the Webfaction control panel. Needed along with the password to upload your cert to their API.
-
-* `--password`
-
-    The password you use to log into the Webfaction control panel.
+    $ letsencrypt_webfaction [cmd] [*args]
 
-    It is better to place this in a config file than to put it in the command line.
-
-If you have several webapps, then you will need to issue the command several times. The command can be run from any folder.
-
-Other parameters (which are generally best left to their default values, unless you have a perticular need to change them) can be found in the `config.defaults.yml` configuration file (see below in the "More detailed examples" section).
-
-### Example
-Here is a basic example which issues one certificate for both yourdomain.com and www.yourdomain.com, both of which are served by `~/webapps/yourapp/wordpress` and your WebFaction contact email address is you@youremail.com. This assumes that both yourdomain.com and www.yourdomain.com are served from the same folder.
-
-    $ letsencrypt_webfaction --letsencrypt_account_email you@youremail.com --domains yourdomain.com,www.yourdomain.com --public ~/webapps/yourapp/wordpress/ --username myusername --password mypassword
-
-*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.
+The commands are `init` and `run`. You can add the `--quiet` argument to the `run` command to keep normal output from appearing (useful in cron).
 
 ### 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.
-
-A test command could thus be something like the following:
-
-    $ letsencrypt_webfaction --letsencrypt_account_email you@youremail.com --domains yourdomain.com,www.yourdomain.com --public ~/webapps/yourapp/wordpress/ --username <webfaction-username> --password <webfaction-password> --endpoint https://acme-staging.api.letsencrypt.org/
-
+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 change the `endpoint` config line to be `https://acme-staging.api.letsencrypt.org/` in order to test the system.
 
 ### Operation
 
 When letsencrypt_webfaction runs, it places verification files into the public directory specified, validates the domains with LetsEncrypt, and then uploads the certificate to WebFaction's API.
 
-To quickly get a list of parameters and help for each, you can run:
-
-    $ letsencrypt_webfaction --help
-
 Once you have the certificate installed and working, you will probably want to redirect the HTTP version of your site to the HTTPS version. WebFaction has [documentation describing how to do this](https://docs.webfaction.com/software/static.html#static-redirecting-from-http-to-https).
 
 ### Cron usage
 
 Normally, you will run the script manually once to get the certificate, and then you will use Cron to automate future certificate renewal.
 
-Your Cron task could look something like:
+The Cron task should run daily (or however often you prefer) and will only renew or issue certs which have been added, changed, or are near or past expiration.
 
-    # System Ruby Installation
-    0 4 1 */2 *     PATH=$PATH:$GEM_HOME/bin:/usr/local/bin GEM_HOME=$HOME/.letsencrypt_webfaction/gems RUBYLIB=$GEM_HOME/lib ruby2.2 $HOME/.letsencrypt_webfaction/gems/bin/letsencrypt_webfaction --letsencrypt_account_email [you@youremail.com] --domains [yourdomain.com,www.yourdomain.com] --public ~/webapps/[yourapp/your_public_html]/ --quiet --username [yourusername] --password [yourpassword]
-    # RBEnv Installation
-    0 4 1 */2 *     RBENV_ROOT=~/.rbenv RBENV_VERSION=2.3.1 ~/.rbenv/bin/rbenv exec letsencrypt_webfaction --letsencrypt_account_email [you@youremail.com] --domains [yourdomain.com,www.yourdomain.com] --public ~/webapps/[yourapp/your_public_html]/ --quiet --username [yourusername] --password [yourpassword]
+Your Cron task should look like:
 
-*Note the usage of `--quiet` to keep the success message from being shown and emailed.*
+```cron
+18 3 * * *     PATH=$PATH:$GEM_HOME/bin:/usr/local/bin GEM_HOME=$HOME/.letsencrypt_webfaction/gems RUBYLIB=$GEM_HOME/lib ruby2.2 $HOME/.letsencrypt_webfaction/gems/bin/letsencrypt_webfaction run --quiet
+```
 
-This [would run](http://crontab.guru/#0_4_1_*/2_*) at 4 a.m. on the first day of January, March, May, July, September, and November. Certificates expire three months after issuance, so modify as desired (for example, you may want to run the task every two months initially, to be sure that everything is working before extending the period). Change the date of the Cron task so that WebFaction staff don't simultaneously receive all certificate change requests on the first day of the month.
+*Note the usage of `--quiet` to keep the success message from being shown and emailed.*
 
-If you have more than one Cron task running like this, you may want to set the environment variables at the top of the file, and create a config file containing the contact information.
+This [would run](https://crontab.guru/#18_3_*_*_*) at 03:18 a.m. every day. Change the exact time of the Cron task so that the load on Let's Encrypt is spread out.
 
 If you want to be notified upon failure, you can add `MAILTO=[you@youremail.com]` to the top of the crontab. This will send you an email whenever any cron job outputs standard out or standard error, which is generally good practice. According to the Webfaction [Cron documentaion](https://docs.webfaction.com/software/general.html#scheduling-tasks-with-cron) some webfaction servers also require you to add `MAILFROM=[you@youremail.com]` to the top of the crontab.
 
@@ -185,37 +115,18 @@ While WebFaction staff maintain your standard server software, the support team
 
 You can find the current version by running `letsencrypt_webfaction --version`. Sort of. In versions >= 1.1.4, this will work. In older versions, this will just print `letsencrypt_webfaction: version unknown` due to an oversight on my part. So if you get the latter output, just upgrade.
 
-[The changelog](./CHANGELOG.md) describes changes from version to version.
+[The changelog](CHANGELOG.md) describes changes from version to version.
 
 LetsEncrypt WebFaction follows [Semantic Versioning](http://semver.org/). In a nutshell, a version number such as `1.2.3` is divided as `major.minor.patch`. When the major version is incremented, you will probably have to change something about the configuration to make it work. The changelog will let you know what changes you need to make. When the minor version is incremented, there are new features but existing features haven't changed. If the patch version is incremented, the changes are all under the hood and shouldn't change or add any existing features.
 
 TL;DR: Be careful with major version upgrades and you should be fine with upgrading to minor or patch releases.
 
-To upgrade, run one of the following two commands to fetch and install the newest version from RubyGems:
+To upgrade, run the following command to fetch and install the newest version from RubyGems:
 
 ```sh
-# For system Ruby:
 GEM_HOME=$HOME/.letsencrypt_webfaction/gems RUBYLIB=$GEM_HOME/lib gem2.2 install letsencrypt_webfaction
-
-# For RBenv
-RBENV_VERSION=2.3.1 gem install letsencrypt_webfaction
 ```
 
-### More detailed examples
-
-Default parameters can be found in [config.defaults.yml](./config.defaults.yml). All of the parameters can be overridden by passing another config file, arguments to the executable, or both. If a both a config file and command-line arguments are passed, they will be interleaved, with the command-line arguments having precedence.
-
-A config file needs to be in [YAML format](http://www.yaml.org/refcard.html) and have a subset of the keys in [config.defaults.yml](./config.defaults.yml). If you use a config file, you add the `--config [./myconfig.yml]` parameter to the letsencrypt_webfaction command.
-
-This allows you to set up a Cron task for multiple sites with the defaults for all of them (such as your email address) in a config file, and site specific directives in the command. For example:
-
-    $ letsencrypt_webfaction --config [~/le_config.yml] --domains [yourdomain.com,www.yourdomain.com] --public ~/webapps/[yourapp/your_public_html/]
-
-This could be run automatically every two months.
-
-A config file can be placed anywhere in your WebFaction account. A good place might be `~/le_config/siteconfig.yml`.
-
-
 ## Development
 
 If you are interested in contributing to this project with new code or bugfixes, welcome!

data/certs/will_in_wi.pem

@@ -1,7 +1,7 @@
 -----BEGIN CERTIFICATE-----
-MIIDhTCCAm2gAwIBAgIBATANBgkqhkiG9w0BAQUFADBEMRAwDgYDVQQDDAd3aWxs
+MIIDhTCCAm2gAwIBAgIBATANBgkqhkiG9w0BAQsFADBEMRAwDgYDVQQDDAd3aWxs
 aWFtMRwwGgYKCZImiZPyLGQBGRYMam9obnN0b25oYXVzMRIwEAYKCZImiZPyLGQB
-GRYCdXMwHhcNMTcwNDIyMTMzODM5WhcNMTgwNDIyMTMzODM5WjBEMRAwDgYDVQQD
+GRYCdXMwHhcNMTgwNjEwMTMxNTEwWhcNMTkwNjEwMTMxNTEwWjBEMRAwDgYDVQQD
 DAd3aWxsaWFtMRwwGgYKCZImiZPyLGQBGRYMam9obnN0b25oYXVzMRIwEAYKCZIm
 iZPyLGQBGRYCdXMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDl8XJy
 iFDfTJHbPnQ43vJKAjVPwxRnPhThFeWgYlZ//SU6ZbO4GqewDSMyCrjtWOq+mE59
@@ -12,10 +12,10 @@ iL3gD6KBGRCdOVRmX+mgz0mIxchknFslbLE1aU9kNGabVw/25qUVxTid7HN5DAeY
 gkKUO+QWHBNH4QL3AgMBAAGjgYEwfzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAd
 BgNVHQ4EFgQUFOFAV8TE1Qa285rrUux+StPq5WowIgYDVR0RBBswGYEXd2lsbGlh
 bUBqb2huc3RvbmhhdXMudXMwIgYDVR0SBBswGYEXd2lsbGlhbUBqb2huc3Rvbmhh
-dXMudXMwDQYJKoZIhvcNAQEFBQADggEBAKpT/kZxUP3ZmywvtVjwYy2iqKglGPfp
-VUrMDaz3M96EFMH2FGMQDDumCR4OrBvc5URigGhj0qZYJmgBmkCW/gw2sv9RfuZb
-btwEZHcHJrWHW6ys0mD0aGZGptsLbxmm+VJhXNWHKu30Wbmm4yt4lk5atOprYGKp
-M/z07wMPdG5bNazz5iNkuW2HyYJV6BArUfD5fF04m856frBJytLkVe5Q1L83wi7g
-Bgn1/q+P8H+/qkt6w5h8UzWYyXRlEjWvSJEjkNU0C05GQ0w0GFiqd62CgQty5xpa
-7M3NhWEjOZHE18Ro4Vy9CQCJxUasYC4JUMMQ9tQBW+vYIgHfBn0+xlw=
+dXMudXMwDQYJKoZIhvcNAQELBQADggEBAEZ6tJ2dwjke8nJbBATwwqwqqyISybGc
+/uw0ApMsYfK0pninuCV5jfpm4WbmqokqNOfbYvlHLpBKGz7uxJRKOioe6Ivl7LJu
+EHiagTaawLYJK0tZ3fH4K7VFx4pXNIbg6LYzOTIflaBQkVSkaVNfrczTJM11aADC
+qy0EH65AuAgNtypTvnCKGB6pztMIgxK0FTSdZnnxtC1ReQ1U8MpsaYpOap2Yvofo
+ilYPju4QWNSvpNVhV+T7JUvAHXva3Rayfp8SKRpvX8ZpRCjvpYfgbmNxXO2ST1qb
+KBba/yJfCMh+B65HfRUXBQRRDtJ2Vu8i0WmRUKenahAnpkkeVmqhWwY=
 -----END CERTIFICATE-----

data/docs/rbenv.md

@@ -0,0 +1,31 @@
+# Installing with RBenv
+
+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 as described in the readme.
+
+Follow the instructions to [set up RBEnv](https://github.com/rbenv/rbenv) and [Ruby Build](https://github.com/rbenv/ruby-build#readme) on your WebFaction server.
+
+Once you have done so, install Ruby 2.1+, but <2.4 (probably 2.3.1 at time of writing). Then set the local Ruby and install the Gem. Finally unset the local Ruby so that you don't run into problems.
+
+    $ rbenv install 2.3.1 # Installs Ruby 2.3.1
+    $ rbenv local 2.3.1 # Sets Ruby 2.3.1 as the default version in the current folder.
+    $ gem install letsencrypt_webfaction # Installs this utility from RubyGems.
+    $ rbenv rehash # Makes RBenv aware of the letsencrypt_webfaction utility.
+    $ rm .ruby-version # Unsets Ruby 2.3.1 as the default version in the current folder.
+
+*Ruby 2.4.0+ is not supported since they removed the XMLRPC library from core and moved it to a gem. This Gem doesn't work in Ruby <2.3, leaving us with an issue as the majority of system Rubies used with this project are <2.4. So don't use 2.4 for now. If you absolutely want to, make sure you install the xmlrpc gem manually.*
+
+## Cron usage
+
+Instead of the cron command in the readme, when using rbenv it would look like the following:
+
+```cron
+18 3 * * *     RBENV_ROOT=~/.rbenv RBENV_VERSION=2.3.1 ~/.rbenv/bin/rbenv exec letsencrypt_webfaction --letsencrypt_account_email [you@youremail.com] --domains [yourdomain.com,www.yourdomain.com] --public ~/webapps/[yourapp/your_public_html]/ --quiet --username [yourusername] --password [yourpassword]
+```
+
+## Upgrading
+
+To upgrade the installed version, run:
+
+```sh
+RBENV_VERSION=2.3.1 gem install letsencrypt_webfaction
+```

data/docs/upgrading.md

@@ -0,0 +1,49 @@
+# Upgrading from v2 to v3
+
+Version 3 has a number of major ease of use improvements that break backwards compatibility:
+
+- Run one command to update all certs instead of one command per cert.
+- When the command runs, it only updates certs that need updating.
+- Uses a single config file instead of a large set of command arguments.
+
+The basic procedure to upgrade is:
+
+- Upgrade the program
+- Initialize the config file
+- Migrate command lines to the config file
+- Replace crontab lines with new single line
+
+## Upgrade the program
+
+Follow the [instructions in the readme](README.md#Upgrading).
+
+## Initialize the config file
+
+Create the config file by running `letsencrypt_webfaction init` on the server. Edit it to reflect your situation (`nano -w ~/letsencrypt_webfaction.toml`).
+
+## Migrate command lines to the config file
+
+You can dump the letsencrypt_webfaction crontab lines by running `crontab -l | grep letsencrypt_webfaction` on the server. For each line, create a `[[certificate]]` section in the config file.
+
+For example, this:
+
+```sh
+0 4 1 */2 *      RBENV_ROOT=~/.rbenv RBENV_VERSION=2.3.1 ~/.rbenv/bin/rbenv exec letsencrypt_webfaction --domains example.com,www.example.com,test.example.com --public ~/webapps/myapp/ --cert_name mycertname
+```
+
+Would become this:
+
+```toml
+[[certificate]]
+domains = [
+  "example.com",
+  "www.example.com",
+  "test.example.com"
+]
+public = "~/webapps/myapp/"
+name = "mycertname"
+```
+
+## Replace crontab lines with new single line
+
+Once these are all migrated, run `letsencrypt_webfaction run`. You should see output regarding which certs were issued, updated, or ignored. If this looks satisfactory, remove the existing `letsencrypt_webfaction` lines from your crontab (You edit it by running `crontab -e` on the server), and insert the new line from the readme.

data/exe/letsencrypt_webfaction

@@ -1,6 +1,11 @@
 #!/usr/bin/env ruby
 
 require 'letsencrypt_webfaction/application'
+require 'letsencrypt_webfaction/errors'
 
-res = LetsencryptWebfaction::Application.new(ARGV).run!
-exit(res ? 0 : 1)
+begin
+  res = LetsencryptWebfaction::Application.new(ARGV).run!
+  exit(res ? 0 : 1)
+rescue LetsencryptWebfaction::AppExitError
+  exit 1
+end

data/letsencrypt_webfaction.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.1.0'
 
   spec.add_runtime_dependency 'acme-client', '~> 0.6.0'
+  spec.add_runtime_dependency 'toml-rb', '~> 1.1'
 
   # This will be required for Ruby 2.4. But it is incompatible for Ruby <2.3. Unsupporting Ruby 2.4 for the moment.
   # spec.add_runtime_dependency 'xmlrpc', '~> 0.3.0'

data/lib/letsencrypt_webfaction.rb

@@ -1,3 +1,3 @@
 module LetsencryptWebfaction
-  VERSION = '2.2.3'.freeze
+  VERSION = '3.0.0'.freeze
 end

data/lib/letsencrypt_webfaction/application.rb

@@ -1,92 +1,40 @@
-require 'openssl'
-require 'acme-client'
-
-require 'letsencrypt_webfaction/args_parser'
-require 'letsencrypt_webfaction/domain_validator'
-require 'letsencrypt_webfaction/certificate_installer'
-require 'letsencrypt_webfaction/webfaction_api_credentials'
+require 'letsencrypt_webfaction/application/init'
+require 'letsencrypt_webfaction/application/run'
 
 module LetsencryptWebfaction
-  class Application
-    def initialize(args)
-      @options = LetsencryptWebfaction::ArgsParser.new(args)
-    end
-
-    def run!
-      # Validate that the correct options were passed.
-      validate_options!
-
-      # Check credentials
-      unless api_credentials.valid?
-        $stderr.puts 'WebFaction API username, password, and/or servername are incorrect. Login failed.'
-        exit 1
+  module Application
+    SUPPORTED_COMMANDS = {
+      'init' => LetsencryptWebfaction::Application::Init,
+      'run' => LetsencryptWebfaction::Application::Run,
+    }.freeze
+
+    V2_COMMANDS = %i[key_size endpoint domains public letsencrypt_account_email api_url username password servername cert_name].freeze
+
+    class << self
+      def new(args) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        if args[0].nil?
+          $stderr.puts "Missing command. Must be one of #{SUPPORTED_COMMANDS.keys.join(', ')}"
+          raise LetsencryptWebfaction::AppExitError, 'Missing command'
+        elsif v2_command?(args)
+          $stderr.puts 'It looks like you are trying to run a version 2 command in version 3'
+          $stderr.puts 'See https://github.com/will-in-wi/letsencrypt-webfaction/blob/master/docs/upgrading.md'
+          raise LetsencryptWebfaction::AppExitError, 'v2 command'
+        else
+          klass = SUPPORTED_COMMANDS[args[0]]
+          if klass.nil?
+            $stderr.puts "Unsupported command `#{args[0]}`. Must be one of #{SUPPORTED_COMMANDS.keys.join(', ')}"
+            raise LetsencryptWebfaction::AppExitError, 'Unsupported command'
+          else
+            klass.new(args[1..-1])
+          end
+        end
       end
 
-      # Register the private key.
-      register_key!
-
-      # Validate the domains.
-      return unless validator.validate!
-
-      # Write the obtained certificates.
-      certificate_installer.install!
-
-      output_success_help
-    end
-
-    private
-
-    def api_credentials
-      @_api_credentials ||= LetsencryptWebfaction::WebfactionApiCredentials.new username: @options.username, password: @options.password, servername: @options.servername, api_server: @options.api_url
-    end
-
-    def certificate_installer
-      @certificate_installer ||= LetsencryptWebfaction::CertificateInstaller.new(@options.cert_name, certificate, api_credentials)
-    end
-
-    def certificate
-      # We can now request a certificate, you can pass anything that returns
-      # a valid DER encoded CSR when calling to_der on it, for example a
-      # OpenSSL::X509::Request too.
-      @certificate ||= client.new_certificate(csr)
-    end
+      private
 
-    def csr
-      # We're going to need a certificate signing request. If not explicitly
-      # specified, the first name listed becomes the common name.
-      @csr ||= Acme::Client::CertificateRequest.new(names: @options.domains)
-    end
-
-    def validator
-      @validator ||= LetsencryptWebfaction::DomainValidator.new @options.domains, client, @options.public
-    end
-
-    def client
-      @client ||= Acme::Client.new(private_key: private_key, endpoint: @options.endpoint)
-    end
-
-    def register_key!
-      # If the private key is not known to the server, we need to register it for the first time.
-      registration = client.register(contact: "mailto:#{@options.letsencrypt_account_email}")
-
-      # You'll may need to agree to the term (that's up the to the server to require it or not but boulder does by default)
-      registration.agree_terms
-    end
-
-    def validate_options!
-      return if @options.valid?
-      raise ArgumentError, @options.errors.values.join("\n")
-    end
-
-    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.'
+      def v2_command?(args)
+        (args & (V2_COMMANDS.map { |arg| "--#{arg}" })).any?
+      end
     end
   end
 end