hbw 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 820fbb36d5486bbf4f7a81e62a508992b8197513f275d257de49d636d0a4b090
+  data.tar.gz: 72c8bbccc47e3ab5272a5cf75843cc3db8b93aaef98bf47fadcf6286a7c5bac1
+SHA512:
+  metadata.gz: 8ae608412930ed3a524536c60116c61f87ae21393a826eb08b2f940efb5325b16c94938bf74436ed094f07de9a865a5b21178e28ae63af1845263b2d73981f3b
+  data.tar.gz: 0a25eece2f08aa781c2b2ef9bbffb374cb3b2e893ff82b71939602e9d7e00685b95d9e3d3ccb1c6ac601a02296727f955a827b7d2adc42b8ec79ceba18290789

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/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/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hbw.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    hbw (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  hbw!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.7.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Nao Minami
+
+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,142 @@
+# HBW
+
+Simple wrapper of [Honeybadger](https://github.com/honeybadger-io/honeybadger-ruby).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hbw'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hbw
+
+## Usage
+
+By using `HBW.notify`, you can report error to honeybadger.io in production environment and raise error in development environment.
+
+```ruby
+HBW.notify("PaymentConfiguration", error_message, context: { company_id: self.id })
+```
+
+### Arguments
+
+```ruby
+# A. Exception only
+HBW.notify(ex)
+
+## equivalent code using `Honeybadger`
+#
+# if defined?(Honeybadger)
+#   Honeybadger.notify(ex)
+# else
+#   raise ex
+# end
+
+# B. `error_class` and `error_message`
+HBW.notify("PaymentConfiguration", "Empty payment period found in PaymentConfiguration#create_continuous_payments")
+
+## equivalent code using `Honeybadger`
+#
+# if defined?(Honeybadger)
+#   Honeybadger.notify(
+#     error_class: "PaymentConfiguration",
+#     error_message: "Empty payment period found in PaymentConfiguration#create_continuous_payments",
+#   )
+# else
+#   raise "Empty payment period found in PaymentConfiguration#create_continuous_payments"
+# end
+
+# C. With other options
+HBW.notify(
+  "PaymentConfiguration",
+  "Empty payment period found in PaymentConfiguration#create_continuous_payments",
+  context: {
+    payment_config_id: id,
+    last_payment_id: last_payment.id
+  }
+)
+
+## equivalent code using `Honeybadger`
+#
+# if defined?(Honeybadger)
+#   Honeybadger.notify(
+#     error_class: "PaymentConfiguration",
+#     error_message: "Empty payment period found in PaymentConfiguration#create_continuous_payments",
+#     context: {
+#       payment_config_id: id,
+#       last_payment_id: last_payment.id
+#     }
+#   )
+# else
+#   raise "Empty payment period found in PaymentConfiguration#create_continuous_payments"
+# end
+```
+
+### `notifce_only` option
+
+This option is default false.
+
+```ruby
+HBW.notify(ex, notice_only: true)
+
+## equivalent code using `Honeybadger`
+#
+# if defined?(Honeybadger)
+#   Honeybadger.notify(ex, error_message: "[Notice Only] #{ex.class}: #{ex.message}")
+# else
+#   raise "[Notice Only] #{ex.class}: #{ex.message}"
+# end
+
+HBW.notify("PaymentConfiguration", "Empty payment period found in PaymentConfiguration#create_continuous_payments", notice_only: true)
+
+## equivalent code using `Honeybadger`
+#
+# if defined?(Honeybadger)
+#   Honeybadger.notify(
+#     error_class: "PaymentConfiguration",
+#     error_message: "[Notice Only] Notice: Empty payment period found in PaymentConfiguration#create_continuous_payments",
+#   )
+# else
+#   raise "[Notice Only] Notice: Empty payment period found in PaymentConfiguration#create_continuous_payments"
+# end
+```
+
+### `raise_development` option
+
+This option is default true.
+
+```ruby
+# `exception` is raised
+[0] pry(main)> HBW.notify(RuntimeError.new("test error"))
+RuntimeError: test error
+
+# `exception` with specified `error_message` is raised
+[1] pry(main)> HBW.notify("PaymentConfiguration", "Empty payment period found in PaymentConfiguration#create_continuous_payments")
+RuntimeError: Empty payment period found in PaymentConfiguration#create_continuous_payments
+
+# when `raise_development: false` is specified, no exception is raised
+[2] pry(main)> HBW.notify(RuntimeError.new("test error"), raise_development: false)
+=> nil
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` 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/south37/hbw.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hbw"
+
+# 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.
+
+require "pry"
+Pry.start

data/bin/rspec

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+bundle exec rspec $1

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/hbw.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hbw/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hbw"
+  spec.version       = HBW::VERSION
+  spec.authors       = ["Nao Minami"]
+  spec.email         = ["south37777@gmail.com"]
+
+  spec.summary       = %q{Simple wrapper of Honeybadger}
+  spec.description   = %q{Simple wrapper of Honeybadger}
+  spec.homepage      = "http://github.com/south37/hbw"
+  spec.license       = "MIT"
+
+  # 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"] = "https://rubygems.org"
+  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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.7.0"
+  spec.add_development_dependency "pry"
+end

data/lib/hbw/version.rb

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

data/lib/hbw.rb

@@ -0,0 +1,182 @@
+require "hbw/version"
+
+module HBW
+  class ArgumentError < ::ArgumentError; end
+
+  class << self
+    # @overload
+    #
+    # @param [Exception] exception
+    # @param [Hash, NilClass] option
+    # @example HBW.notify(exception)
+    # @example HBW.notify(exception, { error_class: 'InvalidUserError' })
+    # def notify(exception, option = nil)
+    #
+    # @param [Exception] exception
+    # @param [String] error_class
+    # @param [String] error_message
+    # @param [Hash] context
+    # @param [Array] backtrace
+    # @param [Hash] parameters
+    # @param [String] action
+    # @param [Boolean] raise_development
+    # @param [Boolean] notice_only
+    # @example HBW.notify(exception, error_class: 'InvalidUserError')
+    # def notify(exception, error_class: nil, error_message: nil, context: nil, backtrace: nil, parameters: nil, action: nil, raise_development: true, notice_only: false)
+    #
+    # @param [String] error_class
+    # @param [String] error_message
+    # @param [Hash] context
+    # @param [Array] backtrace
+    # @param [Hash] parameters
+    # @param [String] action
+    # @param [Boolean] raise_development
+    # @param [Boolean] notice_only
+    # @example HBW.notify('InvalidUserError', 'user message must be integer, but got #{user.id}', raise_development: false)
+    # def notify(error_class, error_message, context: nil, backtrace: nil, parameters: nil, action: nil, raise_development: true, notice_only: false)
+    def notify(exception_or_error_class, option_or_error_message = nil,
+               error_class: nil, error_message: nil, context: nil, backtrace: nil, parameters: nil, action: nil,
+               raise_development: true, notice_only: false)
+      if exception_or_error_class.is_a?(Exception)
+        # option_or_error_message must be option (Hash-like object)
+        if !(option_or_error_message.nil? || option_or_error_message.respond_to?(:to_hash))
+          raise HBW::ArgumentError.new("option_or_error_message must be nil or Hash-like object, but got #{option_or_error_message}")
+        end
+        if option_or_error_message.nil?
+          opts = {}
+        else
+          opts = option_or_error_message.to_hash
+        end
+        merge_opts!(opts,
+                    error_class: error_class, error_message: error_message,
+                    context: context, backtrace: backtrace, parameters: parameters, action: action, raise_development: raise_development, notice_only: notice_only)
+        notify_raw(exception_or_error_class, opts)
+      elsif exception_or_error_class.is_a?(String)
+        # option_or_error_message must be error_message (String)
+        if option_or_error_message.nil? || !option_or_error_message.respond_to?(:to_s)
+          raise HBW::ArgumentError.new("option_or_error_message must be String-like object, but got #{option_or_error_message}")
+        end
+        # error_class and error_message must be nil
+        if (!error_class.nil? || !error_message.nil?)
+          raise HBW::ArgumentError.new("error_class must be nil but got #{error_class}, error_message must be nil but got #{error_message}")
+        end
+        opts = {}
+        merge_opts!(opts,
+                    error_class: exception_or_error_class, error_message: option_or_error_message,
+                    context: context, backtrace: backtrace, parameters: parameters, action: action, raise_development: raise_development, notice_only: notice_only)
+        notify_raw(opts)
+      else
+        raise HBW::ArgumentError.new("Invalid argument")
+      end
+
+    rescue => e
+      if should_use_honeybadger?
+        # Note: Something wrong. exception must not occur when
+        # should_use_honeybadger? is true.
+        honeybadger_notify(e)
+        return nil
+      else
+        raise e
+      end
+    end
+
+    # raise_development is supported. By default, raise_development is true.
+    # notice_only is supported. By default, notice_only is false.
+    # @param [Exception, Hash] exception_or_opts
+    # @param [Hash] opts
+    # @return [NilClass]
+    # @raise [RuntimeError]
+    def notify_raw(exception_or_opts, opts = {})
+      opts.merge!(exception_or_opts.to_hash) if exception_or_opts.respond_to?(:to_hash)
+      raise_development = opts.has_key?(:raise_development) ? opts.delete(:raise_development) : true
+      notice_only       = opts.has_key?(:notice_only)       ? opts.delete(:notice_only)       : false
+
+      if notice_only
+        opts[:error_message] = "[Notice Only] #{error_class(exception_or_opts, opts)}: #{error_message(exception_or_opts, opts)}"
+      end
+
+      # QA, Production
+      if should_use_honeybadger?
+        if exception_or_opts.respond_to?(:to_hash)  # Already merged to opts
+          honeybadger_notify(opts)
+        else
+          honeybadger_notify(exception_or_opts, opts)
+        end
+        return nil
+      end
+
+      # Development
+      return nil if !raise_development
+
+      if notice_only
+        raise opts[:error_message]
+      else
+        raise exception_or_error_message(exception_or_opts, opts)
+      end
+
+      nil
+    end
+
+  private
+
+    def merge_opts!(opts, error_class:, error_message:, context:, backtrace:, parameters:, action:, raise_development:, notice_only:)
+      opts.merge!(error_class:   error_class)   if !error_class.nil?
+      opts.merge!(error_message: error_message) if !error_message.nil?
+      opts.merge!(context:       context)       if !context.nil?
+      opts.merge!(backtrace:     backtrace)     if !backtrace.nil?
+      opts.merge!(parameters:    parameters)    if !parameters.nil?
+      opts.merge!(action:        action)        if !action.nil?
+      opts.merge!(
+        raise_development: raise_development,
+        notice_only:       notice_only,
+      )
+    end
+
+    # @return [Boolean]
+    def should_use_honeybadger?
+      defined?(Honeybadger)
+    end
+
+    # @param [Exception, Hash] exception_or_opts
+    # @param [Hash] opts
+    def honeybadger_notify(exception_or_opts, opts = {})
+      ::Honeybadger.notify(exception_or_opts, opts)
+    end
+
+    # @param [Exception, Hash] exception_or_opts
+    # @param [Hash] opts
+    # @return [String] error class
+    def error_class(exception_or_opts, opts)
+      if exception_or_opts.is_a?(Exception)
+        exception_or_opts.class.name
+      else
+        'Notice'
+      end
+    end
+
+    # @param [Exception, Hash] exception_or_opts
+    # @param [Hash] opts
+    # @return [String] error message
+    def error_message(exception_or_opts, opts)
+      e = exception_or_error_message(exception_or_opts, opts)
+      if e.is_a?(Exception)
+        e.message
+      else
+        e
+      end
+    end
+
+    # @param [Exception, Hash] exception_or_opts
+    # @param [Hash] opts
+    # @return [Exception, String] exception or error message
+    def exception_or_error_message(exception_or_opts, opts)
+      if exception_or_opts.is_a?(Exception)
+        exception_or_opts
+      elsif exception_or_opts.respond_to?(:to_hash) && (opts[:exception] || opts[:error_message])
+        opts[:exception] || opts[:error_message]
+      else
+        exception_or_opts.to_s
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: hbw
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nao Minami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !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'
+description: Simple wrapper of Honeybadger
+email:
+- south37777@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- hbw.gemspec
+- lib/hbw.rb
+- lib/hbw/version.rb
+homepage: http://github.com/south37/hbw
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Simple wrapper of Honeybadger
+test_files: []