copycopter_client 1.0.0.beta8 → 1.0.0.beta9

data/features/rails.feature

@@ -71,13 +71,11 @@ Feature: Using copycopter in a rails app
     <%= @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"
 
@@ -98,8 +96,7 @@ Feature: Using copycopter in a rails app
     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:
+    And 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"

data/lib/copycopter_client/client.rb

@@ -35,14 +35,23 @@ module CopycopterClient
     # If the +public+ option was set to +true+, this will use published blurbs.
     # Otherwise, draft content is fetched.
     #
-    # @return [Hash] blurbs
+    # The client tracks ETags between download requests, and will return
+    # without yielding anything if the server returns a not modified response.
+    #
+    # @yield [Hash] downloaded blurbs
     # @raise [ConnectionError] if the connection fails
     def download
       connect do |http|
-        response = http.get(uri(download_resource))
-        check(response)
-        log("Downloaded translations")
-        JSON.parse(response.body)
+        request = Net::HTTP::Get.new(uri(download_resource))
+        request['If-None-Match'] = @etag
+        response = http.request(request)
+        if check(response)
+          log("Downloaded translations")
+          yield JSON.parse(response.body)
+        else
+          log("No new translations")
+        end
+        @etag = response['ETag']
       end
     end
 
@@ -101,11 +110,14 @@ module CopycopterClient
     end
 
     def check(response)
-      if Net::HTTPNotFound === response
+      case response
+      when Net::HTTPNotFound
         raise InvalidApiKey, "Invalid API key: #{api_key}"
-      end
-
-      unless Net::HTTPSuccess === response
+      when Net::HTTPNotModified
+        false
+      when Net::HTTPSuccess
+        true
+      else
         raise ConnectionError, "#{response.code}: #{response.body}"
       end
     end

data/lib/copycopter_client/configuration.rb

@@ -3,6 +3,7 @@ require 'copycopter_client/i18n_backend'
 require 'copycopter_client/client'
 require 'copycopter_client/sync'
 require 'copycopter_client/prefixed_logger'
+require 'copycopter_client/request_sync'
 
 module CopycopterClient
   # Used to set up and modify settings for the client.
@@ -13,7 +14,7 @@ module CopycopterClient
         :http_open_timeout, :http_read_timeout, :client_name, :client_url,
         :client_version, :port, :protocol, :proxy_host, :proxy_pass,
         :proxy_port, :proxy_user, :secure, :polling_delay, :logger,
-        :framework].freeze
+        :framework, :middleware].freeze
 
     # @return [String] The API key for your project, found on the project edit form.
     attr_accessor :api_key
@@ -72,6 +73,9 @@ module CopycopterClient
     # @return [Logger] Where to log messages. Must respond to same interface as Logger.
     attr_reader :logger
 
+    # @return the middleware stack, if any, which should respond to +use+
+    attr_accessor :middleware
+
     alias_method :secure?, :secure
 
     # Instantiated from {CopycopterClient.configure}. Sets defaults.
@@ -116,12 +120,19 @@ module CopycopterClient
       to_hash.merge(hash)
     end
 
-    # Determines if the content will be editable
-    # @return [Boolean] Returns +false+ if in a development environment, +true+ otherwise.
+    # Determines if the published or draft content will be used
+    # @return [Boolean] Returns +false+ if in a development or test
+    # environment, +true+ otherwise.
     def public?
       !(development_environments + test_environments).include?(environment_name)
     end
 
+    # Determines if the content will be editable
+    # @return [Boolean] Returns +true+ if in a development environment, +false+ otherwise.
+    def development?
+      development_environments.include?(environment_name)
+    end
+
     # Determines if the content will fetched from the server
     # @return [Boolean] Returns +true+ if in a test environment, +false+ otherwise.
     def test?
@@ -134,7 +145,7 @@ module CopycopterClient
       @applied
     end
 
-      # Applies the configuration (internal).
+    # Applies the configuration (internal).
     #
     # Called automatically when {CopycopterClient.configure} is called in the application.
     #
@@ -147,6 +158,7 @@ module CopycopterClient
       I18n.backend = I18nBackend.new(sync)
       CopycopterClient.client = client
       CopycopterClient.sync = sync
+      middleware.use(RequestSync, :sync => sync) if middleware && development?
       @applied = true
       logger.info("Client #{VERSION} ready")
       logger.info("Environment Info: #{environment_info}")

data/lib/copycopter_client/rails.rb

@@ -17,6 +17,7 @@ module CopycopterClient
         config.environment_name = ::Rails.env
         config.logger           = ::Rails.logger
         config.framework        = "Rails: #{::Rails::VERSION::STRING}"
+        config.middleware       = ::Rails.configuration.middleware
       end
     end
   end

data/lib/copycopter_client/request_sync.rb

@@ -0,0 +1,23 @@
+module CopycopterClient
+  # Rack middleware that synchronizes with Copycopter during each request.
+  #
+  # This is injected into the Rails middleware stack in development environments.
+  class RequestSync
+    # @param app [Rack] the upstream app into whose responses to inject the editor
+    # @param options [Hash]
+    # @option options [Sync] :sync agent that should be flushed after each request
+    def initialize(app, options)
+      @app  = app
+      @sync = options[:sync]
+    end
+
+    # Invokes the upstream Rack application and flushes the sync after each
+    # request.
+    def call(env)
+      @sync.download
+      response = @app.call(env)
+      @sync.flush
+      response
+    end
+  end
+end

data/lib/copycopter_client/sync.rb

@@ -86,6 +86,17 @@ module CopycopterClient
       with_queued_changes do |queued|
         client.upload(queued)
       end
+    rescue ConnectionError => error
+      logger.error(error.message)
+    end
+
+    def download
+      client.download do |downloaded_blurbs|
+        downloaded_blurbs.reject! { |key, value| value == "" }
+        lock { @blurbs = downloaded_blurbs }
+      end
+    rescue ConnectionError => error
+      logger.error(error.message)
     end
 
     private
@@ -103,12 +114,8 @@ module CopycopterClient
     end
 
     def sync
-      begin
-        download
-        flush
-      rescue ConnectionError => error
-        logger.error(error.message)
-      end
+      download
+      flush
     ensure
       @pending = false
     end
@@ -124,12 +131,6 @@ module CopycopterClient
       yield(changes_to_push) if changes_to_push
     end
 
-    def download
-      downloaded_blurbs = client.download
-      downloaded_blurbs.reject! { |key, value| value == "" }
-      lock { @blurbs = downloaded_blurbs }
-    end
-
     def lock(&block)
       @mutex.synchronize(&block)
     end

data/lib/copycopter_client/version.rb

@@ -1,6 +1,6 @@
 module CopycopterClient
   # Client version
-  VERSION = "1.0.0.beta8"
+  VERSION = "1.0.0.beta9"
 
   # API version being used to communicate with the server
   API_VERSION = "2.0"

data/spec/copycopter_client/client_spec.rb

@@ -29,28 +29,28 @@ describe CopycopterClient do
     it "should timeout when connecting" do
       project = add_project
       client = build_client(:api_key => project.api_key, :http_open_timeout => 4)
-      client.download
+      client.download { |ignore| }
       http.open_timeout.should == 4
     end
 
     it "should timeout when reading" do
       project = add_project
       client = build_client(:api_key => project.api_key, :http_read_timeout => 4)
-      client.download
+      client.download { |ignore| }
       http.read_timeout.should == 4
     end
 
     it "uses ssl when secure" do
       project = add_project
       client = build_client(:api_key => project.api_key, :secure => true)
-      client.download
+      client.download { |ignore| }
       http.use_ssl.should == true
     end
 
     it "doesn't use ssl when insecure" do
       project = add_project
       client = build_client(:api_key => project.api_key, :secure => false)
-      client.download
+      client.download { |ignore| }
       http.use_ssl.should == false
     end
 
@@ -66,9 +66,9 @@ describe CopycopterClient do
       ]
 
       errors.each do |original_error|
-        http.stubs(:get).raises(original_error)
+        http.stubs(:request).raises(original_error)
         client = build_client_with_project
-        expect { client.download }.
+        expect { client.download { |ignore| } }.
           to raise_error(CopycopterClient::ConnectionError) { |error|
             error.message.
               should == "#{original_error.class.name}: #{original_error.message}"
@@ -78,7 +78,8 @@ describe CopycopterClient do
 
     it "handles 500 errors from downloads with ConnectionError" do
       client = build_client(:api_key => 'raise_error')
-      expect { client.download }.to raise_error(CopycopterClient::ConnectionError)
+      expect { client.download { |ignore| } }.
+        to raise_error(CopycopterClient::ConnectionError)
     end
 
     it "handles 500 errors from uploads with ConnectionError" do
@@ -88,7 +89,8 @@ describe CopycopterClient do
 
     it "handles 404 errors from downloads with ConnectionError" do
       client = build_client(:api_key => 'bogus')
-      expect { client.download }.to raise_error(CopycopterClient::InvalidApiKey)
+      expect { client.download { |ignore| } }.
+        to raise_error(CopycopterClient::InvalidApiKey)
     end
 
     it "handles 404 errors from uploads with ConnectionError" do
@@ -109,8 +111,10 @@ describe CopycopterClient do
         'key.two' => "expected two"
       }
     })
+    client = build_client(:api_key => project.api_key, :public => true)
+    blurbs = nil
 
-    blurbs = build_client(:api_key => project.api_key, :public => true).download
+    client.download { |yielded| blurbs = yielded }
 
     blurbs.should == {
       'key.one' => 'expected one',
@@ -121,7 +125,7 @@ describe CopycopterClient do
   it "logs that it performed a download" do
     logger = FakeLogger.new
     client = build_client_with_project(:logger => logger)
-    client.download
+    client.download { |ignore| }
     logger.should have_entry(:info, "Downloaded translations")
   end
 
@@ -137,8 +141,10 @@ describe CopycopterClient do
         'key.three' => "unexpected three"
       }
     })
+    client = build_client(:api_key => project.api_key, :public => false)
+    blurbs = nil
 
-    blurbs = build_client(:api_key => project.api_key, :public => false).download
+    client.download { |yielded| blurbs = yielded }
 
     blurbs.should == {
       'key.one' => 'expected one',
@@ -146,6 +152,23 @@ describe CopycopterClient do
     }
   end
 
+  it "handles a 304 response when downloading" do
+    project = add_project
+    project.update('draft' => { 'key.one' => "expected one" })
+    logger = FakeLogger.new
+    client = build_client(:api_key => project.api_key,
+                          :public  => false,
+                          :logger  => logger)
+    yields = 0
+
+    2.times do
+      client.download { |ignore| yields += 1 }
+    end
+
+    yields.should == 1
+    logger.should have_entry(:info, "No new translations")
+  end
+
   it "uploads defaults for missing blurbs in an existing project" do
     project = add_project
 

data/spec/copycopter_client/configuration_spec.rb

@@ -42,6 +42,7 @@ describe CopycopterClient::Configuration do
   it { should have_config_option(:api_key).                 overridable }
   it { should have_config_option(:polling_delay).           overridable.default(300) }
   it { should have_config_option(:framework).               overridable }
+  it { should have_config_option(:middleware).              overridable }
 
   it "should provide default values for secure connections" do
     config = CopycopterClient::Configuration.new
@@ -105,12 +106,14 @@ describe CopycopterClient::Configuration do
     config.development_environments = %w(development)
     config.environment_name = 'production'
     config.should be_public
+    config.should_not be_development
   end
 
-  it "should not be public in a development environment" do
+  it "should be development in a development environment" do
     config = CopycopterClient::Configuration.new
     config.development_environments = %w(staging)
     config.environment_name = 'staging'
+    config.should be_development
     config.should_not be_public
   end
 
@@ -249,3 +252,45 @@ describe CopycopterClient::Configuration, "applied when not testing" do
   end
 end
 
+describe CopycopterClient::Configuration, "applied when developing with middleware" do
+  it_should_behave_like "applied configuration"
+
+  let(:middleware) { MiddlewareStack.new }
+
+  before do
+    subject.middleware = middleware
+    subject.environment_name = 'development'
+    subject.apply
+  end
+
+  it "adds the sync middleware" do
+    middleware.should include(CopycopterClient::RequestSync)
+  end
+end
+
+describe CopycopterClient::Configuration, "applied when developing without middleware" do
+  it_should_behave_like "applied configuration"
+
+  before do
+    subject.middleware = nil
+    subject.environment_name = 'development'
+    subject.apply
+  end
+end
+
+describe CopycopterClient::Configuration, "applied with middleware when not developing" do
+  it_should_behave_like "applied configuration"
+
+  let(:middleware) { MiddlewareStack.new }
+
+  before do
+    subject.middleware = middleware
+    subject.environment_name = 'test'
+    subject.apply
+  end
+
+  it "doesn't add the sync middleware" do
+    middleware.should_not include(CopycopterClient::RequestSync)
+  end
+end
+

data/spec/copycopter_client/request_sync_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe CopycopterClient::RequestSync do
+
+  let(:sync) { {} }
+  let(:response) { 'response' }
+  let(:env) { 'env' }
+  let(:app) { stub('app', :call => response) }
+  before { sync.stubs(:flush => nil, :download => nil) }
+  subject { CopycopterClient::RequestSync.new(app, :sync => sync) }
+
+  it "invokes the upstream app" do
+    result = subject.call(env)
+    app.should have_received(:call).with(env)
+    result.should == response
+  end
+
+  it "flushes defaults" do
+    subject.call(env)
+    sync.should have_received(:flush)
+  end
+
+  it "downloads new copy" do
+    subject.call(env)
+    sync.should have_received(:download)
+  end
+end

data/spec/copycopter_client/sync_spec.rb

@@ -100,16 +100,46 @@ describe CopycopterClient::Sync do
   end
 
   it "uploads changes when flushed" do
-    sync = build_sync(:polling_delay => 86400)
-    sync.start
-    sleep 2
+    sync = build_sync
     sync['test.key'] = 'test value'
+
     sync.flush
-    sleep(2)
 
     client.uploaded.should == { 'test.key' => 'test value' }
   end
 
+  it "downloads changes" do
+    client['test.key'] = 'test value'
+    sync = build_sync
+
+    sync.download
+
+    sync['test.key'].should == 'test value'
+  end
+
+  it "handles connection errors when flushing" do
+    failure = "server is napping"
+    logger = FakeLogger.new
+    client.stubs(:upload).raises(CopycopterClient::ConnectionError.new(failure))
+    sync = build_sync(:logger => logger)
+    sync['upload.key'] = 'upload'
+
+    sync.flush
+
+    logger.should have_entry(:error, failure)
+  end
+
+  it "handles connection errors when downloading" do
+    failure = "server is napping"
+    logger = FakeLogger.new
+    client.stubs(:download).raises(CopycopterClient::ConnectionError.new(failure))
+    sync = build_sync(:logger => logger)
+
+    sync.download
+
+    logger.should have_entry(:error, failure)
+  end
+
   it "handles connection errors when polling" do
     failure = "server is napping"
     logger = FakeLogger.new

data/spec/support/fake_client.rb

@@ -16,7 +16,8 @@ class FakeClient
   def download
     wait_for_delay
     @downloads += 1
-    @data.dup
+    yield @data.dup
+    nil
   end
 
   def upload(data)

data/spec/support/fake_copycopter_app.rb

@@ -37,11 +37,17 @@ class FakeCopycopterApp < Sinatra::Base
   end
 
   get "/api/v2/projects/:api_key/published_blurbs" do |api_key|
-    with_project(api_key) { |project| project.published.to_json }
+    with_project(api_key) do |project|
+      etag project.etag
+      project.published.to_json
+    end
   end
 
   get "/api/v2/projects/:api_key/draft_blurbs" do |api_key|
-    with_project(api_key) { |project| project.draft.to_json }
+    with_project(api_key) do |project|
+      etag project.etag
+      project.draft.to_json
+    end
   end
 
   post "/api/v2/projects/:api_key/draft_blurbs" do |api_key|
@@ -66,10 +72,12 @@ class FakeCopycopterApp < Sinatra::Base
       @api_key   = attrs['api_key']
       @draft     = attrs['draft']     || {}
       @published = attrs['published'] || {}
+      @etag      = attrs['etag']      || 1
     end
 
     def to_hash
       { 'api_key'   => @api_key,
+        'etag'      => @etag,
         'draft'     => @draft,
         'published' => @published }
     end
@@ -77,6 +85,7 @@ class FakeCopycopterApp < Sinatra::Base
     def update(attrs)
       @draft.    update(attrs['draft'])     if attrs['draft']
       @published.update(attrs['published']) if attrs['published']
+      @etag += 1
       self.class.save(self)
     end
 
@@ -89,6 +98,10 @@ class FakeCopycopterApp < Sinatra::Base
       self.class.save(self)
     end
 
+    def etag
+      @etag.to_s
+    end
+
     def self.create(api_key)
       project = Project.new('api_key' => api_key)
       save(project)

data/spec/support/middleware_stack.rb

@@ -0,0 +1,13 @@
+class MiddlewareStack
+  def initialize
+    @middlewares = []
+  end
+
+  def use(klass, *args)
+    @middlewares << klass.new('fake_app', *args)
+  end
+
+  def include?(klass)
+    @middlewares.any? { |middleware| klass === middleware }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: copycopter_client
 version: !ruby/object:Gem::Version 
-  hash: 299253588
+  hash: 299253589
   prerelease: true
   segments: 
   - 1
   - 0
   - 0
-  - beta8
-  version: 1.0.0.beta8
+  - beta9
+  version: 1.0.0.beta9
 platform: ruby
 authors: 
 - thoughtbot
@@ -69,6 +69,7 @@ files:
 - lib/copycopter_client/prefixed_logger.rb
 - lib/copycopter_client/rails.rb
 - lib/copycopter_client/railtie.rb
+- lib/copycopter_client/request_sync.rb
 - lib/copycopter_client/sync.rb
 - lib/copycopter_client/version.rb
 - lib/copycopter_client.rb
@@ -78,6 +79,7 @@ files:
 - spec/copycopter_client/helper_spec.rb
 - spec/copycopter_client/i18n_backend_spec.rb
 - spec/copycopter_client/prefixed_logger_spec.rb
+- spec/copycopter_client/request_sync_spec.rb
 - spec/copycopter_client/sync_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -90,6 +92,7 @@ files:
 - spec/support/fake_passenger.rb
 - spec/support/fake_resque_job.rb
 - spec/support/fake_unicorn.rb
+- spec/support/middleware_stack.rb
 - features/rails.feature
 - features/step_definitions/copycopter_server_steps.rb
 - features/step_definitions/rails_steps.rb