shove 1.0.5 → 1.0.7

data/Gemfile

@@ -9,9 +9,12 @@ end
 
 group :test do
   gem "rspec"
-  gem "vcr", "2.0.0.rc1"
+  gem "vcr", "2.0.1"
   gem "webmock"
   gem "net-http-spy"
 end
 
-gemspec
+gem "em-http-request", ">= 1.0.0"
+gem "em-ws-client", ">= 0.2.0"
+gem "yajl-ruby", ">= 1.1.0"
+gem "confstruct", ">= 0.2.1"

data/Gemfile.lock

@@ -1,12 +1,3 @@
-PATH
-  remote: .
-  specs:
-    shove (1.0.4)
-      confstruct (>= 0.2.1)
-      em-http-request (>= 1.0.0)
-      em-ws-client (>= 0.1.2)
-      yajl-ruby (>= 1.1.0)
-
 GEM
   remote: http://rubygems.org/
   specs:
@@ -25,9 +16,8 @@ GEM
       http_parser.rb (>= 0.5.3)
     em-socksify (0.2.0)
       eventmachine (>= 1.0.0.beta.4)
-    em-ws-client (0.1.2)
+    em-ws-client (0.2.0)
       eventmachine (~> 1.0.0.beta.4)
-      state_machine (~> 1.0.2)
     eventmachine (1.0.0.beta.4)
     http_parser.rb (0.5.3)
     net-http-spy (0.2.1)
@@ -42,8 +32,7 @@ GEM
     rspec-expectations (2.9.1)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.9.0)
-    state_machine (1.0.3)
-    vcr (2.0.0.rc1)
+    vcr (2.0.1)
     webmock (1.8.6)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
@@ -54,10 +43,13 @@ PLATFORMS
 
 DEPENDENCIES
   albino
+  confstruct (>= 0.2.1)
+  em-http-request (>= 1.0.0)
+  em-ws-client (>= 0.2.0)
   net-http-spy
   rake
   redcarpet
   rspec
-  shove!
-  vcr (= 2.0.0.rc1)
+  vcr (= 2.0.1)
   webmock
+  yajl-ruby (>= 1.1.0)

data/README.markdown

@@ -2,6 +2,7 @@ shove ruby client
 =================
 Ruby client and CLI for the shove.io HTTP and WebSocket APIs
 
+<a name="installation"></a>
 Installation
 ------------
 
@@ -9,8 +10,7 @@ Installation
 gem install shove
 ```
 
-Grab your App ID and App Key from shove at [https://shove.io/apps][0]
-
+<a name="configuration"></a>
 Configuring Shove
 -----------------
 
@@ -34,96 +34,136 @@ app = Shove::App.new do
 end
 ```
 
+Grab your App ID and App Key from shove: [https://shove.io][0]
+
+<a name="http_client"></a>
 Using the HTTP Client
 ---------------------
 The HTTP client gives publishing and access control capabilities without
-a persistent WebSocket connection
+a persistent WebSocket connection.  The HTTP client does not act as a subscriber.
 
-Publish "Hello World!" to all connections on the notifications channel
+Simple Publish
 
 ```ruby
-Shove.channel("notifications").publish("Hello World!") do |response|
-  # handle response
-end
+Shove.channel("notifications").publish("Hello World!")
 ```
 
-Publish "Hey buddy" to the client with id buddy.
+Publish Direct
 
 ```ruby
-Shove.channel("direct:buddy").publish("Hey buddy") do |response|
-  # handle response
-end
+Shove.channel("direct:buddy").publish("Hey buddy")
 ```
 
-Apps, channels, and clients can be controlled from the HTTP API
-
-Grant a connection to dan@shove.io
+Publish and handle the HTTP response
 
 ```ruby
-Shove.grant_connect("dan@shove.io") do |response|
-  # handle response
+Shove.channel("notifications").publish("...") do |response|
+  if reponse.error?
+    puts "#{response.status} - #{response.error}"
+  end
 end
 ```
 
-Grant subscription on the notifications channel to client dan
+You can control access to your apps and channels, allowing for
+granular security.
+
+Grant subscription on the notifications channel
 
 ```ruby
-Shove.channel("notifications").grant_subscribe("dan") do |response|
-  # handle response
-end
+Shove.channel("notifications").grant_subscribe("dan@shove.io")
 ```
 
 Grant subscription on all channels to client dan
 
 ```ruby
-Shove.channel("*").grant_subscribe("dan@shove.io") do |response|
-  # handle response
-end
+Shove.channel("*").grant_subscribe("dan@shove.io")
 ```
 
 Grant publishing on chat:client_22733 channel to client dan
 
 ```ruby
-Shove.channel("chat:client_22733").grant_publish("dan") do |response|
-  # handle response
-end
+Shove.channel("chat:client_22733").grant_publish("dan")
 ```
 
 Deny publishing on chat:client_22733 channel to dan
 
 ```ruby
-Shove.channel("chat:client_22733").deny_publish("dan") do |response|
-  # handle response
-end
+Shove.channel("chat:client_22733").deny_publish("dan")
 ```
 
-Using the WebSocket Client
---------------------------
+Sometimes it's easier to give out an access key to a specific
+channel, which is also an option.
+
+<a name="channel_keys"></a>
+Channel Keys
+------------
+You can generate channel keys which allow clients of
+your shove network to publish and subscribe to specific
+channels.
 
-Create a WebSocket client on the default app
+Example: Create a key for the channel groups:788
 
 ```ruby
-client = Shove.app.connect
+key = Shove.channel_key "group:788"
 ```
 
-Or
+If it's for a particular App, use:
 
 ```ruby
-app = Shove::App.new do
-  app_id "myappid"
+key = app.channel_key "group:788"
+```
+
+This functionality becomes useful when you want to give
+you site users access.  A little haml for you:
+
+```haml
+:javascript
+  var channel = "#{@channel}";
+  var key = "#{@shove.channel_key(@channel)}";
+```
+
+Note: Channel keys are based off the app key.  So, in order for
+them to work, you must specify the app key:
+
+```ruby
+  Shove.configure do
+    app_key "key"
+  end
+```
+
+<a name="websocket_client"></a>
+Using the WebSocket Client
+--------------------------
+You can also use the gem to run a persistent client.  This
+requires that you are running an EventMachine reactor.
+
+```ruby
+EM.run do
+  app = Shove::App.new do
+    app_id "myapp"
+  end
+
+  app.connect
+
+  # alternatively, supply your user id
+  client = app.connect "unique_id"
 end
-client = app.connect
 ```
 
-Create a client with a custom ID
+### Authorization
+The client is treated like any other websocket
+client and must be authorized to publish and subscribe.
 
 ```ruby
-client = Shove.app.connect("unique_id")
+client.authorize "app_key"
+
+# self authorize a particular channel
+client.channel("channel").authorize "channel_key"
 ```
 
 ### Client events
 
-Handle connect event
+Connect event:
 
 ```ruby
 client.on("connect") do
@@ -131,34 +171,31 @@ client.on("connect") do
 end
 ```
 
-Handle connect denies (private app)
+Disconnect event:
 
 ```ruby
-client.on("connect_denied") do |id|
-  # Silly, but:
-  Shove.client(id).grant_connect do |response|
-    # At this point, the client should receive
-    # a connect event (through the shove app)
-  end
+client.on("disconnect") do
+  # disconnect code
 end
 ```
 
-And disconnect events
+Error event:
 
 ```ruby
-client.on("disconnect") do
+client.on("error") do |error|
+  log.error "Shove error: #{error}"
 end
 ```
 
-If there is any kind of error, log it
+Connect denied event: (don't forget to authorize)
 
 ```ruby
-client.on("error") do |error|
-  log.error "Shove error: #{error}"
+client.on("connect_denied") do |id|
+  client.authorize
 end
 ```
 
-### Clients and Channels
+### Publish and Subscribe
 
 Subscribe to a channel or get a subscribed channel
 
@@ -187,8 +224,8 @@ handle the subscribe_denied event
 
 ```ruby
 channel.on("subscribe_denied") do
-  # Silly example
-  Shove.client(client.id).grant_subscribe(channel.name)
+  channel.authorize "key"
+  channel.subscribe
 end
 ```
 
@@ -196,6 +233,7 @@ You can get the binding for a callback and cancel it
 
 ```ruby
 binding = channel.on("message") do |msg|
+  # important stuff here
 end
 
 binding.cancel
@@ -227,27 +265,6 @@ 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
 ----------------------
 
@@ -281,5 +298,5 @@ Watch all activity on a channel
 shove watch -c chan
 ```
 
-[0]: https://shove.io/apps
-[1]: http://shove.io/documentation/cli
+[0]: https://shove.io
+[1]: https://shove.io

data/lib/shove/app_directory.rb

@@ -1,4 +1,3 @@
-
 module Shove
 
   # Used for storing and accessing shove credentials

data/lib/shove/client/channel.rb

@@ -10,8 +10,9 @@ module Shove
       # +name+ The name of the channel
       def initialize name, conn
         @conn = conn
-        @name = name
+        @name = name.to_s
         @callbacks = {}
+        @subscribe_sent = false
       end
 
       # Bind a block to an event
@@ -23,6 +24,11 @@ module Shove
         end
         result = Callback.new(@callbacks[event], block)
         @callbacks[event] << result
+
+        if @name != "direct" && !@subscribe_sent
+          subscribe
+        end
+
         result
       end
       
@@ -46,6 +52,10 @@ module Shove
         when UNSUBSCRIBE_COMPLETE
           emit("unsubscribe")
           @callbacks.clear
+        when AUTHORIZE_DENIED
+          emit("authorize_denied")
+        when AUTHORIZE_COMPLETE
+          emit("authorize_complete")
         end
 
       end
@@ -59,6 +69,7 @@ module Shove
       # subscribe to the channel, by sending to the remote
       def subscribe
         @conn.send_data :opcode => SUBSCRIBE, :channel => @name
+        @subscribe_sent = true
       end
 
       # unsubscribe from the channel
@@ -68,7 +79,7 @@ module Shove
 
       # authorize pub/sub on this channel
       def authorize channel_key
-        @conn.send_data :opcode => AUTHORIZE, :channel => @name, :data => channel_key
+        @conn.send_data :opcode => AUTHORIZE, :channel => @name, :data => channel_key.to_s
       end
 
       private

data/lib/shove/client/connection.rb

@@ -39,6 +39,14 @@ module Shove
         end
 
         @socket = EM::WebSocketClient.new(url)
+
+        @socket.onclose do
+          @connected = false
+          unless @forcedc
+            reconnect
+          end
+        end
+
         @socket.onopen do
           @connected = true
           send_data :opcode => CONNECT, :data => @id
@@ -46,23 +54,17 @@ module Shove
             send_data @queue.shift
           end
         end
-        
-        @socket.onmessage do |m|
-          process Yajl::Parser.parse(m)
-        end
 
-        @socket.onclose do
-          @connected = false
-          unless @forcedc
-            reconnect
-          end
+        @socket.onmessage do |m, binary|
+          process(Yajl::Parser.parse(m))
         end
+
       end
       
       # Disconnect form the server
       def disconnect
         @forcedc = true
-        @socket.disconnect
+        @socket.unbind
       end
 
       # Bind to events for a given channel.
@@ -81,9 +83,6 @@ module Shove
       def channel name
         unless @channels.key?(name)
           @channels[name] = Channel.new(name, self)
-          if name != "direct"
-            @channels[name].subscribe
-          end
         end
         @channels[name]
       end
@@ -102,7 +101,7 @@ module Shove
       
       def send_data data
         if @connected
-          @socket.send_data(Yajl::Encoder.encode(data))
+          @socket.send_message(Yajl::Encoder.encode(data))
         else
           @queue << data
         end
@@ -157,8 +156,18 @@ module Shove
           @closing = true
           emit "disconnecting"
         when AUTHORIZE_COMPLETE
+          if @channels.key?(channel)
+            @channels[channel].process(message)
+          else
+            emit "authorize_complete"
+          end
+        when AUTHORIZE_DENIED
+          if @channels.key?(channel)
+            @channels[channel].process(message)
+          else
+            emit "authorize_denied"
+          end
         else
-          #TODO: logger
           puts "Unknown opcode"
         end
 

data/lib/shove/http/client_context.rb

@@ -13,7 +13,7 @@ module Shove
       # +message+ the message to publish
       # +block+ called on response
       def publish message, &block
-        @app.request("publish?channel=direct:#{@id}").post(message, &block)
+        @app.request("publish?channel=direct:#{@id}").post(message.to_s, &block)
       end
 
       # grant connection to client

data/lib/shove.rb

@@ -13,12 +13,12 @@ require "digest/sha1"
 ##
 # Shove
 # 
-# See http://shove.io for an account and client documentation
+# See https://shove.io for an account and client documentation
 # See https://github.com/shove/shove-ruby for gem documentation
-# See https://github.com/shove/shove for client documentation
+# See https://github.com/shove/shove for js client documentation
 module Shove
   
-  Version = "1.0.5"
+  Version = "1.0.7"
   
   class ShoveException < Exception; end
   

data/shove.gemspec

@@ -12,7 +12,7 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc = true
   
   s.add_dependency("em-http-request", ">= 1.0.0")
-  s.add_dependency("em-ws-client", ">= 0.1.2")
+  s.add_dependency("em-ws-client", ">= 0.2.0")
   s.add_dependency("yajl-ruby", ">= 1.1.0")
   s.add_dependency("confstruct", ">= 0.2.1")
   

data/spec/helper.rb

@@ -49,13 +49,17 @@ module EM
       @onopen = block
     end
 
+    def onclose &block
+      @onclose = block
+    end
+
     def onmessage &block
       @onmessage = block
       $backdoor = block
       @onopen.call # called
     end
 
-    def send_data data
+    def send_message data
       $queue << Yajl::Parser.parse(data)
     end
 

data/spec/shove_client_spec.rb

@@ -105,8 +105,10 @@ describe Shove::Client do
   it "should subscribe to a channel" do
     @client = Shove.app.connect
     @channel = @client.channel("channel")
-    @message = $queue.last
-    @message["opcode"].should == Shove::Protocol::SUBSCRIBE
+    $queue.last["opcode"].should_not == Shove::Protocol::SUBSCRIBE
+    @channel.on("message") do
+    end
+    $queue.last["opcode"].should == Shove::Protocol::SUBSCRIBE
   end
 
   it "should get a subscribe granted event" do
@@ -207,6 +209,14 @@ describe Shove::Client do
     item["data"].should == "key"
     item["channel"].should == "channel"
 
+    @triggered = false
+    @channel.on("authorize_complete") do
+      @triggered = true
+    end
+
+    backdoor :opcode => Shove::Protocol::AUTHORIZE_COMPLETE, :channel => "channel"
+
+    @triggered.should == true
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shove
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
   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: &70156622099200 !ruby/object:Gem::Requirement
+  requirement: &21823400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,21 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70156622099200
+  version_requirements: *21823400
 - !ruby/object:Gem::Dependency
   name: em-ws-client
-  requirement: &70156622110300 !ruby/object:Gem::Requirement
+  requirement: &21822160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70156622110300
+  version_requirements: *21822160
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70156622116560 !ruby/object:Gem::Requirement
+  requirement: &21820560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70156622116560
+  version_requirements: *21820560
 - !ruby/object:Gem::Dependency
   name: confstruct
-  requirement: &70156622111420 !ruby/object:Gem::Requirement
+  requirement: &21819840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70156622111420
+  version_requirements: *21819840
 description: Client side implementation for the shove.io API.  See http://shove.io/documentation
 email: dan@shove.io
 executables:
@@ -144,44 +144,4 @@ rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Ruby gem for leveraging shove.io, the web push platform
-test_files:
-- spec/app_directory_spec.rb
-- spec/cassettes/should_authorize_on_a_channel.yml
-- spec/cassettes/should_authorize_oneself.yml
-- spec/cassettes/should_be_able_to_authorize_with_the_server.yml
-- spec/cassettes/should_cancel_a_binding.yml
-- spec/cassettes/should_configure_the_default.yml
-- spec/cassettes/should_configure_the_from_the_previous_test.yml
-- spec/cassettes/should_create_a_channel_context.yml
-- spec/cassettes/should_deny_a_connection.yml
-- spec/cassettes/should_deny_a_control_to_a_client.yml
-- spec/cassettes/should_deny_a_publishing_to_a_client.yml
-- spec/cassettes/should_deny_a_subscriptions_to_a_client.yml
-- spec/cassettes/should_deny_publishing_on_a_channel_context.yml
-- spec/cassettes/should_deny_subscriptions_on_a_channel_context.yml
-- spec/cassettes/should_get_a_set_of_nodes_for_the_network.yml
-- spec/cassettes/should_get_a_subscribe_granted_event.yml
-- spec/cassettes/should_grant_a_connection.yml
-- spec/cassettes/should_grant_a_control_to_a_client.yml
-- spec/cassettes/should_grant_a_publishing_to_a_client.yml
-- spec/cassettes/should_grant_a_subscriptions_to_a_client.yml
-- spec/cassettes/should_grant_publishing_on_a_channel_context.yml
-- spec/cassettes/should_grant_subscriptions_on_a_channel_context.yml
-- spec/cassettes/should_publish.yml
-- spec/cassettes/should_publish_on_a_channel_context.yml
-- spec/cassettes/should_publish_to_a_client.yml
-- spec/cassettes/should_receive_an_unsubscribe_event.yml
-- spec/cassettes/should_receive_messages_on_a_channel.yml
-- spec/cassettes/should_send_a_connect_op.yml
-- spec/cassettes/should_send_a_connect_op_with_an_id.yml
-- spec/cassettes/should_spawn_a_client.yml
-- spec/cassettes/should_subscribe_to_a_channel.yml
-- spec/cassettes/should_trigger_a_connect_denied_event.yml
-- spec/cassettes/should_trigger_a_connect_event.yml
-- spec/cassettes/should_trigger_a_disconnect_event.yml
-- spec/cassettes/should_trigger_an_error_event.yml
-- spec/cassettes/should_unsubscribe_from_a_channel.yml
-- spec/cassettes/should_update_the_default_app.yml
-- spec/helper.rb
-- spec/shove_client_spec.rb
-- spec/shove_http_spec.rb
+test_files: []