brm_client 0.0.1

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 Stephane Bellity
+
+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_client
+
+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 Stephane Bellity. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'metric_fu' rescue LoadError
+  MetricFu::Configuration.run do |config|
+    config.metrics = [:flog, :flay, :reek, :saikuro]
+    config.graphs = [:flog, :flay, :reek]
+    config.graph_engine = :gchart
+  end
+rescue LoadError
+  puts "Metric_fu (or a dependency) not available. Install it with: gem install metric_fu"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "brm_client"
+    gem.summary = "BRM Event logging client"
+    gem.description = ""
+    gem.email = "sbellity@gmail.com"
+    gem.homepage = "http://github.com/sbellity/brm_client"
+    gem.authors = ["Stephane Bellity"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "bunny"
+    gem.add_dependency "mongo", ">= 0.18.3"
+    gem.add_dependency "activesupport"
+    # 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
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+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 = "brm_client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/brm_client/event.rb

@@ -0,0 +1,134 @@
+module BrmClient
+  module Event
+    
+  
+    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/lib/brm_client/gateway/amqp.rb

@@ -0,0 +1,33 @@
+require "bunny"
+
+module BrmClient
+  module Gateway
+    class Amqp
+      attr_reader :connection, :queue
+      
+      def initialize opts
+        @connection = Bunny.new({
+          :logging => opts[:logging] || true,
+          :host => opts[:host] || "localhost",
+          :port => opts[:port] || 5672,
+          :user => opts[:user] || "guest",
+          :pass => opts[:pass] || "guest",
+          :vhost => opts[:vhost] || opts[:application]
+        })
+        
+        @connection.start
+        @queue = @connection.queue "reactor.#{opts[:application]}"
+      end
+      
+      def disconnect
+        @connection.stop
+      end
+      
+      def send_event e
+        @queue.publish(e.to_json)
+      end
+      
+    end
+    
+  end
+end

data/lib/brm_client/gateway/file.rb

@@ -0,0 +1,22 @@
+require "mongo"
+
+module BrmClient
+  module Gateway
+    class File
+      attr_reader :path, :file
+      def initialize opts
+        @path = opts[:path] || "/tmp/#{opts[:application]}.log"
+        @file = open(@path, "w")
+      end
+      
+      def disconnect
+        @file.close
+      end
+      
+      def send_event e
+        @file.write "#{e.to_json}\n"
+      end
+      
+    end
+  end
+end

data/lib/brm_client/gateway/mongo.rb

@@ -0,0 +1,24 @@
+require "mongo"
+
+module BrmClient
+  module Gateway
+    class Mongo
+      attr_reader :connection, :collection
+      def initialize opts
+        @connection = ::Mongo::Connection.new({
+          :host => opts[:host] || "localhost",
+          :port => opts[:port] || ::Mongo::Connection::DEFAULT_PORT
+        })
+        @collection = @connection.db(opts[:db] || opts[:application]).collection(opts[:collection] || "logs")
+      end
+      
+      def disconnect
+      end
+      
+      def send_event e
+        collection.insert(e)
+      end
+      
+    end
+  end
+end

data/lib/brm_client/gateway.rb

@@ -0,0 +1,3 @@
+require "brm_client/gateway/amqp"
+require "brm_client/gateway/mongo"
+require "brm_client/gateway/file"

data/lib/brm_client/logger.rb

@@ -0,0 +1,56 @@
+module BrmClient
+  class Logger
+    include BrmClient::Event
+    
+    def sequence_number
+      @sequence_number ||= 0
+      @sequence_number += 1
+    end
+    
+    attr_reader :gateway, :application, :facet_id, :user_id
+    
+    def initialize(application, gateway_type, *args)
+     @application = application
+     gateway_options = args.extract_options! || {}
+     gateway_options[:application] = application
+     @gateway = BrmClient::Gateway.const_get(gateway_type).new(gateway_options)
+    end
+    
+    def disconnect
+      @gateway.disconnect
+    end
+    
+    private 
+    
+    def send_event e
+      @gateway.send_event(e)
+    end
+    
+    def event(event_name, data=nil, context=nil, event_ref="")
+      event = HashWithIndifferentAccess.new
+      event["data"] = data || {}
+      event["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"  => event_name,
+        "application" => application,
+        "loggerVersion" => VERSION,
+        "loggerType" => "ruby",
+        "sequenceNumber" => sequence_number
+      }
+      event["metaData"]["eventRef"] = event_ref
+      
+      send_event event
+    end
+    
+    
+    
+  end
+end

data/lib/brm_client.rb

@@ -0,0 +1,12 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require "rubygems"
+require "active_support"
+
+require "brm_client/event"
+require "brm_client/logger"
+require "brm_client/gateway"
+
+
+module BrmClient
+  VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).chomp
+end

data/spec/brm_client_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "BrmClient" do
+  
+  before(:each) do 
+    application = "brm_client_test"
+    # @logger = BrmClient::Logger.new(application, "File")
+    # @logger = BrmClient::Logger.new(application, "Amqp", { :host => "10.101.0.215", :vhost => "/" })
+  end
+  
+  after(:each) do
+    @logger.disconnect
+  end
+  
+  it "should send custom events" do
+    10.times { |i| @logger.message("think", { "id" => "123", "type" => "facet" }, "Salut #{i}") }
+  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_client'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: brm_client
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Stephane Bellity
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-10 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: bunny
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.18.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: ""
+email: sbellity@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/brm_client.rb
+- lib/brm_client/event.rb
+- lib/brm_client/gateway.rb
+- lib/brm_client/gateway/amqp.rb
+- lib/brm_client/gateway/file.rb
+- lib/brm_client/gateway/mongo.rb
+- lib/brm_client/logger.rb
+- spec/brm_client_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/sbellity/brm_client
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: BRM Event logging client
+test_files: 
+- spec/brm_client_spec.rb
+- spec/spec_helper.rb