localeapp 0.1.2 → 0.2.0

data/.rvmrc

@@ -1 +1 @@
-rvm ruby-1.9.2@localeapp
+rvm ruby-1.9.3@localeapp

data/.travis.yml

@@ -1,6 +1,6 @@
 rvm:
   - 1.8.7
-  - 1.9.2
+  - 1.9.3
 gemfile:
   - Gemfile.i18n_037
   - Gemfile.i18n_050

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# HEAD
+
+* Add `localeapp add` command for sending keys and translations from the command line
+* Add `secure` configuration setting for api communications. Default: true
+* Add `ssl_verify` and `ssl_ca_file` configuration settings for ssl cert verification.
+  Off by default, see the README for more details
+* Add `proxy` configuration setting
+
 # Version 0.1.2
 
 * Fix incorrect documentation

data/README.md

@@ -10,10 +10,6 @@ The gem hooks into the i18n exception mechanism to send missing translations to
 the app. When translated content has been added it's automatically pulled down
 so you can see it straight away.
 
-We're still in private beta but if you think Locale would be useful to you and
-are willing to provide feedback then please get in touch at info@localeapp.com
-and we'll see what we can do.
-
 ## Installation
 
 ### Rails 3
@@ -59,11 +55,9 @@ localeapp.com and the localeapp import command accept zip files.
 
 ## Default Rails Translations
 
-Locale will hide default rails translations to avoid cluttering up your
-translation view with content you haven't changed. This can make it look like
-we didn't import all of your translations but we promise they're there and will
-appear again when you export. If you want to override a default translation you
-can create the key manually in Locale and we'll use your version instead.
+Locale will automatically add the standard rails translations when a project is
+created. If for some reason you don't want these, you can remove them using in
+the project libraries area on localeapp.com
 
 ## Automatically sending missing translations
 
@@ -79,6 +73,15 @@ environment then edit `config/initializers/localeapp.rb` to include:
 This is just an array, so you can configure it to match send in any environment
 you wish.
 
+## Manually create translations
+
+You can create translations on the command line by running:
+
+    localeapp add key.name en:"test content" es:"spanish content"
+
+You must provide at least one translation and the locale code must already
+exist in the project.
+
 ## Automatically pulling translations
 
 There are two ways to do this, one that suits a single developer working the
@@ -109,7 +112,10 @@ Run the daemon with:
     localeapp daemon
 
 The listeners will automatically reload translations when they see there are
-new ones.
+new ones. The daemon has two options:
+
+  -b will run in the background and put a pid file in tmp/pids/localeapp.pid
+  -i X will change the polling interval to X from it's default five seconds.
 
 ### Disabling Reloading
 
@@ -131,6 +137,26 @@ You can also add a new locale to a project via localeapp.com. This will create
 missing translations for every translation key. You will need to restart any
 listeners completely to pick up the new locale.
 
+### Proxies
+
+If you need to go through a proxy server, you can configure it with:
+
+    config.proxy = "http://my.proxy.com:8888"
+
+### SSL Certificate verification
+
+localeapp.com uses https everywhere but certificate validation is turned off by
+default. This is because ruby doesn't know how to read the certs from the OSX
+keychain. You can turn verification on and tell the gem where the latest CA
+certificates are by adding:
+
+    config.ssl_verify = true
+    config.ssl_ca_file = /path/to/ca_cert.pm
+
+See [this article on Ruby Inside][1] for some more details.
+
+[1]: http://www.rubyinside.com/how-to-cure-nethttps-risky-default-https-behavior-4010.html
+
 ### Support and feedback
 
 You can contact us via the support link at the bottom of the page, emailing

data/bin/localeapp

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 $LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
 
-require 'slop'
 require 'localeapp'
 
 # Don't connect to the net if we're running under cucumber for testing
@@ -21,71 +20,104 @@ def include_config_file
     exit 1
   end
 end
-slop = Slop.new(ARGV, :help => true, :strict => true) do
-  banner "Usage: localeapp COMMAND [options]"
-  description <<-COMMANDS
-    COMMAND:
-    install <api_key> - Creates new configuration files and confirms key works
-    pull              - Pulls all translations from localeapp.com
-    push <file>       - Pushes a translation file to localeapp.com
-    update            - Gets any changes since the last poll and updates the yml
-    daemon            - Simple daemon (checks every 5 seconds for new translations)
-COMMANDS
-
-  on_empty { puts self.to_s }
-end
 
-slop.command :install do
-  execute do |opts, args|
+require 'gli'
+include GLI
+
+version Localeapp::VERSION
+
+desc "Creates new configuration files and confirms key works"
+arg_name "<api_key>"
+command :install do |c|
+  c.action do |global_options, options, args|
     key = args.first
     installer = Localeapp::CLI::Install.new
-    if installer.execute(key)
-      exit 0
+    unless installer.execute(key)
+      exit_now! "", 1
+    end
+  end
+end
+
+desc "Sends the key and content to localeapp.com"
+arg_name "<key> <locale:content> (<locale:content> ...)"
+command :add do |c|
+  c.action do |global_options, options, args|
+    key = args.shift
+    if key.nil? || args.size.zero?
+      exit_now! "localeapp add requires a key name and at least one translation", 1
     else
-      exit 1
+      include_config_file
+      Localeapp::CLI::Add.new.execute(key, *args)
     end
   end
 end
 
-slop.command :pull do
-  execute do |opts, args|
+desc "Pulls all translations from localeapp.com"
+command :pull do |c|
+  c.action do |global_options, options, args|
     include_config_file
     Localeapp::CLI::Pull.new.execute
   end
 end
 
-slop.command :push do
-  on_empty { puts "localeapp push requires an file to push" }
-
-  execute do |opts, args|
-    file = args.first
-    exit 1 if file.nil?
-    include_config_file
-    pusher = Localeapp::CLI::Push.new
-    pusher.execute(file)
+desc "Pushes a translation file to localeapp.com"
+arg_name "<file>"
+command :push do |c|
+  c.action do |global_options, options, args|
+    if args.empty?
+      exit_now! "localeapp push requires an file to push", 1
+    else
+      file = args.first
+      include_config_file
+      pusher = Localeapp::CLI::Push.new
+      pusher.execute(file)
+    end
   end
 end
 
-slop.command :update do
-  execute do |opts, args|
+desc "Gets any changes since the last poll and updates the yml"
+command :update do |c|
+  c.action do |global_options, options, args|
     include_config_file
     Localeapp::CLI::Update.new.execute
   end
 end
 
-slop.command :daemon do
-  execute do |opts, args|
+desc "Simple daemon (checks for new translations in the background)"
+command :daemon do |c|
+  c.desc "Interval to wait between checks"
+  c.arg_name 'interval'
+  c.default_value 5
+  c.flag [:i, :interval]
+
+  c.desc "run the daemon in the background"
+  c.switch [:b, 'background']
+
+  c.action do |global_options, options, args|
     include_config_file
-    while true do
-      Localeapp::CLI::Update.new.execute
-      sleep 5
+
+    interval = options[:interval].to_i
+
+    if interval <= 0
+      exit_now! "interval must be a positive integer greater than 0", 1
+    end
+
+    command = Proc.new do
+      loop do
+        Localeapp::CLI::Update.new.execute
+        sleep interval
+      end
+    end
+    if options[:background]
+      pid = fork do
+        command.call
+      end
+      pids_directory = "tmp/pids"
+      File.open("#{File.directory?(pids_directory) ? pids_directory : "./"}/localeapp.pid", 'w') {|f| f << pid}
+    else
+      command.call
     end
   end
 end
 
-begin
-  slop.parse
-rescue Slop::InvalidOptionError
-  puts slop
-end
-puts slop unless ARGV.empty?
+exit GLI.run(ARGV)

data/features/localeapp_binary.feature

@@ -2,14 +2,10 @@ Feature: localeapp executable
 
   Scenario: Viewing help
     In order to see what options I have
-    When I run `localeapp --help`
+    When I run `localeapp help`
     Then the output should contain:
     """
-    Usage: localeapp COMMAND [options]
-
-        COMMAND:
-        install <api_key> - Creates new configuration files and confirms key works
-        pull              - Pulls all translations from localeapp.com
+    usage: localeapp command [command options]
     """
 
   Scenario: Running a command that doesn't exist
@@ -17,11 +13,7 @@ Feature: localeapp executable
     When I run `localeapp foo`
     Then the output should contain:
     """
-    Usage: localeapp COMMAND [options]
-
-        COMMAND:
-        install <api_key> - Creates new configuration files and confirms key works
-        pull              - Pulls all translations from localeapp.com
+    error: Unknown command 'foo'. Use 'localeapp help' for a list of commands
     """
 
   Scenario: Running install
@@ -37,6 +29,7 @@ Feature: localeapp executable
     Project: Test Project
     Default Locale: en (English)
     """
+    And help should not be displayed
     And a file named "config/initializers/localeapp.rb" should exist
     And the exit status should be 0
 
@@ -51,19 +44,47 @@ Feature: localeapp executable
     Checking API key: BADAPIKEY
     ERROR: Project not found
     """
+    And help should not be displayed
     And a file named "config/initializers/localeapp.rb" should not exist
     And the exit status should not be 0
 
+  Scenario: Running add
+    In order to add a key and translation content
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And an initializer file
+    When I run `localeapp add foo.baz en:"test en content" es:"test es content"`
+    Then the output should contain:
+    """
+    Localeapp Add
+
+    Sending key: foo.baz
+    Success!
+    """
+
+  Scenario: Running add with no arguments
+    In order to add a key and translation content
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And an initializer file
+    When I run `localeapp add`
+    Then the output should contain:
+    """
+    localeapp add requires a key name and at least one translation
+    """
+
+  Scenario: Running add with just a key name
+    In order to add a key and translation content
+    When I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And an initializer file
+    When I run `localeapp add foo.bar`
+    Then the output should contain:
+    """
+    localeapp add requires a key name and at least one translation
+    """
+
   Scenario: Running pull
     In order to retreive my translations
     Given I have a translations on localeapp.com for the project with api key "MYAPIKEY"
-    And a file named "config/initializers/localeapp.rb" with:
-    """
-    require 'localeapp/rails'
-    Localeapp.configure do |config|
-      config.api_key = 'MYAPIKEY'
-    end
-    """
+    And an initializer file
     And a directory named "config/locales"
     When I run `localeapp pull`
     Then the output should contain:
@@ -75,18 +96,13 @@ Feature: localeapp executable
     Updating backend:
     Success!
     """
+    And help should not be displayed
     And a file named "config/locales/en.yml" should exist
 
   Scenario: Running push
     In order to send my translations
     When I have a valid project on localeapp.com with api key "MYAPIKEY"
-    And a file named "config/initializers/localeapp.rb" with:
-    """
-    require 'localeapp/rails'
-    Localeapp.configure do |config|
-      config.api_key = 'MYAPIKEY'
-    end
-    """
+    And an initializer file
     And an empty file named "config/locales/en.yml"
     When I run `localeapp push config/locales/en.yml`
     Then the output should contain:
@@ -98,17 +114,12 @@ Feature: localeapp executable
 
     config/locales/en.yml queued for processing.
     """
+    And help should not be displayed
 
   Scenario: Running update
     In order to receive the translations that have been updated since the last check
     When I have a valid project on localeapp.com with api key "MYAPIKEY"
-    And a file named "config/initializers/localeapp.rb" with:
-    """
-    require 'localeapp/rails'
-    Localeapp.configure do |config|
-      config.api_key = 'MYAPIKEY'
-    end
-    """
+    And an initializer file
     And a file named "log/localeapp.yml" with:
     """
     ---
@@ -123,6 +134,7 @@ Feature: localeapp executable
     Localeapp update: checking for translations since 120
     Found and updated new translations
     """
+    And help should not be displayed
     And a file named "config/locales/en.yml" should exist
     # check the content here
     # and the localeapp.yml file

data/features/step_definitions/cli_steps.rb

@@ -2,26 +2,48 @@ require 'net/http'
 require 'time'
 
 When /^I have a valid project on localeapp\.com with api key "([^"]*)"$/ do |api_key|
-  uri = "http://api.localeapp.com/v1/projects/#{api_key}.json"
+  uri = "https://api.localeapp.com/v1/projects/#{api_key}.json"
   body = valid_project_data.to_json
   add_fake_web_uri(:get, uri, ['200', 'OK'], body)
-  add_fake_web_uri(:post, "http://api.localeapp.com/v1/projects/#{api_key}/import/", ['202', 'OK'], '')
+  add_fake_web_uri(:post, "https://api.localeapp.com/v1/projects/#{api_key}/import/", ['202', 'OK'], '')
+  add_fake_web_uri(:post, "https://api.localeapp.com/v1/projects/#{api_key}/translations/missing.json", ["202", "OK"], '')
 end
 
 When /^I have a valid project on localeapp\.com but an incorrect api key "([^"]*)"$/ do |bad_api_key|
-  uri = "http://api.localeapp.com/v1/projects/#{bad_api_key}.json"
+  uri = "https://api.localeapp.com/v1/projects/#{bad_api_key}.json"
   body = valid_project_data.to_json
   add_fake_web_uri(:get, uri, ['404', 'Not Found'], body)
 end
 
 When /^I have a translations on localeapp\.com for the project with api key "([^"]*)"$/ do |api_key|
-  uri = "http://api.localeapp.com/v1/projects/#{api_key}/translations.json"
+  uri = "https://api.localeapp.com/v1/projects/#{api_key}/translations.json"
   body = valid_translation_data.to_json
   add_fake_web_uri(:get, uri, ['200', 'OK'], body)
 end
 
 When /^new translations for the api key "([^"]*)" since "([^"]*)" with time "([^"]*)"$/ do |api_key, update_time, new_time|
-  uri = "http://api.localeapp.com/v1/projects/#{api_key}/translations.json?updated_at=#{update_time}"
+  uri = "https://api.localeapp.com/v1/projects/#{api_key}/translations.json?updated_at=#{update_time}"
   body = valid_translation_data.to_json
   add_fake_web_uri(:get, uri, ['200', 'OK'], body, 'date' => Time.at(new_time.to_i).httpdate)
 end
+
+When /^an initializer file$/ do
+  steps %Q{
+    And a file named "config/initializers/localeapp.rb" with:
+    """
+    require 'localeapp/rails'
+    Localeapp.configure do |config|
+      config.api_key = 'MYAPIKEY'
+    end
+    """
+  }
+end
+
+When /^help should not be displayed$/ do
+  steps %Q{
+    And the output should not contain:
+    """
+    Usage: localeapp COMMAND [options]
+    """
+  }
+end

data/lib/localeapp/api_caller.rb

@@ -47,12 +47,19 @@ module Localeapp
       begin
         @connection_attempts += 1
         Localeapp.debug("ATTEMPT #{@connection_attempts}")
-        request_options = options[:request_options] || {}
+        headers = { :x_localeapp_gem_version => Localeapp::VERSION }.merge(options[:headers] || {})
+        parameters = {
+          :url => url,
+          :method => method,
+          :headers => headers,
+          :verify_ssl => (Localeapp.configuration.ssl_verify ? OpenSSL::SSL::VERIFY_PEER : false)
+        }
+        parameters[:ca_file] = Localeapp.configuration.ssl_ca_file if Localeapp.configuration.ssl_ca_file
         if method == :post
-          RestClient.send(method, url, options[:payload], request_options)
-        else
-          RestClient.send(method, url, request_options)
+          parameters[:payload] = options[:payload]
         end
+        RestClient.proxy = Localeapp.configuration.proxy if Localeapp.configuration.proxy
+        RestClient::Request.execute(parameters)
       rescue RestClient::ResourceNotFound,
         RestClient::NotModified,
         RestClient::InternalServerError,

data/lib/localeapp/cli/add.rb

@@ -0,0 +1,26 @@
+module Localeapp
+  module CLI
+    class Add
+      def initialize(output = $stdout)
+        @output = output
+      end
+
+      def execute(key, *translations)
+        @output.puts "Localeapp Add"
+        @output.puts ""
+        translations.each do |translation|
+          if translation =~ /([\w\-]+):(.*)/
+            locale, description = $1, $2
+            Localeapp.missing_translations.add(locale, key, description)
+          else
+            @output.puts "Ignoring bad translation #{translation}"
+            @output.puts "format should be <locale>:<translation content>"
+          end
+        end
+        @output.puts "Sending key: #{key}"
+        Localeapp.sender.post_missing_translations
+        @output.puts "Success!"
+      end
+    end
+  end
+end

data/lib/localeapp/configuration.rb

@@ -7,7 +7,19 @@ module Localeapp
     # The host to connect to (defaults to api.localeapp.com)
     attr_accessor :host
 
-    # The port to connect to (defaults to 80)
+    # The proxy to connect via
+    attr_accessor :proxy
+
+    # Whether to use https or not (defaults to true)
+    attr_accessor :secure
+
+    # Whether to verify ssl server certificates or not (defaults to false, see README)
+    attr_accessor :ssl_verify
+
+    # Path to local CA certs bundle
+    attr_accessor :ssl_ca_file
+
+    # The port to connect to if it's not the default one
     attr_accessor :port
 
     attr_accessor :http_auth_username
@@ -80,7 +92,8 @@ module Localeapp
 
     def initialize
       @host                            = 'api.localeapp.com'
-      @port                            = 80
+      @secure                          = true
+      @ssl_verify                      = false
       @disabled_sending_environments   = %w(test cucumber production)
       @disabled_reloading_environments = %w(test cucumber production)
       @disabled_polling_environments   = %w(test cucumber production)

data/lib/localeapp/exception_handler.rb

@@ -7,7 +7,7 @@ module Localeapp
         Localeapp.log("Detected missing translation for key(s) #{key.inspect}")
 
         [*key].each do |key|
-          Localeapp.missing_translations.add(locale, key, options || {})
+          Localeapp.missing_translations.add(locale, key, nil, options || {})
         end
 
         [locale, key].join(', ')

data/lib/localeapp/missing_translations.rb

@@ -1,13 +1,13 @@
 module Localeapp
-  MissingTranslationRecord = Struct.new(:key, :locale, :options)
+  MissingTranslationRecord = Struct.new(:key, :locale, :description, :options)
 
   class MissingTranslations
     def initialize
       @translations = Hash.new { |h, k| h[k] = {} }
     end
 
-    def add(locale, key, options = {})
-      record = MissingTranslationRecord.new(key, locale, options)
+    def add(locale, key, description = nil, options = {})
+      record = MissingTranslationRecord.new(key, locale, description, options)
       @translations[locale][key] = record
     end
 
@@ -26,6 +26,7 @@ module Localeapp
           missing_data = {}
           missing_data[:key] = key
           missing_data[:locale] = locale
+          missing_data[:description] = record.description if record.description
           missing_data[:options] = record.options
           data << missing_data
         end

data/lib/localeapp/routes.rb

@@ -8,12 +8,12 @@ module Localeapp
 
     def project_url(options = {})
       options[:format] ||= 'json'
-      URI::HTTP.build(base_options.merge(:path => project_path(options[:format]))).to_s
+      http_scheme.build(base_options.merge(:path => project_path(options[:format]))).to_s
     end
 
     def translations_url(options={})
       options[:format] ||= 'json'
-      url = URI::HTTP.build(base_options.merge(:path => translations_path(options[:format])))
+      url = http_scheme.build(base_options.merge(:path => translations_path(options[:format])))
       url.query = options[:query].map { |k,v| "#{k}=#{v}" }.join('&') if options[:query]
       url.to_s
     end
@@ -32,7 +32,7 @@ module Localeapp
 
     def missing_translations_url(options={})
       options[:format] ||= 'json'
-      url = URI::HTTP.build(base_options.merge(:path => missing_translations_path(options[:format])))
+      url = http_scheme.build(base_options.merge(:path => missing_translations_path(options[:format])))
       url.query = options[:query].map { |k,v| "#{k}=#{v}" }.join('&') if options[:query]
       url.to_s
     end
@@ -42,10 +42,17 @@ module Localeapp
     end
 
     def import_url(options={})
-      URI::HTTP.build(base_options.merge(:path => import_path)).to_s
+      http_scheme.build(base_options.merge(:path => import_path)).to_s
     end
 
   private
+    def http_scheme
+      if Localeapp.configuration.secure
+        URI::HTTPS
+      else
+        URI::HTTP
+      end
+    end
 
     def base_options
       options = {:host => Localeapp.configuration.host, :port => Localeapp.configuration.port}

data/lib/localeapp/sender.rb

@@ -12,7 +12,7 @@ module Localeapp
       @data = { :translation => translation }
       api_call :create_translation,
         :payload => @data.to_json,
-        :request_options => { :content_type => :json },
+        :headers => { :content_type => :json },
         :success => :handle_single_translation_success,
         :failure => :handle_single_translation_failure,
         :max_connection_attempts => 1
@@ -32,7 +32,7 @@ module Localeapp
       @data = { :translations => to_send }
       api_call :missing_translations,
         :payload => @data.to_json,
-        :request_options => { :content_type => :json },
+        :headers => { :content_type => :json },
         :success => :handle_missing_translation_success,
         :failure => :handle_missing_translation_failure,
         :max_connection_attempts => 1

data/lib/localeapp/version.rb

@@ -1,3 +1,3 @@
 module Localeapp
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/localeapp.rb

@@ -38,6 +38,7 @@ require 'localeapp/cli/install'
 require 'localeapp/cli/pull'
 require 'localeapp/cli/push'
 require 'localeapp/cli/update'
+require 'localeapp/cli/add'
 
 # AUDIT: Will this work on ruby 1.9.x
 $KCODE="UTF8" if RUBY_VERSION < '1.9'

data/localeapp.gemspec

@@ -23,12 +23,12 @@ Gem::Specification.new do |s|
   s.add_dependency('json')
   s.add_dependency('rest-client')
   s.add_dependency('ya2yaml')
-  s.add_dependency('slop')
+  s.add_dependency('gli')
 
   s.add_development_dependency('rake')
   s.add_development_dependency('rspec', '2.5.0')
   s.add_development_dependency('yard', '0.6.7')
-  s.add_development_dependency('RedCloth', '4.2.7')
+  s.add_development_dependency('RedCloth', '4.2.8')
   s.add_development_dependency('aruba', '0.3.6')
   s.add_development_dependency('fakeweb', '1.3.0')
 end

data/spec/localeapp/api_caller_spec.rb

@@ -10,34 +10,85 @@ end
 
 describe Localeapp::ApiCaller, "#call(object)" do
   before do
-    @api_caller = Localeapp::ApiCaller.new(:test)
-    @url = 'http://example.com/test'
+    with_configuration do
+      @api_caller = Localeapp::ApiCaller.new(:test)
+    end
+    @url = 'https://example.com/test'
     @api_caller.stub!(:test_endpoint).and_return([:get, @url])
     @api_caller.stub!(:sleep_if_retrying)
   end
 
   it "gets the method and url for the endpoint" do
     @api_caller.should_receive(:test_endpoint).with({}).and_return([:get, @url])
-    RestClient.stub!(:get).and_return(double('response', :code => 200))
+    RestClient::Request.stub!(:execute).and_return(double('response', :code => 200))
     @api_caller.call(self)
   end
 
   it "passes through any url options" do
     @api_caller.should_receive(:test_endpoint).with({:foo => :bar}).and_return([:get, @url])
     @api_caller.options[:url_options] = { :foo => :bar }
-    RestClient.stub!(:get).and_return(double('response', :code => 200))
+    RestClient::Request.stub!(:execute).and_return(double('response', :code => 200))
+    @api_caller.call(self)
+  end
+
+  it "adds the gem version to the headers" do
+    RestClient::Request.should_receive(:execute).with(hash_including(:headers => { :x_localeapp_gem_version => Localeapp::VERSION })).and_return(double('response', :code => 200))
     @api_caller.call(self)
   end
 
+  context "Proxy" do
+    before do
+      RestClient::Request.stub!(:execute).and_return(double('response', :code => 200))
+    end
+
+    it "sets the proxy if configured" do
+      Localeapp.configuration.proxy = "http://localhost:8888"
+      RestClient.should_receive(:proxy=).with('http://localhost:8888')
+      @api_caller.call(self)
+    end
+
+    it "doesn't set the proxy if it's not configured" do
+      RestClient.should_not_receive(:proxy=)
+      @api_caller.call(self)
+    end
+  end
+
+  context "SSL Certificate Validation" do
+    it "set the HTTPClient verify_ssl to VERIFY_PEER if ssl_verify is set to true" do
+      Localeapp.configuration.ssl_verify = true
+      RestClient::Request.should_receive(:execute).with(hash_including(:verify_ssl => OpenSSL::SSL::VERIFY_PEER)).and_return(double('response', :code => 200))
+      @api_caller.call(self)
+    end
+
+    it "set the HTTPClient verify_ssl to false if ssl_verify is set to false" do
+      RestClient::Request.should_receive(:execute).with(hash_including(:verify_ssl => false)).and_return(double('response', :code => 200))
+      @api_caller.call(self)
+    end
+  end
+
+  context "SSL Certificate Validation" do
+    it "set the HTTPClient ca_file to the value given to ssl_ca_file if it's not nil" do
+      Localeapp.configuration.ssl_ca_file = '/tmp/test'
+      RestClient::Request.should_receive(:execute).with(hash_including(:ca_file => '/tmp/test')).and_return(double('response', :code => 200))
+      @api_caller.call(self)
+    end
+
+    it "doesn't set the HTTPClient ca_file if ssl_ca_file is nil" do
+      Localeapp.configuration.ssl_ca_file = nil
+      RestClient::Request.should_receive(:execute).with(hash_not_including(:ca_file => nil)).and_return(double('response', :code => 200))
+      @api_caller.call(self)
+    end
+  end
+
   context "a GET request" do
     it "makes the call to the api" do
-      RestClient.should_receive(:get).with(@url, {}).and_return(double('response', :code => 200))
+      RestClient::Request.should_receive(:execute).with(hash_including(:url => @url, :method => :get)).and_return(double('response', :code => 200))
       @api_caller.call(self)
     end
 
-    it "adds any :request_options to the api call" do
-      RestClient.should_receive(:get).with(@url, :foo => :bar).and_return(double('response', :code => 200))
-      @api_caller.options[:request_options] = { :foo => :bar }
+    it "adds any :headers to the api call" do
+      RestClient::Request.should_receive(:execute).with(hash_including(:headers => { :x_localeapp_gem_version => Localeapp::VERSION, :foo => :bar })).and_return(double('response', :code => 200))
+      @api_caller.options[:headers] = { :foo => :bar }
       @api_caller.call(self)
     end
   end
@@ -50,13 +101,13 @@ describe Localeapp::ApiCaller, "#call(object)" do
     end
 
     it "makes the call to the api using :payload as the payload" do
-      RestClient.should_receive(:post).with(@url, "test data", {}).and_return(double('response', :code => 200))
+      RestClient::Request.should_receive(:execute).with(hash_including(:url => @url, :payload => "test data", :method => :post)).and_return(double('response', :code => 200))
       @api_caller.call(self)
     end
 
-    it "adds any :request_options to the api call" do
-      RestClient.should_receive(:post).with(@url, "test data", :foo => :bar).and_return(double('response', :code => 200))
-      @api_caller.options[:request_options] = { :foo => :bar }
+    it "adds any :headers to the api call" do
+      RestClient::Request.should_receive(:execute).with(hash_including(:headers => { :x_localeapp_gem_version => Localeapp::VERSION, :foo => :bar })).and_return(double('response', :code => 200))
+      @api_caller.options[:headers] = { :foo => :bar }
       @api_caller.call(self)
     end
   end

data/spec/localeapp/cli/add_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Localeapp::CLI::Add, "#execute(key, *translations)" do
+  def do_action(key = 'test.key', args = nil)
+    args ||= ['en:test en', 'es:test es']
+    @command.execute(key, *args)
+  end
+
+  before(:each) do
+    @output = StringIO.new
+    @command = Localeapp::CLI::Add.new(@output)
+  end
+
+  it "adds the translations to missing_translations" do
+    with_configuration do
+      Localeapp.sender.stub!(:post_missing_translations)
+      do_action
+    end
+    en_missing = Localeapp.missing_translations['en']
+    en_missing.size.should == 1
+    en_missing['test.key'].locale.should == 'en'
+    en_missing['test.key'].description.should == 'test en'
+    es_missing = Localeapp.missing_translations['es']
+    es_missing.size.should == 1
+    es_missing['test.key'].locale.should == 'es'
+    es_missing['test.key'].description.should == 'test es'
+  end
+
+  it "ignores badly formed arguments" do
+    with_configuration do
+      Localeapp.sender.stub!(:post_missing_translations)
+      do_action('test.key', ["en:this is fine", "esbad"])
+    end
+    Localeapp.missing_translations['en'].size.should == 1
+    Localeapp.missing_translations['es'].size.should == 0
+    Localeapp.missing_translations['esbad'].size.should == 0
+    @output.string.should include("Ignoring bad translation esbad")
+    @output.string.should include("format should be <locale>:<translation content>")
+  end
+
+  it "tells the sender to send the missing translations" do
+    with_configuration do
+      Localeapp.sender.should_receive(:post_missing_translations)
+      do_action
+    end
+  end
+end

data/spec/localeapp/configuration_spec.rb

@@ -11,6 +11,38 @@ describe Localeapp::Configuration do
     expect { configuration.host = 'test.host' }.to change(configuration, :host).to('test.host')
   end
 
+  it "sets proxy to nil by default" do
+    configuration.proxy.should == nil
+  end
+
+  it "allows proxy setting to be overridden" do
+    expect { configuration.proxy = 'http://localhost:8888' }.to change(configuration, :proxy).to('http://localhost:8888')
+  end
+
+  it "sets secure to true by default" do
+    configuration.secure.should == true
+  end
+
+  it "allows secure setting to be overridden" do
+    expect { configuration.secure = false }.to change(configuration, :secure).to(false)
+  end
+
+  it "sets ssl_verify to false by default" do
+    configuration.ssl_verify.should == false
+  end
+
+  it "allows ssl_verify setting to be overridden" do
+    expect { configuration.ssl_verify = true }.to change(configuration, :ssl_verify).to(true)
+  end
+
+  it "sets ssl_ca_file to nil by default" do
+    configuration.ssl_ca_file.should == nil
+  end
+
+  it "allows ssl_ca_file setting to be overridden" do
+    expect { configuration.ssl_ca_file = '/foo/bar' }.to change(configuration, :ssl_ca_file).to('/foo/bar')
+  end
+
   it "includes http_auth_username defaulting to nil" do
     configuration.http_auth_username.should == nil
     configuration.http_auth_username = "test"

data/spec/localeapp/exception_handler_spec.rb

@@ -9,13 +9,13 @@ describe Localeapp::ExceptionHandler, '#call(exception, locale, key, options)' d
   end
 
   it "adds the missing translation to the missing translation list" do
-    Localeapp.missing_translations.should_receive(:add).with(:en, 'foo', { :baz => 'bam' })
+    Localeapp.missing_translations.should_receive(:add).with(:en, 'foo', nil, { :baz => 'bam' })
     I18n.t('foo', :baz => 'bam')
   end
 
   it "handles when the key is an array of keys" do
-    Localeapp.missing_translations.should_receive(:add).with(:en, 'foo', {})
-    Localeapp.missing_translations.should_receive(:add).with(:en, 'bar', {})
+    Localeapp.missing_translations.should_receive(:add).with(:en, 'foo', nil, {})
+    Localeapp.missing_translations.should_receive(:add).with(:en, 'bar', nil, {})
     I18n.t(['foo', 'bar'])
   end
 

data/spec/localeapp/key_checker_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Localeapp::KeyChecker, "#check(key)" do
   it "returns false and an empty hash if the response from locale app is a 404" do
-    FakeWeb.register_uri(:get, 'http://api.localeapp.com/v1/projects/TEST_KEY.json', :body => "", :status => ['404', 'Not Found'])
+    FakeWeb.register_uri(:get, 'https://api.localeapp.com/v1/projects/TEST_KEY.json', :body => "", :status => ['404', 'Not Found'])
     with_configuration do
       @checker = Localeapp::KeyChecker.new
     end
@@ -10,7 +10,7 @@ describe Localeapp::KeyChecker, "#check(key)" do
   end
 
   it "returns true and and the parsed json hash if the response from locale app is a 200" do
-    FakeWeb.register_uri(:get, 'http://api.localeapp.com/v1/projects/TEST_KEY.json', :body => valid_project_data.to_json, :status => ['200', 'OK'])
+    FakeWeb.register_uri(:get, 'https://api.localeapp.com/v1/projects/TEST_KEY.json', :body => valid_project_data.to_json, :status => ['200', 'OK'])
     with_configuration do
       @checker = Localeapp::KeyChecker.new
     end

data/spec/localeapp/missing_translations_spec.rb

@@ -1,11 +1,12 @@
 require 'spec_helper'
 require 'localeapp/missing_translations'
 
-describe Localeapp::MissingTranslations, "#add(locale, key, options = {})" do
+describe Localeapp::MissingTranslations, "#add(locale, key, description = nil, options = {})" do
   it "stores the missing translation data" do
     translations = Localeapp::MissingTranslations.new
-    translations.add(:en, 'foo', { :baz => 'bam' })
+    translations.add(:en, 'foo', 'bar', { :baz => 'bam' })
     translations[:en].should include('foo')
+    translations[:en]['foo'].description.should == 'bar'
     translations[:en]['foo'].options.should == { :baz => 'bam' }
   end
 end
@@ -13,16 +14,18 @@ end
 describe Localeapp::MissingTranslations, "#to_send" do
   it "returns an array of missing translation data that needs to be sent to localeapp.com" do
     translations = Localeapp::MissingTranslations.new
-    translations.add(:en, 'foo', { :baz => 'bam' })
-    translations.add(:es, 'bar')
+    translations.add(:en, 'foo', nil, { :baz => 'bam' })
+    translations.add(:es, 'bar', 'baz')
 
     to_send = translations.to_send
     to_send.size.should == 2
     to_send[0][:key].should == 'foo'
     to_send[0][:locale].should == :en
+    to_send[0].should_not have_key(:description)
     to_send[0][:options].should == { :baz => 'bam' }
     to_send[1][:key].should == 'bar'
     to_send[1][:locale].should == :es
+    to_send[1][:description].should == 'baz'
     to_send[1][:options].should == {}
   end
 end

data/spec/localeapp/poller_spec.rb

@@ -38,22 +38,22 @@ describe Localeapp::Poller do
     
   describe "#poll!" do
     it "returns false if get returns 304 Not Modified" do
-      FakeWeb.register_uri(:get, "http://api.localeapp.com/v1/projects/TEST_KEY/translations.json?updated_at=#{@updated_at}", :body => '', :status => ['304', 'Not Modified'])
+      FakeWeb.register_uri(:get, "https://api.localeapp.com/v1/projects/TEST_KEY/translations.json?updated_at=#{@updated_at}", :body => '', :status => ['304', 'Not Modified'])
       @poller.poll!.should == false
     end
 
     it "returns false if get returns a 50x response" do
-      FakeWeb.register_uri(:get, "http://api.localeapp.com/v1/projects/TEST_KEY/translations.json?updated_at=#{@updated_at}", :body => '', :status => ['500', 'Internal Server Error'])
+      FakeWeb.register_uri(:get, "https://api.localeapp.com/v1/projects/TEST_KEY/translations.json?updated_at=#{@updated_at}", :body => '', :status => ['500', 'Internal Server Error'])
       @poller.poll!.should == false
     end
 
     it "returns false if get returns 200 OK" do
-      FakeWeb.register_uri(:get, "http://api.localeapp.com/v1/projects/TEST_KEY/translations.json?updated_at=#{@updated_at}", :body => @hash.to_json, :status => ['200', 'OK'], :date => Time.now.httpdate)
+      FakeWeb.register_uri(:get, "https://api.localeapp.com/v1/projects/TEST_KEY/translations.json?updated_at=#{@updated_at}", :body => @hash.to_json, :status => ['200', 'OK'], :date => Time.now.httpdate)
       @poller.poll!.should == true
     end
 
     it "passes the data through to the Updater" do
-      FakeWeb.register_uri(:get, "http://api.localeapp.com/v1/projects/TEST_KEY/translations.json?updated_at=#{@updated_at}", :body => @hash.to_json, :status => ['200', 'OK'], :date => Time.now.httpdate)
+      FakeWeb.register_uri(:get, "https://api.localeapp.com/v1/projects/TEST_KEY/translations.json?updated_at=#{@updated_at}", :body => @hash.to_json, :status => ['200', 'OK'], :date => Time.now.httpdate)
       Localeapp.updater.should_receive(:update).with(@hash)
       @poller.poll!
     end

data/spec/localeapp/routes_spec.rb

@@ -21,21 +21,21 @@ describe Localeapp::Routes do
   end
 
   describe '#project_url' do
-    it "is constructed from the configuration host and port and defaults to json" do
-      with_configuration(@config.merge(:port => 1234)) do
+    it "is constructed from the configuration host, port and secure and defaults to json" do
+      with_configuration(@config.merge(:port => 1234, :secure => false)) do
         @routes.project_url.should == "http://test.host:1234/v1/projects/API_KEY.json"
       end
     end
 
     it "includes http auth if in configuration" do
       with_configuration(@config.merge(:port => 1234, :http_auth_username => 'foo', :http_auth_password => 'bar')) do
-        @routes.project_url.should == "http://foo:bar@test.host:1234/v1/projects/API_KEY.json"
+        @routes.project_url.should == "https://foo:bar@test.host:1234/v1/projects/API_KEY.json"
       end
     end
 
     it "can be changed to another content type" do
       with_configuration(@config) do
-        @routes.project_url(:format => :yml).should == 'http://test.host/v1/projects/API_KEY.yml'
+        @routes.project_url(:format => :yml).should == 'https://test.host/v1/projects/API_KEY.yml'
       end
     end
   end
@@ -43,7 +43,7 @@ describe Localeapp::Routes do
   describe "#translations_url" do
     it "it extends the project_url and defaults to json" do
       with_configuration(@config) do
-        @routes.translations_url.should == "http://test.host/v1/projects/API_KEY/translations.json"
+        @routes.translations_url.should == "https://test.host/v1/projects/API_KEY/translations.json"
       end
     end
 
@@ -57,7 +57,7 @@ describe Localeapp::Routes do
 
     it "can be changed to another content type" do
       with_configuration(@config) do
-        @routes.translations_url(:format => :yml).should == 'http://test.host/v1/projects/API_KEY/translations.yml'
+        @routes.translations_url(:format => :yml).should == 'https://test.host/v1/projects/API_KEY/translations.yml'
       end
     end
   end
@@ -95,7 +95,7 @@ describe Localeapp::Routes do
   describe "#missing_translations_url" do
     it "it extends the project_url and defaults to json" do
       with_configuration(@config) do
-        @routes.missing_translations_url.should == "http://test.host/v1/projects/API_KEY/translations/missing.json"
+        @routes.missing_translations_url.should == "https://test.host/v1/projects/API_KEY/translations/missing.json"
       end
     end
 
@@ -109,7 +109,7 @@ describe Localeapp::Routes do
 
     it "can be changed to another content type" do
       with_configuration(@config) do
-        @routes.missing_translations_url(:format => :yml).should == 'http://test.host/v1/projects/API_KEY/translations/missing.yml'
+        @routes.missing_translations_url(:format => :yml).should == 'https://test.host/v1/projects/API_KEY/translations/missing.yml'
       end
     end
   end
@@ -117,7 +117,7 @@ describe Localeapp::Routes do
   describe "#import_url" do
     it "appends 'import to the project url" do
       with_configuration(@config) do
-        @routes.import_url.should == 'http://test.host/v1/projects/API_KEY/import/'
+        @routes.import_url.should == 'https://test.host/v1/projects/API_KEY/import/'
       end
     end
   end

data/spec/localeapp/sender_spec.rb

@@ -17,7 +17,13 @@ describe Localeapp::Sender, "#post_translation(locale, key, options, value = nil
       }
     }
     # have to stub RestClient here as FakeWeb doesn't support looking at the post body yet
-    RestClient.should_receive(:post).with(@sender.translations_url, data.to_json, :content_type => :json).and_return(double('response', :code => 200))
+    RestClient::Request.should_receive(:execute).with(hash_including(
+      :url => @sender.translations_url,
+      :payload => data.to_json,
+      :headers => {
+        :x_localeapp_gem_version => Localeapp::VERSION,
+        :content_type => :json },
+      :method => :post)).and_return(double('response', :code => 200))
     @sender.post_translation('en', 'test.key', { 'foo' => 'foo', 'bar' => 'bar' }, 'test content')
   end
 end
@@ -37,7 +43,13 @@ describe Localeapp::Sender, "#post_missing_translations" do
     Localeapp.missing_translations.should_receive(:to_send).and_return(missing_to_send)
     data = { :translations => missing_to_send }
     # have to stub RestClient here as FakeWeb doesn't support looking at the post body yet
-    RestClient.should_receive(:post).with(@sender.missing_translations_url, data.to_json, :content_type => :json).and_return(double('response', :code => 200))
+    RestClient::Request.should_receive(:execute).with(hash_including(
+      :url => @sender.missing_translations_url,
+      :payload => data.to_json,
+      :headers => {
+        :x_localeapp_gem_version => Localeapp::VERSION,
+        :content_type => :json },
+      :method => :post)).and_return(double('response', :code => 200))
     @sender.post_missing_translations
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: localeapp
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Christopher Dell
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-07 00:00:00 Z
+date: 2011-11-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: i18n
@@ -75,7 +75,7 @@ dependencies:
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: slop
+  name: gli
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -142,12 +142,12 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 57
+        hash: 39
         segments: 
         - 4
         - 2
-        - 7
-        version: 4.2.7
+        - 8
+        version: 4.2.8
   type: :development
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
@@ -215,6 +215,7 @@ files:
 - lib/localeapp.rb
 - lib/localeapp/api_call.rb
 - lib/localeapp/api_caller.rb
+- lib/localeapp/cli/add.rb
 - lib/localeapp/cli/install.rb
 - lib/localeapp/cli/pull.rb
 - lib/localeapp/cli/push.rb
@@ -240,6 +241,7 @@ files:
 - spec/fixtures/es.yml
 - spec/localeapp/api_call_spec.rb
 - spec/localeapp/api_caller_spec.rb
+- spec/localeapp/cli/add_spec.rb
 - spec/localeapp/cli/install_spec.rb
 - spec/localeapp/cli/pull_spec.rb
 - spec/localeapp/cli/push_spec.rb
@@ -286,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: localeapp
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Add missing translation keys to localeapp.com
@@ -299,6 +301,7 @@ test_files:
 - spec/fixtures/es.yml
 - spec/localeapp/api_call_spec.rb
 - spec/localeapp/api_caller_spec.rb
+- spec/localeapp/cli/add_spec.rb
 - spec/localeapp/cli/install_spec.rb
 - spec/localeapp/cli/pull_spec.rb
 - spec/localeapp/cli/push_spec.rb