weasel 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d760cb9dc3cea66dcc2aa05d827c70b1cbf48380
-  data.tar.gz: 64525592fd903e40df98aa87d8a4c993715fe212
+  metadata.gz: d6162cafcd694b7210e34b8adfb06a68804712c4
+  data.tar.gz: b72c21903a01397cc14d09e093bbb2c41a32248f
 SHA512:
-  metadata.gz: bf57d3bae060ba231942b8ca814556be64db30abc044d519e6e2338b10d2ac79a4448eba499f178bee11129601636a55ff8b8aacd620efdb7a569b8ba3783b23
-  data.tar.gz: c5d7d02859dc111aacc11c2d8d2bb8d443f247fcfcef7c1c5ceef7c45103e5245473073f7e7f8dd44b9a641fe721bbc9e2e508380530a186607a055df98438ee
+  metadata.gz: 74da567b7dde7fdd7524b6ac3b6ec2af1c62b9cdb11ef8267b77c78f679b888f3d1960b7484e16f80ecffe9eca660583503ef3cae5d7c61d1151b68496c45e42
+  data.tar.gz: 1bed4eebf9549908c63548fe646d3e0d9b427b30f3a7ee61b12be51e571ca8317f8d97920a468981f4ba5feb753f1267400ebbc16b1a68895510478fa5bd0fa5

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -22,7 +22,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First, you'll need to create a table like this:
+
+```ruby
+class AddWeaselTables < ActiveRecord::Migration
+  def self.up
+    create_table :weasel_events do |t|
+      t.integer :actor_id
+      t.string  :actor_type
+      t.text    :action_data
+
+      t.timestamps
+    end
+
+    def self.down
+      drop_table :weasel_events
+    end
+  end
+end
+```
+
+Then, create an initializer to configure Weasel. Put this in it:
+
+```ruby
+Weasel.configure do |config|
+  config.db_configuration = ActiveRecord::Base.connection_config
+end
+```
 
 ## Development
 
@@ -32,10 +58,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/weasel. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/goodpeople/weasel. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/lib/weasel/concerns/auditable.rb

@@ -0,0 +1,45 @@
+module Weasel
+  def audit_with_weasel(*args)
+    around_filter :audit, only: args
+  end
+
+  module Auditable
+    def audit
+      yield
+
+      Weasel::EventsWorker.perform_async(current_user.id, thin_request)
+    end
+
+    private
+
+    def thin_request
+      parameters = request.params
+
+      rails_action = "#{parameters[:controller]}:#{parameters[:action]}"
+      rails_parameters = parameters.except(:controller, :action)
+
+      {
+        action: rails_action,
+        params: rails_parameters,
+        remote_ip: request.remote_ip,
+        geo_ip_information: geo_ip_information,
+        user_agent: request.user_agent,
+        response: {
+          status: response.status
+        }.tap do |hash|
+          hash[:body] = response.body if response.body
+        end
+      }.tap do |hash|
+        hash[:flash] = request.flash if request.flash
+      end
+    end
+
+    def geo_ip_information
+      geo_service.country(request.remote_ip).to_h
+    end
+
+    def geo_service
+      @@geoip ||= GeoIP.new(File.join(Rails.root, 'tmp/GeoIP.dat'))
+    end
+  end
+end

data/lib/weasel/models/event.rb

@@ -0,0 +1,9 @@
+module Weasel
+  class Event < ActiveRecord::Base
+    self.table_name = 'weasel_events'
+
+    serialize :action_data
+
+    belongs_to :actor, polymorphic: true
+  end
+end

data/lib/weasel/version.rb

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

data/lib/weasel/workers/events_worker.rb

@@ -0,0 +1,14 @@
+module Weasel
+  class EventsWorker
+    include Sidekiq::Worker
+
+    def perform(user_id, request_hash)
+      return if user_id.nil? || request_hash.empty?
+
+      Weasel::Event.create do |object|
+        object.actor = User.find(user_id)
+        object.action_data = request_hash
+      end
+    end
+  end
+end

data/lib/weasel.rb

@@ -1,5 +1,32 @@
-require "weasel/version"
+require 'active_record'
+require 'active_support/concern'
+
+require 'weasel/concerns/auditable'
+require 'weasel/models/event'
+require 'weasel/workers/events_worker'
+require 'weasel/version'
 
 module Weasel
-  # Your code goes here...
+  def self.root
+    File.expand_path('../..', __FILE__)
+  end
+
+  class Configuration
+    attr_accessor :db_configuration
+  end
+
+  def self.config
+    @@config ||= Configuration.new
+  end
+
+  def self.configure
+    yield config
+
+    # Connect to current AR connection.
+    ActiveRecord::Base.establish_connection(config.db_configuration)
+
+    # Extend ActionController with the `audit_with_weasel` method.
+    ActionController::Base.extend(Weasel)
+    ActionController::Base.send(:include, Weasel::Auditable)
+  end
 end

data/weasel.gemspec

@@ -4,22 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'weasel/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "weasel"
+  spec.name          = 'weasel'
   spec.version       = Weasel::VERSION
-  spec.authors       = ["Agustin Cavilliotti"]
-  spec.email         = ["cavi21@gmail.com"]
+  spec.authors       = ['Agustin Cavilliotti']
+  spec.email         = ['cavi21@gmail.com']
 
   spec.summary       = %q{Simple Audit gem}
   spec.description   = %q{Works as a weasel for your controllers}
-  spec.homepage      = "https://github.com/goodpeople/weasel"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/goodpeople/weasel'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_dependency 'activerecord', '~> 3.2'
+  spec.add_dependency 'sidekiq', '~> 2.17'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: weasel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Agustin Cavilliotti
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-04 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -69,7 +125,10 @@ files:
 - bin/console
 - bin/setup
 - lib/weasel.rb
+- lib/weasel/concerns/auditable.rb
+- lib/weasel/models/event.rb
 - lib/weasel/version.rb
+- lib/weasel/workers/events_worker.rb
 - weasel.gemspec
 homepage: https://github.com/goodpeople/weasel
 licenses:
@@ -91,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Simple Audit gem