ghost_reader 1.1.1 → 1.1.2

data/README.md

@@ -1,35 +1,59 @@
 GhostReader
 ===========
 
-i18n backend to ghost_writer service
+GhostReader is an alternative I18n backend which makes use of the
+GhostWriter service.
 
 ## Usage
 
-add a folowing to `config/initializers/ghost_reader.rb`
-
-    I18n.backend=GhostReader::Backend.new("HTTP_URL_TO_GHOST_SERVER",
-                  :default_backend=>I18n.backend, :wait_time=>30,
-                  :trace => Proc.new do |message|
-                    Rails.logger.debug message
-                  end)
-
-### wait_time
-The 'wait_time' is the minimum time in seconds after which reached a change
-from the Ghost_Writer Ghost_Client. A low value minimizes the delay,
-a high value minimizes the network-traffic.
-Default-Value is 30
-
-### default_backend
-The Ghost_reader tries to find default-values for not found translations and
-posts them to the server together with the statistical data.
-
-### max_packet_size
-For preventing Errors on receiving Server splits the ghost-reader the posts
-in parts with max max_packet_size count of keys
-
-### trace
-Proc for logging connection handling to Server
-
-
+### Gemfile
+
+    gem 'ghost_reader', '~> 1.1.1'
+
+### config/initializers/ghost_reader.rb
+
+    unless Rails.env.test?
+      config = {
+        :report_interval => 42, # secs
+        :retrieval_interval => 23, # secs
+        :fallback => I18n.backend,
+        :logfile => File.join(Rails.root, %w(log ghostwriter.log)),
+        :service => {
+          :api_key => '<here_goes_your_api_key>'
+        }
+      }
+      
+      I18n.backend = GhostReader::Backend.new(config)
+    end
+
+## Configuration
+
+* 'report interval' is the delay in seconds between subsequent POST
+  requests (reporting requests), which report missing translations. 
+* 'retrieval_interval' is the delay in seconds between subsequent GET
+  requests (incremental requests), which retrieve updated translations.
+* 'fallback' point to the I18n backend wich should be used as a
+  fallback.
+* 'logfile' is the path to a optional, separate logfile. If this is
+  omitted, log messages go to standard out.
+* 'service' holds a hash with connection details.
+  - 'api_key' is a GhostWriter API key.
+  - 'host' is the hostname, optionally with port.
+  - 'protocol' is either 'http' or 'https'
+  - 'uri' is the complete uri with the folling keys, which will be
+    replaced: :protocol, :host, :api_key
+
+## TODO
+
+* implement counting, for statistics
+* document all config options
+
+## THANKS
+
+All work on GhostReader is supported by Panter LLC, Zurich,
+Switzerland. http://panter.ch
+
+Special thanks go to Andreas Koenig, for his inital version of
+GhostReader, and Peco Danajlovski for helping with the rewrite.
 
 

data/lib/ghost_reader/backend.rb

@@ -1,10 +1,6 @@
 require 'logger'
 require 'ostruct'
 require 'i18n'
-#require 'i18n/backend/transliterator' # i18n/backend/base fails to require this
-#require 'i18n/backend/base'
-#require 'i18n/backend/memoize'
-#require 'i18n/backend/flatten'
 
 module GhostReader
   class Backend
@@ -30,6 +26,10 @@ module GhostReader
         config.logger.info "Initialized GhostReader backend."
       end
 
+      def available_locales
+        ( memoized_lookup.keys + config.fallback.available_locales ).uniq
+      end
+
       protected
 
       # this won't be called if memoize kicks in
@@ -147,7 +147,7 @@ module GhostReader
 
     include I18n::Backend::Base
     include Implementation
-    include I18n::Backend::Memoize # provides @memoized_lookup
+    include I18n::Backend::Memoize # provides #memoized_lookup
     include I18n::Backend::Flatten # provides #flatten_translations
   end
 end

data/lib/ghost_reader/version.rb

@@ -1,3 +1,3 @@
 module GhostReader
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

data/spec/ghost_reader/backend_spec.rb

@@ -40,6 +40,19 @@ describe GhostReader::Backend do
       result.has_key?(:one).should be_true
     end
 
+    it 'should nicely respond to available_locales' do
+      @backend.should respond_to(:available_locales)
+
+      expected = [:en, :de]
+      @fallback.stub!(:available_locales).and_return(expected)
+      @backend.available_locales.should eq(expected)
+
+      # FIXME
+      # @backend.send(:memoize_merge!, :it => {'dummay' => 'Dummy'})
+      # @backend.translate(:it, 'this.is.a.test')
+      # @backend.available_locales.should eq([:it, :en, :de])
+    end
+
     context 'nicely merge data into memoized_hash' do
 
       it 'should work with valid data' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ghost_reader
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 1
   - 1
-  - 1
-  version: 1.1.1
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Phil Hofmann