pubnub 0.1.2

data/README

@@ -0,0 +1,83 @@
+Pubnub - http://github/pubnub/pubnub-api
+@poptartinc on Twitter, @poptart on Github
+
+## ------------------------------------------
+## PubNub 3.1 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
+    "demo",  ## SECRET_KEY
+    "demo",  ## CIPHER_KEY
+    false    ## SSL_ON?
+)
+
+# -------
+# PUBLISH STRING MESSAGE
+# -------
+# Send Message
+info = pubnub.publish({
+    'channel' => 'hello_world',
+    'message' => 'hey what is up?'
+})
+puts(info)
+
+# -------
+# PUBLISH ARRAY OF MESSAGES
+# -------
+# Send Message
+info = pubnub.publish({
+    'channel' => 'hello_world',
+    'message' => { ["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"] }
+})
+puts(info)
+
+# -------
+# PUBLISH OBJECT OF STRING MESSAGE
+# -------
+# Send Message
+info = pubnub.publish({
+    'channel' => 'hello_world',
+    'message' => { 'text' => 'some text data' }
+})
+puts(info)
+
+# ---------
+# SUBSCRIBE
+# ---------
+# Listen for Messages *NON-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)
+
+# -------
+# UUID
+# -------
+# Generate UUID
+uuid = pubnub.UUID()
+puts(uuid)

data/examples/history_example.rb

@@ -0,0 +1,38 @@
+## -----------------------------------
+## PubNub Ruby API History Example
+## -----------------------------------
+
+## including required libraries
+require 'rubygems'
+require 'pubnub_ruby/pubnub'
+
+## declaring publish_key, subscribe_key, secret_key, cipher_key and ssl flag
+publish_key   = 'demo'
+subscribe_key = 'demo'
+secret_key    = 'demo'
+cipher_key    = 'demo'
+ssl_on        = false
+
+## 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
+  ')
+end
+
+## Create Pubnub Client API (INITIALIZATION)
+puts('Initializing new Pubnub state')
+pubnub = Pubnub.new(publish_key,subscribe_key,secret_key,cipher_key,ssl_on)
+
+## Request Past Publishes (HISTORY)
+puts('Requesting History with history() Function')
+message = pubnub.history({
+  'channel' => 'hello_world',
+  'limit'   => 5
+})
+puts(message)

data/examples/publish_example.rb

@@ -0,0 +1,60 @@
+## -----------------------------------
+## PubNub Ruby API Publish Example
+## -----------------------------------
+
+## including required libraries
+require 'rubygems'
+require 'pubnub_ruby/pubnub'
+
+## declaring publish_key, subscribe_key, secret_key, cipher_key, channel, ssl flag, messages
+publish_key   = 'demo'
+subscribe_key = 'demo'
+secret_key    = 'demo'
+cipher_key    = 'demo'
+ssl_on        = false
+channel       = 'hello_world'
+
+strMessage = "Hi. (顶顅Ȓ)"
+arrMessage = ["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]
+objMessage = {"Name"=>"John","Age"=>"23"}
+
+## Print usage if missing info.
+if !strMessage && arrMessage && objMessage
+  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 "demo" "hey what is up?" true
+  ')
+  exit()
+end
+
+## Pubnub state initialization (INITIALIZATION)
+puts('Initializing new Pubnub state')
+pubnub = Pubnub.new(publish_key,subscribe_key,secret_key,cipher_key,ssl_on)
+
+## Send Message (PUBLISH) -- String
+puts("\nSending message in String format with publish() Function")
+info = pubnub.publish({
+  'channel' => channel,
+  'message' => strMessage
+})
+puts(info)
+
+## Send Message (PUBLISH) -- Array
+puts("\nSending message in Array format with publish() Function")
+info = pubnub.publish({
+  'channel' => channel,
+  'message' => arrMessage
+})
+puts(info)
+
+## Send Message (PUBLISH) -- Object (Dictionary)
+puts("\nSending message in Dictionary Object format with publish() Function")
+info = pubnub.publish({
+  'channel' => channel,
+  'message' => objMessage
+})
+puts(info)

data/examples/subscribe_example.rb

@@ -0,0 +1,43 @@
+## -----------------------------------
+## PubNub Ruby API Subscribe Example
+## -----------------------------------
+
+## including required libraries
+require 'rubygems'
+require 'pubnub_ruby/pubnub'
+
+## declaring publish_key, subscribe_key, secret_key, cipher_key, ssl flag
+publish_key   = 'demo'
+subscribe_key = 'demo'
+secret_key    = 'demo'
+cipher_key    = 'demo'
+ssl_on        = false
+channel       = 'hello_world'
+
+## 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('Initializing new Pubnub state')
+pubnub = Pubnub.new(publish_key,subscribe_key,secret_key,cipher_key,ssl_on)
+
+## Listen for Messages (SUBSCRIBE)
+puts('Listening for new messages with subscribe() Function')
+puts('Press CTRL+C to quit.')
+pubnub.subscribe({
+  'channel'  => channel,
+  'callback' => lambda do |message|
+  puts(message) ## print message
+  return true   ## keep listening?
+  end
+})

data/examples/uuid_example.rb

@@ -0,0 +1,15 @@
+## -----------------------------------
+## PubNub Ruby API UUID Example
+## -----------------------------------
+
+## including required libraries
+require 'rubygems'
+require 'pubnub_ruby/pubnub'
+
+## Generating UUID String
+pubnub=Pubnub.new("","","","",false)
+
+## calling function for UUID generation
+puts('Generating UUID String with UUID() Function')
+uuid=pubnub.UUID()
+puts('UUID: '+uuid)

data/lib/pubnub.rb

@@ -0,0 +1 @@
+require "pubnub_ruby/pubnub"

data/lib/pubnub/pubnub.rb

@@ -0,0 +1,297 @@
+## 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.1 Real-time Push Cloud API
+## -----------------------------------
+
+## including required libraries
+require 'openssl'
+require 'base64'
+require 'open-uri'
+require 'uri'
+require 'net/http'
+require 'json'
+require 'pp'
+require 'rubygems'
+require 'securerandom'
+require 'digest'
+require 'pubnub_ruby/pubnub_crypto'
+require 'eventmachine'
+require 'em-http'
+require 'fiber'
+
+class Pubnub
+  MAX_RETRIES = 3
+  retries=0
+  #**
+  #* 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 string cipher_key required to encrypt messages.
+  #* @param boolean ssl required for 2048 bit encrypted messages.
+  #*
+  def initialize( publish_key, subscribe_key, secret_key, cipher_key, ssl_on )
+    @publish_key   = publish_key
+    @subscribe_key = subscribe_key
+    @secret_key    = secret_key
+    @cipher_key    = cipher_key
+    @ssl           = ssl_on
+    @origin        = 'pubsub.pubnub.com'
+
+    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']
+
+    #encryption of message
+    if @cipher_key.length > 0
+      pc=PubnubCrypto.new(@cipher_key)
+      if message.is_a? Array
+        message=pc.encryptArray(message)
+      else
+        message=pc.encryptObject(message)
+      end
+    else
+      message = args['message'].to_json();
+    end
+
+    ## Sign message using HMAC
+    String signature = '0'
+    if @secret_key.length > 0
+      signature = "{@publish_key,@subscribe_key,@secret_key,channel,message}"
+      digest = OpenSSL::Digest.new("sha256")
+      key = [ @secret_key ]
+      hmac = OpenSSL::HMAC.hexdigest(digest, key.pack("H*"), signature)
+      signature = hmac
+    end
+
+    ## Send Message
+    return _request([
+      'publish',
+      @publish_key,
+      @subscribe_key,
+      signature,
+      channel,
+      '0',
+      message
+    ])
+  end
+
+  #**
+  #* Subscribe
+  #*
+  #* This is NON-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']
+
+    ## Fail if missing channel
+    if !channel
+      puts "Missing Channel."
+      return false
+    end
+
+    ## Fail if missing callback
+    if !callback
+      puts "Missing Callback."
+      return false
+    end
+
+    ## Begin Subscribe
+    loop do
+      begin
+        timetoken = args['timetoken'] ? args['timetoken'] : 0
+
+        ## Wait for Message
+        response = _request([
+          'subscribe',
+          @subscribe_key,
+          channel,
+          '0',
+          timetoken.to_s
+        ])
+
+        messages          = response[0]
+        args['timetoken'] = response[1]
+
+        ## If it was a timeout
+        next if !messages.length
+
+        ## Run user Callback and Reconnect if user permits.
+        ## Capture the message and encrypt it
+        if @cipher_key.length > 0
+          pc = PubnubCrypto.new(@cipher_key)
+          messages.each do |message|
+            if message.is_a? Array
+              message=pc.decryptArray(message)
+            else
+              message=pc.decryptObject(message)
+            end
+            if !callback.call(message)
+              return
+            end
+          end
+        else
+          messages.each do |message|
+            if !callback.call(message)
+              return
+            end
+          end
+        end
+      rescue  Timeout::Error
+      rescue
+        sleep(1)
+      end
+    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'] : 5
+    channel = args['channel']
+
+    ## Fail if bad input.
+    if (!channel)
+      puts 'Missing Channel.'
+      return false
+    end
+
+    ## Get History
+    response = _request([ 'history', @subscribe_key, channel, '0', limit.to_s])
+    if @cipher_key.length > 0
+      myarr=Array.new()
+      response.each do |message|
+        pc=PubnubCrypto.new(@cipher_key)
+        if message.is_a? Array
+          message=pc.decryptArray(message)
+        else
+          message=pc.decryptObject(message)
+        end
+        myarr.push(message)
+      end
+      return myarr
+    else
+      return response
+    end
+  end
+
+  #**
+  #* Time
+  #*
+  #* Timestamp from PubNub Cloud.
+  #*
+  #* @return int timestamp.
+  #*
+  def time()
+    return _request([
+      'time',
+      '0'
+    ])[0]
+  end
+
+  #**
+  #* UUID
+  #*
+  #* Unique identifier generation
+  #*
+  #* @return Unique Identifier
+  #*
+  def UUID()
+    uuid=SecureRandom.base64(32).gsub("/","_").gsub(/=+$/,"")
+  end
+
+  private
+
+  #**
+  #* Request URL
+  #*
+  #* @param array request of url directories.
+  #* @return array from JSON response.
+  #*
+  def _request(request)
+    ## Construct Request URL
+    url = '/' + request.map{ |bit| bit.split('').map{ |ch|
+        ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.index(ch) ?
+        '%' + ch.unpack('H2')[0].to_s.upcase : URI.encode(ch)
+      }.join('') }.join('/')
+
+    url = @origin + url
+    http_response = ''
+
+    EventMachine.run do
+      Fiber.new{
+        http = async_fetch(url)
+        http_response = http.response
+        EventMachine.stop
+      }.resume
+    end
+    JSON.parse(http_response)
+  end
+
+  ## Non-blocking IO using EventMachine
+  def async_fetch(url)
+    f = Fiber.current
+
+    request_options = {
+      :timeout => 310,  # set request timeout
+      :query => {'V' => '3.1', 'User-Agent' => 'Ruby', 'Accept-Encoding' => 'gzip'},  # set request headers
+    }
+
+    http = EventMachine::HttpRequest.new(url).get request_options
+    http.callback { f.resume(http) }
+    http.errback  { f.resume(http) }
+
+    Fiber.yield
+
+    if http.error
+      p [:HTTP_ERROR, http.error]
+    end
+
+    http
+  end
+
+end

data/lib/pubnub/pubnub_crypto.rb

@@ -0,0 +1,142 @@
+## Pubnub cryptography
+
+## including required libraries
+require "openssl"
+require 'digest/MD5'
+require 'base64'
+require 'rubygems'
+require 'json'
+
+class PubnubCrypto
+  #**
+  #* initialize encryption with cipher key, IV and algorithm
+  #*
+  #* @param cipher key (plain text password)
+  #*
+  def initialize(cipher_key)
+    @@alg = "AES-128-CBC"
+    digest = Digest::MD5.new
+    digest.update(cipher_key)
+    @@key = digest.digest
+    @@iv = '0123456789012345'
+    raise 'Key Error' if(@@key.nil? or @@key.size != 16)
+  end
+
+  #**
+  #* encrypt object
+  #*
+  #* @param plain text(message)
+  #* @return cipher text (encrypted text)
+  #*
+  def encryptObject(message)
+    params = Hash.new
+    if message.is_a? String
+      return encrypt(message)
+    else
+      message.each do |key,value|
+        case(key)
+        when(key)
+          params[key] = encrypt(value).chop.reverse.chop.reverse();
+        end
+      end
+      params = params.to_json
+      return params
+    end
+  end
+
+  #**
+  #* decrypt object
+  #*
+  #* @param cipher object (cipher to decrypt)
+  #* @return plain text (decrypted text)
+  #*
+  def decryptObject(cipher_Object)
+    params = {};
+    if cipher_Object.is_a? String
+      return decrypt(cipher_Object)
+    else
+      cipher_Object.each do |key,value|
+        case(key)
+        when(key)
+          params[key] = decrypt(value);
+        end
+      end
+      return params
+    end
+  end
+
+  #**
+  #* encrypt array
+  #*
+  #* @param message to encrypt (array)
+  #* @return cipher text array (encrypted array)
+  #*
+  def encryptArray(message)
+    params = []
+    i=0
+    message.each do |val|
+      case(val)
+      when(val)
+        params[i] = encrypt(val).chop.reverse.chop.reverse();
+        i = i+1
+      end
+    end
+    params = params.to_json
+    return params
+  end
+
+  #**
+  #* decrypt array
+  #*
+  #* @param cipher array (cipher text array to decrypt)
+  #* @return message decrypted (decrypted array)
+  #*
+  def decryptArray(message)
+    params = []
+    i=0
+    message.each do |val|
+      case(val)
+      when(val)
+        params[i] = decrypt(val);
+        i = i+1
+      end
+    end
+    return params
+  end
+
+  #**
+  #* encrypt plain text
+  #*
+  #* @param plain text (string to encrypt)
+  #* @return cipher text (encrypted text)
+  #*
+  def encrypt(message)
+    aes = OpenSSL::Cipher::Cipher.new(@@alg)
+    aes.encrypt
+    aes.key = @@key
+    aes.iv = @@iv
+    @@cipher = aes.update(message)
+    @@cipher << aes.final
+    @@ciphertext = [@@cipher].pack('m')
+    @@ciphertext =  @@ciphertext.strip
+    @@ciphertext =  @@ciphertext.gsub(/\n/,"")
+    @@ciphertext = '"' + @@ciphertext + '"'
+    return @@ciphertext
+  end
+
+  #**
+  #* decrypt plain text
+  #*
+  #* @param cipher text
+  #* @return plain text (decrypted text)
+  #*
+  def decrypt(cipher_text)
+    decode_cipher = OpenSSL::Cipher::Cipher.new(@@alg)
+    decode_cipher.decrypt
+    decode_cipher.key = @@key
+    decode_cipher.iv = @@iv
+    plain_text = decode_cipher.update(cipher_text.unpack('m')[0])
+    plain_text << decode_cipher.final
+    return plain_text
+  end
+end

data/tests/unit_test.rb

@@ -0,0 +1,80 @@
+## 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.1 Real-time Push Cloud API
+## -----------------------------------
+
+## including required libraries
+require 'rubygems'
+require 'pubnub_ruby/pubnub'
+
+## declaring publish_key, subscribe_key, secret_key, cipher_key, message, ssl_on
+publish_key   = ARGV[0] || 'demo'
+subscribe_key = ARGV[1] || 'demo'
+secret_key    = ARGV[2] || 'demo'
+cipher_key    = ARGV[3] || 'demo'
+ssl_on        = false
+channel       = 'hello_world'
+message       = 'Hi. (顶顅Ȓ)'
+
+## ---------------------------------------------------------------------------
+## Create Pubnub Client API (INITIALIZATION)
+## ---------------------------------------------------------------------------
+puts('Initializing new Pubnub state')
+pubnub = Pubnub.new( publish_key, subscribe_key, secret_key,cipher_key, ssl_on )
+
+## ---------------------------------------------------------------------------
+## Unit Test Function
+## ---------------------------------------------------------------------------
+def test( trial, name )
+  trial ? puts('PASS: ' + name) : puts('FAIL: ' + name)
+end
+
+## ---------------------------------------------------------------------------
+## UUID generation
+## ---------------------------------------------------------------------------
+uuid=pubnub.UUID()
+test( uuid.length > 0, 'PubNub Client API UUID: ' + uuid )
+
+## ---------------------------------------------------------------------------
+## PubNub Server Time
+## ---------------------------------------------------------------------------
+timestamp = pubnub.time()
+test( timestamp > 0, 'PubNub Server Time: ' + timestamp.to_s )
+
+## ---------------------------------------------------------------------------
+## PUBLISH
+## ---------------------------------------------------------------------------
+pubish_success = pubnub.publish({
+  'channel' => channel,
+   'message' => message
+})
+test( pubish_success[0] == 1, 'Publish First Message Success' )
+
+## ---------------------------------------------------------------------------
+## HISTORY
+## ---------------------------------------------------------------------------
+history = pubnub.history({
+  'channel' => channel,
+  'limit'   => 5
+})
+puts(history)
+test( history.length >= 1, 'Display History' )
+
+## ---------------------------------------------------------------------------
+## Subscribe
+## ---------------------------------------------------------------------------
+puts('Listening for new messages with subscribe() Function')
+puts('Press CTRL+C to quit.')
+pubnub.subscribe({
+  'channel'  => channel,
+  'callback' => lambda do |message|
+  puts(message) ## print message
+  return true   ## keep listening?
+  end
+})

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: pubnub
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Luke Carpenter / PubNub.com
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        - beta
+        - 4
+        - 1
+        version: 1.0.0.beta.4.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Simply Pubnub.rb in gem format, :require => "pubnub" - ask @PubNub for upgrades.
+email: stephen@pubnub.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- examples/history_example.rb
+- examples/publish_example.rb
+- examples/subscribe_example.rb
+- examples/uuid_example.rb
+- lib/pubnub.rb
+- lib/pubnub/pubnub.rb
+- lib/pubnub/pubnub_crypto.rb
+- tests/unit_test.rb
+- README
+has_rdoc: true
+homepage: http://github.com/pubnub/pubnub-api
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: PubNub Official GEM
+test_files: []
+