softcover-nonstop 1.0.beta2

data/spec/commands/publisher_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+
+describe Softcover::Commands::Publisher do
+  let(:book) { Softcover::Utils.current_book }
+  before(:all) { generate_book }
+  after(:all)  { remove_book }
+
+  let(:publish_options) { { remove_unused_media_bundles: true } }
+
+  describe "#publish" do
+    context "publishing from non book directory" do
+      before do
+        chdir_to_non_book
+      end
+
+      it "rejects the publish" do
+        expect(subject.publish!).to be_false
+      end
+    end
+
+    context "publishing from book directory" do
+      before do
+        chdir_to_book
+        stub_create_book book
+        stub_media_upload book
+      end
+
+      it "publishes" do
+        expect(subject.publish!(publish_options)).to be_true
+      end
+    end
+  end
+
+  describe "#unpublish" do
+    context "unpublishing from non book directory" do
+      before do
+        chdir_to_non_book
+      end
+
+      it "rejects the unpublish" do
+        expect(subject.unpublish!).to be_false
+      end
+    end
+
+    context "unpublishing from book directory" do
+      before do
+        chdir_to_book
+        stub_create_book book
+        stub_media_upload book
+        subject.publish! publish_options
+        stub_destroy_book book
+      end
+
+      it "unpublishes" do
+        expect(subject.unpublish!).to be_true
+      end
+
+      it "removes book config" do
+        subject.unpublish!
+        expect(Softcover::BookConfig.exists?).to be_false
+      end
+    end
+
+    context "unpublishing from book directory with invalid ID" do
+      before do
+        chdir_to_book
+        stub_create_book book
+        stub_media_upload book
+        subject.publish!(publish_options)
+        Softcover::BookConfig['id'] = 0
+        stub_destroy_book_not_found book
+      end
+
+      it "does not unpublish" do
+        expect(subject.unpublish!).to be_false
+      end
+    end
+
+    context "unpublishing outside book directory" do
+      before do
+        chdir_to_book
+        stub_create_book book
+        stub_media_upload book
+        subject.publish! publish_options
+        Dir.chdir(File.dirname(__FILE__))
+      end
+
+      context "with valid slug option" do
+        before { stub_destroy_book_by_slug book }
+
+        it "unpublishes" do
+          expect(subject.unpublish!(book.slug)).to be_true
+        end
+      end
+
+      context "with invalid slug option" do
+        let(:slug) { "error" }
+        before { stub_destroy_book_by_invalid_slug slug }
+
+        it "does not unpublish" do
+          expect(subject.unpublish!(slug)).to be_false
+        end
+      end
+    end
+  end
+
+  describe "#publish_media" do
+    before do
+      chdir_to_book
+      book.id = 1
+      stub_media_upload book
+    end
+
+    # it "should start with 0 processed_media" do
+    #   expect(book.processed_media.length).to eq 0
+    # end
+
+    # it "processes media" do
+    #   subject.publish_media!
+    #   expect(book.processed_media.length).to be > 0
+    # end
+
+    # it "daemonizes" do
+    #   subject.should_receive(:fork) do |&blk|
+    #     blk.call
+    #   end
+    #   subject.publish_media! daemon: true
+    #   expect(book.processed_media.length).to be > 0
+    # end
+
+    # it "watches" do
+    #   subject.should_receive(:loop) do |&blk|
+    #     blk.call
+    #   end
+    #   subject.publish_media! watch: true
+    #   expect(book.processed_media.length).to be > 0
+    # end
+
+  end
+end

data/spec/commands/server_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Softcover::Commands::Server do
+  before(:all) { generate_book }
+  after(:all)  { remove_book }
+
+  before { chdir_to_book }
+
+  it '#listen_for_changes' do
+    expect { subject.listen_for_changes }.to_not raise_error(Exception)
+  end
+
+  it '#run' do
+    Softcover::App.should_receive :run!
+
+    port = 5000
+    subject.run port
+
+    expect(Softcover::App.port).to eq port
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Softcover::Config do
+  before do
+    chdir_to_book
+  end
+
+  describe "path" do
+    context "local path override" do
+      before do
+        `touch .softcover`
+      end
+
+      it "uses local path" do
+        expect(Softcover::Config.path).to eq ".softcover"
+      end
+
+      after do
+        `rm .softcover`
+      end
+    end
+
+    context "system path" do
+      it "uses home dir" do
+        expect(Softcover::Config.path).to eq "~/.softcover"
+      end
+    end
+  end
+
+end

data/spec/mathjax_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Softcover::Mathjax do
+
+  subject(:mathjax) { Softcover::Mathjax }
+
+  let(:custom_sty) do
+%(\\newcommand{\\foo}{\\ensuremath{x}}
+\\newcommand{\\bar}[1]{\\textbf{#1}}
+% \\newcommand{\\baz}{quux}
+)
+  end
+  let(:baz) { 'quux' }
+
+  shared_examples "config" do
+
+    it "should include the default macros" do
+      expect(config).to include polytex
+      expect(config).to include polytexnic
+    end
+
+    context "with a custom.sty" do
+
+      before { Softcover.stub(:custom_styles).and_return(custom_sty) }
+
+      it "should include the custom macros" do
+        expect(config).to include foo
+        expect(config).to include bar
+      end
+
+      it "should not include a commented-out macro" do
+        expect(config).not_to include baz
+      end
+    end
+  end
+
+  context '#config' do
+
+    let(:polytex)    { 'PolyTeX:    "Poly{\\\\TeX}"' }
+    let(:polytexnic) { 'PolyTeXnic: "Poly{\\\\TeX}nic"' }
+    let(:foo)        { 'foo: "{x}"' }
+    let(:bar)        { 'bar: ["\\\\textbf{#1}", 1]' }
+    let(:config)     { mathjax.config }
+
+    it "should not raise an error" do
+      expect { config }.not_to raise_error
+    end
+
+    it_should_behave_like "config"
+  end
+
+  context '#escaped_config' do
+    let(:polytex)    { 'PolyTeX:    "Poly{\\\\\\\\TeX}"' }
+    let(:polytexnic) { 'PolyTeXnic: "Poly{\\\\\\\\TeX}nic"' }
+    let(:foo)        { 'foo: "{x}"' }
+    let(:bar)        { 'bar: ["\\\\\\\\textbf{#1}", 1]' }
+    let(:config)     { mathjax.escaped_config }
+
+    it_should_behave_like "config"
+  end
+end

data/spec/output_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+module OutputTest
+  include Softcover::Output
+  extend self
+
+  def puts_hello
+    puts 'hello'
+  end
+
+  def print_hello
+    print 'hello'
+  end
+
+  def printf_hello
+    print 'hello'
+  end
+
+  def system_cmd
+    system "echo hello"
+  end
+end
+
+describe Softcover::Output do
+  before { Softcover::Output.unsilence! }
+
+  it 'redirects output' do
+    Softcover::Output.stream = $stderr
+    $stderr.should_receive(:puts).with('hello')
+    $stderr.should_receive(:print).twice.with('hello')
+
+    OutputTest.puts_hello
+    OutputTest.print_hello
+    OutputTest.printf_hello
+  end
+
+  it 'redirects system command output' do
+    Softcover::Output.stream.should_receive(:puts)
+    OutputTest.system_cmd
+  end
+end

data/spec/sanitizer_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'softcover/sanitizer'
+
+describe Softcover::Sanitizer do
+  context "malicious html" do
+    let(:html) { "<div onclick='alert(document.cookie)'></div>"}
+
+    it "cleans xss vectors" do
+      expect(subject.clean(html)).to eq "<div></div>"
+    end
+  end
+
+  context "safe html" do
+    let(:html) do Nokogiri::HTML.fragment(<<-EOS
+        <div id="a" class="b"></div>
+        <div data-tralics-id="c" data-number="d" data-chapter="e"></div>
+        <a id="a" class="b" href="c"></a>
+        <span id="a" class="b" style="c"></span>
+        <ol id="a" class="b"></ol>
+        <ul id="a" class="b"></ul>
+        <li id="a" class="b"></li>
+        <sup id="a" class="b"></sup>
+        <h1 id="a" class="b"></h1>
+        <h2 id="a" class="b"></h2>
+        <h3 id="a" class="b"></h3>
+        <h4 id="a" class="b"></h4>
+        <img id="a" class="b" src="c" alt="d" />
+        <em id="a" class="b"></em>
+      EOS
+      ).to_xhtml
+    end
+
+    it "allows class and id" do
+      expect(subject.clean(html)).to match html
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+require 'coveralls'
+Coveralls::Output.silent = !ENV['CI']
+Coveralls.wear!
+
+require 'rubygems'
+require 'bundler/setup'
+require 'webmock/rspec'
+require 'webmock_helpers'
+require 'ostruct'
+require 'pry'
+
+require 'json'
+require 'softcover'
+require 'softcover/utils'
+require 'softcover/config'
+require 'softcover/server/app'
+require 'softcover/commands/publisher'
+Softcover::Output.silence!
+
+# Load support files.
+Dir.glob(File.join(File.dirname(__FILE__), "./support/**/*.rb")).each do |f|
+  require_relative(f)
+end
+
+RSpec.configure do |config|
+  include Softcover::Utils
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  Softcover::set_test_mode!
+
+  config.before do
+    Softcover::set_test_mode!
+    Softcover::Utils.reset_current_book!
+    Softcover::Config.remove
+    Softcover::BookConfig.remove
+  end
+
+  config.before(:each) do
+    Softcover::Output.silence!
+    Softcover::Commands::Server.no_listener = true
+  end
+
+  config.after do
+    Softcover::Config.remove
+    Softcover::BookConfig.remove
+  end
+
+  config.include WebmockHelpers
+end
+
+TEST_API_KEY = 'asdfasdfasdfasdfasdf'
+

data/spec/support/exist_matcher.rb

@@ -0,0 +1,7 @@
+# encoding=utf-8
+
+RSpec::Matchers.define :exist do
+  match do |filename|
+    expect(File.exist?(filename)).to be_true
+  end
+end

data/spec/utils_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Softcover::Utils do
+  context "book_file_lines" do
+    let(:raw_lines) { ['foo.md', '# bar.tex'] }
+    subject { Softcover::Utils.non_comment_lines(raw_lines) }
+    it { should     include 'foo.md' }
+    it { should_not include 'bar.tex' }
+  end
+end

data/spec/webmock_helpers.rb

@@ -0,0 +1,210 @@
+module WebmockHelpers
+  def api_base_url
+    "#{Softcover::BaseConfig::DEFAULTS[:host]}/api/v1"
+  end
+
+  def test_bucket; 'test-bucket' end
+  def test_access_key; 'asdf' end
+  def test_id; 1 end
+
+  def headers(with_content_length=true)
+    hash = { 'Accept'=>'application/json',
+      'Accept-Encoding'=>'gzip, deflate',
+      'Content-Type'=>'application/json',
+      'User-Agent'=>'Ruby'
+    }
+    hash['Content-Length'] = /.+/ if with_content_length
+    hash
+  end
+
+  def stub_valid_login(email, pass, api_key=TEST_API_KEY)
+    stub_request(:post, "#{api_base_url}/login").
+      with(:body => { "email" => email, "password" => pass },
+           :headers => headers ).
+      to_return(:status => 200, :body => {api_key: api_key}.to_json)
+  end
+
+  def stub_invalid_login(email, pass)
+    stub_request(:post, "#{api_base_url}/login").
+      with(:body => { "email" => email, "password" => pass },
+           :headers => headers ).
+      to_return(:status => 422, body: '')
+  end
+
+  def stub_create_book(book)
+
+    return_body = {
+      upload_params: book.files.map { |f|
+        {
+          :policy          => "asdf",
+          :signature       => "asdf",
+          :acl             => "public-read",
+          :content_type    => "asdf",
+          :key             => File.join(book.slug, f.path),
+          :path            => f.path
+        }
+      },
+      bucket: test_bucket,
+      access_key: test_access_key,
+      book: {
+        id: test_id
+      }
+    }.to_json
+
+    stub_request(:post, "#{api_base_url}/books").
+      with(:body => {
+           id: book.id,
+           files: book.files,
+           title: book.title,
+           slug: book.slug,
+           subtitle: book.subtitle,
+           description: book.description,
+           chapters: book.chapter_attributes,
+           prices: book.prices,
+           faq: book.faq,
+           testimonials: book.testimonials,
+           marketing_content: '',
+           contact_email: book.contact_email,
+           hide_softcover_footer: book.hide_custom_domain_footer,
+           authors: book.authors,
+           ga_account: book.ga_account,
+           remove_unused_media_bundles: true
+        }.to_json,
+           :headers => headers).
+      to_return(:status => 200, :body => return_body, :headers => {})
+
+    stub_s3_post
+
+    book.files.each { |file| stub_notify_file_upload file }
+
+    stub_request(:put, "#{api_base_url}/books/#{test_id}").
+      with(:body => "{\"upload_complete\":true}",
+        :headers => headers).
+        to_return(:status => 200, :body => {}.to_json, :headers => {})
+  end
+
+  def stub_destroy_book(book)
+    stub_request(:delete, "#{api_base_url}/books/#{book.id}?api_key=").
+      with(:headers => headers(false)).
+      to_return(:status => 200, :body => "", :headers => {})
+  end
+
+  def stub_destroy_book_by_slug(book)
+    stub_request(:delete, "#{api_base_url}/books/#{book.slug}?api_key=").
+      with(:headers => headers(false)).
+      to_return(:status => 200, :body => "", :headers => {})
+  end
+
+  def stub_destroy_book_by_invalid_slug(slug)
+    stub_request(:delete, "#{api_base_url}/books/#{slug}?api_key=").
+      with(:headers => headers(false)).
+      to_return(:status => 404, :body => "", :headers => {})
+  end
+
+  def stub_destroy_book_not_found(book)
+    stub_request(:delete, "#{api_base_url}/books/#{book.id}?api_key=").
+      with(:headers => headers(false)).
+      to_return(:status => 404, :body => "", :headers => {})
+  end
+
+  def stub_notify_file_upload(file)
+    notify_file_url = "#{api_base_url}/books/#{test_id}/notify_file_upload"
+
+    stub_request(:post, notify_file_url).
+         with(:body =>
+            { path: file.path, checksum: file.checksum }.to_json,
+              :headers => headers).
+         to_return(:status => 200, :body => {}.to_json, :headers => {})
+  end
+
+  def stub_s3_post
+    stub_request(:post, /s3\.amazonaws\.com/).
+                 with(:body => /.*/).
+                 to_return(:status => 200, :body => "", :headers => {})
+  end
+
+  def stub_media_upload(book, dir='ebooks', options={})
+    stub_s3_post
+    stub_create_book(book)
+
+    files = book.get_book_files(dir)
+    stub_request(:post,
+                 /\/books\/#{book.id || '.+'}\/media/).
+                  with(:body => {
+                                  path: dir,
+                                  files: files,
+                                  manifest: nil,
+                                  remove_unused_media_files:
+                                    options[:remove_unused_media_files]
+                                }.to_json,
+                       :headers => headers).
+                  to_return(:status => 200, :body => {
+                            upload_params: files.map { |file|
+                              {
+                                :policy          => "asdf",
+                                :signature       => "asdf",
+                                :acl             => "public-read",
+                                :content_type    => "asdf",
+                                :key             => File.join(book.slug,
+                                                              file.path),
+                                :path            => file.path
+                              }
+                             },
+                            bucket: test_bucket,
+                            access_key: test_access_key
+                           }.to_json, :headers => {})
+
+    files.each { |file| stub_notify_file_upload file }
+  end
+
+  def prepare_book_stubs
+    chdir_to_book
+  end
+
+  def chdir_to_fixtures
+    Dir.chdir File.join File.dirname(__FILE__), "fixtures"
+  end
+
+  def chdir_to_book
+    dir = File.join File.dirname(__FILE__), "fixtures", "book"
+    File.mkdir(dir) unless File.directory?(dir)
+    Dir.chdir dir
+  end
+
+  def chdir_to_non_book
+    dir = File.join File.dirname(__FILE__), "fixtures", "non-book"
+    File.mkdir(dir) unless File.directory?(dir)
+    Dir.chdir dir
+  end
+
+  # Generates a sample book using the same method as `softcover new`.
+  # It also creates test books of all standard formats and a screencasts
+  # directory with a stub file.
+  def generate_book(options = {})
+    name   = options[:name]   || 'book'
+    source = options[:source] || :polytex
+    remove_book
+    Dir.chdir File.join File.dirname(__FILE__), "fixtures/"
+    flags = []
+    flags << '-p' unless options[:markdown]
+    silence { system "softcover new #{name} #{flags.join(' ')}" }
+    chdir_to_book
+    File.mkdir 'html' unless File.exist?('html')
+    File.write(File.join('html', 'chapter-1.html'),          'test')
+    File.write(File.join('html', 'chapter-1_fragment.html'), 'test')
+    File.write(File.join('html', 'test_fragment.html'),      'test')
+    File.write(File.join('html', "#{name}.html"),            'test')
+    File.mkdir 'ebooks' unless File.exist?('ebooks')
+    Softcover::FORMATS.each do |format|
+      dir = format == 'html' ? 'html' : 'ebooks'
+      File.write(File.join(dir, "test-book.#{format}"), 'test')
+    end
+    Dir.mkdir("screencasts") unless File.directory?("screencasts")
+    File.open(File.join('screencasts', 'ch1.mov'), 'w') { |f| f.write('test') }
+  end
+
+  def remove_book
+    FileUtils.rm_rf(File.join File.dirname(__FILE__), "fixtures/book")
+    chdir_to_fixtures
+  end
+end

data/tasks/run_specs.rake

@@ -0,0 +1,5 @@
+task default: [:spec]
+
+task :spec do
+  exit system('rspec spec')
+end