gitnoted 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 514bf87ae44f1a65208940e4a8db87e5a049b27d
+  data.tar.gz: 944db11d0806f73287350138421c35d8b956b38f
+SHA512:
+  metadata.gz: 0ae0007cff3bb75b96d16831d7e779ab2798a80db0dfade08fe3dcb88c9b7b6f470dcb39cb41832c9dc207f14d5a458a6e4a3e98123552ac0b9ce63ee3f2b320
+  data.tar.gz: 32581b4a57bcf3970965cd85f448bbd2955d3cf2b530332b2be49b7edb89a9bbff6234efc5f18abad3385ae152fbe3d5fa8c4647d1d164354ee49b4f764a64ca

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    gitnoted (0.1.0)
+      concurrent-ruby (>= 1.0.5)
+      puma (~> 3.7)
+      rack-cors (~> 0.4)
+      redcarpet (~> 3.4)
+      rugged (~> 0.25)
+      sigdump (>= 0.2.4)
+      sinatra (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.0.5)
+    puma (3.8.1)
+    rack (1.6.5)
+    rack-cors (0.4.1)
+    rack-protection (1.5.3)
+      rack
+    rake (12.0.0)
+    redcarpet (3.4.0)
+    rugged (0.25.1.1)
+    sigdump (0.2.4)
+    sinatra (1.4.8)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    tilt (2.0.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gitnoted!
+  rake (>= 0.9.2)
+
+BUNDLED WITH
+   1.14.6

data/README.md

@@ -0,0 +1,162 @@
+# GitNoted
+
+GitNoted is a simple document server that works with [Github Wiki](https://help.github.com/articles/about-github-wikis/) or [Gollum](https://github.com/gollum/gollum) to serve foot notes for external web sites just by adding a small script tag.
+
+* [JavaScript tag](#javascript-tag)
+* [Writing notes](#writing-notes)
+* [Running server with Github Wiki](#running-server-with-github-wiki)
+* [Running server with other git repositories](#running-server-with-other-git-repositories)
+* [Deploying to Heroku](#deploying-to-heroku)
+* [Server usage](#server-usage)
+
+## JavaScript tag
+
+You can find the JavaScript code on [lib/git_noted/public/js/gitnoted.js](lib/git_noted/public/js/gitnoted.js). This file will be served as `/js/gitnoted.js` from the GitNoted server. You can import it using `<script>` tag as following.
+
+```
+<!-- GitNoted depends on jQuery -->
+<script src="https://code.jquery.com/jquery-3.1.1.min.js"
+    integrity="sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8="
+    crossorigin="anonymous"></script>
+
+<!-- GitNoted -->
+<link rel="stylesheet" type="text/css" href="http://localhost:4567/css/gitnoted.css" />
+<script type="text/javascript" src="http://localhost:4567/js/gitnoted.js"></script>
+```
+
+Please replace `http://localhost:4567` to point your GitNoted server (see bellow).
+
+Once the JavaScript tag is set up, you can add following `<div class="gitnoted" data-labels="label,label,...">` tags your HTML to embed notes. Here is an example:
+
+```
+<div class="gitnoted" data-labels="purpose:test,message:hello"></div>
+```
+
+`data-labels` is used to search notes by labels. Notes that include all of them match.
+
+
+## Writing notes
+
+Edit mode must be Markdown. Other formats are not supported.
+
+In the body of a page, you need to include `:label: label,label,label,...` line at the beginning or at the end. Example:
+
+```
+# My first wiki page
+
+Hello!
+
+---
+
+:label: purpose:test,message:hello
+```
+
+## Running server with Github Wiki
+
+Prepare following information first:
+
+* Domain names (and ports) of your website that embeds notes. You can have multiple web sites. Here uses `example.com` and `localhost:8080` as an example.
+* Repository URL of a Github Wiki. Format of the URL is `https://github.com/<user>/<repo>.wiki.git` where "&lt;user&gt; and &lt;repo&gt; are your repository's username and repository name.
+
+This command starts a server on http://localhost:4567:
+
+```
+$ gem install gitnoted
+$ gitnoted "https://github.com/frsyuki/gitnoted.wiki.git" \
+           ./repo \
+           -a example.com -a localhost:8080 \
+           -h localhost -p 4567
+```
+
+If your repository is private, you also need to set `GITHUB_ACCESS_TOKEN` environment variable. You can create a token on [your account configuration page](https://github.com/settings/tokens). Example:
+
+```
+$ gem install gitnoted
+$ export GITHUB_ACCESS_TOKEN=abcdef0123456789abcdef0123456789abcdef01
+$ gitnoted \
+           "https://github.com/frsyuki/my_secret_repository.wiki.git" \
+           ./repo \
+           -a example.com -a localhost:8080 \
+           -h localhost -p 4567
+```
+
+## Running server with other git repositories
+
+Instead of using Github Wiki, you can use any git repositories that contain files named `<name>.md`. You can use your text editor or tools such as [Gollum](https://github.com/gollum/gollum) to push `.md` files.
+
+To start GitNoted for those git repositories, prepare following information:
+
+* Domain names (and ports) of your website that embeds notes. You can have multiple web sites. Here uses `example.com` and `localhost:8080` as an example.
+* Repository URL of the git repository. It should provide http access (ssh is not supported at this moment).
+* Username and password of the git repository. You need to set them to GIT_USERNAME and GIT_PASSWORD environment variables.
+
+This command starts a server on http://localhost:4567:
+
+```
+$ gem install gitnoted
+$ export GIT_USERNAME=myname
+$ export GIT_PASSWORD=topsecret
+$ gitnoted \
+           "https://github.com/frsyuki/my_secret_repository.wiki.git" \
+           ./repo \
+           -a example.com -a localhost:8080 \
+           -h localhost -p 4567
+```
+
+## Deploying to Heroku
+
+You need to create 4 files in a new git repository.
+
+### Procfile
+
+Put a gitnoted command in your `Procfile` with `$PORT` variable as the port number. Here is an example:
+
+```
+web: bundle exec gitnoted "https://github.com/frsyuki/gitnoted.wiki.git ./repo -a example.com -h 0.0.0.0 -p $PORT
+```
+
+### Gemfile
+
+```
+source "https://rubygems.org"
+ruby "2.4.0"
+gem "gitnoted"
+```
+
+### .buildpacks
+
+```
+https://github.com/ddollar/heroku-buildpack-apts
+https://github.com/heroku/heroku-buildpack-ruby
+```
+
+### Aptfile
+
+```
+cmake
+pkg-config
+```
+
+## Server usage
+
+```
+$ gitnoted [options] <git url> <local path to store>
+  options:
+    -a, --allow-origin DOMAIN[:PORT] Allow cross-origin resource sharing (CORS) from this domain (can be set multiple times)
+    -h, --host ADDRESS               Bind address (default: 'localhost')
+    -p, --port PORT                  Port (default: 4567)
+    -e, --extra-app PATH.rb          Add an extra Sinatra application
+    -i, --interval SECONDS           Interval to update the git repository
+        --threads MIN:MAX            Number of HTTP worker threads
+  environment variables:
+    GIT_USERNAME                 Git username
+    GIT_PASSWORD                 Git password
+    GITHUB_ACCESS_TOKEN          Github personal API token
+```
+
+----
+
+    GitNoted
+    Author: Sadayuki Furuhashi
+    License: MIT
+

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+task :default => [:build]

data/bin/gitnoted

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'logger'
+
+extra_app_paths = []
+
+scheduler_options = {
+  interval: 60
+}
+
+app_options = {
+  allow_origins: [],
+}
+
+repo_options = {
+  logger: Logger.new(STDOUT),
+}
+
+server_options = {
+  server: 'puma',
+  Host: 'localhost',
+  Port: 4567,
+  Threads: nil,
+}
+
+op = OptionParser.new
+op.banner = "#{$0} [options] <git url> <local path to store>"
+
+op.separator "  options:"
+
+op.on('-a', '--allow-origin DOMAIN[:PORT]', "Allow cross-origin resource sharing (CORS) from this domain (can be set multiple times)") do |v|
+  app_options[:allow_origins] << v
+end
+
+op.on('-h', '--host ADDRESS', "Bind address (default: 'localhost')") do |v|
+  server_options[:Host] = v
+end
+
+op.on('-p', '--port PORT', Integer, "Port (default: 4567)") do |v|
+  server_options[:Port] = v
+end
+
+op.on('-e', '--extra-app PATH.rb', "Add an extra Sinatra application") do |v|
+  extra_app_paths << v
+end
+
+op.on('-i', '--interval SECONDS', Integer, "Interval to update the git repository") do |v|
+  scheduler_options[:interval] = v
+end
+
+op.on('--threads MIN:MAX', "Number of HTTP worker threads") do |v|
+  server_options[:Threads] = v
+end
+
+op.separator <<EOF
+  environment variables:
+    GIT_USERNAME                 Git username
+    GIT_PASSWORD                 Git password
+    GITHUB_ACCESS_TOKEN          Github personal API token
+EOF
+
+
+op.parse!(ARGV)
+
+if ARGV.length != 2
+  puts op.to_s
+  exit 1
+end
+
+remote_url, local_path = *ARGV
+
+require 'git_noted'
+require 'sigdump/setup'
+
+ENV['RACK_ENV'] ||= 'production'
+
+if ENV['GIT_USERNAME']
+  repo_options[:username] = ENV['GIT_USERNAME']
+  repo_options[:password] = ENV['GIT_PASSWORD']
+elsif ENV['GITHUB_ACCESS_TOKEN']
+  repo_options[:username] = ENV['GITHUB_ACCESS_TOKEN']
+  repo_options[:password] = 'x-oauth-basic'
+end
+
+repository = GitNoted::Repository.new(remote_url, local_path, **repo_options)
+app = GitNoted::Application.with(repository: repository, **app_options)
+repository.schedule_update! scheduler_options[:interval]
+
+extra_app_paths.each do |path|
+  app.instance_eval(File.read(path), path)
+end
+
+app.run!(server_options)
+

data/gitnoted.gemspec

@@ -0,0 +1,25 @@
+
+Gem::Specification.new do |gem|
+  gem.name        = "gitnoted"
+  gem.description = "Simple document server that works with Github Wiki or Gollum to serve foot notes for external websites just by adding a small script tag"
+  gem.homepage    = "https://github.com/frsyuki/gitnoted"
+  gem.summary     = gem.description
+  gem.version     = "0.1.0"
+  gem.authors     = ["Sadayuki Furuhashi"]
+  gem.email       = ["frsyuki@gmail.com"]
+  gem.license     = "MIT"
+  gem.has_rdoc    = false
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'sinatra', '~> 1.4'
+  gem.add_dependency 'puma', '~> 3.7'
+  gem.add_dependency 'rack-cors', '~> 0.4'
+  gem.add_dependency 'redcarpet', '~> 3.4'
+  gem.add_dependency 'rugged', '~>  0.25'
+  gem.add_dependency 'concurrent-ruby', '>= 1.0.5'
+  gem.add_dependency 'sigdump', '>= 0.2.4'
+  gem.add_development_dependency "rake", ">= 0.9.2"
+end

data/lib/git_noted.rb

@@ -0,0 +1,2 @@
+require 'git_noted/application'
+require 'git_noted/repository'

data/lib/git_noted/application.rb

@@ -0,0 +1,163 @@
+require 'sinatra/base'
+require 'rack/cors'
+require 'rack/static'
+require 'redcarpet'
+require 'erb'
+require 'json'
+require 'git_noted/repository'
+
+module GitNoted
+  class Application < Sinatra::Base
+    def self.default_renderer
+      renderer = Redcarpet::Render::HTML.new({
+        escape_html: true,
+        safe_links_only: true,
+      })
+      redcarpet = Redcarpet::Markdown.new(renderer, {
+        tables: true,
+        no_intra_emphasis: true
+      })
+      redcarpet.method(:render)
+    end
+
+    def self.with(allow_origins: [], **options)
+      Class.new(self) do
+        alias_method :initialize_saved, :initialize
+        define_method(:initialize) do
+          initialize_saved(**options)
+        end
+
+        use Rack::Cors do
+          allow do
+            origins *allow_origins unless allow_origins.empty?
+
+            resource '/api/*', {
+                methods: [:get, :options, :head],
+                headers: :any,
+                expose:  [],
+                credentials: true,
+                max_age: 600,
+            }
+          end
+
+          allow do
+            origins '*'
+            resource '/public/*', :headers => :any, :methods => :get
+          end
+        end
+      end
+    end
+
+    def initialize(repository:, renderer: Application.default_renderer)
+      super()
+      @repository = repository
+      @renderer = renderer
+    end
+
+    attr_accessor :repository
+    attr_accessor :renderer
+
+    use Rack::Static, urls: ["/js", "/css"], root: File.expand_path("../public", __FILE__)
+
+    include ERB::Util
+
+    TRANSPARENT_1PX_PNG = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=".unpack('m').first
+
+    get '/' do
+      redirect "/index.html"
+    end
+
+    # GET /api/notes
+    #     ?labels=k1:v1,k2:v2,...
+    #     ?exclude_labels=k1:v1,k2:v2,...
+    get '/api/notes' do
+      notes = load_notes(params).map do |note|
+        {
+          labels: note.labels,
+          body: read_note(note)
+        }
+      end
+
+      response = {
+        notes: notes
+      }
+
+      content_type "application/json"
+      return response.to_json
+    end
+
+    # GET /api/notes.html
+    #     ?labels=k1:v1,k2:v2,...
+    #     ?exclude_labels=k1:v1,k2:v2,...
+    get '/api/notes.html' do
+      notes = load_notes(params)
+
+      html = %[<ul class="gitnoted">]
+      notes.each do |note|
+        body = render_note(note)
+        html << %[<li class="gitnoted-note">]
+          html << %[<div class="gitnoted-body">#{body}</div>]
+          html << %[<ul class="gitnoted-labels">]
+            note.labels.each do |label|
+              html << %[<li class="gitnoted-label">#{html_escape(label)}</li>]
+            end
+          html << %[</ul>]
+        html << %[</li>]
+      end
+      html << %[</ul>]
+
+      content_type "text/html"
+      return html
+    end
+
+    # GET /api/labels
+    #     ?prefix=k1:
+    #     ?used_with=k1:v1
+    get '/api/labels' do
+      labels = load_labels(params)
+
+      response = {
+        labels: labels
+      }
+
+      content_type "application/json"
+      return response.to_json
+    end
+
+    # force update
+    get '/api/github_hook' do
+      @repository.update!
+
+      response = { }
+
+      content_type "application/json"
+      return response.to_json
+    end
+
+    get '/favicon.ico' do
+      content_type "image/png"
+      return TRANSPARENT_1PX_PNG
+    end
+
+    def read_note(note)
+      @repository.read(note)
+    end
+
+    def render_note(note)
+      @renderer.call(read_note(note))
+    end
+
+    def load_notes(params)
+      label_names = (params[:labels] || '').split(",")
+      exclude_label_names = (params[:exclude_labels] || '').split(",")
+      @repository.search_notes(labels: label_names, exclude_labels: exclude_label_names)
+    end
+
+    def load_labels(params)
+      used_with_label_names = (params[:used_with] || '').split(',')
+      prefix = params[:prefix]
+      prefix = nil if prefix == ''
+      @repository.search_labels(prefix: prefix, used_with: used_with_label_names)
+    end
+  end
+end

data/lib/git_noted/public/css/gitnoted.css

@@ -0,0 +1,60 @@
+ul.gitnoted {
+  list-style-type: none;
+  list-style-position: outside;
+  margin: 0;
+  padding: 0;
+}
+
+ul.gitnoted > li.gitnoted-note {
+  display: block;
+  margin: 2em 0;
+  padding: 0.8em 1em 0.5em 1em;
+  border: 1px solid #ddd;
+  background-color: #fff;
+}
+
+ul.gitnoted > li.gitnoted-note > div.gitnoted-body
+h1 {
+  font-size: 120%;
+}
+
+ul.gitnoted > li.gitnoted-note > div.gitnoted-body
+h2 {
+  font-size: 120%;
+}
+
+ul.gitnoted > li.gitnoted-note > div.gitnoted-body
+h3 {
+  font-size: 100%;
+}
+
+ul.gitnoted > li.gitnoted-note > div.gitnoted-body
+h4 {
+  font-size: 100%;
+}
+
+ul.gitnoted > li.gitnoted-note > ul.gitnoted-labels {
+  list-style-type: none;
+  list-style-position: outside;
+  text-align: right;
+  font-size: 70%;
+}
+
+ul.gitnoted > li.gitnoted-note > ul.gitnoted-labels > li.gitnoted-label {
+  display: inline-block;
+  margin-left: 1.3em;
+  margin-right: -1em;
+  padding: 0 0.5em;
+  color: #fff;
+  background-color: #bbb;
+  border-radius: 0.8em;
+}
+
+ul.gitnoted > li.gitnoted-note > ul.gitnoted-labels .gitnoted-label-button:hover {
+  background-color: #888;
+}
+
+ul.gitnoted > li.gitnoted-note code {
+  white-space: pre;
+}
+

data/lib/git_noted/public/index.html

@@ -0,0 +1,54 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <title>GitNotes setup completed</title>
+</head>
+<body>
+  <h1>GitNotes setup completed</h1>
+  <section id="api_notes_html">
+    <form action="/api/notes.html":>
+      <h2>GET /api/notes.html</h2>
+      <p>Search and render notes.</p>
+      <div>
+        <label for="labels">Labels (separated by comma ","):</label><br />
+        <input type="text" name="labels" id="labels" />
+      </div>
+      <div>
+        <label for="exclude_labels">Exclude labels (separated by comma ","):</label><br />
+        <input type="text" name="exclude_labels" id="exclude_labels" />
+      </div>
+      <input type="submit" value="Go">
+    </form>
+  </section>
+  <section id="api_notes">
+    <form action="/api/notes":>
+      <h2>GET /api/notes</h2>
+      <p>Search notes.</p>
+      <div>
+        <label for="labels">Labels (separated by comma ","):</label><br />
+        <input type="text" name="labels" id="labels" />
+      </div>
+      <div>
+        <label for="exclude_labels">Exclude labels (separated by comma ","):</label><br />
+        <input type="text" name="exclude_labels" id="exclude_labels" />
+      </div>
+      <input type="submit" value="Go">
+    </form>
+  </section>
+  <section id="api_labels">
+    <form action="/api/labels":>
+      <h2>GET /api/labels</h2>
+      <p>Search labels.</p>
+      <div>
+        <label for="prefix">Label name prefix:</label><br />
+        <input type="text" name="prefix" id="prefix" />
+      </div>
+      <div>
+        <label for="used_with">Used with labels (separated by comma ","):</label><br />
+        <input type="text" name="used_with" id="used_with" />
+      </div>
+      <input type="submit" value="Go">
+    </form>
+  </section>
+</body>
+</html>

data/lib/git_noted/public/js/gitnoted.js

@@ -0,0 +1,46 @@
+var gitNotesUrl = new URL(document.currentScript.src)
+gitNotesUrl.pathname = "/api/notes.html"
+
+$(document).ready(function() {
+  function injectExpandScript(e, parentLabels) {
+    e.querySelectorAll('.gitnoted-label').forEach(function (e) {
+      var url = new URL(gitNotesUrl)
+      url.searchParams.set('labels', e.innerText)
+      url.searchParams.set('exclude_labels', parentLabels)
+      var nextParentLabels = `${parentLabels},${e.innerText}`
+      e.classList.add('gitnoted-label-button')
+      e.onclick = function() {
+        console.log(`exclude_labels: ${nextParentLabels}`)
+        fetch(url, {mode: 'cors'}).then(function (r) {
+          return r.text()
+        }).then(function (t) {
+          var template = document.createElement('template')
+          template.innerHTML = t
+          var note = template.content.firstChild
+          injectExpandScript(note, nextParentLabels)
+          e.parentNode.parentNode.appendChild(note, e)
+          e.classList.remove('gitnoted-label-button')
+          e.onclick = null
+        })
+      }
+    })
+  }
+
+  document.querySelectorAll('div.gitnoted').forEach(function (e) {
+    var url = new URL(gitNotesUrl)
+    if (e.dataset.labels) {
+      url.searchParams.set('labels', e.dataset.labels)
+    }
+    fetch(url, {mode: 'cors'}).then(function (r) {
+      return r.text()
+    }).then(function (t) {
+      var template = document.createElement('template')
+      template.innerHTML = t
+      var note = template.content.firstChild
+      if (e.dataset.labels) {
+        injectExpandScript(note, e.dataset.labels)
+      }
+      e.parentNode.replaceChild(note, e)
+    })
+  })
+})

data/lib/git_noted/repository.rb

@@ -0,0 +1,148 @@
+require 'rugged'
+require 'concurrent'
+require 'pathname'
+
+module GitNoted
+  class Repository
+    class Note
+      def initialize(name, path, labels)
+        @name = name
+        @path = path
+        @labels = labels
+      end
+
+      attr_reader :name, :path, :labels
+    end
+
+    def initialize(remote_url, local_path, username: nil, password: nil, logger: Logger.new(STDERR))
+      @local_path = Pathname.new(local_path).cleanpath
+      @remote_url = remote_url
+      if username
+        @credentials = Rugged::Credentials::UserPassword.new(username: username, password: password)
+      else
+        @credentials = nil
+      end
+      @logger = logger
+
+      # initial update
+      update! || index!
+    end
+
+    def update!
+      begin
+        @repo ||= Rugged::Repository.init_at(@local_path.to_s)
+        updated = fetch(@repo)
+        return false unless updated
+      rescue => e
+        # fall back to clone.
+        @logger.warn "Failed to update repository incrementally. Falling back to clone: #{e}"
+      end
+      @repo = clone
+      index!
+      return true
+    end
+
+    def read(note)
+      File.read(note.path).sub(/^:label:(.*)$\n/, '')
+    end
+
+    def schedule_update!(interval)
+      Concurrent::ScheduledTask.execute(interval) do
+        begin
+          update!
+        rescue => e
+          @logger.error "Failed to update repository: #{e}"
+          e.backtrace.each do |bt|
+            @logger.error "  #{bt}"
+          end
+        ensure
+          schedule_update!(interval)
+        end
+      end
+    end
+
+    def search_notes(labels: nil, exclude_labels: nil)
+      labels ||= []
+      exclude_labels ||= []
+
+      @notes.select do |note|
+        labels.all? {|t| note.labels.include?(t) } &&
+          !exclude_labels.any? {|t| note.labels.include?(t) }
+      end
+    end
+
+    def search_labels(prefix: nil, used_with: nil)
+      match = {}
+      @notes.each do |note|
+        if used_with.nil? || used_with.all? {|t| note.labels.include?(t) }
+          if prefix.nil?
+            matching = note.labels
+          else
+            matching = note.labels.select {|label| label.start_with?(prefix) }
+          end
+          matching.each {|label| match[label] = true }
+        end
+      end
+      match.keys.sort
+    end
+
+    private
+
+    def clone
+      logger_timer "Cloning remote repository." do
+        tmp_path = "#{@local_path}.tmp"
+        FileUtils.rm_rf tmp_path
+        Rugged::Repository.clone_at(@remote_url, tmp_path, credentials: @credentials)
+        FileUtils.rm_rf @local_path
+        FileUtils.mv tmp_path, @local_path
+        Rugged::Repository.init_at(@local_path.to_s)
+      end
+    end
+
+    def fetch(repo)
+      logger_timer "Fetching remote repository." do
+        remote = repo.remotes["origin"]
+        unless remote
+          raise "Remote repository is not fetched yet."
+        end
+        fetched = remote.fetch
+        return fetched[:total_objects] > 0
+      end
+    end
+
+    def index!
+      logger_timer "Updating label index." do
+        files = Dir["#{@local_path}/**/*.md"]
+        @notes = files.map do |path|
+          name = Pathname.new(path).relative_path_from(Pathname.new(@local_path)).sub(/\.md$/, '')
+          parse_note(name, path, File.read(path))
+        end
+      end
+    end
+
+    LABEL_KEY_CHARSET = /[a-zA-Z0-9_\-\.\/]/
+    LABEL_VALUE_CHARSET = /[a-zA-Z0-9_\-\.\/]/
+
+    def parse_note(name, path, text)
+      m = /^:label:(.*)$/.match(text)
+      if m
+        labels = m[1].scan(/[a-zA-Z0-9_\-\.\/]+:[a-zA-Z0-9_\-\.\/]+/)
+      else
+        labels = []
+      end
+
+      Note.new(name, path, labels)
+    end
+
+    def logger_timer(start_message, end_message = "%.2f seconds.")
+      @logger.info start_message
+      start_time = Time.now
+      begin
+        return yield
+      ensure
+        finish_time = Time.now
+        @logger.info end_message % (finish_time - start_time)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: gitnoted
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sadayuki Furuhashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rack-cors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: sigdump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Simple document server that works with Github Wiki or Gollum to serve
+  foot notes for external websites just by adding a small script tag
+email:
+- frsyuki@gmail.com
+executables:
+- gitnoted
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/gitnoted
+- gitnoted.gemspec
+- lib/git_noted.rb
+- lib/git_noted/application.rb
+- lib/git_noted/public/css/gitnoted.css
+- lib/git_noted/public/index.html
+- lib/git_noted/public/js/gitnoted.js
+- lib/git_noted/repository.rb
+homepage: https://github.com/frsyuki/gitnoted
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Simple document server that works with Github Wiki or Gollum to serve foot
+  notes for external websites just by adding a small script tag
+test_files: []