localeapp 0.0.7

data/lib/locale_app/updater.rb

@@ -0,0 +1,63 @@
+module LocaleApp
+  class Updater
+
+    def update(data)
+      data['locales'].each do |short_code|
+        filename = File.join(LocaleApp.configuration.translation_data_directory, "#{short_code}.yml")
+
+        if File.exist?(filename)
+          translations = YAML.load(File.read(filename))
+          if data['translations'] && data['translations'][short_code]
+            new_data = { short_code => data['translations'][short_code] }
+            translations.deep_merge!(new_data)
+          end
+        else
+          translations = { short_code => data['translations'][short_code] }
+        end
+
+        if data['deleted']
+          data['deleted'].each do |key|
+            remove_flattened_key!(translations, short_code, key)
+          end
+        end
+
+        if translations[short_code]
+          atomic_write(filename) do |file|
+            file.write translations.ya2yaml[5..-1]
+          end
+        end
+      end
+    end
+
+    private
+    def remove_flattened_key!(hash, locale, key)
+      keys = I18n.normalize_keys(locale, key, '').map(&:to_s)
+      current_key = keys.shift
+      remove_child_keys!(hash[current_key], keys)
+      hash
+    end
+
+    def remove_child_keys!(sub_hash, keys)
+      current_key = keys.shift
+      if keys.empty?
+        sub_hash.delete(current_key)
+      else
+        child_hash = sub_hash[current_key]
+        unless child_hash.nil?
+          remove_child_keys!(child_hash, keys)
+          if child_hash.empty?
+            sub_hash.delete(current_key)
+          end
+        end
+      end
+    end
+
+    # from ActiveSupport
+    def atomic_write(file_name, temp_dir = Dir.tmpdir)
+      temp_file = Tempfile.new(File.basename(file_name), temp_dir)
+      yield temp_file
+      temp_file.close
+      File.rename(temp_file.path, file_name)
+    end
+  end
+end

data/lib/locale_app/version.rb

@@ -0,0 +1,3 @@
+module LocaleApp
+  VERSION = "0.0.7"
+end

data/lib/locale_app.rb

@@ -0,0 +1,98 @@
+# AUDIT: Find a better way of doing this
+begin
+  require 'i18n'
+rescue LoadError
+  # we're in 2.3 and we need to load rails to get the vendored i18n
+  require 'thread' # for rubygems > 1.6.0 support
+  require 'active_support'
+end
+
+begin
+  require 'i18n/core_ext/hash'
+rescue LoadError
+  # Assume that we're in rails 2.3 and AS supplies deep_merge
+end
+
+
+require 'locale_app/version'
+require 'locale_app/configuration'
+require 'locale_app/routes'
+require 'locale_app/api_call'
+require 'locale_app/api_caller'
+require 'locale_app/sender'
+require 'locale_app/poller'
+require 'locale_app/updater'
+require 'locale_app/key_checker'
+require 'locale_app/missing_translations'
+  
+require 'locale_app/cli/install'
+require 'locale_app/cli/pull'
+require 'locale_app/cli/push'
+require 'locale_app/cli/update'
+
+# AUDIT: Will this work on ruby 1.9.x
+$KCODE="UTF8" if RUBY_VERSION < '1.9'
+
+require 'ya2yaml'
+
+module LocaleApp
+  API_VERSION = "1"
+  LOG_PREFIX = "** [LocaleApp] "
+
+  class << self
+    # An LocaleApp configuration object.
+    attr_accessor :configuration
+    
+    # The sender object is responsible for delivering formatted data to the LocaleApp server.
+    attr_accessor :sender
+
+    # The poller object is responsible for retrieving data for the LocaleApp server
+    attr_accessor :poller
+
+    # The updater object is responsible for merging translations into the i18n backend
+    attr_accessor :updater
+
+    # The missing_translations object is responsible for keeping track of missing translations
+    # that will be sent to the backend
+    attr_reader :missing_translations
+
+
+    # Writes out the given message to the #logger
+    def log(message)
+      logger.info LOG_PREFIX + message if logger
+    end
+
+    def debug(message)
+      logger.debug(LOG_PREFIX + message) if logger
+    end
+
+    # Look for the Rails logger currently defined
+    def logger
+      self.configuration && self.configuration.logger
+    end
+  
+    # @example Configuration
+    # LocaleApp.configure do |config|
+    #   config.api_key = '1234567890abcdef'
+    # end
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+      self.sender  = Sender.new
+      self.poller  = Poller.new
+      self.updater = Updater.new
+      @missing_translations = MissingTranslations.new
+    end
+
+    # requires the LocaleApp configuration
+    def include_config_file(file_path=nil)
+      file_path ||= File.join(Dir.pwd, 'config', 'initializers', 'locale_app')
+      begin
+        require file_path
+        true
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/localeapp.rb

@@ -0,0 +1 @@
+require File.expand_path("locale_app.rb",File.dirname(__FILE__))

data/localeapp.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "locale_app/version"
+
+Gem::Specification.new do |s|
+  s.name        = "localeapp"
+  s.version     = LocaleApp::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Christopher Dell", "Chris McGrath"]
+  s.email       = ["chris@tigrish.com", "chris@octopod.info"]
+  s.homepage    = "http://rubygems.org/gems/localeapp"
+  s.summary     = %q{Add missing translation keys to localeapp.com}
+  s.description = %q{Post any unfound translation keys to the Locale SaaS}
+
+  s.rubyforge_project = "localeapp"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('json')
+  s.add_dependency('rest-client')
+  s.add_dependency('ya2yaml')
+
+  # i18n is a dev dependency as we'll use whichever version is in rails
+  # when the gem runs
+  s.add_development_dependency('i18n', '0.5.0')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '2.5.0')
+  s.add_development_dependency('yard', '0.6.7')
+  s.add_development_dependency('RedCloth', '4.2.7')
+  s.add_development_dependency('aruba', '0.3.6')
+  s.add_development_dependency('fakeweb', '1.3.0')
+end

data/run_ci

@@ -0,0 +1,5 @@
+#!/bin/sh
+source "$HOME/.rvm/scripts/rvm"
+rvm gemset use $BUILD_RUBY_VERSION@locale_app
+bundle install
+rake

data/spec/fixtures/en.yml

@@ -0,0 +1,6 @@
+en:
+  bar:
+    delete_me_too: Delete
+  foo:
+    delete_me: Delete
+    monkey: Monkey

data/spec/fixtures/es.yml

@@ -0,0 +1,6 @@
+es:
+  bar:
+    delete_me_too: ES_Delete
+  foo:
+    delete_me: ES_Delete
+    monkey: Mono

data/spec/locale_app/api_call_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+class ApiCallTest
+  include LocaleApp::ApiCall
+end
+
+describe LocaleApp::ApiCall, "#api_call(endpoint, options = {})" do
+  it "creates an ApiCaller object and tells it to make the call" do
+    api_call_test = ApiCallTest.new
+    api_call = double('api_call')
+    api_call.should_receive(:call).with(api_call_test)
+    LocaleApp::ApiCaller.should_receive(:new).with(:endpoint, { :foo => :bar }).and_return(api_call)
+    api_call_test.api_call(:endpoint, { :foo => :bar })
+  end
+end

data/spec/locale_app/api_caller_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+describe LocaleApp::ApiCaller, ".new(endpoint, options = {})" do
+  it "stores the endpoint and options" do
+    api_caller = LocaleApp::ApiCaller.new(:endpoint, :foo => :bar)
+    api_caller.endpoint.should == :endpoint
+    api_caller.options.should == { :foo => :bar }
+  end
+end
+
+describe LocaleApp::ApiCaller, "#call(object)" do
+  before do
+    @api_caller = LocaleApp::ApiCaller.new(:test)
+    @url = 'http://example.com/test'
+    @api_caller.stub!(:test_endpoint).and_return([:get, @url])
+    @api_caller.stub!(:sleep_if_retrying)
+  end
+
+  it "gets the method and url for the endpoint" do
+    @api_caller.should_receive(:test_endpoint).with({}).and_return([:get, @url])
+    RestClient.stub!(:get).and_return(double('response', :code => 200))
+    @api_caller.call(self)
+  end
+
+  it "passes through any url options" do
+    @api_caller.should_receive(:test_endpoint).with({:foo => :bar}).and_return([:get, @url])
+    @api_caller.options[:url_options] = { :foo => :bar }
+    RestClient.stub!(:get).and_return(double('response', :code => 200))
+    @api_caller.call(self)
+  end
+
+  context "a GET request" do
+    it "makes the call to the api" do
+      RestClient.should_receive(:get).with(@url, {}).and_return(double('response', :code => 200))
+      @api_caller.call(self)
+    end
+
+    it "adds any :request_options to the api call" do
+      RestClient.should_receive(:get).with(@url, :foo => :bar).and_return(double('response', :code => 200))
+      @api_caller.options[:request_options] = { :foo => :bar }
+      @api_caller.call(self)
+    end
+  end
+
+
+  context " a POST request" do
+    before do
+      @api_caller.stub!(:test_endpoint).and_return([:post, @url])
+      @api_caller.options[:payload] = "test data"
+    end
+
+    it "makes the call to the api using :payload as the payload" do
+      RestClient.should_receive(:post).with(@url, "test data", {}).and_return(double('response', :code => 200))
+      @api_caller.call(self)
+    end
+
+    it "adds any :request_options to the api call" do
+      RestClient.should_receive(:post).with(@url, "test data", :foo => :bar).and_return(double('response', :code => 200))
+      @api_caller.options[:request_options] = { :foo => :bar }
+      @api_caller.call(self)
+    end
+  end
+
+  context " call succeeded" do
+    before do
+      FakeWeb.register_uri(:get, @url, :body => '', :status => [200, 'OK'])
+      @object = double('calling object')
+    end
+
+    it "calls the :success option callback if present" do
+      @api_caller.options[:success] = :success
+      @object.should_receive(:success).with(kind_of(RestClient::Response))
+      @api_caller.call(@object)
+    end
+
+    it "does nothing if :success option callback not present" do
+      @object.should_not_receive(:success)
+      @api_caller.call(@object)
+    end
+
+    it "should not try the call again" do
+      @api_caller.max_connection_attempts = 2
+      @api_caller.call(@object)
+      @api_caller.connection_attempts.should == 1
+    end
+
+    it "doesn't call the failure handler" do
+      @api_caller.options[:failure] = :failure
+      @object.should_not_receive(:failure)
+      @api_caller.call(@object)
+    end
+  end
+
+  context " call failed" do
+    before do
+      FakeWeb.register_uri(:get, @url, :body => '', :status => [500, 'Internal Server Error'])
+      @object = double('calling object')
+    end
+
+    it "retries call, up to value of :max_connection_attempts option" do
+      @api_caller.max_connection_attempts = 2
+      @api_caller.call(@object)
+      @api_caller.connection_attempts.should == 2
+    end
+
+    it "backs off each retry attempt" do
+      @api_caller.should_receive(:sleep_if_retrying)
+      @api_caller.call(@object)
+    end
+
+    it "calls the :failure option callback if present" do
+      @api_caller.options[:failure] = :fail
+      @object.should_receive(:fail).with(kind_of(RestClient::Response))
+      @api_caller.call(@object)
+    end
+
+    it "does nothing if :failure option callback not present" do
+      @object.should_not_receive(:fail)
+      @api_caller.call(@object)
+    end
+
+    {
+      304 => 'Not Modified',
+      404 => 'Resource Not Found',
+      500 => 'Internal Server Error',
+      # Work out when this could happen
+      # 501 => 'Not Implemented',
+      502 => 'Bad Gateway',
+      503 => 'Service Unavailable',
+      504 => 'Gateway Timeout',
+      # Work out when this could happen
+      # 505 => 'HTTP Version Not Supported',
+      # Work out when this could happen
+      # 506 => 'Variant Also Negotiates',
+      # Work out when this could happen
+      # 507 => 'Insufficient Storage', #WebDAV
+      # Work out when this could happen
+      # 509 => 'Bandwidth Limit Exceeded', #Apache
+      # Work out when this could happen
+      # 510 => 'Not Extended'
+    }.each do |code, reason|
+      it "fails when response is #{code} #{reason}" do
+        FakeWeb.register_uri(:get, @url, :body => '', :status => [code.to_s, reason])
+        @api_caller.options[:failure] = :fail
+        @object.should_receive(:fail)
+        @api_caller.call(@object)
+      end
+    end
+
+    it "handles ECONNREFUSED" do
+      RestClient.stub(:send).and_raise(Errno::ECONNREFUSED)
+      @api_caller.options[:failure] = :fail
+      @object.should_receive(:fail)
+      @api_caller.call(@object)
+    end
+  end
+end

data/spec/locale_app/cli/install_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'locale_app/cli/install'
+
+describe LocaleApp::CLI::Install, '.execute(key, output = $stdout)' do
+  before(:each) do
+    @output = StringIO.new
+    @command = LocaleApp::CLI::Install.new
+  end
+
+  it "displays error if key is nil" do
+    @command.execute(nil, @output)
+    @output.string.should match(/You must supply an API key/)
+  end
+
+  it "displays error if the key is there but isn't valid on localeapp.com" do
+    @command.stub!(:check_key).and_return([false, {}])
+    @command.execute('API_KEY', @output)
+    @output.string.should match(/Project not found/)
+  end
+
+  it "displays project name and base locale if the key is there and valid on localeapp.com" do
+    @command.stub!(:check_key).and_return([true, valid_project_data])
+    @command.stub!(:write_configuration_file)
+    @command.execute('API_KEY', @output)
+    @output.string.should match(/Test Project/)
+    @output.string.should match(/en \(English\)/)
+  end
+
+  it "displays warning if I18n.default_locale doesn't match what's configured on localeapp.com" do
+    I18n.stub(:default_locale).and_return(:es)
+    @command.stub!(:check_key).and_return([true, valid_project_data])
+    @command.stub!(:write_configuration_file)
+    @command.execute('API_KEY', @output)
+    @output.string.should match(%r{WARNING: I18n.default_locale is es, change in config/environment.rb \(Rails 2\) or config/application.rb \(Rails 3\)})
+  end
+
+  it "asks the default configuration to write itself" do
+    @command.stub!(:check_key).and_return([true, valid_project_data])
+    @command.should_receive(:write_configuration_file).with('config/initializers/localeapp.rb')
+    @command.execute('API_KEY', @output)
+  end
+end

data/spec/locale_app/cli/pull_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'locale_app/cli/pull'
+
+describe LocaleApp::CLI::Pull, "#execute" do
+  before do
+    @output = StringIO.new
+    @puller = LocaleApp::CLI::Pull.new(@output)
+  end
+
+  it "makes the api call to the translations endpoint" do
+    with_configuration do
+      @puller.should_receive(:api_call).with(
+        :translations,
+        :success => :update_backend,
+        :failure => :report_failure,
+        :max_connection_attempts => 3
+      )
+      @puller.execute
+    end
+  end
+end
+
+describe LocaleApp::CLI::Pull, "#update_backend(response)" do
+  before do
+    @test_data = ['test data'].to_json
+    @output = StringIO.new
+    @puller = LocaleApp::CLI::Pull.new(@output)
+  end
+
+  it "calls the updater" do
+    with_configuration do
+      LocaleApp.poller.stub!(:write_synchronization_data!)
+      LocaleApp.updater.should_receive(:update).with(['test data'])
+      @puller.update_backend(@test_data)
+    end
+  end
+
+  it "writes the synchronization data" do
+    with_configuration do
+      LocaleApp.updater.stub!(:update)
+      LocaleApp.poller.should_receive(:write_synchronization_data!)
+      @puller.update_backend(@test_data)
+    end
+  end
+end

data/spec/locale_app/cli/push_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe LocaleApp::CLI::Push, "#execute(file)" do
+  before do
+    @output = StringIO.new
+    @pusher = LocaleApp::CLI::Push.new(@output)
+  end
+
+  it "creates a new file object and makes the api call to the translations endpoint" do
+    with_configuration do
+      file = double('file')
+      file_path = 'test_path'
+      @pusher.stub!(:sanitize_file).and_return(file)
+      @pusher.should_receive(:api_call).with(
+        :import,
+        :payload => { :file => file },
+        :success => :report_success,
+        :failure => :report_failure,
+        :max_connection_attempts => 3
+      )
+      @pusher.execute(file_path)
+    end
+  end
+
+  it "doesn't make the api call when the file doesn't exist" do
+    @pusher.stub!(:sanitize_file).and_return(nil)
+    @pusher.should_not_receive(:api_call)
+    @pusher.execute('foo')
+  end
+end

data/spec/locale_app/cli/update_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'locale_app/cli/update'
+
+describe LocaleApp::CLI::Update, "#execute" do
+  before do
+    @output = StringIO.new
+    @updater = LocaleApp::CLI::Update.new(@output)
+  end
+
+  it "creates a Poller and calls poll! on it" do
+    with_configuration do
+      poller = LocaleApp::Poller.new
+      poller.should_receive(:poll!)
+      LocaleApp::Poller.should_receive(:new).and_return(poller)
+      @updater.execute
+    end
+  end
+end

data/spec/locale_app/configuration_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe LocaleApp::Configuration do
+  before(:each) do
+    @configuration = LocaleApp::Configuration.new
+  end
+
+  it "sets the host by default" do
+    @configuration.host.should == 'api.localeapp.com'
+  end
+
+  it "allows the host to be overwritten" do
+    expect { @configuration.host = 'test.host' }.to change(@configuration, :host).to('test.host')
+  end
+
+  it "includes http_auth_username defaulting to nil" do
+    @configuration.http_auth_username.should == nil
+    @configuration.http_auth_username = "test"
+    @configuration.http_auth_username.should == "test"
+  end
+
+  it "includes http_auth_password defaulting to nil" do
+    @configuration.http_auth_password.should == nil
+    @configuration.http_auth_password = "test"
+    @configuration.http_auth_password.should == "test"
+  end
+
+  it "includes translation_data_directory defaulting to config/locales" do
+    @configuration.translation_data_directory.should == File.join("config", "locales")
+    @configuration.translation_data_directory = "test"
+    @configuration.translation_data_directory.should == "test"
+  end
+
+  context "disabled_sending_environments" do
+    it "does not include development by default" do
+      @configuration.environment_name = 'development'
+      @configuration.sending_disabled?.should be_false
+    end
+
+    it "include cucumber by default" do
+      @configuration.environment_name = 'cucumber'
+      @configuration.sending_disabled?.should be_true
+    end
+
+    it "include test by default" do
+      @configuration.environment_name = 'test'
+      @configuration.sending_disabled?.should be_true
+    end
+
+    it "include production by default" do
+      @configuration.environment_name = 'production'
+      @configuration.sending_disabled?.should be_true
+    end
+  end
+
+  context "disabled_reloading_environments" do
+    it "does not include development by default" do
+      @configuration.environment_name = 'development'
+      @configuration.reloading_disabled?.should be_false
+    end
+
+    it "include cucumber by default" do
+      @configuration.environment_name = 'cucumber'
+      @configuration.reloading_disabled?.should be_true
+    end
+
+    it "include test by default" do
+      @configuration.environment_name = 'test'
+      @configuration.reloading_disabled?.should be_true
+    end
+
+    it "include production by default" do
+      @configuration.environment_name = 'production'
+      @configuration.reloading_disabled?.should be_true
+    end
+  end
+  
+  context "disabled_polling_environments" do
+    it "does not include development by default" do
+      @configuration.environment_name = 'development'
+      @configuration.polling_disabled?.should be_false
+    end
+
+    it "include cucumber by default" do
+      @configuration.environment_name = 'cucumber'
+      @configuration.polling_disabled?.should be_true
+    end
+
+    it "include test by default" do
+      @configuration.environment_name = 'test'
+      @configuration.polling_disabled?.should be_true
+    end
+
+    it "include production by default" do
+      @configuration.environment_name = 'production'
+      @configuration.polling_disabled?.should be_true
+    end
+  end
+end
+
+describe LocaleApp::Configuration, "#write_initial(path)" do
+  it "creates a configuration file containing just the api key at the given path" do
+    configuration = LocaleApp::Configuration.new
+    configuration.api_key = "APIKEY"
+    path = 'test_path'
+    file = stub('file')
+    file.should_receive(:write).with <<-CONTENT
+require 'locale_app/rails'
+
+LocaleApp.configure do |config|
+  config.api_key = 'APIKEY'
+  config.host = 'api.localeapp.com'
+  config.port = 80
+end
+CONTENT
+    File.should_receive(:open).with(path, 'w+').and_yield(file)
+    configuration.write_initial(path)
+  end
+end

data/spec/locale_app/exception_handler_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'locale_app/exception_handler'
+
+describe LocaleApp::ExceptionHandler, '#call(exception, locale, key, options)' do
+  before(:each) do
+    LocaleApp.configure do |config|
+      config.api_key = 'abcdef'
+    end
+  end
+
+  it "adds the missing translation to the missing translation list" do
+    LocaleApp.missing_translations.should_receive(:add).with(:en, 'foo', { :baz => 'bam' })
+    I18n.t('foo', :baz => 'bam')
+  end
+
+  it "handles when the key is an array of keys" do
+    LocaleApp.missing_translations.should_receive(:add).with(:en, 'foo', {})
+    LocaleApp.missing_translations.should_receive(:add).with(:en, 'bar', {})
+    I18n.t(['foo', 'bar'])
+  end
+end