marginalia-io 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Pete Keen
+
+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,62 @@
+# Marginalia CLI
+
+[Marginalia](https://www.marginalia.io/) is a web-based journaling and
+note taking app using Markdown. It also has a full featured [RESTful API](https://www.marginalia.io/apidocs), and this is the Ruby API client for it, as well as
+an example command line application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'marginalia-io'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install marginalia-io
+
+## Usage
+
+```
+Tasks:
+  marginalia append ID     # Append to the given note
+  marginalia edit ID       # Edit the given note in the editor
+  marginalia help [TASK]   # Describe available tasks or one specific task
+  marginalia list          # List all notes
+  marginalia login         # Login to Marginalia
+  marginalia logout        # Logout of Marginalia
+  marginalia search QUERY  # List all notes matching a given query
+  marginalia show ID       # Show the given note in the pager
+
+Options:
+  [--host=HOST]  # Marginalia hostname
+                 # Default: www.marginalia.io
+```
+
+The API is pretty simple right now:
+
+```ruby
+require 'marginalia-io'
+
+api    = Marginalia::IO::API.new # will prompt for credentials if not logged in
+
+all    = api.all                 # Get all of the notes
+blurb  = api.search('blurb')     # Get all of the notes matching 'blurb'
+note_5 = api.get(5)              # Get the note with id 5
+
+api.append(5, "Hi There")        # Append "Hi There" with a timestamp to the end of not 5
+
+api.update(5, "Hello There")     # replace the body of note 5 with "Hello There"
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/marginalia

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+
+begin
+  require 'marginalia-io'
+rescue LoadError => e
+  path = File.expand_path '../../lib', __FILE__
+  $:.unshift(path) if File.directory?(path) && !$:.include?(path)
+  require 'marginalia-io'
+end
+
+Marginalia::IO::CLI.start()

data/lib/marginalia-io/api.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'httparty'
+require 'netrc'
+require 'uri'
+
+module Marginalia
+  module IO
+
+    class NetRCMissingError < StandardError; end
+
+    class API
+
+      include HTTParty
+
+      def initialize(host='www.marginalia.io')
+        credentials = Marginalia::IO::Auth.new(host).get_credentials
+        self.class.base_uri "https://#{host}"
+        self.class.basic_auth credentials[0], credentials[1]
+      end
+
+      def append(id, body)
+        self.class.post("/notes/#{id}/append.json", :body => {:body => body})
+      end
+
+      def all
+        self.class.get("/notes.json").parsed_response
+      end
+
+      def search(query)
+        escaped = URI.escape(query)
+        self.class.get("/notes/search.json?q=#{escaped}").parsed_response
+      end
+
+      def get(id)
+        self.class.get("/notes/#{id}.json")
+      end
+
+      def update(id, body)
+        puts self.class.put("/notes/#{id}.json", :body => {:note => {:body => body}}).parsed_response
+      end
+    end
+
+  end
+end

data/lib/marginalia-io/auth.rb

@@ -0,0 +1,70 @@
+require 'netrc'
+
+class Marginalia::IO::Auth
+  attr_accessor :credentials, :host
+
+  def initialize(host="www.marginalia.io")
+    @host = host
+  end
+
+  def netrc_path
+    default = Netrc.default_path
+    encrypted = default + ".gpg"
+    if File.exists?(encrypted)
+      encrypted
+    else
+      default
+    end
+  end
+
+  def get_credentials    # :nodoc:
+    @credentials ||= (read_credentials || login)
+  end
+
+  def netrc   # :nodoc:
+    @netrc ||= begin
+      File.exists?(netrc_path) && Netrc.read(netrc_path)
+    rescue => error
+      if error.message =~ /^Permission bits for/
+        perm = File.stat(netrc_path).mode & 0777
+        abort("Permissions #{perm} for '#{netrc_path}' are too open. You should run `chmod 0600 #{netrc_path}` so that your credentials are NOT accessible by others.")
+      else
+        raise error
+      end
+    end
+  end
+
+  def delete_credentials
+    if netrc
+      netrc.delete(host)
+      netrc.save
+    end
+  end
+
+  def read_credentials
+    if netrc
+      netrc[host]
+    end
+  end
+
+  def write_credentials
+    FileUtils.mkdir_p(File.dirname(netrc_path))
+    FileUtils.touch(netrc_path)
+    FileUtils.chmod(0600, netrc_path)
+    netrc[host] = self.credentials
+    netrc.save
+  end
+
+  def login
+    print "Email address: "
+    username = gets
+    print "Password: "
+    system "stty -echo"
+    password = gets
+    system "stty echo"
+
+    self.credentials = [username, password]
+    write_credentials
+    self.credentials
+  end
+end

data/lib/marginalia-io/cli.rb

@@ -0,0 +1,107 @@
+require 'thor'
+require 'open3'
+
+class Marginalia::IO::CLI < Thor
+  include Thor::Actions
+
+  class_option :host, :type => :string, :desc => "Marginalia hostname", :default => 'www.marginalia.io'
+
+  desc "login", "Login to Marginalia"
+  def login
+    auth = Marginalia::IO::Auth.new(options[:host])
+    auth.delete_credentials
+    auth.login
+  end
+
+  desc "logout", "Logout of Marginalia"
+  def logout
+    auth = Marginalia::IO::Auth.new(options[:host])
+    auth.delete_credentials
+  end
+
+  desc "list", "List all notes"
+  def list
+    api.all.sort_by{ |n| n['updated_at'] }.reverse.each do |note|
+      puts "#{note['id'].to_s.rjust(4)} #{note['updated_at'][0,10]} #{note['title']}"
+    end
+  end
+
+  desc "search QUERY", "List all notes matching a given query"
+  def search(query)
+    api.search(query).sort_by{|n|n['updated_at']}.reverse.each do |note|
+      puts "#{note['id'].to_s.rjust(4)} #{note['updated_at'][0,10]} #{note['title']}"
+    end
+  end
+
+  desc "show ID", "Show the given note in the pager"
+  def show(id)
+    note = api.get(id)
+    body = """title:   #{note['title']}
+id:      #{note['id']}
+created: #{note['created_at']}
+updated: #{note['updated_at']}
+
+#{note['body'].delete("\C-M")}
+"""
+
+    temp = Tempfile.new(["notes", ".md"])
+    temp.write body
+    temp.flush
+    system(ENV['PAGER'], temp.path)
+  end
+
+  desc "edit ID", "Edit the given note in the editor"
+  def edit(id)
+    note = api.get(id)
+    if note.nil?
+      raise Thor::Error.new "Unknown note id #{id}"
+    end
+    body = """title:   #{note['title']}
+id:      #{note['id']}
+created: #{note['created_at']}
+updated: #{note['updated_at']}
+
+#{note['body'].delete("\C-M")}
+"""
+    temp = Tempfile.new(["note", ".md"])
+    temp.write body
+    temp.flush
+
+    system("#{ENV['EDITOR']} #{temp.path}")
+
+    temp.rewind
+    contents = temp.read
+
+    headers, body = contents.split(/\n\n/, 2)
+
+    api.update(id, body)
+  end
+
+  desc "append ID", "Append to the given note"
+  def append(*args)
+    id = args.shift
+    raise Thor::Error.new "Expected an id" unless id
+
+    body = args.join(" ")
+    if body.strip == ""
+      temp = Tempfile.new(['journal', '.md'])
+      system(ENV['EDITOR'], temp.path)
+      body = temp.read
+    end
+
+    if body.strip == ""
+      exit 0
+    end
+
+    api.append(id, body)
+  end
+
+  default_task :list
+
+  no_tasks do
+    def api
+      Marginalia::IO::API.new(options[:host])
+    end
+  end
+
+end

data/lib/marginalia-io/version.rb

@@ -0,0 +1,5 @@
+module Marginalia
+  module IO
+    VERSION = "0.0.1"
+  end
+end

data/lib/marginalia-io.rb

@@ -0,0 +1,5 @@
+require 'marginalia-io/version'
+require 'marginalia-io/auth'
+require 'marginalia-io/api'
+require 'marginalia-io/cli'
+require 'marginalia-io/version'

data/marginalia-io.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/marginalia-io/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Pete Keen"]
+  gem.email         = ["pete@marginalia.io"]
+  gem.description   = "API and Command Line Client for Marginalia.io"
+  gem.summary       = "Marginalia.io is a web-based note taking and journalling app using Markdown. This is the Ruby API for it."
+  gem.homepage      = "https://www.marginalia.io"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "marginalia-io"
+  gem.require_paths = ["lib"]
+  gem.version       = Marginalia::IO::VERSION
+
+  gem.add_dependency "netrc",    "~> 0.7.7"
+  gem.add_dependency "httparty", "~> 0.8.3"
+  gem.add_dependency "thor",     "~> 0.16.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: marginalia-io
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Pete Keen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: netrc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+description: API and Command Line Client for Marginalia.io
+email:
+- pete@marginalia.io
+executables:
+- marginalia
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/marginalia
+- lib/marginalia-io.rb
+- lib/marginalia-io/api.rb
+- lib/marginalia-io/auth.rb
+- lib/marginalia-io/cli.rb
+- lib/marginalia-io/version.rb
+- marginalia-io.gemspec
+homepage: https://www.marginalia.io
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Marginalia.io is a web-based note taking and journalling app using Markdown.
+  This is the Ruby API for it.
+test_files: []