copycopter_client 1.1.2 → 2.0.0

data/lib/copycopter_client.rb

@@ -24,6 +24,12 @@ module CopycopterClient
     client.deploy
   end
 
+  # Issues a new export, returning yaml representation of blurb cache.
+  # This is called when the copycopter:export rake task is invoked.
+  def self.export
+    cache.export
+  end
+
   # Starts the polling process.
   def self.start_poller
     poller.start
@@ -47,7 +53,8 @@ module CopycopterClient
   # @example
   #   CopycopterClient.configure do |config|
   #     config.api_key = '1234567890abcdef'
-  #     config.secure  = false
+  #     config.host = 'your-copycopter-server.herokuapp.com'
+  #     config.secure = true
   #   end
   #
   # @param apply [Boolean] (internal) whether the configuration should be applied yet.
@@ -55,12 +62,15 @@ module CopycopterClient
   # @yield [Configuration] the configuration to be modified
   def self.configure(apply = true)
     self.configuration ||= Configuration.new
-    yield(configuration)
-    configuration.apply if apply
+    yield configuration
+
+    if apply
+      configuration.apply
+    end
   end
 end
 
-if defined?(Rails)
+if defined? Rails
   require 'copycopter_client/rails'
 end
 

data/lib/copycopter_client/cache.rb

@@ -13,13 +13,13 @@ module CopycopterClient
     # @param options [Hash]
     # @option options [Logger] :logger where errors should be logged
     def initialize(client, options)
-      @client     = client
-      @blurbs     = {}
-      @queued     = {}
-      @mutex      = Mutex.new
-      @logger     = options[:logger]
-      @started    = false
+      @blurbs = {}
+      @client = client
       @downloaded = false
+      @logger = options[:logger]
+      @mutex = Mutex.new
+      @queued = {}
+      @started = false
     end
 
     # Returns content for the given blurb.
@@ -43,33 +43,67 @@ module CopycopterClient
       lock { @blurbs.keys }
     end
 
+    # Yaml representation of all blurbs
+    # @return [String] yaml
+    def export
+      keys = {}
+      lock do
+        @blurbs.sort.each do |(blurb_key, value)|
+          current = keys
+          yaml_keys = blurb_key.split('.')
+
+          0.upto(yaml_keys.size - 2) do |i|
+            key = yaml_keys[i]
+
+            # Overwrite en.key with en.sub.key
+            unless current[key].class == Hash
+              current[key] = {}
+            end
+
+            current = current[key]
+          end
+
+          current[yaml_keys.last] = value
+        end
+      end
+
+      unless keys.size < 1
+        keys.to_yaml
+      end
+    end
+
     # Waits until the first download has finished.
     def wait_for_download
       if pending?
-        logger.info("Waiting for first download")
-        logger.flush if logger.respond_to?(:flush)
+        logger.info 'Waiting for first download'
+
+        if logger.respond_to? :flush
+          logger.flush
+        end
+
         while pending?
-          sleep(0.1)
+          sleep 0.1
         end
       end
     end
 
     def flush
       with_queued_changes do |queued|
-        client.upload(queued)
+        client.upload queued
       end
     rescue ConnectionError => error
-      logger.error(error.message)
+      logger.error error.message
     end
 
     def download
       @started = true
+
       client.download do |downloaded_blurbs|
-        downloaded_blurbs.reject! { |key, value| value == "" }
+        downloaded_blurbs.reject! { |key, value| value == '' }
         lock { @blurbs = downloaded_blurbs }
       end
     rescue ConnectionError => error
-      logger.error(error.message)
+      logger.error error.message
     ensure
       @downloaded = true
     end
@@ -86,17 +120,21 @@ module CopycopterClient
 
     def with_queued_changes
       changes_to_push = nil
+
       lock do
         unless @queued.empty?
           changes_to_push = @queued
           @queued = {}
         end
       end
-      yield(changes_to_push) if changes_to_push
+
+      if changes_to_push
+        yield changes_to_push
+      end
     end
 
     def lock(&block)
-      @mutex.synchronize(&block)
+      @mutex.synchronize &block
     end
 
     def pending?

data/lib/copycopter_client/client.rb

@@ -28,7 +28,7 @@ module CopycopterClient
     def initialize(options)
       [:api_key, :host, :port, :public, :http_read_timeout,
         :http_open_timeout, :secure, :logger, :ca_file].each do |option|
-        instance_variable_set("@#{option}", options[option])
+        instance_variable_set "@#{option}", options[option]
       end
     end
 
@@ -47,12 +47,14 @@ module CopycopterClient
         request = Net::HTTP::Get.new(uri(download_resource))
         request['If-None-Match'] = @etag
         response = http.request(request)
-        if check(response)
-          log("Downloaded translations")
+
+        if check response
+          log 'Downloaded translations'
           yield JSON.parse(response.body)
         else
-          log("No new translations")
+          log 'No new translations'
         end
+
         @etag = response['ETag']
       end
     end
@@ -62,9 +64,9 @@ module CopycopterClient
     # @raise [ConnectionError] if the connection fails
     def upload(data)
       connect do |http|
-        response = http.post(uri("draft_blurbs"), data.to_json, 'Content-Type' => 'application/json')
-        check(response)
-        log("Uploaded missing translations")
+        response = http.post(uri('draft_blurbs'), data.to_json, 'Content-Type' => 'application/json')
+        check response
+        log 'Uploaded missing translations'
       end
     end
 
@@ -72,9 +74,9 @@ module CopycopterClient
     # @raise [ConnectionError] if the connection fails
     def deploy
       connect do |http|
-        response = http.post(uri("deploys"), "")
-        check(response)
-        log("Deployed")
+        response = http.post(uri('deploys'), '')
+        check response
+        log 'Deployed'
       end
     end
 
@@ -93,9 +95,9 @@ module CopycopterClient
 
     def download_resource
       if public?
-        "published_blurbs"
+        'published_blurbs'
       else
-        "draft_blurbs"
+        'draft_blurbs'
       end
     end
 
@@ -103,11 +105,12 @@ module CopycopterClient
       http = Net::HTTP.new(host, port)
       http.open_timeout = http_open_timeout
       http.read_timeout = http_read_timeout
-      http.use_ssl      = secure
-      http.verify_mode  = OpenSSL::SSL::VERIFY_PEER
-      http.ca_file      = ca_file
+      http.use_ssl = secure
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http.ca_file = ca_file
+
       begin
-        yield(http)
+        yield http
       rescue *HTTP_ERRORS => exception
         raise ConnectionError, "#{exception.class.name}: #{exception.message}"
       end
@@ -127,7 +130,7 @@ module CopycopterClient
     end
 
     def log(message)
-      logger.info(message)
+      logger.info message
     end
   end
 end

data/lib/copycopter_client/configuration.rb

@@ -18,9 +18,6 @@ module CopycopterClient
         :proxy_port, :proxy_user, :secure, :polling_delay, :logger,
         :framework, :middleware, :ca_file].freeze
 
-    # Default root certificate used to verify ssl sessions.
-    CA_FILE = File.expand_path('../../../AddTrustExternalCARoot.crt', __FILE__).freeze
-
     # @return [String] The API key for your project, found on the project edit form.
     attr_accessor :api_key
 
@@ -87,25 +84,24 @@ module CopycopterClient
     # @return [Cache] instance used internally to synchronize changes.
     attr_accessor :cache
 
-    # @return [Client] instance used to communicate with the Copycopter server.
+    # @return [Client] instance used to communicate with a Copycopter Server.
     attr_accessor :client
 
     alias_method :secure?, :secure
 
     # Instantiated from {CopycopterClient.configure}. Sets defaults.
     def initialize
-      self.secure                   = true
-      self.host                     = 'copycopter.com'
-      self.http_open_timeout        = 2
-      self.http_read_timeout        = 5
+      self.client_name = 'Copycopter Client'
+      self.client_url = 'https://rubygems.org/gems/copycopter_client'
+      self.client_version = VERSION
       self.development_environments = %w(development staging)
-      self.test_environments        = %w(test cucumber)
-      self.client_name              = 'Copycopter Client'
-      self.client_version           = VERSION
-      self.client_url               = 'http://copycopter.com'
-      self.polling_delay            = 300
-      self.logger                   = Logger.new($stdout)
-      self.ca_file                  = CA_FILE
+      self.host = 'copycopter.com'
+      self.http_open_timeout = 2
+      self.http_read_timeout = 5
+      self.logger = Logger.new($stdout)
+      self.polling_delay = 300
+      self.secure = false
+      self.test_environments = %w(test cucumber)
       @applied = false
     end
 
@@ -121,8 +117,9 @@ module CopycopterClient
     # @return [Hash] configuration attributes
     def to_hash
       base_options = { :public => public? }
+
       OPTIONS.inject(base_options) do |hash, option|
-        hash.merge(option.to_sym => send(option))
+        hash.merge option.to_sym => send(option)
       end
     end
 
@@ -131,7 +128,7 @@ module CopycopterClient
     # @param [Hash] hash A set of configuration options that will take precedence over the defaults
     # @return [Hash] the merged configuration hash
     def merge(hash)
-      to_hash.merge(hash)
+      to_hash.merge hash
     end
 
     # Determines if the published or draft content will be used
@@ -144,13 +141,13 @@ module CopycopterClient
     # Determines if the content will be editable
     # @return [Boolean] Returns +true+ if in a development environment, +false+ otherwise.
     def development?
-      development_environments.include?(environment_name)
+      development_environments.include? environment_name
     end
 
     # Determines if the content will fetched from the server
     # @return [Boolean] Returns +true+ if in a test environment, +false+ otherwise.
     def test?
-      test_environments.include?(environment_name)
+      test_environments.include? environment_name
     end
 
     # Determines if the configuration has been applied (internal)
@@ -168,15 +165,22 @@ module CopycopterClient
     # When {#test?} returns +false+, the poller will be started.
     def apply
       self.client ||= Client.new(to_hash)
-      self.cache  ||= Cache.new(client, to_hash)
-      poller        = Poller.new(cache, to_hash)
+      self.cache ||= Cache.new(client, to_hash)
+      poller = Poller.new(cache, to_hash)
       process_guard = ProcessGuard.new(cache, poller, to_hash)
-      I18n.backend  = I18nBackend.new(cache)
-      middleware.use(RequestSync, :cache => cache) if middleware && development?
+      I18n.backend = I18nBackend.new(cache)
+
+      if middleware && development?
+        middleware.use RequestSync, :cache => cache
+      end
+
       @applied = true
-      logger.info("Client #{VERSION} ready")
-      logger.info("Environment Info: #{environment_info}")
-      process_guard.start unless test?
+      logger.info "Client #{VERSION} ready"
+      logger.info "Environment Info: #{environment_info}"
+
+      unless test?
+        process_guard.start
+      end
     end
 
     def port

data/lib/copycopter_client/version.rb

@@ -1,8 +1,7 @@
 module CopycopterClient
   # Client version
-  VERSION = "1.1.2"
+  VERSION = '2.0.0'
 
   # API version being used to communicate with the server
-  API_VERSION = "2.0".freeze
+  API_VERSION = '2.0'.freeze
 end
-

data/lib/tasks/copycopter_client_tasks.rake

@@ -4,4 +4,17 @@ namespace :copycopter do
     CopycopterClient.deploy
     puts "Successfully marked all blurbs as published."
   end
+
+  desc "Export Copycopter blurbs to yaml."
+  task :export => :environment do
+    CopycopterClient.cache.sync
+
+    if yml = CopycopterClient.export
+      PATH = "config/locales/copycopter.yml"
+      File.new("#{Rails.root}/#{PATH}", 'w').write(yml)
+      puts "Successfully exported blurbs to #{PATH}."
+    else
+      puts "No blurbs have been cached."
+    end
+  end
 end

data/spec/copycopter_client/cache_spec.rb

@@ -205,5 +205,70 @@ describe CopycopterClient::Cache do
 
     cache.should have_received(:flush)
   end
+
+  describe "#export" do
+    before do
+      save_blurbs
+      @cache = build_cache
+      @cache.download
+    end
+
+    let(:save_blurbs) {}
+
+    it "can be invoked from the top-level constant" do
+      CopycopterClient.configure do |config|
+        config.cache = @cache
+      end
+      @cache.stubs(:export)
+
+      CopycopterClient.export
+
+      @cache.should have_received(:export)
+    end
+
+    it "returns no yaml with no blurb keys" do
+      @cache.export.should == nil
+    end
+
+    context "with single-level blurb keys" do
+      let(:save_blurbs) do
+        client['key']       = 'test value'
+        client['other_key'] = 'other test value'
+      end
+
+      it "returns blurbs as yaml" do
+        exported = YAML.load(@cache.export)
+        exported['key'].should == 'test value'
+        exported['other_key'].should == 'other test value'
+      end
+    end
+
+    context "with multi-level blurb keys" do
+      let(:save_blurbs) do
+        client['en.test.key']       = 'en test value'
+        client['en.test.other_key'] = 'en other test value'
+        client['fr.test.key']       = 'fr test value'
+      end
+
+      it "returns blurbs as yaml" do
+        exported = YAML.load(@cache.export)
+        exported['en']['test']['key'].should == 'en test value'
+        exported['en']['test']['other_key'].should == 'en other test value'
+        exported['fr']['test']['key'].should == 'fr test value'
+      end
+    end
+
+    context "with conflicting blurb keys" do
+      let(:save_blurbs) do
+        client['en.test']     = 'test value'
+        client['en.test.key'] = 'other test value'
+      end
+
+      it "retains the new key" do
+        exported = YAML.load(@cache.export)
+        exported['en']['test']['key'].should == 'other test value'
+      end
+    end
+  end
 end