inboxer 0.0.1

data/.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_PATH: vendor
+BUNDLE_DISABLE_SHARED_GEMS: '1'

data/.gitignore

@@ -0,0 +1,2 @@
+vendor/ruby
+pkg

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    inboxer (0.0.1)
+      gli
+      hpricot
+      phantomjs.rb
+      pony
+      premailer
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    crack (0.3.1)
+    css_parser (1.2.6)
+      addressable
+      rdoc
+    diff-lcs (1.1.3)
+    email_spec (1.2.1)
+      mail (~> 2.2)
+      rspec (~> 2.0)
+    gli (1.6.0)
+    hpricot (0.8.6)
+    htmlentities (4.3.1)
+    i18n (0.6.0)
+    json (1.7.3)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    phantomjs-mac (0.0.3)
+    phantomjs.rb (0.0.4)
+      phantomjs-mac
+    polyglot (0.3.3)
+    pony (1.4)
+      mail (> 2.0)
+    premailer (1.7.3)
+      css_parser (>= 1.1.9)
+      htmlentities (>= 4.0.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    webmock (1.8.7)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  email_spec
+  inboxer!
+  rake
+  rdoc
+  rspec
+  webmock

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Gareth Rushgrove
+
+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,80 @@
+Command line utility to send emails of web pages to specified email addresses.
+
+Lets say you have some dashboards showing up-to-date information about,
+well, anything. But sometimes going to view the dashboards is too much
+effort and what you want it a regular email report. Or maybe your boss
+wants a nice weekly or month summary.
+
+# Usage
+
+    > inboxer
+    Send emails of HTML pages to mailing list based on configuration file
+
+    usage: inboxer [global options] command [command options]
+
+    Version: 0.0.1
+
+    Global Options:
+        --help - Show this message
+
+    Commands:
+        help - Shows list of commands or help for one command
+        send - Send all emails described in configuration file
+        view - Display what is going to happen
+
+So, given a yaml configuration file like so:
+
+    -
+      URL: http://example.com/1/
+      Subject: Example report 1
+      Recipients:
+        - test1@example.com
+        - test2@example.com
+    -
+      URL: http://example.com/2/
+      Subject: Example report 2
+      Recipients:
+        - test1@example.com
+
+We can run inboxer against it:
+
+    inboxer send example.yml
+
+You would tend to have separate yaml files for different frequencies
+(say daily, weekly, monthly) and then setup a cron to trigger those at
+the relevant times.
+
+The default is to send an html and inline css version of the page via
+email. As an alternative you can also send a pdf.
+
+    inboxer pdf example.yml
+
+# Installation
+
+inboxer is written in ruby and available as a gem. I'd recommend
+using bundler but you can also just install with:
+
+    gem install inboxer
+
+# License
+
+Copyright (c) 2012 Gareth Rushgrove
+
+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/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc "Run rspec tests"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.rspec_opts = "--color --format documentation"
+end
+
+desc "Run rspec tests"
+task :default => [:spec]

data/bin/inboxer

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'gli'
+require 'yaml'
+require 'pony'
+require 'premailer'
+require 'inboxer'
+
+include GLI
+
+program_desc 'Send emails of HTML pages to mailing list based on configuration file'
+
+version Inboxer::VERSION
+
+desc 'Display what is going to happen'
+command :view do |c|
+  c.action do |global_options, options, args|
+    raise "Must supply configuration file as argument" unless args.size == 1
+    puts "A nested set of web addresses to capture and the email addresses to send them to" 
+    puts
+    puts File.open(args.first).read
+  end
+end
+
+desc 'Send all emails described in configuration file'
+command :send do |c|
+  c.action do |global_options, options, args|
+    raise "Must supply configuration file as argument" unless args.size == 1
+    report = Inboxer::Reporter.new(args.first)
+    report.send!
+  end
+end
+
+desc 'Send all emails described in configuration file as PDF'
+command :pdf do |c|
+  c.action do |global_options, options, args|
+    raise "Must supply configuration file as argument" unless args.size == 1
+    report = Inboxer::Reporter.new(args.first)
+    report.send_pdf!
+  end
+end
+
+
+exit GLI.run(ARGV)

data/inboxer.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/inboxer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gareth Rushgrove"]
+  gem.email         = ["gareth@morethanseven.net"]
+  gem.homepage      = 'https://github.com/garethr/inboxer'
+  gem.summary       = 'Send web pages to your inbox as html or PDF'
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "inboxer"
+  gem.require_paths = ["lib"]
+  gem.version       = Inboxer::VERSION
+
+  gem.add_dependency('pony')
+  gem.add_dependency('hpricot')
+  gem.add_dependency('gli')
+  gem.add_dependency('premailer')
+  gem.add_dependency('phantomjs.rb')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rdoc')
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('webmock')
+  gem.add_development_dependency('email_spec')
+end

data/lib/inboxer.rb

@@ -0,0 +1,45 @@
+require "inboxer/version"
+
+require 'yaml'
+require 'pony'
+require 'premailer'
+require 'phantomjs.rb'
+
+module Inboxer
+
+  class Reporter
+
+    def initialize(filename)
+      @yml = YAML::load(File.open(filename))
+    end
+
+    def send!
+      @yml.each do |report|
+        premailer = Premailer.new(report['URL'], :warn_level => Premailer::Warnings::SAFE)
+        report['Recipients'].each do |email|
+          Pony.mail(:to => email, :from => report['From'],
+                    :subject => report['Subject'], :html_body => premailer.to_inline_css,
+                    :headers => {'X-Software' => 'Inboxer'}
+                   )
+        end
+      end
+    end
+
+    def send_pdf!
+      @yml.each do |report|
+        report['Recipients'].each do |email|
+          script = File.expand_path('../rasterize.js', __FILE__)
+          file = "/tmp/output.#{rand(36**8).to_s(36)}.pdf"
+          output = Phantomjs.run(script, report['URL'], file)
+          Pony.mail(:to => email, :from => report['From'],
+                    :subject => report['Subject'], :body => report['Content'],
+                    :attachments => {'report.pdf' => File.read(file)},
+                    :headers => {'X-Software' => 'Inboxer'}
+                   )
+        end
+      end
+    end
+
+  end
+
+end

data/lib/inboxer/version.rb

@@ -0,0 +1,3 @@
+module Inboxer
+  VERSION = "0.0.1"
+end

data/lib/rasterize.js

@@ -0,0 +1,21 @@
+var page = require('webpage').create(),
+    address, output, size;
+
+if (phantom.args.length < 2 || phantom.args.length > 3) {
+    console.log('Usage: rasterize.js URL filename');
+    phantom.exit();
+} else {
+    address = phantom.args[0];
+    output = phantom.args[1];
+    page.viewportSize = { width: 600, height: 600 };
+    page.open(address, function (status) {
+        if (status !== 'success') {
+            console.log('Unable to load the address!');
+        } else {
+            window.setTimeout(function () {
+                page.render(output);
+                phantom.exit();
+            }, 200);
+        }
+    });
+}

data/spec/fixtures/multiple.yml

@@ -0,0 +1,11 @@
+-
+  URL: http://example.com/1/
+  Subject: Example report 1
+  Recipients:
+    - test1@example.com
+    - test2@example.com
+-
+  URL: http://example.com/2/
+  Subject: Example report 2
+  Recipients:
+    - test1@example.com

data/spec/fixtures/single.yml

@@ -0,0 +1,6 @@
+-
+  URL: http://example.com
+  Subject: Example report
+  From: from@example.com
+  Recipients:
+    - test@example.com

data/spec/reporter_spec.rb

@@ -0,0 +1,73 @@
+require_relative 'spec_helper'
+
+require 'inboxer'
+
+def run_report(fixture='spec/fixtures/single.yml')
+  report = Inboxer::Reporter.new(fixture)
+  report.send!
+end
+
+def run_pdf_report
+  report = Inboxer::Reporter.new('spec/fixtures/single.yml')
+  report.send_pdf!
+end
+
+def run_report_with_multiple_entries
+  run_report 'spec/fixtures/multiple.yml'
+end
+
+describe 'Running a report with sample data' do
+  before do
+    @content = "sample content"
+    @mailbox = "test@example.com"
+    stub_request(:get, "http://example.com/").to_return(:body => @content)
+    run_report
+  end
+
+  it 'should send an email' do
+    unread_emails_for(@mailbox).size.should == 1
+  end
+
+  it 'the email should contain content from the response' do
+    open_last_email_for(@mailbox)
+    current_email.should have_body_text @content
+  end
+
+  it 'should have the set subject' do
+    open_last_email_for(@mailbox)
+    current_email.should have_subject "Example report"
+  end
+
+  it 'should be from the specified address' do
+    open_last_email_for(@mailbox)
+    current_email.should be_delivered_from "from@example.com"
+  end
+
+  it 'should set an identifying header' do
+    open_last_email_for(@mailbox)
+    current_email.should have_header("X-Software", "Inboxer")
+  end
+end
+
+describe 'Running a report with multiple entries' do
+  before do
+    stub_request(:get, "http://example.com/1/").to_return(:body => "test1")
+    stub_request(:get, "http://example.com/2/").to_return(:body => "test2")
+    run_report_with_multiple_entries
+  end
+
+  it 'should send several emails' do
+    unread_emails_for("test1@example.com").size.should == 2
+    unread_emails_for("test2@example.com").size.should == 1
+  end
+
+  it 'should send emails which contain content from the response' do
+    open_last_email_for "test1@example.com"
+    current_email.should have_subject "Example report 2"
+    current_email.should have_body_text "test2"
+    open_last_email_for "test2@example.com"
+    current_email.should have_subject "Example report 1"
+    current_email.should have_body_text "test1"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'pony'
+require 'email_spec'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.include(EmailSpec::Helpers)
+  config.include(EmailSpec::Matchers)
+end
+
+require 'webmock/rspec'
+WebMock.disable_net_connect!

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: inboxer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gareth Rushgrove
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: &70299174733000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70299174733000
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: &70299174731800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70299174731800
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: &70299174729960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70299174729960
+- !ruby/object:Gem::Dependency
+  name: premailer
+  requirement: &70299174728220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70299174728220
+- !ruby/object:Gem::Dependency
+  name: phantomjs.rb
+  requirement: &70299174724420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70299174724420
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70299174722140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70299174722140
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70299174719820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70299174719820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70299174708520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70299174708520
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70299174706820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70299174706820
+- !ruby/object:Gem::Dependency
+  name: email_spec
+  requirement: &70299174705500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70299174705500
+description: 
+email:
+- gareth@morethanseven.net
+executables:
+- inboxer
+extensions: []
+extra_rdoc_files: []
+files:
+- .bundle/config
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/inboxer
+- inboxer.gemspec
+- lib/inboxer.rb
+- lib/inboxer/version.rb
+- lib/rasterize.js
+- spec/fixtures/multiple.yml
+- spec/fixtures/single.yml
+- spec/reporter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/garethr/inboxer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2227123263043891155
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2227123263043891155
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Send web pages to your inbox as html or PDF
+test_files:
+- spec/fixtures/multiple.yml
+- spec/fixtures/single.yml
+- spec/reporter_spec.rb
+- spec/spec_helper.rb