pdf_mage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b94ce6a010e8a551ca483651eb2998f2341d4f70d937f95de3737bf5eb063388
+  data.tar.gz: 11524a2c1e1e2a43b673616301510eab6a47c2919ac578ff653683d57b2552c1
+SHA512:
+  metadata.gz: 44f11f5a1d38e3eb1d221fee75349d618ff054c13554e667470987bd87a54c3a280456794e75f8d2b332af6a9a8677a8d6c75ab0b9cac57e51dfea9169f1767e
+  data.tar.gz: 0b107577a60a86e1353905b29c71d0cd7341d1f7c8a3141a0262e04e9bf53f9536fa5dd28dc5631dd8ff78a850a071260dc22f5eb7ca788ffe60424fa7749af7

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: 5DNjehW2z6VK8jjiE5qMyGlUqN4t8UBHM

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+/pdfs/
+*.local
+*.local.yml
+*.log
+/spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.5.1
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 25
+  Exclude:
+    - spec/**/*
+
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+Metrics/PerceivedComplexity:
+  Max: 8

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+addons:
+  chrome: stable
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dean.g.papastrat@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+gemspec

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    pdf_mage (0.1.0)
+      aws-sdk-s3 (~> 1)
+      redis (~> 4.0)
+      sidekiq (~> 5.1)
+      sinatra (~> 2.0)
+      typhoeus (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    aws-eventstream (1.0.0)
+    aws-partitions (1.90.0)
+    aws-sdk-core (3.21.2)
+      aws-eventstream (~> 1.0)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-kms (1.5.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sdk-s3 (1.13.0)
+      aws-sdk-core (~> 3, >= 3.21.2)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.0)
+    aws-sigv4 (1.0.2)
+    concurrent-ruby (1.0.5)
+    connection_pool (2.2.2)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.24)
+    jmespath (1.4.0)
+    json (2.1.0)
+    mustermann (1.0.2)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rack (2.0.5)
+    rack-protection (2.0.1)
+      rack
+    rainbow (3.0.0)
+    rake (10.5.0)
+    redis (4.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.56.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    sidekiq (5.1.3)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sinatra (2.0.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.1)
+      tilt (~> 2.0)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tilt (2.0.8)
+    tins (1.16.3)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  coveralls (~> 0.8)
+  pdf_mage!
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  rubocop (~> 0.56)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sideqik
+
+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

@@ -0,0 +1,108 @@
+# PdfMage ![Build Status](https://travis-ci.org/sideqik/pdf-mage.svg?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/49a43b30df054740910ac010042372bb)](https://www.codacy.com/app/Sideqik/pdf-mage?utm_source=github.com&utm_medium=referral&utm_content=sideqik/pdf-mage&utm_campaign=Badge_Grade) [![Coverage Status](https://coveralls.io/repos/github/sideqik/pdf-mage/badge.svg?branch=master)](https://coveralls.io/github/sideqik/pdf-mage?branch=master)
+
+PdfMage is a standalone microservice packaged as a Ruby gem that you makes it simple to render PDFs using Headless Chrome on a standalone server.
+
+It includes support for:
+
+- Uploading PDFs to AWS S3
+- Webhooks
+- API "secrets" for security
+
+Please note, the documentation is still in-progress!
+
+## Installation
+
+Clone the repository to your computer and navigate to the directory:
+
+```sh
+git clone https://github.com/sideqik/pdf-mage.git
+cd pdf-mage
+```
+
+Then install bundler if you haven't already done so:
+
+```sh
+gem install bundler
+```
+
+Finally, run the setup command:
+
+```sh
+bin/setup
+```
+
+## Running the Server
+
+To run the server, you need to turn run both the API and the Sidekiq job server. If running in production, make sure to enable the environment flag for it, or else it'll default to the development environment.
+
+```sh
+PDFMAGE_ENV=production bin/pdf_mage
+PDFMAGE_ENV=production bin/sidekiq
+```
+
+We recommend using a service such as `monit` to keep these processes alive in production, as system issues could cause them to crash and not be restarted.
+
+## Configuration
+
+Create a config.yml.local file and overwrite any of the following properties:
+
+| name | type | description |
+| ---- | ---- | ----------- |
+| api_secret | String | TBD |
+| aws_account_key | String | Key in your AWS S3 API credentials
+| aws_account_bucket | String | Bucket to upload PDFs into
+| aws_account_region | String | Region to upload PDFs into
+| aws_account_secret | String | Secret in your AWS S3 API credentials
+| aws_presigned_url_duration | Integer | How long the returned URL in the presigned-request should exist for, in seconds
+| chrome_exe | String | Path to the Chrome executable
+| delete_file_on_upload | Boolean | Whether or not to delete PDFs after they're uploaded
+| log_level | String | What level of logs to write to the logfile
+| pdf_directory | String | Where to locally store PDFs
+
+Then, when starting the server, pass `CONFIG_FILE=config.yml.local`.
+
+```sh
+CONFIG_FILE=config.yml.local bin/pdf_mage
+CONFIG_FILE=config.yml.local bin/sidekiq
+```
+
+### Using the "Secret" for Security
+
+If you use the API secret config option, you can add security to your application. Adding a secret will:
+
+1. Require you to pass a "secret" param with every request to PDF Mage's render resource, where the value is the secret set in the config.
+2. Request the website url you want PDF Mage to render with a "secret" parameter, with the value you set in the config.
+3. Sign the webhook sent to your server with a SHA256 hexdigest as a "X-Pdf-Signature" header. See info about checking the signature below.
+
+**To check the X-Pdf-Signature header:**
+
+1. Create a SHA256 HMAC hexdigest using the config secret as the key and the response body as the data.
+2. Compare the hexdigest to the signature provided.
+
+**Example in Ruby:**
+
+```ruby
+# Generate the signature that should have been returned
+valid_signature = OpenSSL::HMAC.hexdigest('sha256', CONFIG.api_secret, response.body)
+
+# Compare the signatures
+response.headers['X-Pdf-Signature'] == valid_signature
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sidekiq/pdf_mage. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PdfMage project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sidekiq/pdf_mage/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'pdf_mage'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/pdf_mage

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+begin
+  require 'pdf_mage'
+rescue LoadError
+  require 'rubygems'
+  path = File.expand_path('../lib', __dir__)
+  $LOAD_PATH.unshift(path) if File.directory?(path) && !$LOAD_PATH.include?(path)
+  require 'pdf_mage'
+end
+
+PdfMage.start!

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/sidekiq

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+bundle exec sidekiq -r ./lib/pdf_mage_workers.rb -q pdfmage

data/lib/pdf_mage.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+MODE = 'api'
+
+require 'pdf_mage/init'
+require 'pdf_mage/api/app'
+
+# Root loader for all PdfMage classes & modules
+module PdfMage
+  # Starts the PdfMage API Application
+  # @return [NilClass]
+  def self.start!
+    PdfMage::Api::App.run!
+    nil
+  end
+end

data/lib/pdf_mage/api/app.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'sinatra'
+require 'json'
+require 'pdf_mage/workers/render_pdf'
+
+module PdfMage
+  module Api
+    # The PdfMage Sinatra API application, which has /status and /render endpoints that you can call to render PDFs
+    # from another server over HTTPS.
+    # @since 0.1.0
+    class App < Sinatra::Base
+      set :environment, :production
+
+      before do
+        content_type :json
+      end
+
+      error do
+        e = env['sinatra.error']
+        error(500, e.message)
+      end
+
+      get '/status' do
+        { result: 'ok' }.to_json
+      end
+
+      post '/render' do
+        authorize!
+        url = required_param(:url)
+        callback_url = params[:callback_url]
+        filename = params[:filename]
+        meta = params[:meta]
+
+        job_id = PdfMage::Workers::RenderPdf.perform_async(url, callback_url, filename, meta)
+        { result: 'ok', job_id: job_id }.to_json
+      end
+
+      def authorize!
+        return unless CONFIG.api_secret
+        error(401, 'Unauthorized') unless params[:secret] && params[:secret].strip == CONFIG.api_secret
+      end
+
+      def error(code, message)
+        halt code, { result: 'error', message: message }.to_json
+      end
+
+      def required_param(key)
+        value = params[key]
+        error(422, "Required parameter '#{key}' is missing") unless value && !value.empty?
+        value
+      end
+    end
+  end
+end

data/lib/pdf_mage/config.yml

@@ -0,0 +1,10 @@
+api_secret: null
+aws_account_key: null
+aws_account_bucket: null
+aws_account_region: 'us-east-1'
+aws_account_secret: null
+aws_presigned_url_duration: 600
+chrome_exe: chrome
+delete_file_on_upload: true
+log_level: 'info'
+pdf_directory: 'pdfs'

data/lib/pdf_mage/init.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'ostruct'
+require 'yaml'
+
+ENVIRONMENTS = %w[development test staging production].freeze
+
+# Load Environment
+current_env = ENV['PDFMAGE_ENV'] || 'development'
+env_config = OpenStruct.new
+env_config.current = current_env
+ENVIRONMENTS.each { |env| env_config[env] = current_env == env }
+
+# Load Config Files
+user_config_filename = ENV['CONFIG_FILE'] ? File.expand_path(ENV['CONFIG_FILE']) : 'config.local.yml'
+default_config_file  = File.new(File.expand_path('lib/pdf_mage/config.yml'))
+
+# Build Configuration
+config_hash = YAML.safe_load(default_config_file).to_h
+
+if File.exist?(user_config_filename)
+  user_config_file = File.new(user_config_filename)
+  user_config      = YAML.safe_load(user_config_file).to_h
+  config_hash      = config_hash.merge(user_config)
+end
+
+config      = OpenStruct.new(config_hash)
+config.env  = env_config.freeze
+CONFIG      = config.freeze
+
+# Build Logger
+LOGGER = Logger.new(STDOUT)
+LOGGER.level = CONFIG.log_level
+LOGGER.freeze

data/lib/pdf_mage/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PdfMage
+  VERSION = '0.1.0'
+end

data/lib/pdf_mage/workers/base.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'sidekiq'
+require 'uri'
+
+module PdfMage
+  module Workers
+    # Base worker class that configures Sidekiq options and all workers extend.
+    # @since 0.1.0
+    class Base
+      include Sidekiq::Worker
+      sidekiq_options queue: 'pdfmage'
+
+      # Options for the strip string method, for use with the String#encode method.
+      # @private
+      STRIP_STRING_OPTIONS = {
+        invalid: :replace,
+        undef: :replace,
+        replace: '',
+        universal_newline: true
+      }.freeze
+
+      # Creates directories in the filesystem for the given filename, so that writing a file to that location succeeds.
+      #
+      # @param [String] filename - string that represents the path the PDF will be created at
+      # @return [NilClass]
+      #
+      # @raise [ArgumentError] if filename is nil or an empty string
+      def ensure_directory_exists_for_pdf(filename)
+        unless string_exists?(filename)
+          raise ArgumentError, 'filename must be a string that includes at least 1 ASCII character.'
+        end
+
+        directory_path = filename.split('/').slice(0..-2).join('/')
+        FileUtils.mkdir_p(directory_path) if string_exists?(directory_path)
+        nil
+      end
+
+      # Generates a filename for a unique PDF identifier using the pdf directory specified in the config and the given
+      # pdf id.
+      #
+      # @param [String] pdf_id - PDF identifier to make filename from
+      # @return [String] filename to store PDF at
+      #
+      # @raise [ArgumentError] if pdf_id is nil or an empty string
+      # @raise [ArgumentError] if CONFIG.pdf_directory is nil or an empty string
+      def pdf_filename(pdf_id)
+        return @filename if defined?(@filename)
+
+        unless string_exists?(pdf_id)
+          raise ArgumentError, 'pdf_id must be a string that includes at least 1 ASCII character.'
+        end
+
+        unless string_exists?(CONFIG.pdf_directory)
+          raise ArgumentError, '
+            The pdf_directory in your config.yml must be a string that includes at least 1 ASCII character.
+          '
+        end
+
+        filename = "#{CONFIG.pdf_directory}/#{pdf_id}"
+        filename += '.pdf' unless pdf_id.end_with?('.pdf')
+
+        @filename = filename
+      end
+
+      # Adds the API secret to a URL.
+      #
+      # @param [String] url - URL to add the API secret from the config to
+      # @return [String] url with secret
+      #
+      # @raise [ArgumentError] if url is nil or an empty string
+      def secretize_url(url)
+        unless string_exists?(url) && (uri = URI(url)) && uri.scheme&.match(/^https?$/)
+          raise ArgumentError, 'url must be a valid url using the http/s protocol.'
+        end
+
+        if CONFIG.api_secret
+          new_query_params = URI.decode_www_form(uri.query.to_s) << ['secret', CONFIG.api_secret]
+          uri.query = URI.encode_www_form(new_query_params)
+          uri.to_s
+        else
+          url
+        end
+      end
+
+      # Checks if the given string is not nil and is not empty, like ActiveSupport's String#present?
+      #
+      # @param [String] string - string to strip non-ASCII characters from
+      # @return [TrueClass, FalseClass] boolean of if the string is present or not
+      def string_exists?(string)
+        !string.nil? && !string.empty?
+      end
+
+      # Removes all non-ASCII characters from a string.
+      #
+      # @param [String] string - string to strip non-ASCII characters from
+      # @return [String, NilClass] string with non-ASCII characters removed or nil if given nil
+      def strip_string(string)
+        string&.encode(Encoding.find('ASCII'), STRIP_STRING_OPTIONS)
+      end
+    end
+  end
+end

data/lib/pdf_mage/workers/render_pdf.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'send_webhook'
+require_relative 'upload_file'
+require 'securerandom'
+
+module PdfMage
+  module Workers
+    # A Sidekiq job that renders a PDF using Chrome headless and kicks off post-render tasks, such as webhook
+    # processing or uploading to Amazon S3.
+    # @since 0.1.0
+    class RenderPdf < PdfMage::Workers::Base
+      def perform(website_url, callback_url = nil, filename = nil, meta = nil)
+        LOGGER.info "Rendering [#{website_url}] with callback [#{callback_url}] and meta: #{meta.inspect}"
+
+        stripped_filename = strip_string(filename)
+        stripped_filename_present = string_exists?(stripped_filename)
+
+        # If a filename exists and the stripped version causes the string to be empty, warn about it in the logs.
+        if filename && !stripped_filename_present
+          LOGGER.warn "'#{filename}' is not a valid ASCII string, falling back to UUID for PDF name."
+        end
+
+        pdf_id = stripped_filename_present ? stripped_filename : SecureRandom.uuid
+        ensure_directory_exists_for_pdf(pdf_filename(pdf_id))
+        url_with_secret = secretize_url(website_url)
+
+        `#{CONFIG.chrome_exe} --headless --disable-gpu --print-to-pdf=#{pdf_filename(pdf_id)} #{url_with_secret}`
+
+        raise "Error executing chrome PDF export. Status: [#{status}]" unless $CHILD_STATUS.zero?
+        LOGGER.info "Rendered PDF [#{pdf_id}] with status [#{status}]"
+
+        if CONFIG.aws_account_key
+          PdfMage::Workers::UploadFile.perform_async(pdf_id, callback_url, meta)
+        elsif string_exists?(callback_url)
+          PdfMage::Workers::SendWebhook.perform_async(pdf_filename(pdf_id), callback_url, meta)
+        end
+      end
+    end
+  end
+end

data/lib/pdf_mage/workers/send_webhook.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require 'typhoeus'
+
+module PdfMage
+  module Workers
+    # A Sidekiq job that sends a webhook after a PDF has been rendered or uploaded.
+    # @since 0.1.0
+    class SendWebhook < PdfMage::Workers::Base
+      def perform(file_url_or_path, callback_url, meta = nil)
+        LOGGER.info "Sending webhook to [#{callback_url}] for file [#{file_url_or_path}] and meta: #{meta.inspect}"
+        params = {
+          file: file_url_or_path,
+          meta: meta
+        }
+
+        data = params.to_json
+        headers = {
+          'content-type' => 'application/json',
+          'user-agent' => 'PdfMage/1.0'
+        }
+
+        headers['X-Pdf-Signature'] = OpenSSL::HMAC.hexdigest('sha256', CONFIG.api_secret, data) if CONFIG.api_secret
+
+        response = Typhoeus.post(callback_url, headers: headers, body: data, ssl_verifypeer: !CONFIG.env.development)
+        LOGGER.info "Received response with status [#{response.code}]: #{response.body}"
+      end
+    end
+  end
+end

data/lib/pdf_mage/workers/upload_file.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'send_webhook'
+require 'aws-sdk-s3'
+
+module PdfMage
+  module Workers
+    # A Sidekiq job that uploads a rendered PDF to Amazon S3.
+    # @since 0.1.0
+    class UploadFile < PdfMage::Workers::Base
+      def perform(pdf_id, callback_url = nil, meta = nil)
+        validate_aws_config!
+
+        s3 = Aws::S3::Resource.new(
+          access_key_id: CONFIG.aws_account_key,
+          region: CONFIG.aws_account_region,
+          secret_access_key: CONFIG.aws_account_secret
+        )
+
+        obj = s3.bucket(CONFIG.aws_account_bucket).object(pdf_id)
+        obj.upload_file(pdf_filename(pdf_id))
+        pdf_url = obj.presigned_url(:get, expires_in: CONFIG.aws_presigned_url_duration)
+
+        `rm #{pdf_filename(pdf_id)}` if CONFIG.delete_file_on_upload
+        PdfMage::Workers::SendWebhook.perform_async(pdf_url, callback_url, meta) if string_exists?(callback_url)
+      end
+
+      private
+
+      # Checks for the present of all necessary AWS config options.
+      def validate_aws_config!
+        unless string_exists?(CONFIG.aws_account_key)
+          raise ArgumentError, 'You must define aws_account_key in your config file to upload PDFs.'
+        end
+
+        unless string_exists?(CONFIG.aws_account_secret)
+          raise ArgumentError, 'You must define aws_account_secret in your config file to upload PDFs.'
+        end
+
+        unless string_exists?(CONFIG.aws_account_region)
+          raise ArgumentError, 'You must define aws_account_region in your config file to upload PDFs.'
+        end
+
+        unless string_exists?(CONFIG.aws_account_bucket)
+          raise ArgumentError, 'You must define aws_account_bucket in your config file to upload PDFs.'
+        end
+
+        if CONFIG.aws_presigned_url_duration.nil?
+          raise ArgumentError, 'You must define aws_presigned_url_duration in your config file to upload PDFs.'
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/pdf_mage_workers.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+MODE = 'worker'
+
+require 'pdf_mage/init'
+require 'pdf_mage/workers/render_pdf'
+require 'pdf_mage/workers/send_webhook'
+require 'pdf_mage/workers/upload_file'

data/pdf_mage.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pdf_mage/version'
+
+Gem::Specification.new do |spec|
+  spec.name               = 'pdf_mage'
+  spec.version            = PdfMage::VERSION
+  spec.authors            = %w[Jeremy Haile Dean Papastrat]
+  spec.email              = %w[jeremy@sideqik.com dean@sideqik.com]
+  spec.summary            = 'A lightweight Ruby gem for rendering PDFs with Chrome Headless'
+  spec.homepage           = 'https://github.com/sideqik/pdf-mage'
+  spec.license            = 'MIT'
+  spec.executables        = %w[pdf_mage]
+  spec.require_paths      = %w[lib]
+  spec.bindir             = 'bin'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.add_dependency 'aws-sdk-s3', '~> 1'
+  spec.add_dependency 'redis', '~> 4.0'
+  spec.add_dependency 'sidekiq', '~> 5.1'
+  spec.add_dependency 'sinatra', '~> 2.0'
+  spec.add_dependency 'typhoeus', '~> 1.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.56'
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: pdf_mage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy
+- Haile
+- Dean
+- Papastrat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+description: 
+email:
+- jeremy@sideqik.com
+- dean@sideqik.com
+executables:
+- pdf_mage
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/pdf_mage
+- bin/setup
+- bin/sidekiq
+- lib/pdf_mage.rb
+- lib/pdf_mage/.DS_Store
+- lib/pdf_mage/api/app.rb
+- lib/pdf_mage/config.yml
+- lib/pdf_mage/init.rb
+- lib/pdf_mage/version.rb
+- lib/pdf_mage/workers/base.rb
+- lib/pdf_mage/workers/render_pdf.rb
+- lib/pdf_mage/workers/send_webhook.rb
+- lib/pdf_mage/workers/upload_file.rb
+- lib/pdf_mage_workers.rb
+- pdf_mage.gemspec
+homepage: https://github.com/sideqik/pdf-mage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: A lightweight Ruby gem for rendering PDFs with Chrome Headless
+test_files: []