shove 0.2

data/README.md

@@ -0,0 +1,49 @@
+#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
+  
+##Install Step 3
+  Configure shover with your credentials
+  
+  require "shove"
+  
+  Shove.configure(
+    :network => "network",
+    :key => "apikey"
+  )
+
+##Broadcast messages
+
+  # 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
+  
+##Direct messages
+
+  Shove.direct(userid, "hello", "Hello World!") do |response|
+    # handle response
+  end
+
+##Authorize a user
+
+  # authorize user with id userid on channel "default"
+  Shove.authorize(userid, "default") do |response|
+    # handle 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
+  will leverage em-http-request.  Otherwise, the requests fallback to net/http requests.  We recommend
+  using EM if possible.
+  

data/Rakefile

@@ -0,0 +1,6 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/shove/client.rb

@@ -0,0 +1,48 @@
+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 network, key, opts={}
+      @network = network
+      @key = key
+      @auth_header = { "api-key" => key }
+      @secure = opts[:secure] || false
+      @host = opts[:host] || "api.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}/#{@network}/broadcast/#{channel}/#{event}", @auth_header).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}/#{@network}/direct/#{event}/#{uid}", @auth_header).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)
+    end
+    
+    protected
+    
+    def uri
+      (@secure ? "https" : "http") + "://#{@host}"
+    end
+    
+  end
+end

data/lib/shove/request.rb

@@ -0,0 +1,31 @@
+module Shove
+  class Request
+    
+    attr_accessor :url, :headers
+    
+    def initialize url, headers={}
+      self.url = url
+      self.headers = headers
+    end
+    
+    def post params={}, &block
+      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
+      else
+        raise "EM requests only for now."
+      end
+    end
+
+  end
+end
+
+
+

data/lib/shove/response.rb

@@ -0,0 +1,17 @@
+module Shove
+  class Response
+    
+    attr_accessor :status, :message, :error
+    
+    def initialize status, message, error=false
+      self.status = status
+      self.message = message
+      self.error = error
+    end
+    
+    def error?
+      error
+    end
+
+  end
+end

data/lib/shove.rb

@@ -0,0 +1,73 @@
+$:.unshift File.dirname(__FILE__)
+
+require "rubygems"
+require "eventmachine"
+require "em-http"
+require "yaml"
+require "json"
+
+##
+# Shove
+# 
+# See http://shove.io for an account
+module Shove
+  
+  Version = 0.2
+  
+  class << self
+  
+    attr_accessor :config, :client
+    
+    # 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"
+      end
+      
+      self.client = Client.new config[:network], config[:key], 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
+    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
+    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
+    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"
+    end
+    
+  end
+end
+
+require "shove/client"
+require "shove/request"
+require "shove/response"

data/shove.gemspec

@@ -0,0 +1,24 @@
+spec = Gem::Specification.new do |s|
+  s.name = "shove"
+  s.version = "0.2"
+  s.date = "2010-12-16"
+  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.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"
+  ]
+end

data/spec/helper.rb

@@ -0,0 +1,3 @@
+$:.unshift(File.dirname(__FILE__) + "/../lib/")
+
+require "shove"

data/spec/shove_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + "/helper"
+
+describe Shove do
+
+  before do
+    Shove.configure "./shove.yml"
+  end
+
+  it "should have a version" do
+    Shove.const_defined?("Version").should == true
+  end
+
+  it "should have config" do
+    Shove.config["network"].should == "shove"
+  end
+
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: shove
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
+platform: ruby
+authors: 
+- Dan Simpson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-16 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Client side implementation for the shove.io API.  See http://shove.io/documentation
+email: dan@shove.io
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+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
+has_rdoc: true
+homepage: https://github.com/shove/shover
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby gem for leveraging shove.io, the web push platform
+test_files: []
+