synclenote 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6318984ebbcbba1c14f54fac700a2ac544cb1f2f1ab4fca0acb3246e26fa1a6
+  data.tar.gz: 74008eba2e3644861cc2bea68aa99ec40ddeed7c8747fec898bcf3d878757db6
+SHA512:
+  metadata.gz: 138083fdf90abc8648ffc29e2c999a99978c2bc116992a7fa6f360e586d8e9ebc32ac975190d2d67591de0d49a5b85b8c971bef72777a7fc2e12f833fdc4446a
+  data.tar.gz: 6c2af8a37616982b59f8f5c8951a94c679ab6fb5c947aa61e7385e2958c6e0736bd4a799954acdde787282a6a5c2f695438394eabc1c9b09a1969dac9c456683

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.1
+  - 2.0.0
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install -qq libicu-dev
+  - gem update --remote bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in synclenote.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    synclenote (0.0.0)
+      evernote_oauth
+      redcarpet
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    evernote-thrift (1.25.2)
+    evernote_oauth (0.2.3)
+      evernote-thrift
+      oauth (>= 0.4.1)
+    oauth (0.5.6)
+    rake (13.0.6)
+    redcarpet (3.5.1)
+    thor (1.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  rake
+  synclenote!
+
+BUNDLED WITH
+   2.2.23

data/Guardfile

@@ -0,0 +1,4 @@
+guard :bundler do
+  watch("Gemfile")
+  watch(/\A.+\.gemspec\z/)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yuya.Nishida.
+
+X11 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,40 @@
+# Synclenote
+
+A synchronization tool for GFM (GitHub Flavored Markdown) files and Evernote.
+
+[![License X11](https://img.shields.io/badge/license-X11-brightgreen.svg)](https://raw.githubusercontent.com/nishidayuya/synclenote/master/LICENSE.txt)
+[![Build Status](https://travis-ci.org/nishidayuya/synclenote.svg?branch=master)](https://travis-ci.org/nishidayuya/synclenote)
+
+## Requirements
+
+- Ruby
+
+## Installation
+
+```console
+$ gem install synclenote
+```
+
+## Usage
+
+Create configuration directory:
+
+```console
+$ synclenote init
+```
+
+Open "~/.synclenote/config" by your favorite text editor and edit "TODO:" section.
+
+Sync your GFM files and Evernote:
+
+```console
+$ synclenote sync
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/nishidayuya/synclenote/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,3 @@
+require "bundler/gem_tasks"
+
+task default: %i(build)

data/bin/synclenote

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+
+require "synclenote/command"
+
+Synclenote::Command.start

data/lib/synclenote/command.rb

@@ -0,0 +1,276 @@
+require "synclenote"
+
+require "yaml"
+require "pathname"
+require "logger"
+require "tempfile"
+
+require "thor"
+require "evernote_oauth"
+require "redcarpet"
+
+class Synclenote::Command < Thor
+  attr_accessor :logger
+
+  def initialize(*args, &block)
+    super
+    self.logger = Logger.new(STDOUT)
+  end
+
+  desc "init", "Create profile directory"
+  def init
+    if profile_path.exist?
+      $stderr.puts(<<EOS)
+Profile directory "#{profile_path}" is already exist.
+
+Please check it and rename/remove it.
+EOS
+      exit(1)
+    end
+    profile_path.mkpath
+    config_path.open("w") do |f|
+      f.write(<<EOS)
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Synclenote.configure(1) do |config|
+  # TODO: Replace your notes directory.
+  config.local.directory = "~/notes"
+  config.local.pattern = "**/*.{md,txt}"
+  # You can use either whitelist_tags or blacklist_tags.
+  # config.local.whitelist_tags = %w(smartphone tablet)
+  # config.local.blacklist_tags = %w(noremote supersecret)
+
+  config.remote.type = :evernote
+  # You must fill your developer token.
+  # See https://www.evernote.com/api/DeveloperToken.action
+  config.remote.developer_token = "TODO: Write your developer token."
+end
+EOS
+    end
+    sync_statuses_path.mkpath
+    last_sync_path.open("w") do |f|
+      f.puts(YAML_HEADER)
+      f.puts({last_sync_datetime: Time.at(0)}.to_yaml)
+    end
+    puts(<<EOS)
+Creating new profile directory is succeeded.
+
+Please check TODO in configuration file.
+$ vi #{config_path}
+EOS
+  end
+
+  desc "sync", "Sync all notes at once"
+  def sync
+    logger.debug("loading configuration file: %s" % config_path)
+    load(config_path)
+    c = Synclenote::Configuration.data
+    token = c.remote.developer_token
+    logger.debug("loaded configuration file: %s" % config_path)
+
+    logger.debug("invoking client.")
+    client = EvernoteOAuth::Client.new(token: token,
+                                       sandbox: !!c.remote.sandbox)
+    logger.debug("invoked client.")
+
+    logger.debug("invoking user_store.")
+    user_store = client.user_store
+    logger.debug("invoked user_store.")
+    if !user_store.version_valid?
+      raise "Invalid Evernote API version. Please update evernote_oauth.gem and synclenote.gem."
+    end
+    logger.debug("done EvernoteOAuth version check.")
+    logger.debug("loading note_store.")
+    note_store = client.note_store
+    logger.debug("loaded note_store.")
+
+    local_top_path = Pathname(c.local.directory).expand_path
+    last_sync_status = YAML.load_file(last_sync_path)
+    last_sync_datetime = last_sync_status[:last_sync_datetime]
+    if Time.now - last_sync_datetime <= min_sync_interval
+      allowed_sync_time = last_sync_datetime + min_sync_interval
+      raise "too less interval sync after #{allowed_sync_time}."
+    end
+
+    processed = []
+    Pathname.glob(local_top_path + c.local.pattern) do |note_path|
+      relative_note_path = note_path.relative_path_from(local_top_path)
+      note_sync_status_path = sync_statuses_path + relative_note_path
+      processed << note_sync_status_path
+
+      # create note
+      if !note_sync_status_path.exist?
+        create_remote_note(token, note_store, note_path, note_sync_status_path)
+        next
+      end
+
+      # update note
+      note_sync_status = YAML.load_file(note_sync_status_path)
+      if note_sync_status[:last_sync_datetime] < note_path.mtime
+        update_remote_note(token, note_store, note_path, note_sync_status_path,
+                           note_sync_status[:guid])
+        next
+      end
+
+      logger.debug("nothing: %s" % note_path)
+    rescue Evernote::EDAM::Error::EDAMUserException => e
+      logger.error(e.inspect)
+      raise
+    end
+
+    # remove note
+    removed = Pathname.glob(sync_statuses_path + c.local.pattern) - processed
+    removed.each do |note_sync_status_path|
+      remove_remote_note(token, note_store, note_sync_status_path)
+    end
+  end
+
+  private
+
+  YAML_HEADER = <<EOS.freeze
+# -*- mode: yaml -*-
+# vi: set ft=yaml :
+
+EOS
+
+  HEADER = <<EOS.freeze
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE en-note SYSTEM "http://xml.evernote.com/pub/enml2.dtd">
+<en-note>
+EOS
+
+  FOOTER = <<EOS.freeze
+</en-note>
+EOS
+
+  def profile_path
+    return @profile_path ||= Pathname("~/.synclenote").expand_path
+  end
+
+  def config_path
+    return @config_path ||= profile_path + "config"
+  end
+
+  def sync_statuses_path
+    return @sync_statuses_path ||= profile_path + "sync_statuses"
+  end
+
+  def last_sync_path
+    return @last_sync_path ||= profile_path + "last_sync"
+  end
+
+  def min_sync_interval
+    # return 15 * 60 # 15 min for production
+    return 4 # 4 sec for sandbox
+  end
+
+  def build_html(markdown_text)
+    @formatter ||= Redcarpet::Markdown.new(
+      Redcarpet::Render::HTML.new(
+        filter_html: true,
+        hard_wrap: true,
+      ),
+      underline: true,
+      lax_spacing: true,
+      footnotes: true,
+      no_intra_emphasis: true,
+      superscript: true,
+      strikethrough: true,
+      tables: true,
+      space_after_headers: true,
+      fenced_code_blocks: true,
+      # autolink: true,
+    )
+    html = @formatter.render(markdown_text)
+    return html
+  end
+
+  def create_note(note_path, options = {})
+    title = nil
+    tags = ["syncle"]
+    body = nil
+    note_path.open do |f|
+      title = f.gets.chomp.sub(/\A#\s*/, "")
+      if md = /\A(?<tags>(?:\[.*?\])+)(?:\s|\z)/.match(title)
+        tags += md[:tags].scan(/\[(.*?)\]/).flatten
+        title = md.post_match
+      end
+      body = f.read
+    end
+    html = build_html(body)
+    content = HEADER +
+      html.gsub(/ class=\".*?\"/, "").gsub(/<(br|hr|img).*?>/, "\\&</\\1>") +
+      FOOTER
+    o = options.merge(title: title, content: content, tagNames: tags)
+    return Evernote::EDAM::Type::Note.new(o)
+  end
+
+  def target_note?(note)
+    c = Synclenote::Configuration.data
+    if c.local.whitelist_tags
+      return note.tagNames.any? { |name|
+        c.local.whitelist_tags.include?(name)
+      }
+    elsif c.local.blacklist_tags
+      return !note.tagNames.any? { |name|
+        c.local.blacklist_tags.include?(name)
+      }
+    end
+    return true
+  end
+
+  def create_note_sync_status_file(path, note, sync_datetime)
+    Tempfile.open("synclenote") do |tmp_file|
+      tmp_file.puts(YAML_HEADER)
+      tmp_file.puts({
+                      last_sync_datetime: sync_datetime,
+                      guid: note.guid,
+                    }.to_yaml)
+      tmp_file.close
+      path.parent.mkpath
+      FileUtils.mv(tmp_file.path, path)
+    end
+  end
+
+  def create_remote_note(token, note_store, note_path, note_sync_status_path)
+    c = Synclenote::Configuration.data
+    new_note = create_note(note_path)
+    if !target_note?(new_note)
+      logger.info("skip creating: %s" % note_path)
+      return
+    end
+    logger.debug("doing createNote: %s" % note_path)
+    created_note = note_store.createNote(token, new_note)
+    logger.debug("done createNote.")
+    create_note_sync_status_file(note_sync_status_path, created_note,
+                                 Time.now)
+    logger.debug("created: %s" % note_sync_status_path)
+  end
+
+  def update_remote_note(token, note_store, note_path, note_sync_status_path,
+                         guid)
+    new_note = create_note(note_path, guid: guid)
+    if !target_note?(new_note)
+      logger.info("skip updating: %s" % note_path)
+      remove_remote_note(token, note_store, note_sync_status_path)
+      return
+    end
+    logger.debug("doing updateNote: %s %s" % [note_path, guid])
+    updated_note = note_store.updateNote(token, new_note)
+    logger.debug("done updateNote.")
+    create_note_sync_status_file(note_sync_status_path, updated_note, Time.now)
+    logger.debug("created: %s" % note_sync_status_path)
+  end
+
+  def remove_remote_note(token, note_store, note_sync_status_path)
+    note_sync_status = YAML.load_file(note_sync_status_path)
+    guid = note_sync_status[:guid]
+    logger.debug("doing deleteNote: %s" % guid)
+    note_store.deleteNote(token, guid)
+    logger.debug("done deleteNote.")
+
+    note_sync_status_path.delete
+    logger.debug("removed: %s" % note_sync_status_path)
+  end
+end

data/lib/synclenote/configuration.rb

@@ -0,0 +1,21 @@
+require "synclenote"
+
+require "ostruct"
+
+module Synclenote::Configuration
+  # TODO: better code and multiple configuration support.
+  @data = OpenStruct.new(local: OpenStruct.new(directory: "~/.synclenote",
+                                               pattern: "**/*.{md,txt}",
+                                               whitelist_tags: nil,
+                                               blacklist_tags: nil),
+                         remote: OpenStruct.new(type: nil))
+
+  def self.run(version, &_block)
+    fail "unknown API version: version=<#{version.inspect}>" if version != 1
+    yield(@data)
+  end
+
+  def self.data
+    return @data
+  end
+end

data/lib/synclenote/version.rb

@@ -0,0 +1,3 @@
+module Synclenote
+  VERSION = "0.0.0"
+end

data/lib/synclenote.rb

@@ -0,0 +1,11 @@
+# This module is a namespace for this gem.
+module Synclenote
+  autoload :VERSION, "synclenote/varsion"
+
+  autoload :Command, "synclenote/command"
+  autoload :Configuration, "synclenote/configuration"
+
+  def self.configure(version, &block)
+    Configuration.run(version, &block)
+  end
+end

data/synclenote.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'synclenote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "synclenote"
+  spec.version       = Synclenote::VERSION
+  spec.authors       = ["Yuya.Nishida."]
+  spec.email         = ["yuya@j96.org"]
+  spec.summary       = File.readlines(File.join(__dir__, "README.md"))
+    .reject { |l| /\A\s*\z|\A\#/ === l }.first.chomp
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/nishidayuya/" + spec.name
+  spec.license       = "X11"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "evernote_oauth"
+  spec.add_runtime_dependency "redcarpet"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: synclenote
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Yuya.Nishida.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evernote_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A synchronization tool for GFM (GitHub Flavored Markdown) files and Evernote.
+email:
+- yuya@j96.org
+executables:
+- synclenote
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/synclenote
+- lib/synclenote.rb
+- lib/synclenote/command.rb
+- lib/synclenote/configuration.rb
+- lib/synclenote/version.rb
+- synclenote.gemspec
+homepage: https://github.com/nishidayuya/synclenote
+licenses:
+- X11
+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: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A synchronization tool for GFM (GitHub Flavored Markdown) files and Evernote.
+test_files: []