TextTractor 0.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+require 'rspec'
+require 'rack/test'
+require 'capybara/rspec'
+require 'text_tractor'
+require 'redis'
+
+TextTractor.config do |c|
+  c.redis = {
+    ns: "text_tractor:test",
+    db: 8
+  }
+
+  c.environment = :test
+  c.hostname = "example.host"
+  c.port = 8000
+  c.ssl = false
+end
+
+RSpec.configure do |conf|
+  conf.include Rack::Test::Methods
+  conf.include Capybara
+  
+  conf.before(:each) do
+    redis.flushdb
+  end
+  
+  def redis
+    TextTractor.redis
+  end
+
+  def app
+    TextTractor.application
+  end
+  Capybara.app = app
+  
+  def login(username = nil, password = nil)
+    username ||= TextTractor.configuration.default_username
+    password ||= TextTractor.configuration.default_password
+    
+    basic_authorize username, password
+    Capybara.current_session.driver.basic_authorize username, password
+  end
+  
+  def create_user(username, password, superuser = false)
+    TextTractor::Users.create(name: username, username: username, password: password, superuser: superuser)
+  end
+
+  def create_superuser(username, password)
+    create_user(username, password, true)
+  end
+end

data/spec/ui_server/authentication_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe "authentication", :type => :request do
+  it "rejects the request if no authentication was provided" do
+    get "/"
+    last_response.status.should eq 401
+  end
+  
+  it "allows access if logging in with the default credentials" do
+    TextTractor.configuration.default_username = "admin"
+    TextTractor.configuration.default_password = "password"
+    
+    basic_authorize "admin", "password"
+    
+    get "/"
+    last_response.status.should eq 200
+  end
+
+  describe "managing users" do
+    it "denies access to user who is not a superuser" do
+      create_user "bob@example.org", "p@ssw0rd"
+      login "bob@example.org", "p@ssw0rd"
+
+      visit "/"
+      page.should_not have_content "Users"
+
+      visit "/users"
+      Capybara.current_session.status_code.should eq 403
+    end
+
+    it "allows access to the default user" do
+      login
+
+      visit "/"
+      click_link "Users"
+      
+      page.should have_content "User Management"
+      page.should have_content "Default User"
+    end
+
+    it "allows the creation of a new user" do
+      login
+
+      visit "/users"
+
+      page.should have_content "Create a User"
+
+      fill_in "Username", :with => "bob@example.org"
+      fill_in "Name", :with => "Bob Hoskins"
+      fill_in "Password", :with => "p@ssw0rd"
+      click_button "Create User"
+      
+      page.should have_content "Bob Hoskins"
+
+      login "bob@example.org", "p@ssw0rd"
+      visit "/"
+      Capybara.current_session.status_code.should eq 200
+    end
+  end
+end

data/spec/ui_server/project_management_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe "project management" do
+  context "as a superuser" do
+    before(:each) do
+      create_superuser "jim@example.org", "password"
+      login "jim@example.org", "password"
+    end
+    
+    it "it lists all projects" do
+      TextTractor::Projects.create(name: "Test Project")
+      TextTractor::Projects.create(name: "User Specified Project", users: [ "jim@example.org" ])
+
+      visit '/'
+      page.should have_content "Test Project"
+      page.should have_content "User Specified Project"
+    end
+    
+    it "it allows a new project to be created" do
+      visit '/'
+      page.should have_content "Create a Project"
+
+      click_link "Create a Project"
+
+      fill_in "Project Name", :with => "Example Project"
+      fill_in "Default Locale", :with => "cy" # Hell yeah, we're doing this site in Welsh.
+      check "jim@example.org"
+      click_button "Create Project"
+
+      page.should have_content "Example Project (cy)"
+    end
+    
+    it "defaults the locale to 'en'" do
+      visit '/projects/new'
+      find_field("Default Locale").value.should == "en"
+    end
+
+    it "allows access to a project the user has been explicitly added to" do
+      project = TextTractor::Projects.create(name: "User Specified Project", users: [ "jim@example.org" ])
+      
+      get "/projects/#{project["api_key"]}"
+      last_response.status.should eq 200
+    end
+
+    it "allows access to a project the user has not been added to" do
+      project = TextTractor::Projects.create(name: "User Specified Project")
+      
+      get "/projects/#{project["api_key"]}"
+      last_response.status.should eq 200
+    end
+  end
+
+  context "as a normal user" do
+    before(:each) do
+      TextTractor::Projects.create(name: "Test Project", api_key: "test")
+      TextTractor::Projects.create(name: "User Specified Project", api_key: "user", users: [ "bob@example.org" ])
+      
+      create_user "bob@example.org", "password"
+      login "bob@example.org", "password"
+    end
+
+    it "denies access to create a new project" do
+      visit '/'
+      page.should_not have_content "Create a Project"
+
+      get '/projects/new'
+      last_response.status.should eq 403
+    end
+    
+    it "lists only the projects the user has been added to" do
+      visit '/'
+      page.should have_content "User Specified Project"
+      page.should_not have_content "Test Project"
+    end
+
+    it "allows access to a project the user has been added to" do
+      get '/projects/user'
+      last_response.status.should eq 200
+    end
+
+    it "denies access to project the user has not been added to" do
+      get '/projects/test'
+      last_response.status.should eq 403
+    end
+  end
+
+  context "when not logged in" do
+    it "denies access to the project list" do
+      get "/"
+      last_response.status.should eq 401
+    end
+
+    it "denies access to create a new project" do
+      post "/"
+      last_response.status.should eq 401
+    end
+
+    it "denies access to view a project" do
+      get "/projects/test"
+      last_response.status.should eq 401
+    end
+  end
+end

data/spec/ui_server/project_viewing_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+
+describe "working with a project", :type => :request do
+  before(:each) do
+    @project = TextTractor::Projects.create(name: "Test Project", api_key: "test")
+
+    login
+  end
+
+  context "when the project has had no blurbs added to it" do
+    it "displays some advice on adding it to your project, including the API key" do
+      visit '/projects/test'
+
+      page.should have_content %q{config.api_key = "test"}
+      page.should have_content %q{config.host = "example.host"}
+      page.should have_content %q{config.port = 8000}
+      page.should have_content %q{config.secure = false}
+    end
+  end
+
+  context "when the project has had some blurbs added to it" do
+    before(:each) do
+      @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 "allows the locale to be selected" do
+      visit '/projects/test'
+      within "ul#locales" do
+        page.should have_content "cy"
+        page.should have_content "en"
+      end
+
+      click_link "cy"
+      page.should have_content "Test Project (cy)"
+    end
+
+    it "displays a list of all the known blurbs in the default locale on the project index" do
+      visit '/projects/test'
+      page.should have_content "Application / Home / Title"
+      page.should have_content "Home Page"
+    end
+    
+    it "displays a list of all the known blurbs in the selected locale if one was set" do
+      visit '/projects/test/cy'
+      
+      page.should have_content "Application / Home / Title"
+      page.should have_content "Dafan"
+    end
+    
+    it "displays the original version of each blurb if the default locale is not selected" do
+      visit '/projects/test/cy'
+      find('dd[data-key="application.home.title"] p.original').should have_content "Home Page"
+    end
+
+    it "displays 'Click to add a translation' if no translation has been provided" do
+      visit '/projects/test/cy'
+      find('dd[data-key="application.home.body"] p.translation').should have_content "Click to add a translation"
+    end
+
+    it "updates the blurb content on a POST" do
+      post "/projects/test/en/application/home/title", :blurb => "Test"
+
+      @project.draft_blurbs["en.application.home.title"].should == "Test"
+    end
+
+    it "displays the form for editing on a GET" do
+      visit "/projects/test/en/application/home/title"
+      
+      page.find("form")["action"].should == "/projects/test/en/application/home/title"
+      within("textarea[name='blurb']") do
+        page.should have_content "Home Page"
+      end
+    end
+
+    context "when filtering to a specific state" do
+      before(:each) do
+        Time.stub(:now).and_return(Time.new(2011, 01, 01, 00, 00, 00))
+        @project.update_draft_blurbs({
+          "en.application.untranslated" => "Hello",
+          "en.application.translated" => "Hello",
+          "cy.application.translated" => "Foo",
+          "en.application.stale" => "Hello",
+          "cy.application.stale" => "Foo"
+        })
+
+        Time.stub(:now).and_return(Time.new(2011, 01, 01, 00, 00, 30))
+        @project.update_draft_blurbs({
+          "en.application.stale" => "Hello world"
+        }, overwrite: true)
+      end
+
+      it "shows all phrases if no filter was set" do
+        visit "/projects/test/cy"
+
+        page.should have_content "Application / Untranslated"
+        page.should have_content "Application / Translated"
+        page.should have_content "Application / Stale"
+      end
+
+      it "shows only untranslated phrases if the Untranslated filter was set" do
+        visit "/projects/test/cy?state=untranslated"
+
+        page.should have_content "Application / Untranslated"
+        page.should_not have_content "Application / Translated"
+        page.should_not have_content "Application / Stale"
+      end
+
+      it "shows only untranslated and stale phrases if the Needs Work filter was set" do
+        visit "/projects/test/cy?state=needs_work"
+
+        page.should have_content "Application / Untranslated"
+        page.should_not have_content "Application / Translated"
+        page.should have_content "Application / Stale"
+      end
+
+      it "shows only stale phrases if the Stale filter was set" do
+        visit "/projects/test/cy?state=stale"
+
+        page.should_not have_content "Application / Untranslated"
+        page.should_not have_content "Application / Translated"
+        page.should have_content "Application / Stale"
+      end
+
+      it "shows only translated phrases if the Translated filter was set" do
+        visit "/projects/test/cy?state=translated"
+
+        page.should_not have_content "Application / Untranslated"
+        page.should_not have_content "Application / Stale"
+        page.should have_content "Application / Translated"
+      end
+    end
+  end
+end

data/spec/ui_server_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'json'
+
+describe "the UI server" do
+  subject { TextTractor::UiServer.new }
+end

data/spec/users_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+describe TextTractor::Users do
+  it { should_not be_nil }
+
+  specify { TextTractor::Users.should respond_to(:create) }
+  describe "creating a new user" do
+    before(:each) do
+      TextTractor::Users.create(username: "test", password: "example", name: "Test User", superuser: true)
+    end
+    
+    it "adds the user's details to Redis" do
+      JSON.parse(TextTractor.redis.get("users:test")).should == {
+        "username" => "test",
+        "name" => "Test User",
+        "superuser" => true
+      }
+    end
+    
+    it "adds the user's username to the list of users" do
+      TextTractor.redis.sismember("users", "test").should be_true
+    end
+
+    it "adds the user's hash for authentication" do
+      TextTractor.redis.sismember("user_hashes", TextTractor::Users.hash_user("test", "example")).should be_true
+    end
+
+    it "defaults superuser to false" do
+      TextTractor::Users.create(username: "foo", password: "example", name: "Test User")
+      JSON.parse(TextTractor.redis.get("users:foo")).should == {
+        "username" => "foo",
+        "name" => "Test User",
+        "superuser" => false
+      }
+    end
+
+    it "raises an Users::DuplicateUserError if the username is already in use" do
+      lambda { TextTractor::Users.create(username: "test", password: "example", name: "Test User") }.should raise_error(TextTractor::Users::DuplicateUserError)
+    end
+  end
+
+  specify { TextTractor::Users.should respond_to(:all) }
+  describe "getting the full list of users" do
+    before(:each) do
+      @user1 = TextTractor::Users.create(username: "test", password: "example", name: "Test User", superuser: false)
+      @user2 = TextTractor::Users.create(username: "jon", password: "test", name: "Jon Wood", superuser: true)
+    end
+    
+    subject { TextTractor::Users.all }
+
+    it "includes all the users" do
+      subject.should have(2).users
+    end
+
+    it "doesn't include the password for a user" do
+      subject.first.should_not have_key("password")
+    end
+
+    it "includes all other details" do
+      subject.should == [
+        { "username" => "jon", "name" => "Jon Wood", "superuser" => true },
+        { "username" => "test", "name" => "Test User", "superuser" => false },
+      ]
+    end
+
+    it "sorts users alphabetically by their name" do
+      subject.first["name"].should eq "Jon Wood"
+      subject.last["name"].should eq "Test User"
+    end
+  end
+
+  specify { TextTractor::Users.should respond_to(:authenticate) }
+  describe "authenticating a user" do
+    before(:each) do
+      TextTractor::Users.create(username: "test", password: "example", name: "Test User")
+    end
+
+    it "returns true if the user and password match" do
+      TextTractor::Users.authenticate("test", "example").should be_true
+    end
+
+    it "returns false if only the user matches" do
+      TextTractor::Users.authenticate("test", "wrong").should be_false
+    end
+
+    it "returns false if only the password matches" do
+      TextTractor::Users.authenticate("wrong", "example").should be_false
+    end
+
+    it "returns false if neither attributes match" do
+      TextTractor::Users.authenticate("wrong", "wrong").should be_false
+    end
+  end
+
+  specify { TextTractor::Users.should respond_to(:get) }
+  describe "loading a user" do
+    before(:each) do
+      TextTractor::Users.create(username: "test", password: "example", name: "Test User")
+    end
+
+    it "returns the user's details if they exist" do
+      TextTractor::Users.get("test").should == {
+        "username" => "test",
+        "name" => "Test User",
+        "superuser" => false
+      }
+    end
+
+    it "returns nil if they do not exist" do
+      TextTractor::Users.get("bob").should be_nil
+    end
+  end
+
+  specify { TextTractor::Users.should respond_to(:exists?) }
+  describe "checking the existance of a user" do
+    before(:each) do
+      TextTractor::Users.create(username: "test", password: "example", name: "Test User")
+    end
+    
+    specify { TextTractor::Users.exists?("test").should be_true }
+    specify { TextTractor::Users.exists?("other").should be_false }
+  end
+end