copycopter_client 1.0.0.beta9 → 1.0.0.beta10

data/README.md

@@ -0,0 +1,81 @@
+Copycopter Client
+=================
+
+This is the client gem for integrating apps with "Copycopter":http://copycopter.com.
+
+The client integrates with the I18n gem so that you can access copy text and translations from a Copycopter project.
+
+Installation
+------------
+
+Just install the gem:
+
+    gem install copycopter_client
+
+### Rails 3
+
+Add the following line to your `Gemfile`:
+
+    gem "copycopter_client"
+
+Then run `bundle install`.
+
+### Rails 2
+
+Add the following line to your `config/environment.rb`:
+
+    config.gem 'copycopter_client'
+
+Then run `rake gems:install`. We also recommend vendoring the gem by running `rake gems:unpack:dependencies GEM=copycopter_client`.
+
+### Configuration
+
+Add the following to your application:
+
+    CopycopterClient.configure do |config|
+      config.api_key = "YOUR API KEY HERE"
+    end
+
+In a Rails application, this should be saved as `config/initializers/copycopter.rb`. You can find the API key on the project page on the Copycopter website. See the CopycopterClient::Configuration class for a full list of configuration options.
+
+Usage
+-----
+
+You can access blurbs from Copycopter by using `I18n.translate`. This is also aliased as `translate` or just `t` inside Rails controllers and views.
+
+    # In a controller
+    def index
+      flash[:success] = t("users.create.success", :default => "User created")
+    end
+
+    # In a view
+    <%= t(".welcome", :default => "Why hello there") %>
+
+    # Global scope (for example, in a Rake task)
+    I18n.translate("system.tasks_complete", :default => "Tasks complete")
+
+    # Interpolation
+    I18n.translate("mailer.welcome", :default => "Welcome, %{name}!", :name => @user.name)
+
+See the [I18n documentation](http://rdoc.info/github/svenfuchs/i18n/master/file/README.textile) documentation for more examples.
+
+Deploys
+-------
+
+Blurbs start out as draft copy, and won't be displayed in production environments until they're published. If you want to publish all draft copy when deploying to production, you can use the `copycopter:deploy` rake task:
+
+    rake copycopter:deploy
+
+Credits
+-------
+
+![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+
+Copycopter Client is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
+
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+License
+-------
+
+Copycopter Client is Copyright © 2010-2011 thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/features/step_definitions/rails_steps.rb

@@ -24,6 +24,7 @@ When /^I configure the copycopter client with api key "([^"]*)"$/ do |api_key|
       config.api_key = "#{api_key}"
       config.polling_delay = 1
       config.host = 'localhost'
+      config.secure = false
       config.port = #{FakeCopycopterApp.port}
     end
   RUBY

data/lib/copycopter_client/client.rb

@@ -23,9 +23,10 @@ module CopycopterClient
     # @option options [Fixnum] :http_open_timeout how long to wait before timing out when opening the socket
     # @option options [Boolean] :secure whether to use SSL
     # @option options [Logger] :logger where to log transactions
+    # @option options [String] :ca_file path to root certificate file for ssl verification
     def initialize(options)
       [:api_key, :host, :port, :public, :http_read_timeout,
-        :http_open_timeout, :secure, :logger].each do |option|
+        :http_open_timeout, :secure, :logger, :ca_file].each do |option|
         instance_variable_set("@#{option}", options[option])
       end
     end
@@ -79,7 +80,7 @@ module CopycopterClient
     private
 
     attr_reader :host, :port, :api_key, :http_read_timeout,
-      :http_open_timeout, :secure, :logger
+      :http_open_timeout, :secure, :logger, :ca_file
 
     def public?
       @public
@@ -102,6 +103,8 @@ module CopycopterClient
       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
       begin
         yield(http)
       rescue *HTTP_ERRORS => exception

data/lib/copycopter_client/configuration.rb

@@ -14,7 +14,10 @@ module CopycopterClient
         :http_open_timeout, :http_read_timeout, :client_name, :client_url,
         :client_version, :port, :protocol, :proxy_host, :proxy_pass,
         :proxy_port, :proxy_user, :secure, :polling_delay, :logger,
-        :framework, :middleware].freeze
+        :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
@@ -76,11 +79,14 @@ module CopycopterClient
     # @return the middleware stack, if any, which should respond to +use+
     attr_accessor :middleware
 
+    # @return [String] the path to a root certificate file used to verify ssl sessions. Default's to the root certificate file for copycopter.com.
+    attr_accessor :ca_file
+
     alias_method :secure?, :secure
 
     # Instantiated from {CopycopterClient.configure}. Sets defaults.
     def initialize
-      self.secure                   = false
+      self.secure                   = true
       self.host                     = 'copycopter.com'
       self.http_open_timeout        = 2
       self.http_read_timeout        = 5
@@ -91,6 +97,7 @@ module CopycopterClient
       self.client_url               = 'http://copycopter.com'
       self.polling_delay            = 300
       self.logger                   = Logger.new($stdout)
+      self.ca_file                  = CA_FILE
 
       @applied = false
     end

data/lib/copycopter_client/version.rb

@@ -1,6 +1,6 @@
 module CopycopterClient
   # Client version
-  VERSION = "1.0.0.beta9"
+  VERSION = "1.0.0.beta10"
 
   # API version being used to communicate with the server
   API_VERSION = "2.0"

data/spec/copycopter_client/client_spec.rb

@@ -40,11 +40,13 @@ describe CopycopterClient do
       http.read_timeout.should == 4
     end
 
-    it "uses ssl when secure" do
+    it "uses verified ssl when secure" do
       project = add_project
       client = build_client(:api_key => project.api_key, :secure => true)
       client.download { |ignore| }
       http.use_ssl.should == true
+      http.verify_mode.should == OpenSSL::SSL::VERIFY_PEER
+      http.ca_file.should == CopycopterClient::Configuration::CA_FILE
     end
 
     it "doesn't use ssl when insecure" do

data/spec/copycopter_client/configuration_spec.rb

@@ -33,7 +33,7 @@ describe CopycopterClient::Configuration do
   it { should have_config_option(:client_version).          overridable.default(CopycopterClient::VERSION) }
   it { should have_config_option(:client_name).             overridable.default('Copycopter Client') }
   it { should have_config_option(:client_url).              overridable.default('http://copycopter.com') }
-  it { should have_config_option(:secure).                  overridable.default(false) }
+  it { should have_config_option(:secure).                  overridable.default(true) }
   it { should have_config_option(:host).                    overridable.default('copycopter.com') }
   it { should have_config_option(:http_open_timeout).       overridable.default(2) }
   it { should have_config_option(:http_read_timeout).       overridable.default(5) }
@@ -44,6 +44,12 @@ describe CopycopterClient::Configuration do
   it { should have_config_option(:framework).               overridable }
   it { should have_config_option(:middleware).              overridable }
 
+  it "provides the root ssl certificate" do
+    should have_config_option(:ca_file).
+      overridable.
+      default(File.join(PROJECT_ROOT, "AddTrustExternalCARoot.crt"))
+  end
+
   it "should provide default values for secure connections" do
     config = CopycopterClient::Configuration.new
     config.secure = true
@@ -72,7 +78,7 @@ describe CopycopterClient::Configuration do
     [:api_key, :environment_name, :host, :http_open_timeout,
       :http_read_timeout, :client_name, :client_url, :client_version, :port,
       :protocol, :proxy_host, :proxy_pass, :proxy_port, :proxy_user, :secure,
-      :development_environments, :logger, :framework].each do |option|
+      :development_environments, :logger, :framework, :ca_file].each do |option|
       hash[option].should == config[option]
     end
     hash[:public].should == config.public?

data/spec/spec_helper.rb

@@ -16,7 +16,7 @@ Dir.glob(File.join(PROJECT_ROOT, "spec", "support", "**", "*.rb")).each do |file
 end
 
 WebMock.disable_net_connect!
-ShamRack.mount(FakeCopycopterApp.new, "copycopter.com")
+ShamRack.mount(FakeCopycopterApp.new, "copycopter.com", 443)
 
 Spec::Runner.configure do |config|
   config.include ClientSpecHelpers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: copycopter_client
 version: !ruby/object:Gem::Version 
-  hash: 299253589
+  hash: 180128174
   prerelease: true
   segments: 
   - 1
   - 0
   - 0
-  - beta9
-  version: 1.0.0.beta9
+  - beta10
+  version: 1.0.0.beta10
 platform: ruby
 authors: 
 - thoughtbot
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-04 00:00:00 -04:00
+date: 2011-01-31 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,9 +55,10 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.textile
+extra_rdoc_files: []
+
 files: 
+- README.md
 - MIT-LICENSE
 - Rakefile
 - init.rb
@@ -98,15 +99,13 @@ files:
 - features/step_definitions/rails_steps.rb
 - features/support/env.rb
 - features/support/rails_server.rb
-- README.textile
 has_rdoc: true
 homepage: http://github.com/thoughtbot/copycopter_client
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --main
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/README.textile

@@ -1,71 +0,0 @@
-h1. Copycopter Client
-
-This is the client gem for integrating apps with "Copycopter":http://copycopter.com.
-
-The client integrates with the I18n gem so that you can access copy text and translations from a Copycopter project.
-
-h2. Installation
-
-Just install the gem:
-
-<pre>gem install copycopter_client</pre>
-
-h3. Rails 3
-
-Add the following line to your <code>Gemfile</code>:
-
-<pre>gem "copycopter_client"</pre>
-
-Then run <code>bundle install</code>.
-
-h3. Rails 2
-
-Add the following line to your <code>config/environment.rb</code>:
-
-<pre>config.gem 'copycopter_client'</pre>
-
-Then run <code>rake gems:install</code>. We also recommend vendoring the gem by running <code>rake gems:unpack:dependencies GEM=copycopter_client</code>.
-
-h2. Configuration
-
-Add the following to your application:
-
-<pre>
-CopycopterClient.configure do |config|
-  config.api_key = "YOUR API KEY HERE"
-end
-</pre>
-
-In a Rails application, this should be saved as <code>config/initializers/copycopter.rb</code>. You can find the API key on the project page on the Copycopter website. See the {CopycopterClient::Configuration} class for a full list of configuration options.
-
-h2. Usage
-
-You can access blurbs from Copycopter by using <code>I18n.translate</code>. This is also aliased as <code>translate</code> or just <code>t</code> inside Rails controllers and views.
-
-<pre>
-# In a controller
-def index
-  flash[:success] = t("users.create.success", :default => "User created")
-end
-
-# In a view
-<%= t(".welcome", :default => "Why hello there") %>
-
-# Global scope (for example, in a Rake task)
-I18n.translate("system.tasks_complete", :default => "Tasks complete")
-
-# Interpolation
-I18n.translate("mailer.welcome", :default => "Welcome, %{name}!", :name => @user.name)
-</pre>
-
-See the "I18n documentation":http://rdoc.info/github/svenfuchs/i18n/master/file/README.textile documentation for more examples.
-
-h2. Deploys
-
-Blurbs start out as draft copy, and won't be displayed in production environments until they're published. If you want to publish all draft copy when deploying to production, you can use the <code>copycopter:deploy</code> rake task:
-
-<pre>rake copycopter:deploy</pre>
-
-h2. About
-
-Copyright (c) 2010 "thoughtbot, inc.":http://thoughtbot.com, released under the MIT license