neighborparrot 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Eloy Gomez
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= neighborparrot
+
+Description goes here.
+
+== Contributing to neighborparrot
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Eloy Gomez. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "neighborparrot"
+  gem.homepage = "http://neighborparrot.com"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby client for the Neighborparrot}
+  gem.description = %Q{Send messages to the neighborparrot event source service}
+  gem.email = "eloy@indeos.es"
+  gem.authors = ["Eloy Gomez"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "neighborparrot #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/neighborparrot.rb

@@ -0,0 +1,115 @@
+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")
+
+  # 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
+
+  # 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
+  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
+  end
+
+  # @return true if a connection exists and is started
+  def connected?
+    @connection && @connection.started?
+  end
+
+  # close and 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
+
+  # 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
+  end
+end

data/spec/neighborparrot_spec.rb

@@ -0,0 +1,108 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Neighborparrot" do
+  before :each do
+    @key = 'test_key'
+    @parrot = Neighborparrot.new(@key)
+  end
+
+  describe "Neigborparrot#post" do
+    it "should rails exception when instantiate without key" do
+      expect { Neighborparrot.new() }.to raise_error
+    end
+
+    it "should rails exception when nil key" do
+      expect { Neighborparrot.new(nil) }.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])
+    end
+
+    it "should raise exception with nill channel" do
+      expect { @parrot.post(nil, 'test string') }.to raise_error
+    end
+
+    it "should raise exception with empty channel" do
+      expect { @parrot.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)
+    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
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require '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

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: neighborparrot
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Eloy Gomez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &15247940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *15247940
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &15247200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *15247200
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &15246640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *15246640
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &15245900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *15245900
+description: Send messages to the neighborparrot event source service
+email: eloy@indeos.es
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/neighborparrot.rb
+- spec/neighborparrot_spec.rb
+- spec/spec_helper.rb
+homepage: http://neighborparrot.com
+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'
+      segments:
+      - 0
+      hash: 3143593421196085716
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby client for the Neighborparrot
+test_files: []