okuribito 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 554a0e1bcd2a985c3f08ec493efad06bf0b58b95
+  data.tar.gz: 3a419fbe576efd5143466f5b1aecf084378c2a68
+SHA512:
+  metadata.gz: 46165e2cceca9ad323f05fb647fe40c4c717362462ce4dbd1832cd4f7da8cc529a284f193c5ac35908bd32b76a7e566b1682dca2542f78a7e55b1584572d7f2d
+  data.tar.gz: f62c2bf61de45c6cc502d24d06b1fe8fbad45628200889c9f43a6ea55f5bb449ab275933dc9073cc64b8d1cf48462bbd35219eea8a076ba66cb9eaa30d61ed8e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at yasuhiro.matsumura@pixta.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 yasuhiro_matsumura
+
+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,81 @@
+# Okuribito
+
+![okuribito](okuribito_logo.png)
+
+Okuribito is a gem to judge whether methods should be sent to the heaven :innocent:.
+Okuribito was named after a japanese movie.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'okuribito'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install okuribito
+
+## Usage
+
+Add `config/okuribito.yml` and edit it.
+
+```yml
+User:
+  - '#feed'
+Micropost:
+  - '.from_users_followed_by'
+```
+
+Edit `application.rb`
+
+```ruby
+class OkuribitoSetting < Rails::Railtie
+  config.after_initialize do
+    okuribito = Okuribito::OkuribitoPatch.new(
+      {
+        console: "back_trace",
+        slack: "https://hooks.slack.com/services/xxxxxxxxx/xxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx",
+        logging: "log/okuribito/method_called.log",
+        first_prepended: "log/okuribito/first_prepended.log"
+      }
+    )
+    okuribito.apply("okuribito.yml")
+  end
+end
+```
+
+### console
+Setting for console outout.
+- `plain` is the simplest 1 line log.
+- `back_trace` shows back trace in detail.
+
+### slack
+Setting for slack notification.
+
+### logging
+Setting for logging.
+
+### first_prepended
+Setting for logging to save when you started to monitor.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/okuribito. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "okuribito"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/okuribito/version.rb

@@ -0,0 +1,3 @@
+module Okuribito
+  VERSION = "0.0.1"
+end

data/lib/okuribito.rb

@@ -0,0 +1,144 @@
+require "okuribito/version"
+require "yaml"
+require "active_support"
+require "active_support/core_ext"
+require "net/http"
+require "uri"
+require "json"
+require "logger"
+
+module Okuribito
+  class OkuribitoPatch
+    CLASS_METHOD_SYMBOL = "."
+    INSTANCE_METHOD_SYMBOL = "#"
+    PATTERN = /\A(?<symbol>[#{CLASS_METHOD_SYMBOL}#{INSTANCE_METHOD_SYMBOL}])(?<method_name>.+)\z/
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    module PatchModule
+      def disp_console_by_okuribito(method_name, obj_name, caller_info, type)
+        case type
+        when "plane"
+          puts "#{obj_name} : #{method_name} is called."
+        when "back_trace"
+          puts "#############################################################"
+          puts "# #{obj_name} : #{method_name} is called."
+          puts "#############################################################"
+          puts caller_info
+        end
+      end
+
+      def notificate_slack_by_okuribito(method_name, obj_name, caller_info, url)
+        uri  = URI.parse(url)
+        params = {
+          text: "OKURIBITO detected a method call.",
+          username: "OKURIBITO",
+          icon_emoji: ":innocent:",
+          attachments: [{
+            fields: [{
+               title: "#{obj_name}::#{method_name}",
+               value: "#{caller_info[0]}",
+               short: false
+             }]
+          }]
+        }
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.start do
+          request = Net::HTTP::Post.new(uri.path)
+          request.set_form_data(payload: params.to_json)
+          http.request(request)
+        end
+      end
+
+      def logging_by_okuribito(symbol, method_name, obj_name, caller_info, log_path)
+        logger = Logger.new(log_path)
+        logger.formatter = proc{|severity, datetime, progname, message|
+          "#{datetime}, #{message}\n"
+        }
+
+        logger.info("#{obj_name}#{symbol}#{method_name} : #{caller_info[0]}")
+      end
+
+      def define_okuribito_patch(method_name)
+        define_method(method_name) do |*args|
+          yield(self.to_s, caller) if block_given?
+          super(*args)
+        end
+      end
+    end
+
+    def apply(yaml_path)
+      yaml = YAML.load_file(yaml_path)
+      yaml.each do |class_name, observe_methods|
+        patch_okuribito(class_name, observe_methods)
+        logging_prepended(class_name, observe_methods, @options[:first_prepended]) unless @options[:first_prepended].nil?
+      end
+    end
+
+    def patch_okuribito(class_name, observe_methods)
+      options = @options # スコープを乗り越えるために使用.
+      klass = class_name.constantize
+
+      klass.class_eval do
+        instance_method_patch = Module.new.extend(PatchModule)
+        class_method_patch    = Module.new.extend(PatchModule)
+        instance_method_patched = 0
+        class_method_patched    = 0
+
+        observe_methods.each do |observe_method|
+          next unless md = PATTERN.match(observe_method)
+          symbol, method_name = md[:symbol], md[:method_name].to_sym
+
+          case symbol
+            when INSTANCE_METHOD_SYMBOL
+              next unless klass.instance_methods.include?(method_name)
+              instance_method_patch.module_eval do
+                define_okuribito_patch(method_name) do |obj_name, caller_info|
+                  disp_console_by_okuribito(method_name, obj_name, caller_info, options[:console]) unless options[:console].nil?
+                  notificate_slack_by_okuribito(method_name, obj_name, caller_info, options[:slack]) unless options[:slack].nil?
+                  logging_by_okuribito(symbol, method_name, obj_name, caller_info, options[:logging]) unless options[:logging].nil?
+                end
+              end
+              instance_method_patched += 1
+            when CLASS_METHOD_SYMBOL
+              next unless klass.respond_to?(method_name)
+              class_method_patch.module_eval do
+                define_okuribito_patch(method_name) do |obj_name, caller_info|
+                  disp_console_by_okuribito(method_name, obj_name, caller_info, options[:console]) unless options[:console].nil?
+                  notificate_slack_by_okuribito(method_name, obj_name, caller_info, options[:slack]) unless options[:slack].nil?
+                  logging_by_okuribito(symbol, method_name, obj_name, caller_info, options[:logging]) unless options[:logging].nil?
+                end
+              end
+              class_method_patched += 1
+          end
+        end
+        prepend instance_method_patch if instance_method_patched > 0
+        singleton_class.send(:prepend, class_method_patch) if class_method_patched > 0
+      end
+    end
+
+    def logging_prepended(class_name, observe_methods, log_path)
+      # ファイル読み出して、クラス名+メソッド名だけを配列に保持する.
+      methods = []
+      if File.exist?(log_path)
+        File.open(log_path) { |f| methods = f.read.split("\n") }
+        methods.slice!(0)
+        methods.map! { |m| m.split(",")[1] }
+      end
+
+      logger = Logger.new(log_path)
+      logger.formatter = proc{|severity, datetime, progname, message|
+        "#{datetime},#{message}\n"
+      }
+
+      observe_methods.each do |observe_method|
+        method_full_name = "#{class_name}#{observe_method}"
+        logger.info(method_full_name) unless methods.include?(method_full_name)
+      end
+
+    end
+  end
+end

data/okuribito.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'okuribito/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "okuribito"
+  spec.version       = Okuribito::VERSION
+  spec.authors       = ["muramurasan"]
+  spec.email         = ["ym.works1985@gmail.com"]
+
+  spec.summary       = "Monitoring system of the method call"
+  spec.description   = "Okuribito monitors the method call by the yaml."
+  spec.homepage      = "https://github.com/muramurasan/okuribito"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "http://mygemserver.com"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 4.0"
+  spec.add_dependency "json", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: okuribito
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- muramurasan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Okuribito monitors the method call by the yaml.
+email:
+- ym.works1985@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/okuribito.rb
+- lib/okuribito/version.rb
+- okuribito.gemspec
+- okuribito_logo.png
+homepage: https://github.com/muramurasan/okuribito
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Monitoring system of the method call
+test_files: []