brm-ruby-logger 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 mathieuravaux
+
+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,17 @@
+= brm-ruby-logger
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 mathieuravaux. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "brm-ruby-logger"
+    gem.summary = "Ruby event logger for the BRM real-time analytics and BI solution"
+    gem.description = ""
+    gem.email = "mathieu.ravaux@gmail.com"
+    gem.homepage = "http://github.com/mathieuravaux/brm-ruby-logger"
+    gem.authors = ["mathieuravaux"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "bunny"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "brm-ruby-logger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/brm-ruby-logger.rb

@@ -0,0 +1,69 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require "rubygems"
+require "bunny"
+require "active_support"
+require "pp"
+
+require "logger/event.rb"
+
+module BrmLogger
+  VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).chomp
+
+  class Logger
+    attr_accessor :connection, :user_id, :facet_id, :application
+  
+    def sequence_number
+      @sequence_number ||= 0
+      @sequence_number += 1
+    end
+
+    def initialize(user_id, application,  *args)
+     @user_id = user_id
+     @application = application
+     
+     bunny_options = args.extract_options!
+     @connection = Bunny.new bunny_options
+     @connection.start
+    end
+
+    def disconnect()
+      @connection.stop
+    end
+
+    def event(eventName, data=nil, context=nil, event_ref="")
+      event = HashWithIndifferentAccess.new
+      event["data"] = data || {}
+      event["context"] = context || {}
+      
+      
+      event["data"]["agent"] = {:id => facet_id, :type => "facet"} if facet_id
+
+      if user_id
+        event["data"]["agent"] ||= {:id => user_id, :type => "user"}
+        event["context"]["userID"] = user_id
+      end
+      
+      event["metaData"] = {
+        "timestamp" => Time.now.to_i * 1000,
+        "eventName"  => $eventName,
+        "application" => application,
+        "loggerVersion" => VERSION,
+        "loggerType" => "ruby",
+        "sequenceNumber" => sequence_number
+      }
+
+      event["metaData"]["eventRef"] = event_ref
+
+      send event
+    end
+    
+    
+    
+    private
+    def send event
+      
+    end
+  end
+
+end

data/lib/logger/event.rb

@@ -0,0 +1,142 @@
+module BrmLogger
+  class Logger
+
+    def message type, recipients, msg, context=nil, event_ref=nil
+      data = {
+        "message" => msg,
+        "recipients" => recipients,
+        "type" => type
+      }
+      event "Message", data, context, event_ref
+    end
+
+
+    def action(type, context=nil, event_ref="")
+      event "Action", { "type" => type }, context, event_ref
+    end
+
+
+    def sign_in(service_name, agent_id=nil, agent_type=nil, context=nil, event_ref="")
+      session_event("start", service_name, agent_id, agent_type, context, event_ref)
+    end
+
+
+    def sign_out(service_name, agent_id=nil, agent_type=nil, context=nil, event_ref="")
+      session_event("end", service_name, agent_id, agent_type, context, event_ref)
+    end
+
+    def sign_in_failed(service_name, agent_id=nil, agent_type=nil, context=nil, event_ref="")
+      session_event("failed", service_name, agent_id, agent_type, context, event_ref)
+    end
+
+
+    def session_expired(service_name, agent_id=nil, agent_type=nil, context=nil, event_ref="")
+      session_event("expired", service_name, agent_id, agent_type, context, event_ref)
+    end
+
+    def location(location_id=nil, location_type="url", referrer_id=nil, referrer_type="url", context=nil, event_ref="")
+      data = { "location" => { "type" => location_type, "id" => location_id } }
+      data["referrer"] = { "id" => referrer_id, "type" => referrer_type } if referrer_id
+      event("Location", data, context, event_ref)
+    end
+
+    def create(resource_id, resource_type, resource_attributes=nil, context=nil, event_ref="")
+      resource_event("create", resource_id, resource_type, resource_attributes || {}, context, event_ref)
+    end
+
+    def update(resource_id, resource_type, resource_attributes=nil, context=nil, event_ref="")
+      resource_event("update", resource_id, resource_type, resource_attributes || {}, context, event_ref)
+    end
+
+    def delete(resource_id, resource_type, context=nil, event_ref="")
+      resource_event("delete", resource_id, resource_type, {}, context, event_ref)
+    end
+
+    def share(destination, resource_id, resource_type, context=nil, event_ref="")
+      resource = {"id" => resource_id, "type" => resource_type }
+      event("Share", {"resource" => resource, "destination" => destination }, context, event_ref)
+    end
+
+    def message(type, recipients, msg, context=nil, event_ref="")
+      data = { "message" => msg, "recipients" => recipients, "type" => type }
+      event("Message", data, context, event_ref)
+    end
+
+    def connect(type, action, with_id, with_type, attributes=nil, context=nil, event_ref="")
+      data = {
+        "action" => action,
+        "type" => type,
+        "withAgent" => { "id" => with_id, "type" => with_type }
+      }
+      data["attributes"] = attributes if attributes;
+      event("Connect", data, context, event_ref)
+    end
+
+    def transaction(type, resources, from_id, from_type, context=nil, event_ref="")
+      data = {
+        "type" => type,
+        "resources" => resources,
+        "fromAgent" => { "id" => from_id, "type" => from_type }
+      }
+      event("Transaction", data, context, event_ref)
+    end
+
+
+    def system(type, msg="", context=nil, event_ref="")
+      event("System", { "type" => type, "message" => msg }, context, event_ref)
+    end
+
+    def describe(type, resource, context=nil, event_ref="")
+      event("Describe", { "type" => type, "resource" => resource }, context, event_ref)
+    end
+
+
+    def sign_up(service, step_status="success", context=nil, event_ref="")
+      register_event(service, "register", 1, step_status, true, context, event_ref)
+    end
+
+    def unsubscribe(service, context=nil, event_ref="")
+      register_event(service, "unsubscribe", -1, "success", true, context, event_ref)
+    end
+
+    def session_event(type, service_name, agent_id, agent_type, context, event_ref)
+      if type != "start"
+        user_id = nil
+        facet_id = nil
+      elsif agent_id
+        if agent_type == "facet"
+          facet_id = agent_id
+        else
+          user_id = agent_id
+        end
+      end
+
+      event("Session", { "type" => type, "service" => service_name }, context, event_ref)
+    end
+
+
+    def resource_event(type, resource_id, resource_type, attributes=nil, context=nil, event_ref="")
+      resource = attributes || {}
+      resource.update("id" => resource_id, "type" => resource_type)
+      event "Resource", { "resource" => resource, "type" => type }, context, event_ref
+    end
+
+    def register_event(service, step_name, step_num=0, step_status="success", complete=true, context=nil, event_ref="")
+      data = {
+        "service" => service,
+        "step" => {
+          "num" => step_num,
+          "name" => step_name,
+          "status" => step_status
+        },
+        "complete" => complete
+      }
+      event("Register", data, context, event_ref)
+    end
+
+
+
+  end
+end
+
+

data/spec/brm-ruby-logger_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+RABBITMQ_HOST = 'mimesis12.typhon.net'
+RABBITMQ_PORT = 5672
+RABBITMQ_USERNAME = 'guest'
+RABBITMQ_PASSWORD = 'guest'
+RABBITMQ_VHOST = '/'
+
+# RABBITMQ_VHOST = 'bmbubbler_test'
+# RABBITMQ_USERNAME = 'blackmamba'
+# RABBITMQ_PASSWORD = 'blackmamba'
+
+
+
+describe "BrmLogger" do
+  before(:each) do
+    user_id = "123"
+    application = "brm-ruby-logger-tests"
+    @logger = BrmLogger::Logger.new(user_id, application,
+      # :logging => true,
+      :host => RABBITMQ_HOST,
+      :port => RABBITMQ_PORT,
+      :user => RABBITMQ_USERNAME,
+      :pass => RABBITMQ_PASSWORD,
+      :vhost => RABBITMQ_VHOST
+    )
+  end
+  
+  after(:each) do
+    @logger.disconnect
+  end
+  
+  it  "should connect to the QA RabbitMQ" do
+  end
+  
+  it "should send custom events" do
+    @logger.message("think", { "id" => "123", "type" => "facet" }, "Salut");
+  end
+  
+  it "should send generic Action events" do
+    # action (générique), dont envoi de post
+    @logger.action "Salut"
+  end
+  
+  it "should send user sign-ins" do
+    @logger.facet_id = "JeanClaude"
+    @logger.sign_in "test_service"
+  end
+
+  it "should send user account creation events" do
+    @logger.describe "create", {"id" => "123", "type" => "User", "name" => "Bob" }
+  end
+  
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'brm-ruby-logger'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: brm-ruby-logger
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- mathieuravaux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bunny
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: ""
+email: mathieu.ravaux@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/brm-ruby-logger.rb
+- lib/logger/event.rb
+- spec/brm-ruby-logger_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mathieuravaux/brm-ruby-logger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Ruby event logger for the BRM real-time analytics and BI solution
+test_files: 
+- spec/brm-ruby-logger_spec.rb
+- spec/spec_helper.rb