shove 0.52 → 1.0.1

data/lib/shove/http/response.rb

@@ -0,0 +1,30 @@
+module Shove
+  module Http
+    class Response
+      
+      attr_accessor :status, :message, :error
+      
+      def initialize status, message, error=false
+        self.status = status.to_i
+        self.message = message
+        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
+end

data/lib/shove/protocol.rb

@@ -0,0 +1,53 @@
+module Shove
+  module Protocol
+
+    ERROR = 0x00
+
+    # Connection
+    CONNECT = 0x01
+    CONNECT_GRANTED = 0x02
+    CONNECT_DENIED = 0x03
+    DISCONNECT = 0x04
+    DISCONNECT_COMPLETE = 0x06
+
+    # Subscribe Ops
+    SUBSCRIBE = 0x10 
+    SUBSCRIBE_GRANTED = 0x11
+    SUBSCRIBE_DENIED = 0x12
+    UNSUBSCRIBE = 0x13
+    UNSUBSCRIBE_COMPLETE = 0x14
+
+    # Publish Ops
+    PUBLISH = 0x20 
+    PUBLISH_DENIED = 0x21
+    PUBLISH_GRANTED = 0x22
+
+    # Authorize Ops
+    GRANT_PUBLISH = 0x30 
+    GRANT_SUBSCRIBE = 0x31
+    GRANT_CONNECT = 0x32
+    GRANT_CONTROL = 0x33
+
+    # Deny Ops
+    DENY_PUBLISH = 0x40 
+    DENY_SUBSCRIBE = 0x41
+    DENY_CONNECT = 0x42
+    DENY_CONTROL = 0x43
+
+    # Log Ops
+    LOG = 0x50 
+    LOG_STARTED = 0x51
+    LOG_DENIED = 0x52
+
+    # Self authorize
+    AUTHORIZE = 0x60
+    AUTHORIZE_COMPLETE = 0x61
+    AUTHORIZE_DENIED = 0x62
+
+    # Presence Ops
+    PRESENCE_SUBSCRIBED = 0x70
+    PRESENCE_UNSUBSCRIBED = 0x71
+    PRESENCE_LIST = 0x72
+
+  end
+end

data/lib/shove.rb

@@ -3,110 +3,92 @@ $:.unshift File.dirname(__FILE__)
 require "rubygems"
 require "net/http"
 require "em-http-request"
+require "em-ws-client"
 require "yajl"
 require "yaml"
+require "confstruct"
 
 ##
 # 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-ruby for gem documentation
+# See https://github.com/shove/shove for client documentation
 module Shove
   
-  Version = 0.52
+  Version = "1.0.1"
   
-  class << self
+  class ShoveException < Exception; end
   
-    attr_accessor :config, :client
-    
+  class << self
+
+    attr_accessor :config, :app
+
     # configure shover
     # +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
-        self.config = settings
-      else
-        raise "Unsupported configuration type"
+    def configure params=nil, &block
+
+      unless defined? @config
+        @config = Confstruct::Configuration.new do
+          api_url "https://api.shove.io/"
+        end
+      end
+      
+      if params
+        @config.configure params
       end
 
-      self.client = Client.new(config)
-    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
-      client.broadcast channel, event, message, &block
+      if block
+        @config.configure(&block)
+      end
+
+      unless defined? @app
+        @app = App.new(@config)
+      else
+        
+      end
     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
-      client.direct uid, event, message, &block
+
+    # fetch a channel by name
+    # +name+ the name of the channel
+    def channel name
+      @app.channel(name)
     end
-    
-    # authorize a user on a private channel
-    # +uid+ the users id
-    # +channel+ the channel to authorize them on
-    def authorize uid, channel="*", &block
-      client.authorize uid, channel, &block
+
+    # fetch a client by id
+    def client id
+      @app.client(id)
     end
     
     # validate network settings
     # used for the CLI
-    def validate
-      client.validate
+    def valid?
+      @app.valid?
     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
-      
-      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({
-          :channel => parts[0],
-          :event => parts[1],
-          :to => parts[2],
-          :from => parts[3],
-          :data => parts[4]
-        })
-      }
+    # fetch the available stream nodes
+    # for this network.
+    def hosts
+      @app.hosts
+    end
 
+    # Connect to the default app with a 
+    # WebSocket connection
+    def connect
+      @app.connect
     end
+
   end
 end
 
-require "shove/client"
-require "shove/request"
-require "shove/response"
+require "shove/app"
+require "shove/app_directory"
+require "shove/protocol"
+require "shove/client/connection"
+require "shove/client/channel"
+require "shove/client/callback"
+require "shove/http/request"
+require "shove/http/response"
+require "shove/http/channel_context"
+require "shove/http/client_context"

data/shove.gemspec

@@ -1,32 +1,23 @@
 spec = Gem::Specification.new do |s|
   s.name = "shove"
-  s.version = "0.52"
-  s.date = "2011-03-26"
+  s.version = "1.0.1"
+  s.date = "2012-02-08"
   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.homepage = "https://github.com/shove/shove-ruby"
   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("commander", ">= 4.0.3")
-  s.add_dependency("yajl-ruby", ">= 0.8.1")
+  s.add_dependency("em-http-request", ">= 1.0.0")
+  s.add_dependency("em-ws-client", ">= 0.1.1")
+  s.add_dependency("yajl-ruby", ">= 1.1.0")
+  s.add_dependency("confstruct", ">= 0.2.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/app_directory_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + "/helper"
+
+module Shove
+
+  # Mock standard in (for CLI app)
+  class MockStdin
+
+    def initialize *msgs
+      @msgs = msgs
+    end
+
+    def gets
+      "#{@msgs.shift}\r\n"
+    end
+
+  end
+
+  describe AppDirectory do
+
+    before do |context|
+      VCR.insert_cassette context.example.metadata[:description_args].first
+    end
+
+    after do |context|
+      VCR.eject_cassette
+    end
+
+    it "should configure the default" do
+      system "rm /tmp/shove.yml"
+      dir = AppDirectory.new(MockStdin.new("test","test"), "/tmp/shove.yml")
+      config = dir.default
+      config[:app_id].should == "test"
+      config[:app_key].should == "test"
+      FileTest.exist?("/tmp/shove.yml").should == true
+    end
+
+    it "should configure the from the previous test" do
+      dir = AppDirectory.new(MockStdin.new, "/tmp/shove.yml")
+      config = dir.get_config "test"
+      config[:app_id].should == "test"
+      config[:app_key].should == "test"
+    end
+
+    it "should save an app" do
+      dir = AppDirectory.new(MockStdin.new, "/tmp/shove.yml")
+      dir.put "id1", "key1"
+      dir.put "id2", "key2"
+      dir.put "id3", "key3"
+      dir.apps.size.should == 4
+    end
+
+    it "should update an app" do
+      dir = AppDirectory.new(MockStdin.new, "/tmp/shove.yml")
+      dir.put "id2", "key9"
+      dir.key("id2").should == "key9"
+    end
+
+    it "should update the default app" do
+      dir = AppDirectory.new(MockStdin.new, "/tmp/shove.yml")
+      dir.default = "id2"
+      dir.app.should == "id2"
+      dir.default()[:app_key].should == "key9"
+    end
+
+  end
+end

data/spec/cassettes/should_authorize_oneself.yml

@@ -0,0 +1,24 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://:test@api.shove.dev:8080/apps/test/hosts
+    body: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: Ok
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '19'
+    body: ! '["test-1","test-2"]'
+    http_version: !!null 
+  recorded_at: Fri, 17 Feb 2012 03:09:18 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/should_be_able_to_authorize_with_the_server.yml

@@ -0,0 +1,24 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://:test@api.shove.dev:8080/apps/test/validate
+    body: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: Ok
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '32'
+    body: ! '{"code":"200 Ok","details":"Ok"}'
+    http_version: !!null 
+  recorded_at: Fri, 17 Feb 2012 01:53:24 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/should_cancel_a_binding.yml

@@ -0,0 +1,24 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://:test@api.shove.dev:8080/apps/test/hosts
+    body: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: Ok
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '19'
+    body: ! '["test-1","test-2"]'
+    http_version: !!null 
+  recorded_at: Fri, 17 Feb 2012 01:53:24 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/should_configure_the_default.yml

@@ -0,0 +1,24 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://:test@api.shove.dev:8080/apps/test/validate
+    body: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: Ok
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '32'
+    body: ! '{"code":"200 Ok","details":"Ok"}'
+    http_version: !!null 
+  recorded_at: Fri, 17 Feb 2012 01:53:24 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/should_configure_the_from_the_previous_test.yml

@@ -0,0 +1,24 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.shove.dev:8080/apps/test/validate
+    body: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: Ok
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '39'
+    body: ! '{"code":"503","error":"Not Authorized"}'
+    http_version: !!null 
+  recorded_at: Fri, 17 Feb 2012 02:02:05 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/should_create_a_channel_context.yml

@@ -0,0 +1,24 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://:test@api.shove.dev:8080/apps/test/hosts
+    body: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: Ok
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '19'
+    body: ! '["test-1","test-2"]'
+    http_version: !!null 
+  recorded_at: Fri, 17 Feb 2012 01:53:24 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/should_deny_a_connection.yml

@@ -0,0 +1,24 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://:test@api.shove.dev:8080/apps/test/deny_connect?client=dan
+    body: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: Ok
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '36'
+    body: ! '{"code":"400","error":"Invalid URL"}'
+    http_version: !!null 
+  recorded_at: Fri, 17 Feb 2012 01:53:24 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/should_deny_a_control_to_a_client.yml

@@ -0,0 +1,24 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://:test@api.shove.dev:8080/apps/test/deny_control?client=dan
+    body: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: Ok
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '36'
+    body: ! '{"code":"400","error":"Invalid URL"}'
+    http_version: !!null 
+  recorded_at: Fri, 17 Feb 2012 01:53:24 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/should_deny_a_publishing_to_a_client.yml

@@ -0,0 +1,24 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://:test@api.shove.dev:8080/apps/test/deny_publish?channel=channel&client=dan
+    body: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: Ok
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '36'
+    body: ! '{"code":"400","error":"Invalid URL"}'
+    http_version: !!null 
+  recorded_at: Fri, 17 Feb 2012 01:53:24 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/should_deny_a_subscriptions_to_a_client.yml

@@ -0,0 +1,24 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://:test@api.shove.dev:8080/apps/test/deny_subscribe?channel=channel&client=dan
+    body: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: Ok
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '36'
+    body: ! '{"code":"400","error":"Invalid URL"}'
+    http_version: !!null 
+  recorded_at: Fri, 17 Feb 2012 01:53:24 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/should_deny_publishing_on_a_channel_context.yml

@@ -0,0 +1,24 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://:test@api.shove.dev:8080/apps/test/deny_publish?channel=test&client=dan
+    body: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: Ok
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '36'
+    body: ! '{"code":"400","error":"Invalid URL"}'
+    http_version: !!null 
+  recorded_at: Fri, 17 Feb 2012 01:53:24 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/should_deny_subscriptions_on_a_channel_context.yml

@@ -0,0 +1,24 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://:test@api.shove.dev:8080/apps/test/deny_subscribe?channel=test&client=dan
+    body: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: Ok
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '36'
+    body: ! '{"code":"400","error":"Invalid URL"}'
+    http_version: !!null 
+  recorded_at: Fri, 17 Feb 2012 01:53:24 GMT
+recorded_with: VCR 2.0.0.rc1