softcover 0.0.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64e9e6a9cc0844c04b1358751f9bcdca2ae9c6fb
-  data.tar.gz: a029afce4169492e14ab97b95f06466ae5704782
+  metadata.gz: 241551e9906a00f2eb0a5d8ce1de0c08609ddb30
+  data.tar.gz: 4f4e7c76d2095f5901a453dfabe386305c8b4ade
 SHA512:
-  metadata.gz: a1291a75a3b6326199c929ac8b3378db9fadfa8b52e8a0bdee5cfa8e53f884f8125244b8b6d346aa05a3eb285abfa53efcbff5dfa8e7826c8fd03a75d2addeb0
-  data.tar.gz: e6f56331e88ea04996876aad2ccaa3297c8c63fdb94ab4584037c4eee2c2354a1329d9abcc72a371b4edeafb9bef314d3be528ea2333b426d1ce1405fedf3e8e
+  metadata.gz: 8cbcbc5414d6e04a168c14b15d505e3ecfda89f6ade8ef241a036f4d92d1682aa181e71d2349ccfcf2e0d00a6a0a49469700f9d2c059feb2db39fe5987419f34
+  data.tar.gz: 6de7dd3b4b929147c8d2aa84e3fe04244ddf965d9daa22abb334fde33288f58464f84d1918c99afa89016ad3a244dae2cb90bcbbad67e4d0e1956b6aff36d727

data/.gitignore

@@ -15,3 +15,12 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store
+*.aux
+*.tmp.*
+spec/fixtures/book/
+spec/fixtures/non-book/
+pygments.sty
+.api_token
+.project_id
+spec/fixtures/md-book/log/tralics.log

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.ruby-gemset

@@ -0,0 +1 @@
+polytexnic

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

@@ -1,4 +1,15 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in softcover.gemspec
 gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'debugger2'
+  gem 'webmock',   require: false
+  gem 'simplecov', require: false
+  gem 'rack-test'
+end
+
+group :development do
+  gem 'rake'
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Michael Hartl
+Copyright (c) 2012 Nick Merwin
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,25 +1,42 @@
 # Softcover
 
-TODO: Write a gem description
+## **Note:** Softcover is currently in private beta
 
-## Installation
+It is strongly recommended that right now only members of the private beta use the `softcover` gem. Go to [Softcover.io](http://softcover.io/) to request an invitation to the private beta.
 
-Add this line to your application's Gemfile:
+Softcover is an ebook typesetting system for technical authors. This is the main gem, `softcover`, which depends on `polytexnic` to convert Markdown or PolyTeX input to HTML and LaTeX, and thence to EPUB, MOBI, and PDF. Authors can use Softcover to publish and optionally sell the resulting ebooks (as well as associated digital goods such as screencasts) on the [Softcover publishing platform](http://softcover.io/).
 
-    gem 'softcover'
+For more details about Softcover, see [*The Softcover Manual*](http://manual.softcover.io) (currently in preparation).
 
-And then execute:
+<!--
+# Softcover CLI
 
-    $ bundle
+Command line interface for Softcover.io
 
-Or install it yourself as:
+## Installation
 
     $ gem install softcover
 
 ## Usage
 
-TODO: Write usage instructions here
+    $ softcover <command>
+
+## Commands:
+
+* login
+* logout
+* build:html, build:pdf, build:epub, build:mobi, build:all
+* build (aliased to build:html)
+* publish
+* new
+
+## Development Notes
+    $ softcover config:add host=http://localhost:3000
+
+  * use "silence=false" to unsilence spec output:
 
+    $ silence=false bundle exec rspec
+-->
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,2 @@
 require "bundler/gem_tasks"
+Dir["tasks/**/*.rake"].sort.each { |ext| load ext }

data/bin/sc

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "softcover"
+
+Softcover::CLI.start

data/bin/softcover

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "softcover"
+
+Softcover::CLI.start

data/lib/softcover.rb

@@ -1,5 +1,62 @@
-require "softcover/version"
+require 'polytexnic'
+require 'active_support/core_ext/string'
+
+require_relative 'softcover/formats'
+require_relative 'softcover/utils'
+require_relative 'softcover/output'
+
+profile = false
+if profile
+  Dir[File.join(File.dirname(__FILE__), '/softcover/**/*.rb')].each do |file|
+    t1 = Time.now
+    require file.chomp(File.extname(file))
+    $stderr.puts "#{Time.now - t1} #{File.basename(file)}"
+  end
+end
+
+require_relative 'softcover/book'
+require_relative 'softcover/book_manifest'
+require_relative 'softcover/builder'
+require_relative 'softcover/builders/epub'
+require_relative 'softcover/builders/html'
+require_relative 'softcover/builders/mobi'
+require_relative 'softcover/builders/pdf'
+require_relative 'softcover/builders/preview'
+require_relative 'softcover/cli'
+require_relative 'softcover/commands/auth'
+require_relative 'softcover/commands/build'
+require_relative 'softcover/commands/deployment'
+require_relative 'softcover/commands/epub_validator'
+require_relative 'softcover/commands/generator'
+require_relative 'softcover/commands/opener'
+require_relative 'softcover/commands/server'
+require_relative 'softcover/mathjax'
+require_relative 'softcover/uploader'
+require_relative 'softcover/version'
 
 module Softcover
-  # Your code goes here...
+  extend self
+
+  include Softcover::Utils
+
+  # Return the custom styles, if any.
+  def custom_styles
+    custom_file = 'custom.sty'
+    File.exist?(custom_file) ? File.read(custom_file) : ''
+  end
+
+  def set_test_mode!
+    @test_mode = true
+  end
+
+  def test?
+    @test_mode
+  end
+
+  def profiling?
+    return false if test?
+    false
+  end
 end
+
+require 'softcover/rails/railtie' if defined?(Rails)

data/lib/softcover/book.rb

@@ -0,0 +1,190 @@
+class Softcover::Book
+  include Softcover::Utils
+
+  DEFAULT_SCREENCASTS_DIR = "screencasts"
+
+  attr_accessor :errors, :uploader, :signatures, :manifest,
+                :processed_screencasts, :screencasts_dir
+
+  class UploadError < StandardError; end
+
+  def initialize
+    require "softcover/client"
+    @manifest = Softcover::BookManifest.new
+    @client = Softcover::Client.new_with_book self
+
+    @screencasts_dir = DEFAULT_SCREENCASTS_DIR
+
+    @processed_screencasts = []
+  end
+
+  class BookFile < Struct.new(:path)
+    LAST_WRITE_HORIZON = 5
+
+    attr_accessor :checksum
+    def initialize(*args)
+      super
+      @checksum = Digest::MD5.hexdigest File.read path
+      (@@lookup ||= {})[path] = self
+    end
+
+    def ready?
+      return true if Softcover::test?
+      File::ctime(path).to_i < Time.now.to_i - LAST_WRITE_HORIZON
+    end
+
+    def to_json(opts={})
+      { path: path, checksum: @checksum }.to_json
+    end
+
+    def self.find(path)
+      @@lookup[path]
+    end
+  end
+
+  # TODO: extract pattern to config helper:
+  #   has_config_for :id, :last_uploaded_at, path: ".polytex-book"
+
+  def id
+    Softcover::BookConfig['id']
+  end
+
+  def id=(n)
+    Softcover::BookConfig['id'] = n
+  end
+
+  # get array of paths and checksums
+  def files
+    # question: should we use `git ls-files` instead?
+    # TODO: only use pertinent files
+    paths = %w{html/*_fragment.html images/**/* ebooks/*}
+    Dir[*paths].reject { |path| File.directory?(path) }.map do |path|
+      BookFile.new path
+    end
+  end
+
+  def filenames
+    files.map &:path
+  end
+
+  def chapter_attributes
+    chapters.map(&:to_hash)
+  end
+
+  def url
+    # TODO: append api_token to auto-login?
+    "#{@client.host}/books/#{id}/redirect"
+  end
+
+  # Opens the book in the browser (OS X–only).
+  def open_in_browser
+    `open #{url}`
+  end
+
+  def create_or_update
+    raise "HTML not built!" if Dir['html/*'].empty?
+
+    res = @client.create_or_update_book id: id,
+                                        files: files,
+                                        title: title,
+                                        slug: slug,
+                                        subtitle: subtitle,
+                                        description: description,
+                                        cover: cover,
+                                        chapters: chapter_attributes
+
+    if res['errors']
+      @errors = res['errors']
+      return false
+    end
+
+    # is this needed?
+    @attrs = res['book']
+
+    self.id = @attrs['id']
+    Softcover::BookConfig['last_uploaded_at'] = Time.now
+
+    @uploader = Softcover::Uploader.new res
+
+    true
+
+  rescue Exception => e
+    @errors = [e.message]
+    raise e
+    false
+  end
+
+  def upload!(options={})
+    @uploader.after_each do |params|
+      notify_file_upload params['path']
+    end
+
+    @uploader.upload!(options)
+
+    res = @client.notify_upload_complete
+
+    if res['errors'].nil?
+      return url
+    else
+      raise UploadError, "Couldn't verify upload: #{res['errors']}"
+    end
+  end
+
+  def notify_file_upload(path)
+    book_file = BookFile.find path
+
+    # this could spin off new thread:
+    @client.notify_file_upload path: book_file.path,
+      checksum: book_file.checksum
+  end
+
+  def destroy
+    res = @client.destroy
+    if res['errors']
+      @errors = res['errors']
+      return false
+    end
+    true
+  end
+
+  # ============================================================================
+  # Screencast handling
+  # ============================================================================
+
+  def process_screencasts
+    files_to_upload = find_screencasts.select do |file|
+      next false if @processed_screencasts.include?(file)
+
+      file.ready?# && upload_screencast!(file)
+    end
+
+    upload_screencasts! files_to_upload
+
+    @processed_screencasts += files_to_upload
+  end
+
+  def find_screencasts
+    Dir["#{@screencasts_dir}/**/*.mov"].map{ |path| BookFile.new path }
+  end
+
+  def upload_screencasts!(files)
+    return if files.empty?
+
+    res = @client.get_screencast_upload_params files
+
+    if res['upload_params']
+      screencast_uploader = Softcover::Uploader.new res
+      screencast_uploader.after_each do |params|
+        notify_file_upload params['path']
+      end
+      screencast_uploader.upload!
+    else
+      raise 'server error'
+    end
+  end
+
+  private
+    def method_missing(name, *args, &block)
+      @manifest.send(name) || super
+    end
+end