thoth 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cddde402b621db27a9e031bd3e2e144bc80be5c9
+  data.tar.gz: 4520792c5d4638e897e18b12604ca626caabe04f
+SHA512:
+  metadata.gz: 07ffd771377ab1a63830ec8d547d593012df1b3c478023ab0deca104a484d875000fcd0d546601ee56edb097f9fadc2dd9cde39e5ea54200e546d1e7d82686a0
+  data.tar.gz: e9fec58049c2b2c72b8f4ecedbea9aa88fbf468e0067d3bc7ef6f7e4d6769bfcc2aff42d74c35dd7d528918a8039f29f8bc89daea16e074bb2bc05671b686807

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in thoth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Philippe Huibonhoa
+
+MIT License
+
+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.md

@@ -0,0 +1,77 @@
+# Thoth
+
+Easy event logging for Rails.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'thoth'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thoth
+
+## Usage
+
+
+### Basics
+
+The default `Thoth.logger` will write to `log/events_#{Rails.env}.log` and include `time`.  It will also populate `context` with the current `params` and `current_user.id` if `current_user` is defined.
+
+```ruby
+Thoth.logger.log(:ship_notice, previous_state: :processing, next_state: :shipped)
+# {"event":"ship_notice","time":"25/Sep/2014:01:02:25 +0000","context":{"controller":"shipments","action":"create","current_user":1},"details":{state:'shipped'}}
+
+Thoth.logger.log(:ship_notice, {context: { source: :api }}, state: :shipped)
+# {"event":"ship_notice","time":"25/Sep/2014:01:02:25 +0000","context":{"controller":"shipments","action":"create","current_user":1,source:'api'},"details":{state:'shipped'}}
+```
+
+### Logging changes to a model
+
+Include `Thoth::Rails::Model` on your model and declare `log_events`.
+
+```ruby
+class Cat < ActiveRecord::Base
+  include Thoth::Rails::Model
+
+  # :on (default [:create, :update, :destroy]) - which events should be logged
+  # :only (default all attributes) - for updates, only log when these attributes are changed
+  log_events on: [:update, :destroy], only: [:mood, :name]
+end
+```
+
+### Changing default context
+
+If you'd like to change what is included in the context in requests, you can overwrite the `thoth_request_context` method in your controllers.
+
+```ruby
+class ApplicationController
+
+  def thoth_request_context
+    super.merge(customer: current_customer.id)
+  end
+end
+```
+
+### Changing the default logger
+
+```ruby
+# create a initializers/thoth.rb file
+file = File.open(Rails.root.join(*%w[log checkout_events.log]), 'a')
+Thoth.logger = Thoth::Logger.new(Thoth::Output::Json.new(file))
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/thoth/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/thoth/context.rb

@@ -0,0 +1,21 @@
+require 'request_store'
+
+module Thoth
+  module Context
+
+    KEY = :thoth_context
+
+    def context
+      RequestStore.store[KEY] ||= {}
+    end
+
+    def context=(value)
+      RequestStore.store[KEY] = value
+    end
+
+    def clear_context!
+      self.context = {}
+    end
+
+  end
+end

data/lib/thoth/default_logger.rb

@@ -0,0 +1,13 @@
+module Thoth
+  module DefaultLogger
+
+    def logger
+      @default_logger
+    end
+
+    def logger=(logger)
+      @default_logger = logger
+    end
+
+  end
+end

data/lib/thoth/logger.rb

@@ -0,0 +1,32 @@
+module Thoth
+  class Logger
+
+    attr_reader :outputs, :timestamp_format, :timestamp_key
+
+    def initialize(outputs, options={})
+      @outputs = [outputs].flatten
+      @timestamp_format = options.fetch(:timestamp_format, "%d/%b/%Y:%H:%M:%S %z")
+      @timestamp_key = options.fetch(:timestamp_key, :time)
+    end
+
+    def log(event_name, details={}, context={})
+      event_data = marshal_event(event_name, details, context)
+
+      outputs.each do |output|
+        output.write(event_data)
+      end
+    end
+
+
+    private
+
+    def marshal_event(event_name, details, context)
+      {
+        event: event_name,
+        timestamp_key => Time.now.utc.strftime(timestamp_format),
+        context: context.reverse_merge(Thoth.context),
+        details: details
+      }
+    end
+  end
+end

data/lib/thoth/output/json.rb

@@ -0,0 +1,14 @@
+module Thoth
+  module Output
+    class Json
+
+      def initialize(io)
+        @io = io
+      end
+
+      def write(hash)
+        @io.write("#{ActiveSupport::JSON.encode(hash)}\n")
+      end
+    end
+  end
+end

data/lib/thoth/rails/controller_context.rb

@@ -0,0 +1,26 @@
+module Thoth
+  module Rails
+    module ControllerContext
+
+      def self.included(base)
+        base.around_filter(:set_thoth_request_context)
+      end
+
+      def set_thoth_request_context
+        Thoth.context = Thoth.context.merge(thoth_request_context)
+        yield
+        Thoth.clear_context!
+      end
+
+      def thoth_request_context
+        context = params.dup
+        context[:current_user] = current_user.try(:id) if defined?(current_user)
+        context
+      end
+    end
+  end
+end
+
+if defined?(::ActionController)
+  ::ActiveSupport.on_load(:action_controller) { include Thoth::Rails::ControllerContext }
+end

data/lib/thoth/rails/model.rb

@@ -0,0 +1,45 @@
+module Thoth
+  module Rails::Model
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      def log_events(options={})
+        defaults = {on: [:create, :update, :destroy]}
+        options = options.reverse_merge!(defaults)
+
+        options[:on] = Array(options[:on])
+        options[:only] = Array(options[:only])
+
+        class_attribute :thoth_options
+        self.thoth_options = options
+
+        after_create  :thoth_log_create if options[:on].include?(:create)
+        before_update :thoth_log_update if options[:on].include?(:update)
+        after_destroy :thoth_log_destroy if options[:on].include?(:destroy)
+      end
+    end
+
+    def thoth_log_create
+      thoth_log_model(:create)
+    end
+
+    def thoth_log_update
+      only_options = self.class.thoth_options[:only]
+
+      if only_options.empty? || !(only_options.map(&:to_s) & changes.keys).empty?
+        thoth_log_model(:update)
+      end
+    end
+
+    def thoth_log_destroy
+      thoth_log_model(:destroy)
+    end
+
+    def thoth_log_model(action)
+      Thoth.logger.log("#{self.class.name} #{action}", changes: changes, attributes: attributes)
+    end
+  end
+end

data/lib/thoth/rails/railtie.rb

@@ -0,0 +1,14 @@
+require 'thoth/rails/controller_context'
+require 'thoth/rails/model'
+
+module Thoth
+  class Railtie < ::Rails::Railtie
+    initializer "thoth.configure_rails_initialization" do
+      Thoth.logger ||= (
+        file = File.open(::Rails.root.join(*%W[log events_#{ENV['RAILS_ENV']}.log]), 'a')
+        file.sync = true
+        Logger.new(Output::Json.new(file))
+      )
+    end
+  end
+end

data/lib/thoth/version.rb

@@ -0,0 +1,3 @@
+module Thoth
+  VERSION = "0.0.2"
+end

data/lib/thoth.rb

@@ -0,0 +1,10 @@
+require "thoth/version"
+require 'thoth/default_logger'
+require 'thoth/context'
+require 'thoth/output/json'
+require 'thoth/logger'
+require 'thoth/rails/railtie' if defined?(Rails)
+
+module Thoth
+  extend DefaultLogger, Context
+end

data/spec/dummy/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy/Gemfile

@@ -0,0 +1,40 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.18'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer', :platforms => :ruby
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+gem 'thoth', path: File.join(File.dirname(__FILE__), %w[.. ..])
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'debugger'

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .