yaml_notifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be95fcd186e78298b3ad782b0886dbfe460e19d7
+  data.tar.gz: 8b242988424a6f4761be2f2336964dea91559aab
+SHA512:
+  metadata.gz: f368bdb067d0d77efd70934dae8e8209131de76a773a788e4cba0a62447201669035c614a292e7a481c93bbe4663af40416c4450ea38dc6ac2a7fef53fc1ed8b
+  data.tar.gz: c3c6f540ff789646c7c7d53ff23359e30a04887fa187d69eb4f9b9306abc5ab8e50ea5eedfe7ed68753207e12c4029857a4622cb69830caed15877d8c3e43ab3

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    yaml_notifier (0.0.1)
+      yaml_record4 (= 0.0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    builder (3.2.2)
+    i18n (0.6.11)
+    json (1.8.1)
+    minitest (5.4.1)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yaml_record4 (0.0.6)
+      activemodel (>= 4.0)
+      activesupport (>= 4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  yaml_notifier!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Thierry Zires
+
+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,4 @@
+yaml_notifier
+================
+
+save exceptions in yaml when exception_notification occur

data/lib/exception_notifier/yaml_notifier.rb

@@ -0,0 +1,31 @@
+require 'yaml_notifier/exception_log'
+
+module ExceptionNotifier
+  class YamlNotifier
+
+    def initialize(options)
+      # initialize options here
+      @extra_params = options[:extra_params] || []
+    end
+
+    def call(exception, options={})
+      log = ::YamlNotifier::ExceptionLog.new({
+        title: exception.inspect,
+        message: exception.message,
+        backtrace: exception.backtrace.join("\n")
+      })
+
+      env = options[:env]
+      unless env.nil?
+        log.user_agent     = env['HTTP_USER_AGENT']
+        log.request_uri    = env['REQUEST_URI']
+        log.request_method = env['REQUEST_METHOD']
+        log.controller     = env['action_dispatch.request.path_parameters'][:controller]
+        log.action         = env['action_dispatch.request.path_parameters'][:action]
+        log.extra_params   = @extra_params.map{|p| env[p]} unless @extra_params.empty?
+      end
+
+      log.save
+    end
+  end
+end

data/lib/yaml_notifier.rb

@@ -0,0 +1,7 @@
+module YamlNotifier
+end
+
+require 'exception_notifier/yaml_notifier'
+ExceptionNotifier.add_notifier :yaml, {} if defined?(ExceptionNotifier)
+
+require 'yaml_notifier/railtie' if defined?(Rails)

data/lib/yaml_notifier/exception_log.rb

@@ -0,0 +1,7 @@
+require 'yaml_record'
+
+module YamlNotifier
+  class ExceptionLog < YamlRecord::Base
+    properties :title, :message, :backtrace, :user_agent, :request_uri, :request_method, :extra_params, :controller, :action
+  end
+end

data/lib/yaml_notifier/railtie.rb

@@ -0,0 +1,7 @@
+module YamlNotifier
+  class Railtie < ::Rails::Railtie
+    initializer "yaml_record.root_path" do
+      YamlRecord.root_path = File.join(Rails.root, 'db')
+    end
+  end
+end

data/lib/yaml_notifier/version.rb

@@ -0,0 +1,3 @@
+module YamlNotifier
+  VERSION = '0.0.1'
+end

data/test/base_test.rb

@@ -0,0 +1,193 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class YamlObject < YamlRecord::Base
+  properties :title, :body, :child_ids
+  source File.dirname(__FILE__) + "/../tmp/yaml_object"
+end
+
+class BaseTest < Test::Unit::TestCase
+
+  def setup
+    @obj_title = "Simple Title"
+    @obj_id = "1234"
+    @obj2_id = "5678"
+    @obj2_title = "Simple Title 2"
+
+    @attr = {
+      :child_ids  =>  [@obj_id],
+      :title =>  @obj_title,
+      :body => "Body!!"
+    }
+
+    @attr2 = {
+      :child_ids  =>  [@obj2_id],
+      :title =>  @obj2_title,
+      :body => "Body!!"
+    }
+
+    clean_yaml_record(YamlObject)
+    @fs = YamlObject.create(@attr)
+  end
+
+  context "for instance methods" do
+
+    context "for [] method" do
+      should("get attribute with [attribute]"){ assert_equal @fs.title, @fs[:title] }
+    end
+
+    context "for []= method" do
+      setup do
+        @fs[:title] = "Toto"
+      end
+      should("set attribute with [attribute]="){ assert_equal @fs[:title], "Toto" }
+    end
+
+    context "for save method" do
+      setup do
+        @fs2 = YamlObject.new(@attr)
+        @fs2.save
+      end
+
+      should("save on yaml file"){ assert_equal YamlObject.last.attributes.diff(@attr), {:id => @fs2.reload.id } }
+    end
+
+    context "for update_attributes method" do
+      setup do
+        @fs.update_attributes(:title => "Toto", :body  => "http://somewhereelse.com")
+        @fs.reload
+      end
+      should("update title") { assert_equal @fs.title, "Toto" }
+      should("update body") { assert_equal @fs.body, "http://somewhereelse.com"  }
+    end
+
+    context "for column_names method" do
+      should("return an array with attributes names") { assert_equal @fs.column_names.sort!, YamlObject.properties.map { |p| p.to_s }.sort! }
+    end
+
+    context "for persisted_attributes method" do
+      should("return persisted attributes") { assert_equal [:title, :body, :child_ids, :id ].sort_by {|sym| sym.to_s}, @fs.persisted_attributes.keys.sort_by {|sym| sym.to_s} }
+    end
+
+    context "for new_record? method" do
+      setup do
+        @fs3 = YamlObject.new
+      end
+      should("be a new record") { assert @fs3.new_record? }
+      should("not be a new record") { assert_false @fs.new_record? }
+    end
+
+    context "for destroyed? method" do
+      setup do
+        @fs4 = YamlObject.create(@attr)
+        @fs4.destroy
+      end
+      should("be a destoyed") { assert @fs4.destroyed? }
+      should("not be destroyed") { assert_false @fs.destroyed? }
+    end
+
+    context "for destroy method" do
+      setup do
+        @fs5 = YamlObject.create(@attr)
+        @fs5.destroy
+      end
+      should("not find @fs5"){ assert_nil YamlObject.find(@fs5.id) }
+    end
+
+    context "for reload method" do
+      setup do
+        @fs.title = "Foo"
+      end
+      should("equal to Foo"){ assert_equal @fs.title, "Foo" }
+      should("equal to correct title"){ assert_equal @fs.reload.title, @obj_title }
+    end
+
+    context "for to_param method" do
+      setup { @fs.id = "a1b2c3" }
+
+      should("return id of record") { assert_equal(@fs.to_param, @fs.id) }
+    end
+  end
+
+  context "for class methods" do
+    context "for self.find_by_attribute method" do
+      setup do
+        @fs_found = YamlObject.find_by_attribute(:title, @obj_title)
+      end
+      should("be same object as @fs"){ assert_equal @fs_found, YamlObject.find(@fs.id) }
+    end
+
+    context "for self.find_by_id method" do
+      setup do
+        @fs_found = YamlObject.find_by_id(@fs.id)
+        @fs_found2 = YamlObject.find(@fs.id)
+      end
+      should("be same object as @fs"){ assert_equal @fs.attributes, @fs_found.attributes }
+      should("be same object as @fs bis"){ assert_equal @fs.attributes, @fs_found2.attributes }
+    end
+
+    context "for self.all method" do
+      setup do
+        clean_yaml_record(YamlObject)
+        @fs, @fs2 = YamlObject.create(@attr), YamlObject.create(@attr2)
+      end
+      should("retrieve 2 YamlObject obj"){ assert_equal YamlObject.all.size, 2 }
+      should("return as first item @fs"){ assert_equal YamlObject.all.first.attributes, @fs.attributes }
+      should("return as last item @fs2"){ assert_equal YamlObject.all.last.attributes, @fs2.attributes }
+    end
+
+    context "for self.first method" do
+      setup do
+        clean_yaml_record(YamlObject)
+        @fs, @fs2 = YamlObject.create(@attr), YamlObject.create(@attr2)
+      end
+
+      should("return @fs as the first item"){ assert_equal YamlObject.first.attributes, @fs.attributes }
+      should("return @fs"){ assert_equal YamlObject.first(2).first.attributes, @fs.attributes }
+      should("return @fs2"){ assert_equal YamlObject.first(2).last.attributes, @fs2.attributes }
+    end
+
+    context "for self.last method" do
+      setup do
+        clean_yaml_record(YamlObject)
+        @fs, @fs2 = YamlObject.create(@attr), YamlObject.create(@attr2)
+      end
+
+      should("return @fs as the first item"){ assert_equal YamlObject.last.attributes, @fs2.attributes }
+      should("return @fs"){ assert_equal YamlObject.last(2).first.attributes, @fs.attributes }
+      should("return @fs2"){ assert_equal YamlObject.last(2).last.attributes, @fs2.attributes }
+    end
+
+    context "for self.write_contents method" do
+      setup do
+        clean_yaml_record(YamlObject)
+        @attributes = [ @attr, @attr2 ]
+        YamlObject.write_contents(@attributes)
+      end
+      should("write in yaml file"){ assert_equal YAML.load_file(YamlObject.source), [ @attr, @attr2 ] }
+    end
+
+    context "for self.create method" do
+      setup do
+        clean_yaml_record(YamlObject)
+        @fs = YamlObject.create(@attr)
+        @fs_not_created = YamlObject.new(@attr)
+      end
+      should("create @fs"){ assert_equal YamlObject.last.attributes, @fs.attributes }
+      should("set its is_created to true"){ assert @fs.is_created }
+      should("set @fs_not_created is_created field  to false"){ assert_false @fs_not_created.is_created }
+    end
+
+    context "for set_id!" do
+      setup do
+        @fs_no_id = YamlObject.new(@attr)
+        @fs_with_id = YamlObject.create(@attr)
+        @id = @fs_with_id.id
+        @fs_with_id.update_attributes(:title =>  "Gomiso")
+      end
+      should("not have any id"){ assert_nil @fs_no_id.id }
+      should("have a id"){ assert @fs_with_id.id }
+      should("keep the same id"){ assert_equal @fs_with_id.id, @id }
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'minitest/autorun'
+#require 'test/unit'
+require 'shoulda'
+require File.dirname(__FILE__) + "/../lib/yaml_record"
+
+class Test::Unit::TestCase
+  def clean_yaml_record(class_record)
+    File.open(class_record.source, 'w') {|f| f.write(nil) }
+  end
+
+  # Asserts that the condition is not true
+  # assert_false @title == "hey"
+  def assert_false(condition, message='')
+    assert !condition, message
+  end
+end

data/yaml_notifier.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "yaml_notifier/version"
+
+Gem::Specification.new do |s|
+  s.name        = "yaml_notifier"
+  s.version     = YamlNotifier::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Thierry Zires"]
+  s.email       = ["zshuaibin@gmail.com"]
+  s.homepage    = "https://github.com/zires/yaml_notifier"
+  s.summary     = %q{save exceptions in yaml when exception_notification occur}
+  s.description = %q{save exceptions in yaml when exception_notification occur}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'yaml_record4', '= 0.0.6'
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: yaml_notifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thierry Zires
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yaml_record4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+description: save exceptions in yaml when exception_notification occur
+email:
+- zshuaibin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/exception_notifier/yaml_notifier.rb
+- lib/yaml_notifier.rb
+- lib/yaml_notifier/exception_log.rb
+- lib/yaml_notifier/railtie.rb
+- lib/yaml_notifier/version.rb
+- test/base_test.rb
+- test/test_helper.rb
+- yaml_notifier.gemspec
+homepage: https://github.com/zires/yaml_notifier
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: save exceptions in yaml when exception_notification occur
+test_files:
+- test/base_test.rb
+- test/test_helper.rb
+has_rdoc: