pubnub-ruby 0.0.0

data/README

@@ -0,0 +1,59 @@
+## ---------------------------------------------------
+##
+## YOU MUST HAVE A PUBNUB ACCOUNT TO USE THE API.
+## http://www.pubnub.com/account
+##
+## ----------------------------------------------------
+
+## ------------------------------------------
+## PubNub 3.0 Real-time Cloud Push API - RUBY
+## ------------------------------------------
+##
+## www.pubnub.com - PubNub Real-time Push Service in the Cloud. 
+## http://www.pubnub.com/blog/ruby-push-api
+##
+## PubNub is a Massively Scalable Real-time Service for Web and Mobile Games.
+## This is a cloud-based service for broadcasting Real-time messages
+## to thousands of web and mobile clients simultaneously.
+
+## -------------
+## Ruby Push API
+## -------------
+pubnub = Pubnub.new(
+    "demo",  ## PUBLISH_KEY
+    "demo",  ## SUBSCRIBE_KEY
+    "",      ## SECRET_KEY
+    false    ## SSL_ON?
+)
+
+# -------
+# PUBLISH
+# -------
+# Send Message
+info = pubnub.publish({
+    'channel' => 'hello_world',
+    'message' => { 'text' => 'some text data' }
+})
+puts(info)
+
+# ---------
+# SUBSCRIBE
+# ---------
+# Listen for Messages *BLOCKING*
+pubnub.subscribe({
+    'channel'  => 'hello_world',
+    'callback' => lambda do |message|
+        puts(message) ## print message
+        return true   ## keep listening?
+    end
+})
+
+# -------
+# HISTORY
+# -------
+# Load Previously Published Messages
+messages = pubnub.history({
+    'channel' => 'hello_world',
+    'limit'   => 10
+})
+puts(messages)

data/examples/history-example.rb

@@ -0,0 +1,36 @@
+require '../lib/pubnub'
+
+publish_key   = ARGV[0]
+subscribe_key = ARGV[1]
+ssl_on        = !!ARGV[2]
+
+## Print usage if missing info.
+if !subscribe_key
+    puts('
+    Get API Keys at http://www.pubnub.com/account
+    ==============
+    EXAMPLE USAGE:
+    ==============
+    ruby history-example.rb PUBLISH-KEY SUBSCRIBE-KEY SSL-ON
+    ruby history-example.rb demo demo true
+
+    ')
+    exit()
+end
+
+## -----------------------------------------
+## Create Pubnub Client API (INITIALIZATION)
+## -----------------------------------------
+puts('Creating new Pubnub Client API')
+pubnub = Pubnub.new( publish_key, subscribe_key, nil, ssl_on )
+
+## --------------------------------
+## Request Past Publishes (HISTORY)
+## --------------------------------
+puts('Requesting History with history() Function')
+messages = pubnub.history({
+    'channel' => 'hello_world',
+    'limit'   => 10
+})
+
+puts(messages)

data/examples/publish-example.rb

@@ -0,0 +1,39 @@
+require '../lib/pubnub'
+
+publish_key   = ARGV[0]
+subscribe_key = ARGV[1]
+secret_key    = ARGV[2]
+message       = ARGV[3]
+ssl_on        = !!ARGV[4]
+
+## Print usage if missing info.
+if !message
+    puts('
+    Get API Keys at http://www.pubnub.com/account
+    ==============
+    EXAMPLE USAGE:
+    ==============
+    ruby publish-example.rb PUB-KEY SUB-KEY SECRET-KEY "message text" SSL-ON
+    ruby publish-example.rb demo demo "" "hey what is up?" true
+
+    ')
+    exit()
+end
+
+## -----------------------------------------
+## Create Pubnub Client API (INITIALIZATION)
+## -----------------------------------------
+puts('Creating new Pubnub Client API')
+pubnub = Pubnub.new( publish_key, subscribe_key, secret_key, ssl_on )
+
+## ----------------------
+## Send Message (PUBLISH)
+## ----------------------
+puts('Sending a message with publish() Function')
+info = pubnub.publish({
+    'channel' => 'hello_world',
+    'message' => message
+})
+
+## Print Pretty
+puts(info)

data/examples/subscribe-example.rb

@@ -0,0 +1,38 @@
+require '../lib/pubnub'
+
+publish_key   = ARGV[0]
+subscribe_key = ARGV[1]
+ssl_on        = !!ARGV[2]
+
+## Print usage if missing info.
+if !subscribe_key
+    puts('
+    Get API Keys at http://www.pubnub.com/account
+    ==============
+    EXAMPLE USAGE:
+    ==============
+    ruby subscribe-example.rb PUBLISH-KEY SUBSCRIBE-KEY SSL-ON
+    ruby subscribe-example.rb demo demo true
+
+    ')
+    exit()
+end
+
+## -----------------------------------------
+## Create Pubnub Client API (INITIALIZATION)
+## -----------------------------------------
+puts('Creating new Pubnub Client API')
+pubnub = Pubnub.new( publish_key, subscribe_key, nil, ssl_on )
+
+## -------------------------------
+## Listen for Messages (SUBSCRIBE)
+## -------------------------------
+puts('Listening for new messages with subscribe() Function')
+puts('Press CTRL+C to quit.')
+pubnub.subscribe({
+    'channel'  => 'hello_world',
+    'callback' => lambda do |message|
+        puts(message) ## print message
+        return true   ## keep listening?
+    end
+})

data/lib/pubnub.rb

@@ -0,0 +1,217 @@
+## www.pubnub.com - PubNub realtime push service in the cloud. 
+## http://www.pubnub.com/blog/ruby-push-api - Ruby Push API Blog 
+
+## PubNub Real Time Push APIs and Notifications Framework
+## Copyright (c) 2010 Stephen Blum
+## http://www.pubnub.com/
+
+## -----------------------------------
+## PubNub 3.0 Real-time Push Cloud API
+## -----------------------------------
+
+require 'digest/md5'
+require 'open-uri'
+require 'uri'
+require 'json'
+require 'pp'
+
+class Pubnub
+    #**
+    #* Pubnub
+    #*
+    #* Init the Pubnub Client API
+    #*
+    #* @param string publish_key required key to send messages.
+    #* @param string subscribe_key required key to receive messages.
+    #* @param string secret_key required key to sign messages.
+    #* @param boolean ssl required for 2048 bit encrypted messages.
+    #*
+    def initialize( publish_key, subscribe_key, secret_key, ssl_on )
+        @publish_key   = publish_key
+        @subscribe_key = subscribe_key
+        @secret_key    = secret_key
+        @ssl           = ssl_on
+        @origin        = 'pubsub.pubnub.com'
+        @limit         = 1800
+
+        if @ssl
+            @origin = 'https://' + @origin
+        else
+            @origin = 'http://'  + @origin
+        end
+    end
+
+    #**
+    #* Publish
+    #*
+    #* Send a message to a channel.
+    #*
+    #* @param array args with channel and message.
+    #* @return array success information.
+    #*
+    def publish(args)
+        ## Fail if bad input.
+        if !(args['channel'] && args['message'])
+            puts('Missing Channel or Message')
+            return false
+        end
+
+        ## Capture User Input
+        channel = args['channel']
+        message = args['message'].to_json
+
+        ## Sign Message
+        signature = @secret_key.length > 0 ? Digest::MD5.hexdigest([
+            @publish_key,
+            @subscribe_key,
+            @secret_key,
+            channel,
+            message
+        ].join('/')) : '0'
+
+        ## Fail if message too long.
+        if message.length > @limit
+            puts('Message TOO LONG (' + @limit.to_s + ' LIMIT)')
+            return [ 0, 'Message Too Long.' ]
+        end
+
+        ## Send Message
+        return self._request([
+            'publish',
+            @publish_key,
+            @subscribe_key,
+            signature,
+            channel,
+            '0',
+            message
+        ])
+    end
+
+    #**
+    #* Subscribe
+    #*
+    #* This is BLOCKING.
+    #* Listen for a message on a channel.
+    #*
+    #* @param array args with channel and message.
+    #* @return false on fail, array on success.
+    #*
+    def subscribe(args)
+        ## Capture User Input
+        channel   = args['channel']
+        callback  = args['callback']
+        timetoken = args['timetoken'] ? args['timetoken'] : 0
+
+        ## Fail if missing channel
+        if !channel
+            echo("Missing Channel.\n")
+            return false
+        end
+
+        ## Fail if missing callback
+        if !callback
+            echo("Missing Callback.\n")
+            return false
+        end
+
+        ## Begin Recusive Subscribe
+        begin
+            ## Wait for Message
+            response = self._request([
+                'subscribe',
+                @subscribe_key,
+                channel,
+                '0',
+                timetoken.to_s
+            ])
+
+            messages          = response[0]
+            args['timetoken'] = response[1]
+
+            ## If it was a timeout
+            if !messages.length
+                return self.subscribe(args)
+            end
+
+            ## Run user Callback and Reconnect if user permits.
+            messages.each do |message|
+                if !callback.call(message)
+                    return
+                end
+            end
+
+            ## Keep Listening.
+            return self.subscribe(args)
+        rescue Timeout::Error
+            return self.subscribe(args)
+        rescue
+            sleep(1)
+            return self.subscribe(args)
+        end
+    end
+
+    #**
+    #* History
+    #*
+    #* Load history from a channel.
+    #*
+    #* @param array args with 'channel' and 'limit'.
+    #* @return mixed false on fail, array on success.
+    #*
+    def history(args)
+        ## Capture User Input
+        limit   = +args['limit'] ? +args['limit'] : 10
+        channel = args['channel']
+
+        ## Fail if bad input.
+        if (!channel)
+            echo('Missing Channel')
+            return false
+        end
+
+        ## Get History
+        return self._request([
+            'history',
+            @subscribe_key,
+            channel,
+            '0',
+            limit.to_s
+        ]);
+    end
+
+    #**
+    #* Time
+    #*
+    #* Timestamp from PubNub Cloud.
+    #*
+    #* @return int timestamp.
+    #*
+    def time()
+        return self._request([
+            'time',
+            '0'
+        ])[0]
+    end
+
+    #**
+    #* Request URL
+    #*
+    #* @param array request of url directories.
+    #* @return array from JSON response.
+    #*
+    def _request(request)
+        ## Construct Request URL
+        url = @origin + '/' + request.map{ |bit| bit.split('').map{ |ch|
+            ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.index(ch) ?
+            '%' + ch.unpack('H2')[0].to_s.upcase : URI.encode(ch)
+        }.join('') }.join('/')
+
+        response = ''
+        open(url) do |f|
+            response = f.read
+        end
+
+        return JSON.parse(response)
+    end
+end
+

data/tests/unit-test.rb

@@ -0,0 +1,79 @@
+## www.pubnub.com - PubNub realtime push service in the cloud. 
+## http://www.pubnub.com/blog/ruby-push-api - Ruby Push API Blog 
+
+## PubNub Real Time Push APIs and Notifications Framework
+## Copyright (c) 2010 Stephen Blum
+## http://www.pubnub.com/
+
+## -----------------------------------
+## PubNub 3.0 Real-time Push Cloud API
+## -----------------------------------
+require 'Pubnub'
+
+publish_key   = ARGV[0] || 'demo'
+subscribe_key = ARGV[1] || 'demo'
+secret_key    = ARGV[2] || ''
+ssl_on        = !!ARGV[3]
+
+
+## ---------------------------------------------------------------------------
+## Create Pubnub Client API (INITIALIZATION)
+## ---------------------------------------------------------------------------
+pubnub  = Pubnub.new( publish_key, subscribe_key, secret_key, ssl_on )
+channel = 'ruby-unit-test-' + rand().to_s
+
+
+## ---------------------------------------------------------------------------
+## Unit Test Function
+## ---------------------------------------------------------------------------
+def test( trial, name )
+    trial ? puts('PASS: ' + name) : puts('FAIL: ' + name)
+end
+
+
+## ---------------------------------------------------------------------------
+## PubNub Server Time
+## ---------------------------------------------------------------------------
+timestamp = pubnub.time()
+test( timestamp > 0, 'PubNub Server Time: ' + timestamp.to_s )
+
+
+## ---------------------------------------------------------------------------
+## PUBLISH
+## ---------------------------------------------------------------------------
+first_message  = 'Hi. (顶顅Ȓ)'
+pubish_success = pubnub.publish({
+    'channel' => channel,
+    'message' => first_message
+})
+test( pubish_success[0] == 1, 'Publish First Message Success' )
+
+crazy_channel  = ' ~`!@#$%^&*(顶顅Ȓ)+=[]\\{}|;\':",./<>?abcd'
+pubish_success = pubnub.publish({
+    'channel' => crazy_channel,
+    'message' => crazy_channel
+})
+test( pubish_success[0] == 1, 'Publish First Message Success' )
+
+
+## ---------------------------------------------------------------------------
+## Request Past Publishes (HISTORY)
+## ---------------------------------------------------------------------------
+history = pubnub.history({
+    'channel' => crazy_channel,
+    'limit'   => 1
+})
+test( history.length == 1, 'History Length 2' )
+test( history[0] == crazy_channel, 'History Message UTF8: '  + history[0] )
+
+
+## ---------------------------------------------------------------------------
+## Subscribe
+## ---------------------------------------------------------------------------
+pubnub.subscribe({
+    'channel'  => crazy_channel,
+    'callback' => lambda do |message|
+        puts(message) ## print message
+        return true ## keep listening?
+    end
+})

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: pubnub-ruby
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Luke Carpenter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Simply Pubnub.rb in gem format - ask @lukella for upgrades
+email: orlyowlizere@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- examples/history-example.rb
+- examples/publish-example.rb
+- examples/subscribe-example.rb
+- lib/pubnub.rb
+- tests/unit-test.rb
+- README
+homepage: http://github.com/rubynerd/pubnub
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: PubNub unofficial gem
+test_files: []
+