shove 1.0.4 → 1.0.5

data/README.markdown

@@ -58,6 +58,7 @@ end
 Apps, channels, and clients can be controlled from the HTTP API
 
 Grant a connection to dan@shove.io
+
 ```ruby
 Shove.grant_connect("dan@shove.io") do |response|
   # handle response
@@ -226,6 +227,27 @@ channel.publish("hi!")
 channel.publish(obj.to_json)
 ```
 
+Channel Keys
+------------
+You can generate channel keys which allow clients of
+your shove network to publish and subscribe to specific
+channels.
+
+Example: Create a key for the channel groups:788
+
+```ruby
+key = Shove.channel_key "group:788"
+```
+
+If it's for a particular App, use:
+
+```ruby
+key = app.channel_key "group:788"
+```
+
+Note: if you don't have the app key speficied for the app, the
+channel key generated will not be correct.
+
 Using the Command Line
 ----------------------
 

data/lib/shove/app.rb

@@ -69,6 +69,13 @@ module Shove
       Http::Request.new("#{url}/#{path}", @config)
     end
 
+    # Generate a channel key for a client to self authorize
+    # publish and subscribe actions.
+    # +channel+ the name of the channel
+    def channel_key channel
+      Digest::SHA1.hexdigest "#{@config.app_key}-#{channel}"
+    end
+
     ####
 
     # Connect to shove as a client in the current process

data/lib/shove.rb

@@ -18,7 +18,7 @@ require "digest/sha1"
 # See https://github.com/shove/shove for client documentation
 module Shove
   
-  Version = "1.0.4"
+  Version = "1.0.5"
   
   class ShoveException < Exception; end
   
@@ -83,15 +83,10 @@ module Shove
 
     # Create a channel key
     # +channel+ the name of the channel
-    def channel_key channel, key=nil
-      if key.nil?
-        key = @config.app_key
-      end
-      digest = Digest::SHA1.hexdigest "#{key}-#{channel}"
+    def channel_key channel
+      @app.channel_key channel
     end
 
-
-
   end
 end
 

data/shove.gemspec

@@ -1,6 +1,9 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "shove"
+
 spec = Gem::Specification.new do |s|
   s.name = "shove"
-  s.version = "1.0.4"
+  s.version = Shove::Version
   s.date = "2012-02-08"
   s.summary = "Ruby gem for leveraging shove.io, the web push platform"
   s.email = "dan@shove.io"

data/spec/shove_client_spec.rb

@@ -192,8 +192,8 @@ describe Shove::Client do
   end
 
   it "should generate a channel key" do
-    key = Shove.channel_key "money", "key"
-    key.should == "e627e0e305c60b6ccb164f8baafdbc8d84f0d032"
+    key = Shove.channel_key "money"
+    key.should == "6f78f2ba414a482fc5c45eb080d8877ddf1fc6ba"
   end
 
   it "should authorize on a channel" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shove
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70199512602620 !ruby/object:Gem::Requirement
+  requirement: &70156622099200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70199512602620
+  version_requirements: *70156622099200
 - !ruby/object:Gem::Dependency
   name: em-ws-client
-  requirement: &70199512546900 !ruby/object:Gem::Requirement
+  requirement: &70156622110300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70199512546900
+  version_requirements: *70156622110300
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70199508320220 !ruby/object:Gem::Requirement
+  requirement: &70156622116560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70199508320220
+  version_requirements: *70156622116560
 - !ruby/object:Gem::Dependency
   name: confstruct
-  requirement: &70199508298620 !ruby/object:Gem::Requirement
+  requirement: &70156622111420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70199508298620
+  version_requirements: *70156622111420
 description: Client side implementation for the shove.io API.  See http://shove.io/documentation
 email: dan@shove.io
 executables: