utter_events 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7f9364791c5599be45a3537b0ec6fdcb4070628
-  data.tar.gz: 8acd1e350b764ca069915b659fa4f23d3b371f7a
+  metadata.gz: fb46bae6c354ecba25cfa0706148df5dd12070a6
+  data.tar.gz: 2c62baca84bb188665a375c76817642760ea5117
 SHA512:
-  metadata.gz: dc4044d8813310cf6653e1d39702c8260f37b1c502f50624990f8c15a3070c5a8593cd9796aa33a17382e0e8a0f00b2b5319b6b13760c11648de333295a6c4b0
-  data.tar.gz: 0617c8f3578bf306b4c0e9929edea1371095f99fc2d3b20e6e89b6bf920381f9a10b1d246f6a94d4f9831f31b5b3215aabd77eb33aa4c7fea2f8600480cdc8c4
+  metadata.gz: 917cd2594cfbfd4b2c9b154232e72fedb3595ee345d03054fe9a9bbaef428220e7766283328610da177d4b008388c2b584b285f57a9c8a91bfafdfcecb0988d4
+  data.tar.gz: 497277157be74cd61f7acbfeb4f4e47355c2901d81c9c6775c0454fb58ae67e6d7126f7cc25d7adf2ceefb095a79cc871f268497639452d40838eb0f5d822a3c

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.byebug*

data/README.md

@@ -98,6 +98,26 @@ end
 
 Note that this doesn't work on events that are called from class methods; you will need to observe the Global Events Table object in those cases.
 
+## Examples
+
+There is an example [Rails App](https://github.com/parasquid/utter/tree/master/sample_rails_app) that uses `Utter`
+
+    $ # after checking out this repository
+    $ cd sample_rails_app
+    $ bundle install
+    $ rails s
+
+Then go to localhost:3000/articles and take a look at the console. You should see something like this:
+
+```ruby
+object_id: 70100155242700
+event: index_viewed
+payload: {:params=>{"controller"=>"articles", "action"=>"index"}}
+```
+You will need to [setup your AWS credentials](https://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs) if you wish to be able to use the AWS related examples.
+
+The `UtterDynamoLogger` watcher utilizes [Celluloid](https://github.com/celluloid/celluloid/wiki/Basic-usage) in order to not block the original method call.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/utter.rb

@@ -17,10 +17,16 @@ module Utter
     end
 
     def process_event(object_id, event, payload)
+      return unless @backing_hash.has_key? object_id
+      return unless @backing_hash[object_id].has_key? event
+
+      # call registered event handlers
       @backing_hash[object_id][event].compact!
       @backing_hash[object_id][event].each do |block|
         block.call(payload)
       end
+
+      # notify watchers
       changed
       notify_observers(object_id, event, payload)
     end

data/lib/utter/utils/wrapper.rb

@@ -0,0 +1,45 @@
+module Utter
+  module Utils
+    class Wrapper
+      def wrap(wrapped_class, before: nil, after: nil)
+        wrapped_class.class_eval do
+          self.define_singleton_method :utter_before_action do
+            before || Proc.new {}
+          end
+
+          self.define_singleton_method :utter_after_action do
+            after || Proc.new {}
+          end
+
+          def self.inherited(klass)
+            def klass.method_added(name)
+              # prevent a SystemStackError
+              return if @_not_new
+              @_not_new = true
+
+              # preserve the original method call
+              original = "original #{name}"
+              alias_method original, name
+
+              # wrap the method call
+              define_method(name) do |*args, &block|
+                self.class.superclass.utter_before_action.call(self, args, name)
+
+                # call the original method
+                result = send original, *args, &block
+
+                self.class.superclass.utter_after_action.call(self, args, name)
+
+                # return the original return value
+                result
+              end
+
+              # reset the guard for the next method definition
+              @_not_new = false
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/utter/version.rb

@@ -1,3 +1,3 @@
 module Utter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/sample_rails_app/Gemfile

@@ -7,6 +7,7 @@ gem 'uglifier', '>= 1.3.0'
 gem 'jquery-rails'
 gem 'jbuilder', '~> 2.0'
 gem 'sdoc', '~> 0.4.0', group: :doc
+gem "celluloid", require: "celluloid/current"
 
 group :development, :test do
   gem 'byebug'
@@ -14,4 +15,6 @@ group :development, :test do
   gem "quiet_assets"
 end
 
-gem "utter", path: "../"
+gem "utter_events", path: "../", require: "utter"
+
+gem "aws-sdk", "~> 2"

data/sample_rails_app/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: ../
   specs:
-    utter (0.1.0)
-      gem_config (= 0.3.1)
+    utter_events (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -43,21 +42,45 @@ GEM
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     arel (6.0.3)
+    aws-sdk (2.2.22)
+      aws-sdk-resources (= 2.2.22)
+    aws-sdk-core (2.2.22)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.2.22)
+      aws-sdk-core (= 2.2.22)
     binding_of_caller (0.7.2)
       debug_inspector (>= 0.0.1)
     builder (3.2.2)
     byebug (8.2.2)
+    celluloid (0.17.3)
+      celluloid-essentials
+      celluloid-extras
+      celluloid-fsm
+      celluloid-pool
+      celluloid-supervision
+      timers (>= 4.1.1)
+    celluloid-essentials (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-extras (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-fsm (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-pool (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-supervision (0.20.5)
+      timers (>= 4.1.1)
     concurrent-ruby (1.0.0)
     debug_inspector (0.0.2)
     erubis (2.7.0)
     execjs (2.6.0)
-    gem_config (0.3.1)
     globalid (0.3.6)
       activesupport (>= 4.1.0)
+    hitimes (1.2.3)
     i18n (0.7.0)
     jbuilder (2.4.1)
       activesupport (>= 3.0.0, < 5.1)
       multi_json (~> 1.2)
+    jmespath (1.1.3)
     jquery-rails (4.1.0)
       rails-dom-testing (~> 1.0)
       railties (>= 4.2.0)
@@ -126,6 +149,8 @@ GEM
     thor (0.19.1)
     thread_safe (0.3.5)
     tilt (2.0.2)
+    timers (4.1.1)
+      hitimes
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     uglifier (2.7.2)
@@ -141,7 +166,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  aws-sdk (~> 2)
   byebug
+  celluloid
   jbuilder (~> 2.0)
   jquery-rails
   quiet_assets
@@ -150,7 +177,7 @@ DEPENDENCIES
   sdoc (~> 0.4.0)
   sqlite3
   uglifier (>= 1.3.0)
-  utter!
+  utter_events!
   web-console (~> 2.0)
 
 BUNDLED WITH

data/sample_rails_app/config/initializers/utter.rb

@@ -1,8 +1,79 @@
+
+require "pp"
+
 class UtterConsoleLogger
   def update(object_id, event, payload)
     puts "object_id: #{object_id}\nevent: #{event}\npayload: #{payload}"
   end
 end
 
-watcher = UtterConsoleLogger.new
-Utter::GLOBAL_EVENTS_TABLE.add_observer(watcher)
+class UtterKinesisLogger
+  def initialize
+    credentials = Aws::SharedCredentials.new(profile_name: "kinesis")
+    @client = Aws::Firehose::Client.new(credentials: credentials, region: "us-east-1")
+  end
+
+  def update(object_id, event, payload)
+    self.async._update(object_id, event, payload)
+  end
+
+  def _update(object_id, event, payload)
+    @client.put_record(
+      delivery_stream_name: "checkout",
+      record: {
+        data: payload.to_s
+      }
+    )
+  end
+end
+
+class UtterDynamoLogger
+  include Celluloid
+
+  def initialize
+    credentials = Aws::SharedCredentials.new(profile_name: "dynamodb")
+    @client = Aws::DynamoDB::Client.new(
+      credentials: credentials,
+      region: "us-east-1"
+    )
+  end
+
+  def update(object_id, event, payload)
+    self.async._update(object_id, event, payload)
+  end
+
+  def _update(object_id, event, payload)
+    @client.put_item({
+      table_name: "mv_utter_events",
+      item: {
+        event_id: SecureRandom.uuid,
+        object_id: object_id,
+        event: event,
+        payload: payload
+      }
+    })
+  end
+end
+
+require "utter/utils/wrapper"
+
+[ApplicationController].each do |klass|
+  after_action = Proc.new do |context, args, name|
+    payload = {
+      "object_instance" => context.to_s,
+      "action_dispatch.request.path_parameters" => context.env["action_dispatch.request.path_parameters"]
+    }
+    context.utter("#{context.class.to_s}##{name}", payload) if context.respond_to?(:utter)
+  end
+  Utter::Utils::Wrapper.new.wrap(klass, after: after_action )
+end
+
+
+
+
+console_watcher = UtterConsoleLogger.new
+dynamo_watcher = UtterDynamoLogger.new
+# kinesis_watcher = UtterKinesisLogger.new
+Utter::GLOBAL_EVENTS_TABLE.add_observer(console_watcher)
+Utter::GLOBAL_EVENTS_TABLE.add_observer(dynamo_watcher)
+# Utter::GLOBAL_EVENTS_TABLE.add_observer(kinesis_watcher)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utter_events
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - parasquid
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ files:
 - bin/console
 - bin/setup
 - lib/utter.rb
+- lib/utter/utils/wrapper.rb
 - lib/utter/version.rb
 - sample_rails_app/.gitignore
 - sample_rails_app/Gemfile