TextTractor 0.1.0

data/lib/text_tractor/users.rb

@@ -0,0 +1,49 @@
+require 'digest/md5'
+
+module TextTractor
+  module Users
+    class DuplicateUserError < Exception; end
+    
+    def self.redis
+      TextTractor.redis
+    end
+    
+    def self.all
+      redis.smembers("users").collect { |u| JSON.parse(redis.get("users:#{u}")) }.sort { |a, b| a["name"] <=> b["name"] }
+    end
+    
+    def self.exists?(username)
+      redis.sismember("users", username)
+    end
+
+    def self.authenticate(username, password)
+      redis.sismember("user_hashes", hash_user(username, password))
+    end
+    
+    def self.create(attributes = {})
+      attributes = TextTractor.stringify_keys(attributes)
+      
+      password = attributes.delete("password")
+      attributes["superuser"] ||= false
+   
+      if redis.setnx("users:#{attributes["username"]}", attributes.to_json)
+        redis.sadd("users", attributes["username"])
+        redis.sadd("user_hashes", hash_user(attributes["username"], password))
+      else
+        raise DuplicateUserError.new
+      end
+      
+      attributes
+    end
+
+    def self.get(username)
+      raw = redis.get("users:#{username}")
+      return JSON.parse(raw) if raw
+    end
+
+    private
+      def self.hash_user(username, password)
+        Digest::MD5.hexdigest("#{username}.#{password}.#{TextTractor.configuration.salt}")
+      end
+  end
+end

data/lib/text_tractor/users_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe TextTractor::Users do
+  it { should_not be_nil }
+
+  specify { TextTractor::Users.should respond_to(:all) }
+  specify { TextTractor::Users.should respond_to(:authenticate) }
+  specify { TextTractor::Users.should respond_to(:create) }
+  specify { TextTractor::Users.should respond_to(:get) }
+end

data/lib/text_tractor/version.rb

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

data/spec/api_server_spec.rb

@@ -0,0 +1,224 @@
+require 'spec_helper'
+require 'json'
+
+describe "the API server" do
+  def app
+    TextTractor::ApiServer
+  end
+
+  describe "creating and listing projects" do
+    it "allows the creation of a new project, returning the details" do
+      post "/", :name => "Test Project", :api_key => "49032804328090f8sd0fas0jds"
+
+      last_response.should be_ok
+      last_response.body.should == TextTractor::Project.new(
+        name: "Test Project",
+        api_key: "49032804328090f8sd0fas0jds",
+        default_locale: "en"
+      ).to_json
+    end
+
+    it "includes a newly created project in the projects list" do
+      post "/", :name => "Test Project", :api_key => "bob"
+      get "/"
+
+      last_response.body.should == [
+        { name: "Test Project", api_key: "bob", default_locale: "en", users: [] }
+      ].to_json
+    end
+
+    it "rejects a project with the same name as an existing project" do
+      post "/", :name => "Test Project"
+      post "/", :name => "Test Project"
+      
+      last_response.should_not be_ok
+      last_response.status.should eq 422
+      JSON.parse(last_response.body).should == {
+        "error" => "The project name you specified is already in use."
+      }
+    end
+  end
+  
+  let(:example_phrases) do
+    {
+      "en.application.home.title" => "Home Page",
+      "en.application.home.body" => "This is the home page."
+    }
+  end
+  
+  describe "registering draft blurbs for a project" do
+    context "when the project exists" do
+      before(:each) do
+        post "/", :name => "Test Project", :api_key => "test"
+        post "/test/draft_blurbs", example_phrases.to_json
+      end
+
+      it "shows the update was OK" do
+        last_response.should be_ok
+        last_response.body.should == "OK"
+      end
+    end
+
+    context "when the project does not exist" do
+      it "returns a 404 error code" do
+        post "/test/draft_blurbs"
+
+        last_response.status.should eq 404
+      end
+    end
+  end
+
+  describe "returning the draft blurbs for a project" do
+    context "when the project exists" do
+      before(:each) do
+        TextTractor::Projects.create name: "Test Project", api_key: "test"
+
+        # That's the format we get it in from copycopter_client
+        post "/test/draft_blurbs", example_phrases.to_json
+      end
+
+      it "returns all the translations if the ETag does not match" do
+        get "/test/draft_blurbs"
+        
+        last_response.should be_ok
+        JSON.parse(last_response.body).should == example_phrases
+      end
+      
+      it "returns a status code of 302, with an empty body, if the ETag does match" do
+        header "If-None-Match", redis.get("projects:test:draft_blurbs_etag")
+        get "/test/draft_blurbs"
+
+        last_response.status.should eq 304
+        last_response.body.should be_empty
+      end
+      
+      it "does not load the translation list if the ETag matches" do
+        blurbs = stub(:bytesize => 0, :etag => "foo")
+        TextTractor::ApiServer::BlurbList.should_receive(:new).and_return(blurbs)
+        blurbs.should_not_receive(:each)
+        
+        header "If-None-Match", "foo"
+        get "/test/draft_blurbs"
+
+        last_response.status.should eq 304
+        last_response.body.should be_empty
+      end
+
+      it "sets the ETag to be set" do
+        get "/test/draft_blurbs"
+
+        last_response.headers["ETag"].should_not be_nil
+        last_response.headers["ETag"].should == redis.get("projects:test:draft_blurbs_etag")
+      end
+    end
+
+    context "when the project does not exist" do
+      it "returns a 404 error code" do
+        get "/test/draft_blurbs"
+
+        last_response.status.should eq 404
+      end
+    end
+  end
+
+  describe "returning the published blurbs for a project" do
+    context "when the project exists" do
+      before(:each) do
+        TextTractor::Projects.create name: "Test Project", api_key: "test"
+
+        post "/test/published_blurbs", example_phrases.to_json
+      end
+
+      it "returns all the translations if the ETag does not match" do
+        get "/test/published_blurbs"
+        
+        last_response.should be_ok
+        JSON.parse(last_response.body).should == example_phrases
+      end
+      
+      it "returns a status code of 302, with an empty body, if the ETag does match" do
+        header "If-None-Match", redis.get("projects:test:published_blurbs_etag")
+        get "/test/published_blurbs"
+
+        last_response.status.should eq 304
+        last_response.body.should be_empty
+      end
+      
+      it "does not load the translation list if the ETag matches" do
+        blurbs = stub(:bytesize => 0, :etag => "foo")
+        TextTractor::ApiServer::BlurbList.should_receive(:new).and_return(blurbs)
+        blurbs.should_not_receive(:each)
+        
+        header "If-None-Match", "foo"
+        get "/test/published_blurbs"
+
+        last_response.status.should eq 304
+        last_response.body.should be_empty
+      end
+
+      it "sets the ETag to be set" do
+        get "/test/published_blurbs"
+
+        last_response.headers["ETag"].should_not be_nil
+        last_response.headers["ETag"].should == redis.get("projects:test:published_blurbs_etag")
+      end
+    end
+
+    context "when the project does not exist" do
+      it "returns a 404 error code" do
+        get "/test/draft_blurbs"
+
+        last_response.status.should eq 404
+      end
+    end
+  end
+
+  describe "publishing blurbs" do
+    context "when the project does exist" do
+      before(:each) do
+        post "/", :name => "Test Project", :api_key => "test"
+        post "/test/draft_blurbs", example_phrases.to_json
+      end
+
+      it "has a 200 response code" do
+        post "/test/deploys"
+        last_response.status.should eq 200
+      end
+
+      it "marks the draft blurbs as published" do
+        get "/test/published_blurbs"
+        JSON.parse(last_response.body).should be_empty
+
+        post "/test/deploys"
+        get "/test/published_blurbs"
+        JSON.parse(last_response.body).should == example_phrases
+      end
+    end
+
+    context "when the project does not exist" do
+      it "returns a 404 error code" do
+        post "/test/publish"
+        last_response.status.should eq 404
+      end
+    end
+  end
+
+  describe "registering multi-lingual blurbs" do
+    let(:example_phrases) do
+      {
+        "en.application.home.title" => "Home Page",
+        "cy.application.home.title" => "Hafan",
+        "en.application.home.body" => "This is the home page.",
+        "cy.application.home.body" => "Dyma hafan."
+      }
+    end
+
+    it "registers all the translations provided" do
+      post "/", :name => "Test Project", :api_key => "test"
+      post "/test/draft_blurbs", example_phrases.to_json
+      get "/test/draft_blurbs"
+      
+      JSON.parse(last_response.body).should == example_phrases
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe TextTractor::Config do
+  describe "setting the application configuration" do
+    specify { TextTractor.should respond_to(:config) }
+    
+    it "yields an instance of TextTractor::Config" do
+      TextTractor.config.should do |config|
+        config.should be_a TextTractor::Config
+      end
+    end
+  end
+
+  describe "available options" do
+    it { should respond_to(:redis) }
+    it { should respond_to(:default_username) }
+    it { should respond_to(:default_password) }
+    it { should respond_to(:environment) }
+    it { should respond_to(:salt) }
+    it { should respond_to(:hostname) }
+    it { should respond_to(:port) }
+    it { should respond_to(:ssl) }
+    
+    describe "setting the redis option" do
+      it "defaults to an empty hash" do
+        subject.redis.should == {}
+      end
+      
+      it "uses the provided value if it is a Hash" do
+        subject.redis = { :server => "foo" }
+        subject.redis.should == { :server => "foo" }
+      end
+
+      it "extracts the relevant details is it is a String" do
+        subject.redis = "redis://user:password@example.org:1234/namespace"
+        subject.redis.should == {
+          host: "example.org",
+          port: 1234,
+          username: "user",
+          password: "password",
+          ns: "namespace"
+        }
+      end
+    end
+  end
+
+  describe "client configuration options" do
+    it "defaults the port to 80" do
+      subject.port.should eq 80
+    end
+
+    it "defaults ssl to true" do
+      subject.ssl.should eq true
+    end
+  end
+end

data/spec/phrase_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe TextTractor::Phrase do
+  let(:project) { TextTractor::Project.new(default_locale: "en", name: "Test Project", api_key: "test") }
+  subject do
+    TextTractor::Phrase.new(project, {
+      en: { "text" => "An example", "translated_at" => Time.new(2011, 01, 03, 00, 32, 00).to_s }, 
+      cy: { "text" => "An example in Welsh", "translated_at" => Time.new(2011, 01, 03, 00, 12, 00).to_s }
+    })
+  end
+  
+  it "should set the phrase's project" do
+    subject.project.should == project
+  end
+
+  describe "converting to a hash for saving" do
+    specify do
+      subject.to_hash.should == {
+        "en" =>  { "text" => "An example", "translated_at" => Time.new(2011, 01, 03, 00, 32, 00).to_s }, 
+        "cy" =>  { "text" => "An example in Welsh", "translated_at" => Time.new(2011, 01, 03, 00, 12, 00).to_s }
+      }
+    end
+  end
+
+  it { should respond_to(:[]) }
+  it { should respond_to(:[]=) }
+  
+  describe "accessing the individual translations" do
+    it "allows direct access to the translated string" do
+      subject["en"].to_s.should == "An example"
+      subject["cy"].to_s.should == "An example in Welsh"
+    end
+
+    it "allows the translation of a phrase to be set" do
+      subject["cy"] = "A new translation"
+      subject["cy"].to_s.should == "A new translation"
+    end
+
+    it "returns an empty string when the translation has not been made" do
+      subject["de"].to_s.should == ""
+      subject["de"].translated_at.should be_nil
+    end
+  end
+  
+  describe "setting a translation" do
+    before(:each) do
+      Time.stub(:now).and_return(Time.new(2011, 04, 11))
+    end
+
+    it "sets the translation time" do
+      subject["de"] = "Hello!"
+      subject["de"].translated_at.should == Time.new(2011, 04, 11)
+    end
+  end
+
+  describe "translaion states" do
+    it "is considered translated if the default locale was translated before this translation" do
+      subject["cy"].translated_at = subject["en"].translated_at + 40
+      subject["cy"].state.should == :translated
+    end
+
+    it "is considered untranslated if no translation time is set" do
+      subject["de"].state.should == :untranslated
+    end
+
+    it "is considered stale if the translation time is earlier then that on the default locale" do
+      subject["cy"].translated_at = subject["en"].translated_at - 40
+      subject["cy"].state.should == :stale
+    end
+  end
+end

data/spec/project_spec.rb

@@ -0,0 +1,292 @@
+require 'spec_helper'
+
+describe TextTractor::Project do
+  it { should_not be_nil }
+  it { should respond_to :name }
+  it { should respond_to :api_key }
+  it { should respond_to :default_locale }
+  it { should respond_to :users }
+
+  it "defaults the api_key to a random key" do
+    TextTractor::Projects.stub(:random_key).and_return("4") # Chosen by fair dice roll.
+    subject.api_key.should == "4"
+  end
+
+  it "defaults the locale to 'en'" do
+    subject.default_locale.should == "en"
+  end
+
+  it "defaults the users to an empty array" do
+    subject.users.should == []
+  end
+
+  specify { should respond_to(:update_draft_blurbs) }
+  describe "updating the draft blurbs" do
+    before(:each) do
+      Time.stub(:now).and_return(Time.new(2011, 01, 01, 00, 00, 00))
+      
+      @project = TextTractor::Projects.create(name: "Test", api_key: "test")
+      @project.update_draft_blurbs(
+        "en.application.home.title" => "Home Page",
+        "en.application.home.body" => "This is the home page.",
+      )
+    end
+    
+    it "saves the new translations" do
+      JSON.parse(redis.get("projects:test:draft_blurbs:application.home.title")).should == TextTractor::Phrase.new(@project, { 
+        "en" => { "text" => "Home Page", "translated_at" => Time.now.to_s }
+      }).to_hash
+      JSON.parse(redis.get("projects:test:draft_blurbs:application.home.body")).should == TextTractor::Phrase.new(@project, {
+        "en" => { "text" => "This is the home page.", "translated_at" => Time.now.to_s }
+      }).to_hash
+    end
+    
+    it "correctly retains quotes" do
+      @project.update_draft_blurbs(
+        "en.application.home.quoted" => %q{"I would like to test quoting." said Jon.}
+      )
+            
+      JSON.parse(redis.get("projects:test:draft_blurbs:application.home.quoted")).should == TextTractor::Phrase.new(@project, {
+        "en" => { "text" => %q{"I would like to test quoting." said Jon.}, "translated_at" => Time.now.to_s }
+      }).to_hash
+    end
+
+    it "generates a new ETag if the translations have changed" do
+      redis.get("projects:test:draft_blurbs_etag").should_not be_nil
+    end
+
+    it "does not replace the content of existing translations by default" do
+      @project.update_draft_blurbs(
+        "en.application.home.title" => "A different title"
+      )
+
+      JSON.parse(redis.get("projects:test:draft_blurbs:application.home.title")).should == TextTractor::Phrase.new(@project, {
+        "en" => { "text" => "Home Page", "translated_at" => Time.now.to_s }
+      }).to_hash
+    end
+
+    it "replaces the content of existing translations if :overwrite is set" do
+      @project.update_draft_blurbs({
+        "en.application.home.title" => "A different title"
+      }, :overwrite => true)
+      
+      JSON.parse(redis.get("projects:test:draft_blurbs:application.home.title")).should == TextTractor::Phrase.new(@project, {
+        "en" => { "text" => "A different title", "translated_at" => Time.now.to_s }
+      }).to_hash
+    end
+
+    it "does not generate a new ETag if the translations did not change" do
+      previous_etag = redis.get("projects:test:draft_blurbs_etag")
+      
+      @project.update_draft_blurbs(
+        "en.application.home.title" => "A different title"
+      )
+      redis.get("projects:test:draft_blurbs_etag").should == previous_etag
+    end
+  end
+  
+  specify { should respond_to(:draft_blurbs) }
+  describe "getting the draft blurbs for a project" do
+    context "when the project exists" do
+      before(:each) do
+        @project = TextTractor::Projects.create(name: "Test Project", api_key: "test")
+        @project.update_draft_blurbs({
+          "en.application.home.title" => "Home Page",
+          "en.application.home.body" => "This is the home page."
+        })
+      end
+
+      subject { @project.draft_blurbs }
+      
+      it "returns all the translations" do
+        subject.should == {
+          "en.application.home.title" => "Home Page",
+          "en.application.home.body" => "This is the home page."
+        }
+      end
+    end
+  end
+
+  specify { should respond_to(:draft_phrases) }
+  describe "getting the phrase list for a project" do
+    before(:each) do
+      Time.stub(:now).and_return(Time.new(2011, 01, 01, 00, 00, 00))
+      @project = TextTractor::Projects.create(name: "Test Project", api_key: "test")
+      @project.update_draft_blurbs({
+        "en.application.home.title" => "Home Page",
+        "cy.application.home.title" => "Dafan",
+        "en.application.home.body" => "This is the home page."
+      })
+    end
+
+    it "returns the list of phrases, in all known languages" do
+      @project.draft_phrases.inject({}) { |memo, value| memo[value[0]] = value[1].to_hash; memo }.should == {
+        "application.home.title" => TextTractor::Phrase.new(@project, {
+          "en" => { "text" => "Home Page", "translated_at" => Time.now.to_s },
+          "cy" => { "text" => "Dafan", "translated_at" => Time.now.to_s }
+        }).to_hash,
+        "application.home.body" => TextTractor::Phrase.new(@project, {
+          "en" => { "text" => "This is the home page.", "translated_at" => Time.now.to_s }
+        }).to_hash
+      }
+    end
+  end
+
+  specify { should respond_to(:locales) }
+  describe "getting the list of known locales" do
+    before(:each) do
+      @project = TextTractor::Projects.create(name: "Test Project", api_key: "test")
+      @project.update_draft_blurbs({
+        "en.application.home.title" => "Home Page",
+        "cy.application.home.title" => "Dafan",
+        "en.application.home.body" => "This is the home page."
+      })
+    end
+
+    it "returns the known locales" do
+      @project.locales.should == [ "cy", "en" ]
+    end
+  end
+end
+
+describe TextTractor::Projects do
+  specify { TextTractor::Projects.should respond_to(:create) }
+   
+  describe "creating a new project" do
+    context "when succesful" do
+      before(:each) { @project = TextTractor::Projects.create name: "Test Project", api_key: "49032804328090f8sd0fas0jds", users: [ "jon@blankpad.net", "bob@example.org" ] }
+      subject { @project }
+       
+      it "returns the details as a project instance" do
+        subject.should be_instance_of TextTractor::Project
+
+        subject.name.should == "Test Project"
+        subject.api_key.should == "49032804328090f8sd0fas0jds"
+      end
+      
+      it "saves the projects details for later use" do
+        TextTractor.redis.get("projects:49032804328090f8sd0fas0jds").should == subject.to_json
+      end
+      
+      it "adds the API key to the project index" do
+        TextTractor.redis.sismember("projects", "49032804328090f8sd0fas0jds").should be_true
+      end
+
+      it "places the project name in a set for quick reference" do
+        TextTractor.redis.sismember("project_names", "Test Project").should be_true
+      end
+
+      it "assigns any provided users to the project" do
+        TextTractor.redis.sismember("project_users:49032804328090f8sd0fas0jds", "bob@example.org").should be_true
+        TextTractor.redis.sismember("project_users:49032804328090f8sd0fas0jds", "jon@blankpad.net").should be_true
+      end
+    end
+
+    it "rejects a project with the same name as an existing project" do
+      TextTractor::Projects.create name: "Test Project"
+      
+      lambda { TextTractor::Projects.create name: "Test Project" }.should raise_error(TextTractor::Projects::DuplicateProjectName)
+    end
+  end
+
+  describe "getting an existing project" do
+    it "returns the project on success" do
+      TextTractor::Projects.create name: "Test Project", api_key: "test"
+
+      project = TextTractor::Projects.get("test")
+      project.should be_instance_of TextTractor::Project
+      project.name.should == "Test Project"
+      project.api_key.should == "test"
+    end
+
+    it "returns nil if the project did not exist" do
+      TextTractor::Projects.get("test").should be_nil
+    end
+  end
+
+  describe "listing projects for a user" do
+    before(:each) do
+      TextTractor::Projects.create(name: "Assigned Project", users: [ "example" ])
+      TextTractor::Projects.create(name: "Unassigned Project")
+    end
+    
+    let(:user) do
+      { "username" => "example",
+        "superuser" => false }
+    end
+    
+    specify { TextTractor::Projects.should respond_to(:for_user) }
+    
+    it "returns all projects if the user is a superuser" do
+      user["superuser"] = true
+      projects = TextTractor::Projects.for_user(user)
+      
+      projects.should have(2).projects
+      projects.first["name"].should eq "Assigned Project"
+      projects.last["name"].should eq "Unassigned Project"
+    end
+
+    it "returns only projects the user has been added to for standard users" do
+      user["superuser"] = false
+      projects = TextTractor::Projects.for_user(user)
+      
+      projects.should have(1).project
+      projects.first["name"].should eq "Assigned Project"
+    end
+  end
+
+  specify { TextTractor::Projects.should respond_to(:authorised?) }
+  describe "checking authorisation for a project" do
+    before(:each) do
+      TextTractor::Projects.create(name: "Test", api_key: "test", users: [ "bob@example.org" ])
+    end
+
+    it "returns true if the user is a super user" do
+      TextTractor::Projects.authorised?({ "superuser" => true }, "test")
+    end
+
+    it "returns true if the user is in the list of assigned users for the project" do
+      TextTractor::Projects.authorised?({ "superuser" => false, "username" => "bob@example.org" }, "test")
+    end
+    
+    it "returns false if the user is not in the list of assigned users for the project" do
+      TextTractor::Projects.authorised?({ "superuser" => false, "username" => "frank@example.org" }, "test")
+    end
+  end
+  
+  specify { TextTractor::Projects.should respond_to(:update_datastore) }
+  describe "migrating a data store to the current version" do
+    before(:each) do
+      Time.stub(:now).and_return(Time.new(2011, 01, 01, 00, 00, 00))
+      TextTractor::Projects.create(name: "Test", api_key: "test")
+      
+      redis.set("projects:test:draft_blurbs:en.application.home.title", "Home page")
+      redis.sadd("projects:test:draft_blurb_keys", "en.application.home.title")
+      redis.set("projects:test:draft_blurbs:cy.application.home.title", "Hafan")
+      redis.sadd("projects:test:draft_blurb_keys", "cy.application.home.title")
+      redis.set "projects:test:draft_blurbs_etag", "old_etag"
+
+      TextTractor::Projects.update_datastore
+    end
+
+    it "updates the ETag" do
+      redis.get("projects:test:draft_blurbs_etag").should_not == "old_etag"
+    end
+
+    it "places all translations of a phrase under one key" do
+      redis.sismember("projects:test:draft_blurb_keys", "application.home.title").should be_true
+      redis.get("projects:test:draft_blurbs:application.home.title").should == {
+        "en" => { "text" => "Home page", "translated_at" => Time.now.to_s },
+        "cy" => { "text" => "Hafan", "translated_at" => Time.now.to_s }
+      }.to_json
+    end
+
+    it "removes the old blurbs" do
+      redis.sismember("projects:test:draft_blurb_keys", "en.application.home.title").should_not be_true
+      redis.sismember("projects:test:draft_blurb_keys", "cy.application.home.title").should_not be_true
+
+      redis.get("projects:test:draft_blurbs:en.application.home.title").should be_nil
+      redis.get("projects:test:draft_blurbs:cy.application.home.title").should be_nil
+    end
+  end
+end