magicbroker 0.2.0 → 0.2.1

data/Manifest

@@ -1,5 +1,5 @@
-README.rdoc
+Manifest
+README.md
 Rakefile
-lib/broker.rb
 lib/client/client.rb
-Manifest
+lib/magicbroker.rb

data/README.md

@@ -0,0 +1,88 @@
+
+Ruby gem for subscribing, unsubscribing and sending events to the Magic Broker 2.
+
+## Getting Started:
+
+This gem is already published on rubygems.org, so you can actually just include it in your application. 
+
+### Step 1
+
+If you're writting a Rails application, first add the following line to your Gemfile file:
+
+```
+gem 'magicbroker', '0.2.0'
+```
+
+### Step 2
+
+Then you can include it in any controller like so:
+```
+require 'magicbroker'
+```
+
+### Other ways:
+
+If you want to download the latest version of the gem, fork this repository and you can find the packaged gem in the /pkg directory.
+
+
+## Using the gem where it should be used: in a Rails application
+
+For ease you can declare a global broker entity, in /apps/controllers/application_controller.rb: 
+
+```
+require 'magicbroker'
+def magicbroker
+   @magicbroker = Magicbroker::Client.new("localhost:8800/osgibroker", "clientID", "topic")
+end
+```
+
+Then you can use your global object. For example, sending events:
+
+```
+magicbroker.subscribe()
+hash = {:key1 => "value1", :key2 => "value2", :key3 => "value3"}
+magicbroker.send_events(hash)
+```
+
+Unsubscribing:
+
+```
+magicbroker.unsubscribe()
+```
+
+Querying events (default timeout of 1 second). You can delegate this task to a Resque worker running in the background:
+
+```
+magicbroker.receive_events(nil)
+```
+
+### Using without a global object (many broker objects)
+
+You can initialize a new magicbroker object, subscribe, receive events and send a key/value pair event:
+
+```
+require 'magicbroker'
+myentity = Magicbroker::Client.new("localhost:8800/osgibroker", "clientID", "topic")
+myentity.subscribe()
+myentity.receive_events(20) #define a timeout of 20 seconds
+myhash = {:key => "value"}
+myentity.send_events(myhash)
+```
+
+## Installing from source
+
+This gem was built using 'echoe', to install the gem in your system run:
+
+```
+rake manifest #To first test the file.
+rake install #To install in your system.
+``` 
+
+## Publishing to RubyForge
+
+ATTENTION: this is only for developers. You can publish the gem to rubygems.org by running the task:
+
+```
+rake release
+```
+

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('magicbroker', '0.2.0') do |p|
+Echoe.new('magicbroker', '0.2.1') do |p|
   p.description    = "The MAGIC-Broker-2 gem"
   p.url            = "https://github.com/magic-liam/broker-gem-0.2.0.git"
   p.author         = "Roberto Calderon"

data/lib/client/client.rb

@@ -1,7 +1,7 @@
 require 'net/http'
 require 'uri'
 
-module Broker
+module Magicbroker
 
   class Client
       
@@ -29,7 +29,14 @@ module Broker
         Net::HTTP.get_print URI.parse(servlet)
         print servlet
       end
-    
+
+      def receive_events(t)
+	t.nil? ? t=1 : t=t	
+	print
+	servlet = 'http://'+@server+'/event?clientID='+@clientID+'&topic='+@topic+'&timeOut='+t.to_s()
+        Net::HTTP.get_print URI.parse(servlet)
+        print servlet
+      end
+
   end
-  
-end
+end

data/lib/{broker.rb → magicbroker.rb}

@@ -1,3 +1,3 @@
-module Broker
+module Magicbroker
     autoload :Client, 'client/client' 
 end

data/magicbroker.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = "magicbroker"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roberto Calderon"]
   s.date = "2012-08-11"
   s.description = "The MAGIC-Broker-2 gem"
   s.email = "roberto@robertocalderon.ca"
-  s.extra_rdoc_files = ["README.rdoc", "lib/broker.rb", "lib/client/client.rb"]
-  s.files = ["README.rdoc", "Rakefile", "lib/broker.rb", "lib/client/client.rb", "Manifest", "magicbroker.gemspec"]
+  s.extra_rdoc_files = ["README.md", "lib/client/client.rb", "lib/magicbroker.rb"]
+  s.files = ["Manifest", "README.md", "Rakefile", "lib/client/client.rb", "lib/magicbroker.rb", "magicbroker.gemspec"]
   s.homepage = "https://github.com/magic-liam/broker-gem-0.2.0.git"
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Magicbroker", "--main", "README.rdoc"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Magicbroker", "--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubyforge_project = "magicbroker"
   s.rubygems_version = "1.8.24"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magicbroker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -16,15 +16,15 @@ email: roberto@robertocalderon.ca
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
-- lib/broker.rb
+- README.md
 - lib/client/client.rb
+- lib/magicbroker.rb
 files:
-- README.rdoc
+- Manifest
+- README.md
 - Rakefile
-- lib/broker.rb
 - lib/client/client.rb
-- Manifest
+- lib/magicbroker.rb
 - magicbroker.gemspec
 homepage: https://github.com/magic-liam/broker-gem-0.2.0.git
 licenses: []
@@ -35,7 +35,7 @@ rdoc_options:
 - --title
 - Magicbroker
 - --main
-- README.rdoc
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement

data/README.rdoc

@@ -1 +0,0 @@
-Ruby gem for subscribing, unsubscribing and sending events to the Magic Broker 2