emacs_org_protocol_server 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cd216cbf9fc6631801e4c4d644c6dadf8cecb5f
+  data.tar.gz: 4c7a17b84adba7fa55daf9a9d041dd7cde73006c
+SHA512:
+  metadata.gz: 279bdd2eb65b784fbf312c19fb4ac87d42812cbc10dbbb44b47ba68455d902347ae57cc0c73eb38dba2c1190c926803f1763ac73043b672137c3aa23b5ae0c59
+  data.tar.gz: 210ca79de52caa60a636ad96482f0763636dd6be8c1e2fef3efbd80ebe4e8638e887bb2e40a2cba01a6e13d166587af7bef72c2d484f59c62b136a4b735a919f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,32 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect
+all people who contribute through reporting issues, posting feature
+requests, updating documentation, submitting pull requests or patches,
+and other activities.
+
+We are committed to making participation in this project a
+harassment-free experience for everyone, regardless of level of
+experience, gender, gender identity and expression, sexual
+orientation, disability, personal appearance, body size, race,
+ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of
+sexual language or imagery, derogatory comments or personal attacks,
+trolling, public or private harassment, insults, or other
+unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit,
+or reject comments, commits, code, wiki edits, issues, and other
+contributions that are not aligned to this Code of Conduct. Project
+maintainers who do not follow the Code of Conduct may be removed from
+the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior
+may be reported by opening an issue or contacting one or more of the
+project maintainers.
+
+This Code of Conduct is adapted from the
+[Contributor Covenant](http://contributor-covenant.org), version
+1.0.0, available at
+[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tamara Temple
+
+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,176 @@
+# Emacs Org-Protocol Server
+
+Emacs's `org-protocol` module in `org-mode` can be used to accept an
+`org-protocol://` scheme. However, configuring this on Mac OSX using
+Chrome seems problematic. There is a utility called
+[EmacsClient](https://github.com/neil-smithline-elisp/EmacsClient.app)
+that is listed in the
+[`org-protocol`](http://orgmode.org/worg/org-contrib/org-protocol.html#orgheadline6)
+documentation, however, it does not work on 10.11.2 (El Capitan) as of
+this writing (Sat Dec 26 04:42:59 2015). So I cam up with this
+alternative, which uses a [Sinatra](http://www.sinatrarb.com)
+mini-server running locally.
+
+## Installation
+
+Install the gem locally:
+
+    gem install emacs-org-protocol-server
+
+Start it up:
+
+    emacs-org-protocol-server
+
+This will run the server on port 4567, and call
+`/usr/local/bin/emacsclient` to operate.
+
+## Command line options
+
+The command line options are the same as for any standard Sinatra
+application:
+
+    emacs-org-protocol-server [-h] [-x] [-e ENVIRONMENT] [-p PORT] [-o HOST] [-s HANDLER]
+
+Options are:
+
+    -h # help
+    -p # set the port (default is 4567)
+    -o # set the host (default is 0.0.0.0)
+    -e # set the environment (default is development)
+    -s # specify rack server/handler (default is thin)
+    -x # turn on the mutex lock (default is off)
+
+In addition, you may set what the path to the `emacsclient`
+application is by setting the environment variable `EMACSCLIENT`. For
+example:
+
+
+    EMACSCLIENT=/usr/bin/emacsclient emacs-org-protocol-server -p 9294 -e production
+
+uses the `emacsclient` at `/usr/bin/emacsclient` running on port 9294
+in production.
+
+## Browser Configuration
+
+The entire point here is to get something from your browser over into
+emacs. Our good emacs teacher,
+[Sacha Chua](http://sachachua.com/)
+has an article on
+[Capturing links quickly with emacsclient, org-protocol, and Chrome Shortcut Manager on Microsoft Windows 8 - sacha chua  living an awesome life](http://sachachua.com/blog/2015/11/capturing-links-quickly-with-emacsclient-org-protocol-and-chrome-shortcut-manager-on-microsoft-windows-8/)
+that helped me a lot in setting up my Chrome browser on OSX 10.11. I
+still had to work out how it all worked, and build my own JavaScript
+scriptlets and bookmarklets.
+
+Essentially, you want to end up with a URL that calls the
+`emacs-org-protocol-server` that looks like so:
+
+    http://localhost:4567/?p=capture&l=http%3A%2F%2Fexample.com%2F&t=Example%20Domain&s=This%20domain%20is%20established%20to%20be%20used%20for%20illustrative%20examples%20in%20documents.%20You%20may%20use%20this%20domain%20in%20examples%20without%20prior%20coordination%20or%20asking%20for%20permission.
+
+assuming your browser is sitting at `http://example.com`.
+
+### ShortKeys
+
+I wrote the following to put into a
+[ShortKeys](https://chrome.google.com/webstore/detail/shortkeys-custom-keyboard/logpjaacgmcbpdkdchjiaagddngobkck?hl=en)
+definition:
+
+``` javascript
+function fixedEncodeURIComponent (str) {
+  return encodeURIComponent(str).replace(/[!'()*]/g, function(c) {
+    return '%' + c.charCodeAt(0).toString(16);
+  });
+};
+
+var captureLink = function(){
+  var s = fixedEncodeURIComponent(window.getSelection().toString());
+  var l = fixedEncodeURIComponent(window.location.href);
+  var t = fixedEncodeURIComponent(document.title);
+  var p = fixedEncodeURIComponent('capture')
+  var uri = 'http://localhost:4567/?' +
+	  'p=' + p +
+      '&l=' + l +
+      '&t=' + t +
+      '&s=' + s
+  window.location = uri;
+  return uri;
+};
+captureLink();
+```
+
+Which is different from the code @sachac shows in her post.
+
+In this case, URI encoding needs to go deeper than just the unsafe
+characters, because you could easily have safe characters in any of
+the components but you want
+them  encoded anyway, such as `'`, `&`, etc.
+
+Also, they are getting put together as a query string to the
+`emacs-org-protocol-server` instead of the URI itself.
+
+Copy and paste the into the Shortkeys javascript area when you're
+creating your short key. You can assign
+your own shortkey to it.
+
+### Bookmarklet
+
+Another way to do this, which is more what I'm used to, is to create a
+JavaScript Bookmarklet. To do this in Chrome, you create a new
+bookmark in your Bookmark Manager window, give it a name such as
+`capture`, and then paste in some JS code prefixed by the pseudo-scheme
+`javascript:`, for example:
+
+
+``` javascript
+javascript:function fx(str){return encodeURIComponent(str).replace(/[!'()*]/g, function(c){return '%' + c.charCodeAt(0).toString(16);});};var captureLink=function(){var s=fx(window.getSelection().toString()),l=fx(window.location.href),t=fx(document.title),p='capture',uri='http://localhost:4567/?'+'p='+p+'&l='+l+'&t='+t+'&s='+s;window.location=uri;return uri;};captureLink();
+```
+
+If you are running your `emacs-org-protocol-server` at a different
+port than 4567, put that in the bookmarklet instead.
+
+## Capture Template
+
+The org-protocol capture sub-protocol theoretically lets you give a an
+org-capture template code, but I'm still trying to get this to work
+consistently and well. I've short-circuited the code in the server to
+always use the "w" capture template (which is old behaviour) which
+dumps the captured page information into my links journal file. You
+can set up your own capture template, just name it "w".
+
+Here's my "w" capture template:
+
+``` elisp
+("w"
+ "Default Org-protocol Capture Template"
+ entry
+ (file+datetree (concat org-directory "link_journal.org"))
+ "* %:link\n\n  Title: %:description\n\n  %?%:initial\n\n  captured at: %U\n"
+ :empty-lines 1)
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. Then, run `rake` to run the tests. You can also run
+`bin/console` for an interactive prompt that will allow you to
+experiment. Run `bundle exec emacs_org_protocol_server` to use the gem
+in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`. To release a new version, update the version number in
+`version.rb`, and then run `bundle exec rake release`, which will
+create a git tag for the version, push git commits and tags, and push
+the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/tamouse/emacs_org_protocol_server. This project
+is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "emacs_org_protocol_server"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bookmarklet.js

@@ -0,0 +1 @@
+javascript:function fx(str){return encodeURIComponent(str).replace(/[!'()*]/g, function(c){return '%' + c.charCodeAt(0).toString(16);});};var captureLink=function(){var s=fx(window.getSelection().toString()),l=fx(window.location.href),t=fx(document.title),p='capture',uri='http://localhost:4567/?'+'p='+p+'&l='+l+'&t='+t+'&s='+s;window.location=uri;return uri;};captureLink();

data/emacs_org_protocol_server.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'emacs_org_protocol_server/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "emacs_org_protocol_server"
+  spec.version       = EmacsOrgProtocolServer::VERSION
+  spec.authors       = ["Tamara Temple"]
+  spec.email         = ["tamouse@gmail.com"]
+
+  spec.summary       = %q{Simple Sinatra server to call org-protocol with emacsclient}
+  spec.description   = %q{Simple Sinatra server to call org-protocol with emacsclient}
+  spec.homepage      = "https://github.com/tamouse/emacs_org_protocol_server"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "thin"
+  spec.add_dependency "sinatra"
+end

data/exe/emacs_org_protocol_server

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "emacs_org_protocol_server"
+EmacsOrgProtocolServer::OPServ.run!

data/lib/emacs_org_protocol_server/version.rb

@@ -0,0 +1,3 @@
+module EmacsOrgProtocolServer
+  VERSION = "0.1.0"
+end

data/lib/emacs_org_protocol_server.rb

@@ -0,0 +1,40 @@
+require "emacs_org_protocol_server/version"
+require 'sinatra/base'
+require 'uri'
+
+module EmacsOrgProtocolServer
+  EMACSCLIENT=ENV['EMACSCLIENT'] || "/usr/local/bin/emacsclient"
+
+  class OPServ < Sinatra::Application
+
+    helpers do
+      def esc(s)
+        URI.escape(s, %r{[^[:alnum:]]})
+      end
+    end
+
+    get '/' do
+      if params.empty?
+        return [422, 'no params passed']
+      end
+
+      p=params['p'].to_s.downcase
+      if p.match(%r{capture})
+        template='//w'
+      else
+        template=''
+      end
+      l=params['l'].to_s
+      t=params['t'].to_s
+      s=params['s'].to_s
+
+      emacsclient_target = "org-protocol://#{p}:#{template}//#{esc(l)}/#{esc(t)}/#{esc(s)}"
+      cmd = "#{EMACSCLIENT} -n '#{emacsclient_target}'"
+      system(cmd)
+      puts "ran #{cmd}"
+      redirect to(params['l'])
+    end
+
+  end
+
+end

data/shortkey.js

@@ -0,0 +1,20 @@
+function fixedEncodeURIComponent (str) {
+  return encodeURIComponent(str).replace(/[!'()*]/g, function(c) {
+    return '%' + c.charCodeAt(0).toString(16);
+  });
+};
+
+var captureLink = function(){
+  var s = fixedEncodeURIComponent(window.getSelection().toString());
+  var l = fixedEncodeURIComponent(window.location.href);
+  var t = fixedEncodeURIComponent(document.title);
+  var p = fixedEncodeURIComponent('capture')
+  var uri = 'http://localhost:4567/?' +
+	  'p=' + p +
+      '&l=' + l +
+      '&t=' + t +
+      '&s=' + s
+  window.location = uri;
+  return uri;
+};
+captureLink();

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: emacs_org_protocol_server
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tamara Temple
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  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: sinatra
+  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'
+description: Simple Sinatra server to call org-protocol with emacsclient
+email:
+- tamouse@gmail.com
+executables:
+- emacs_org_protocol_server
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bookmarklet.js
+- emacs_org_protocol_server.gemspec
+- exe/emacs_org_protocol_server
+- lib/emacs_org_protocol_server.rb
+- lib/emacs_org_protocol_server/version.rb
+- shortkey.js
+homepage: https://github.com/tamouse/emacs_org_protocol_server
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple Sinatra server to call org-protocol with emacsclient
+test_files: []
+has_rdoc: