copycopter_client 1.0.0.beta1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.textile

@@ -0,0 +1,71 @@
+h1. Copycopter Client
+
+This is the client gem for integrating apps with "Copycopter":http://copycopter.com.
+
+The client integrates with the I18n gem so that you can access copy text and translations from a Copycopter project.
+
+h2. Installation
+
+Just install the gem:
+
+<pre>gem install copycopter_client</pre>
+
+h3. Rails 3
+
+Add the following line to your <code>Gemfile</code>:
+
+<pre>gem "copycopter_client"</pre>
+
+Then run <code>bundle install</code>.
+
+h3. Rails 2
+
+Add the following line to your <code>config/environment.rb</code>:
+
+<pre>config.gem 'copycopter_client'</pre>
+
+Then run <code>rake gems:install</code>. We also recommend vendoring the gem by running <code>rake gems:unpack:dependencies GEM=copycopter_client</code>.
+
+h2. Configuration
+
+Add the following to your application:
+
+<pre>
+CopycopterClient.configure do |config|
+  config.api_key = "YOUR API KEY HERE"
+end
+</pre>
+
+In a Rails application, this should be saved as <code>config/initializers/copycopter.rb</code>. You can find the API key on the project page on the Copycopter website. See the {CopycopterClient::Configuration} class for a full list of configuration options.
+
+h2. Usage
+
+You can access blurbs from Copycopter by using <code>I18n.translate</code>. This is also aliased as <code>translate</code> or just <code>t</code> inside Rails controllers and views.
+
+<pre>
+# In a controller
+def index
+  flash[:success] = t("users.create.success", :default => "User created")
+end
+
+# In a view
+<%= t(".welcome", :default => "Why hello there") %>
+
+# Global scope (for example, in a Rake task)
+I18n.translate("system.tasks_complete", :default => "Tasks complete")
+
+# Interpolation
+I18n.translate("mailer.welcome", :default => "Welcome, %{name}!", :name => @user.name)
+</pre>
+
+See the "I18n documentation":http://rdoc.info/github/svenfuchs/i18n/master/file/README.textile documentation for more examples.
+
+h2. Deploys
+
+Blurbs start out as draft copy, and won't be displayed in production environments until they're published. If you want to publish all draft copy when deploying to production, you can use the <code>copycopter:deploy</code> rake task:
+
+<pre>rake copycopter:deploy</pre>
+
+h2. About
+
+Copyright (c) 2010 "thoughtbot, inc.":http://thoughtbot.com, released under the MIT license

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'appraisal'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'cucumber/rake/task'
+require 'spec/rake/spectask'
+require 'yard'
+
+desc 'Default: run the specs and features.'
+task :default => :spec do
+  system("rake -s appraisal cucumber;")
+end
+
+desc 'Test the copycopter_client plugin.'
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/copycopter_client/**/*_spec.rb']
+end
+
+desc "Run cucumber features"
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = ['--tags', '~@wip',
+                     '--format', (ENV['CUCUMBER_FORMAT'] || 'progress')]
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+end
+
+eval("$specification = begin; #{IO.read('copycopter_client.gemspec')}; end")
+Rake::GemPackageTask.new($specification) do |package|
+  package.need_zip = true
+  package.need_tar = true
+end
+

data/features/rails.feature

@@ -0,0 +1,267 @@
+@disable-bundler @puts @announce
+Feature: Using copycopter in a rails app
+
+  Background:
+    Given I have a copycopter project with an api key of "abc123"
+    When I generate a rails application
+    And I configure the copycopter client with api key "abc123"
+
+  Scenario: copycopter in the controller
+    Given the "abc123" project has the following blurbs:
+      | key                            | draft content  |
+      | en.users.index.controller-test | This is a test |
+    When I write to "app/controllers/users_controller.rb" with:
+    """
+    class UsersController < ActionController::Base
+      def index
+        @text = t("users.index.controller-test", :default => "default")
+      end
+    end
+    """
+    When I route the "users" resource
+    And I write to "app/views/users/index.html.erb" with:
+    """
+    <%= @text %>
+    """
+    When I start the application
+    And I wait for changes to be synchronized
+    Then the copycopter client version and environment should have been logged
+    Then the log should contain "Downloaded translations"
+    When I visit /users/
+    Then the response should contain "This is a test"
+    And the log should not contain "DEPRECATION WARNING"
+
+  Scenario: copycopter in the view
+    Given the "abc123" project has the following blurbs:
+      | key                      | draft content  |
+      | en.users.index.view-test | This is a test |
+    When I write to "app/controllers/users_controller.rb" with:
+    """
+    class UsersController < ActionController::Base
+      def index
+        render
+      end
+    end
+    """
+    When I route the "users" resource
+    And I write to "app/views/users/index.html.erb" with:
+    """
+    <%= t(".view-test", :default => "default") %>
+    """
+    When I start the application
+    And I wait for changes to be synchronized
+    And I visit /users/
+    Then the response should contain "This is a test"
+
+  Scenario: copycopter detects updates to copy
+    Given the "abc123" project has the following blurbs:
+      | key                            | draft content |
+      | en.users.index.controller-test | Old content   |
+    When I write to "app/controllers/users_controller.rb" with:
+    """
+    class UsersController < ActionController::Base
+      def index
+        @text = t("users.index.controller-test", :default => "default")
+      end
+    end
+    """
+    When I route the "users" resource
+    And I write to "app/views/users/index.html.erb" with:
+    """
+    <%= @text %>
+    """
+    When I start the application
+    And I wait for changes to be synchronized
+    And I visit /users/
+    Then the response should contain "Old content"
+    When the the following blurbs are updated in the "abc123" project:
+      | key                            | draft content |
+      | en.users.index.controller-test | New content   |
+    And I wait for changes to be synchronized
+    And I visit /users/
+    Then the response should contain "New content"
+
+  Scenario: missing key
+    When I write to "app/controllers/users_controller.rb" with:
+    """
+    class UsersController < ActionController::Base
+      def index
+        render :action => "index"
+      end
+    end
+    """
+    When I route the "users" resource
+    And I write to "app/views/users/index.html.erb" with:
+    """
+    <%= t(".404", :default => "not found") %>
+    """
+    When I start the application
+    And I visit /users/
+    Then the response should contain "not found"
+    When I wait for changes to be synchronized
+    Then the "abc123" project should have the following blurbs:
+      | key                | draft content |
+      | en.users.index.404 | not found     |
+    And the log should contain "Uploaded missing translations"
+
+  Scenario: copycopter in production
+    Given the "abc123" project has the following blurbs:
+      | key                            | published content | draft content |
+      | en.users.index.controller-test | This is a test    | Extra extra   |
+    When I write to "app/controllers/users_controller.rb" with:
+    """
+    class UsersController < ActionController::Base
+      def index
+        @text = t("users.index.controller-test", :default => "default")
+      end
+    end
+    """
+    When I route the "users" resource
+    And I write to "app/views/users/index.html.erb" with:
+    """
+    <%= @text %>
+    """
+    When I configure the copycopter client to use published data
+    And I start the application
+    And I wait for changes to be synchronized
+    And I visit /users/
+    Then the response should contain "This is a test"
+
+  Scenario: backwards compatibility
+    Given the "abc123" project has the following blurbs:
+      | key                            | draft content    |
+      | en.users.index.controller-test | Controller blurb |
+      | en.users.index.view-test       | View blurb       |
+    When I write to "app/controllers/users_controller.rb" with:
+    """
+    class UsersController < ActionController::Base
+      def index
+        @text = s('.controller-test')
+        render
+      end
+    end
+    """
+    When I route the "users" resource
+    And I write to "app/views/users/index.html.erb" with:
+    """
+    <%= @text %>
+    <%= s(".view-test", "default") %>
+    """
+    When I start the application
+    And I wait for changes to be synchronized
+    And I visit /users/
+    Then the response should contain "Controller blurb"
+    And the response should contain "View blurb"
+
+  Scenario: configure a bad api key
+    When I configure the copycopter client with api key "bogus"
+    And I start the application
+    And I wait for changes to be synchronized
+    Then the log should contain "Invalid API key: bogus"
+
+  Scenario: deploy
+    Given the "abc123" project has the following blurbs:
+      | key      | draft content | published content |
+      | test.one | expected one  | unexpected one    |
+      | test.two | expected two  | unexpected two    |
+    When I successfully rake "copycopter:deploy"
+    Then the "abc123" project should have the following blurbs:
+      | key      | draft content | published content |
+      | test.one | expected one  | expected one      |
+      | test.two | expected two  | expected two      |
+
+  Scenario: fallback on the simple I18n backend
+    When I write to "config/locales/en.yml" with:
+    """
+    en:
+      test:
+        key: Hello, %{name}
+    """
+    When I write to "app/controllers/users_controller.rb" with:
+    """
+    class UsersController < ActionController::Base
+      def index
+      render :text => t("test.key", :name => 'Joe')
+      end
+    end
+    """
+    When I route the "users" resource
+    And I start the application
+    And I visit /users/
+    Then the response should contain "Hello, Joe"
+    When I wait for changes to be synchronized
+    Then the "abc123" project should have the following blurbs:
+      | key         | draft content  |
+      | en.test.key | Hello, %{name} |
+
+  Scenario: preserve localization keys
+    When I write to "app/controllers/users_controller.rb" with:
+    """
+    class UsersController < ActionController::Base
+      def index
+        render
+      end
+    end
+    """
+    When I route the "users" resource
+    And I write to "app/views/users/index.html.erb" with:
+    """
+    <%= number_to_currency(2.5) %>
+    """
+    When I start the application
+    And I visit /users/
+    Then the response should contain "$2.50"
+    When I wait for changes to be synchronized
+    Then the "abc123" project should not have the "en.number.format" blurb
+
+  Scenario: view validation errors
+    When I write to "app/models/user.rb" with:
+    """
+    class User < ActiveRecord::Base
+      validates_presence_of :name
+    end
+    """
+    When I write to "db/migrate/1_create_users.rb" with:
+      """
+      class CreateUsers < ActiveRecord::Migration
+        def self.up
+          create_table :users do |t|
+            t.string :name
+          end
+        end
+      end
+      """
+    When I write to "app/controllers/users_controller.rb" with:
+    """
+    class UsersController < ActionController::Base
+      def index
+        @user = User.new
+        @user.valid?
+        render
+      end
+    end
+    """
+    When I route the "users" resource
+    And I write to "app/views/users/index.html.erb" with:
+    """
+    <%= @user.errors.full_messages.first %>
+    """
+    When I successfully rake "db:migrate"
+    And I configure the copycopter client to use published data
+    And I start the application
+    And I visit /users/
+    Then the response should contain "Name can't be blank"
+    When I wait for changes to be synchronized
+    Then the "abc123" project should have the following error blurbs:
+      | key                        | draft content  |
+      | user.attributes.name.blank | can't be blank |
+
+
+  Scenario: ensure keys are synced with short lived processes
+    When I configure the copycopter client to have a polling delay of 86400 seconds
+    And I start the application
+    And I run a short lived process that sets the key "threaded.key" to "all your base"
+    Then the "abc123" project should have the following blurbs:
+      | key             | draft content |
+      | en.threaded.key | all your base |
+

data/features/step_definitions/copycopter_server_steps.rb

@@ -0,0 +1,65 @@
+require File.join(PROJECT_ROOT, "spec", "support", "fake_copycopter_app")
+
+Given /^I have a copycopter project with an api key of "([^"]*)"$/ do |api_key|
+  FakeCopycopterApp.add_project api_key
+end
+
+Given /^the "([^"]*)" project has the following blurbs:$/ do |api_key, table|
+  project = FakeCopycopterApp.project(api_key)
+  table.hashes.each do |blurb_hash|
+    key = blurb_hash['key']
+    data = { 'draft'     => { key => blurb_hash['draft content'] },
+             'published' => { key => blurb_hash['published content'] } }
+    project.update(data)
+  end
+end
+
+When /^the the following blurbs are updated in the "([^"]*)" project:$/ do |api_key, table|
+  Given %{the "#{api_key}" project has the following blurbs:}, table
+end
+
+Then /^the "([^"]*)" project should have the following blurbs:$/ do |api_key, table|
+  project = FakeCopycopterApp.project(api_key)
+  table.hashes.each do |blurb_hash|
+    key = blurb_hash['key']
+
+    if blurb_hash['draft content']
+      unless project.draft[key] == blurb_hash['draft content']
+        raise "Expected #{blurb_hash['draft content']} for #{key} but got #{project.draft[key]}\nExisting keys: #{project.draft.inspect}"
+      end
+    end
+
+    if blurb_hash['published content']
+      unless project.published[key] == blurb_hash['published content']
+        raise "Expected #{blurb_hash['published content']} for #{key} but got #{project.published[key]}\nExisting keys: #{project.published.inspect}"
+      end
+    end
+  end
+end
+
+Then /^the "([^"]*)" project should have the following error blurbs:$/ do |api_key, table|
+  prefix = 'en.activerecord.errors.models'
+
+  rows = table.hashes.map do |error_blurb|
+    "| #{prefix}.#{error_blurb['key']} | #{error_blurb['draft content']} |"
+  end
+
+  steps %{
+    Then the "#{api_key}" project should have the following blurbs:
+      | key | draft content  |
+      #{rows.join("\n")}
+  }
+end
+
+Then /^the "([^"]*)" project should not have the "([^"]*)" blurb$/ do |api_key, blurb_key|
+  project = FakeCopycopterApp.project(api_key)
+  project.draft[blurb_key].should be_nil
+end
+
+When /^I wait for changes to be synchronized$/ do
+  sleep(3)
+end
+
+FakeCopycopterApp.start
+After { FakeCopycopterApp.reset }
+

data/features/step_definitions/rails_steps.rb

@@ -0,0 +1,134 @@
+When "I generate a rails application" do
+  if Rails::VERSION::MAJOR == 3
+    subcommand = 'new'
+  else
+    subcommand = ''
+  end
+
+  run_simple("rails _#{Rails::VERSION::STRING}_ #{subcommand} testapp")
+  cd("testapp")
+
+  if Rails::VERSION::MAJOR == 3
+    append_to_file("Gemfile", <<-GEMS)
+      gem "thin"
+      gem "sham_rack"
+      gem "sinatra"
+      gem "json"
+    GEMS
+  end
+end
+
+When /^I configure the copycopter client with api key "([^"]*)"$/ do |api_key|
+  create_file("config/initializers/copycopter.rb", <<-RUBY)
+    CopycopterClient.configure do |config|
+      config.api_key = "#{api_key}"
+      config.polling_delay = 1
+      config.host = 'localhost'
+      config.port = #{FakeCopycopterApp.port}
+    end
+  RUBY
+
+  if Rails::VERSION::MAJOR == 3
+    append_to_file("Gemfile", <<-GEMS)
+      gem "copycopter_client", :path => "../../.."
+    GEMS
+  else
+    in_current_dir { FileUtils.rm_f("vendor/plugins/copycopter") }
+    run_simple("ln -s #{PROJECT_ROOT} vendor/plugins/copycopter")
+  end
+end
+
+When "I start the application" do
+  in_current_dir do
+    RailsServer.start(ENV['RAILS_PORT'], @announce_stderr)
+  end
+end
+
+When /^I visit (\/.*)$/ do |path|
+  @last_response = RailsServer.get(path)
+end
+
+When /^I configure the copycopter client to use published data$/ do
+  in_current_dir do
+    config_path = "config/initializers/copycopter.rb"
+    contents = IO.read(config_path)
+    contents.sub!("end", "  config.development_environments = []\nend")
+    File.open(config_path, "w") { |file| file.write(contents) }
+  end
+end
+
+When /^I configure the copycopter client to have a polling delay of (\d+) seconds$/ do |polling_delay|
+  in_current_dir do
+    config_path = "config/initializers/copycopter.rb"
+    contents = IO.read(config_path)
+    contents.sub!(/config.polling_delay = .+/, "config.polling_delay = #{polling_delay}")
+    File.open(config_path, "w") { |file| file.write(contents) }
+  end
+end
+
+Then /^the copycopter client version and environment should have been logged$/ do
+  client_version = CopycopterClient::VERSION
+  environment_info = "[Ruby: #{RUBY_VERSION}]"
+  environment_info << " [Rails: #{Rails::VERSION::STRING}]"
+  environment_info << " [Env: development]"
+  steps %{
+    Then the log should contain "Client #{client_version} ready"
+    Then the log should contain "Environment Info: #{environment_info}"
+  }
+end
+
+Then /^the log should contain "([^"]*)"$/ do |line|
+  prefix = "** [Copycopter] "
+  pattern = Regexp.compile([Regexp.escape(prefix), Regexp.escape(line)].join(".*"))
+  log_path = "log/development.log"
+  in_current_dir do
+    File.open(log_path) do |file|
+      unless file.readlines.any? { |file_line| file_line =~ pattern }
+        raise "In log file:\n#{IO.read(log_path)}\n\nMissing line:\n#{pattern}"
+      end
+    end
+  end
+end
+
+Then /^the log should not contain "([^"]*)"$/ do |line|
+  log_path = "log/development.log"
+  in_current_dir do
+    File.open(log_path) do |file|
+      if bad_line = file.readlines.detect { |file_line| file_line.include?(line) }
+        raise "In log file:\n#{log_path}\n\nGot unexpected line:\n#{bad_line}"
+      end
+    end
+  end
+end
+
+When /^I successfully rake "([^"]*)"$/ do |task|
+  run_simple("rake #{task}")
+end
+
+Then /^the response should contain "([^"]+)"$/ do |text|
+  @last_response.body.should include(text)
+end
+
+When /^I route the "([^"]+)" resource$/ do |resource|
+  if Rails::VERSION::MAJOR == 3
+    draw = "Testapp::Application.routes.draw do\n"
+  else
+    draw = "ActionController::Routing::Routes.draw do |map|\nmap."
+  end
+
+  routes = "#{draw}resources :#{resource}\nend"
+
+  create_file("config/routes.rb", routes, false)
+end
+
+When /^I run a short lived process that sets the key "([^"]*)" to "([^"]*)"$/ do |key, value|
+  if Rails::VERSION::MAJOR == 3
+    run_simple %[script/rails runner 'I18n.translate("#{key}", :default => "#{value}")']
+  else
+    run_simple %[script/runner 'I18n.translate("#{key}", :default => "#{value}")']
+  end
+end
+
+After do
+  RailsServer.stop
+end

data/features/support/env.rb

@@ -0,0 +1,8 @@
+require 'sham_rack'
+require 'aruba/cucumber'
+require 'rails/version'
+
+PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+$LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
+require "copycopter_client/version"
+