i18n-backend-http 0.1.0

data/test/i18n/backend/http_test.rb

@@ -0,0 +1,356 @@
+# encoding: UTF-8
+require File.expand_path('../../../test_helper', __FILE__)
+
+class I18nBackendHttpTest < Test::Unit::TestCase
+  class SimpleCache
+    def initialize
+      @cache = {}
+    end
+
+    def read(key)
+      @cache[key]
+    end
+
+    def write(key, value, options={})
+      if not options[:unless_exist] or not @cache[key]
+        @cache[key] = value
+      end
+    end
+
+    def fetch(key, options={})
+      result = read(key)
+      return result if result
+      result = yield
+      write(key, result)
+    end
+  end
+
+  class ZenEnd < ::I18n::Backend::Http
+    def initialize(options={})
+      super({
+        :host => "https://support.zendesk.com",
+      }.merge(options))
+    end
+
+    # TODO remove conversion
+    def lookup(locale, key, scope = [], options = {})
+      locale = locale.to_s[/\d+/].to_i # we only care about the id en-EN-x-ID, everything else could cause duplicate caches
+      super(locale, key, scope, options)
+    end
+
+    def parse_response(body)
+      JSON.load(body)["locale"]["translations"]
+    end
+
+    def path(locale)
+      "/api/v2/locales/#{locale}.json?include=translations"
+    end
+  end
+
+  def silence_backend
+    $stderr.stubs(:puts)
+  end
+
+  def with_local_available
+    VCR.use_cassette("simple") do
+      yield
+    end
+  end
+
+  def with_error
+    VCR.use_cassette("error") do
+      I18n.locale = "de_DE-x-888888888"
+      yield
+    end
+  end
+
+  def add_local_change
+    ::I18n.backend.send(:translations, 8)[@key] = "OLD"
+  end
+
+  def update_caches
+    I18n.backend.send(:update_caches)
+  end
+
+  context "I18n::Backend::Http" do
+    setup do
+      @existing_key = "txt.modal.welcome.browsers.best_support"
+      @missing_key = "txt.blublublub"
+      Thread.list.each {|thread| thread.exit unless thread == Thread.current } # stop all polling threads
+    end
+
+    teardown do
+      I18n.backend && I18n.backend.respond_to?(:stop_polling) && I18n.backend.stop_polling
+    end
+
+    context "#translate" do
+      setup do
+        I18n.locale = "de_DE-x-8"
+        I18n.backend = ZenEnd.new
+      end
+
+      should "translate via api" do
+        with_local_available do
+          assert_equal "Am besten", I18n.t(@existing_key)
+        end
+      end
+
+      should "translate via api and :scope" do
+        with_local_available do
+          assert_equal "Am besten", I18n.t("browsers.best_support", :scope => "txt.modal.welcome")
+        end
+      end
+
+      should "translate via :default" do
+        with_local_available do
+          assert_equal "XXX", I18n.t("txt.blublublub", :default => "XXX")
+        end
+      end
+
+      should "caches the locale" do
+        with_local_available do
+          assert_equal "Am besten", I18n.t(@existing_key)
+          JSON.expects(:load).never
+          assert_equal "By group", I18n.t("txt.admin.helpers.rules_helper.by_group_label")
+        end
+      end
+
+      should "fail when key is unknown" do
+        with_local_available do
+          assert_equal "translation missing: de_DE-x-8.#{@missing_key}", I18n.t(@missing_key).gsub(', ', '.')
+        end
+      end
+
+      should "fail when I mess up the host" do
+        silence_backend
+        I18n.backend = ZenEnd.new(:host => "https://MUAHAHAHAHA.com")
+        VCR.use_cassette("invalid_host") do
+          assert_equal "translation missing: de_DE-x-8.#{@missing_key}", I18n.t(@missing_key).gsub(', ', '.')
+        end
+      end
+
+      should "fail with invalid locale" do
+        silence_backend
+        with_error do
+          assert_equal "translation missing: #{I18n.locale}.#{@existing_key}", I18n.t(@existing_key).gsub(', ', '.')
+        end
+      end
+
+      should "call :exception_handler when error occurs" do
+        exception = nil
+        I18n.backend = ZenEnd.new(:exception_handler => lambda{|e|
+          exception = e
+        })
+        $stderr.expects(:puts).never
+
+        with_error do
+          I18n.t(@existing_key).gsub(', ', '.')
+        end
+
+        assert_equal exception.class, RuntimeError
+      end
+
+      should "keep :memory_cache_size items in memory cache" do
+        I18n.backend = ZenEnd.new(:memory_cache_size => 1)
+
+        VCR.use_cassette("multiple_locales") do
+          assert_equal "Am besten", I18n.t(@existing_key)
+          I18n.locale = "es-ES-x-2"
+          assert_equal "Mejor", I18n.t(@existing_key)
+        end
+
+        assert_equal "Mejor", I18n.t(@existing_key) # still in memory
+
+        I18n.locale = "de-DE-x-8"
+        I18n.backend.expects(:download_and_cache_translations).returns({})
+        I18n.t(@existing_key) # dropped from memory
+      end
+
+      # FIXME how to simulate http timeouts !?
+      #should "fails when api is slower then set timeout" do
+      #  Timeout.timeout 0.8 do
+      #    assert_equal "translation missing: de_DE-x-8.#{@missing_key}", I18n.t(@missing_key).gsub(', ', '.')
+      #  end
+      #end
+
+      context "with cache" do
+        setup do
+          @cache = SimpleCache.new
+          I18n.backend = ZenEnd.new(:cache => @cache)
+        end
+
+        should "loads translations from cache" do
+          @cache.write "i18n/backend/http/translations/8", {"foo" => "bar"}
+          assert_equal "bar", I18n.t("foo")
+        end
+
+        should "downloads translations on cache miss" do
+          with_local_available do
+            assert_equal "Am besten", I18n.t(@existing_key)
+          end
+          assert @cache.read("i18n/backend/http/translations/8")
+        end
+
+        should "not store invalid responses in cache" do
+          silence_backend
+          with_error do
+            assert_equal "translation missing: #{I18n.locale}.#{@existing_key}", I18n.t(@existing_key).gsub(', ', '.')
+          end
+          assert !@cache.read("i18n/backend/http/translations/#{I18n.locale.to_s[/\d+/]}")
+        end
+
+        should "use the memory cache before the cache" do
+          @cache.write "i18n/backend/http/translations/8", {"foo" => "bar"}
+          assert_equal "bar", I18n.t("foo")
+          @cache.write "i18n/backend/http/translations/8", {"foo" => "baZZZ"}
+          assert_equal "bar", I18n.t("foo")
+        end
+      end
+    end
+
+    context "#start_polling" do
+      should "not start polling when poll => false is given" do
+        I18n.locale = "de_DE-x-8"
+        I18n.backend = ZenEnd.new(:poll => false, :polling_interval => 0.2)
+        sleep 0.1
+        I18n.backend.expects(:update_caches).never
+        I18n.backend.stop_polling
+        sleep 0.5
+      end
+
+      should "update_caches" do
+        I18n.locale = "de_DE-x-8"
+        I18n.backend = ZenEnd.new(:polling_interval => 0.2)
+        I18n.backend.expects(:update_caches).twice
+        sleep 0.5
+      end
+
+      should "stop when calling stop_polling" do
+        I18n.locale = "de_DE-x-8"
+        I18n.backend = ZenEnd.new(:polling_interval => 0.2)
+        sleep 0.1
+        I18n.backend.expects(:update_caches).once
+        I18n.backend.stop_polling
+        sleep 0.5
+      end
+    end
+
+    context "#update_caches_via_api" do
+      setup do
+        I18n.locale = "de_DE-x-8"
+        I18n.backend = ZenEnd.new
+        @key = @existing_key
+      end
+
+      should "update translations" do
+        # init it
+        with_local_available do
+          assert_equal "Am besten", I18n.t(@key)
+        end
+
+        # add a change
+        add_local_change
+        assert_equal "OLD", I18n.t(@key)
+
+        # update
+        with_local_available do
+          update_caches
+        end
+
+        assert_equal "Am besten", I18n.t(@key)
+      end
+
+      should "not update if api did not change" do
+        VCR.use_cassette("matching_etag") do
+          assert_equal "Am besten", I18n.t(@key) # initial request
+
+          # add a change
+          add_local_change
+
+          # update -> not modified!
+          update_caches
+          assert_equal "OLD", I18n.t(@key)
+        end
+      end
+
+      context "with cache" do
+        setup do
+          @key = @existing_key
+          @cache = SimpleCache.new
+          I18n.backend = ZenEnd.new(:cache => @cache)
+        end
+
+        should "update cache" do
+          # init it via cache
+          @cache.write "i18n/backend/http/translations/8", {@key => "bar"}
+          assert_equal "bar", I18n.t(@key)
+
+          # add a change
+          add_local_change
+          assert_equal "OLD", I18n.t(@key)
+
+          # update via api
+          with_local_available do
+            update_caches
+          end
+
+          assert_equal "Am besten", I18n.t(@key)
+
+          # loading from cache should have new translations
+          I18n.backend = ZenEnd.new(:cache => @cache)
+          assert_equal "Am besten", I18n.t(@key)
+        end
+
+        should "pick one server to be the master" do
+          @cache.write "i18n/backend/http/translations/8", {@key => "bar"}
+          ZenEnd.any_instance.expects(:download_and_cache_translations).twice
+          4.times{
+            backend = ZenEnd.new(:polling_interval => 0.3, :cache => @cache)
+            assert_equal "bar", backend.translate("de-DE-x-8", @key)
+          }
+          sleep 0.7
+        end
+
+        should "update all translations known by all clients" do
+          VCR.use_cassette("multiple_locales") do
+            @cache.write "i18n/backend/http/translations/8", {@key => "bar"}
+            @cache.write "i18n/backend/http/translations/2", {@key => "bar"}
+
+            a = ZenEnd.new(:polling_interval => 0.3, :cache => @cache)
+            b = ZenEnd.new(:polling_interval => 0.3, :cache => @cache)
+
+            assert_equal "bar", a.translate("de-DE-x-8", @key)
+            assert_equal "bar", b.translate("es-Es-x-2", @key)
+
+            sleep 0.4 # to refresh vcr: a.stop_polling; b.stop_polling; sleep 10
+
+            assert_equal "Am besten", a.translate("de-DE-x-8", @key)
+            assert_equal "Mejor", b.translate("es-Es-x-2", @key)
+          end
+        end
+
+        should "updates translations from cache if its a slave" do
+          VCR.use_cassette("matching_etag") do
+            @cache.write "i18n/backend/http/translations/8", {@key => "bar"}
+            backends = Array.new(4)
+
+            backends = backends.map do
+              ZenEnd.new(:polling_interval => 0.3, :cache => @cache)
+            end
+
+            translate = lambda{
+              backends.map do |backend|
+                backend.translate(I18n.locale, @key)
+              end
+            }
+            assert_equal ["bar", "bar", "bar", "bar"], translate.call
+
+            sleep 0.8
+
+            assert_equal ["Am besten", "Am besten", "Am besten", "Am besten"], translate.call
+          end
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler.setup
+
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'vcr'
+require 'redgreen'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/fixtures/vcr'
+  c.hook_into :webmock
+end
+
+$LOAD_PATH.unshift 'lib'
+require 'i18n/backend/http'
+require 'i18n/backend/simple' # is used when I18n first starts
+require 'json'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: i18n-backend-http
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  requirement: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: gem_of_thrones
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  requirement: *id003
+  prerelease: false
+description: 
+email: michael@grosser.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .travis.yml
+- Appraisals
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- gemfiles/rails2.gemfile
+- gemfiles/rails2.gemfile.lock
+- gemfiles/rails3.gemfile
+- gemfiles/rails3.gemfile.lock
+- i18n-backend-http.gemspec
+- lib/i18n/backend/http.rb
+- lib/i18n/backend/http/etag_http_client.rb
+- lib/i18n/backend/http/lru_cache.rb
+- lib/i18n/backend/http/null_cache.rb
+- lib/i18n/backend/http/version.rb
+- test/fixtures/static/testing.yml
+- test/fixtures/vcr/error.yml
+- test/fixtures/vcr/matching_etag.yml
+- test/fixtures/vcr/multiple_locales.yml
+- test/fixtures/vcr/simple.yml
+- test/i18n/backend/http_test.rb
+- test/test_helper.rb
+homepage: http://github.com/grosser/i18n-backend-http
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rails I18n Backend for Http APIs with etag-aware background polling and memory+[memcache] caching
+test_files: []
+