localeapp 0.0.7 → 0.0.8

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

@@ -1,10 +1,10 @@
 require 'rest-client'
 require 'json'
 
-module LocaleApp
+module Localeapp
   class Sender
-    include ::LocaleApp::ApiCall
-    include ::LocaleApp::Routes
+    include ::Localeapp::ApiCall
+    include ::Localeapp::Routes
 
     def post_translation(locale, key, options, value = nil)
       options ||= {}
@@ -19,15 +19,15 @@ module LocaleApp
     end
 
     def handle_single_translation_success(response)
-       LocaleApp.log([translations_url, response.code, @data.inspect].join(' - '))
+       Localeapp.log([translations_url, response.code, @data.inspect].join(' - '))
     end
 
     def handle_single_translation_failure(response)
-       LocaleApp.log([translations_url, response.code, @data.inspect].join(' - '))
+       Localeapp.log([translations_url, response.code, @data.inspect].join(' - '))
     end
 
     def post_missing_translations
-      to_send = LocaleApp.missing_translations.to_send
+      to_send = Localeapp.missing_translations.to_send
       return if to_send.empty?
       @data = { :translations => to_send }
       api_call :missing_translations,
@@ -39,11 +39,11 @@ module LocaleApp
     end
 
     def handle_missing_translation_success(response)
-       LocaleApp.log([translations_url, response.code, @data.inspect].join(' - '))
+       Localeapp.log([translations_url, response.code, @data.inspect].join(' - '))
     end
 
     def handle_missing_translation_failure(response)
-       LocaleApp.log([translations_url, response.code, @data.inspect].join(' - '))
+       Localeapp.log([translations_url, response.code, @data.inspect].join(' - '))
     end
   end
 end

data/lib/{locale_app/tasks/locale_app.rake → localeapp/tasks/localeapp.rake}

@@ -1,4 +1,4 @@
-namespace :locale_app do
+namespace :localeapp do
   desc 'Imports the en.yml file to the LocaleServer'
   task :import => :environment do
     require 'flatten'
@@ -13,7 +13,7 @@ namespace :locale_app do
         nil
       ).each do |key, value|
         puts "#{key} => #{value}"
-        LocaleApp.sender.post_translation(locale, key, {}, value)
+        Localeapp.sender.post_translation(locale, key, {}, value)
       end
     end
   end

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

@@ -1,9 +1,9 @@
-module LocaleApp
+module Localeapp
   class Updater
 
     def update(data)
       data['locales'].each do |short_code|
-        filename = File.join(LocaleApp.configuration.translation_data_directory, "#{short_code}.yml")
+        filename = File.join(Localeapp.configuration.translation_data_directory, "#{short_code}.yml")
 
         if File.exist?(filename)
           translations = YAML.load(File.read(filename))

data/lib/localeapp/version.rb

@@ -0,0 +1,3 @@
+module Localeapp
+  VERSION = "0.0.8"
+end

data/lib/localeapp.rb

@@ -1 +1,98 @@
-require File.expand_path("locale_app.rb",File.dirname(__FILE__))
+# 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 'localeapp/version'
+require 'localeapp/configuration'
+require 'localeapp/routes'
+require 'localeapp/api_call'
+require 'localeapp/api_caller'
+require 'localeapp/sender'
+require 'localeapp/poller'
+require 'localeapp/updater'
+require 'localeapp/key_checker'
+require 'localeapp/missing_translations'
+  
+require 'localeapp/cli/install'
+require 'localeapp/cli/pull'
+require 'localeapp/cli/push'
+require 'localeapp/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', 'localeapp')
+      begin
+        require file_path
+        true
+      rescue
+        false
+      end
+    end
+  end
+end

data/localeapp.gemspec

@@ -1,10 +1,10 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "locale_app/version"
+require "localeapp/version"
 
 Gem::Specification.new do |s|
   s.name        = "localeapp"
-  s.version     = LocaleApp::VERSION
+  s.version     = Localeapp::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Christopher Dell", "Chris McGrath"]
   s.email       = ["chris@tigrish.com", "chris@octopod.info"]

data/run_ci

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

data/spec/{locale_app → localeapp}/api_call_spec.rb

@@ -1,15 +1,15 @@
 require 'spec_helper'
 
 class ApiCallTest
-  include LocaleApp::ApiCall
+  include Localeapp::ApiCall
 end
 
-describe LocaleApp::ApiCall, "#api_call(endpoint, options = {})" do
+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)
+    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 → localeapp}/api_caller_spec.rb

@@ -1,16 +1,16 @@
 require 'spec_helper'
 
-describe LocaleApp::ApiCaller, ".new(endpoint, options = {})" do
+describe Localeapp::ApiCaller, ".new(endpoint, options = {})" do
   it "stores the endpoint and options" do
-    api_caller = LocaleApp::ApiCaller.new(:endpoint, :foo => :bar)
+    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
+describe Localeapp::ApiCaller, "#call(object)" do
   before do
-    @api_caller = LocaleApp::ApiCaller.new(:test)
+    @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)

data/spec/{locale_app → localeapp}/cli/install_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
-require 'locale_app/cli/install'
+require 'localeapp/cli/install'
 
-describe LocaleApp::CLI::Install, '.execute(key, output = $stdout)' do
+describe Localeapp::CLI::Install, '.execute(key, output = $stdout)' do
   before(:each) do
     @output = StringIO.new
-    @command = LocaleApp::CLI::Install.new
+    @command = Localeapp::CLI::Install.new
   end
 
   it "displays error if key is nil" do

data/spec/{locale_app → localeapp}/cli/pull_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
-require 'locale_app/cli/pull'
+require 'localeapp/cli/pull'
 
-describe LocaleApp::CLI::Pull, "#execute" do
+describe Localeapp::CLI::Pull, "#execute" do
   before do
     @output = StringIO.new
-    @puller = LocaleApp::CLI::Pull.new(@output)
+    @puller = Localeapp::CLI::Pull.new(@output)
   end
 
   it "makes the api call to the translations endpoint" do
@@ -20,25 +20,25 @@ describe LocaleApp::CLI::Pull, "#execute" do
   end
 end
 
-describe LocaleApp::CLI::Pull, "#update_backend(response)" do
+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)
+    @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'])
+      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!)
+      Localeapp.updater.stub!(:update)
+      Localeapp.poller.should_receive(:write_synchronization_data!)
       @puller.update_backend(@test_data)
     end
   end

data/spec/{locale_app → localeapp}/cli/push_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe LocaleApp::CLI::Push, "#execute(file)" do
+describe Localeapp::CLI::Push, "#execute(file)" do
   before do
     @output = StringIO.new
-    @pusher = LocaleApp::CLI::Push.new(@output)
+    @pusher = Localeapp::CLI::Push.new(@output)
   end
 
   it "creates a new file object and makes the api call to the translations endpoint" do

data/spec/localeapp/cli/update_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'localeapp/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 → localeapp}/configuration_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe LocaleApp::Configuration do
+describe Localeapp::Configuration do
   before(:each) do
-    @configuration = LocaleApp::Configuration.new
+    @configuration = Localeapp::Configuration.new
   end
 
   it "sets the host by default" do
@@ -98,16 +98,16 @@ describe LocaleApp::Configuration do
   end
 end
 
-describe LocaleApp::Configuration, "#write_initial(path)" do
+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 = Localeapp::Configuration.new
     configuration.api_key = "APIKEY"
     path = 'test_path'
     file = stub('file')
     file.should_receive(:write).with <<-CONTENT
-require 'locale_app/rails'
+require 'localeapp/rails'
 
-LocaleApp.configure do |config|
+Localeapp.configure do |config|
   config.api_key = 'APIKEY'
   config.host = 'api.localeapp.com'
   config.port = 80

data/spec/{locale_app → localeapp}/exception_handler_spec.rb

@@ -1,21 +1,21 @@
 require 'spec_helper'
-require 'locale_app/exception_handler'
+require 'localeapp/exception_handler'
 
-describe LocaleApp::ExceptionHandler, '#call(exception, locale, key, options)' do
+describe Localeapp::ExceptionHandler, '#call(exception, locale, key, options)' do
   before(:each) do
-    LocaleApp.configure do |config|
+    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' })
+    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', {})
+    Localeapp.missing_translations.should_receive(:add).with(:en, 'foo', {})
+    Localeapp.missing_translations.should_receive(:add).with(:en, 'bar', {})
     I18n.t(['foo', 'bar'])
   end
 end

data/spec/{locale_app → localeapp}/key_checker_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe LocaleApp::KeyChecker, "#check(key)" do
+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
+      @checker = Localeapp::KeyChecker.new
     end
     @checker.check('TEST_KEY').should == [false, {}]
   end
@@ -12,7 +12,7 @@ describe LocaleApp::KeyChecker, "#check(key)" do
   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
+      @checker = Localeapp::KeyChecker.new
     end
     @checker.check('TEST_KEY').should == [true, valid_project_data]
   end

data/spec/{locale_app → localeapp}/missing_translations_spec.rb

@@ -1,18 +1,18 @@
 require 'spec_helper'
-require 'locale_app/missing_translations'
+require 'localeapp/missing_translations'
 
-describe LocaleApp::MissingTranslations, "#add(locale, key, options = {})" do
+describe Localeapp::MissingTranslations, "#add(locale, key, options = {})" do
   it "stores the missing translation data" do
-    translations = LocaleApp::MissingTranslations.new
+    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
+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 = Localeapp::MissingTranslations.new
     translations.add(:en, 'foo', { :baz => 'bam' })
     translations.add(:es, 'bar')
 

data/spec/{locale_app → localeapp}/poller_spec.rb

@@ -1,16 +1,16 @@
 require 'spec_helper'
 
-describe LocaleApp::Poller do
+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
+    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
+    LocaleappSynchronizationData::destroy
   end
 
   describe "#needs_reloading?" do
@@ -54,7 +54,7 @@ describe LocaleApp::Poller do
 
     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)
+      Localeapp.updater.should_receive(:update).with(@hash)
       @poller.poll!
     end
   end

data/spec/{locale_app → localeapp}/rails/controller_spec.rb

@@ -7,64 +7,64 @@ class TestController
   end
 end
 
-require 'locale_app/rails/controller'
+require 'localeapp/rails/controller'
 
-describe LocaleApp::Rails::Controller, '#handle_translation_updates' do
+describe Localeapp::Rails::Controller, '#handle_translation_updates' do
   before do
-    TestController.send(:include, LocaleApp::Rails::Controller)
-    with_configuration(:synchronization_data_file => LocaleAppSynchronizationData::setup) do
+    TestController.send(:include, Localeapp::Rails::Controller)
+    with_configuration(:synchronization_data_file => LocaleappSynchronizationData::setup) do
       @controller = TestController.new
     end
   end
 
   after do
-    LocaleAppSynchronizationData::destroy
+    LocaleappSynchronizationData::destroy
   end
 
   context "when polling is enabled" do
     before do
-      LocaleApp.configuration.environment_name = 'development' # reloading enabled
-      LocaleApp.configuration.disabled_reloading_environments << 'development'
+      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!)
+      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!)
+      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'
+      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!)
+      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!)
+      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'
+      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)
+      Localeapp.poller.write_synchronization_data!(01234, 56789)
       I18n.should_receive(:reload!)
       @controller.handle_translation_updates
     end
@@ -77,12 +77,12 @@ describe LocaleApp::Rails::Controller, '#handle_translation_updates' do
  
   context "when reloading is disabled" do
     before do
-      LocaleApp.configuration.environment_name = 'production' # reloading disabled
-      LocaleApp.configuration.disabled_polling_environments << 'production'
+      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)
+      Localeapp.poller.write_synchronization_data!(01234, 56789)
       I18n.should_not_receive(:reload!)
       @controller.handle_translation_updates
     end
@@ -94,24 +94,24 @@ describe LocaleApp::Rails::Controller, '#handle_translation_updates' do
   end
 end
 
-describe LocaleApp::Rails::Controller, '#send_missing_translations' do
+describe Localeapp::Rails::Controller, '#send_missing_translations' do
   before(:each) do
-    LocaleApp.configure do |config|
+    Localeapp.configure do |config|
       config.api_key = 'abcdef'
     end
-    TestController.send(:include, LocaleApp::Rails::Controller)
+    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)
+    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)
+    Localeapp.configuration.environment_name = 'development'
+    Localeapp.sender.should_receive(:post_missing_translations)
     @controller.send_missing_translations
   end
 end

data/spec/{locale_app → localeapp}/routes_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
 class TestRoutes
-  include LocaleApp::Routes
+  include Localeapp::Routes
 end
   
-describe LocaleApp::Routes do
+describe Localeapp::Routes do
   before(:each) do
     @routes = TestRoutes.new
     @config = {:host => 'test.host', :api_key => 'API_KEY'}