private_pub 1.0.1 → 1.0.2

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## 1.0.0 (January 25, 2012)
+## 1.0.2 (August 20, 2012)
+
+* added HTTPS support (thanks vanne)
+
+
+## 1.0.1 (January 25, 2012)
 
 * Rails 3.2 compatibility with SecureRandom fix (thanks windigo) - issue #26
 

data/README.md

@@ -39,6 +39,29 @@ rackup private_pub.ru -s thin -E production
 
 It's not necessary to include faye.js since that will be handled automatically for you.
 
+## Serving Faye over HTTPS (with Thin)
+
+To server Faye over HTTPS you could create a thin configuration file `config/private_pub_thin.yml` similar to the following:
+
+```yaml
+---
+port: 4443
+ssl: true
+ssl_key_file: /path/to/server.pem
+ssl_cert_file: /path/to/certificate_chain.pem
+environment: production
+rackup: private_pub.ru
+```
+
+The `certificate_chain.pem` file should contain your signed certificate, followed by intermediate certificates (if any) and the root certificate of the CA that signed the key.
+
+Next reconfigure the URL in `config/private_pub.yml` to look like `https://your.hostname.com:4443/faye`
+
+Finally start up Thin from the project root.
+
+```
+thin -C config/private_pub_thin.yml start
+```
 
 ## Usage
 
@@ -107,6 +130,11 @@ The signature and timestamp checked on the Faye server to ensure users are only
 The `publish_to` method will send a post request to the Faye server (using `Net::HTTP`) instructing it to send the given data back to the browser.
 
 
+##  Project Status
+
+Unfortunately I have not had time to actively work on this project recently. If you find a critical issue where it does not work as documented please [ping me on Twitter](http://twitter.com/rbates) and I'll take a look.
+
+
 ## Development & Feedback
 
 Questions or comments? Please use the [issue tracker](https://github.com/ryanb/private_pub/issues). Tests can be run with `bundle` and `rake` commands.

data/lib/private_pub.rb

@@ -31,7 +31,14 @@ module PrivatePub
     # Sends the given message hash to the Faye server using Net::HTTP.
     def publish_message(message)
       raise Error, "No server specified, ensure private_pub.yml was loaded properly." unless config[:server]
-      Net::HTTP.post_form(URI.parse(config[:server]), :message => message.to_json)
+      url = URI.parse(config[:server])
+
+      form = Net::HTTP::Post.new(url.path.empty? ? '/' : url.path)
+      form.set_form_data(:message => message.to_json)
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = url.scheme == "https"
+      http.start {|h| h.request(form)}
     end
 
     # Returns a message hash for sending to Faye

data/spec/private_pub_spec.rb

@@ -72,11 +72,40 @@ describe PrivatePub do
 
   it "publish message as json to server using Net::HTTP" do
     PrivatePub.config[:server] = "http://localhost"
-    message = stub(:to_json => "message_json")
-    Net::HTTP.should_receive(:post_form).with(URI.parse("http://localhost"), :message => "message_json").and_return(:result)
+    message = 'foo'
+    form = mock(:post).as_null_object
+    http = mock(:http).as_null_object
+
+    Net::HTTP::Post.should_receive(:new).with('/').and_return(form)
+    form.should_receive(:set_form_data).with(message: 'foo'.to_json)
+
+    Net::HTTP.should_receive(:new).with('localhost', 80).and_return(http)
+    http.should_receive(:start).and_yield(http)
+    http.should_receive(:request).with(form).and_return(:result)
+
     PrivatePub.publish_message(message).should eq(:result)
   end
 
+  it "it should use HTTPS if the server URL says so" do
+    PrivatePub.config[:server] = "https://localhost"
+    http = mock(:http).as_null_object
+
+    Net::HTTP.should_receive(:new).and_return(http)
+    http.should_receive(:use_ssl=).with(true)
+
+    PrivatePub.publish_message('foo')
+  end
+
+  it "it should not use HTTPS if the server URL says not to" do
+    PrivatePub.config[:server] = "http://localhost"
+    http = mock(:http).as_null_object
+
+    Net::HTTP.should_receive(:new).and_return(http)
+    http.should_receive(:use_ssl=).with(false)
+
+    PrivatePub.publish_message('foo')
+  end
+
   it "raises an exception if no server is specified when calling publish_message" do
     lambda {
       PrivatePub.publish_message("foo")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: private_pub
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-26 00:00:00.000000000Z
+date: 2012-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye
-  requirement: &2152830800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152830800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152830360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152830360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152859540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *2152859540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: jasmine
-  requirement: &2152859040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: 1.1.1
   type: :development
   prerelease: false
-  version_requirements: *2152859040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 description: Private pub/sub messaging in Rails through Faye.
 email: ryan@railscasts.com
 executables: []
@@ -102,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.4
 requirements: []
 rubyforge_project: private_pub
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Private pub/sub messaging in Rails.