RubyGems - tobacco - Versions diffs - 0.0.1 - Mend

tobacco 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

data/.gitignore +18 -0
data/.rspec +2 -0
data/.rvmrc +1 -0
data/.travis.yml +2 -0
data/Gemfile +4 -0
data/LICENSE.txt +22 -0
data/README.md +319 -0
data/Rakefile +9 -0
data/lib/tobacco/burnout.rb +28 -0
data/lib/tobacco/error.rb +38 -0
data/lib/tobacco/exhaler.rb +26 -0
data/lib/tobacco/inhaler.rb +13 -0
data/lib/tobacco/roller.rb +38 -0
data/lib/tobacco/smoker.rb +141 -0
data/lib/tobacco/version.rb +3 -0
data/lib/tobacco.rb +46 -0
data/spec/spec_helper.rb +18 -0
data/spec/support/vcr_cassettes/url_content.yml +72 -0
data/spec/tobacco/burnout_spec.rb +51 -0
data/spec/tobacco/error_spec.rb +86 -0
data/spec/tobacco/exhaler_spec.rb +63 -0
data/spec/tobacco/inhaler_spec.rb +38 -0
data/spec/tobacco/roller_spec.rb +108 -0
data/spec/tobacco/smoker_spec.rb +204 -0
data/spec/tobacco_spec.rb +61 -0
data/tobacco.gemspec +24 -0
metadata +160 -0

data/lib/tobacco.rb ADDED Viewed

@@ -0,0 +1,46 @@
+# A convenience module to gain access to
+# configuration options
+#
+require 'open-uri'
+module Tobacco
+  # Default options in the event no configuration
+  # file is created
+  #
+  @base_path              = '/tmp/published_content'
+  @published_host         = 'http://localhost:3000'
+  @content_method         = :content
+  @content_url_method     = :content_url
+  @output_filepath_method = :output_filepath
+  class << self
+    attr_accessor :base_path,
+      :published_host,
+      :content_method,
+      :content_url_method,
+      :output_filepath_method
+  end
+  def self.configure
+    yield self
+  end
+  def self.log(msg)
+    msg = "LOGGING: #{msg}"
+    if defined? Rails
+      Rails.logger.info(msg)
+    else
+      puts msg
+    end
+  end
+end
+require 'tobacco/burnout.rb'
+require 'tobacco/smoker'
+require 'tobacco/roller'
+require 'tobacco/inhaler'
+require 'tobacco/exhaler'
+require 'tobacco/error'

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,18 @@
+require 'tobacco'
+require 'pry'
+require 'vcr'
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+  VCR.configure do |c|
+    c.cassette_library_dir = 'spec/support/vcr_cassettes'
+    c.hook_into :fakeweb
+    c.allow_http_connections_when_no_cassette = true
+  end
+  config.extend VCR::RSpec::Macros
+end

data/spec/support/vcr_cassettes/url_content.yml ADDED Viewed

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.iana.org/domains/example/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Sun, 30 Sep 2012 02:45:14 GMT
+      server:
+      - Apache/2.2.3 (CentOS)
+      last-modified:
+      - Wed, 09 Feb 2011 17:13:15 GMT
+      vary:
+      - Accept-Encoding
+      connection:
+      - close
+      transfer-encoding:
+      - chunked
+      content-type:
+      - text/html; charset=UTF-8
+    body:
+      encoding: US-ASCII
+      string: ! "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"
+        \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n<head>\n\t<title>IANA
+        &mdash; Example domains</title>\n\t<!-- start common-head -->\n\t<meta http-equiv=\"Content-type\"
+        content=\"text/html; charset=utf-8\" />\n\t<link rel=\"stylesheet\" type=\"text/css\"
+        href=\"/_css/2008.1/reset-fonts-grids.css\" />\n\t<link rel=\"stylesheet\"
+        type=\"text/css\" media=\"screen\" href=\"/_css/2008.1/screen.css\" />\n\t<link
+        rel=\"stylesheet\" type=\"text/css\" media=\"print\" href=\"/_css/2008.1/print.css\"
+        />\n\t<link rel=\"shortcut icon\" type=\"image/ico\" href=\"/favicon.ico\"
+        />\n\t<script type=\"text/javascript\" src=\"/_js/prototype.js\"></script>\n\t<script
+        type=\"text/javascript\" src=\"/_js/corners.js\"></script>\n\t<script type=\"text/javascript\"
+        src=\"/_js/common.js\"></script>\n\t<!-- end common-head -->\n\n</head>\n<body>\n\t<!--
+        start common-bodyhead -->\n\t<div id=\"header-frame\">\n\t<div id=\"header\">\n\t<div
+        id=\"header-logo\"><a href=\"/\"><img src=\"/_img/iana-logo-pageheader.png\"
+        alt=\"Homepage\"/></a></div>\n\t<div id=\"header-nav\">\n\t<ul>\n\t<li><a
+        href=\"/domains/\">Domains</a></li>\n\t<li><a href=\"/numbers/\">Numbers</a></li>\n\t<li><a
+        href=\"/protocols/\">Protocols</a></li>\n\t<li><a href=\"/about/\">About IANA</a></li>\n\t</ul>\n\t</div>\n\t</div>\n\t</div>\n\n\t<div
+        id=\"body-container\">\n\t<div id=\"body\">\n\t<!-- end common-bodyhead -->\n\n\n\t<h1>Example
+        Domains</h1>\n\n\t<p>As described in <a href=\"/go/rfc2606\">RFC 2606</a>,\n\twe
+        maintain a number of domains such as EXAMPLE.COM and EXAMPLE.ORG\n\tfor documentation
+        purposes. These domains may be used as illustrative\n\texamples in documents
+        without prior coordination with us. They are \n\tnot available for registration.</p>\n\n\t
+        <!-- start common-bodytail -->\n\t</div>\n\t</div>\n\n\t<div id=\"footer-frame\">\n\t<div
+        id=\"footer\">\n\n\n\t<table width=100%>\n\t<tr>\n\t\t<td id=\"iana-footer-first\"><b><a
+        href=\"/about/\">About</a></b><br/>\n                <a href=\"/about/presentations/\">Presentations</a><br/>\n
+        \               <a href=\"/about/performance/\">Performance</a><br/>\n\t\t<a
+        href=\"/reports/\">Reports</a><br/>\n                </td>\n\n\t\t<td><b><a
+        href=\"/domains/\">Domains</a></b><br/>\n\t\t<a href=\"/domains/root/\">Root
+        Zone</a><br/>\n\t\t<a href=\"/domains/int/\">.INT</a><br/>\n\t\t<a href=\"/domains/arpa/\">.ARPA</a><br/>\n\t\t<a
+        href=\"/domains/idn-tables/\">IDN Repository</a></td>\n\n\t\t<td><b><a href=\"/protocols/\">Protocols</a></b><br/>\n\t\t<br/>\n\t\t<b><a
+        href=\"/numbers/\">Number Resources</a></b><br/>\n\t\t<a href=\"/abuse/\">Abuse
+        Information</a></td>\n\n\t\t<td id=\"iana-footer-icann\"><img src=\"/_img/icann-logo-micro.png\"><br/>IANA
+        is operated by the<br/><a href=\"http://www.icann.org/\">Internet Corporation
+        for Assigned Names and Numbers</a></td>\n\t</tr>\n\t</table>\n\n<div id=\"footer-beta-feedback\">\n
+        \       <p>Please direct general feedback regarding IANA to <a href=\"mailto:iana@iana.org?subject=General%20website%20feedback\">iana@iana.org</a>.</p>\n
+        \       </div>\n\n\t</div>\n\t</div>\n\t<!-- end common-bodytail -->\n\n\n</body>\n</html>\n"
+    http_version: '1.1'
+  recorded_at: Sun, 30 Sep 2012 02:45:14 GMT
+recorded_with: VCR 2.2.5

data/spec/tobacco/burnout_spec.rb ADDED Viewed

@@ -0,0 +1,51 @@
+require 'spec_helper'
+describe Tobacco::Burnout do
+  subject { Tobacco::Burnout }
+  let(:call_count) { 0 }
+  let(:max_timeouts) { 0 }
+  let(:untimely_block) {
+    ->(call_count, max_timeouts) {
+      if call_count < max_timeouts
+        call_count += 1
+        raise Timeout::Error
+      else
+        return "an important value"
+      end
+    }
+  }
+  context "when the attempted block times out exactly X times" do
+    before do
+      max_timeouts = 5
+    end
+    it "raises nothing" do
+      expect {
+        subject.try(5) { untimely_block.call(call_count, max_timeouts) }
+      }.to_not raise_error
+    end
+    it "returns whatever the block returned" do
+      subject.try(5) { untimely_block.call(call_count, max_timeouts) }.should == "an important value"
+    end
+  end
+  context "when the attempted block times out more than X times" do
+    before do
+      max_timeouts = 3
+    end
+    it "raises a MaximumAttemptsExceeded exception" do
+      expect {
+        subject.try(2) do
+          untimely_block.call(0, 4)
+        end
+      }.to raise_error(Tobacco::Burnout::MaximumAttemptsExceeded, /more than 2 time/)
+    end
+  end
+end

data/spec/tobacco/error_spec.rb ADDED Viewed

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'tobacco'
+shared_examples_for "attributes set" do
+  it 'msg is set' do
+    error.msg.should == msg
+  end
+  it 'filepath is set' do
+    error.filepath.should == filepath
+  end
+  it 'content is set' do
+    error.content.should == content
+  end
+  it 'object is an error object' do
+    error.object.message.should == error_object.message
+  end
+end
+describe Tobacco::Error do
+  subject { Tobacco::Error }
+  describe '#new' do
+    context 'sets attributes during initialize' do
+      let(:msg)          { 'Error Writing' }
+      let(:filepath)     { '/users/somepath/index.html' }
+      let(:content)      { '<h1>Page Title</h1>'}
+      let(:error_object) { RuntimeError.new("Can't do that!") }
+      let(:error) do
+        subject.new(
+          msg: msg,
+          filepath: filepath,
+          content: content,
+          object: error_object
+        )
+      end
+      it_behaves_like "attributes set"
+    end
+    context 'allows setting attributes directly' do
+      let(:msg)          { 'Error Writing' }
+      let(:filepath)     { '/users/no_permissions_here/index.html' }
+      let(:content)      { '<h1>Overdone</h1>'}
+      let(:error_object) { Exception.new("I know this is crazy. Not sure what just happened. Try it again and the error may not happen... maybe") }
+      let(:error)        { subject.new }
+      before do
+        error.msg      = msg
+        error.filepath = filepath
+        error.content  = content
+        error.object   = error_object
+      end
+      it_behaves_like "attributes set"
+    end
+  end
+  describe '#to_a' do
+    context 'when destructuring using *splat' do
+      let(:msg)          { 'Error Writing' }
+      let(:filepath)     { '/users/somepath/index.html' }
+      let(:content)      { '<h1>Page Title</h1>'}
+      let(:error_object) { RuntimeError.new("Can't do that!") }
+      let(:expected_array) { [ msg, filepath, content, error_object ] }
+      let(:error) do
+        subject.new(
+          msg: msg,
+          filepath: filepath,
+          content: content,
+          object: error_object
+        )
+      end
+      it 'sets the array of variables' do
+        splatted = *error
+        expected_array.should == splatted
+      end
+    end
+  end
+end

data/spec/tobacco/exhaler_spec.rb ADDED Viewed

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'tobacco'
+describe Tobacco::Exhaler do
+  subject { Tobacco::Exhaler }
+  let(:exhaler) { subject.new(content, filepath) }
+  describe '#new' do
+    context 'when passing arguments' do
+      let(:content) { 'File content' }
+      let(:filepath) { '/users/someuser/work/index.html' }
+      it 'sets the content' do
+        exhaler.filepath.should == filepath
+      end
+      it 'sets the filepath' do
+        exhaler.content.should == content
+      end
+    end
+    context 'when setting attributes after creation' do
+      let(:exhaler) { Tobacco::Exhaler.new }
+      it 'sets the content' do
+        exhaler.content = 'new content'
+        exhaler.content.should == 'new content'
+      end
+      it 'sets the filepath' do
+        exhaler.filepath = '/var/other'
+        exhaler.filepath.should == '/var/other'
+      end
+    end
+  end
+  describe 'file operations' do
+    let(:filepath) { '/tmp/base_dir/index.html' }
+    let(:dir)      { '/tmp/base_dir/' }
+    let(:content) { '<h1>Page Title</h1>' }
+    after { FileUtils.rm_rf(dir) }
+    describe '#create_directory' do
+      it 'creates a directory based on a filepath' do
+        exhaler.create_directory
+        File.exists?(dir).should be_true
+      end
+    end
+    describe '#write!' do
+      it 'writes content to a file' do
+        exhaler.write!
+        File.read(filepath).should == content
+      end
+    end
+  end
+end

data/spec/tobacco/inhaler_spec.rb ADDED Viewed

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'tobacco'
+describe Tobacco::Inhaler do
+  subject { Tobacco::Inhaler.new(url) }
+  describe '#new' do
+    let!(:url) { 'http://google.com/videos' }
+    it 'sets the url' do
+      subject.url.should == url
+    end
+  end
+  describe '#read' do
+    context 'when reading a url succeeds' do
+      let!(:url) { 'http://www.iana.org/domains/example/' }
+      before { VCR.insert_cassette('url_content') }
+      after { VCR.eject_cassette() }
+      it 'reads content from a url' do
+        subject.read
+      end
+    end
+    context 'when reading a url fails' do
+      let!(:url) { 'http://somehost' }
+      it 'errors on reading' do
+        expect { subject.read }.to raise_error(Tobacco::Burnout::MaximumAttemptsExceeded)
+      end
+    end
+  end
+end

data/spec/tobacco/roller_spec.rb ADDED Viewed

@@ -0,0 +1,108 @@
+require 'spec_helper'
+require 'tobacco'
+describe Tobacco::Roller do
+  context 'paths' do
+    before do
+      Tobacco.configure do |config|
+        config.published_host         = 'http://localhost:3000'
+        config.base_path              = 'published_content'
+        config.content_method         = :content
+        config.content_url_method     = :content_url
+        config.output_filepath_method = :output_filepath
+      end
+    end
+    subject { Tobacco::Roller.new(smoker) }
+    context 'when using default settings' do
+      let(:smoker) { double('smoker') }
+      let(:expected_output_filepath) { 'published_content/1/video/245' }
+      describe '#output_filepath' do
+        it 'builds a path when given array of options' do
+          smoker.stub(:output_filepath) { [ '1', 'video', '245' ] }
+          subject.output_filepath.should == expected_output_filepath
+        end
+        it 'builds a path when given a string' do
+          smoker.stub(:output_filepath) { '1/video/245' }
+          subject.output_filepath.should == expected_output_filepath
+        end
+      end
+      describe '#content_url' do
+        context 'when prepended with a forward slash' do
+          let(:expected_content_url) { 'http://localhost:3000/publisher/video/245' }
+          it 'builds a content url' do
+            smoker.stub(:content_url) { '/publisher/video/245' }
+            subject.content_url.should == expected_content_url
+          end
+        end
+        context 'when not prepended with a forward slash' do
+          let(:expected_content_url) { 'http://localhost:3000/publisher/video/245' }
+          it 'builds a content url' do
+            smoker.stub(:content_url) { 'publisher/video/245' }
+            subject.content_url.should == expected_content_url
+          end
+        end
+      end
+    end
+    context 'when overriding default settings' do
+      let(:smoker) { double('smoker') }
+      before do
+        Tobacco.configure do |config|
+          config.published_host         = 'http://localhost:5000'
+          config.base_path              = 'pub_content'
+          config.content_method         = :data
+          config.content_url_method     = :url
+          config.output_filepath_method = :fpath
+        end
+      end
+      let(:smoker) { double('smoker') }
+      let(:expected_output_filepath) { 'pub_content/1/video/245' }
+      describe '#output_filepath' do
+        it 'builds an ouput filepath' do
+          smoker.stub(:fpath) { [ '1', 'video', '245' ] }
+          subject.output_filepath.should == expected_output_filepath
+        end
+      end
+      describe '#content_url' do
+        context 'when prepended with a forward slash' do
+          let(:expected_content_url) { 'http://localhost:5000/publisher/video/245' }
+          it 'builds a content url' do
+            smoker.stub(:url) { '/publisher/video/245' }
+            subject.content_url.should == expected_content_url
+          end
+        end
+        context 'when not prepended with a forward slash' do
+          let(:expected_content_url) { 'http://localhost:5000/publisher/video/245' }
+          it 'builds a content url' do
+            smoker.stub(:url) { 'publisher/video/245' }
+            subject.content_url.should == expected_content_url
+          end
+        end
+      end
+    end
+  end
+end

data/spec/tobacco/smoker_spec.rb ADDED Viewed

@@ -0,0 +1,204 @@
+require 'spec_helper'
+require 'tobacco'
+describe Tobacco::Smoker do
+  before do
+    Tobacco.configure do |config|
+      config.published_host         = 'http://localhost:3000'
+      config.base_path              = '/tmp/published_content'
+      config.content_method         = :content
+      config.content_url_method     = :content_url
+      config.output_filepath_method = :output_filepath
+    end
+  end
+  let(:smoker) { mock('smoker') }
+  subject { Tobacco::Smoker.new(smoker) }
+  context '#write!' do
+    context 'when content is empty' do
+      let(:inhaler)  { mock('inhaler', read: '') }
+      let(:filepath) { mock('roller', content_url: '/video', filepath: '/user') }
+      before do
+        Tobacco::Inhaler.should_receive(:new).and_return(inhaler)
+        subject.file_path_generator = filepath
+      end
+      it 'does not attempt a write' do
+        Tobacco::Exhaler.should_not_receive(:new)
+        subject.read
+        subject.write!
+      end
+    end
+    context 'content' do
+      let(:content) { 'Directly set content' }
+      let(:exhaler) { mock('exhaler', write!: true) }
+      let(:filepath) { mock('roller', content_url: '/video', filepath: '/user', output_filepath: '/desktop') }
+      before do
+        Tobacco::Exhaler.should_receive(:new).and_return(exhaler)
+        subject.file_path_generator = filepath
+      end
+      context 'when providing content directly' do
+        it 'allows setting content directly' do
+          exhaler.should_receive(:write!)
+          subject.content = content
+          subject.write!
+        end
+        it 'callback :on_success is called' do
+          smoker.should_receive(:before_write).with(content).and_return(content)
+          smoker.should_receive(:on_success).with(content)
+          subject.content = content
+          subject.write!
+        end
+      end
+      context 'when an error occurs during writing' do
+        let(:error) { raise RuntimeError.new('File Permission Error') }
+        before do
+          subject.file_path_generator = filepath
+          smoker.should_receive(:before_write).with(content).and_return(content)
+          exhaler.should_receive(:write!).and_return { error }
+        end
+        it 'calls the callback :on_write_error' do
+          smoker.should_receive(:on_write_error)
+          subject.content = content
+          subject.write!
+        end
+      end
+    end
+  end
+  describe '#modify_content_before_writing' do
+    let(:content) { '<h1>Summer Gear</h1>' }
+    let(:modified_content) { '<h1>Winter Gear</h1>' }
+    before do
+      smoker.stub(:before_write).and_return(modified_content)
+    end
+    it 'allows the smoker to modify content before writing' do
+      subject.content = content
+      subject.modify_content_before_writing.should == modified_content
+    end
+  end
+  describe '#generate_file_paths' do
+    it 'sets the file_path_generator' do
+      Tobacco::Roller.should_receive(:new).with(smoker)
+      subject.generate_file_paths
+    end
+  end
+  describe '#choose_reader' do
+    context 'when smoker provides the content' do
+      before { smoker.stub(:content) }
+      it 'uses the smoker for the content' do
+        subject.choose_reader
+        subject.reader.should == smoker
+      end
+    end
+    context 'when smoker does not provide content' do
+      let(:inhaler)  { mock('inhaler', read: 'reader method') }
+      let(:filepath) { mock('roller', content_url: '/video') }
+      before do
+        Tobacco::Inhaler.should_receive(:new).and_return(inhaler)
+        subject.file_path_generator = filepath
+      end
+      it 'uses the smoker for the content' do
+        subject.choose_reader
+        subject.reader.should == inhaler
+      end
+    end
+  end
+  describe '#read_content' do
+    context 'when content is read from the smoker' do
+      let(:content) { 'Provided content' }
+      before { smoker.stub(:content).and_return(content) }
+      it 'should have the correct content' do
+        subject.choose_reader
+        subject.read_content
+        subject.content.should == content
+      end
+    end
+    context 'when content is read from url' do
+      let(:content)  { 'Content from reading url' }
+      let(:inhaler)  { mock('inhaler', read: content) }
+      let(:filepath) { mock('roller', content_url: '/video') }
+      before do
+        Tobacco::Inhaler.should_receive(:new).and_return(inhaler)
+        subject.file_path_generator = filepath
+      end
+      it 'should have the correct content' do
+        subject.choose_reader
+        subject.read_content
+        subject.content.should == content
+      end
+    end
+  end
+  describe '#read' do
+    context 'when content is empty' do
+      class Writer
+        attr_accessor :error
+        def on_read_error(error)
+          self.error = error
+        end
+      end
+      describe '#on_read_error' do
+        let(:inhaler)  { mock('inhaler', read: '') }
+        let(:filepath) { mock('roller', content_url: '/video', filepath: '/file/path') }
+        let(:smoker)   { Writer.new }
+        before do
+          Tobacco::Inhaler.should_receive(:new).and_return(inhaler)
+          subject.file_path_generator = filepath
+        end
+        it 'the callback is called on the smoker' do
+          subject.smoker.should_receive(:on_read_error)
+          subject.read
+        end
+        it 'has the correct message on the error object' do
+          subject.read
+          error   = subject.smoker.error
+          message = error.object.message
+          message.should match(/No error encountered/)
+        end
+      end
+    end
+  end
+end