Giter Club home page Giter Club logo

paperboy-newsletter-generator's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.