catscan 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael de Silva
+
+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,28 @@
+# Catscan
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'catscan'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install catscan
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Catscan'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/models/catscan/scan.rb

@@ -0,0 +1,10 @@
+module Catscan
+  class Scan < ActiveRecord::Base
+    self.table_name = "catscan_scans"
+
+    attr_accessible :klass, :entity, :comment, :category,
+      :error_message,
+      :error_class,
+      :error_backtrace
+  end
+end

data/db/migrate/20131122070729_create_catscan_scans.rb

@@ -0,0 +1,13 @@
+class CreateCatscanScans < ActiveRecord::Migration
+  def change
+    create_table :catscan_scans do |t|
+      t.string    :klass
+      t.text      :payload
+      t.string    :comment
+
+      t.integer   :version,     :default => 1
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20131129073921_add_extra_columns_to_catscan_scans.rb

@@ -0,0 +1,10 @@
+class AddExtraColumnsToCatscanScans < ActiveRecord::Migration
+  def change
+    add_column :catscan_scans, :entity, :string
+    add_column :catscan_scans, :category, :string
+    add_column :catscan_scans, :error_message, :string
+    add_column :catscan_scans, :error_class, :string
+    add_column :catscan_scans, :error_backtrace, :text
+    remove_column :catscan_scans, :payload
+  end
+end

data/lib/catscan.rb

@@ -0,0 +1,6 @@
+require "catscan/engine"
+
+module Catscan
+  autoload :Scannable,    'catscan/scannable'
+  autoload :Util,         'catscan/util'
+end

data/lib/catscan/engine.rb

@@ -0,0 +1,20 @@
+module Catscan
+  class Engine < ::Rails::Engine
+    isolate_namespace Catscan
+
+    initializer "catscan.scanner_subscribe", :after => :load_environment_config do |app|
+      ActiveSupport::Notifications.subscribe 'log.scan' do |*args|
+        event = ActiveSupport::Notifications::Event.new(*args)
+        ::Catscan::Scan.create!(
+          :klass => event.payload[:klass_name],
+          :entity => event.payload[:entity].present? ? event.payload[:entity] : nil,
+          :comment => event.payload[:comment].present? ? event.payload[:comment] : nil,
+          :category => event.payload[:category],
+          :error_message => event.payload[:error_message].present? ? event.payload[:error_message] : nil,
+          :error_class => event.payload[:error_class].present? ? event.payload[:error_class] : nil,
+          :error_backtrace => event.payload[:error_backtrace].present? ? Util.limit_bytesize(event.payload[:error_backtrace].force_encoding("UTF-8")) : nil
+        )
+      end
+    end
+  end
+end

data/lib/catscan/scannable.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+require 'catscan/util'
+
+module Catscan
+  module Scannable
+
+    class << self
+      def included _klass
+        _klass.class_eval do
+          _klass.send(:extend, ClassMethods)
+        end
+      end
+    end
+
+    module ClassMethods
+
+      def scan(context, entity = nil, comment = nil, category = :default, &block)
+        klass_name = %w(Class).include?(context.class.name) ? context.name : context.class.name
+        comment = Util.limit_bytesize(comment.force_encoding("UTF-8")) if comment.present?
+
+        if block_given?
+          ActiveSupport::Notifications.instrument("log.scan",
+            :klass_name       => klass_name,
+            :entity           => entity.present? ? "#{entity}" : nil,
+            :comment          => comment.present? ? "#{comment}" : nil,
+            :category         => "#{category}") do
+            context.instance_eval(&block)
+          end
+        else
+          ActiveSupport::Notifications.instrument("log.scan",
+            :klass_name       => klass_name,
+            :entity           => entity.present? ? "#{entity}" : nil,
+            :comment          => comment.present? ? "#{comment}" : nil,
+            :category         => "#{category}"
+          )
+        end
+      rescue => ex
+        puts "Error!"
+
+        # NOTE Re-raise exception for spec purposes
+        raise if Rails.env.test?
+
+        ActiveSupport::Notifications.instrument("log.scan",
+          :klass_name       => klass_name,
+          :entity           => entity.present? ? "#{entity}" : nil,
+          :comment          => comment.present? ? "ERROR: #{comment}" : nil,
+          :category         => "#{category}",
+          :error_message    => "#{ex.message}",
+          :error_class      => "#{ex.class}",
+          :error_backtrace  => "#{ex.backtrace}"
+        )
+      end
+
+    end
+
+  end
+end

data/lib/catscan/util.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Catscan
+  module Util
+
+    class << self
+
+      # Limits the byte size of the string, by default, to (2^16 - 1),
+      # which is the maximum size of MySQL's TEXT data type.
+      #
+      # @return [String] limited to 65,535 bytes, by default.
+      # @see http://stackoverflow.com/a/12536366/495653
+      def limit_bytesize(str, size = 65535)
+        str.encoding.name == 'UTF-8' or raise ArgumentError, "str must have UTF-8 encoding"
+
+        # Change to canonical unicode form (compose any decomposed characters).
+        # Works only if you're using active_support
+        str = str.mb_chars.compose.to_s if str.respond_to?(:mb_chars)
+
+        # Start with a string of the correct byte size, but
+        # with a possibly incomplete char at the end.
+        new_str = str.byteslice(0, size)
+
+        # We need to force_encoding from utf-8 to utf-8 so ruby will re-validate
+        # (idea from halfelf).
+        until new_str[-1].force_encoding('utf-8').valid_encoding?
+          # remove the invalid char
+          new_str = new_str.slice(0..-2)
+        end
+        new_str
+      end
+
+    end
+
+  end
+end

data/lib/catscan/version.rb

@@ -0,0 +1,3 @@
+module Catscan
+  VERSION = "0.1.0"
+end

data/lib/tasks/catscan_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :catscan do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: catscan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael de Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.15
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nyan-cat-formatter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A
+email:
+- michael@mwdesilva.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/catscan/scan.rb
+- db/migrate/20131122070729_create_catscan_scans.rb
+- db/migrate/20131129073921_add_extra_columns_to_catscan_scans.rb
+- lib/catscan/engine.rb
+- lib/catscan/scannable.rb
+- lib/catscan/util.rb
+- lib/catscan/version.rb
+- lib/catscan.rb
+- lib/tasks/catscan_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://mwdesilva.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1562943042469313175
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A
+test_files: []
+has_rdoc: