ghost_reader 1.2.1 → 1.2.2

data/README.md

@@ -2,15 +2,17 @@ GhostReader
 ===========
 
 GhostReader is an alternative I18n backend which makes use of the
-GhostWriter service.
+GhostWriter service (https://github.com/branch14/ghost_writer).
 
 ## Usage
 
 ### Gemfile
 
-    gem 'ghost_reader', '~> 1.1.1'
+    gem 'ghost_reader'
 
-### config/initializers/ghost_reader.rb
+### For development & staging
+
+#### config/initializers/ghost_reader.rb
 
     unless Rails.env.test?
       config = {
@@ -26,7 +28,7 @@ GhostWriter service.
       I18n.backend = GhostReader::Backend.new(config)
     end
 
-## Configuration
+#### Configuration
 
 * 'report interval' is the delay in seconds between subsequent POST
   requests (reporting requests), which report missing translations. 
@@ -43,6 +45,24 @@ GhostWriter service.
   - 'uri' is the complete uri with the folling keys, which will be
     replaced: :protocol, :host, :api_key
 
+### For Live
+
+In a live system you typically don't want to depend on another system,
+so we'll just go with a static export of translations.
+
+    # specify where to get the static file from
+    echo 'static: https://<ghostservice>/system/static/<apikey>.yml' >> config/ghost_reader.yml
+
+    # in a cron job do this
+    rake ghost_reader:poll
+
+The rake task will rewrite config/locales/ghost_reader.yml if it
+changed and touch tmp/restart.txt to make passenger restart the
+application.
+
+It's a good idea to delete all other translations files on this
+system.
+
 ## TODO
 
 * implement counting, for statistics

data/lib/ghost_reader/backend.rb

@@ -9,9 +9,6 @@ module GhostReader
 
       attr_accessor :config, :missings
 
-      # exposed for testing & debugging
-      attr_reader :retriever, :reporter
-
       # for options see code of default_config
       def initialize(conf={})
         self.config = OpenStruct.new(default_config.merge(conf))
@@ -20,12 +17,6 @@ module GhostReader
         config.logger.level = config.log_level || Logger::WARN
         config.service[:logger] ||= config.logger
         config.client ||= Client.new(config.service)
-        # unless config.no_auto_spawn
-        #   log "GhostReader spawning agents."
-        #   spawn_retriever
-        #   spawn_reporter
-        #   log "GhostReader spawned its agents."
-        # end
         @report_ts = @retrieval_ts = Time.now
         log "Initialized GhostReader backend.", :info
       end
@@ -41,10 +32,10 @@ module GhostReader
         raise 'no fallback given' if config.fallback.nil?
         log "lookup: #{locale} #{key} #{scope.inspect} #{options.inspect}"
         
-        result = config.fallback.translate(locale, key, options)
+        result = config.fallback.lookup(locale, key, scope, options)
         log "fallback result: #{result.inspect}"
       rescue Exception => ex
-        log "fallback.translate raised exception: #{ex}"
+        log "fallback.lookup raised exception: #{ex}"
       ensure # make sure everything is tracked
         # TODO results which are hashes need to be tracked disaggregated
         track({ key => { locale.to_s => { 'default' => result } } }) unless result.is_a?(Hash)

data/lib/ghost_reader/engine.rb

@@ -0,0 +1,4 @@
+module GhostReader
+  class Engine < Rails::Engine
+  end
+end

data/lib/ghost_reader/util.rb

@@ -0,0 +1,44 @@
+require 'excon'
+require 'yaml'
+
+module GhostReader
+  module Util
+    class << self
+
+      def poll(headers={})
+        p config_file
+        return unless File.exist?(config_file)
+        headers['If-Modified-Since'] = File.mtime(translation_file) if File.exist?(translation_file)
+        headers.reverse_merge! :method => :get
+        p headers
+        p config
+        excon = Excon.new(config['static'])
+        response = excon.request(headers)
+        p response
+        if response.status == 200
+          translation_file response.body
+          restart!
+        end
+      end
+
+      def translation_file(content=nil)
+        path = File.join(Rails.root, 'config', 'locales', 'ghost_reader.yml')
+        return path if content.nil?
+        File.open(path, 'w') { |f| f.puts content }
+      end
+
+      def config_file
+        File.join(Rails.root, 'config', 'ghost_reader.yml')
+      end
+
+      def restart!
+        FileUtils.touch(File.join(Rails.root, 'tmp', 'restart.txt'))
+      end
+
+      def config
+        YAML.load(File.read(config_file))
+      end
+
+    end
+  end
+end

data/lib/ghost_reader/version.rb

@@ -1,3 +1,3 @@
 module GhostReader
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/lib/ghost_reader.rb

@@ -1,4 +1,4 @@
-%w(backend client).each do |f|
+%w(backend client util engine).each do |f|
   require File.expand_path(File.join(%w(.. ghost_reader), f), __FILE__)
 end
 

data/lib/tasks/ghost_reader.rake

@@ -1,62 +1,67 @@
 namespace :ghost_reader do
 
-  desc "Fetch newest translations from ghost-writer and overwrite the local translations"
-  task :fetch => :environment do
-    unless I18n.backend.respond_to? :load_yaml_from_ghostwriter
-      raise "ERROR: Ghostwriter is not configured as I18n.backend"
-    end
-
-    begin
-      puts "Loading data from Ghostwriter and delete old translations"
-      yaml_data = I18n.backend.load_yaml_from_ghostwriter
-    rescue Exception => e
-      abort e.message
-    end
-
-    yaml_data.each_pair do |key,value|
-      outfile = Rails.root.join("config", "locales",
-                                "#{key.to_s}.yml")
-      begin
-        puts "Deleting old translations: #{outfile}"
-        File.delete(outfile) if File.exists?(outfile)
-      rescue Exception => e
-        abort "Couldn't delete file: #{e.message}"
-      end
-
-      begin
-        puts "Writing new translations: #{outfile}"
-        File.open(outfile, "w") do |yaml_file|
-          yaml_file.write({key => value}.to_yaml)
-        end
-      rescue Exception => e
-        abort "Couldn't write file: #{e.message}"
-      end
-    end
-  end
-
-  desc "Push all locally configured translations to ghost-writer"
-  task :push => :environment do
-    unless I18n.backend.respond_to? :push_all_backend_data
-      raise "ERROR: Ghostwriter is not configured as I18n.backend"
-    end
-    puts "Pushing data to Ghostwriter"
-    begin
-      I18n.backend.push_all_backend_data
-    rescue Exception => e
-      abort e.message
-    end
+  desc "Poll for changes in translations for production"
+  task :poll => :environment do
+    GhostReader::Util.poll
   end
 
-  desc "Install default initializer for ghost reader"
-  task :install => :environment do
-
-    # TODO: this should work only when the ghost_reader is introduced as gem
-    infile = 'templates/ghost_reader.rb'
-    outdir = Rails.root.join("config", "initializers")
-
-    puts "Installing ghost_reader.rb initializer..."
-    FileUtils.copy_file(infile, outdir)
-    puts "Done."
-  end
+  # desc "Fetch newest translations from ghost-writer and overwrite the local translations"
+  # task :fetch => :environment do
+  #   unless I18n.backend.respond_to? :load_yaml_from_ghostwriter
+  #     raise "ERROR: Ghostwriter is not configured as I18n.backend"
+  #   end
+  # 
+  #   begin
+  #     puts "Loading data from Ghostwriter and delete old translations"
+  #     yaml_data = I18n.backend.load_yaml_from_ghostwriter
+  #   rescue Exception => e
+  #     abort e.message
+  #   end
+  # 
+  #   yaml_data.each_pair do |key,value|
+  #     outfile = Rails.root.join("config", "locales",
+  #                               "#{key.to_s}.yml")
+  #     begin
+  #       puts "Deleting old translations: #{outfile}"
+  #       File.delete(outfile) if File.exists?(outfile)
+  #     rescue Exception => e
+  #       abort "Couldn't delete file: #{e.message}"
+  #     end
+  # 
+  #     begin
+  #       puts "Writing new translations: #{outfile}"
+  #       File.open(outfile, "w") do |yaml_file|
+  #         yaml_file.write({key => value}.to_yaml)
+  #       end
+  #     rescue Exception => e
+  #       abort "Couldn't write file: #{e.message}"
+  #     end
+  #   end
+  # end
+  # 
+  # desc "Push all locally configured translations to ghost-writer"
+  # task :push => :environment do
+  #   unless I18n.backend.respond_to? :push_all_backend_data
+  #     raise "ERROR: Ghostwriter is not configured as I18n.backend"
+  #   end
+  #   puts "Pushing data to Ghostwriter"
+  #   begin
+  #     I18n.backend.push_all_backend_data
+  #   rescue Exception => e
+  #     abort e.message
+  #   end
+  # end
+  # 
+  # desc "Install default initializer for ghost reader"
+  # task :install => :environment do
+  # 
+  #   # TODO: this should work only when the ghost_reader is introduced as gem
+  #   infile = 'templates/ghost_reader.rb'
+  #   outdir = Rails.root.join("config", "initializers")
+  # 
+  #   puts "Installing ghost_reader.rb initializer..."
+  #   FileUtils.copy_file(infile, outdir)
+  #   puts "Done."
+  # end
 
 end

data/spec/ghost_reader/backend_spec.rb

@@ -25,7 +25,7 @@ describe GhostReader::Backend do
 
     let(:fallback) do
       mock("FallbackBackend").tap do |fallback|
-        fallback.stub!(:translate).and_return(translation)
+        fallback.stub!(:lookup).and_return(translation)
       end
     end
 
@@ -37,7 +37,7 @@ describe GhostReader::Backend do
 
     it 'should use the given fallback' do
       backend.config.fallback.should be(fallback)
-      fallback.should_receive(:translate)
+      fallback.should_receive(:lookup)
       backend.translate(:en, 'this.is.a.test').should eq(translation)
     end
 
@@ -48,7 +48,7 @@ describe GhostReader::Backend do
     end
 
     it 'should use memoization' do
-      fallback.should_receive(:translate).exactly(1)
+      fallback.should_receive(:lookup).exactly(1)
       2.times { backend.translate(:en, 'this.is.a.test').should eq(translation) }
     end
 
@@ -116,7 +116,7 @@ describe GhostReader::Backend do
   context 'GhostReader set up with raising fallback' do
     let(:fallback) do
       mock("FallbackBackend").tap do |fallback|
-        fallback.stub!(:translate) do
+        fallback.stub!(:lookup) do
           raise 'missing translation'
         end
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ghost_reader
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 1
   - 2
-  - 1
-  version: 1.2.1
+  - 2
+  version: 1.2.2
 platform: ruby
 authors: 
 - Phil Hofmann
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-19 00:00:00 +01:00
+date: 2012-01-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -154,6 +154,8 @@ files:
 - lib/ghost_reader.rb
 - lib/ghost_reader/backend.rb
 - lib/ghost_reader/client.rb
+- lib/ghost_reader/engine.rb
+- lib/ghost_reader/util.rb
 - lib/ghost_reader/version.rb
 - lib/tasks/ghost_reader.rake
 - lib/tasks/templates/ghost_reader.rb