localeapp 0.0.7 → 0.0.8

data/.rvmrc

@@ -1 +1 @@
-rvm ruby-1.9.2@locale_app
+rvm ruby-1.9.2@localeapp

data/bin/localeapp

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 $LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
 
-require 'locale_app'
+require 'localeapp'
 
 # Don't connect to the net if we're running under cucumber for testing
 # Use FakeWeb to simulate api.localeapp.com
@@ -19,7 +19,7 @@ args = ARGV.dup
 command = args.shift.strip rescue nil
 
 unless %w{help install}.include?(command)
-  unless LocaleApp.include_config_file
+  unless Localeapp.include_config_file
     puts "Could not load config file"
     exit
   end
@@ -28,23 +28,23 @@ end
 case command
 when 'install'
   key = args.shift.strip rescue nil
-  installer = LocaleApp::CLI::Install.new
+  installer = Localeapp::CLI::Install.new
   if installer.execute(key)
     exit 0
   else
     exit 1
   end
 when 'pull'
-  LocaleApp::CLI::Pull.new.execute
+  Localeapp::CLI::Pull.new.execute
 when 'push'
   file = args.shift.strip rescue nil
-  pusher = LocaleApp::CLI::Push.new
+  pusher = Localeapp::CLI::Push.new
   pusher.execute(file)
 when 'update'
-  LocaleApp::CLI::Update.new.execute
+  Localeapp::CLI::Update.new.execute
 when 'daemon'
   while true do
-    LocaleApp::CLI::Update.new.execute
+    Localeapp::CLI::Update.new.execute
     sleep 5
   end
 else
@@ -53,8 +53,8 @@ Usage: localeapp COMMAND [ARGS]
 
 Commands:
   install <api_key> - Creates new configuration files and confirms key works
-  pull              - Pulls all translations from LocaleApp.com
-  push <file>       - Pushes a translation file to LocaleApp.com
+  pull              - Pulls all translations from localeapp.com
+  push <file>       - Pushes a translation file to localeapp.com
   update            - Gets any changes since the last poll and updates the yml files
   daemon            - Simple daemon that checks every 5 seconds for new translations
 HELP

data/features/localeapp_binary.feature

@@ -9,7 +9,7 @@ Feature: localeapp executable
 
     Commands:
       install <api_key> - Creates new configuration files and confirms key works
-      pull              - Pulls all translations from LocaleApp.com
+      pull              - Pulls all translations from localeapp.com
     """
 
   Scenario: Running install
@@ -18,7 +18,7 @@ Feature: localeapp executable
     And I run `localeapp install MYAPIKEY`
     Then the output should contain:
     """
-    LocaleApp Install
+    Localeapp Install
 
     Checking API key: MYAPIKEY
     Success!
@@ -34,21 +34,21 @@ Feature: localeapp executable
     And I run `localeapp install BADAPIKEY`
     Then the output should contain:
     """
-    LocaleApp Install
+    Localeapp Install
 
     Checking API key: BADAPIKEY
     ERROR: Project not found
     """
-    And a file named "config/initializers/locale_app.rb" should not exist
+    And a file named "config/initializers/localeapp.rb" should not exist
     And the exit status should not be 0
 
   Scenario: Running pull
     In order to retreive my translations
     Given I have a translations on localeapp.com for the project with api key "MYAPIKEY"
-    And a file named "config/initializers/locale_app.rb" with:
+    And a file named "config/initializers/localeapp.rb" with:
     """
-    require 'locale_app/rails'
-    LocaleApp.configure do |config|
+    require 'localeapp/rails'
+    Localeapp.configure do |config|
       config.api_key = 'MYAPIKEY'
     end
     """
@@ -56,7 +56,7 @@ Feature: localeapp executable
     When I run `localeapp pull`
     Then the output should contain:
     """
-    LocaleApp Pull
+    Localeapp Pull
 
     Fetching translations:
     Success!
@@ -68,10 +68,10 @@ Feature: localeapp executable
   Scenario: Running push
     In order to send my translations
     When I have a valid project on localeapp.com with api key "MYAPIKEY"
-    And a file named "config/initializers/locale_app.rb" with:
+    And a file named "config/initializers/localeapp.rb" with:
     """
-    require 'locale_app/rails'
-    LocaleApp.configure do |config|
+    require 'localeapp/rails'
+    Localeapp.configure do |config|
       config.api_key = 'MYAPIKEY'
     end
     """
@@ -79,7 +79,7 @@ Feature: localeapp executable
     When I run `localeapp push config/locales/en.yml`
     Then the output should contain:
     """
-    LocaleApp Push
+    Localeapp Push
 
     Pushing file:
     Success!
@@ -90,14 +90,14 @@ Feature: localeapp executable
   Scenario: Running update
     In order to receive the translations that have been updated since the last check
     When I have a valid project on localeapp.com with api key "MYAPIKEY"
-    And a file named "config/initializers/locale_app.rb" with:
+    And a file named "config/initializers/localeapp.rb" with:
     """
-    require 'locale_app/rails'
-    LocaleApp.configure do |config|
+    require 'localeapp/rails'
+    Localeapp.configure do |config|
       config.api_key = 'MYAPIKEY'
     end
     """
-    And a file named "log/locale_app.yml" with:
+    And a file named "log/localeapp.yml" with:
     """
     ---
     :updated_at: 120
@@ -108,7 +108,7 @@ Feature: localeapp executable
     When I run `localeapp update`
     Then the output should contain:
     """
-    LocaleApp update: checking for translations since 120
+    Localeapp update: checking for translations since 120
     Found and updated new translations
     """
     And a file named "config/locales/en.yml" should exist

data/features/support/env.rb

@@ -1,6 +1,6 @@
 require 'aruba/cucumber'
-require File.expand_path(File.join(File.dirname(__FILE__), '../../spec/support/locale_app_integration_data'))
-World(LocaleAppIntegrationData)
+require File.expand_path(File.join(File.dirname(__FILE__), '../../spec/support/localeapp_integration_data'))
+World(LocaleappIntegrationData)
 
 ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
 

data/init.rb

@@ -1 +1 @@
-require 'locale_app'
+require 'localeapp'

data/lib/{locale_app → localeapp}/api_call.rb

@@ -1,8 +1,8 @@
-module LocaleApp
+module Localeapp
   module ApiCall
     # creates an object to perform the call
     def api_call(endpoint, options = {})
-      api_caller = LocaleApp::ApiCaller.new(endpoint, options)
+      api_caller = Localeapp::ApiCaller.new(endpoint, options)
       api_caller.call(self)
     end
   end

data/lib/{locale_app → localeapp}/api_caller.rb

@@ -1,6 +1,6 @@
-module LocaleApp
+module Localeapp
   class ApiCaller
-    include ::LocaleApp::Routes
+    include ::Localeapp::Routes
 
     NonHTTPResponse = Struct.new(:code)
 
@@ -20,16 +20,16 @@ module LocaleApp
 
     def call(obj)
       method, url = send("#{endpoint}_endpoint", options[:url_options] || {})
-      LocaleApp.debug("API CALL: #{method} #{url}")
+      Localeapp.debug("API CALL: #{method} #{url}")
       success = false
       while connection_attempts < max_connection_attempts
         sleep_if_retrying
         response = make_call(method, url)
-        LocaleApp.debug("RESPONSE: #{response.code}")
+        Localeapp.debug("RESPONSE: #{response.code}")
         valid_response_codes = (200..207).to_a
         if valid_response_codes.include?(response.code.to_i)
           if options[:success]
-            LocaleApp.debug("CALLING SUCCESS HANDLER: #{options[:success]}")
+            Localeapp.debug("CALLING SUCCESS HANDLER: #{options[:success]}")
             obj.send(options[:success], response)
           end
           success = true
@@ -46,7 +46,7 @@ module LocaleApp
     def make_call(method, url)
       begin
         @connection_attempts += 1
-        LocaleApp.debug("ATTEMPT #{@connection_attempts}")
+        Localeapp.debug("ATTEMPT #{@connection_attempts}")
         request_options = options[:request_options] || {}
         if method == :post
           RestClient.send(method, url, options[:payload], request_options)
@@ -61,7 +61,7 @@ module LocaleApp
         RestClient::GatewayTimeout => error
         return error.response
       rescue Errno::ECONNREFUSED => error
-        LocaleApp.debug("ERROR: Connection Refused")
+        Localeapp.debug("ERROR: Connection Refused")
         return NonHTTPResponse.new(-1)
       end
     end
@@ -69,7 +69,7 @@ module LocaleApp
     def sleep_if_retrying
       if @connection_attempts > 0
         time = @connection_attempts * 5
-        LocaleApp.debug("Sleeping for #{time} before retrying")
+        Localeapp.debug("Sleeping for #{time} before retrying")
         sleep time
       end
     end

data/lib/{locale_app → localeapp}/cli/install.rb

@@ -1,8 +1,8 @@
-module LocaleApp
+module Localeapp
   module CLI
     class Install
       def execute(key, output = $stdout)
-        output.puts "LocaleApp Install"
+        output.puts "Localeapp Install"
         output.puts ""
         output.puts "Checking API key: #{key}"
         if key.nil?
@@ -13,9 +13,9 @@ module LocaleApp
         if valid_key
           output.puts "Success!"
           output.puts "Project: #{project_data['name']}"
-          locale_app_default_code = project_data['default_locale']['code']
-          output.puts "Default Locale: #{locale_app_default_code} (#{project_data['default_locale']['name']})"
-          if I18n.default_locale.to_s != locale_app_default_code
+          localeapp_default_code = project_data['default_locale']['code']
+          output.puts "Default Locale: #{localeapp_default_code} (#{project_data['default_locale']['name']})"
+          if I18n.default_locale.to_s != localeapp_default_code
             output.puts "WARNING: I18n.default_locale is #{I18n.default_locale}, change in config/environment.rb (Rails 2) or config/application.rb (Rails 3)"
           end
           config_file_path = "config/initializers/localeapp.rb"
@@ -30,11 +30,11 @@ module LocaleApp
 
       private
       def check_key(key)
-        LocaleApp::KeyChecker.new.check(key)
+        Localeapp::KeyChecker.new.check(key)
       end
 
       def write_configuration_file(path)
-        LocaleApp.configuration.write_initial(path)
+        Localeapp.configuration.write_initial(path)
       end
     end
   end

data/lib/{locale_app → localeapp}/cli/pull.rb

@@ -1,14 +1,14 @@
-module LocaleApp
+module Localeapp
   module CLI
     class Pull
-      include ::LocaleApp::ApiCall
+      include ::Localeapp::ApiCall
 
       def initialize(output = $stdout)
         @output = output
       end
 
       def execute
-        @output.puts "LocaleApp Pull"
+        @output.puts "Localeapp Pull"
         @output.puts ""
 
         @output.puts "Fetching translations:"
@@ -21,9 +21,9 @@ module LocaleApp
       def update_backend(response)
         @output.puts "Success!"
         @output.puts "Updating backend:"
-        LocaleApp.updater.update(JSON.parse(response))
+        Localeapp.updater.update(JSON.parse(response))
         @output.puts "Success!"
-        LocaleApp.poller.write_synchronization_data!(Time.now.to_i, Time.now.to_i)
+        Localeapp.poller.write_synchronization_data!(Time.now.to_i, Time.now.to_i)
       end
 
       def report_failure(response)

data/lib/{locale_app → localeapp}/cli/push.rb

@@ -1,14 +1,14 @@
-module LocaleApp
+module Localeapp
   module CLI
     class Push
-      include ::LocaleApp::ApiCall
+      include ::Localeapp::ApiCall
 
       def initialize(output = $stdout)
         @output = output
       end
 
       def execute(file_path = nil)
-        @output.puts "LocaleApp Push"
+        @output.puts "Localeapp Push"
         @output.puts ""
 
         @file_path = file_path

data/lib/{locale_app → localeapp}/cli/update.rb

@@ -1,4 +1,4 @@
-module LocaleApp
+module Localeapp
   module CLI
     class Update
       def initialize(output = $stdout)
@@ -6,8 +6,8 @@ module LocaleApp
       end
 
       def execute
-        poller = LocaleApp::Poller.new
-        @output.puts("LocaleApp update: checking for translations since #{poller.updated_at}")
+        poller = Localeapp::Poller.new
+        @output.puts("Localeapp update: checking for translations since #{poller.updated_at}")
         if poller.poll!
           @output.puts "Found and updated new translations"
         else

data/lib/{locale_app → localeapp}/configuration.rb

@@ -1,4 +1,4 @@
-module LocaleApp
+module Localeapp
   class Configuration
   
     # The API key for your project, found on the project edit form
@@ -32,7 +32,7 @@ module LocaleApp
     # 'test', 'cucumber', 'production')
     attr_accessor :disabled_polling_environments
 
-    # The logger used by LocaleApp
+    # The logger used by Localeapp
     attr_accessor :logger
 
     # The number of seconds to wait before asking the service for new
@@ -40,8 +40,8 @@ module LocaleApp
     attr_accessor :poll_interval
 
     # The complete path to the data file where we store synchronization
-    # information (defaults to ./locale_app.yml) local_app/rails overwrites
-    # this to RAILS_ROOT/log/locale_app.yml
+    # information (defaults to ./localeapp.yml) local_app/rails overwrites
+    # this to RAILS_ROOT/log/localeapp.yml
     attr_accessor :synchronization_data_file
 
     # The complete path to the directory where translations are stored
@@ -54,7 +54,7 @@ module LocaleApp
       @disabled_reloading_environments = %w(test cucumber production)
       @disabled_polling_environments   = %w(test cucumber production)
       @poll_interval                   = 0
-      @synchronization_data_file       = File.join('log', 'locale_app.yml')
+      @synchronization_data_file       = File.join('log', 'localeapp.yml')
       @translation_data_directory      = File.join('config', 'locales')
       if ENV['DEBUG']
         require 'logger'
@@ -79,9 +79,9 @@ module LocaleApp
       FileUtils.mkdir_p(dir)
       File.open(path, 'w+') do |file|
         file.write <<-CONTENT
-require 'locale_app/rails'
+require 'localeapp/rails'
 
-LocaleApp.configure do |config|
+Localeapp.configure do |config|
   config.api_key = '#{@api_key}'
   config.host = '#{@host}'
   config.port = #{@port}

data/lib/localeapp/exception_handler.rb

@@ -0,0 +1,21 @@
+module Localeapp
+  class ExceptionHandler
+    def self.call(exception, locale, key, options)
+      Localeapp.log(exception.message)
+      if I18n::MissingTranslationData === exception
+        Localeapp.log("Detected missing translation for key(s) #{key.inspect}")
+
+        [*key].each do |key|
+          Localeapp.missing_translations.add(locale, key, options)
+        end
+
+        [locale, key].join(', ')
+      else
+        Localeapp.log('Raising exception')
+        raise
+      end
+    end
+  end
+end
+
+I18n.exception_handler = Localeapp::ExceptionHandler

data/lib/{locale_app → localeapp}/key_checker.rb

@@ -2,16 +2,16 @@ require 'yaml'
 require 'rest-client'
 require 'time'
 
-module LocaleApp
+module Localeapp
   class KeyChecker
-    include ::LocaleApp::ApiCall
+    include ::Localeapp::ApiCall
 
     def check(key)
-      if LocaleApp.configuration.nil? # no config file yet
-        LocaleApp.configuration = LocaleApp::Configuration.new
-        LocaleApp.configuration.host = ENV['LA_TEST_HOST'] if ENV['LA_TEST_HOST']
+      if Localeapp.configuration.nil? # no config file yet
+        Localeapp.configuration = Localeapp::Configuration.new
+        Localeapp.configuration.host = ENV['LA_TEST_HOST'] if ENV['LA_TEST_HOST']
       end
-      LocaleApp.configuration.api_key = key
+      Localeapp.configuration.api_key = key
       api_call :project,
         :success => :handle_success,
         :failure => :handle_failure,

data/lib/{locale_app → localeapp}/missing_translations.rb

@@ -1,4 +1,4 @@
-module LocaleApp
+module Localeapp
   MissingTranslationRecord = Struct.new(:key, :locale, :options)
 
   class MissingTranslations

data/lib/{locale_app → localeapp}/poller.rb

@@ -2,9 +2,9 @@ require 'yaml'
 require 'rest-client'
 require 'time'
 
-module LocaleApp
+module Localeapp
   class Poller
-    include ::LocaleApp::ApiCall
+    include ::Localeapp::ApiCall
     
     # when we last asked the service for updates
     attr_accessor :polled_at
@@ -18,21 +18,21 @@ module LocaleApp
     end
 
     def synchronization_data
-      if File.exists?(LocaleApp.configuration.synchronization_data_file)
-        YAML.load_file(LocaleApp.configuration.synchronization_data_file)
+      if File.exists?(Localeapp.configuration.synchronization_data_file)
+        YAML.load_file(Localeapp.configuration.synchronization_data_file)
       else
         {}
       end
     end
 
     def write_synchronization_data!(polled_at, updated_at)
-      File.open(LocaleApp.configuration.synchronization_data_file, 'w+') do |f|
+      File.open(Localeapp.configuration.synchronization_data_file, 'w+') do |f|
         f.write({:polled_at => polled_at, :updated_at => updated_at}.to_yaml)
       end
     end
 
     def needs_polling?
-      synchronization_data[:polled_at] < (Time.now.to_i - LocaleApp.configuration.poll_interval)
+      synchronization_data[:polled_at] < (Time.now.to_i - Localeapp.configuration.poll_interval)
     end
 
     def needs_reloading?
@@ -50,7 +50,7 @@ module LocaleApp
 
     def handle_success(response)
       @success = true
-      LocaleApp.updater.update(JSON.parse(response))
+      Localeapp.updater.update(JSON.parse(response))
       write_synchronization_data!(Time.now.to_i, Time.parse(response.headers[:date]).to_i)
     end
 

data/lib/{locale_app → localeapp}/rails/2_3_translation_helper_monkeypatch.rb

@@ -2,7 +2,7 @@
 # This means the exception handler will be called and missing translations get sent to
 # localeapp. It's ugly but there's no other way to do it :(
 
-module LocaleApp::TranslationHelperMonkeyPatch
+module Localeapp::TranslationHelperMonkeyPatch
   # Delegates to I18n#translate but also performs two additional functions. First, it'll catch MissingTranslationData exceptions
   # and turn them into inline spans that contains the missing key, such that you can see in a view what is missing where.
   #
@@ -33,4 +33,4 @@ module LocaleApp::TranslationHelperMonkeyPatch
   alias :t :translate
 end
 
-ActionView::Base.send(:include, ::LocaleApp::TranslationHelperMonkeyPatch)
+ActionView::Base.send(:include, ::Localeapp::TranslationHelperMonkeyPatch)

data/lib/localeapp/rails/controller.rb

@@ -0,0 +1,34 @@
+module Localeapp
+  module Rails
+    module Controller
+      def self.included(base)
+        base.before_filter :handle_translation_updates
+        base.after_filter  :send_missing_translations
+      end
+
+      def handle_translation_updates
+        unless ::Localeapp.configuration.polling_disabled?
+          ::Localeapp.log Time.now.to_i.to_s << '-- Handling translation updates'
+          if ::Localeapp.poller.needs_polling?
+            ::Localeapp.log Time.now.to_i.to_s << ' - polling'
+            ::Localeapp.poller.poll!
+          end
+        end
+
+        unless ::Localeapp.configuration.reloading_disabled?
+          if ::Localeapp.poller.needs_reloading?
+            ::Localeapp.log Time.now.to_i.to_s << '- reloading I18n'
+            I18n.reload!
+            ::Localeapp.poller.updated_at = ::Localeapp.poller.synchronization_data[:updated_at]
+          end
+        end
+      end
+
+      def send_missing_translations
+        return if ::Localeapp.configuration.sending_disabled?
+
+        ::Localeapp.sender.post_missing_translations
+      end
+    end
+  end
+end

data/lib/{locale_app → localeapp}/rails.rb

@@ -1,4 +1,4 @@
-module LocaleApp
+module Localeapp
   module Rails
     def self.initialize
       if defined?(::Rails.logger)
@@ -19,25 +19,25 @@ module LocaleApp
         rails_root = RAILS_ROOT
       end
 
-      ActionController::Base.send(:include, LocaleApp::Rails::Controller)
+      ActionController::Base.send(:include, Localeapp::Rails::Controller)
 
       if ::Rails::VERSION::MAJOR == 2 && ::Rails::VERSION::MINOR >= 3 # TODO: Check previous rails versions if required
-        require 'locale_app/rails/2_3_translation_helper_monkeypatch'
+        require 'localeapp/rails/2_3_translation_helper_monkeypatch'
       end
 
-      LocaleApp.configure do |config|
+      Localeapp.configure do |config|
         config.logger                     = rails_logger
         config.environment_name           = rails_env
         config.project_root               = rails_root
-        config.synchronization_data_file  = File.join([rails_root, 'log', 'locale_app.yml'])
+        config.synchronization_data_file  = File.join([rails_root, 'log', 'localeapp.yml'])
         config.translation_data_directory = File.join([rails_root, 'config', 'locales'])
       end
       initialize_synchronization_data_file
     end
 
     def self.initialize_synchronization_data_file
-      if !File.exists?(LocaleApp.configuration.synchronization_data_file)
-        File.open(LocaleApp.configuration.synchronization_data_file, 'w') do |f|
+      if !File.exists?(Localeapp.configuration.synchronization_data_file)
+        File.open(Localeapp.configuration.synchronization_data_file, 'w') do |f|
           f.write({:polled_at => Time.now.to_i, :updated_at => Time.now.to_i}.to_yaml)
         end
       end
@@ -46,8 +46,8 @@ module LocaleApp
 end
 
 if defined?(Rails)
-  require 'locale_app/rails/controller'
-  require 'locale_app/exception_handler'
-  LocaleApp::Rails.initialize
-  LocaleApp.log('Loaded locale_app/rails')
+  require 'localeapp/rails/controller'
+  require 'localeapp/exception_handler'
+  Localeapp::Rails.initialize
+  Localeapp.log('Loaded localeapp/rails')
 end

data/lib/{locale_app → localeapp}/routes.rb

@@ -1,4 +1,4 @@
-module LocaleApp
+module Localeapp
   module Routes
     VERSION = 'v1'
 
@@ -48,15 +48,15 @@ module LocaleApp
   private
 
     def base_options
-      options = {:host => LocaleApp.configuration.host, :port => LocaleApp.configuration.port}
-      if LocaleApp.configuration.http_auth_username
-        options[:userinfo] = "#{LocaleApp.configuration.http_auth_username}:#{LocaleApp.configuration.http_auth_password}"
+      options = {:host => Localeapp.configuration.host, :port => Localeapp.configuration.port}
+      if Localeapp.configuration.http_auth_username
+        options[:userinfo] = "#{Localeapp.configuration.http_auth_username}:#{Localeapp.configuration.http_auth_password}"
       end
       options
     end
 
     def project_path(format = nil)
-      path = "/#{VERSION}/projects/#{LocaleApp.configuration.api_key}"
+      path = "/#{VERSION}/projects/#{Localeapp.configuration.api_key}"
       path << ".#{format}" if format
       path
     end