shove 0.3 → 0.4

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]
   
 ##Install Step 3
   Configure shover with your credentials
@@ -16,7 +16,8 @@
   
     Shove.configure(
       :network => "network",
-      :key => "apikey"
+      :key => "apikey",
+      :cluster => "cluster"
     )
 
 ##Broadcast messages
@@ -47,3 +48,8 @@
   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]
+    
+    

data/bin/shove

@@ -0,0 +1,126 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "commander/import"
+require "shove"
+
+ymlpath = File.expand_path("~/.shove.yml") 
+
+# get network, key, cluster
+unless FileTest.exist?(ymlpath)
+
+  access = {}
+  
+  loop do
+    
+    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: "
+
+    Shove.configure access
+    
+    check = Shove.validate
+    if check.status >= 400
+      say "Unable to validate network settings.  Error: #{check.message}"
+    else
+      break
+    end
+    
+  end
+
+  File.open(ymlpath, "w") do |f|
+    f << access.to_yaml
+  end
+    
+end
+
+Shove.configure(ymlpath)
+
+# Commander specification
+
+program :name, "shove"
+program :version, Shove::Version
+program :description, "CLI for the shove.io push platform"
+program :help, "Author", "Dan Simpson <dan@shove.io>"
+program :formatter, :compact
+
+command :stream do |c|
+  c.syntax = "shove stream channel"
+  c.example "Streams the default channel", "shove stream default"
+  c.description = "Stream all data on a given channel to the console"
+  c.action do |args, opts|
+    if args.empty?
+      say_invalid c
+    else
+      EM.run do
+        Shove.stream(args.first) { |m| say(m) }
+      end
+    end
+  end
+end
+alias_command :subscribe, :stream
+
+command :broadcast do |c|
+  c.syntax = "shove broadcast channel event data"
+  c.example "Broadcast x,y coordinates on the grid channel", "shove broadcast grid coords '1522,234'"
+  c.description = "Broadcast event and data to all subscribers of a given channel"
+  c.action do |args, opts|
+    if args.length != 3
+      say_invalid c
+    else
+      say "Broadcasting on channel #{args.first}"
+      Shove.broadcast(*args) do |response|
+        say response.message
+      end
+    end
+  end
+end
+
+command :direct do |c|
+  c.syntax = "shove direct user event data"
+  c.example "Send a message to user with id 9812737890", "shove direct 9812737890 message 'Your account expires in 2 minutes'"
+  c.description = "Send a message directly to a specific shove subscriber"
+  c.action do |args, opts|
+    if args.length != 3
+      say_invalid c
+    else
+      say "Sending data directly to user #{args.first}"
+      Shove.direct(*args) do |response|
+        say response.message
+      end
+    end
+  end
+end
+
+command :authorize do |c|
+  c.syntax = "shove authorize user channel"
+  c.example "Authorize user 9812737890 access to channel internal-bus", "shove authorize 9812737890 internal-bus"
+  c.description = "Authorize a pending channel subscription.  Only required for private channels."
+  c.action do |args, opts|
+    if args.length != 2
+      say_invalid c
+    else
+      say "Authorizing user #{args.first} on channel #{args.last}"
+      Shove.authorize(*args) do |response|
+        say response.message
+      end
+    end
+  end
+end
+
+
+def say_invalid cmd
+  puts "Invalid #{cmd.name} command. Syntax: #{cmd.syntax}"
+  unless cmd.examples.empty?
+    puts "Examples"
+    cmd.examples.each do |ex|
+      puts "---------"
+      puts ex.first
+      puts ex.last
+    end
+  end
+end
+

data/lib/shove.rb

@@ -1,6 +1,7 @@
 $:.unshift File.dirname(__FILE__)
 
 require "rubygems"
+require "net/http"
 require "em-http-request"
 require "yaml"
 
@@ -10,7 +11,7 @@ require "yaml"
 # See http://shove.io for an account
 module Shove
   
-  Version = 0.3
+  Version = 0.4
   
   class << self
   
@@ -20,6 +21,7 @@ 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)
       elsif settings.kind_of? Hash
@@ -28,6 +30,12 @@ module Shove
         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
     end
     
@@ -53,16 +61,49 @@ module Shove
     def authorize uid, channel="*", &block
       client.authorize uid, channel, &block
     end
+    
+    # validate network settings
+    # used for the CLI
+    def validate
+      client.validate
+    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 }"
       end
-      raise "Websocket client not implemented yet... soon"
+      
+      uid = ""
+      
+      http = EventMachine::HttpRequest.new("ws://ws.shove.io/#{config[:network]}").get :timeout => 0
+      
+      http.errback {
+        block.call("Connection Error")
+      }
+      
+      http.callback {
+        block.call("Connected")
+        http.send("#{channel}!$subscribe!!!")
+      }
+
+      http.stream { |msg|
+        
+        parts = msg.split "!"
+        
+        case parts[1]
+        when "$identity"
+          uid = parts.last
+        when "$unauthorized"
+          Shove.authorize uid, channel
+        end
+        
+        block.call(msg)
+      }
+
     end
-    
   end
 end
 

data/lib/shove/client.rb

@@ -9,10 +9,11 @@ module Shove
     # :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 }
       @secure = opts[:secure] || false
-      @host = opts[:host] || "api.shove.io"
+      @host = opts[:host] || "api.#{@cluster}.shove.io"
     end
     
     # broadcast a message
@@ -38,6 +39,12 @@ module Shove
       Request.new("#{uri}/#{@network}/authorize/#{channel}/#{uid}", @auth_header).post(&block)
     end
     
+    def validate
+      Request.new("#{uri}/#{@network}/validate", @auth_header).post do |response|
+        return response
+      end
+    end
+    
     protected
     
     def uri

data/lib/shove/request.rb

@@ -8,7 +8,7 @@ module Shove
       self.headers = headers
     end
     
-    def post params={}, &block
+    def post params="", &block
       if EM.reactor_running?
         http = EventMachine::HttpRequest.new(url).post(:body => params, :head => headers)
         if block
@@ -20,7 +20,11 @@ module Shove
           }
         end
       else
-        raise "EM requests only for now."
+        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))
+        end
       end
     end
 

data/lib/shove/response.rb

@@ -4,7 +4,7 @@ module Shove
     attr_accessor :status, :message, :error
     
     def initialize status, message, error=false
-      self.status = status
+      self.status = status.to_i
       self.message = message
       self.error = error
     end

data/shove.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = "shove"
-  s.version = "0.3"
+  s.version = "0.4"
   s.date = "2010-12-16"
   s.summary = "Ruby gem for leveraging shove.io, the web push platform"
   s.email = "dan@shove.io"
@@ -9,7 +9,11 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc = true
   
   s.add_dependency("em-http-request", ">= 0.3.0")
+  s.add_dependency("commander", ">= 4.0.3")
   
+  s.bindir = "bin"
+	s.executables = ["shove"]
+	
   s.authors = ["Dan Simpson"]
 
   s.files = [
@@ -21,6 +25,7 @@ spec = Gem::Specification.new do |s|
     "lib/shove.rb",
     "lib/shove/request.rb",
     "lib/shove/response.rb",
-    "lib/shove/client.rb"
+    "lib/shove/client.rb",
+    "bin/shove"
   ]
 end

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  version: "0.3"
+  - 4
+  version: "0.4"
 platform: ruby
 authors: 
 - Dan Simpson
@@ -31,10 +31,25 @@ dependencies:
         version: 0.3.0
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: commander
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 4
+        - 0
+        - 3
+        version: 4.0.3
+  type: :runtime
+  version_requirements: *id002
 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: []
@@ -49,6 +64,7 @@ files:
 - lib/shove/request.rb
 - lib/shove/response.rb
 - lib/shove/client.rb
+- bin/shove
 has_rdoc: true
 homepage: https://github.com/shove/shover
 licenses: []