localeapp 0.0.7

data/spec/locale_app/key_checker_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe LocaleApp::KeyChecker, "#check(key)" do
+  it "returns false and an empty hash if the response from locale app is a 404" do
+    FakeWeb.register_uri(:get, 'http://api.localeapp.com/v1/projects/TEST_KEY.json', :body => "", :status => ['404', 'Not Found'])
+    with_configuration do
+      @checker = LocaleApp::KeyChecker.new
+    end
+    @checker.check('TEST_KEY').should == [false, {}]
+  end
+
+  it "returns true and and the parsed json hash if the response from locale app is a 200" do
+    FakeWeb.register_uri(:get, 'http://api.localeapp.com/v1/projects/TEST_KEY.json', :body => valid_project_data.to_json, :status => ['200', 'OK'])
+    with_configuration do
+      @checker = LocaleApp::KeyChecker.new
+    end
+    @checker.check('TEST_KEY').should == [true, valid_project_data]
+  end
+end

data/spec/locale_app/missing_translations_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'locale_app/missing_translations'
+
+describe LocaleApp::MissingTranslations, "#add(locale, key, options = {})" do
+  it "stores the missing translation data" do
+    translations = LocaleApp::MissingTranslations.new
+    translations.add(:en, 'foo', { :baz => 'bam' })
+    translations[:en].should include('foo')
+    translations[:en]['foo'].options.should == { :baz => 'bam' }
+  end
+end
+
+describe LocaleApp::MissingTranslations, "#to_send" do
+  it "returns an array of missing translation data that needs to be sent to localeapp.com" do
+    translations = LocaleApp::MissingTranslations.new
+    translations.add(:en, 'foo', { :baz => 'bam' })
+    translations.add(:es, 'bar')
+
+    to_send = translations.to_send
+    to_send.size.should == 2
+    to_send[0][:key].should == 'foo'
+    to_send[0][:locale].should == :en
+    to_send[0][:options].should == { :baz => 'bam' }
+    to_send[1][:key].should == 'bar'
+    to_send[1][:locale].should == :es
+    to_send[1][:options].should == {}
+  end
+end

data/spec/locale_app/poller_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe LocaleApp::Poller do
+  before do
+    @updated_at = Time.now.to_i
+    with_configuration(:synchronization_data_file => LocaleAppSynchronizationData::setup(nil, @updated_at), :api_key => 'TEST_KEY') do
+      @poller = LocaleApp::Poller.new
+    end
+    @hash = { 'translations' => {}, 'deleted' => [], 'locales' => [] }
+  end
+
+  after do
+    LocaleAppSynchronizationData::destroy
+  end
+
+  describe "#needs_reloading?" do
+    it "returns true when updated_at has been changed in the synchronization file" do
+      @poller.write_synchronization_data!(@poller.polled_at, 12345)
+      @poller.needs_reloading?.should be_true
+    end
+
+    it "returns false when updated_at is the same as in the synchronization file" do
+      @poller.needs_reloading?.should be_false
+    end
+  end
+
+  describe "#write_synchronization_data!(polled_at, updated_at)" do
+    it "updates polled_at in the synchronization file" do
+      polled_at = lambda { @poller.synchronization_data[:polled_at] }
+      expect { @poller.write_synchronization_data!(01234, 56789) }.to change(polled_at, :call).to(01234)
+    end
+
+    it "updates updated_at in the synchronization file" do
+      updated_at = lambda { @poller.synchronization_data[:updated_at] }
+      expect { @poller.write_synchronization_data!(01234, 56789) }.to change(updated_at, :call).to(56789)
+    end
+  end
+    
+  describe "#poll!" do
+    it "returns false if get returns 304 Not Modified" do
+      FakeWeb.register_uri(:get, "http://api.localeapp.com/v1/projects/TEST_KEY/translations.json?updated_at=#{@updated_at}", :body => '', :status => ['304', 'Not Modified'])
+      @poller.poll!.should == false
+    end
+
+    it "returns false if get returns a 50x response" do
+      FakeWeb.register_uri(:get, "http://api.localeapp.com/v1/projects/TEST_KEY/translations.json?updated_at=#{@updated_at}", :body => '', :status => ['500', 'Internal Server Error'])
+      @poller.poll!.should == false
+    end
+
+    it "returns false if get returns 200 OK" do
+      FakeWeb.register_uri(:get, "http://api.localeapp.com/v1/projects/TEST_KEY/translations.json?updated_at=#{@updated_at}", :body => @hash.to_json, :status => ['200', 'OK'], :date => Time.now.httpdate)
+      @poller.poll!.should == true
+    end
+
+    it "passes the data through to the Updater" do
+      FakeWeb.register_uri(:get, "http://api.localeapp.com/v1/projects/TEST_KEY/translations.json?updated_at=#{@updated_at}", :body => @hash.to_json, :status => ['200', 'OK'], :date => Time.now.httpdate)
+      LocaleApp.updater.should_receive(:update).with(@hash)
+      @poller.poll!
+    end
+  end
+end

data/spec/locale_app/rails/controller_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+class TestController
+  def self.before_filter(*options)
+  end
+  def self.after_filter(*options)
+  end
+end
+
+require 'locale_app/rails/controller'
+
+describe LocaleApp::Rails::Controller, '#handle_translation_updates' do
+  before do
+    TestController.send(:include, LocaleApp::Rails::Controller)
+    with_configuration(:synchronization_data_file => LocaleAppSynchronizationData::setup) do
+      @controller = TestController.new
+    end
+  end
+
+  after do
+    LocaleAppSynchronizationData::destroy
+  end
+
+  context "when polling is enabled" do
+    before do
+      LocaleApp.configuration.environment_name = 'development' # reloading enabled
+      LocaleApp.configuration.disabled_reloading_environments << 'development'
+    end
+ 
+    it "calls poller.poll! when the synchronization file's polled_at has changed" do
+      LocaleApp.poller.write_synchronization_data!(01234, 56789)
+      LocaleApp.poller.should_receive(:poll!)
+      @controller.handle_translation_updates
+    end
+
+    it "doesn't call poller.poll! when the synchronization file's polled_at is the same" do
+      LocaleApp.poller.should_not_receive(:poll!)
+      @controller.handle_translation_updates
+    end
+  end
+
+  context "when polling is disabled" do
+    before do
+      LocaleApp.configuration.environment_name = 'production' # reloading disabled
+      LocaleApp.configuration.disabled_reloading_environments << 'production'
+    end
+
+    it "doesn't poller.poll! when the synchronization file's polled_at has changed" do
+      LocaleApp.poller.write_synchronization_data!(01234, 56789)
+      LocaleApp.poller.should_not_receive(:poll!)
+      @controller.handle_translation_updates
+    end
+
+    it "doesn't poller.poll! when the synchronization file's polled_at is the same" do
+      LocaleApp.poller.should_not_receive(:poll!)
+      @controller.handle_translation_updates
+    end
+  end
+ 
+  context "when reloading is enabled" do
+    before do
+      LocaleApp.configuration.environment_name = 'development' # reloading enabled
+      LocaleApp.configuration.disabled_polling_environments << 'development'
+    end
+ 
+    it "calls I18n.reload! when the synchronization file's updated_at has changed" do
+      LocaleApp.poller.write_synchronization_data!(01234, 56789)
+      I18n.should_receive(:reload!)
+      @controller.handle_translation_updates
+    end
+
+    it "doesn't call I18n.relaod! when the synchronization file's updated_at is the same" do
+      I18n.should_not_receive(:reload!)
+      @controller.handle_translation_updates
+    end
+  end
+ 
+  context "when reloading is disabled" do
+    before do
+      LocaleApp.configuration.environment_name = 'production' # reloading disabled
+      LocaleApp.configuration.disabled_polling_environments << 'production'
+    end
+
+    it "doesn't call I18n.reload! when the synchronization file's updated_at has changed" do
+      LocaleApp.poller.write_synchronization_data!(01234, 56789)
+      I18n.should_not_receive(:reload!)
+      @controller.handle_translation_updates
+    end
+
+    it "doesn't call I18n.relaod! when the synchronization file's updated_at is the same" do
+      I18n.should_not_receive(:reload!)
+      @controller.handle_translation_updates
+    end
+  end
+end
+
+describe LocaleApp::Rails::Controller, '#send_missing_translations' do
+  before(:each) do
+    LocaleApp.configure do |config|
+      config.api_key = 'abcdef'
+    end
+    TestController.send(:include, LocaleApp::Rails::Controller)
+    @controller = TestController.new
+  end
+
+  it "does nothing when sending is disabled" do
+    LocaleApp.configuration.environment_name = 'test'
+    LocaleApp.sender.should_not_receive(:post_missing_translations)
+    @controller.send_missing_translations
+  end
+
+  it "proceeds when configuration is enabled" do
+    LocaleApp.configuration.environment_name = 'development'
+    LocaleApp.sender.should_receive(:post_missing_translations)
+    @controller.send_missing_translations
+  end
+end

data/spec/locale_app/routes_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+class TestRoutes
+  include LocaleApp::Routes
+end
+  
+describe LocaleApp::Routes do
+  before(:each) do
+    @routes = TestRoutes.new
+    @config = {:host => 'test.host', :api_key => 'API_KEY'}
+  end
+
+  describe "#project_endpoint(options = {})" do
+    it "returns :get and the project url for the options" do
+      with_configuration(@config) do
+        options = { :foo => :bar }
+        @routes.should_receive(:project_url).with(options).and_return('url')
+        @routes.project_endpoint(options).should == [:get, 'url']
+      end
+    end
+  end
+
+  describe '#project_url' do
+    it "is constructed from the configuration host and port and defaults to json" do
+      with_configuration(@config.merge(:port => 1234)) do
+        @routes.project_url.should == "http://test.host:1234/v1/projects/API_KEY.json"
+      end
+    end
+
+    it "includes http auth if in configuration" do
+      with_configuration(@config.merge(:port => 1234, :http_auth_username => 'foo', :http_auth_password => 'bar')) do
+        @routes.project_url.should == "http://foo:bar@test.host:1234/v1/projects/API_KEY.json"
+      end
+    end
+
+    it "can be changed to another content type" do
+      with_configuration(@config) do
+        @routes.project_url(:format => :yml).should == 'http://test.host/v1/projects/API_KEY.yml'
+      end
+    end
+  end
+
+  describe "#translations_url" do
+    it "it extends the project_url and defaults to json" do
+      with_configuration(@config) do
+        @routes.translations_url.should == "http://test.host/v1/projects/API_KEY/translations.json"
+      end
+    end
+
+    it "adds query parameters on to the url" do
+      with_configuration(@config) do
+        url = @routes.translations_url(:query => {:updated_at => '2011-04-19', :foo => :bar})
+        url.should match(/\?.*updated_at=2011-04-19/)
+        url.should match(/\?.*foo=bar/)
+      end
+    end
+
+    it "can be changed to another content type" do
+      with_configuration(@config) do
+        @routes.translations_url(:format => :yml).should == 'http://test.host/v1/projects/API_KEY/translations.yml'
+      end
+    end
+  end
+
+  describe "#translations_endpoint(options = {})" do
+    it "returns :get and the translations url for the options" do
+      with_configuration(@config) do
+        options = { :foo => :bar }
+        @routes.should_receive(:translations_url).with(options).and_return('url')
+        @routes.translations_endpoint(options).should == [:get, 'url']
+      end
+    end
+  end
+
+  describe "#create_translation_endpoint(options = {})" do
+    it "returns :post and the translation url for the options" do
+      with_configuration(@config) do
+        options = { :foo => :bar }
+        @routes.should_receive(:translations_url).with(options).and_return('url')
+        @routes.create_translation_endpoint(options).should == [:post, 'url']
+      end
+    end
+  end
+
+  describe "#missing_translations_endpoint(options = {})" do
+    it "returns :post and the missing_translations url for the options" do
+      with_configuration(@config) do
+        options = { :foo => :bar }
+        @routes.should_receive(:missing_translations_url).with(options).and_return('url')
+        @routes.missing_translations_endpoint(options).should == [:post, 'url']
+      end
+    end
+  end
+
+  describe "#missing_translations_url" do
+    it "it extends the project_url and defaults to json" do
+      with_configuration(@config) do
+        @routes.missing_translations_url.should == "http://test.host/v1/projects/API_KEY/translations/missing.json"
+      end
+    end
+
+    it "adds query parameters on to the url" do
+      with_configuration(@config) do
+        url = @routes.missing_translations_url(:query => {:updated_at => '2011-04-19', :foo => :bar})
+        url.should match(/\?.*updated_at=2011-04-19/)
+        url.should match(/\?.*foo=bar/)
+      end
+    end
+
+    it "can be changed to another content type" do
+      with_configuration(@config) do
+        @routes.missing_translations_url(:format => :yml).should == 'http://test.host/v1/projects/API_KEY/translations/missing.yml'
+      end
+    end
+  end
+
+  describe "#import_url" do
+    it "appends 'import to the project url" do
+      with_configuration(@config) do
+        @routes.import_url.should == 'http://test.host/v1/projects/API_KEY/import/'
+      end
+    end
+  end
+
+  describe "#import_endpoint(options = {})" do
+    it "returns :post and the import url for the options" do
+      with_configuration(@config) do
+        options = { :foo => :bar }
+        @routes.should_receive(:import_url).with(options).and_return('url')
+        @routes.import_endpoint(options).should == [:post, 'url']
+      end
+    end
+  end
+end

data/spec/locale_app/sender_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe LocaleApp::Sender, "#post_translation(locale, key, options, value = nil)" do
+  before(:each) do
+    with_configuration(:api_key => "TEST_KEY") do
+      @sender = LocaleApp::Sender.new
+    end
+  end
+
+  it "posts the missing translation data to the backend" do
+    data = {
+      :translation => {
+        :key => "test.key",
+        :locale => "en",
+        :substitutions => ['foo', 'bar'],
+        :description => "test content"
+      }
+    }
+    # have to stub RestClient here as FakeWeb doesn't support looking at the post body yet
+    RestClient.should_receive(:post).with(@sender.translations_url, data.to_json, :content_type => :json).and_return(double('response', :code => 200))
+    @sender.post_translation('en', 'test.key', { 'foo' => 'foo', 'bar' => 'bar' }, 'test content')
+  end
+end
+
+describe LocaleApp::Sender, "#post_missing_translations" do
+  before(:each) do
+    with_configuration(:api_key => 'TEST_KEY') do
+      @sender = LocaleApp::Sender.new
+    end
+  end
+
+  it "sends the missing translation data to the API" do
+    missing_to_send = [
+      { :key => "test.key", :locale => "en" },
+      { :key => "test.key2", :locale => "en" }
+    ]
+    LocaleApp.missing_translations.should_receive(:to_send).and_return(missing_to_send)
+    data = { :translations => missing_to_send }
+    # have to stub RestClient here as FakeWeb doesn't support looking at the post body yet
+    RestClient.should_receive(:post).with(@sender.missing_translations_url, data.to_json, :content_type => :json).and_return(double('response', :code => 200))
+    @sender.post_missing_translations
+  end
+
+  it "does nothing if there are no missing translations to send" do
+    LocaleApp.missing_translations.should_receive(:to_send).and_return([])
+    RestClient.should_not_receive(:post)
+    @sender.post_missing_translations
+  end
+end

data/spec/locale_app/updater_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe LocaleApp::Updater, ".update(data)" do
+  before(:each) do
+    @yml_dir = Dir.mktmpdir
+    Dir.glob(File.join(File.dirname(__FILE__), '..', 'fixtures', '*.yml')).each { |f| FileUtils.cp f, @yml_dir }
+    with_configuration(:translation_data_directory => @yml_dir) do
+      @updater = LocaleApp::Updater.new
+    end
+  end
+
+  after(:each) do
+    FileUtils.rm_rf @yml_dir
+  end
+
+  def do_update(data)
+    @updater.update(data)
+  end
+
+  it "adds, updates and deletes keys in the yml files" do
+    do_update({
+      'translations' => {
+        'en' => {
+          'foo' => { 'monkey' => 'hello', 'night' => 'night' }
+        },
+        'es' => {
+          'foo' => { 'monkey' => 'hola', 'night' => 'noche' }
+        }
+      },
+      'deleted' => [
+        'foo.delete_me',
+        'bar.delete_me_too',
+        'hah.imnotreallyhere'
+      ],
+      'locales' => %w{en es}
+    })
+    File.read(File.join(@yml_dir, 'en.yml')).should == <<-EN
+en: 
+  foo: 
+    monkey: hello
+    night: night
+EN
+    File.read(File.join(@yml_dir, 'es.yml')).should == <<-ES
+es: 
+  foo: 
+    monkey: hola
+    night: noche
+ES
+  end
+
+  it "deletes keys in the yml files when updates are empty" do
+    do_update({
+      'translations' => {},
+      'deleted' => [
+        'foo.delete_me',
+        'bar.delete_me_too',
+        'hah.imnotreallyhere'
+      ],
+      'locales' => %w{es}
+    })
+    File.read(File.join(@yml_dir, 'es.yml')).should == <<-ES
+es: 
+  foo: 
+    monkey: Mono
+ES
+  end
+
+  it "creates a new yml file if an unknown locale is passed" do
+    do_update({
+      'translations' => {
+        'ja' => { 'foo' => 'bar'}
+      },
+      'locales' => ['ja']
+    })
+    File.read(File.join(@yml_dir, 'ja.yml')).should == <<-JA
+ja: 
+  foo: bar
+JA
+  end
+
+  it "doesn't create a new yml file if an unknown locale is passed but it has no translations" do
+    do_update({
+      'translations' => {},
+      'deletes' => ['foo.delete_me'],
+      'locales' => ['ja']
+    })
+    File.exist?(File.join(@yml_dir, 'ja.yml')).should be_false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'i18n'
+require 'locale_app'
+require 'fakeweb'
+require 'support/locale_app_integration_data'
+require 'support/locale_app_synchronization_data'
+require 'logger'
+
+def with_configuration(options = {})
+  LocaleApp.configuration = nil
+  LocaleApp.configure do |configuration|
+    options.each do |option, value| 
+      configuration.send("#{option}=", value)
+    end
+  end
+  yield
+end
+
+RSpec.configure do |config|
+  config.include(LocaleAppIntegrationData)
+  config.include(LocaleAppSynchronizationData)
+  config.before(:each) do
+    FakeWeb.allow_net_connect = false
+  end
+end

data/spec/support/locale_app_integration_data.rb

@@ -0,0 +1,33 @@
+# This module is the source for all data that simulates what the real app would return.
+# It's included in the specs and cucumber tests, so if our format changes we
+# should only have to change here
+module LocaleAppIntegrationData
+  def valid_project_data
+    {
+      'name' => "Test Project",
+      'default_locale' => {
+        'name' => "English",
+        'code' => "en"
+      }
+    }
+  end
+
+  def valid_translation_data
+    {
+      'translations' => {
+        'en' => {
+          'foo' => { 'monkey' => 'hello', 'night' => 'night' }
+          },
+          'es' => {
+            'foo' => { 'monkey' => 'hola', 'night' => 'noche' }
+          },
+      },
+      'deleted' => [
+        'foo.delete_me',
+        'bar.delete_me_too',
+        'hah.imnotreallyhere'
+      ],
+      'locales' => %w{en es}
+    }
+  end
+end

data/spec/support/locale_app_synchronization_data.rb

@@ -0,0 +1,21 @@
+module LocaleAppSynchronizationData
+  def self.file(dir)
+    File.join(dir, 'test_sync.yml')
+  end
+
+  def self.setup(polled_at=nil, updated_at=nil)
+    polled_at  ||= Time.now.to_i
+    updated_at ||= Time.now.to_i
+
+    @dir  = Dir.mktmpdir
+    @file = file(@dir)
+    File.open(@file, 'w+') do |f|
+      f.write({ :polled_at  => polled_at, :updated_at => updated_at }.to_yaml)
+    end
+    @file
+  end
+
+  def self.destroy
+    FileUtils.rm_rf @dir
+  end
+end