Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A modification of TPM's Paperboy Distributor to generate a complete HTML newsletter in one step.

branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

paperboy_newsletter_generator

A modification of TPM's sample sinatra app (Paperboy Distributor) based on the paperboy gem for generating HTML newsletters from popular stories.

In one step, newsletter.rb uses Chartbeat historical data to generate a complete HTML file containing a list of the most viewed stories from your site over the past four hours.

How?

Paperboy aggregates stories from chartbeat's snapshots endpoint over a given time period and scrapes the URLs for META tags containing images and blurbs to create ready-made or templateable emails.

Install and use

Make sure you have Paperboy (sudo gem install paperboy)

git clone git://github.com/rnagle/paperboy-newsletter-generator.git
cd paperboy-newsletter-generator
Rename opts.yml.sample to opts.yml, fill in your chartbeat credentials and xpath prefs (for slurping up images and descriptions from META tags)

Open newsletter.rb and fill in custom filters.

The newsletter.erb file is the template file Paperboy will run stories through. The template loops through a @stories array. Each item in the array has the components:

item[:url]
item[:hed]
item[:img]
item[:blurb]

See a sample bare-bones structure here.

Run app with ruby newsletter.rb View HTML file in public/index.html

License

Copyright (c) 2010 TPM Media LLC

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.

Something went wrong with that request. Please try again.