shove 0.6.0 → 0.51

data/README.md

@@ -20,7 +20,7 @@
       :cluster => "cluster"
     )
 
-##Broadcasting
+##Broadcast messages
 
     # broadcast the "hello" event on the "default" channel with
     # Hello World! as the data
@@ -30,20 +30,20 @@
       puts response.message
     end
   
-##Send direct messages
+##Direct messages
 
     Shove.direct(userid, "hello", "Hello World!") do |response|
       # handle response
     end
 
-##Subscription Authorization
+##Authorize a user
 
     # authorize user with id userid on channel "default"
     Shove.authorize(userid, "default") do |response|
       # handle response
     end
     
-##Channel Streaming
+##Stream all data from a channel
 
     # stream all data on channel "default"
     Shove.stream("default") do |msg|
@@ -56,6 +56,36 @@
       puts msg[:data] # the payload
 
     end
+    
+##Channel Management
+Creating channels is a privileged operation.  You can do it from the shove.io management console, or via the management API. 
+In the case of the ruby gem, you can manage it straight from ruby.
+
+    # Create a channel
+    options = {
+      :name => "funchannel", #this is the only required field
+      :restricted => false, #require authorization for subscription
+      :broadcastable => true, #allow clients to broadcast to other clients
+      :presence => true #when users subscribe/unsubscribe all other subscribers are notified
+    }
+    Shove.create_channel(options) do |response|
+      if response.error?
+        puts "boooo"
+        puts response.message
+      end
+    end
+    
+    # Update a channel
+    Shove.update_channel("funchannel", :presence => false) do |response|
+      # ...
+    end
+    
+    # Delete channel
+    # this will unsubscribe all subscribers from this channel
+    # nearly immediately, so make sure you want to do that.
+    Shove.delete_channel("funchannel") do |response|
+      # ...
+    end
   
 ##Block and Non-blocking
   shover does both.  If the shover code happens to run inside of an EM.run block, the HTTP calls

data/bin/shove

@@ -16,6 +16,7 @@ unless FileTest.exist?(ymlpath)
     say "Please enter your network information."
     say "Visit http://shove.io/customer/network/api_access for more info."
     
+    access[:cluster] = ask "Enter Cluster Group: "
     access[:network] = ask "Enter Network Id: "
     access[:key] = ask "Enter Network Key: "
 

data/lib/shove/client.rb

@@ -6,12 +6,13 @@ module Shove
     # +key+ the api access key
     # +opts+ hash with a few options, such as:
     # :secure true or false
-    # :host leave as default unless you have a dedicated cluster
+    # :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.shove.io"
-      @port = opts[:port] || (@secure ? 443 : 80)
+      @host = opts[:host] || "api.#{@cluster}.shove.io"
+      @web_host = opts[:web_host] || "shove.io"
     end
     
     # broadcast a message
@@ -44,18 +45,38 @@ module Shove
       end
     end
     
-    # fetch a list of hosts for streaming websockets and comet
-    def hosts
-      Request.new("#{uri}/hosts").get do |response|
-        return response
-      end
+    # Channel methods
+    
+    # create a channel
+    # +opts+ the hash containing channel options
+    #   :restricted
+    #   :name
+    def create_channel opts, &block
+      Request.new("#{channel_uri}").post({ :channel => opts }, &block)
+    end
+    
+    # delete a channel
+    # +name+ the name of the channel to delete
+    def delete_channel name, &block
+      Request.new("#{channel_uri}/#{name}").delete(&block)
     end
-        
+    
+    # update the attributes of a channel
+    # +name+ the name of the channel
+    # +opts+ the options hash to update
+    def update_channel name, opts, &block
+      Request.new("#{channel_uri}/#{name}").put({ :channel => opts }, &block)
+    end
+    
     protected
     
     def uri
-      (@secure ? "https" : "http") + "://#{@host}:#{@port}/#{@network}"
+      (@secure ? "https" : "http") + "://#{@host}/#{@network}"
+    end
+    
+    def channel_uri
+      (@secure ? "https" : "http") + "://#{@web_host}/api/#{@network}/channels"
     end
     
   end
-end
+end

data/lib/shove/response.rb

@@ -14,14 +14,9 @@ module Shove
       error
     end
     
-    # parse a json response
-    def parse
-      @parsed ||= Yajl::Parser.new(:symbolize_keys => true).parse(message)
-    end
-    
-    # alias parse
+    # generate a hash from a json response
     def to_hash
-      parse
+      @hash ||= Yajl::Parser.new(:symbolize_keys => true).parse(message)
     end
 
   end

data/lib/shove.rb

@@ -9,12 +9,10 @@ require "yaml"
 ##
 # Shove
 # 
-# See http://shove.io for an account and client documentation
-# See https://github.com/shove/shover for gem documentation
-# See https://github.com/shove/shove for client documentation
+# See http://shove.io for an account
 module Shove
   
-  Version = 0.60
+  Version = 0.51
   
   class << self
   
@@ -26,7 +24,6 @@ module Shove
     def configure settings
       if settings.kind_of? String
         self.config = YAML.load_file(settings)
-        self.config
       elsif settings.kind_of? Hash
         self.config = settings
       else
@@ -64,32 +61,39 @@ module Shove
     def validate
       client.validate
     end
+
+    # Channel methods
+
+    # create a channel
+    # +opts+ the hash containing channel options
+    def create_channel opts, &block
+      client.create_channel opts, &block
+    end
     
-    # fetch the available stream hosts
-    # for this network.
-    def hosts
-      client.hosts
+    # delete a channel
+    # +name+ the name of the channel to delete
+    def delete_channel name, &block
+      client.delete_channel name, &block
     end
     
+    # update the attributes of a channel
+    # +name+ the name of the channel
+    # +opts+ the options hash to update
+    def update_channel name, opts, &block
+      client.update_channel name, opts, &block
+    end
+    
+
     # act as a stream client.  requires EM
     # +channel+ the channel to stream
     def stream channel, &block
       
       unless EM.reactor_running?
-        puts "You can stream when running in an Eventmachine event loop.  EM.run { #code here }"
-        exit
-      end
-      
-      ## Fetch hosts
-      hostnames = hosts
-      
-      if hostnames.empty?
-        puts "Error fetching hosts for network #{config[:network]}"
-        exit
+        raise "You can stream when running in an Eventmachine event loop.  EM.run { #code here }"
       end
       
       uid  = ""
-      http = EventMachine::HttpRequest.new("ws://ws-#{hostnames.first}.shove.io/#{config[:network]}").get :timeout => 0
+      http = EventMachine::HttpRequest.new("ws://ws.shove.io/#{config[:network]}").get :timeout => 0
       
       http.errback {
         block.call("Connection Error")
@@ -101,7 +105,9 @@ module Shove
       }
 
       http.stream { |msg|
-
+        
+        puts msg
+        
         parts = msg.split "!"
         
         case parts[1]

data/shove.gemspec

@@ -1,7 +1,7 @@
 spec = Gem::Specification.new do |s|
   s.name = "shove"
-  s.version = "0.6.0"
-  s.date = "2011-07-23"
+  s.version = "0.51"
+  s.date = "2011-03-12"
   s.summary = "Ruby gem for leveraging shove.io, the web push platform"
   s.email = "dan@shove.io"
   s.homepage = "https://github.com/shove/shover"
@@ -13,11 +13,20 @@ spec = Gem::Specification.new do |s|
   s.add_dependency("yajl-ruby", ">= 0.8.1")
   
   s.bindir = "bin"
-
+	s.executables = ["shove"]
+	
   s.authors = ["Dan Simpson"]
 
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-
+  s.files = [
+    "README.md",
+    "shove.gemspec",
+    "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"
+  ]
 end

data/spec/shove_spec.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + "/helper"
 describe Shove do
 
   before do
-    Shove.configure "shove.yml"
+    Shove.configure "./shove.yml"
   end
 
   it "should have a version" do
@@ -11,40 +11,8 @@ describe Shove do
   end
 
   it "should have config" do
-    Shove.config[:network].should == "test"
+    Shove.config["network"].should == "shove"
   end
   
-  it "should be able to authorize with the server" do
-    response = Shove.validate
-    response.error?.should == false
-  end
-  
-  it "should get a set of hosts for the network" do
-    response = Shove.hosts
-    response.status.should == 200
-  end
-  
-  it "should be able to broadcast a message" do
-    Shove.broadcast("default", "event", "test") do |response|
-      response.error?.should == false
-    end
-  end
-    
-  it "should be able to broadcast a message with EM" do
-    EM.run do
-    
-      ##
-      # Setup stream and capture for validation
-      ##
-    
-      Shove.broadcast("default", "event", "test2") do |response|
-        response.error?.should == false
-      end
-      
-      EM.add_timer(0.2) do
-          EM.stop
-      end
-    end
-  end
 
 end

metadata

@@ -1,8 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: shove
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.6.0
+  prerelease: false
+  segments: 
+  - 0
+  - 51
+  version: "0.51"
 platform: ruby
 authors: 
 - Dan Simpson
@@ -10,7 +13,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-23 00:00:00 Z
+date: 2011-03-12 00:00:00 -08:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: em-http-request
@@ -20,6 +24,10 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
         version: 0.3.0
   type: :runtime
   version_requirements: *id001
@@ -31,6 +39,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 4
+        - 0
+        - 3
         version: 4.0.3
   type: :runtime
   version_requirements: *id002
@@ -42,6 +54,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 1
         version: 0.8.1
   type: :runtime
   version_requirements: *id003
@@ -54,17 +70,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- .gitignore
 - README.md
+- shove.gemspec
 - Rakefile
-- bin/shove
+- spec/helper.rb
+- spec/shove_spec.rb
 - lib/shove.rb
-- lib/shove/client.rb
 - lib/shove/request.rb
 - lib/shove/response.rb
-- shove.gemspec
-- spec/helper.rb
-- spec/shove_spec.rb
+- lib/shove/client.rb
+- bin/shove
+has_rdoc: true
 homepage: https://github.com/shove/shover
 licenses: []
 
@@ -78,17 +94,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.3
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby gem for leveraging shove.io, the web push platform

data/.gitignore

@@ -1,3 +0,0 @@
-shove.yml
-example.rb
-*.gem