letsencrypt_webfaction 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7df37c878990ab6cc66c72d383fd790c1438ea80
-  data.tar.gz: 7f90d70c80b4f1522f725bdb76289a7673cde3cc
+  metadata.gz: 7ce33f9963c0f2f176f271677a4940058999553f
+  data.tar.gz: 0d3e010e9f36feeb6ad4b683614fd8bcfee88988
 SHA512:
-  metadata.gz: c3ead0e1aa11a3635136056379479e5e7a4124b85ef50612320066cecca7ffc1699840fac19a1a0eada1cfd3d065e4429e833ac7a519d87ae503cde3cf1a5768
-  data.tar.gz: 72dfad675873758f4179382499863e72735051b6d7be902346584510331b7494b5805f3ba91f6b714912b7ff17634de907c0e9e65961cbf5a5966b7948e653af
+  metadata.gz: 97a8d46981d1a5d2252be5a832e6f9ec68be1d61864a3166a9f7272d7c246098176a64f9177e5529710b5ac7dd7a29bf381a62f994b2e8740c225f49945602a2
+  data.tar.gz: 675c9b21c9f794794f316a9194ea0edca89d7810b9ad02dc1e40e9f53a2c7c342f361b822dcafbde3e1530d3fc4a162d752a379e2aff1b72264717ac115e80e2

data/.codeclimate.yml

@@ -0,0 +1,24 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Rails: false
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitignore

@@ -7,3 +7,6 @@
 
 # Ignore code coverage output.
 /coverage
+
+# Ignore vim locks
+*.swp

data/.rubocop.yml

@@ -35,3 +35,9 @@ Style/Send:
 # If you interpolate a literal, just include it in the string itself.
 Lint/LiteralInInterpolation:
   Enabled: true
+
+# Personal preference. Makes the diffs smaller.
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+v0.0.3
+
+* Updates to readme.
+
+v0.0.2
+
+* Fix a bug related to Gem pathing and the defaults.yml file.
+
+v0.0.1
+
+* Initial release.

data/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2016 William Johnston
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -2,13 +2,45 @@
 
 LetsEncrypt utility client for WebFaction hosts.
 
-This tool simplifies the manual process of using LetsEncrypt on Webfaction hosts. It can be added to cron where it will validate your domains automatically, place the generated certificates in a common folder, and then email you directions and example text to send the WebFaction support team.
+This tool simplifies the manual process of using LetsEncrypt on Webfaction hosts. It can be added to cron where it will validate your domains automatically, place the generated certificates in a common folder, and then email the Webfaction support team to request installation, also notifying you.
 
 [![Build Status](https://travis-ci.org/will-in-wi/letsencrypt-webfaction.svg?branch=master)](https://travis-ci.org/will-in-wi/letsencrypt-webfaction)
 
+[![Gem Version](https://badge.fury.io/rb/letsencrypt_webfaction.svg)](https://badge.fury.io/rb/letsencrypt_webfaction)
+
+[![Code Climate](https://codeclimate.com/github/will-in-wi/letsencrypt-webfaction/badges/gpa.svg)](https://codeclimate.com/github/will-in-wi/letsencrypt-webfaction)
+
 ## Installation
 
-Because WebFaction has an unusual Ruby setup with the default Ruby as 1.8, I recommend that you [set up RBEnv](https://github.com/rbenv/rbenv) and [Ruby Build](https://github.com/rbenv/ruby-build#readme) on your WebFaction server to run this script.
+This utility works on [CentOS 6 and 7 boxes](https://docs.webfaction.com/user-guide/server.html#finding-your-server-s-operating-system). The CentOS 5 systems do not have a new enough OpenSSL to include the algorithms required. You may be able to make this work using rbenv and compiling openssl yourself.
+
+You can install LetsEncrypt Webfaction using the system Ruby or using RBEnv.
+
+### System Ruby
+
+This is the simpler method and is preferred.
+
+Run the following command to install:
+
+```sh
+GEM_HOME=$HOME/.letsencrypt_webfaction/gems RUBYLIB=$GEM_HOME/lib gem2.2 install letsencrypt_webfaction
+```
+
+Add the following to `~/.bash_profile`:
+
+```sh
+function letsencrypt_webfaction {
+    PATH=$PATH:$GEM_HOME/bin GEM_HOME=$HOME/.letsencrypt_webfaction/gems RUBYLIB=$GEM_HOME/lib ruby2.2 $HOME/.letsencrypt_webfaction/gems/bin/letsencrypt_webfaction $*
+}
+```
+
+Now, you can run `letsencrypt_webfaction` from the shell.
+
+### RBEnv
+
+This method is useful if you are already using RBEnv to manage Ruby.
+
+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+ (probably 2.3.0 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.
 
@@ -22,7 +54,7 @@ Once you have done so, install Ruby 2.1+ (probably 2.3.0 at time of writing). Th
 
 Basic example:
 
-    $ letsencrypt_webfaction --contact me@example.com --domains example.com,www.example.com --public ~/webapps/myapp/public_html/
+    $ letsencrypt_webfaction --account_email me@example.com --domains example.com,www.example.com --public ~/webapps/myapp/public_html/
 
 To quickly get a list of parameters, you can call:
 
@@ -34,7 +66,10 @@ Normally, you will run the script manually once to get the certificate, and then
 
 Your cron task could look something like:
 
-    0 4 * */2 *     cd /home/williaminwi/Projects/letsencrypt-webfaction && RBENV_ROOT=~/.rbenv RBENV_VERSION=2.3.0 ~/.rbenv/bin/rbenv exec letsencrypt_webfaction --contact you@example.com --domains example.com,www.example.com --public ~/webapps/myapp/
+    # System Ruby Installation
+    0 4 1 */2 *     PATH=$PATH:$GEM_HOME/bin GEM_HOME=$HOME/.letsencrypt_webfaction/gems RUBYLIB=$GEM_HOME/lib ruby2.2 $HOME/.letsencrypt_webfaction/gems/bin/letsencrypt_webfaction --account_email you@example.com --domains example.com,www.example.com --public ~/webapps/myapp/
+    # RBEnv Installation
+    0 4 1 */2 *     RBENV_ROOT=~/.rbenv RBENV_VERSION=2.3.0 ~/.rbenv/bin/rbenv exec letsencrypt_webfaction --account_email you@example.com --domains example.com,www.example.com --public ~/webapps/myapp/
 
 This [would run](http://crontab.guru/#0_4_*_*/2_*) at 4 a.m. in Jan, Mar, May, Jul, Sep, and Nov. Certificates expire three months after issuance, so modify as desired.
 
@@ -56,9 +91,7 @@ This could be run automatically every two months.
 
 When the code runs, it places verification files into a public directory, validates the domains with LetsEncrypt (or your ACME provider), and then dumps the signed certificate and private key into an output folder. By default, the output folder is `~/le_certs/`, inside which it will create `[domain_name]/[timestamp]/`.
 
-After this is done, the utility will dump to stdout instructions regarding how to request that your new certs be installed by the WebFaction admins. This will include sample text and a link to https://help.webfaction.com/.
-
-If you use Cron, you should set `MAILTO=youremail@example.com` and `MAILFROM=username@servername.webfaction.com` at the top in order to receive the instructions. The [WebFaction docs](https://docs.webfaction.com/software/general.html#scheduling-tasks-cron) have more details about how to do this.
+After this is done, the utility will email the cert installation request to Webfaction support and also copy you.
 
 If you see messages containing SyntaxErrors, you are most likely using an old version of Ruby. This utility requires Ruby 2.1+.
 
@@ -78,6 +111,8 @@ To run the script directly from the repository, use:
 
 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 5 certs per domain every 7 days rate limit. You can add the `--endpoint https://acme-staging.api.letsencrypt.org/` parameter to do so.
 
+You will probably also want to use the argument `--support_email ""` which will keep support from actually being contacted. Alternately, set the `support_email` address to be yourself.
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bin/rake install`. To release a new version, update the version number in `lib/letsencrypt_webfaction.rb`, and then run `bin/rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). This project uses [Semantic Versioning](http://semver.org/).

data/config.defaults.yml

@@ -3,5 +3,8 @@ key_size: 4096
 endpoint: 'https://acme-v01.api.letsencrypt.org/'
 domains: []
 public: ''
-contact: ''
 output_dir: '~/le_certs/'
+support_email: 'support@webfaction.com'
+account_email: ''
+admin_notification_email: '' # Defaults to the value given in account_email.
+letsencrypt_account_email: '' # Defaults to the value given in account_email.

data/config.example.yml

@@ -1,6 +1,8 @@
+# See config.defaults.yml for all available settings.
+
 key_size: 4096
 endpoint: 'https://acme-v01.api.letsencrypt.org/'
-contact: 'me@example.com'
+account_email: 'me@example.com'
 domains:
   - 'example.com'
   - 'www.example.com'

data/exe/letsencrypt_webfaction

@@ -2,4 +2,4 @@
 
 require 'letsencrypt_webfaction/application'
 
-LetsencryptWebfaction::Application.new.run!
+LetsencryptWebfaction::Application.new(ARGV).run!

data/letsencrypt_webfaction.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.1.0'
 
   spec.add_runtime_dependency 'acme-client', '~> 0.3.0'
+  spec.add_runtime_dependency 'pony', '~> 1.11'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
@@ -34,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.37'
   spec.add_development_dependency 'simplecov', '~> 0.11'
   spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'pry-byebug', '~> 3.3'
 end

data/lib/letsencrypt_webfaction.rb

@@ -1,3 +1,3 @@
 module LetsencryptWebfaction
-  VERSION = '0.0.2'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/letsencrypt_webfaction/application.rb

@@ -5,11 +5,12 @@ require 'letsencrypt_webfaction/args_parser'
 require 'letsencrypt_webfaction/domain_validator'
 require 'letsencrypt_webfaction/certificate_writer'
 require 'letsencrypt_webfaction/instructions'
+require 'letsencrypt_webfaction/emailer'
 
 module LetsencryptWebfaction
   class Application
-    def initialize
-      @options = LetsencryptWebfaction::ArgsParser.new(ARGV)
+    def initialize(args)
+      @options = LetsencryptWebfaction::ArgsParser.new(args)
     end
 
     def run!
@@ -25,12 +26,16 @@ module LetsencryptWebfaction
       # Write the obtained certificates.
       certificate_writer.write!
 
-      # Dump help text.
-      puts instructions.message
+      # Send emails.
+      emailer.send!
     end
 
     private
 
+    def emailer
+      @emails ||= LetsencryptWebfaction::Emailer.new instructions, support_email: @options.support_email, account_email: @options.account_email, notification_email: @options.admin_notification_email
+    end
+
     def instructions
       @instructions ||= LetsencryptWebfaction::Instructions.new certificate_writer.output_dir, @options.domains
     end
@@ -62,7 +67,7 @@ module LetsencryptWebfaction
 
     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.contact}")
+      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
@@ -70,8 +75,7 @@ module LetsencryptWebfaction
 
     def validate_options!
       return if @options.valid?
-      puts @options.errors.values.join("\n")
-      exit
+      raise ArgumentError, @options.errors.values.join("\n")
     end
 
     def private_key

data/lib/letsencrypt_webfaction/args_parser.rb

@@ -15,10 +15,13 @@ module LetsencryptWebfaction
     FIELDS = [
       Field::IntegerField.new(:key_size, 'Size of private key (e.g. 4096)', [DefinedValuesValidator.new(VALID_KEY_SIZES)]),
       Field.new(:endpoint, 'ACME endpoint (e.g. https://acme-v01.api.letsencrypt.org/)', [StringValidator.new]),
-      Field.new(:contact, 'Email address to notify on renewal', [StringValidator.new]),
       Field::ListField.new(:domains, 'Comma separated list of domains. The first one will be the common name.', [ArrayValidator.new]),
       Field.new(:public, 'Location on the filesystem served by the desired site (e.g. ~/webapps/myapp/public_html)', [StringValidator.new]),
-      Field.new(:output_dir, 'Location on the filesystem to which the certs will be saved.', [StringValidator.new])
+      Field.new(:output_dir, 'Location on the filesystem to which the certs will be saved.', [StringValidator.new]),
+      Field.new(:support_email, 'The email address of the ISP support.', []),
+      Field.new(:account_email, 'The email address associated with your account.', [StringValidator.new]),
+      Field.new(:admin_notification_email, 'The email address associated with your account. Defaults to the value of account_email.', []),
+      Field.new(:letsencrypt_account_email, 'The email address associated with your account. Defaults to the value of account_email.', []),
     ].freeze
 
     # Set up getters.
@@ -97,6 +100,15 @@ module LetsencryptWebfaction
 
     def parse!
       opt_parser.parse!(@options)
+
+      # Set defaults from other fields.
+      if @admin_notification_email.nil? || @admin_notification_email == ''
+        @admin_notification_email = @account_email
+      end
+
+      if @letsencrypt_account_email.nil? || @letsencrypt_account_email == ''
+        @letsencrypt_account_email = @account_email
+      end
     end
   end
 end

data/lib/letsencrypt_webfaction/emailer.rb

@@ -0,0 +1,34 @@
+require 'pony'
+
+module LetsencryptWebfaction
+  class Emailer
+    SUBJECT_MESSAGE = 'New certificate installation'.freeze
+
+    def initialize(instructions, support_email: '', account_email: '', notification_email: '')
+      @instructions = instructions
+
+      raise Error, 'Missing account_email' if account_email == '' || account_email.nil?
+      raise Error, 'Missing notification_email' if notification_email == '' || notification_email.nil?
+
+      @support_email = support_email
+      @account_email = account_email
+      @notification_email = notification_email
+    end
+
+    def send!
+      send_to_support!
+      send_to_account!
+    end
+
+    def send_to_support!
+      return if @support_email.nil? || @support_email == ''
+      Pony.mail(to: @support_email, from: @account_email, subject: SUBJECT_MESSAGE, body: @instructions.instructions)
+    end
+
+    def send_to_account!
+      Pony.mail(to: @notification_email, from: @notification_email, subject: SUBJECT_MESSAGE, body: @instructions.full_message(support_email: @support_email != ''))
+    end
+
+    class Error < StandardError; end
+  end
+end

data/lib/letsencrypt_webfaction/instructions.rb

@@ -5,17 +5,30 @@ module LetsencryptWebfaction
       @domains = domains
     end
 
-    def message
-      'LetsEncrypt Webfaction has generated a new certificate for ' \
-      "#{to_sentence @domains}. The certificates have been placed in " \
-      "#{@output_dir}. You now need to request installation from the " \
-      "WebFaction support team.\n\n" \
-      'Go to https://help.webfaction.com, log in, and paste the ' \
-      "following text into a new ticket:\n\n" \
+    def context(support_email: true)
+      out = 'LetsEncrypt Webfaction has generated a new certificate for ' \
+        "#{to_sentence @domains}. The certificates have been placed in " \
+        "#{@output_dir}. "
+
+      out << if support_email
+               'WebFaction support has been contacted with the following message:'
+             else
+               'Go to https://help.webfaction.com, log in, and paste the ' \
+               'following text into a new ticket:'
+             end
+
+      out
+    end
+
+    def instructions
       "Please apply the new certificate in #{@output_dir} to " \
       "#{to_sentence @domains}. Thanks!"
     end
 
+    def full_message(support_email: true)
+      context(support_email: support_email) + "\n\n" + instructions
+    end
+
     private
 
     # Borrowed (with simplifications) from ActiveSupport.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: letsencrypt_webfaction
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - William Johnston
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-06 00:00:00.000000000 Z
+date: 2016-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acme-client
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 description: A tool to simplify the manual process of using LetsEncrypt on Webfaction
   hosts. It can be added to cron where it will validate your domains automatically,
   place the generated certs in a common folder, and then email you directions and
@@ -119,11 +147,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
@@ -144,6 +175,7 @@ files:
 - lib/letsencrypt_webfaction/args_parser/string_validator.rb
 - lib/letsencrypt_webfaction/certificate_writer.rb
 - lib/letsencrypt_webfaction/domain_validator.rb
+- lib/letsencrypt_webfaction/emailer.rb
 - lib/letsencrypt_webfaction/instructions.rb
 homepage: https://github.com/will-in-wi/letsencrypt-webfaction
 licenses:
@@ -165,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: LetsEncrypt utility client for WebFaction hosts.