exes_poster 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b88589a7be0db10bd1f45dc664398f03677feff1
+  data.tar.gz: c9ae68113d889217b670db6b59f737ed046a4318
+SHA512:
+  metadata.gz: a3dda28c49b55920fb1a6dfb728a8bc0e85e4cc766b7d2300b9c744d0d9d05df4d2b2ea1af1076119a7482c9b9373149dddbb66a7d26c891adf44c49e9aefa10
+  data.tar.gz: 277ae0ed64f62c580ded7dc101de9ca9d4a688b2629ac9d67a0403d910f375208a97e42fac9f65d064b2da85ae66da40a25019e474239fe107091158a4bb5a03

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Takahiro HAMAGUCHI
+
+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,100 @@
+ExesPoster
+========
+
+ExesPoster is an exception post tool to Elasticsearch.
+
+Installation
+-----
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exes_poster'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install exes_poster
+```
+
+
+Getting Started
+-----
+
+1. To set an environment variable "ELASTICSEARCH_URL"
+  ```bash
+  $ export ELASTICSEARCH_URL=localhost:9200
+  ```
+
+2. Call `ExesPoster.post_exception` with caught exception in the rescue section.
+  ```ruby
+  require 'exes_poster'
+  
+  begin
+      raise RuntimeError, 'hoge'
+  rescue => e
+      ExesPoster.post_exception(e)
+  end
+  ```
+
+3. You can find exception information at your elasticsearch.
+  ```javascript
+  {
+    "_index"   : "exes_index",
+    "_type"    : "exception",
+    "_id"      : "eIb4VGPbRB6tw0eGnUXUXA",
+    "_version" : 1,
+    "found"    : true,
+    "_source"  : {
+      "message"    : "hoge",
+      "@timestamp" : "2016-09-21T16:28:09.753+09:00",
+      "detail"     : {
+        "class"     : "RuntimeError",
+        "backtrace" : [
+          "/PATH/TO/ERROR/FILE1.rb:123:in `block (3 levels) in <top (required)>'",
+          "/PATH/TO/ERROR/FILE2.rb:456:in `block (2 levels) in function'",
+          "/PATH/TO/ERROR/FILE3.rb:15:in `<main>'"
+        ]
+      }
+    }
+  }
+  ```
+
+in Japanese
+-----
+ * [使い方](features/post_exception_to_elasticsearch.feature)
+
+
+Configuration
+-----
+
+You can set Elasticsearch url and index name.
+
+```ruby
+ExesPoster.setup do |config|
+  config.es_url   = 'example.com:9200'
+  config.es_index = 'hoge_test'
+end
+```
+
+Test
+-----
+
+1. You set an environment variable DOCKER_HOST or ELASTICSEARCH_URL
+  ```bash
+  $ export ELASTICSEARCH_URL=localhost:9200
+  ```
+  or
+  ```bash
+  $ eval $(docker-machine env default)
+  ```
+ 
+2. Then exec rake
+  ```bash
+  $ bundle exec rake
+  ```

data/Rakefile

@@ -0,0 +1,58 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+default_tasks = []
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = "-fd"
+  end
+  default_tasks << :spec
+rescue LoadError
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "features --format pretty"
+  end
+  default_tasks << :features
+rescue LoadError
+end
+
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['app/controllers/**/*.rb','app/helpers/**/*.rb', 'app/mailers/**/*.rb', 'app/models/**/*.rb', 'lib/**/*.rb']
+    t.options = []
+    t.options << '--debug' << '--verbose' if $trace
+  end
+  default_tasks << :yard
+rescue LoadError
+end
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+  default_tasks << :rubocop
+rescue LoadError
+end
+
+desc 'Generate docs'
+task :docs do
+  system 'rm -rf docs'
+  system 'rspec spec -fh -o docs/rspec/index.html'
+  system 'mv coverage docs'
+  system 'mkdir -p docs/cucumber/'
+  system 'cucumber features -f html -o docs/cucumber/index.html'
+  system 'yardoc -o docs/yard'
+  system 'rubocop -fh -o docs/rubocop/index.html'
+end
+
+task default: default_tasks
+

data/lib/exes_poster.rb

@@ -0,0 +1,17 @@
+require 'elasticsearch'
+
+# ExesPoster
+#
+# @since 0.1.0
+# @author tk.hamaguchi@gmail.com
+#
+module ExesPoster
+  @@es_url   = ENV['ELASTICSEARCH_URL']
+  @@es_index = 'exes_index'
+
+  autoload :Configurator, 'exes_poster/configurator'
+  autoload :Poster,       'exes_poster/poster'
+
+  include Configurator
+  include Poster
+end

data/lib/exes_poster/configurator.rb

@@ -0,0 +1,28 @@
+module ExesPoster
+  # ExesPoster::Configurator
+  #
+  # @since 0.1.0
+  # @author tk.hamaguchi@gmail.com
+  #
+  module Configurator
+    def self.included(klass)
+      klass.class_variables.each do |var|
+        sym = var.to_s.gsub(/^@@/, '').to_sym
+        klass.class_eval <<-EOS
+          def self.#{sym}()
+            return @@#{sym}
+          end
+
+          def self.#{sym}=(obj)
+            @@#{sym} = obj
+          end
+        EOS
+      end
+      klass.class_eval <<-EOS
+        def self.setup
+          yield self
+        end
+      EOS
+    end
+  end
+end

data/lib/exes_poster/poster.rb

@@ -0,0 +1,39 @@
+module ExesPoster
+  # ExesPoster::Poster
+  #
+  # @since 0.1.0
+  # @author tk.hamaguchi@gmail.com
+  #
+  module Poster
+    def self.included(klass)
+      klass.module_eval do
+        def self.post(type, message, detail = nil)
+          body = {
+            message: message,
+            '@timestamp' => Time.now.iso8601(3)
+          }
+          body[:detail] = detail unless detail.nil?
+
+          c = Elasticsearch::Client.new(url: es_url)
+          d = c.index(
+            index: es_index,
+            type: type,
+            body: body,
+            refresh: true
+          )
+
+          d['_id']
+        end
+
+        def self.post_exception(e)
+          post(
+            :exception,
+            e.message,
+            class: e.class.name,
+            backtrace: e.backtrace
+          )
+        end
+      end
+    end
+  end
+end

data/lib/exes_poster/version.rb

@@ -0,0 +1,3 @@
+module ExesPoster
+  VERSION = '0.1.0'.freeze
+end

data/lib/tasks/exes_poster_tasks.rake

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

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# 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_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+
+//= link_directory ../stylesheets .css

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

@@ -0,0 +1,13 @@
+// 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 any plugin's vendor/assets/javascripts directory 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
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::API
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end