enwrite 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29b7e3af7cfaaa08cf0be33569aa558a35daa502
+  data.tar.gz: 4ab795bb5115e458b772903e303318270f6d22bb
+SHA512:
+  metadata.gz: e3db52be55a5648a98440ef78d7e6a6a7e4de825f81a87a60cf4620049666deefe81a02b478a31fadd8159ae7db41caf492fe90031e8b9fb28338769686a19db
+  data.tar.gz: ba8b5c411395d07ed358304346b81915b6e1e942ef962bb0c700e9b3513b2c3448f6e03f846e6e61449047eff00da70df5e08d3a1c0066ee1904e8a09d510174

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "colorize", "~> 0.7"
+gem "deep_merge", "~> 1.0"
+gem "evernote-thrift", "~> 1.25"
+gem "evernote_oauth", "~> 0.2"
+gem "htmlentities", "~> 4.3"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0"
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    builder (3.2.2)
+    colorize (0.7.5)
+    deep_merge (1.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    evernote-thrift (1.25.1)
+    evernote_oauth (0.2.3)
+      evernote-thrift
+      oauth (>= 0.4.1)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.4.1)
+    highline (1.7.2)
+    htmlentities (4.3.3)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.2)
+    jwt (1.4.1)
+    mini_portile (0.6.2)
+    multi_json (1.11.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth (0.4.7)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.0)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    thread_safe (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  colorize (~> 0.7)
+  deep_merge (~> 1.0)
+  evernote-thrift (~> 1.25)
+  evernote_oauth (~> 0.2)
+  htmlentities (~> 4.3)
+  jeweler (~> 2.0)
+  rdoc (~> 3.12)

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Diego Zamboni
+
+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/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Diego Zamboni
+
+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,90 @@
+# Enwrite
+
+> What wild heart-histories seemed to lie enwritten<br/>
+> Upon those crystalline, celestial spheres!
+<p align="right">&mdash;Edgar Allan Poe</p>
+
+Evernote-powered statically-generated blogs and websites.
+
+Still work-in-progress but functional, more docs to come soon.
+
+The first time you run it (or if you use the `--auth` flag afterward)
+you will be asked to open an Evernote authentication page, and then to
+provide the authentication code to Enwrite.
+
+For now it produces output suitable for [Hugo](http://gohugo.io). You
+need to have an existing Hugo install.
+
+## Getting started
+
+Install using gem:
+
+    $ gem install enwrite
+
+Create a new Hugo site for testing (if you don't have one already):
+
+    $ cd ~/tmp
+    $ hugo new site my-hugo-blog
+    $ mkdir my-hugo-blog/themes; git clone https://github.com/zyro/hyde-x.git my-hugo-blog/themes/hyde-x
+
+Populate it with contents from Evernote:
+
+    $ enwrite --help
+    Enwrite v0.2.0
+    
+    Usage: /usr/local/bin/enwrite [options] (at least one of -n or -s has to be specified)
+    
+    Search options:
+        -n, --notebook NOTEBOOK          Process notes from specified notebook.
+        -t, --tag TAG                    Process only notes that have this tag
+                                         within the given notebook.
+            --remove-tags [t1,t2,t3]     List of tags to remove from output posts.
+                                         If no argument given, defaults to --tag.
+        -s, --search SEARCHEXP           Process notes that match given search
+                                         expression. If specified, --notebook
+                                         and --tag are ignored.
+    Output options:
+        -p, --output-plugin PLUGIN       Output plugin to use (Valid values: hugo)
+        -o, --output-dir OUTDIR          Base dir of hugo output installation
+            --rebuild-all                Process all notes that match the given
+                                         conditions (normally only updated notes
+                                         are processed)
+    Other options:
+            --auth [TOKEN]               Force Evernote reauthentication (will
+                                         happen automatically if needed). Use
+                                         TOKEN if given, otherwise get one
+                                         interactively.
+            --config-tag TAG             Specify tag to determine config notes
+                                         (default: _enwrite_config)
+            --verbose                    Verbose mode
+        -v, --debug                      Debug output mode
+            --version                    Show version
+        -h, --help                       Shows this help message
+    
+Generate posts from all notes tagged `published` in notebook
+`my_notebook`:
+
+    $ enwrite -n my_notebook -t published -o ~/tmp/my-hugo-blog
+    $ cd ~/tmp/my-hugo-blog
+    $ hugo server --watch
+
+Generate posts from all notes matching `some search expression`:
+
+    $ enwrite -s 'some search expression' -o /tmp/my-hugo-blog
+
+Images, audio and video are embedded in the generated posts (audio
+and video are done using HTML5 `<audio>` and `<video>` tags). Other
+file types are stored and linked to with their filename.
+
+The following shortcuts are recognized:
+
+Embed Youtube video by URL or ID. You can optionally specify `width`
+and `height`. All arguments must be enclosed in double quotes.
+
+    [youtube url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"]
+    [youtube src="https://www.youtube.com/watch?v=dQw4w9WgXcQ"]
+    [youtube id="dQw4w9WgXcQ" width="640px" height="480px"]
+
+Embed gist:
+
+    [gist url="https://gist.github.com/zzamboni/843142d3f759e582fe8f"]

data/Rakefile

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require './lib/enwrite.rb'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "enwrite"
+  gem.homepage = "http://github.com/zzamboni/enwrite"
+  gem.license = "MIT"
+  gem.summary = %Q{Enwrite: Power a web site using Evernote}
+  gem.description = %Q{Enwrite allows you to generate a website from contents stored in Evernote.
+At the moment only Hugo (http://gohugo.io) is supported as an output format,
+but others can be added through plugins.}
+  gem.email = "diego@zzamboni.org"
+  gem.authors = ["Diego Zamboni"]
+  # dependencies defined in Gemfile
+  gem.executables = [ 'enwrite' ]
+  gem.version = Enwrite::Version::STRING
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "enwrite #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/enwrite

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+#
+# enwrite - power a web site using Evernote
+#
+# Diego Zamboni, March 2015
+# Time-stamp: <2015-04-28 13:26:56 diego>
+
+require 'enwrite'
+
+Enwrite.run

data/lib/enml-utils.rb

@@ -0,0 +1,196 @@
+# coding: utf-8
+#
+# ENML Processing class
+#
+# Diego Zamboni, March 2015
+# Time-stamp: <2015-04-30 00:45:35 diego>
+
+require 'digest'
+require 'htmlentities'
+require 'rexml/parsers/sax2parser'
+require 'rexml/sax2listener'
+require 'rexml/document'
+require 'rexml/element'
+require 'util'
+include REXML
+
+class ENML_Listener
+  include REXML::SAX2Listener
+
+  def initialize(resources, to_text, static_dirs, note_guid)
+    @to_text = to_text
+    @files = []
+    @resources = resources || []
+    @dirs = static_dirs
+    @note_guid = note_guid
+    @resource_index = {}
+    @resources.each do |res|
+      hash = Digest.hexencode(res.data.bodyHash)
+      @resource_index[hash] = res
+      verbose "Stored index for resource with hash #{hash}"
+    end
+  end
+    
+  def start_document
+    @outdoc = Document.new
+    @stack = [@outdoc]
+  end
+
+  def process_file(attributes, type, subtype)
+    resource = @resource_index[attributes['hash']]
+    if resource.nil?
+      error "An error occurred - I don't have a resource with hash #{attributes['hash']}"
+      return nil
+    else
+      new_file = {}
+      if (!resource.attributes.nil? && !resource.attributes.fileName.nil?)
+        new_file[:basename] = resource.attributes.fileName
+      else
+        new_file[:basename] = "#{attributes['hash']}.#{subtype}"
+      end
+      if @dirs[type]
+        new_file[:fname] = "#{@dirs[type][0]}/#{attributes['hash']}/#{new_file[:basename]}"
+        new_file[:url] = "#{@dirs[type][1]}/#{attributes['hash']}/#{new_file[:basename]}"
+      end
+      new_file[:data] = resource.data.body
+      return new_file
+    end
+  end
+  
+  def start_element(uri, localname, qname, attributes)
+    new_elem = nil
+    if localname == 'en-note'
+      # Convert <en-note> to <span>
+      new_elem = Element.new('span')
+      new_elem.add_attributes(attributes)
+    elsif localname == 'en-todo'
+      unless @to_text
+        new_elem = Element.new('input')
+        new_elem.add_attribute('type', 'checkbox')
+        if attributes and attributes['checked'] == 'true'
+          new_elem.add_attribute('checked', 'checked')
+        end
+      else
+        if attributes and attributes['checked'] == 'true'
+          @stack[-1].add_text("[x] ")
+        else
+          @stack[-1].add_text("[ ] ")
+        end
+      end
+    elsif localname == 'en-media'
+      if attributes['type'] =~ /^image\/(.+)/
+        subtype = $1
+        new_file = process_file(attributes, 'image', subtype)
+        if new_file
+          new_elem = Element.new('img')
+          new_elem.add_attributes(attributes)
+          new_elem.add_attribute('src', new_file[:url])
+          @files.push(new_file)
+        end
+      elsif attributes['type'] =~ /^(audio|video)\/(.*)/
+        type = $1
+        subtype = $2
+        new_file = process_file(attributes, type, subtype)
+        if new_file
+          new_elem = Element.new(type)
+          new_elem.add_attribute('controls', "1")
+          new_elem.add_element 'source', { 'src' => new_file[:url], 'type' => attributes['type'] }
+          new_elem.add_text "Sorry, your browser does not support the #{type} tag."
+          @files.push(new_file)
+        end
+      elsif attributes['type'] =~ /^(\S+)\/(\S+)/
+        type = $1
+        subtype = $2
+        new_file = process_file(attributes, 'files', subtype)
+        if new_file
+          new_elem = Element.new('a')
+          new_elem.add_attribute('href', new_file[:url])
+          new_elem.add_text(new_file[:basename])
+          @files.push(new_file)
+        end
+      else
+        error "Sorry, I don't know how to handle attachments of this type: #{attributes['type']}"
+      end
+    else
+      new_elem = Element.new(localname)
+      new_elem.add_attributes(attributes)
+    end
+    @stack.push(new_elem)
+  end
+  
+  def end_element(uri, localname, qname)
+    new_elem = @stack.pop
+    @stack[-1].add_element(new_elem) unless new_elem.nil?
+  end
+  
+  def characters(text)
+    @stack[-1].add_text(text)
+  end
+
+  def end_document
+    @output = ""
+    @stack[-1].write(@output)
+    decoder = HTMLEntities.new
+    # One pass of entity decoding for HTML output...
+    @output = decoder.decode(@output)
+    if @to_text
+      # Clean up some tags, extra empty lines, prettyfied characters, etc.
+      @output.gsub!(/<\/?span[^>]*>/, '')
+      @output.gsub!(/\t*<div[^>]*>/, '')
+      @output.gsub!(/<\/div>/, "\n")
+      @output.gsub!(/^\s+$/, '')
+      @output.gsub!(/\n+/, "\n")
+      @output.gsub!(/<br[^>]*\/>/, "\n")
+      @output.gsub!(/“/, '"')
+      @output.gsub!(/”/, '"')
+      @output.gsub!(/‘/, "'")
+      @output.gsub!(/’/, "'")
+      @output.gsub!(/\u{a0}/, " ")  # Unicode non-breaking space
+      # ...two passes of decoding for text output.
+      @output = decoder.decode(@output)
+    end
+  end
+
+  def output
+    @output
+  end
+  def files
+    @files
+  end
+end
+
+class ENML_utils
+  def initialize(text, resources = nil, static_dirs = {}, note_guid = "")
+    @text = text or ""
+    @resources = resources or []
+    @static_dirs = static_dirs
+    @note_guid = note_guid
+    @parsed = false
+  end
+
+  def to_html(to_text=false)
+    parser = Parsers::SAX2Parser.new( @text )
+    debug "to_html input text:"
+    debug "-----"
+    debug @text
+    debug "-----"
+    listener = ENML_Listener.new(@resources, to_text, @static_dirs, @note_guid)
+    parser.listen(listener)
+    parser.parse
+    @files = listener.files
+    @parsed = true
+    debug "to_html output:"
+    debug listener.output
+    debug "-----"
+    return listener.output
+  end
+
+  def to_text
+    return to_html(true)
+  end
+  
+  def resource_files
+    to_html unless @parsed
+    return @files
+  end
+end