iated 0.0.1

data/lib/iated/version.rb

@@ -0,0 +1,3 @@
+module Iated
+  VERSION = "0.0.1"
+end

data/lib/iated/views/hello.haml

@@ -0,0 +1,13 @@
+!!!
+%meta( charset="utf-8" )
+%title Authorize Iated
+
+%body( id="hello" )
+  %h1 Authorize Iated
+
+  %form( method="post" )
+    %input( type="text" name="onetime" )
+    %input( type="submit" name="Authorize!" )
+
+  %pre
+    %= params.inspect

data/lib/iated/views/preferences.haml

@@ -0,0 +1,27 @@
+!!!
+%meta( charset="utf-8" )
+%title It's All Text!
+%link( rel="stylesheet" type="text/css" href="iated.css" )
+
+%body( class="preferences" )
+
+  %div( id="content" )
+  %h1
+    It's All Text! Preferences
+
+  %form( method="post" action="/preferences" )
+    %input( type="hidden" name="token" value="#{token}" )
+
+    %label( for="editor" )
+      Editor:
+    %input( type="text" name="editor" value="#{editor}")
+
+    %label( for="port" )
+      Port:
+    %input( type="text" name="port" value="#{port}")
+
+    %label( for="config_dir" )
+      Config Directory:
+    %input( type="text" name="config_dir" value="#{config_dir}")
+
+    %input( type="submit" value="Save" )

data/lib/iated/views/reference.coffee

@@ -0,0 +1,79 @@
+# Defaults for ajax requests.
+jQuery.ajaxSetup cache: true
+
+# Method to highlight a change.
+jQuery.fn.highlight = ->
+  this.effect('highlight', 3 * 1000)
+
+hello = () ->
+  jQuery.getJSON('/hello', (data) ->
+    console.log("GET /hello: %o", data)
+  )
+
+secret = () ->
+  data=
+    secret: $('#secret').val()
+  jQuery.post('/hello', data, (data, textStatus, jqXHR) ->
+    console.log("POST /hello: %o %o %o", data, textStatus, jqXHR)
+    $('#token').val(data.token)
+    token=data.token
+  )
+
+edit = () ->
+  tid = "#text"
+  text = $(tid).val()
+  url = window.location.toString()
+  extension = '.txt'
+
+  data=
+    tid:       "#text"
+    text:      $("#text").val()
+    url:       url
+    extension: $('#extension').val()
+    token:     $("#token").val()
+
+  jQuery.post('/edit', data, (data, textStatus, jqXHR) ->
+    console.log("POST /edit: %o %o %o", data, textStatus, jqXHR)
+    $('#sid').val(data.sid).highlight()
+    $('#change-id').val( if data.change_id then data.change_id else 0).highlight()
+  )
+
+edit_prev = () ->
+  tid = "#text"
+  url = window.location.toString()
+  extension = '.text'
+
+  data=
+    tid: "#text"
+    url: url
+    extension: $('#extension').val()
+    token: $('#token').val()
+
+  jQuery.post('/edit', data, (data, textStatus, jqXHR) ->
+    console.log("POST /edit: %o %o %o", data, textStatus, jqXHR)
+    $('#sid').val(data.sid).highlight()
+    $('#change-id').val(if data.change_id then data.change_id else 0).highlight()
+  )
+
+update = () ->
+  jQuery.getJSON('/edit/' + $('#sid').val() + "/" + $("#change-id").val(), (data) ->
+    console.log("GET /edit/:sid/:change-id: %o", data)
+    if data.change_id && data.change_id.toString() != $('#change-id').val()
+      $('#text').val(data.text).highlight()
+      $('#change-id').val(data.change_id).highlight()
+  )
+
+preferences = () ->
+  event.preventDefault()
+  event.stopPropagation()
+  window.open('/preferences?token=' + encodeURIComponent($('#token').val()), "iat_prefs")
+  return true
+
+jQuery ->
+  $("#hello-btn").click(hello);
+  $("#secret-btn").click(secret);
+  $("#edit-btn").click(edit);
+  $("#edit-prev-btn").click(edit_prev);
+  $("#update-btn").click(update);
+  $("#preferences-btn").click(preferences);
+

data/lib/iated/views/reference.haml

@@ -0,0 +1,94 @@
+!!!
+%meta( charset="utf-8" )
+%title Reference Implementation
+%script( type="text/javascript" src="/jquery.js" )
+%script( type="text/javascript" src="/jquery-ui.js" )
+%script( type="text/javascript" src="script.js" )
+%link( rel="stylesheet" type="text/css" href="style.css" )
+%body
+  %h1 Reference Implementation of IAT
+
+  %p
+    This is a reference implementation of IAT's browser side code.  See the code on
+    %a( href="http://github.com/docwhat/iated" ) GitHub
+
+  %div#content-text
+    %h2 Textarea
+    An example textarea to play in.
+
+    %div#textarea-wrapper
+      %textarea#text="Some example text\nto play with."
+
+  %div#content-data
+    %h2 The data
+
+    %dl
+      %dt
+        Extension:
+      %dd
+        %input#extension( name="extension" type="text" value=".txt" )
+        %br
+        The extension used for the file when opening it up to the editor.
+        This value is checked on the server side against the list of approved
+        extensions.
+
+      %dt
+        Browser Authentication Secret:
+      %dd
+        %input#secret( name="secret" type="text" )
+        %br
+        This is a one-time secret used to verify the browser is actually under
+        control of the user who is running Iated.
+
+      %dt
+        Browser Token:
+      %dd
+        %input#token( name="token" type="text" )
+        %br
+        This is the unique token to be used by this one browser extension instance
+        to validate against Iated.
+
+      %dt
+        Edit Session ID (sid):
+      %dd
+        %input#sid( name="sid" type="text" )
+        %br
+        The session identifier for editing this particular textarea.
+
+      %dt
+        Change ID:
+      %dd
+        %input#change-id( name="change-id" type="text" )
+        %br
+        Every time the file changes on disk, the change id is incremented. It starts
+        at zero when the edit session is created and increments during the lifetime
+        of the session.
+
+  %div#content-requests
+    %h2 The requests
+
+    %ol
+      %li
+        %button#hello-btn GET /hello
+        %br
+        Ask for a secret to authenticate
+      %li
+        %button#secret-btn POST /hello (with secret)
+        %br
+        Send the secret to retrieve a token.
+      %li
+        %button#edit-btn POST /edit
+        %br
+        Request that the text be opened in an editor.
+      %li
+        %button#edit-prev-btn POST /edit
+        %br
+        Request the existing file be opened in an editor.
+      %li
+        %button#update-btn POST /edit/:sid/:change_id
+        %br
+        Check the status of the edit, retrieving changes as needed.
+      %li
+        %button#preferences-btn GET /preferences
+        %br
+        Open the preference window.

data/lib/iated/views/reference.scss

@@ -0,0 +1,36 @@
+body {
+  font-family: 'Lucida Sans Unicode', 'Lucida Grande', sans-serif;
+  background-color: #def;
+}
+
+dd {
+  font-size: 90%;
+}
+
+#content-text {
+  margin: 0 1em;
+  float: left;
+  width: 30%;
+  #textarea-wrapper {
+    textarea {
+      position: fixed;
+      left: inherit;
+      top: inherit;
+      width: 28%;
+      height: 8em;
+    }
+  }
+}
+#content-data {
+  margin: 0 1em;
+  float: left;
+  width: 30%;
+  input {
+    font-family: Menlo, monospace;
+  }
+}
+#content-requests {
+  margin: 0 1em;
+  float: left;
+  width: 30%;
+}

data/lib/iated/views/root.haml

@@ -0,0 +1,13 @@
+!!!
+%meta( charset="utf-8" )
+%title Iated
+
+%body( id="root" )
+  %h1 It's All Text! editor daemon
+
+  %dl
+    %dt Chrome
+    %dd Link to plugin
+
+    %dt Firefox
+    %dd Link to plugin

data/spec/lib/iated/browser_token_db_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'pathname'
+require 'tmpdir'
+require 'fileutils'
+
+describe Iated::BrowserTokenDB do
+
+  it "writes to a specified file" do
+    dir = Dir.mktmpdir
+    fname = Pathname.new(dir) + 'test.yml'
+    db = Iated::BrowserTokenDB.new fname
+    fname.exist?.should be_true
+    FileUtils.rm_rf dir
+  end
+
+  it "doesn't have tokens that don't exist" do
+    dir = Dir.mktmpdir
+    fname = Pathname.new(dir) + 'test.yml'
+    db = Iated::BrowserTokenDB.new fname
+    db.has_token?("random-token").should be_false
+    db.user_agent("random_token").should be_nil
+    FileUtils.rm_rf dir
+  end
+
+  it "stores tokens and reads them back" do
+    dir = Dir.mktmpdir
+    ua = "NCSA_Mosaic/2.7b5 (X11;Linux 2.6.7 i686) libwww/2.12"
+    fname = Pathname.new(dir) + 'test.yml'
+    db = Iated::BrowserTokenDB.new fname
+    tok = db.add ua
+    db.has_token?(tok).should be_true
+    db.user_agent(tok).should == ua
+    FileUtils.rm_rf dir
+  end
+
+  it "stores tokens and reads them back persistantly" do
+    dir = Dir.mktmpdir
+    ua = "NCSA_Mosaic/2.7b5 (X11;Linux 2.6.7 i686) libwww/2.12"
+    fname = Pathname.new(dir) + 'test.yml'
+    db = Iated::BrowserTokenDB.new fname
+    tok = db.add ua
+    db = nil
+
+    db2 = Iated::BrowserTokenDB.new fname
+    db2.has_token?(tok).should be_true
+    db2.user_agent(tok).should == ua
+    FileUtils.rm_rf dir
+  end
+
+  it "tokens are always strings" do
+    dir = Dir.mktmpdir
+    fname = Pathname.new(dir) + 'test.yml'
+    db = Iated::BrowserTokenDB.new fname
+    tok = db.add "user agent"
+    tok.should be_an_instance_of String
+    FileUtils.rm_rf dir
+  end
+
+  it "user agents are always strings" do
+    dir = Dir.mktmpdir
+    fname = Pathname.new(dir) + 'test.yml'
+    db = Iated::BrowserTokenDB.new fname
+    tok = db.add :user_agent
+    db.user_agent(tok).should be_an_instance_of String
+    FileUtils.rm_rf dir
+  end
+
+end

data/spec/lib/iated/edit_session_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+describe Iated::EditSession do
+  before(:each) do
+    Iated::reset
+  end
+  after(:each) do
+    Iated::purge
+  end
+
+  context "#find" do
+
+    it "should find existing by params" do
+      params = {:url => 'http://example.com/'}
+      Iated::EditSession.new(params).should == Iated::EditSession.find(params)
+    end
+
+    it "should find existing sessions by sid" do
+      params = {:url => 'http://example.com/'}
+      sess1 = Iated::EditSession.new(params)
+      sess1.should == Iated::EditSession.find(sess1.sid)
+    end
+  end
+
+  context "#find_or_create" do
+    it "should find or create by exact match" do
+      tid = "fc-tid#{rand(1000)}"
+
+      sess1 = Iated::EditSession.find_or_create(:url => 'http://example.com/', :tid => tid)
+      sess2 = Iated::EditSession.find_or_create(:url => 'http://example.com/', :tid => tid)
+
+      sess1.should == sess2
+    end
+  end
+
+  context "#sid" do
+    it "should be 32 character hex string" do
+      tok = Iated::EditSession.calculate_sid :url => 'http://example.com/'
+      tok.should =~ /^[a-f0-9]{32}$/
+    end
+
+    it "should be different for different extensions" do
+      tok1 = Iated::EditSession.calculate_sid :url => "http://example.com", :extension => '.xml'
+      tok2 = Iated::EditSession.calculate_sid :url => "http://example.com", :extension => '.txt'
+      tok1.should_not == tok2
+    end
+
+    it "should be different for different urls" do
+      tok1 = Iated::EditSession.calculate_sid :url => "http://example.com/a"
+      tok2 = Iated::EditSession.calculate_sid :url => "http://example.com/b"
+      tok1.should_not == tok2
+    end
+
+    it "should be different for different tids" do
+      tok1 = Iated::EditSession.calculate_sid :url => "http://example.com/", :tid => 'a'
+      tok2 = Iated::EditSession.calculate_sid :url => "http://example.com/", :tid => 'b'
+      tok1.should_not == tok2
+    end
+  end
+
+  context "#text" do
+    it "should save the text when assigned" do
+      text = "\t Random Number: #{rand}"
+      sess = Iated::EditSession.new :url => 'http://example.com/', :text => text
+      sess.filename.should be_exist
+      sess.filename.read.should == text
+    end
+
+    it "should read back the text" do
+      text = "\t Random Number: #{rand}"
+      sess = Iated::EditSession.new :url => 'http://example.com/', :text => text
+      sess.text.should == text
+    end
+
+    it "shouldn't touch the change_id on first save" do
+      sess = Iated::EditSession.new :url => 'http://example.com/first_save_check', :tid => "#{rand}"
+      sess.text = "first-save-foo"
+      sess.change_id.should == 0
+    end
+
+    it "should increment the change_id on subsequent saves" do
+      sess = Iated::EditSession.new :url => 'http://example.com/subseq_save_check', :tid => "#{rand}", :text => "sub-foo"
+      sess.text = "sub-bar"
+      sess.change_id.should == 1
+    end
+
+    it "should be writen to disk" do
+      sess = Iated::EditSession.new :url => 'http://example.com/writeme', :tid => "#{rand}", :text => "written"
+      sess.filename.open('r') do |f|
+        f.read.should == "written"
+      end
+    end
+  end
+
+  context "#change_id" do
+    it "should be zero for new sessions" do
+      params = {}
+      params[:text] = "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
+      params[:url] = "http://example.com/cucumber"
+      session = Iated::EditSession.new params
+      session.change_id.should == 0
+    end
+
+    it "should detect the change_id when the contents change" do
+      sess = Iated::EditSession.new :url => 'http://example.com/changer', :tid => "#{rand}", :text => "change me"
+      sess.change_id.should == 0
+      sess.filename.open('w') do |f|
+        f.write "I'm changed!"
+      end
+      sess.change_id.should == 1
+    end
+  end
+
+  context "#increment_change_id" do
+    it "should increment the #change_id" do
+      sess = Iated::EditSession.new :url => 'http://example.com/should_increment'
+      sess.change_id.should == 0
+      sess.increment_change_id
+      sess.change_id.should == 1
+    end
+  end
+
+  context "param normalization" do
+    it "should handle text keys the same as symbol keys" do
+      [:url, :tid, :extension, :text].each do |key|
+        h1 = {}
+        h1[key] = 'stuff'
+        h2 = {}
+        h2[key.to_s] = 'stuff'
+        p1 = Iated::EditSession.normalize_keys h1
+        p2 = Iated::EditSession.normalize_keys h2
+        p1.should == p2
+      end
+    end
+
+    it "should not destroy the original" do
+      original = {
+        :url => "http://example.com/",
+        :tid => "some-tid",
+      }
+      normalized = Iated::EditSession.normalize_keys original
+      original.should_not be_nil
+    end
+
+    it "should strip :text being passed in" do
+      original = {
+        :url => "http://example.com/",
+        :text => "some text",
+        :tid => "some-tid",
+      }
+      normalized = Iated::EditSession.normalize_keys original
+      normalized[:url].should == original[:url]
+      normalized[:tid].should == original[:tid]
+      normalized[:text].should be_nil
+    end
+  end
+end