ebook_generator 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d00c5f445bb58f02fd5421fbc9f449b2fc8ad45
+  data.tar.gz: f56981f51e890a4fb2d6d5762731fb4be0df7586
+SHA512:
+  metadata.gz: b217a3d82a044ee065111b94aa9ada5e86b5087348c35659b5b9a93898d45a4cba34aab3d30881c09756974789d736435ee1642847209f17d5c6769e37593a19
+  data.tar.gz: f0ef7a57ca03587fd3dd8c4343bb53900158339d7674d80b1f501c6a875320d2a37a717cf1733134215ee9545e8dfda1eb278be198477c0893be7a782dc0993d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Changelog.md

@@ -0,0 +1,10 @@
+# EbookGenerator Changelog
+
+## 0.0.2 (2014-04-18)
+
+- Fixed bug where the methods could not be accessed
+
+## 0.0.1 (2014-04-17)
+
+- Added db migrations
+- Added generate ePub class

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kris Quigley
+
+MIT License
+
+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,77 @@
+# EbookGenerator
+
+Rails gem to generate eBooks using the Markdown syntax to format content for sections of the book.
+
+An example of this gem being used can be found at: [ebook-generator.affinity-tech.com](http://ebook-generator.affinity-tech.com)
+
+Requires:
+- Postgres with UUID support (uses the id to generate the ebook UUID)
+- Rubyzip (to generate the .epub)
+- Redcarpet (to render Markdown into HTML)
+- Friendly_id (for nice slugs and for naming of generated ebook file)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ebook_generator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ebook_generator
+
+## Usage
+
+Generate the tables needed to process the ebooks:
+
+`rails generate ebook_generator`
+
+Migrate the db:
+
+`rake db:migrate`
+
+Require the ebook_generator module in your class:
+
+`include 'EbookGenerator'`
+
+Pass the id for the ebook you want to generate:
+
+`EbookGenerator.generate_ebook(ebook.id)`
+
+This will then generate an ebook based on the values in the db in the /tmp folder.
+
+## Feature roadmap
+
+### 0.1.0
+- Kindle support
+- Tests
+
+### 0.2.0
+- Style editing
+
+### 0.3.0
+- PDF out
+
+### 0.4.0
+- HTML out
+- Image support for the front cover
+
+### 0.5.0
+- HTML to eBook conversion
+
+### 0.6.0
+- User membership to manage books
+
+Publishing support?
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ebook_generator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/ebook_generator.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ebook_generator/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'ebook_generator'
+  s.version     = EbookGenerator::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Generates eBooks"
+  s.description = "A simple eBook (ePub) generator gem"
+  s.authors     = ["Kris Quigley"]
+  s.email       = 'kris@krisquigley.co.uk'
+  s.homepage    =
+    'https://github.com/krisquigley/ebook_generator'
+
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.license       = 'MIT'
+end

data/lib/ebook_generator/initializer.rb

@@ -0,0 +1,5 @@
+# Nothing needed here at this time
+
+EbookGenerator.defaults do |config|
+
+end

data/lib/ebook_generator/migration.rb

@@ -0,0 +1,30 @@
+class CreateEbookGeneratorTables < ActiveRecord::Migration
+  def change
+    enable_extension 'uuid-ossp'
+
+    create_table :ebooks, id: :uuid, default: "uuid_generate_v4()" do |t|
+      t.string    "title",      null: false
+      t.string    "creator"
+      t.string    "language",   limit: 2
+      t.string    "contributor"
+      t.text      "description"
+      t.string    "publisher"
+      t.text      "rights"
+      t.string    "subject"
+      t.datetime  "created_at"
+      t.datetime  "updated_at"
+    end
+
+    create_table "sections", force: true do |t|
+      t.string   "title",      null: false
+      t.text     "content",    null: false
+      t.uuid     "ebook_id",   null: false
+      t.integer  "position",   null: false
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    add_index "sections", ["ebook_id"], name: "index_sections_on_ebook_id", using: :btree
+    add_index "sections", ["position"], name: "index_sections_on_position", using: :btree
+  end
+end

data/lib/ebook_generator/version.rb

@@ -0,0 +1,3 @@
+module EbookGenerator
+  VERSION = "0.0.2"
+end

data/lib/ebook_generator.rb

@@ -0,0 +1,208 @@
+require "ebook_generator/version"
+
+module EbookGenerator
+
+  def self.included(model_class)
+    model_class.extend self
+  end
+
+  # Move writing of files into its own class that accepts an array
+  def self.make_dir(path)
+    Dir.mkdir(path, 0777) unless File.exists?(path)
+  end
+
+  def self.initialise_files(path)
+    metainf_path = path + "/META-INF"
+
+    Dir.mkdir(metainf_path) unless File.exists?(metainf_path)
+
+    metainf = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+      <container version=\"1.0\" xmlns=\"urn:oasis:names:tc:opendocument:xmlns:container\">
+        <rootfiles>
+          <rootfile full-path=\"OEBPS/content.opf\" media-type=\"application/oebps-package+xml\"/>
+        </rootfiles>
+      </container>"
+
+    File.open(metainf_path + "/container.xml", "w+") do |f|
+      f.write(metainf)
+    end
+
+    mimetype = "application/epub+zip"
+    mimetype_path = path + "/mimetype"
+
+    File.open(mimetype_path, "w+") do |f|
+      f.write(mimetype)
+    end
+
+    FileUtils.chmod 0755, mimetype_path
+
+    content_path = path + "/OEBPS"
+
+    Dir.mkdir(content_path) unless File.exists?(content_path)
+
+    Dir.mkdir(content_path + "/Text") unless File.exists?(content_path + "/Text")
+
+    Dir.mkdir(content_path + "/Styles") unless File.exists?(content_path + "/Styles")
+
+    root = Rails.root.to_s
+
+    FileUtils.cp "#{root}/app/ebook/style.css", content_path+"/Styles"
+
+    return content_path
+
+  end
+
+  def self.generate_headers(attrs)
+    xml = "<title>#{attrs.title}</title>
+      <meta content=\"#{attrs.title}\" name=\"Title\" />
+      <meta content=\"#{attrs.title}\" name=\"Author\" />
+      <link href=\"../Styles/style.css\" rel=\"stylesheet\" type=\"text/css\" />"
+    return xml
+  end
+
+  def self.generate_sections(path, attrs)
+    markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, autolink: true, tables: true)
+    headers = generate_headers(attrs)
+
+    attrs.sections.each do |section|
+      xml = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"no\"?>
+        <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\"
+          \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">
+        <html xmlns=\"http://www.w3.org/1999/xhtml\">
+        <head>
+          #{headers}
+        </head>
+        <body>
+          <div id=\"#{section.title}\">
+          "
+      xml += markdown.render(section.content)
+      xml += "
+          </div>
+        </body>
+        </html>"
+
+      File.open(path + "/Section#{section.position}.html", "w+") do |f|
+        f.write(xml)
+      end
+    end
+  end
+
+  def self.generate_content_opf(path, attrs)
+    xml = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>
+    <package xmlns=\"http://www.idpf.org/2007/opf\" unique-identifier=\"BookId\" version=\"2.0\">
+      <metadata xmlns:dc=\"http://purl.org/dc/elements/1.1/\" xmlns:opf=\"http://www.idpf.org/2007/opf\">
+        <dc:identifier id=\"BookId\" opf:scheme=\"UUID\">#{attrs.id}</dc:identifier>
+        <dc:title>#{attrs.title}</dc:title>
+        <dc:creator opf:role=\"aut\">#{attrs.creator}</dc:creator>
+        <dc:language>#{attrs.language}</dc:language>
+        <dc:date opf:event=\"modification\">#{attrs.updated_at}</dc:date>
+        <dc:description>#{attrs.description}</dc:description>
+        <dc:publisher>#{attrs.publisher}</dc:publisher>
+        <dc:rights>#{attrs.rights}</dc:rights>
+        <dc:subject>#{attrs.subject}</dc:subject>
+        <dc:contributor opf:role=\"cov\">#{attrs.contributor}</dc:contributor>
+        <meta content=\"0.7.2\" name=\"Sigil version\" />
+      </metadata>
+      <manifest>
+        <item href=\"toc.ncx\" id=\"ncx\" media-type=\"application/x-dtbncx+xml\" />
+        <item href=\"Styles/style.css\" id=\"style.css\" media-type=\"text/css\" />"
+
+    attrs.sections.each do |section|
+      xml += "<item href=\"Text/Section#{section.position}.html\" id=\"Section#{section.position}.html\" media-type=\"application/xhtml+xml\" />"
+    end
+
+    xml += "<item href=\"Fonts/junicode-italic-webfont.ttf\" id=\"junicode-italic-webfont.ttf\" media-type=\"application/x-font-ttf\" />
+        <item href=\"Fonts/junicode-webfont.ttf\" id=\"junicode-webfont.ttf\" media-type=\"application/x-font-ttf\" />
+        <item href=\"Fonts/junicode-bold-webfont.ttf\" id=\"junicode-bold-webfont.ttf\" media-type=\"application/x-font-ttf\" />
+      </manifest>
+      <spine toc=\"ncx\">"
+
+    attrs.sections.each do |section|
+      xml += "<itemref idref=\"Section#{section.position}.html\" />"
+
+    end
+    xml += "</spine>
+      <guide />
+    </package>"
+
+    content_path = path + "/content.opf"
+
+    File.open(content_path, "w+") do |f|
+      f.write(xml)
+    end
+
+    FileUtils.chmod 0755, content_path
+
+  end
+
+  def self.generate_toc_ncx(path, attrs)
+    xml = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\" ?>
+    <!DOCTYPE ncx PUBLIC \"-//NISO//DTD ncx 2005-1//EN\"
+     \"http://www.daisy.org/z3986/2005/ncx-2005-1.dtd\">
+    <ncx xmlns=\"http://www.daisy.org/z3986/2005/ncx/\" version=\"2005-1\">
+      <head>
+        <meta content=\"urn:uuid:${attrs.id}\" name=\"dtb:uid\"/>
+        <meta content=\"2\" name=\"dtb:depth\"/>
+        <meta content=\"0\" name=\"dtb:totalPageCount\"/>
+        <meta content=\"0\" name=\"dtb:maxPageNumber\"/>
+      </head>
+      <docTitle>
+        <text>#{attrs.title}</text>
+      </docTitle>
+      <navMap>"
+
+
+    attrs.sections.each do |section|
+      xml += "<navPoint id=\"navPoint-#{section.position}\" playOrder=\"#{section.position}\">
+        <navLabel>
+          <text>#{section.title}</text>
+        </navLabel>
+        <content src=\"Text/Section#{section.position}.html\"/>
+      </navPoint>"
+    end
+
+    xml += "</navMap>
+    </ncx>"
+
+    toc_path = path + "/toc.ncx"
+
+    File.open(toc_path, "w+") do |f|
+      f.write(xml)
+    end
+
+    FileUtils.chmod 0755, toc_path
+  end
+
+  def self.remove_tmp_dir(directory)
+    FileUtils.remove_dir(directory, true)
+  end
+
+  def self.generate_ebook(ebook_id)
+
+    # create tmp directory based on UUID
+    path = Rails.root.join "tmp/#{ebook_id}"
+    make_dir(path.to_s)
+
+    # set up required files and dirs
+    content_path = initialise_files(path.to_s)
+
+    # loop through each section loading the reference header and saving as it's own section
+    attrs = Ebook.find(ebook_id)
+    generate_sections(content_path + "/Text", attrs)
+
+    # generate toc based on the number of sections generated
+    generate_content_opf(content_path, attrs)
+    generate_toc_ncx(content_path, attrs)
+
+    # zip all files
+    zipfile_name = Rails.root.to_s + "/tmp/" + attrs.slug + ".epub"
+
+    zf = ZipFileProcessor.new(path.to_s, zipfile_name)
+    zf.write
+
+    # Clean up the tmp dir
+    remove_tmp_dir(path.to_s + "/")
+
+  end
+
+end

data/lib/generators/ebook_generator_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+require "rails/generators/active_record"
+
+class EbookGeneratorGenerator < ActiveRecord::Generators::Base
+  argument :name, type: :string, default: 'random_name'
+
+  source_root File.expand_path('../../ebook_generator', __FILE__)
+
+  # Copies the migration template to db/migrate.
+  def copy_files
+    migration_template 'migration.rb', 'db/migrate/create_ebook_generator_tables.rb'
+  end
+
+  def create_initializer
+    copy_file 'initializer.rb', 'config/initializers/ebook_generator.rb'
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: ebook_generator
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Kris Quigley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-18 00:00:00.000000000 Z
+dependencies: []
+description: A simple eBook (ePub) generator gem
+email: kris@krisquigley.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Changelog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ebook_generator.gemspec
+- lib/ebook_generator.rb
+- lib/ebook_generator/initializer.rb
+- lib/ebook_generator/migration.rb
+- lib/ebook_generator/version.rb
+- lib/generators/ebook_generator_generator.rb
+homepage: https://github.com/krisquigley/ebook_generator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Generates eBooks
+test_files: []