softcover 0.0.1 → 0.5.0

data/lib/softcover/cli.rb

@@ -0,0 +1,236 @@
+require "thor"
+
+module Softcover
+  class CLI < Thor
+    include Softcover::Utils
+
+    map "-v" => :version
+
+    desc "version", "Returns the version number"
+    method_option :version, aliases: '-v',
+                            desc: "Print version number", type: :boolean
+    def version
+      require 'softcover/version'
+      puts "Softcover #{Softcover::VERSION}"
+      exit 0
+    end
+
+    # ===============================================
+    # Builder
+    # ===============================================
+
+    desc 'build, build:all', 'Build all formats'
+    method_option :quiet, aliases: '-q',
+                          desc: "Quiet output", type: :boolean
+    method_option :silent, aliases: '-s',
+                           desc: "Silent output", type: :boolean
+    def build
+      Softcover::Commands::Build.all_formats(options)
+    end
+    map "build:all" => "build"
+
+    Softcover::FORMATS.each do |format|
+      desc "build:#{format}", "Build #{format.upcase}"
+      if format == 'pdf'
+        method_option :debug, aliases: '-d',
+                              desc: "Run raw xelatex for debugging purposes",
+                              type: :boolean
+        method_option :once, aliases: '-o',
+                             desc: "Run PDF generator once (no xref update)",
+                             type: :boolean
+        method_option :'find-overfull', aliases: '-f',
+                                        desc: "Find overfull hboxes",
+                                        type: :boolean
+      end
+      method_option :quiet, aliases: '-q',
+                            desc: "Quiet output", type: :boolean
+      method_option :silent, aliases: '-s',
+                             desc: "Silent output", type: :boolean
+      define_method "build:#{format}" do
+        Softcover::Commands::Build.for_format format, options
+      end
+    end
+
+    # ===============================================
+    # Preview
+    # ===============================================
+    desc "build:preview", "Build book preview in all formats"
+    method_option :quiet, aliases: '-q',
+                          desc: "Quiet output", type: :boolean
+    method_option :silent, aliases: '-s',
+                           desc: "Silent output", type: :boolean
+    define_method "build:preview" do
+      Softcover::Commands::Build.preview(options)
+    end
+
+    # ===============================================
+    # Server
+    # ===============================================
+
+    desc 'server', 'Run local server'
+    method_option :port, type: :numeric, default: 4000, aliases: '-p'
+    def server
+      if Softcover::BookManifest::valid_directory?
+        Softcover::Commands::Server.run options[:port]
+      else
+        puts 'Not in a valid book directory.'
+        exit 1
+      end
+    end
+
+    # ===============================================
+    # Auth
+    # ===============================================
+
+    desc "login", "Log into Softcover account"
+    def login
+      puts "Logging in."
+
+      logged_in = false
+      while not logged_in do
+        email = ask "Email:"
+        password = ask_without_echo "Password (won't be shown):"
+        unless logged_in = Softcover::Commands::Auth.login(email, password)
+          puts "Invalid login, please try again."
+        end
+      end
+      puts "Welcome back, #{email}!"
+    end
+
+    desc "logout", "Log out of Softcover account"
+    def logout
+      Softcover::Commands::Auth.logout
+    end
+
+    # ===============================================
+    # Publisher
+    # ===============================================
+
+    desc "publish", "Publish your book on Softcover"
+    method_option :quiet, aliases: '-q',
+                          desc: "Quiet output", type: :boolean
+    method_option :silent, aliases: '-s',
+                           desc: "Silent output", type: :boolean
+    def publish
+      require 'softcover/commands/publisher'
+
+      invoke :login unless logged_in?
+
+      puts "Publishing..." unless options[:silent]
+      Softcover::Commands::Publisher.publish!(options)
+    end
+
+    desc "publish:screencasts", "Publish screencasts"
+    method_option :daemon, aliases: '-d', force: false,
+      desc: "Run as daemon", type: :boolean
+    method_option :watch, aliases: '-w', type: :boolean,
+      force: false, desc: "Watch a directory to auto upload."
+
+    # TODO: make screencasts dir .book configurable
+    define_method "publish:screencasts" do |dir=
+      Softcover::Book::DEFAULT_SCREENCASTS_DIR|
+
+      puts "Publishing screencasts in #{dir}"
+      Softcover::Commands::Publisher.
+        publish_screencasts! options.merge(dir: dir)
+    end
+
+    desc "unpublish", "Removes book from Softcover"
+    def unpublish
+      require 'softcover/commands/publisher'
+
+      invoke :login unless logged_in?
+
+      slug = Softcover::BookManifest.new.slug
+      if ask("Type '#{slug}' to unpublish:") == slug
+        puts "Unpublishing..." unless options[:silent]
+        Softcover::Commands::Publisher.unpublish!
+      else
+        puts "Canceled."
+      end
+    end
+
+    # ===============================================
+    # Deployment
+    # ===============================================
+    desc "deploy", "Build & publish book (configure using .softcover-deploy)"
+    def deploy
+      Softcover::Commands::Deployment.deploy!
+    end
+
+    # ===============================================
+    # Generator
+    # ===============================================
+
+    desc "new <name>", "Generate new book directory structure."
+    method_option :markdown,
+                  :type => :boolean,
+                  :default => false,
+                  :aliases => "-m",
+                  :desc => "Generate a Markdown book."
+    method_option :simple,
+                  :type => :boolean,
+                  :default => false,
+                  :aliases => "-s",
+                  :desc => "Generate a simple book."
+    def new(n)
+      Softcover::Commands::Generator.generate_file_tree(n, options)
+    end
+
+    # ===============================================
+    # Open
+    # ===============================================
+
+    desc "open", "Open book on Softcover website (OS X only)"
+    def open
+      Softcover::Commands::Opener.open!
+    end
+
+    # ===============================================
+    # EPUB validate
+    # ===============================================
+
+    desc "epub:validate, epub:check", "Validate EPUB with epubcheck"
+    define_method "epub:validate" do
+      Softcover::Commands::EpubValidator.validate!
+    end
+    map "epub:check" => "epub:validate"
+
+    # ===============================================
+    # Config
+    # ===============================================
+
+    desc "config", "View local config"
+    def config
+      require "softcover/config"
+      Softcover::Config.read
+    end
+
+    desc "config:add key=value", "Add to your local config vars"
+    define_method "config:add" do |pair|
+      require "softcover/config"
+      key, value = pair.split "="
+      Softcover::Config[key] = value
+
+      puts 'Config var added:'
+      config
+    end
+
+    desc "config:remove key", "Remove the key from your local config vars"
+    define_method "config:remove" do |key|
+      require "softcover/config"
+      Softcover::Config[key] = nil
+
+      puts 'Config var removed.'
+    end
+
+    protected
+      def ask_without_echo(*args)
+        system "stty -echo"
+        ret = ask *args
+        system "stty echo"
+        puts
+        ret
+      end
+  end
+end

data/lib/softcover/client.rb

@@ -0,0 +1,113 @@
+
+module Softcover
+  class Client
+    include Softcover::Utils
+
+    ApiVersion = 1
+
+    ApiPrefix = "/api/v#{ApiVersion}"
+
+    Paths = {
+      login: 'login',
+      books: 'books'
+    }
+
+    attr_accessor :host, :book
+
+    def initialize(email=nil,password=nil,book=nil)
+      require 'json'
+      require 'rest_client'
+      require "softcover/config"
+      @email = email
+      @password = password
+      @book = book
+
+      @api_key = Softcover::Config['api_key']
+      @host = Softcover::Config['host']
+    end
+
+    def self.new_with_book(book)
+      new nil, nil, book
+    end
+
+    # ============ Auth ===========
+    def login!
+      require "softcover/config"
+      response = post path_for(:login), email: @email, password: @password
+
+      json = JSON response
+      Softcover::Config['api_key'] = @api_key = json['api_key']
+    end
+
+    # ============ Publishing ===========
+    def create_or_update_book(params)
+      JSON post path_for(:books), params
+    rescue RestClient::ResourceNotFound
+      { "errors" =>
+        "Book ID #{params[:id]} not found for this account. "+
+        "Either login again or delete this file: .softcover-book"
+      }
+    end
+
+    def notify_file_upload(params)
+      JSON post path_for(:books, book.id, :notify_file_upload), params
+    end
+
+    def notify_upload_complete
+      JSON put path_for(:books, book.id), upload_complete: true
+    end
+
+    def destroy
+      delete path_for(:books, book.id)
+    end
+
+    # ============ Screencasts ===========
+    def get_screencast_upload_params(files)
+      JSON post path_for(:books, book.id, :screencasts), files: files
+      # TODO: handle errors
+    end
+
+    # ============ Utils ===========
+    private
+      %w{put post}.each do |verb|
+        define_method verb do |url, params={}, headers={}|
+          begin
+            RestClient.send verb, @host + url,
+              params_with_key(params).to_json,
+              formatted_headers(headers)
+          rescue RestClient::UnprocessableEntity
+            handle_422
+          end
+        end
+      end
+
+      %w{get delete}.each do |verb|
+        define_method verb do |url, headers={}|
+          begin
+            path = "#{@host + url}?api_key=#{@api_key}"
+            RestClient.send verb, path, formatted_headers(headers)
+          rescue RestClient::UnprocessableEntity
+            handle_422
+          end
+        end
+      end
+
+      def params_with_key(params)
+        @api_key.present? ? params.merge({api_key: @api_key}) : params
+      end
+
+      def formatted_headers(headers={})
+        headers.merge accept: :json, content_type: :json
+      end
+
+      def path_for(action, *args)
+        File.join ApiPrefix, Paths[action], *(args.map &:to_s)
+      end
+
+      def handle_422
+        require "softcover/config"
+        Softcover::Config['api_key'] = nil
+        return { "errors" => "You don't have access to that resource." }
+      end
+  end
+end

data/lib/softcover/commands/auth.rb

@@ -0,0 +1,18 @@
+module Softcover
+  module Commands
+    module Auth
+      extend self
+
+      def login(email, password)
+        require "softcover/client"
+        client = Softcover::Client.new email, password
+        client.login!
+      end
+
+      def logout
+        require "softcover/config"
+        Softcover::Config['api_key'] = nil
+      end
+    end
+  end
+end

data/lib/softcover/commands/build.rb

@@ -0,0 +1,51 @@
+module Softcover
+  module Commands
+    module Build
+      include Softcover::Output
+      extend self
+
+      # Builds the book for the given format.
+      def for_format(format, options={})
+        raise 'Invalid format' unless Softcover::FORMATS.include?(format)
+        building_message(format.upcase, options)
+        builder_for(format).build!(options)
+        if format == 'html' && !(options[:silent] || options[:quiet])
+          puts "LaTeX-to-XML debug information output to log/tralics.log"
+        end
+      end
+
+      # Builds the book for all formats.
+      def all_formats(options={})
+        building_message('all formats', options)
+        Softcover::BUILD_ALL_FORMATS.each do |format|
+          if format == 'mobi'
+            building_message('EPUB & MOBI', options)
+          else
+            building_message(format.upcase, options)
+          end
+          builder_for(format).build!(options)
+        end
+      end
+
+      # Builds the book preview.
+      def preview(options={})
+        building_message('preview', options)
+        builder_for('preview').build!
+      end
+
+      # Returns the builder for the given format.
+      def builder_for(format)
+        "Softcover::Builders::#{format.titleize}".constantize.new
+      end
+
+      private
+
+        # Shows a message when building a particular format.
+        def building_message(format, options={})
+          unless options[:silent] || options[:'find-overfull']
+            puts "Building #{format}..."
+          end
+        end
+    end
+  end
+end

data/lib/softcover/commands/deployment.rb

@@ -0,0 +1,42 @@
+module Softcover
+  module Commands
+    module Deployment
+      include Softcover::Utils
+      extend self
+
+      # Deploy a book by building and publishing it.
+      # The deploy steps can be customized using `.poly-publish`
+      # in the book project's home directory.
+      def deploy!
+        if File.exist?('.softcover-deploy') && !custom_commands.empty?
+          execute custom_commands
+        else
+          execute default_commands
+        end
+      end
+
+      # Returns the default commands.
+      def default_commands
+        commands(['softcover build:all', 'softcover build:preview',
+                  'softcover publish'])
+      end
+
+      # Returns custom commands (if any).
+      def custom_commands
+        commands(File.readlines(deploy_config).map(&:strip))
+      end
+
+      # Returns the filename for configuring `softcover deploy`.
+      def deploy_config
+        '.softcover-deploy'
+      end
+
+      # Returns the commands from the given lines.
+      # We skip comments and blank lines.
+      def commands(lines)
+        skip = /(^\s*#|^\s*$)/
+        lines.reject { |line| line =~ skip }.join("\n")
+      end
+    end
+  end
+end