eotb 0.2.0 → 0.2.1

data/README.rdoc

@@ -0,0 +1,74 @@
+= EotB Gem
+
+Rails plugin which allow you easily track and observe your apps.
+
+== Installation
+
+Install gem in traditional way
+
+	$ gem install eotb
+
+Install gem from GitHub repository
+
+	$ git clone git://github.com/Quirke/eotb_rails_plugin.git
+	$ cd eotb_rails_plugin
+	$ rake build
+	$ gem install ./pkg/eotb-0.2.0.gem
+
+Add this line to Gemfile in your rails application
+
+	gem 'eotb'
+
+And run
+
+	$ bundle install
+
+=== Getting API Key
+
+Create new account on Eotb website and add new application by clicking "Applications » Add application".
+As a result you will get API Key of your application.
+
+== Using in your apps
+
+Add file <tt>eotb.rb</tt> in directory <tt>config/initializers</tt> of your rails application with content:
+
+	require 'Eotb'
+	Eotb.configure("your_api_key", "host", "port") # default host and port are 127.0.0.1 and 3000
+
+Register events by:
+
+	Eotb.register_event("user", "did_sth", {:username => "John", :time => "12:39:00"}) # actor, action, subject
+
+=== Examples
+
+Register actor and his action
+	
+	Eotb.register_event("user", "registered")
+
+Register subject of event (<b>it must be a Hash!</b>)
+
+	Eotb.register_event("user", "registered", {:username => "John", :when => "today"})
+
+Use Symbols instead of Strings
+
+	Eotb.register_event(:admin, :deleted, {:what => "News", :category => "Ruby"})
+
+You can register any type of objects (for example Arrays) by using <tt>to_actor</tt> and <tt>to_subject</tt> methods
+
+	Eotb.register_event(["User", "Admin"].to_actor, :connected, {:values => [28, 3]}.to_subject)
+
+	Eotb.register_event(Object.new.to_actor, :fed, {:pet => Dog.new}.to_subject)
+
+Parse subject to JSON by
+
+	{:username => "John"}.to_subject.to_json
+
+And inspect your actors and subjects
+
+	"Josh".to_actor.inspect
+
+	{:username => "John"}.to_subject.inspect
+
+== Copyright
+
+Copyright (c) 2010 Ragnarson. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/eotb.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{eotb}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ragnarson"]
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.email = %q{bartlomiej.kozal@ragnarson.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README"
+     "README.rdoc"
   ]
   s.files = [
     ".document",
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
      "Gemfile",
      "Gemfile.lock",
      "LICENSE",
-     "README",
+     "README.rdoc",
      "Rakefile",
      "VERSION",
      "eotb.gemspec",

data/lib/eotb.rb

@@ -19,10 +19,10 @@ class Eotb
     api_key = { "event[app_id]" => @@api_key }
     action = { "event[action]" => action }
     actor = { "event[actor]" => actor }
+    subject_to_post = {}
+    subject.each { |key, value| subject_to_post["event[subject][#{key.to_s}]"] = value.to_s }
     
-    subject.each { |key, value| subject["event[subject][#{key.to_s}]"] = value.to_s }
-    
-    event = api_key.merge(actor).merge(action).merge(subject)
+    event = api_key.merge(actor).merge(action).merge(subject_to_post)
     @@post.set_form_data(event)
     Net::HTTP.new(@@uri.host, @@uri.port).start.request(@@post)
   end

data/spec/eotb_spec.rb

@@ -4,7 +4,7 @@ describe Eotb do
   
   before(:each) do
     @response = "302"
-    Eotb.configure("4c30fc21b3dfae0b18000078")
+    Eotb.configure("4c3128cfb3dfae0b180000e8")
   end
   
   it "should register only two arguments" do
@@ -24,7 +24,7 @@ describe Eotb do
   end
   
   it "should generate JSON from subject" do
-    {:username => "John"}.to_subject.to_json.should == JSON.generate({:username => "String"})
+    {:username => "John"}.to_subject.to_json.should == JSON.generate({:username => "John"})
   end
   
   # it "should parse JSON from subject" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: eotb
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Ragnarson
@@ -58,14 +58,14 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README
+- README.rdoc
 files: 
 - .document
 - .gitignore
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README
+- README.rdoc
 - Rakefile
 - VERSION
 - eotb.gemspec

data/README

@@ -1,44 +0,0 @@
-EotB Gem
-========
-Rails plugin which allow you easily track and observe your apps.
-
-Installation
-------------------
-* Install gem in traditional way:
-
-$ gem install eotb
-
-* Install gem from GitHub repository:
-
-$ git clone git://github.com/Quirke/eotb_rails_plugin.git
-$ cd eotb_rails_plugin
-$ rake build
-$ gem install ./pkg/eotb-0.1.3.gem
-
-* Add this line to Gemfile in your rails application:
-
-gem 'eotb'
-
-and run
-
-$ bundle install
-
-Getting API KEY:
-------------------
-Register your application on EOTB site by clicking "New application" and giving application name in text field.
-As a result you will get API KEY of your application.
-
-Using in your apps
-------------------
-Add file eotb.rb in directory config/initializers of your rails application with content:
-
-require 'Eotb'
-Eotb.configure("your_api_key", "host", "port") # default host and port are 127.0.0.1 and 3000
-
-Register events by:
-
-Eotb.register_event("user", "did_sth", {:username => "John", :time => "12:39:00"}) # Eotb.register_event(actor, action, subject)
-
-Copyright
-=========
-Copyright (c) 2010 Ragnarson. See LICENSE for details.