localeapp 0.0.7

data/.autotest

@@ -0,0 +1,4 @@
+Autotest.add_hook :initialize do |at|
+  at.add_exception %r{^\./\.git/}
+  at.add_exception %r{^\./tmp/}
+end

data/.gitignore

@@ -0,0 +1,7 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock
+.yardoc/*
+doc/*
+tmp/*

data/.rspec

@@ -0,0 +1,2 @@
+-I ./lib
+-I ./spec

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2@locale_app

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+branches:
+  only:
+    - master
+    - develop

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubyforge
+gemspec

data/README.textile

@@ -0,0 +1,147 @@
+h1. Locale
+
+The localeapp gem connects your rails app to the Locale service on
+"localeapp.com":http://www.localeapp.com. Locale makes hand editing translation
+files something you don't have to do.
+
+The gem hooks into the i18n exception mechanism to send missing translations to
+the app. When translated content has been added it's automatically pulled down
+so you can see it straight away.
+
+We're still in private beta but if you think Locale would be useful to you and
+are willing to provide feedback then please get in touch at info@localeapp.com
+and we'll see what we can do.
+
+h2. Installation
+
+h3. Rails 3
+
+Add the localeapp gem to your Gemfile and install it:
+
+<pre>
+  echo "gem 'localeapp'" >> Gemfile
+  bundle install
+</pre>
+
+Create a project on localeapp.com and get the api key. Then run:
+
+<pre>
+  bundle exec localeapp install <YOUR_API_KEY>
+</pre>
+
+This will check everything looks good and create
+config/initializers/localeapp.rb for you.
+
+h3. Rails 2.3
+
+Define localeapp in config/environment.rb:
+
+<pre>
+  config.gem 'localeapp'
+</pre>
+
+Install the gem:
+
+<pre>
+  rake gems:install
+</pre>
+
+Create a project on localeapp.com and get the api key. Then run:
+
+<pre>
+  localeapp install <YOUR_API_KEY>
+</pre>
+
+h2. Importing existing content
+
+You can import via localeapp.com or with the command line tool. To import
+existing translations do:
+
+<pre>
+  localeapp import config/locales/en.yml
+</pre>
+
+This will queue importing the file. The projects pages on localeapp.com will
+automatically refresh so you can see the import progress.
+
+If you've more than one locale to import you can zip up the yml files. Both
+localeapp.com and the localeapp import command accept zip files.
+
+h2. Automatically sending missing translations
+
+Missing translations are automatically sent only in the development environment
+by default. When a page is refreshed any missing translations will be sent to
+localeapp.com.
+
+If you want to disable sending missing translations in the development
+environment then edit config/initializers/localeapp.rb to include:
+
+<pre>
+  config.disabled_sending_environments << 'development'
+</pre>
+
+This is just an array, so you can configure it to match any environment you
+wish.
+
+h2. Automatically pulling translations
+
+There are two ways to do this, one that suits a single developer working the
+code locally and one where the translations are being pulled down to a staging
+(or live) server.
+
+h3. Single developer
+
+In this mode the gem pulls any updated translations from localeapp.com at the
+beginning of each request. This is the default setting so you don't need to do
+anything special.
+
+h3. Staging server
+
+In this mode you configure the individual listeners to not poll every request
+and instead run localeapp in daemon mode to fetch updated translations. This is
+useful when you have more than one listener and don't want them to race to
+update the translations.
+
+h4. Disabling polling
+
+Edit config/initializers/localeapp.rb to include:
+
+<pre>
+  config.disabled_polling_environments << 'development'
+</pre>
+
+Run the daemon with:
+
+<pre>
+  localeapp daemon
+</pre>
+
+The listeners will automatically reload translations when they see there are
+new ones.
+
+h3. Disabling Reloading
+
+Automatic reloading is disabled everywhere but the development environment, and
+can be disabled there in a similar way to polling and sending:
+
+<pre>
+  config.disabled_reloading_environments << 'development'
+</pre>
+
+h3. Inviting other developers and translators
+
+You can invite other developers and translators via localeapp.com.  Developers
+have access to all the content and all the locales. Translators are restricted
+to editing only the locales you give them access too.
+
+h3. Adding a locale
+
+If we find an unknown locale during an import we'll add it to your project.
+You can also add a new locale to a project via localeapp.com. This will create
+missing translations for every translation key. You will need to restart any
+listeners completely to pick up the new locale.
+
+h3. Support and feedback
+
+You can contact us via the support link at the bottom of the page, emailing
+info@localeapp.com, or on campfire at https://localeapp.campfirenow.com/d77b5

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => [:spec, :features]
+

data/bin/localeapp

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'locale_app'
+
+# Don't connect to the net if we're running under cucumber for testing
+# Use FakeWeb to simulate api.localeapp.com
+if ENV['FAKE_WEB_DURING_CUCUMBER_RUN'] && fake_data_as_json = ENV['FAKE_WEB_FAKES']
+  require 'fakeweb'
+  FakeWeb.allow_net_connect = false
+  fakes = JSON.parse(fake_data_as_json)
+  fakes.each do |fake|
+    FakeWeb.register_uri fake['method'].to_sym, fake['uri'], { :body => fake['body'], :status => fake['status'] }.merge(fake['headers'])
+  end
+end
+
+args = ARGV.dup
+
+command = args.shift.strip rescue nil
+
+unless %w{help install}.include?(command)
+  unless LocaleApp.include_config_file
+    puts "Could not load config file"
+    exit
+  end
+end
+
+case command
+when 'install'
+  key = args.shift.strip rescue nil
+  installer = LocaleApp::CLI::Install.new
+  if installer.execute(key)
+    exit 0
+  else
+    exit 1
+  end
+when 'pull'
+  LocaleApp::CLI::Pull.new.execute
+when 'push'
+  file = args.shift.strip rescue nil
+  pusher = LocaleApp::CLI::Push.new
+  pusher.execute(file)
+when 'update'
+  LocaleApp::CLI::Update.new.execute
+when 'daemon'
+  while true do
+    LocaleApp::CLI::Update.new.execute
+    sleep 5
+  end
+else
+puts <<-HELP
+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
+  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
+end

data/cucumber.yml

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/features/localeapp_binary.feature

@@ -0,0 +1,116 @@
+Feature: localeapp executable
+
+  Scenario: Viewing help
+    In order to see what options I have
+    When I run `localeapp help`
+    Then the output should contain:
+    """
+    Usage: localeapp COMMAND [ARGS]
+
+    Commands:
+      install <api_key> - Creates new configuration files and confirms key works
+      pull              - Pulls all translations from LocaleApp.com
+    """
+
+  Scenario: Running install
+    In order to configure my project and check my api key is correct
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And I run `localeapp install MYAPIKEY`
+    Then the output should contain:
+    """
+    LocaleApp Install
+
+    Checking API key: MYAPIKEY
+    Success!
+    Project: Test Project
+    Default Locale: en (English)
+    """
+    And a file named "config/initializers/localeapp.rb" should exist
+    And the exit status should be 0
+
+  Scenario: Running install with bad api key
+    In order to configure my project and check my api key is correct
+    When I have a valid project on localeapp.com but an incorrect api key "BADAPIKEY"
+    And I run `localeapp install BADAPIKEY`
+    Then the output should contain:
+    """
+    LocaleApp Install
+
+    Checking API key: BADAPIKEY
+    ERROR: Project not found
+    """
+    And a file named "config/initializers/locale_app.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:
+    """
+    require 'locale_app/rails'
+    LocaleApp.configure do |config|
+      config.api_key = 'MYAPIKEY'
+    end
+    """
+    And a directory named "config/locales"
+    When I run `localeapp pull`
+    Then the output should contain:
+    """
+    LocaleApp Pull
+
+    Fetching translations:
+    Success!
+    Updating backend:
+    Success!
+    """
+    And a file named "config/locales/en.yml" should exist
+
+  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:
+    """
+    require 'locale_app/rails'
+    LocaleApp.configure do |config|
+      config.api_key = 'MYAPIKEY'
+    end
+    """
+    And an empty file named "config/locales/en.yml"
+    When I run `localeapp push config/locales/en.yml`
+    Then the output should contain:
+    """
+    LocaleApp Push
+
+    Pushing file:
+    Success!
+
+    config/locales/en.yml queued for processing.
+    """
+
+  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:
+    """
+    require 'locale_app/rails'
+    LocaleApp.configure do |config|
+      config.api_key = 'MYAPIKEY'
+    end
+    """
+    And a file named "log/locale_app.yml" with:
+    """
+    ---
+    :updated_at: 120
+    :polled_at: 130
+    """
+    And new translations for the api key "MYAPIKEY" since "120" with time "140"
+    And a directory named "config/locales"
+    When I run `localeapp update`
+    Then the output should contain:
+    """
+    LocaleApp update: checking for translations since 120
+    Found and updated new translations
+    """
+    And a file named "config/locales/en.yml" should exist
+    # check the content here
+    # and the localeapp.yml file

data/features/step_definitions/cli_steps.rb

@@ -0,0 +1,27 @@
+require 'net/http'
+require 'time'
+
+When /^I have a valid project on localeapp\.com with api key "([^"]*)"$/ do |api_key|
+  uri = "http://api.localeapp.com/v1/projects/#{api_key}.json"
+  body = valid_project_data.to_json
+  add_fake_web_uri(:get, uri, ['200', 'OK'], body)
+  add_fake_web_uri(:post, "http://api.localeapp.com/v1/projects/#{api_key}/import/", ['202', 'OK'], '')
+end
+
+When /^I have a valid project on localeapp\.com but an incorrect api key "([^"]*)"$/ do |bad_api_key|
+  uri = "http://api.localeapp.com/v1/projects/#{bad_api_key}.json"
+  body = valid_project_data.to_json
+  add_fake_web_uri(:get, uri, ['404', 'Not Found'], body)
+end
+
+When /^I have a translations on localeapp\.com for the project with api key "([^"]*)"$/ do |api_key|
+  uri = "http://api.localeapp.com/v1/projects/#{api_key}/translations.json"
+  body = valid_translation_data.to_json
+  add_fake_web_uri(:get, uri, ['200', 'OK'], body)
+end
+
+When /^new translations for the api key "([^"]*)" since "([^"]*)" with time "([^"]*)"$/ do |api_key, update_time, new_time|
+  uri = "http://api.localeapp.com/v1/projects/#{api_key}/translations.json?updated_at=#{update_time}"
+  body = valid_translation_data.to_json
+  add_fake_web_uri(:get, uri, ['200', 'OK'], body, 'date' => Time.at(new_time.to_i).httpdate)
+end

data/features/support/env.rb

@@ -0,0 +1,21 @@
+require 'aruba/cucumber'
+require File.expand_path(File.join(File.dirname(__FILE__), '../../spec/support/locale_app_integration_data'))
+World(LocaleAppIntegrationData)
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+
+module FakeWebHelper
+  def add_fake_web_uri(method, uri, status, body, headers = {})
+    fakes = JSON.parse(ENV['FAKE_WEB_FAKES'] || '[]')
+    fakes << {
+      'method' => method,
+      'uri' => uri,
+      'status' => status,
+      'body' => body,
+      'headers' => headers
+    }
+    ENV['FAKE_WEB_FAKES'] = fakes.to_json
+  end
+end
+World(FakeWebHelper)
+

data/features/support/hooks.rb

@@ -0,0 +1,3 @@
+Before do
+  ENV['FAKE_WEB_DURING_CUCUMBER_RUN'] = '1'
+end

data/init.rb

@@ -0,0 +1 @@
+require 'locale_app'

data/lib/locale_app/api_call.rb

@@ -0,0 +1,9 @@
+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.call(self)
+    end
+  end
+end

data/lib/locale_app/api_caller.rb

@@ -0,0 +1,77 @@
+module LocaleApp
+  class ApiCaller
+    include ::LocaleApp::Routes
+
+    NonHTTPResponse = Struct.new(:code)
+
+    DEFAULT_RETRY_LIMIT = 1
+
+    # we can retry more in the gem than we can
+    # when running in process
+    attr_accessor :max_connection_attempts
+
+    attr_reader :endpoint, :options, :connection_attempts
+
+    def initialize(endpoint, options = {})
+      @endpoint, @options = endpoint, options
+      @connection_attempts = 0
+      @max_connection_attempts = options[:max_connection_attempts] || DEFAULT_RETRY_LIMIT
+    end
+
+    def call(obj)
+      method, url = send("#{endpoint}_endpoint", options[:url_options] || {})
+      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}")
+        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]}")
+            obj.send(options[:success], response)
+          end
+          success = true
+          break
+        end
+      end
+
+      if !success && options[:failure]
+        obj.send(options[:failure], response)
+      end
+    end
+
+    private
+    def make_call(method, url)
+      begin
+        @connection_attempts += 1
+        LocaleApp.debug("ATTEMPT #{@connection_attempts}")
+        request_options = options[:request_options] || {}
+        if method == :post
+          RestClient.send(method, url, options[:payload], request_options)
+        else
+          RestClient.send(method, url, request_options)
+        end
+      rescue RestClient::ResourceNotFound,
+        RestClient::NotModified,
+        RestClient::InternalServerError,
+        RestClient::BadGateway,
+        RestClient::ServiceUnavailable,
+        RestClient::GatewayTimeout => error
+        return error.response
+      rescue Errno::ECONNREFUSED => error
+        LocaleApp.debug("ERROR: Connection Refused")
+        return NonHTTPResponse.new(-1)
+      end
+    end
+
+    def sleep_if_retrying
+      if @connection_attempts > 0
+        time = @connection_attempts * 5
+        LocaleApp.debug("Sleeping for #{time} before retrying")
+        sleep time
+      end
+    end
+  end
+end

data/lib/locale_app/cli/install.rb

@@ -0,0 +1,41 @@
+module LocaleApp
+  module CLI
+    class Install
+      def execute(key, output = $stdout)
+        output.puts "LocaleApp Install"
+        output.puts ""
+        output.puts "Checking API key: #{key}"
+        if key.nil?
+          output.puts "ERROR: You must supply an API key"
+          return
+        end
+        valid_key, project_data = check_key(key)
+        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
+            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"
+          output.puts "Writing configuration file to #{config_file_path}"
+          write_configuration_file config_file_path
+          true
+        else
+          output.puts "ERROR: Project not found"
+          false
+        end
+      end
+
+      private
+      def check_key(key)
+        LocaleApp::KeyChecker.new.check(key)
+      end
+
+      def write_configuration_file(path)
+        LocaleApp.configuration.write_initial(path)
+      end
+    end
+  end
+end

data/lib/locale_app/cli/pull.rb

@@ -0,0 +1,34 @@
+module LocaleApp
+  module CLI
+    class Pull
+      include ::LocaleApp::ApiCall
+
+      def initialize(output = $stdout)
+        @output = output
+      end
+
+      def execute
+        @output.puts "LocaleApp Pull"
+        @output.puts ""
+
+        @output.puts "Fetching translations:"
+        api_call :translations,
+          :success => :update_backend,
+          :failure => :report_failure,
+          :max_connection_attempts => 3
+      end
+
+      def update_backend(response)
+        @output.puts "Success!"
+        @output.puts "Updating backend:"
+        LocaleApp.updater.update(JSON.parse(response))
+        @output.puts "Success!"
+        LocaleApp.poller.write_synchronization_data!(Time.now.to_i, Time.now.to_i)
+      end
+
+      def report_failure(response)
+        @output.puts "Failed!"
+      end
+    end
+  end
+end

data/lib/locale_app/cli/push.rb

@@ -0,0 +1,49 @@
+module LocaleApp
+  module CLI
+    class Push
+      include ::LocaleApp::ApiCall
+
+      def initialize(output = $stdout)
+        @output = output
+      end
+
+      def execute(file_path = nil)
+        @output.puts "LocaleApp Push"
+        @output.puts ""
+
+        @file_path = file_path
+
+        file = sanitize_file(file_path)
+        if file
+          @output.puts "Pushing file:"
+          api_call :import,
+            :payload => { :file => file },
+            :success => :report_success,
+            :failure => :report_failure,
+            :max_connection_attempts => 3
+        else
+          @output.puts "Could not load file"
+        end
+      end
+
+      def report_success(response)
+        @output.puts "Success!"
+        @output.puts ""
+        @output.puts "#{@file_path} queued for processing."
+      end
+
+      def report_failure(response)
+        @output.puts "Failed!"
+      end
+
+      private
+      def sanitize_file(file_path)
+        if File.exist?(file_path)
+          File.new(file_path)
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/locale_app/cli/update.rb

@@ -0,0 +1,19 @@
+module LocaleApp
+  module CLI
+    class Update
+      def initialize(output = $stdout)
+        @output = output
+      end
+
+      def execute
+        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
+          @output.puts "No new translations"
+        end
+      end
+    end
+  end
+end