RubyGems - iated - Versions diffs - 0.0.1 - Mend

iated 0.0.1

Files changed (54) hide show

data/.gitignore +6 -0
data/Gemfile +3 -0
data/Guardfile +24 -0
data/LICENSE +23 -0
data/Makefile +72 -0
data/README.md +87 -0
data/Rakefile +10 -0
data/bin/iated +13 -0
data/config.ru +5 -0
data/extensions/chrome/background.html +5 -0
data/extensions/chrome/background.js +105 -0
data/extensions/chrome/contentscript.css +0 -0
data/extensions/chrome/contentscript.js +110 -0
data/extensions/chrome/jquery-ui.js +45 -0
data/extensions/chrome/jquery.js +16 -0
data/extensions/chrome/jquery.updater.js +46 -0
data/extensions/chrome/manifest.json +19 -0
data/extensions/chrome/yaml.js +489 -0
data/extensions/tests/simple.html +23 -0
data/features/extension_authenticates.feature +30 -0
data/features/extension_edits.feature +45 -0
data/features/step_definitions/extension_steps.rb +134 -0
data/features/support/env.rb +47 -0
data/features/support/hooks.rb +11 -0
data/iated.gemspec +48 -0
data/lib/iated.rb +111 -0
data/lib/iated/browser_token_db.rb +76 -0
data/lib/iated/edit_session.rb +221 -0
data/lib/iated/helpers.rb +9 -0
data/lib/iated/mcp.rb +144 -0
data/lib/iated/page_helpers.rb +33 -0
data/lib/iated/public/jquery-ui.js +101 -0
data/lib/iated/public/jquery.js +2 -0
data/lib/iated/public/robots.txt +5 -0
data/lib/iated/server.rb +162 -0
data/lib/iated/sys_pref.rb +201 -0
data/lib/iated/version.rb +3 -0
data/lib/iated/views/hello.haml +13 -0
data/lib/iated/views/preferences.haml +27 -0
data/lib/iated/views/reference.coffee +79 -0
data/lib/iated/views/reference.haml +94 -0
data/lib/iated/views/reference.scss +36 -0
data/lib/iated/views/root.haml +13 -0
data/spec/lib/iated/browser_token_db_spec.rb +68 -0
data/spec/lib/iated/edit_session_spec.rb +157 -0
data/spec/lib/iated/mcp_spec.rb +86 -0
data/spec/lib/iated/sys_pref_spec.rb +40 -0
data/spec/protocol/edit_spec.rb +88 -0
data/spec/protocol/hello_spec.rb +18 -0
data/spec/protocol/notfound_spec.rb +11 -0
data/spec/protocol/ping_spec.rb +10 -0
data/spec/protocol/preferences_spec.rb +35 -0
data/spec/spec_helper.rb +21 -0
metadata +460 -0

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<title>IAT Testing Page</title>
+<script src="jquery.js"></script>
+<body>
+  <h1>
+    IAT Testing Page
+  </h1>
+  <section>
+    <p>
+      A Textarea:
+    </p>
+    <textarea>Some text to play with.</textarea>
+  </section>
+  <section>
+    <p>
+      Another Textarea:
+    </p>
+    <textarea>Some more text to play with.</textarea>
+  </section>
+</body>

data/features/extension_authenticates.feature ADDED

@@ -0,0 +1,30 @@
+Feature: Extension Authenticates
+  As a browser extension
+  I want to authenticate
+  So that I can send requests
+  The token can't be a cookie, or any page sent from the browser could access
+  features like editing, etc. That would allow a malicious page to open a million
+  editors or change preferences.
+  Scenario: Extension says hello
+    Given I have not authenticated
+    When I GET /hello without a secret
+    Then the user should be shown the secret
+    And the page should be "text/json"
+    And the status should be "ok"
+  @wip
+  Scenario: Extension posts secret
+    Given I have a secret
+    When I POST /hello with the secret
+    Then I should be sent a response with a token
+    And the page should be "text/json"
+    And the token should be registered
+  Scenario: Extension pings with secret
+    Given I have a token
+    When I POST /ping with the token
+    Then the page should say "pong"
+    And the page should be "text/plain"

data/features/extension_edits.feature ADDED

@@ -0,0 +1,45 @@
+Feature: Extension edits files
+  As a browser extension
+  I want to open text in an editor
+  So that I can allow users to edit textareas more elegantly.
+  Scenario: Sending text to edit
+    Given I have a token
+    When I have a textarea to edit
+     And the textarea has the id of "foobar"
+     And the textarea has a url of "http://example.com/foobarpage.html"
+     And I request an extension of ".txt"
+     And I POST an /edit request
+    Then I expect a valid session id
+    And I expect the editor file to have an extension of ".txt"
+    And I expect the editor file to have "example.com" in it
+    And I expect the editor file to have "foobarpage" in it
+    And I expect an editor to be opened
+  Scenario: First check of text
+    Given I have a new session
+    When I GET /edit/<session id>/0
+    Then I expect a change-count of 0
+    And I expect no text to be sent
+  Scenario: Checking unchanged text
+    Given I have a new session
+    And the session has been edited 2 times
+    When I GET /edit/<session id>/2
+    Then I expect a change-count of 2
+    And I expect no text to be sent
+  Scenario: Checking once changed text
+    Given I have a new session
+    And the session has been edited 2 times
+    When I GET /edit/<session id>/1
+    Then I expect a change-count of 2
+    And I expect the text to be sent
+  Scenario: Checking twice changed text
+    Given I have a new session
+    And the session has been edited 3 times
+    When I GET /edit/<session id>/1
+    Then I expect a change-count of 3
+    And I expect the text to be sent

data/features/step_definitions/extension_steps.rb ADDED

@@ -0,0 +1,134 @@
+## Givens
+Given /^I have not authenticated$/ do
+  @secret.should be_nil
+  @token.should be_nil
+end
+Given /^I have a secret$/ do
+  @secret.should be_nil
+  @secret = Iated::mcp.generate_secret
+  @secret.should_not be_nil
+end
+Given /^I have a token$/ do
+  @token.should be_nil
+  @token = Iated::mcp.generate_token "cucumber testing user agent"
+  @token.should_not be_nil
+end
+Given /^I have a new session$/ do
+  @textarea = {}
+  @textarea[:text] = "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
+  @textarea[:url] = "http://example.com/cucumber"
+  @session = Iated::EditSession.new @textarea
+  @sid = @session.sid
+  @session.change_id.should == 0
+end
+Given /^the session has been edited (\d+) times$/ do |count|
+  count.to_i.times.each do
+    # This fakes that the file has been edited.
+    @session.increment_change_id
+  end
+end
+## Whens
+When /^I GET (\/[a-z]+)( without a secret|)$/ do |url, junk|
+  get url
+end
+When /^the page should be "([^"]*)"$/ do |content_type| #"
+  last_response.content_type.should =~ Regexp.new("^#{Regexp.quote content_type}(;.*|)$")
+end
+When /^the page should say "([^"]*)"$/ do |body| #"
+  last_response.body.should == body
+end
+When /^I POST (\/[a-z]+) with the secret$/ do |url|
+  post url, :secret => @secret
+  last_response.status.should_not == 500
+end
+When /^I POST (\/[a-z]+) with the token$/ do |url|
+  post url, :token => @token
+end
+When /^I have a textarea to edit$/ do
+  @textarea = {}
+  @textarea[:text] = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque ullamcorper metus lacinia risus congue sagittis. Integer enim libero, semper ut viverra eu, ullamcorper vitae urna. Quisque sit amet nibh urna, eget posuere nisi. Ut feugiat fermentum lacinia. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam vitae congue turpis. Sed orci mi, eleifend ut tristique ac, vehicula ac erat. Integer nisl quam, dictum vel posuere non, semper adipiscing massa. Ut in lectus id arcu adipiscing interdum. Aliquam orci lectus, semper vitae varius eget, rutrum et ante. Aenean sagittis scelerisque augue, consectetur blandit elit sodales id. Proin nibh nunc, aliquam id porttitor quis, facilisis id ante. Morbi aliquet suscipit augue. Integer molestie nisi ut libero consectetur vel blandit erat sagittis."
+end
+When /^the textarea has the id of "([^"]*)"$/ do |tid| #"
+  @textarea[:id] = tid
+end
+When /^the textarea has a url of "([^"]*)"$/ do |url| #"
+  @textarea[:url] = url
+end
+When /^I request an extension of "(\.[a-z]+)"$/ do |extension|
+  @textarea[:extension] = extension
+end
+When /^I POST an \/edit request$/ do
+  @textarea[:token] = @token
+  post "/edit", @textarea
+end
+When /^I GET \/edit\/<session id>\/(\d+)$/ do |change_id|
+  get "/edit/#{@sid}/#{change_id}"
+end
+## Thens
+Then /^the user should be shown the secret$/ do
+  Iated::mcp.should be_showing_secret
+end
+Then /^I should be sent a response with a token$/ do
+  last_response.status.should == 200
+  last_json["token"].should_not be_nil
+  @token = last_json["token"]
+end
+Then /^the token should be registered$/ do
+  Iated::mcp.is_token_valid?(@token).should be_true
+  # FIXME This is here because I'm having a hard time aggregating rcov reports.
+  Iated::mcp.cucumber_coverage_check
+end
+Then /^I expect the text to be sent$/ do
+  last_json["text"].should == @textarea[:text]
+end
+Then /^I expect a valid session id$/ do
+  last_response.status.should == 200
+  @sid = last_json["sid"]
+  @sid.should_not be_nil
+  @session = Iated::sessions[@sid]
+  @session.should_not be_nil
+end
+Then /^I expect an editor to be opened$/ do
+  @session.should be_running
+end
+Then /^the status should be "([a-z0-9]+)"$/ do |string|
+  last_json["status"].should be == string
+end
+Then /^I expect the editor file to have an extension of "(\.[a-z]+)"$/ do |ext|
+  @session.extension.should == @textarea[:extension]
+end
+Then /^I expect the editor file to have "([a-z0-9._-]+)" in it$/ do |string|
+  @session.filename.to_s.should =~ Regexp.new(Regexp.quote(string))
+end
+Then /^I expect a change\-count of (\d+)$/ do |change_count|
+  last_json["change_id"].should == change_count.to_i
+end
+Then /^I expect no text to be sent$/ do
+  last_json["text"].should be_nil
+end

data/features/support/env.rb ADDED

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'pathname'
+$: << (Pathname.new(__FILE__).dirname.dirname.dirname + 'src' + 'lib').to_s
+require 'yaml'
+require 'json'
+require 'iated/server'
+## Force the application name because polyglot breaks the auto-detection logic.
+#Sinatra::Application.app_file = app_file
+set :environment, :test
+Iated::environment = :test
+require 'rspec/expectations'
+require 'rack/test'
+require 'webrat'
+Webrat.configure do |config|
+  config.mode = :rack
+end
+class MyWorld
+  include Rack::Test::Methods
+  include Webrat::Methods
+  include Webrat::Matchers
+  Webrat::Methods.delegate_to_session :response_code, :response_body
+  def app
+    Iated::Server
+  end
+  def last_yaml
+    YAML::load(last_response.body)
+  end
+  def last_json
+    JSON::load(last_response.body)
+  end
+end
+World do
+  MyWorld.new
+end

data/features/support/hooks.rb ADDED

@@ -0,0 +1,11 @@
+# Before each scenerio
+Before do
+  Iated::reset
+  Iated::mcp.ui = :test
+end
+After do
+  # This cleans up test directories.
+  Iated::reset
+end

data/iated.gemspec ADDED

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/iated/version', __FILE__)
+Gem::Specification.new do |gem|
+  gem.authors       = ["Christian Höltje"]
+  gem.email         = ["docwhat@gerf.org"]
+  gem.description   = %q{The It's All Text! Editor Daemon}
+  gem.summary       = <<-EOF
+  This is the core IAT Editor Daemon functionality as a gem.
+  It comes with the command line version of `iated` that
+  gives you all the functionality of the GUI versions.
+  EOF
+  gem.homepage      = "http://github.com/docwhat/iated"
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "iated"
+  gem.require_paths = ["lib"]
+  gem.license       = 'MIT'
+  gem.version       = Iated::VERSION
+  gem.add_runtime_dependency "sinatra", "~> 1.3.3"
+  gem.add_runtime_dependency "haml", "~> 3.1.7"
+  gem.add_runtime_dependency "json", "~> 1.1"
+  gem.add_runtime_dependency "addressable", "~> 2.3.2"
+  gem.add_runtime_dependency "coffee-script"
+  gem.add_runtime_dependency "sass"
+  gem.add_development_dependency "rake", "~> 0.9.2"
+  gem.add_development_dependency "rspec", "> 2.0"
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "kramdown"
+  gem.add_development_dependency "cucumber", ">= 1.1.0"
+  gem.add_development_dependency "webrat"
+  gem.add_development_dependency "syntax"
+  gem.add_development_dependency "rack-test"
+  gem.add_development_dependency "guard", ">= 1.3.0"
+  gem.add_development_dependency "guard-bundler"
+  gem.add_development_dependency "guard-cucumber"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "rb-fsevent"
+  gem.add_development_dependency "terminal-notifier-guard"
+  gem.add_development_dependency "growl"
+end

data/lib/iated.rb ADDED

@@ -0,0 +1,111 @@
+require 'pathname'
+# Load all handlers in the iated/ directory
+Pathname.glob(Pathname.new(__FILE__).dirname + 'iated' + 'pages' + '*.rb').each do |path|
+  require path.to_s
+end
+require 'sinatra'
+require 'haml'
+require 'iated/mcp'
+require 'iated/edit_session'
+require 'iated/browser_token_db'
+require 'optparse'
+if RUBY_ENGINE == "jruby"
+  # Load all the jars in the lib directory.
+  Dir[File.join(File.dirname(__FILE__), '*.jar')].each do |jar|
+    require jar
+  end
+end
+module Iated
+  class Application
+    #:nocov:
+    def initialize
+      @mcp = nil
+      @optparse = OptionParser.new do |opts|
+        opts.banner =    "Usage: #{opts.program_name} [OPTIONS]"
+        opts.on('-p', '--port PORT', Integer,
+                "The port number to run the server on (default: #{Iated.mcp.prefs.port}).") do |p|
+          Iated.mcp.prefs.port = p
+        end
+        opts.on('-e', '--editor EDITOR', "Set editor (default #{Iated.mcp.prefs.editor}).") do |editor|
+          Iated.mcp.prefs.editor = editor
+        end
+        opts.on('-u', '--ui UI', "Set the UI to be 'gui' or 'text' (default #{Iated.mcp.ui}).") do |ui|
+          Iated.mcp.ui = ui.to_sym
+        end
+        opts.on('-d', '--debug', "Turn on debugging mode.") do
+          Iated.mcp.debug = true
+        end
+        opts.on_tail('-h', '--help', 'Show this help.') do
+          puts opts
+          exit
+        end
+      end
+    end
+    #:nocov:
+    #:nocov:
+    def run
+      @optparse.parse!
+      Iated.mcp.begin!
+    end
+    #:nocov:
+  end
+  # @return [Hash] Sessions
+  def self.sessions
+    # TODO This needs to be replaced with a real persistant data store.
+    @sessions ||= {}
+  end
+  # The current environment
+  # @return [Symbol] Returns one of: `:test`, `:development`, `:production`
+  def self.environment
+    @environment ||= :development
+  end
+  # Set the current environment
+  # @return [Symbol] The symbol set.
+  def self.environment= env
+    if [:test, :development, :production].include? env
+      @environment = env
+      @mcp.prefs.reset unless @mcp.nil?
+    else
+      raise "Invalid Iated::environment specified: #{env.inspect}"
+    end
+  end
+  ## Resets the Master Control Program, Preferences, and Sessions
+  # @return [nil]
+  def self.reset
+    @mcp.prefs.reset unless @mcp.nil?
+    @mcp = nil
+    @sessions = nil
+  end
+  ## Deletes all state from the system
+  # @return [nil]
+  def self.purge
+    dir = self.mcp.prefs.config_dir
+    dir.rmtree if dir.directory?
+  end
+  ## Access to the Master Control Program
+  # @return [Iated::MCP]
+  def self.mcp
+    @mcp ||= Iated::MCP.new
+  end
+end