adhearsion-i18n 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e463ed4f0c550e8e75ab106657d90d26ddfc5d95
-  data.tar.gz: 8034854d0020472d7b6070a41207569bb70c0b74
+  metadata.gz: b79e86d823fcae890f17fbaa1aba1944e1b69323
+  data.tar.gz: 0270e6e92f4829b690a8d1a2154605d94c02e711
 SHA512:
-  metadata.gz: c1cb66a73e434715ef5563cd5b0bf68bbdb4c44d899e860a7b0360188bd76ff72bea5bc8b062c41376b36c544bf50d1e6ed87a47e690f7a250cf75590c259dba
-  data.tar.gz: c953b0beeeaccafb39996919edb553cdc9ece394a4806bbc54a19224690882014100bd01db9d7d88003ad4568ad8c95c1daab7a9d9f246cc70102423123d5b52
+  metadata.gz: ad98b93929680aed34ed0c4d36ced32f38f9208df8300262f787cf11c9bb3425939a7d0993ef92d410bdfef7917b25984fadabb81199f8626db13f6319ce05ee
+  data.tar.gz: 004ebe0363f04b5c5284f97f4295f543744bf1537bbaca051c5dd47b8ed1f496d6aad353265982adc8dbeb651115f8b694000ed1ae8ba582f8dd62ee4630bf32

data/README.md

@@ -17,6 +17,14 @@ See `rake config:show` to see a full list of options.
 
 Make sure to create your locales in `config/locales` within your Adhearsion app.
 
+adhearsion-i18n uses the [i18n gem](https://github.com/svenfuchs/i18n).  For example, if you want to change the default locale, put something like this in config/adhearsion.rb:
+
+```Ruby
+I18n.default_locale = :de
+```
+
+More docs (though admittedly Rails-specific - read carefully) can be found at http://guides.rubyonrails.org/i18n.html
+
 ## Examples
 
 en.yml:
@@ -57,6 +65,6 @@ end
 
 Copyright (C) 2014 The Adhearsion Foundation
 
-adhearsion-i18n is released under the [MIT license](http://opensource.org/licenses/MIT). Please see the [LICENSE](https://github.com/bklang/sippy_cup/blob/master/LICENSE) file for details.
+adhearsion-i18n is released under the [MIT license](http://opensource.org/licenses/MIT). Please see the [LICENSE](https://github.com/adhearsion/adhearsion-i18n/blob/master/LICENSE) file for details.
 
 adhearsion-i18n was created by [Ben Klang](https://twitter.com/bklang) with support from [Mojo Lingo](https://mojolingo.com) and their clients.

data/lib/adhearsion-i18n/call_controller_methods.rb

@@ -1,11 +1,17 @@
 # encoding: utf-8
 
 module AdhearsionI18n::CallControllerMethods
-  def t(key)
-    prompt = ::I18n.t "#{key.to_s}.audio", default: ''
-    text   = ::I18n.t "#{key.to_s}.text"
+  def t(key, options = {})
+    this_locale = options[:locale] || locale
+    options = {default: '', locale: locale}.merge(options)
+    prompt = ::I18n.t "#{key}.audio", options
+    text   = ::I18n.t "#{key}.text", options
 
-    RubySpeech::SSML.draw do
+    unless prompt.empty?
+      prompt = "#{config['audio_path']}/#{this_locale}/#{prompt}"
+    end
+
+    RubySpeech::SSML.draw language: this_locale do
       if prompt.empty?
         string text
       else
@@ -13,4 +19,18 @@ module AdhearsionI18n::CallControllerMethods
       end
     end
   end
+
+  def locale
+    call[:locale] || I18n.default_locale
+  end
+
+  def locale=(l)
+    call[:locale] = l
+  end
+
+private
+
+  def config
+    Adhearsion.config.i18n
+  end
 end

data/lib/adhearsion-i18n/plugin.rb

@@ -2,7 +2,13 @@
 
 class AdhearsionI18n::Plugin < Adhearsion::Plugin
   init :i18n do
-    ::Adhearsion::CallController.mixin ::Adhearsion::I18n::CallControllerMethods
+    ::Adhearsion::CallController.mixin ::AdhearsionI18n::CallControllerMethods
+
+    config.locale_path.each do |dir|
+      logger.debug "Adding #{dir} to the I18n load path"
+      I18n.load_path += Dir["#{dir}/**/*.yml"]
+    end
+
     logger.info "Adhearsion I18n loaded"
   end
 
@@ -10,5 +16,8 @@ class AdhearsionI18n::Plugin < Adhearsion::Plugin
     locale_path ["#{Adhearsion.root}/config/locales"], transform: Proc.new { |v| v.split ':' }, desc: <<-__
       List of directories from which to load locale data, colon-delimited
     __
+    audio_path "#{Adhearsion.root}/audio", desc: <<-__
+      Base path from which audio files can be found. May be a filesystem path or some other URL (like HTTP)
+    __
   end
 end

data/lib/adhearsion-i18n/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 class AdhearsionI18n
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/call_controller_methods_spec.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe AdhearsionI18n::CallControllerMethods do
+
+  let(:call_id)     { SecureRandom.uuid }
+  let(:call)        { Adhearsion::Call.new }
+  let(:block)       { nil }
+
+  subject(:controller) { Class.new(Adhearsion::CallController).new call }
+
+  before :all do
+    Adhearsion.config.i18n['locale_path'] = ["#{File.dirname(__FILE__)}/fixtures/locale"]
+  end
+
+  before do
+    I18n.default_locale = :en
+    double call, write_command: true, id: call_id
+    Adhearsion::Plugin.init_plugins
+  end
+
+  describe 'getting and setting the locale' do
+    it 'should be able to set and get the locale' do
+      controller.locale.should == :en
+      controller.locale = :it
+      controller.locale.should == :it
+    end
+  end
+
+  describe 'requesting a translation' do
+    it 'should use a default locale' do
+      ssml = controller.t :have_many_cats
+      ssml['xml:lang'].should =~ /^en/
+    end
+
+    it 'should allow overriding the locale per-request' do
+      ssml = controller.t :have_many_cats, locale: 'it'
+      ssml['xml:lang'].should =~ /^it/
+    end
+
+    it 'should allow overriding the locale for the entire call' do
+      controller.locale = 'it'
+      ssml = controller.t :have_many_cats
+      ssml['xml:lang'].should =~ /^it/
+      controller2 = Class.new(Adhearsion::CallController).new call
+      controller2.locale.should == 'it'
+    end
+
+    it 'should generate proper SSML with both audio and text fallback translations' do
+      ssml = controller.t :have_many_cats
+      ssml.should == RubySpeech::SSML.draw(language: 'en') do
+        audio src: "/audio/en/have_many_cats.wav" do
+          string 'I have quite a few cats'
+        end
+      end
+    end
+
+    it 'should generate proper SSML with only audio (no fallback text) translations' do
+      ssml = controller.t :my_shirt_is_white
+      ssml.should == RubySpeech::SSML.draw(language: 'en') do
+        audio src: "/audio/en/my_shirt_is_white.wav" do
+          string ''
+        end
+      end
+    end
+
+    it 'should generate proper SSML with only text (no audio) translations' do
+      ssml = controller.t :many_people_out_today
+      ssml.should == RubySpeech::SSML.draw(language: 'en') do
+        string 'There are many people out today'
+      end
+    end
+
+    it 'should generate a path to the audio prompt based on the requested locale' do
+      ssml = controller.t :my_shirt_is_white, locale: 'it'
+      ssml.should == RubySpeech::SSML.draw(language: 'it') do
+        audio src: "/audio/it/la_mia_camicia_e_bianca.wav" do
+          string ''
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/locale/en.yml

@@ -0,0 +1,10 @@
+en:
+  have_many_cats:
+    audio: have_many_cats.wav
+    text: "I have quite a few cats"
+
+  my_shirt_is_white:
+    audio: my_shirt_is_white.wav
+
+  many_people_out_today:
+    text: There are many people out today

data/spec/fixtures/locale/it.yml

@@ -0,0 +1,10 @@
+it:
+  have_many_cats:
+    audio: ho_parecchi_gatti.wav
+    text: "Ho parecchi gatti"
+
+  my_shirt_is_white:
+    audio: la_mia_camicia_e_bianca.wav
+
+  many_people_out_today:
+    text: Ci sono molti persone fuori oggi

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'adhearsion'
+require 'adhearsion-i18n'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.tty = true
+
+  config.mock_with :rspec
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+
+  config.backtrace_clean_patterns = [/rspec/]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adhearsion-i18n
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ben Klang
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,6 +89,10 @@ files:
 - lib/adhearsion-i18n/call_controller_methods.rb
 - lib/adhearsion-i18n/plugin.rb
 - lib/adhearsion-i18n/version.rb
+- spec/call_controller_methods_spec.rb
+- spec/fixtures/locale/en.yml
+- spec/fixtures/locale/it.yml
+- spec/spec_helper.rb
 homepage: http://adhearsion.com
 licenses:
 - MIT
@@ -113,5 +117,9 @@ rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Internationalization helpers for Adhearsion applications
-test_files: []
+test_files:
+- spec/call_controller_methods_spec.rb
+- spec/fixtures/locale/en.yml
+- spec/fixtures/locale/it.yml
+- spec/spec_helper.rb
 has_rdoc: