exvo_globalize 0.0.2 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # Exvo Globalize
 
-This plugin lets you make use of the Globalize app (http://globalize.exvo.com/)
+This gem lets you make use of the Globalize app (http://globalize.exvo.com/)
 to handle the translation of your Rails app into multiple languages.
 
 
@@ -31,7 +31,7 @@ $ rails generate exvo_globalize
 ```
 
 
-Is is advised to have your `/globalize/` actions behind an authorization barrier (besides `/globalize/translations.json`, which is by default publicly accessible).
+It is advised to have your `/globalize/` actions behind an authorization barrier (besides `/globalize/translations.json`, which is by default publicly accessible).
 Create a `config/initializers/exvo_globalize.rb` file with similar contents:
 
 ```ruby
@@ -44,5 +44,27 @@ I18n::Backend::GlobalizeStore.authenticator = proc {
 `authenticate_user!` and `require_admin!` are just exemplary authorization actions.
 
 
+## Globalize integration
+
+In order to fully integrate this gem with Globalize, after installing it you need to register your application (http://globalize.exvo.com/) and order some translations (Globalize should automatically detect the gem installation and should let you choose the JSON translations option).
+
+By default a link between your application and Globalize is established by using `request.host` by the gem. If your application’s main DNS record is a CNAME (as is the common case when using Heroku), you can set your application’s domain in the `config/initializers/exvo_globalize.rb` file:
+
+```ruby
+ENV['GLOBALIZE_REQUEST_HOST'] = 'yourawesomewebapp.com'
+```
+
+Note that this host must be the same as the one you have used when registering your application at Globalize. Otherwise updating translations will not be possible.
+
+
+When Globalize translations are ready, you need to manually update them at your application by going to this url:
+
+```
+http://yourawesomewebapp.com/globalize/translations
+```
+
+And pressing `Update translations`.
+
+
 
 Copyright © 2011 Exvo.com Development BV, released under the MIT license

data/app/controllers/globalize_translations_controller.rb

@@ -1,28 +1,41 @@
 class GlobalizeTranslationsController < ApplicationController
 
-  before_filter :globalize_translations_authenticator, :except => [:index]
+  before_filter :globalize_translations_authenticator
+  before_filter :set_globalize_app
 
-  # get :index as JSON should not require authentication
-  before_filter(:only => :index) do |controller|
-    globalize_translations_authenticator unless controller.request.format.json?
-  end
-
-  layout false
+  layout 'exvo_globalize'
 
   respond_to :html, :json
 
-  def index
+  def show
     # returns {"default_locale":"en","pl":{"hello.world":"Witaj \u015bwiecie","hello.earth":"Witaj ziemio"},"en":{"hello.world":"Hello world","hello.earth":"Hello Earth"}}
     @translations = I18n.backend.available_translations.merge({ :default_locale => I18n.default_locale })
     respond_with @translations
   end
 
+  def update
+    if I18n.backend.store_flatten_translations(@globalize_app.fetch_translations)
+      flash.now[:notice] = 'Translations updated'
+    else
+      flash.now[:alert] = 'There was a problem while updating translations'
+    end
+    render :show
+  end
+
   private
 
   def globalize_translations_authenticator
+    # get :show as JSON does not require authentication
+    return if params[:action].to_s == 'show' and request.format.json?
+
+    # call custom authenticator method if available
     if I18n::Backend::GlobalizeStore.authenticator && I18n::Backend::GlobalizeStore.authenticator.respond_to?(:call)
       I18n::Backend::GlobalizeStore.authenticator.bind(self).call
     end
   end
 
+  def set_globalize_app
+    @globalize_app ||= GlobalizeApp.new(ENV["GLOBALIZE_REQUEST_HOST"] || request.host)
+  end
+
 end

data/app/views/globalize_translations/_flash_messages.html.haml

@@ -0,0 +1,5 @@
+- if flash[:notice].present?
+  %p.notice= flash[:notice]
+
+- if flash[:alert].present?
+  %p.alert= flash[:alert]

data/app/views/globalize_translations/show.html.haml

@@ -0,0 +1,7 @@
+= render 'flash_messages'
+
+- if @globalize_app.updated_translations_available?
+  %p Would you like to update the translations from Globalize?
+
+  = form_tag globalize_translations_path, :method => :put do
+    = submit_tag 'Update translations'

data/app/views/layouts/exvo_globalize.html.haml

@@ -0,0 +1,7 @@
+!!!
+%html
+  %head
+    %title= "Exvo Globalize translations"
+    %meta{ :name => "robots", :content => "noindex, nofollow" }
+  %body
+    = yield

data/config/routes.rb

@@ -1,7 +1,6 @@
 Rails.application.routes.draw do
   scope '/globalize' do
-    resources :translations, :only => [:index], :as => 'globalize_translations', :controller => 'globalize_translations' do
-      put :update_many, :on => :collection
+    resource :translations, :only => [:show, :update], :as => 'globalize_translations', :controller => 'globalize_translations' do
     end
   end
 end

data/exvo_globalize.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'rails', ['>= 3.0.0']
   s.add_dependency 'i18n', ['>= 0.5.0']
+  s.add_dependency 'haml', ['>= 3.0.0']
+  s.add_dependency 'httparty', ['>= 0.6.1']
   s.add_development_dependency 'guard', ['>= 0.5.0']
   s.add_development_dependency 'guard-rspec', ['>= 0.4.0']
   s.add_development_dependency 'sqlite3', ['>= 1.3']
@@ -28,5 +30,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-rails', ['>= 2.6']
   s.add_development_dependency 'factory_girl_rails', ['>= 1.1.0']
   s.add_development_dependency 'shoulda-matchers', ['>= 1.0.0.beta3']
+  s.add_development_dependency 'capybara', ['>= 1.0.0']
   s.add_development_dependency 'json', ['>= 1.5.1']
 end

data/lib/exvo_globalize.rb

@@ -2,6 +2,9 @@ require "exvo_globalize/version"
 require "exvo_globalize/backend/chain"
 require "exvo_globalize/backend/globalize_store"
 require "exvo_globalize/backend/simple"
+require 'exvo_globalize/globalize_app'
+require 'haml'
+require 'httparty'
 
 # Make it a Rails engine
 module ExvoGlobalize

data/lib/exvo_globalize/backend/chain.rb

@@ -20,8 +20,28 @@ module I18n
             translate_without_fallback(I18n.default_locale, key, default_options)
           end
         end
-
         alias_method_chain :translate, :fallback
+
+        # stores a whole Hash of flattened translations
+        def store_flatten_translations(translations_hash)
+          return false if translations_hash.blank?
+
+          translations_hash.reject { |key, value| key.to_sym == :default_locale }.each do |locale, translations|
+            next if translations.blank?
+
+            translations.each do |key, value|
+              store_flatten_translation(locale, key, value)
+            end
+          end
+        end
+
+        # pass-through for the `store_flatten_translation()` method to the GlobalizeStore
+        # so that I18n.backend.store_flatten_translation() works
+        def store_flatten_translation(*args)
+          backends.each do |backend|
+            return backend.send(:store_flatten_translation, *args) if backend.respond_to?(:store_flatten_translation)
+          end
+        end
       end
 
       include Implementation

data/lib/exvo_globalize/globalize_app.rb

@@ -0,0 +1,32 @@
+class GlobalizeApp
+
+  def initialize(request_host)
+    @request_host = request_host
+  end
+
+  def updated_translations_available?
+    # TODO fetch_translations and sha1 compare them with database stored sha1 of previously fetched translations
+    true
+  end
+
+  # returns a Hash with translations: { "en" => { "intro" => "Introduction" } }
+  def fetch_translations
+    resp = HTTParty.get(translations_uri)
+    if resp.response.is_a?(Net::HTTPOK)
+      resp.parsed_response
+    else
+      {}
+    end
+  end
+
+  private
+
+  def globalize_host
+    Rails.env.production? ? "globalize.exvo.com" : "globalize.exvo.co"
+  end
+
+  def translations_uri
+    "http://#{globalize_host}/translations.json?host=#{@request_host}"
+  end
+
+end

data/lib/exvo_globalize/version.rb

@@ -1,3 +1,3 @@
 module ExvoGlobalize
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/controllers/globalize_translations_controller_spec.rb

@@ -7,11 +7,11 @@ describe GlobalizeTranslationsController do
 
   context "JSON" do
 
-    describe "GET :index" do
+    describe "GET :show" do
 
       let(:translations) do
-        i18n_title # needed so there is some data in the database before a call to get :index
-        get :index, :format => :json
+        i18n_title # needed so there is some data in the database before a call to get :show
+        get :show, :format => :json
         JSON.parse(response.body)
       end
 
@@ -33,11 +33,11 @@ describe GlobalizeTranslationsController do
 
   context "HTML" do
 
-    describe "GET :index" do
+    describe "GET :show" do
 
       context "without being logged in" do
         before do
-          get :index, :format => :html
+          get :show, :format => :html
         end
 
         it { should respond_with(:forbidden) }
@@ -46,7 +46,7 @@ describe GlobalizeTranslationsController do
       context "when being logged in as admin" do
         before do
           controller.stub!(:require_admin).and_return(true)
-          get :index, :format => :html
+          get :show, :format => :html
         end
 
         it { should respond_with(:success) }
@@ -54,6 +54,34 @@ describe GlobalizeTranslationsController do
 
     end
 
+    describe "PUT :update" do
+
+      let(:intro) { "Introduction" }
+      let(:translations) { { :en => { :intro => intro } } }
+
+      render_views
+      let(:page) { Capybara::Node::Simple.new(@response.body) }
+
+      before do
+        controller.stub!(:require_admin).and_return(true)
+        GlobalizeApp.any_instance.stub(:fetch_translations) { translations }
+        put :update, :format => :html
+      end
+
+      it "updates the translations" do
+        I18n.t(:intro).should eq(intro)
+      end
+
+      it "sets a flash notice" do
+        flash[:notice].should_not be_empty
+      end
+
+      it "displays a flash notice" do
+        page.should have_selector('p.notice')
+      end
+
+    end
+
   end
 
 end

data/spec/integration/exvo_globalize_spec.rb

@@ -23,17 +23,22 @@ describe ExvoGlobalize do
   context "translation storage" do
     let(:hello_world) { 'Hello world' }
     let(:hello_earth) { 'Hello Earth' }
-    let(:globalize_store_backend) { I18n.backend.backends.detect { |backend| backend.is_a?(I18n::Backend::GlobalizeStore) } }
 
-    it "stores nested translations in the GlobalizeStore backend" do
-      globalize_store_backend.store_translations(I18n.locale, { :hello => { :world => hello_world} })
+    it "stores a flatten translations hash" do
+      I18n.backend.store_flatten_translations({ :en => { 'hello.world' => hello_world, 'hello.earth' => hello_earth } })
       I18n.translate('hello.world').should eql(hello_world)
+      I18n.translate('hello.earth').should eql(hello_earth)
     end
 
-    it "stores flatten translation in the GlobalizeStore backend" do
-      globalize_store_backend.store_flatten_translation(I18n.locale, 'hello.earth', hello_earth)
+    it "stores a flatten translation" do
+      I18n.backend.store_flatten_translation(I18n.locale, 'hello.earth', hello_earth)
       I18n.translate(:earth, :scope => [:hello]).should eql(hello_earth)
     end
+
+    it "stores a nested translation" do
+      I18n.backend.store_translations(I18n.locale, { :hello => { :world => hello_world } })
+      I18n.translate('hello.world').should eql(hello_world)
+    end
   end
 
   it "falls back to the YAML file if the translation is missing in the GlobalizeStore backend (db)" do

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - "Pawe\xC5\x82 Go\xC5\x9Bcicki"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-04 00:00:00 +02:00
+date: 2011-08-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,9 +51,41 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: guard
+  name: haml
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -65,11 +97,11 @@ dependencies:
         - 0
         version: 0.5.0
   type: :development
-  version_requirements: *id003
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: guard-rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -81,11 +113,11 @@ dependencies:
         - 0
         version: 0.4.0
   type: :development
-  version_requirements: *id004
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: sqlite3
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -96,11 +128,11 @@ dependencies:
         - 3
         version: "1.3"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -111,11 +143,11 @@ dependencies:
         - 6
         version: "2.6"
   type: :development
-  version_requirements: *id006
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: rspec-rails
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -126,11 +158,11 @@ dependencies:
         - 6
         version: "2.6"
   type: :development
-  version_requirements: *id007
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: factory_girl_rails
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -142,11 +174,11 @@ dependencies:
         - 0
         version: 1.1.0
   type: :development
-  version_requirements: *id008
+  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: shoulda-matchers
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -160,11 +192,27 @@ dependencies:
         - 3
         version: 1.0.0.beta3
   type: :development
-  version_requirements: *id009
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id012
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -176,7 +224,7 @@ dependencies:
         - 1
         version: 1.5.1
   type: :development
-  version_requirements: *id010
+  version_requirements: *id013
 description: It exposes `/globalize/translations.json` with JSON of all translations in the app
 email: 
 - pawel.goscicki@gmail.com
@@ -195,7 +243,9 @@ files:
 - Rakefile
 - app/controllers/globalize_translations_controller.rb
 - app/models/globalize_translation.rb
-- app/views/globalize_translations/index.html
+- app/views/globalize_translations/_flash_messages.html.haml
+- app/views/globalize_translations/show.html.haml
+- app/views/layouts/exvo_globalize.html.haml
 - config/routes.rb
 - exvo_globalize.gemspec
 - lib/exvo_globalize.rb
@@ -203,6 +253,7 @@ files:
 - lib/exvo_globalize/backend/globalize_store.rb
 - lib/exvo_globalize/backend/simple.rb
 - lib/exvo_globalize/engine.rb
+- lib/exvo_globalize/globalize_app.rb
 - lib/exvo_globalize/version.rb
 - lib/generators/exvo_globalize/exvo_globalize_generator.rb
 - lib/generators/exvo_globalize/templates/migration.rb