shove 0.52 → 1.0.1

data/spec/shove_client_spec.rb

@@ -0,0 +1,194 @@
+require File.dirname(__FILE__) + "/helper"
+
+describe Shove::Client do
+
+  before(:all) do 
+    Shove.configure do
+      app_id "test"
+      app_key "test"
+      api_url "http://api.shove.dev:8080"
+      ws_url "ws://shove.dev:9000"
+    end
+  end
+
+  before do |context|
+    VCR.insert_cassette context.example.metadata[:description_args].first
+    $queue.clear
+  end
+
+  after do |context|
+    VCR.eject_cassette
+  end
+
+  it "should spawn a client" do
+    @client = Shove.app.connect
+    @client.should_not == nil
+    @client.url.should == "#{Shove.config.ws_url}/test"
+  end
+
+  it "should send a connect op" do
+    @client = Shove.app.connect
+    message = $queue.pop
+    message["opcode"].should == Shove::Protocol::CONNECT
+  end
+
+  it "should send a connect op with an id" do
+    @client = Shove.app.connect("monkey")
+    message = $queue.pop
+    message["opcode"].should == Shove::Protocol::CONNECT
+    message["data"].should == "monkey"
+  end
+
+  it "should trigger a connect event" do
+    @client = Shove.app.connect
+    @client.on("connect") do |client_id|
+      @triggered = true
+      @id = client_id
+    end
+
+    backdoor :opcode => Shove::Protocol::CONNECT_GRANTED, :data => "tid"
+
+    @id.should == "tid"
+    @triggered.should == true
+  end
+
+  it "should trigger a connect_denied event" do
+    @client = Shove.app.connect
+    @client.on("connect_denied") do |client_id|
+      @triggered = true
+      @id = client_id
+    end
+
+    backdoor :opcode => Shove::Protocol::CONNECT_DENIED, :data => "tid"
+
+    @id.should == "tid"
+    @triggered.should == true
+  end
+
+
+  it "should trigger a disconnect event" do
+    @client = Shove.app.connect
+    @client.on("disconnect") do
+      @triggered = true
+    end
+
+    backdoor :opcode => Shove::Protocol::DISCONNECT
+
+    @triggered.should == true
+  end
+
+  it "should trigger an error event" do
+    @client = Shove.app.connect
+    @client.on("error") do |error|
+      @error = error
+    end
+
+    backdoor :opcode => Shove::Protocol::ERROR, :data => "Test Error"
+
+    @error.should == "Test Error"
+  end
+
+  it "should authorize oneself" do
+    @client = Shove.app.connect
+    @client.authorize("test")
+    $queue.last()["opcode"].should == Shove::Protocol::AUTHORIZE
+  end
+
+  it "should create a channel context" do
+    @client = Shove.app.connect
+    @channel = @client.channel("channel")
+
+    @channel.should_not == nil
+    @channel.should == @client.channel("channel")
+  end
+
+  it "should subscribe to a channel" do
+    @client = Shove.app.connect
+    @channel = @client.channel("channel")
+    @message = $queue.last
+    @message["opcode"].should == Shove::Protocol::SUBSCRIBE
+  end
+
+  it "should get a subscribe granted event" do
+    @client = Shove.app.connect
+    @channel = @client.channel("channel")
+    @channel.on("subscribe") do
+      @triggered = true
+    end
+
+    backdoor :opcode => Shove::Protocol::SUBSCRIBE_GRANTED, :channel => "channel"
+
+    @triggered.should == true
+  end
+
+  it "should receive messages on a channel" do
+    @messages = 0
+    @message = nil
+
+    @client = Shove.app.connect
+    @channel = @client.channel("channel")
+    @channel.on("message") do |msg|
+      @messages += 1
+      @message = msg
+    end
+
+    backdoor :opcode => Shove::Protocol::PUBLISH, :channel => "channel", :data => "test"
+
+    @messages.should == 1
+    @message.should == "test"
+  end
+
+  it "should cancel a binding" do
+    @messages = 0
+
+    @client = Shove.app.connect
+    @channel = @client.channel("channel")
+    binding = @channel.on("message") do |msg|
+      @messages += 1
+    end
+
+    message = { 
+      :opcode => Shove::Protocol::PUBLISH, 
+      :channel => "channel", 
+      :data => "test" 
+    }
+
+    backdoor message
+    backdoor message
+    binding.cancel
+    backdoor message
+
+    @messages.should == 2
+  end
+
+  it "should unsubscribe from a channel" do
+    @client = Shove.app.connect
+    @channel = @client.channel("channel")
+    @channel.unsubscribe
+    @message = $queue.last
+    @message["opcode"].should == Shove::Protocol::UNSUBSCRIBE
+  end
+
+  it "should receive an unsubscribe event" do
+    @client = Shove.app.connect
+    @channel = @client.channel("channel")
+    @channel.unsubscribe
+    @channel.on("unsubscribe") do
+      @triggered = true
+    end
+
+    backdoor :opcode => Shove::Protocol::UNSUBSCRIBE_COMPLETE, :channel => "channel"
+
+    @triggered.should == true
+  end
+
+
+  it "should publish" do
+    @client = Shove.app.connect
+    @channel = @client.channel("channel")
+    @channel.publish "test"
+
+    $queue.last()["opcode"].should == Shove::Protocol::PUBLISH
+  end
+
+end

data/spec/shove_http_spec.rb

@@ -0,0 +1,142 @@
+require File.dirname(__FILE__) + "/helper"
+
+describe Shove:Http do
+
+  before(:all) do
+    Shove.configure do
+      app_id "test"
+      app_key "test"
+      api_url "http://api.shove.dev:8080"
+      ws_url "ws://shove.dev:9000"
+    end
+  end
+
+  before do |context|
+    VCR.insert_cassette context.example.metadata[:description_args].first
+  end
+
+  after do |context|
+    VCR.eject_cassette
+  end
+
+  it "should have a version" do
+    Shove.const_defined?("Version").should == true
+  end
+
+  it "should have config" do
+    Shove.config.app_id.should == "test"
+    Shove.config.app_key.should == "test"
+  end
+  
+  it "should be able to authorize with the server" do
+    valid = Shove.valid?
+    valid.should == true
+  end
+    
+  it "should get a set of nodes for the network" do
+    hosts = Shove.hosts
+    hosts.size.should > 0
+  end
+  
+  # Channel context tests, basic plumbing
+
+  it "should spawn a channel context" do
+    chan = Shove.channel("test")
+    chan.channel.should == "test"
+    chan.app.should == Shove.app
+  end
+
+  it "should publish on a channel context" do
+    Shove.channel("test").publish("hi") do |response|
+      response.error?.should == false
+    end
+  end
+
+  it "should grant subscriptions on a channel context" do
+    Shove.channel("test").grant_subscribe("dan") do |response|
+      response.error?.should == false
+    end
+  end
+
+  it "should grant publishing on a channel context" do
+    Shove.channel("test").grant_publish("dan") do |response|
+      response.error?.should == false
+    end
+  end
+
+  it "should deny subscriptions on a channel context" do
+    Shove.channel("test").deny_subscribe("dan") do |response|
+      response.error?.should == false
+    end
+  end
+
+  it "should deny publishing on a channel context" do
+    Shove.channel("test").deny_publish("dan") do |response|
+      response.error?.should == false
+    end
+  end
+ 
+  # Client context tests, basic plumbing
+
+  it "should spawn a client context" do
+    chan = Shove.client("dan")
+    chan.id.should == "dan"
+    chan.app.should == Shove.app
+  end
+
+  it "should grant a connection" do
+    Shove.client("dan").grant_connect do |response|
+      response.error?.should == false
+    end
+  end
+
+  it "should deny a connection" do
+    Shove.client("dan").deny_connect do |response|
+      response.error?.should == false
+    end
+  end
+
+  it "should publish to a client" do
+    Shove.client("dan").publish("hi") do |response|
+      response.error?.should == false
+    end
+  end
+
+  it "should grant a subscriptions to a client" do
+    Shove.client("dan").grant_subscribe("channel") do |response|
+      response.error?.should == false
+    end
+  end
+
+  it "should grant a publishing to a client" do
+    Shove.client("dan").grant_publish("channel") do |response|
+      response.error?.should == false
+    end
+  end
+
+  it "should grant a control to a client" do
+    Shove.client("dan").grant_control do |response|
+      response.error?.should == false
+    end
+  end
+
+  it "should deny a subscriptions to a client" do
+    Shove.client("dan").deny_subscribe("channel") do |response|
+      response.error?.should == false
+    end
+  end
+
+  it "should deny a publishing to a client" do
+    Shove.client("dan").deny_publish("channel") do |response|
+      response.error?.should == false
+    end
+  end
+
+  it "should deny a control to a client" do
+    Shove.client("dan").deny_control do |response|
+      response.error?.should == false
+    end
+  end
+
+
+end

metadata

@@ -1,116 +1,146 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: shove
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 52
-  version: "0.52"
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Dan Simpson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-26 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: em-http-request
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &13961220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 3
-        - 0
-        version: 0.3.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: commander
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *13961220
+- !ruby/object:Gem::Dependency
+  name: em-ws-client
+  requirement: &13930020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 4
-        - 0
-        - 3
-        version: 4.0.3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *13930020
+- !ruby/object:Gem::Dependency
   name: yajl-ruby
+  requirement: &13924920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *13924920
+- !ruby/object:Gem::Dependency
+  name: confstruct
+  requirement: &13918240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 8
-        - 1
-        version: 0.8.1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *13918240
 description: Client side implementation for the shove.io API.  See http://shove.io/documentation
 email: dan@shove.io
-executables: 
+executables:
 - shove
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- README.md
-- shove.gemspec
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.markdown
 - Rakefile
-- spec/helper.rb
-- spec/shove_spec.rb
-- lib/shove.rb
-- lib/shove/request.rb
-- lib/shove/response.rb
-- lib/shove/client.rb
 - bin/shove
-has_rdoc: true
-homepage: https://github.com/shove/shover
+- lib/shove.rb
+- lib/shove/app.rb
+- lib/shove/app_directory.rb
+- lib/shove/client/callback.rb
+- lib/shove/client/channel.rb
+- lib/shove/client/connection.rb
+- lib/shove/http/channel_context.rb
+- lib/shove/http/client_context.rb
+- lib/shove/http/request.rb
+- lib/shove/http/response.rb
+- lib/shove/protocol.rb
+- shove.gemspec
+- spec/app_directory_spec.rb
+- 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
+homepage: https://github.com/shove/shove-ruby
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby gem for leveraging shove.io, the web push platform
 test_files: []
-

data/README.md

@@ -1,71 +0,0 @@
-#shover
-
-* The official ruby gem for shove.io's REST API
-
-##Install Step 1
-
-	gem install shove
-
-##Install Step 2
-  Grab your network id and API key from shove at [http://shove.io/customer/network/api_access#ruby][0]
-  
-##Install Step 3
-  Configure shover with your credentials
-  
-    require "shove"
-  
-    Shove.configure(
-      :network => "network",
-      :key => "apikey",
-      :cluster => "cluster"
-    )
-
-##Broadcasting
-
-    # broadcast the "hello" event on the "default" channel with
-    # Hello World! as the data
-    Shove.broadcast("default", "hello", "Hello World!") do |response|
-      puts response.error?
-      puts response.status
-      puts response.message
-    end
-  
-##Send direct messages
-
-    Shove.direct(userid, "hello", "Hello World!") do |response|
-      # handle response
-    end
-
-##Subscription Authorization
-
-    # authorize user with id userid on channel "default"
-    Shove.authorize(userid, "default") do |response|
-      # handle response
-    end
-    
-##Channel Streaming
-
-    # stream all data on channel "default"
-    Shove.stream("default") do |msg|
-      
-      # msg has several properties
-      puts msg[:channel]
-      puts msg[:event]
-      puts msg[:to] # this will either be empty or self
-      puts msg[:from] # message sender
-      puts msg[:data] # the payload
-
-    end
-  
-##Block and Non-blocking
-  shover does both.  If the shover code happens to run inside of an EM.run block, the HTTP calls
-  will leverage em-http-request.  Otherwise, the requests fallback to net/http requests.  We recommend
-  using EM if possible.
-  
-##CLI (Command line interface)
-  The shove gem comes with a command line tool for controlling the network.
-  View documentation @ [http://shove.io/documentation/cli][1]
-
-
-[0]: http://shove.io/customer/network/api_access
-[1]: http://shove.io/documentation/cli

data/lib/shove/client.rb

@@ -1,54 +0,0 @@
-module Shove
-  class Client
-
-    # create an API client
-    # +network+ the network id
-    # +key+ the api access key
-    # +opts+ hash with a few options, such as:
-    # :secure true or false
-    # :host leave as default unless you are given a private cluster
-    def initialize opts={}
-      @network = opts[:network]
-      @cluster = opts[:cluster] || "a01"
-      @secure = opts[:secure] || false
-      @host = opts[:host] || "api-#{@cluster}.shove.io"
-    end
-    
-    # broadcast a message
-    # +channel+ the channel to broadcast on
-    # +event+ the event to trigger
-    # +message+ the message to send, UTF-8 encoded kthx
-    def broadcast channel, event, message, &block
-      Request.new("#{uri}/broadcast/#{channel}/#{event}").post(message, &block)
-    end
-    
-    # direct a message to a specific user
-    # +uid+ the users id
-    # +event+ the event to trigger
-    # +message+ the message to send, UTF-8 encoded kthx
-    def direct uid, event, message, &block
-      Request.new("#{uri}/direct/#{event}/#{uid}").post(message, &block)
-    end
-    
-    # authorize a user on a private channel
-    # +uid+ the users id
-    # +channel+ the channel to authorize them on
-    def authorize uid, channel="*", &block
-      Request.new("#{uri}/authorize/#{channel}/#{uid}").post(&block)
-    end
-    
-    # validate current API settings
-    def validate
-      Request.new("#{uri}/validate").post do |response|
-        return response
-      end
-    end
-        
-    protected
-    
-    def uri
-      (@secure ? "https" : "http") + "://#{@host}/#{@network}"
-    end
-    
-  end
-end