neighborparrot 0.2.0 → 0.3.0

data/Gemfile

@@ -11,3 +11,8 @@ group :development do
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
 end
+
+
+group :test do
+  gem 'faker'
+end   

data/Gemfile.lock

@@ -2,7 +2,10 @@ GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.3)
+    faker (1.0.1)
+      i18n (~> 0.4)
     git (1.2.5)
+    i18n (0.6.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -23,6 +26,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0.0)
+  faker
   jeweler (~> 1.6.4)
   rcov
   rspec (~> 2.3.0)

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/neighborparrot/esparrot.rb

@@ -0,0 +1,92 @@
+require 'pp'
+class ESParrot
+  include Neighborparrot
+  
+  # Open a persistent connection to the Neighbor in a new
+  # thread and return true if all works  unless :foreground
+  # options is true.
+  # Current options to the connectio are:
+  #
+  # @param [String] channel to connect
+  # @param [Hash] Params for the connection. this params can be:
+  # * :foreground [Boolean] run the connection in the foreground
+  #     stoping the clode flow until the connection is closed by server or
+  #     another thread call close
+  # * :api_id => Your api ID in neighborparrot.com
+  # * :api_key => Your api key
+  # * :server => Server to connect (Only for development)
+  def open(channel, params={})
+    params = Neighborparrot.configuration.merge(params)
+    return false if connected?
+    if ! params[:foreground] == true
+      close if @current_thread # If previus thread but closed connection, kill it
+      @current_thread = Thread.new(channel, params) do | channel, params|
+        open_connection channel, params
+      end
+      return true
+    else
+      open_connection channel, params
+    end
+  end
+  
+  # @return true if a connection exists and is started
+  def connected?
+    @connection && @connection.started?
+  end
+  
+  # close the active connection
+  def close
+    return unless connected?
+    @connection.finish()
+    @current_thread.kill
+    @current_thread = nil
+  end
+  
+  # Define a block called on message received
+  # The received message is passed to the block as a var
+  def on_message(&block)
+    @on_message_blk = block
+  end
+  
+  # Define a block called on error
+  # An optional param with the error should be pass if present
+  def on_error(&block)
+    @on_error_blk = block
+  end
+  
+  # Define a block called on connection closed
+  def on_close(&block)
+    @on_close_blk = block
+  end
+  
+  # Define a block called on connect
+  def on_connect(&block)
+    @on_connect_blk = block
+  end
+
+  private
+  
+  # Open a persistent connection to the neighbor
+  # TODO: Refactor, EM??
+  def open_connection(channel, params={})
+    begin
+      uri = URI(params[:server])
+      Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        http.read_timeout = 9999999999999999 # TODO Fix this
+        request = Net::HTTP::Get.new URI.escape("/open?channel=#{channel}")
+        @connection = http
+        @on_connect_blk.call if @on_connect_blk
+        http.request request do |response|
+          response.read_body do |chunk|
+            if chunk.start_with? "data:"
+              @on_message_blk.call(chunk[5..-3]) if @on_message_blk # Remove data: and \n\n
+            end
+          end
+        end
+      end
+    rescue      
+      @on_error_blk.call($!) if @on_error_blk      
+    end      
+    @on_close_blk.call if @on_close_blk
+  end
+end

data/lib/neighborparrot/post.rb

@@ -0,0 +1,31 @@
+module Neighborparrot
+
+  # Post a message to a channel
+  # Raise exception if channel is not setted
+  # If empty data, refuse to send nothing
+  # @param [String] channel: The channel name
+  # @param [String] string to send
+  # @param [Hash] params
+  # * :api_id => Your api ID in neighborparrot.com
+  # * :api_key => Your api key
+  # * :server => Server to connect (Only for development)
+  # @return [Boolean] true if sended
+  def self.post(channel, data, params={})
+    raise "Channel can't be nil" if channel.nil? || channel.length == 0
+    return false if data.nil? || data.length == 0
+    params = self.configuration.merge params
+    self.check_params params
+
+    uri = URI(params[:server])
+    Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+      request = Net::HTTP::Post.new('/post')
+      request.set_form_data(params.merge({ :channel => channel, :data => data }))
+      response = http.request(request)
+      return true if response.body == "Ok"
+    end
+  end
+
+  def post(channel, data, params={})
+    Neighborparrot.post(channel, data, params)
+  end
+end

data/lib/neighborparrot.rb

@@ -1,115 +1,32 @@
-class Neighborparrot
-  require 'net/http'
-  require 'uri'
-  NEIGHBOR_PROTOCOL = "http"
-  NEIGHBOR_HOST = "neighborparrot.net"
-  NEIGHBOR_PORT = 80
-  POST_URL = URI.parse("#{NEIGHBOR_PROTOCOL}://#{NEIGHBOR_HOST}:#{NEIGHBOR_PORT}/post")
+require 'net/http'
+require 'net/https'
+require 'uri'
 
-  # Create a new instance of the client
-  # @param [String] key: The key assigned to your account
-  # in neighborparrot.com site
-  def initialize(key)
-    raise "Invalid key" if key.nil? || key.length == 0
-    @key = key
-  end
+module Neighborparrot
 
-  # Post a message to a channel
-  # Raise exception if channel is not setted
-  # If empty data, refuse to send nothing
-  # Raise exception if error
-  # @param [String] channel: The channel name
-  # @param [String] string to send
-  def post(channel, data)
-    raise "Channel can't be nil" if channel.nil? || channel.length == 0
-    return false if data.nil? || data.length == 0
-    params = { :key => @key, :channel => channel, :data => data }
-    res = Net::HTTP.post_form(POST_URL, params)
-    raise "Error when post to the neighborparrot: #{res.value}" unless res.nil? || res.is_a?(Net::HTTPSuccess)
-    return true
+  # Setup the configuration options
+  # * :api_id => Your api ID in neighborparrot.com
+  # * :api_key => Your api key
+  # * :server => Server to connect (Only for development)
+  def self.configure(params={})
+    @@config.merge! params
   end
 
-  # Open a persistent connection to the Neighbor in a new
-  # thread and return true if all works  unless :foreground
-  # options is true.
-  # Current options to the connectio are:
-  # :foreground [Boolean] run the connection in the foreground
-  # stoping the clode flow until the connection is closed by server or
-  # another thread call close
-  #
-  # @param [String] channel to connect
-  # @param [Hash] Options to the connection
-  def open(channel, options={})
-    return false if connected?
-
-    if ! options[:foreground] == true
-      close if @current_thread # If previus thread but closed connection kill it
-      @current_thread = Thread.new(channel, options) do | channel, options|
-        open_connection channel, options
-      end
-      return true
-    else
-      open_connection channel, options
-    end
+  # Return settings
+  def self.configuration
+    @@config
   end
 
-  # @return true if a connection exists and is started
-  def connected?
-    @connection && @connection.started?
-  end
+  private
 
-  # close and active connection
-  def close
-    return unless connected?
-    @connection.finish()
-    @current_thread.kill
-    @current_thread = nil
-  end
+  DEFAULT_SERVER = 'https://neighborparrot.net'
+  @@config = { :server => DEFAULT_SERVER }
 
-  # Define a block called on message received
-  # The received message is passed to the block as a var
-  def on_message(&block)
-    @on_message_blk = block
-  end
-
-  # Define a block called on error
-  # An optional param with the error should be pass if present
-  def on_error(&block)
-    @on_error_blk = block
-  end
-
-  # Define a block called on connection closed
-  def on_close(&block)
-    @on_close_blk = block
-  end
-
-  # Define a block called on connect
-  def on_connect(&block)
-    @on_connect_blk = block
-  end
-
-  # Open a persistent connection to the neighbor
-  #
-  def open_connection(channel, options={})
-    begin
-      Net::HTTP.start(NEIGHBOR_HOST, NEIGHBOR_PORT) do |http|
-        http.read_timeout = 9999999999999999 # TODO Fix this
-        request = Net::HTTP::Get.new "/open?channel=#{channel}"
-        @connection = http
-        @on_connect_blk.call if @on_connect_blk
-        http.request request do |response|
-          response.read_body do |chunk|
-            if chunk.start_with? "data:"
-              data = chunk[5..-3]
-              @on_message_blk.call(data) if @on_message_blk
-            end
-          end
-        end
-      end
-    rescue
-      @on_error_blk.call($!) if @on_error_blk
-      return
-    end
-    @on_close_blk.call if @on_close_blk
+  def self.check_params(p)
+    raise "ERROR# Neighborparrot: api_id can't be nil" if p[:api_id].nil? || p[:api_id].length == 0
+    raise "ERROR# Neighborparrot: api_key can't be nil" if p[:api_key].nil? || p[:api_key].length == 0
   end
 end
+
+require 'neighborparrot/post'
+require 'neighborparrot/esparrot'

data/neighborparrot.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "neighborparrot"
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eloy Gomez"]
+  s.date = "2012-01-06"
+  s.description = "Send messages to the neighborparrot event source service"
+  s.email = "eloy@indeos.es"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/neighborparrot.rb",
+    "lib/neighborparrot/esparrot.rb",
+    "lib/neighborparrot/post.rb",
+    "neighborparrot.gemspec",
+    "spec/esparrot_spec.rb",
+    "spec/neighborparrot_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/helpers.rb"
+  ]
+  s.homepage = "http://neighborparrot.com"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Ruby client for the Neighborparrot"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/esparrot_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Neighborparrot::ESParrot" do
+  before :all do
+    api_id = 'test-id'
+    api_key = 'api_key'
+    Neighborparrot.configure({ :api_id => api_id, :api_key => :api_key })
+  end
+
+  before :each do
+    @parrot = ESParrot.new
+  end
+
+  describe "Neighborparrot::ESParrot#open" do
+    after :each do
+      @parrot.close
+    end
+
+    it "should open a connection with correct values" do
+      connected = false
+      @parrot.on_connect do
+        connected = true
+      end
+      @parrot.open('test')
+      sleep(2)
+      connected.should be_true
+    end
+
+    it "should receive messages" do
+      received = nil
+      @parrot.on_message do |msg|
+        received = msg
+      end
+      @parrot.open('test')
+      sleep(2)
+      text = Faker::Lorem.paragraph(30)
+      @parrot.post('test', text)
+      sleep(1)
+      received.should eq text
+    end
+
+    it "should return false if already a connection active" do
+      @parrot.open('test')
+      sleep(2)
+      @parrot.open('other test').should be_false
+    end
+  end
+
+  describe "Neighborparrot::ESParrot#close" do
+    it "should close a connection" do
+      @parrot.open('test')
+      sleep(2)
+      @parrot.close()
+      @parrot.connected?.should be_false
+    end
+  end
+
+  describe "Neighborparrot::ESParrot#connected?" do
+    it "should be false before connected" do
+      @parrot.connected?.should be_false
+      @parrot.close
+    end
+
+    it "should be true when connected" do
+      @parrot.open('test')
+      sleep(2)
+      @parrot.connected?.should be_true
+      @parrot.close
+    end
+  end
+end

data/spec/neighborparrot_spec.rb

@@ -2,107 +2,40 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Neighborparrot" do
   before :each do
-    @key = 'test_key'
-    @parrot = Neighborparrot.new(@key)
+    api_id = 'test-id'
+    api_key = 'api_key'
+    Neighborparrot.configure({ :api_id => api_id, :api_key => :api_key })
   end
 
   describe "Neigborparrot#post" do
-    it "should rails exception when instantiate without key" do
-      expect { Neighborparrot.new() }.to raise_error
+    it 'should return true if no errors' do
+      test_post.should be_true
     end
 
-    it "should rails exception when nil key" do
-      expect { Neighborparrot.new(nil) }.to raise_error
+    it "should rails exception without id" do
+      Neighborparrot.configure({ :api_key => nil })
+      expect { test_post }.to raise_error
     end
 
-    it "should rails exception when empty key" do
-      expect { Neighborparrot.new('') }.to raise_error
-    end
-
-    it "should send post request with valid parameters" do
-      expec_params = { :key => @key, :channel => 'test', :data => 'test string' }
-      url =  URI.parse('http://neighborparrot.net/post')
-      Net::HTTP.should_receive(:post_form).with(url, expec_params)
-      @parrot.post(expec_params[:channel], expec_params[:data])
+    it "should rails exception  without key" do
+    Neighborparrot.configure({:api_id => nil})
+      expect { test_post }.to raise_error
     end
 
     it "should raise exception with nill channel" do
-      expect { @parrot.post(nil, 'test string') }.to raise_error
+      expect { Neighborparrot.post(nil, 'test string') }.to raise_error
     end
 
     it "should raise exception with empty channel" do
-      expect { @parrot.post('', 'test string') }.to raise_error
+      expect { Neighborparrot.post('', 'test string') }.to raise_error
     end
 
     it "should not send message with nil data" do
-      Net::HTTP.should_not_receive(:post_form)
-      @parrot.post('test-channel', nil)
+      Neighborparrot.post('test-channel', nil).should be_false
     end
 
     it "should not send message with empty data" do
-      Net::HTTP.should_not_receive(:post_form)
-      @parrot.post('test-channel', '')
-    end
-
-    # TODO
-    it "should raise exception if can't send the request"
-
-  end
-
-  describe "Neigborparrot#open" do
-    after :each do
-      @parrot.close
-    end
-
-    it "should open a connection with correct values" do
-      connected = false
-      @parrot.on_connect do
-        connected = true
-      end
-      @parrot.open('test')
-      sleep(2)
-      connected.should be_true
-    end
-
-    it "should receive messages" do
-      received = nil
-      @parrot.on_message do |msg|
-        received = msg
-      end
-      @parrot.open('test')
-      sleep(2)
-      @parrot.post('test', 'message')
-      sleep(1)
-      received.should eq 'message'
-    end
-
-    it "should return false if already a connection active" do
-      @parrot.open('test')
-      sleep(2)
-      @parrot.open('other test').should be_false
-    end
-  end
-
-  describe "Neigborparrot#close" do
-    it "should close a connection" do
-      @parrot.open('test')
-      sleep(2)
-      @parrot.close()
-      @parrot.connected?.should be_false
-    end
-  end
-
-  describe "Neigborparrot#connected?" do
-    it "should be false before connected" do
-      @parrot.connected?.should be_false
-      @parrot.close
-    end
-
-    it "should be true when connected" do
-      @parrot.open('test')
-      sleep(2)
-      @parrot.connected?.should be_true
-      @parrot.close
+      Neighborparrot.post('test-channel', '').should be_false
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,12 +1,14 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
-require 'neighborparrot'
+require 'faker'
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/neighborparrot')
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  
+
 end

data/spec/support/helpers.rb

@@ -0,0 +1,4 @@
+# Post 'test' string to 'test_channel'
+def test_post
+  Neighborparrot.post('test_channel', 'test')
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neighborparrot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-02 00:00:00.000000000Z
+date: 2012-01-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &15247940 !ruby/object:Gem::Requirement
+  requirement: &26510820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *15247940
+  version_requirements: *26510820
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &15247200 !ruby/object:Gem::Requirement
+  requirement: &26510280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *15247200
+  version_requirements: *26510280
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &15246640 !ruby/object:Gem::Requirement
+  requirement: &26509780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *15246640
+  version_requirements: *26509780
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &15245900 !ruby/object:Gem::Requirement
+  requirement: &26509200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15245900
+  version_requirements: *26509200
 description: Send messages to the neighborparrot event source service
 email: eloy@indeos.es
 executables: []
@@ -72,8 +72,13 @@ files:
 - Rakefile
 - VERSION
 - lib/neighborparrot.rb
+- lib/neighborparrot/esparrot.rb
+- lib/neighborparrot/post.rb
+- neighborparrot.gemspec
+- spec/esparrot_spec.rb
 - spec/neighborparrot_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers.rb
 homepage: http://neighborparrot.com
 licenses:
 - MIT
@@ -89,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3143593421196085716
+      hash: -3144654155739837993
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: