shove 0.4 → 0.6.0

data/.gitignore

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

data/README.md

@@ -7,7 +7,7 @@
 	gem install shove
 
 ##Install Step 2
-  Grab your network id and API key from shove at [http://shove.io/customer/network/api_access]
+  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
@@ -20,7 +20,7 @@
       :cluster => "cluster"
     )
 
-##Broadcast messages
+##Broadcasting
 
     # broadcast the "hello" event on the "default" channel with
     # Hello World! as the data
@@ -30,18 +30,32 @@
       puts response.message
     end
   
-##Direct messages
+##Send direct messages
 
     Shove.direct(userid, "hello", "Hello World!") do |response|
       # handle response
     end
 
-##Authorize a user
+##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
@@ -50,6 +64,8 @@
   
 ##CLI (Command line interface)
   The shove gem comes with a command line tool for controlling the network.
-  View documentation @ [http://shove.io/documentation/cli]
-    
-    
+  View documentation @ [http://shove.io/documentation/cli][1]
+
+
+[0]: http://shove.io/customer/network/api_access
+[1]: http://shove.io/documentation/cli

data/bin/shove

@@ -16,7 +16,6 @@ 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: "
 
@@ -56,7 +55,14 @@ command :stream do |c|
       say_invalid c
     else
       EM.run do
-        Shove.stream(args.first) { |m| say(m) }
+        Shove.stream(args.first) { |m| 
+          puts m[:channel]
+          puts m[:event]
+          puts m[:to] # this will either be empty or self
+          puts m[:from] # message sender
+          puts m[:data] # the payload
+          puts "============"
+        }
       end
     end
   end

data/lib/shove/client.rb

@@ -6,14 +6,12 @@ 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 are given a private cluster
-    def initialize network, key, opts={}
-      @network = network
-      @cluster = opts[:cluster] || "a04"
-      @key = key
-      @auth_header = { "api-key" => key }
+    # :host leave as default unless you have a dedicated cluster
+    def initialize opts={}
+      @network = opts[:network]
       @secure = opts[:secure] || false
-      @host = opts[:host] || "api.#{@cluster}.shove.io"
+      @host = opts[:host] || "api.shove.io"
+      @port = opts[:port] || (@secure ? 443 : 80)
     end
     
     # broadcast a message
@@ -21,7 +19,7 @@ module Shove
     # +event+ the event to trigger
     # +message+ the message to send, UTF-8 encoded kthx
     def broadcast channel, event, message, &block
-      Request.new("#{uri}/#{@network}/broadcast/#{channel}/#{event}", @auth_header).post(message, &block)
+      Request.new("#{uri}/broadcast/#{channel}/#{event}").post(message, &block)
     end
     
     # direct a message to a specific user
@@ -29,27 +27,35 @@ module Shove
     # +event+ the event to trigger
     # +message+ the message to send, UTF-8 encoded kthx
     def direct uid, event, message, &block
-      Request.new("#{uri}/#{@network}/direct/#{event}/#{uid}", @auth_header).post(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}/#{@network}/authorize/#{channel}/#{uid}", @auth_header).post(&block)
+      Request.new("#{uri}/authorize/#{channel}/#{uid}").post(&block)
     end
     
+    # validate current API settings
     def validate
-      Request.new("#{uri}/#{@network}/validate", @auth_header).post do |response|
+      Request.new("#{uri}/validate").post do |response|
         return response
       end
     end
     
+    # fetch a list of hosts for streaming websockets and comet
+    def hosts
+      Request.new("#{uri}/hosts").get do |response|
+        return response
+      end
+    end
+        
     protected
     
     def uri
-      (@secure ? "https" : "http") + "://#{@host}"
+      (@secure ? "https" : "http") + "://#{@host}:#{@port}/#{@network}"
     end
     
   end
-end
+end

data/lib/shove/request.rb

@@ -1,33 +1,78 @@
 module Shove
   class Request
     
+    include EventMachine::HttpEncoding
+    
     attr_accessor :url, :headers
     
     def initialize url, headers={}
       self.url = url
-      self.headers = headers
+      self.headers = headers.merge({
+        "api-key" => Shove.config[:key]
+      })
+    end
+    
+    # HTTP Delete request
+    def delete &block
+      exec :delete, &block
+    end
+  
+    # HTTP Post request for new content
+    def post params={}, &block
+      exec :post, params, &block
+    end
+    
+    # HTTP Put request for updates
+    def put params={}, &block
+      exec :put, params, &block
+    end
+    
+    # HTTP Get request
+    def get &block
+      exec :get, &block
     end
     
-    def post params="", &block
+    private
+
+    # exec a HTTP request, and callback with
+    # a response via block
+    def exec method, params={}, &block
+      
+      # run async so we don't block if EM is running
       if EM.reactor_running?
-        http = EventMachine::HttpRequest.new(url).post(:body => params, :head => headers)
-        if block
-          http.errback { 
-            block.call(Response.new(http.response_header.status, http.response, true))
-          }
-          http.callback {
-            block.call(Response.new(http.response_header.status, http.response, false))
-          }
-        end
+        http = EventMachine::HttpRequest.new(url).send(method, { 
+          :body => params,
+          :head => headers 
+        })
+        
+        # handle error
+        http.errback {
+          block.call(Response.new(http.response_header.status, http.response, true)) if block_given? 
+        }
+        
+        # handle success
+        http.callback {
+          status = http.response_header.status
+          block.call(Response.new(status, http.response, status >= 400)) if block_given? 
+        }
+      
+      # fallback to standard lib for http  
       else
         uri = URI.parse(url)
-        res = Net::HTTP.new(uri.host, uri.port).post(uri.path, params, headers)
-        if block
-          block.call(Response.new(res.code, res.body, res.code.to_i < 400))
+        case method
+        when :post, :put
+          res = Net::HTTP.new(uri.host, uri.port).send(method, uri.path, normalize_body(params), headers)
+        when :get, :delete
+          res = Net::HTTP.new(uri.host, uri.port).send(method, uri.path, headers) 
         end
+        block.call(Response.new(res.code, res.body, res.code.to_i >= 400)) if block_given? 
       end
     end
-
+    
+    def normalize_body(body)
+      body.is_a?(Hash) ? form_encode_body(body) : body
+    end
+    
   end
 end
 

data/lib/shove/response.rb

@@ -9,9 +9,20 @@ module Shove
       self.error = error
     end
     
+    # was there an error with the request?
     def error?
       error
     end
+    
+    # parse a json response
+    def parse
+      @parsed ||= Yajl::Parser.new(:symbolize_keys => true).parse(message)
+    end
+    
+    # alias parse
+    def to_hash
+      parse
+    end
 
   end
 end

data/lib/shove.rb

@@ -3,15 +3,18 @@ $:.unshift File.dirname(__FILE__)
 require "rubygems"
 require "net/http"
 require "em-http-request"
+require "yajl"
 require "yaml"
 
 ##
 # Shove
 # 
-# See http://shove.io for an account
+# 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
 module Shove
   
-  Version = 0.4
+  Version = 0.60
   
   class << self
   
@@ -21,22 +24,16 @@ module Shove
     # +settings+ the settings for the created client as 
     # a string for a yaml file, or as a hash
     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
         raise "Unsupported configuration type"
       end
-      
-      # symbolize keys
-      # self.config = {}
-      #      tmp.each_pair do |k,v|
-      #        self.config[k.to_sym] = v
-      #      end
-      
-      self.client = Client.new config[:network], config[:key], config
+
+      self.client = Client.new(config)
     end
     
     # broadcast a message
@@ -67,18 +64,32 @@ module Shove
     def validate
       client.validate
     end
-
+    
+    # fetch the available stream hosts
+    # for this network.
+    def hosts
+      client.hosts
+    end
+    
     # act as a stream client.  requires EM
     # +channel+ the channel to stream
     def stream channel, &block
       
       unless EM.reactor_running?
-        raise "You can stream when running in an Eventmachine event loop.  EM.run { #code here }"
+        puts "You can stream when running in an Eventmachine event loop.  EM.run { #code here }"
+        exit
       end
       
-      uid = ""
+      ## Fetch hosts
+      hostnames = hosts
+      
+      if hostnames.empty?
+        puts "Error fetching hosts for network #{config[:network]}"
+        exit
+      end
       
-      http = EventMachine::HttpRequest.new("ws://ws.shove.io/#{config[:network]}").get :timeout => 0
+      uid  = ""
+      http = EventMachine::HttpRequest.new("ws://ws-#{hostnames.first}.shove.io/#{config[:network]}").get :timeout => 0
       
       http.errback {
         block.call("Connection Error")
@@ -90,7 +101,7 @@ module Shove
       }
 
       http.stream { |msg|
-        
+
         parts = msg.split "!"
         
         case parts[1]
@@ -100,7 +111,13 @@ module Shove
           Shove.authorize uid, channel
         end
         
-        block.call(msg)
+        block.call({
+          :channel => parts[0],
+          :event => parts[1],
+          :to => parts[2],
+          :from => parts[3],
+          :data => parts[4]
+        })
       }
 
     end

data/shove.gemspec

@@ -1,31 +1,23 @@
 spec = Gem::Specification.new do |s|
   s.name = "shove"
-  s.version = "0.4"
-  s.date = "2010-12-16"
+  s.version = "0.6.0"
+  s.date = "2011-07-23"
   s.summary = "Ruby gem for leveraging shove.io, the web push platform"
   s.email = "dan@shove.io"
   s.homepage = "https://github.com/shove/shover"
   s.description = "Client side implementation for the shove.io API.  See http://shove.io/documentation"
   s.has_rdoc = true
   
-  s.add_dependency("em-http-request", ">= 0.3.0")
+  s.add_dependency("em-http-request", "= 0.3.0")
   s.add_dependency("commander", ">= 4.0.3")
+  s.add_dependency("yajl-ruby", ">= 0.8.1")
   
   s.bindir = "bin"
-	s.executables = ["shove"]
-	
+
   s.authors = ["Dan Simpson"]
 
-  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"
-  ]
+  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) }
+
 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,7 +11,40 @@ describe Shove do
   end
 
   it "should have config" do
-    Shove.config["network"].should == "shove"
+    Shove.config[:network].should == "test"
+  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,11 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: shove
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  version: "0.4"
+  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors: 
 - Dan Simpson
@@ -13,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-16 00:00:00 -08:00
-default_executable: 
+date: 2011-07-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: em-http-request
@@ -22,12 +18,8 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 3
-        - 0
         version: 0.3.0
   type: :runtime
   version_requirements: *id001
@@ -39,13 +31,20 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 4
-        - 0
-        - 3
         version: 4.0.3
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+  type: :runtime
+  version_requirements: *id003
 description: Client side implementation for the shove.io API.  See http://shove.io/documentation
 email: dan@shove.io
 executables: 
@@ -55,17 +54,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
 - README.md
-- shove.gemspec
 - Rakefile
-- spec/helper.rb
-- spec/shove_spec.rb
+- bin/shove
 - lib/shove.rb
+- lib/shove/client.rb
 - lib/shove/request.rb
 - lib/shove/response.rb
-- lib/shove/client.rb
-- bin/shove
-has_rdoc: true
+- shove.gemspec
+- spec/helper.rb
+- spec/shove_spec.rb
 homepage: https://github.com/shove/shover
 licenses: []
 
@@ -79,21 +78,17 @@ 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.3.7
+rubygems_version: 1.8.3
 signing_key: 
 specification_version: 3
 summary: Ruby gem for leveraging shove.io, the web push platform