peak_flow_utils 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37a78b46beae7ae1bc88bc68eb7d0c1d28d75dadcae7d2629876ad2003d7183f
-  data.tar.gz: fa714fbc49871837c9f85bfc029476e01e730801abe935fa959517478c1dd266
+  metadata.gz: 1bdc19548c94f5a84768b360d892e622d4a43e2b93aabd2211ff01aaa90aee1f
+  data.tar.gz: 9144161819e38594b3b8adefd74d9f60c7b9de2c1e5873c5f007058d4ea74eb5
 SHA512:
-  metadata.gz: 25eff4b17a70c74bf924184b47f575e1238b151c85b744cefa80b310e78b906c053bfe08658f44383bbd6154d1c669d5bca0615f11f96b4bb66280f67722a594
-  data.tar.gz: 3fed80233a8684233797f4010e20310f7b081bd63e88828de069753a5b67c964b36e57a83e9806cbe54a42a5d99b340eff2ce6b48a4aefbf3dcf55f544dbb116
+  metadata.gz: bb753bd4bda442fae033de2b2d1f05a3815f0584ca54a263ffc2d8e2647692cb3af6f40289c7989301087ff0d44cf727681e4a370dc50fba14bd504a71457f57
+  data.tar.gz: 0b8b67efb910799b5a78dda78c12f2e85ac4e45144493d662babafa03dc328f40f2bf4814030fab49072716b5285976c965460e13fc25f9c8965217933b452a2

data/README.md

@@ -1,14 +1,12 @@
-# PeakFlowUtils
-Short description and motivation.
+# PeakflowUtils
 
-## Usage
-How to use my plugin.
+Various tools to use with www.peakflow.io.
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'peak_flow_utils'
+gem "peak_flow_utils"
 ```
 
 And then execute:
@@ -21,6 +19,33 @@ Or install it yourself as:
 $ gem install peak_flow_utils
 ```
 
+Add this to `config/peakflow.rb`:
+```ruby
+PeakFlowUtils::Notifier.configure(auth_token: "your-token")
+```
+
+## Usage
+
+### Reporting errors manually
+
+```ruby
+PeakFlowUtils::Notifier.notify(error: error)
+```
+
+### Reporting Rails errors
+
+Add this to `config/peakflow.rb`:
+```ruby
+PeakFlowUtils::NotifierRails.configure
+```
+
+### Reporting Sidekiq errors in Rails:
+
+Add this to `config/peakflow.rb`:
+```ruby
+PeakFlowUtils::NotifierSidekiq.configure
+```
+
 ## Contributing
 Contribution directions go here.
 

data/app/handlers/peak_flow_utils/validations_handler.rb

@@ -23,11 +23,11 @@ class PeakFlowUtils::ValidationsHandler < PeakFlowUtils::ApplicationHandler
             translations_for_format_validator(validator, model_inspector, attribute_name, yielder)
           elsif validator.is_a?(ActiveRecord::Validations::UniquenessValidator)
             translations_for_uniqueness_validator(validator, model_inspector, attribute_name, yielder)
-          elsif validator.class.name == "ActiveRecord::Validations::PresenceValidator"
+          elsif validator.class.name == "ActiveRecord::Validations::PresenceValidator" # rubocop:disable Style/ClassEqualityComparison
             translations_for_presence_validator(validator, model_inspector, attribute_name, yielder)
-          elsif validator.class.name == "EmailValidator"
+          elsif validator.class.name == "EmailValidator" # rubocop:disable Style/ClassEqualityComparison
             translations_for_email_validator(validator, model_inspector, attribute_name, yielder)
-          elsif validator.class.name == "ActiveModel::Validations::ConfirmationValidator"
+          elsif validator.class.name == "ActiveModel::Validations::ConfirmationValidator" # rubocop:disable Style/ClassEqualityComparison
             translations_for_confirmation_validator(validator, model_inspector, attribute_name, yielder)
           else
             Rails.logger.error "Unhandeled validator: #{validator.class.name}"

data/app/services/peak_flow_utils/erb_inspector/file_inspector.rb

@@ -58,19 +58,19 @@ class PeakFlowUtils::ErbInspector::FileInspector
 private
 
   def parse_content_liquid(line_no, line, translations_found, yielder)
-    line.scan(/\"([^\"]+?)\"\s+\|\s+t\s*(\%}|\}\}|\|)/) do |match|
+    line.scan(/"([^"]+?)"\s+\|\s+t\s*(%}|\}\}|\|)/) do |match|
       add_translation(line_no, "t", match[0], translations_found, yielder)
     end
 
-    line.scan(/\'([^\']+?)\'\s+\|\s+t\s*(\%}|\}\}|\|)/) do |match|
+    line.scan(/'([^']+?)'\s+\|\s+t\s*(%}|\}\}|\|)/) do |match|
       add_translation(line_no, "t", match[0], translations_found, yielder)
     end
 
-    line.scan(/\"([^\"]+?)\"\s+\|\s+val:\s*\"([^\"]+?)\"\s*,\s*(.+?)\s*\|\s+t\s*/) do |match|
+    line.scan(/"([^"]+?)"\s+\|\s+val:\s*"([^"]+?)"\s*,\s*(.+?)\s*\|\s+t\s*/) do |match|
       add_translation(line_no, "t", match[0], translations_found, yielder)
     end
 
-    line.scan(/'([^\"]+?)'\s+\|\s+val:\s*'([^\"]+?)'\s*,\s*(.+?)\s*\|\s+t\s*/) do |match|
+    line.scan(/'([^"]+?)'\s+\|\s+val:\s*'([^"]+?)'\s*,\s*(.+?)\s*\|\s+t\s*/) do |match|
       add_translation(line_no, "t", match[0], translations_found, yielder)
     end
   end

data/app/services/peak_flow_utils/erb_inspector/translation_inspector.rb

@@ -27,7 +27,7 @@ class PeakFlowUtils::ErbInspector::TranslationInspector
   end
 
   def global?
-    !relative? && !key.include?(".")
+    !relative? && key.exclude?(".")
   end
 
   def relative?
@@ -49,16 +49,16 @@ private
         is_mailer = true
       elsif @full_key.start_with?("app/views/")
         # Remove "app/views" from view-translations since that doesn't get used in keys.
-        @full_key.gsub!(/\Aapp\/views\//, "")
+        @full_key.delete_prefix!("app/views/")
       elsif @full_key.start_with?("app/controllers")
         # Remove "app/controllers" from controller-translations since that doesn't get used in keys.
         @full_key.gsub!(/\Aapp\/controllers(\/?)/, "")
         is_controller = true
       elsif @full_key.start_with?("app/cells")
-        @full_key.gsub!(/\Aapp\/cells\//, "")
+        @full_key.delete_prefix!("app/cells/")
       elsif @full_key.start_with?("app/")
         # Remove "app" from controller- and helper-translations since that doesn't get used.
-        @full_key.gsub!(/\Aapp\//, "")
+        @full_key.delete_prefix!("app/")
       end
 
       @full_key.tr!("/", ".")
@@ -66,7 +66,7 @@ private
       @full_key << file_key(@file_path)
       @full_key << ".#{@last_method}" if (is_mailer || is_controller) && @last_method && @method != "controller_t"
       @full_key << "."
-      @full_key << @key.gsub(/\A\./, "")
+      @full_key << @key.delete_prefix(".")
     elsif @method == "I18n-js.t" || @method == "t" || @method == "helper_t" || @method == "controller_t"
       @full_key = @key
     else
@@ -81,10 +81,10 @@ private
     key = key.match(/\A(.+?)\./)[1]
 
     # Remove leading "_" from partials
-    key = key.gsub(/\A_/, "")
+    key.delete_prefix!("_")
 
     # Remove '_controller' from controllers
-    key = key.gsub(/_controller\Z/, "")
+    key.delete_suffix!("_controller")
 
     key
   end

data/app/services/peak_flow_utils/model_inspector.rb

@@ -1,5 +1,6 @@
 class PeakFlowUtils::ModelInspector
   attr_reader :clazz
+
   cattr_accessor :models_loaded
 
   # Yields a model-inspector for each model found in the application.

data/lib/peak_flow_utils.rb

@@ -6,6 +6,12 @@ require "service_pattern"
 module PeakFlowUtils
   path = "#{File.dirname(__FILE__)}/peak_flow_utils"
 
+  autoload :Notifier, "#{path}/notifier"
+  autoload :NotifierErrorParser, "#{path}/notifier_error_parser"
+  autoload :NotifierRack, "#{path}/notifier_rack"
+  autoload :NotifierRails, "#{path}/notifier_rails"
+  autoload :NotifierResponse, "#{path}/notifier_response"
+  autoload :NotifierSidekiq, "#{path}/notifier_sidekiq"
   autoload :RspecHelper, "#{path}/rspec_helper"
   autoload :HandlerHelper, "#{path}/handler_helper"
 end

data/lib/peak_flow_utils/notifier.rb

@@ -0,0 +1,61 @@
+class PeakFlowUtils::Notifier
+  class NotConfiguredError < RuntimeError; end
+
+  attr_reader :auth_token
+
+  def self.configure(auth_token:)
+    @current = PeakFlowUtils::Notifier.new(auth_token: auth_token)
+  end
+
+  def self.current
+    raise PeakFlowUtils::Notifier::NotConfiguredError, "Hasn't been configured" unless @current
+
+    @current
+  end
+
+  def self.notify(*args)
+    PeakFlowUtils::Notifier.current.notify(*args)
+  end
+
+  def initialize(auth_token:)
+    @auth_token = auth_token
+  end
+
+  def notify(error:, environment: nil, parameters: nil)
+    error_parser = PeakFlowUtils::NotifierErrorParser.new(
+      backtrace: error.backtrace,
+      environment: environment,
+      error: error
+    )
+
+    uri = URI("https://www.peakflow.io/errors/reports")
+
+    https = Net::HTTP.new(uri.host, uri.port)
+    https.use_ssl = true
+
+    data = {
+      auth_token: auth_token,
+      error: {
+        backtrace: error.backtrace,
+        environment: error_parser.cleaned_environment,
+        error_class: error.class.name,
+        file_path: error_parser.file_path,
+        line_number: error_parser.line_number,
+        message: error.message,
+        parameters: parameters,
+        remote_ip: error_parser.remote_ip,
+        url: error_parser.url,
+        user_agent: error_parser.user_agent
+      }
+    }
+
+    request = Net::HTTP::Post.new(uri.path)
+    request["Content-Type"] = "application/json"
+    request.body = JSON.generate(data)
+
+    response = https.request(request)
+    response_data = JSON.parse(response.body)
+
+    PeakFlowUtils::NotifierResponse.new(url: response_data["url"]) # URL not always present so dont use fetch
+  end
+end

data/lib/peak_flow_utils/notifier_error_parser.rb

@@ -0,0 +1,53 @@
+class PeakFlowUtils::NotifierErrorParser
+  attr_reader :backtrace, :environment, :error, :file_path, :line_number
+
+  def initialize(backtrace:, environment:, error:)
+    @backtrace = backtrace
+    @environment = environment || {}
+    @error = error
+
+    detect_file_path_and_line_number
+  end
+
+  def detect_file_path_and_line_number
+    backtrace.each do |trace|
+      match = trace.match(/^((.+)\.([A-z]{2,4})):(\d+)(:|$)/)
+      next unless match
+
+      file_path = match[1]
+      line_number = match[4].to_i
+
+      next if file_path.include?("/.rvm/")
+
+      @file_path ||= file_path
+      @line_number ||= line_number
+
+      break
+    end
+  end
+
+  def cleaned_environment
+    environment.reject do |key, _value|
+      key.start_with?("action_controller.", "action_dispatch.", "puma.", "rack.") || key == "warden"
+    end
+  end
+
+  def remote_ip
+    environment["HTTP_X_FORWARDED_FOR"] || environment["REMOTE_ADDR"]
+  end
+
+  def url
+    return unless environment["REQUEST_URI"]
+
+    url = "http"
+    url << "s" if environment["SERVER_PORT"] == 443 || environment["rack.url_scheme"] == "https" || environment["HTTPS"] == "on"
+    url << "://"
+    url << environment["HTTP_HOST"]
+    url << environment["REQUEST_URI"]
+    url
+  end
+
+  def user_agent
+    environment["HTTP_USER_AGENT"]
+  end
+end

data/lib/peak_flow_utils/notifier_rack.rb

@@ -0,0 +1,22 @@
+class PeakFlowUtils::NotifierRack
+  def initialize(app, options = {})
+    @app = app
+    @options = options
+  end
+
+  def call(env)
+    @app.call(env)
+  rescue Exception => e # rubocop:disable Lint/RescueException
+    controller = env["action_controller.instance"]
+    request = controller&.request
+    parameters = {}.merge(request.GET).merge(request.POST)
+
+    PeakFlowUtils::Notifier.notify(
+      environment: env,
+      error: e,
+      parameters: parameters
+    )
+
+    raise e
+  end
+end

data/lib/peak_flow_utils/notifier_rails.rb

@@ -0,0 +1,5 @@
+class PeakFlowUtils::NotifierRails
+  def self.configure
+    Rails.application.config.app_middleware.use PeakFlowUtils::NotifierRack
+  end
+end

data/lib/peak_flow_utils/notifier_response.rb

@@ -0,0 +1,7 @@
+class PeakFlowUtils::NotifierResponse
+  attr_reader :url
+
+  def initialize(url:)
+    @url = url
+  end
+end

data/lib/peak_flow_utils/notifier_sidekiq.rb

@@ -0,0 +1,11 @@
+class PeakFlowUtils::NotifierSidekiq
+  def self.configure
+    require "sidekiq"
+
+    Sidekiq.configure_server do |config|
+      config.error_handlers << proc do |error, _context|
+        PeakFlowUtils::Notifier.notify(error: error)
+      end
+    end
+  end
+end

data/lib/peak_flow_utils/rspec_helper.rb

@@ -118,7 +118,7 @@ class PeakFlowUtils::RspecHelper
         value1 = file1.fetch(:points)
       end
 
-      if file2_data && file2_data && file2_data.fetch(:seconds) != 0.0 && file2_data.fetch(:seconds) != 0.0
+      if file2_data && file1_data && file2_data.fetch(:seconds) != 0.0 && file2_data.fetch(:seconds) != 0.0
         value2 = file2_data[:seconds]
       else
         value2 = file2.fetch(:points)
@@ -175,7 +175,7 @@ private
   end
 
   def ignore_type?(type)
-    only_types && !only_types.include?(type)
+    only_types && !only_types.include?(type) # rubocop:disable Rails/NegateInclude:, Style/SafeNavigation
   end
 
   def type_from_path(file_path)

data/lib/peak_flow_utils/version.rb

@@ -1,3 +1,3 @@
 module PeakFlowUtils
-  VERSION = "0.1.10".freeze
+  VERSION = "0.1.11".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peak_flow_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2020-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -156,6 +142,7 @@ files:
 - app/models/peak_flow_utils/scanned_file.rb
 - app/models/peak_flow_utils/translation_key.rb
 - app/models/peak_flow_utils/translation_value.rb
+- app/services/peak_flow_utils/application_migration.rb
 - app/services/peak_flow_utils/application_service.rb
 - app/services/peak_flow_utils/attribute_service.rb
 - app/services/peak_flow_utils/configuration_service.rb
@@ -180,7 +167,12 @@ files:
 - lib/peak_flow_utils/migrations/20150908085500_create_translation_values.rb
 - lib/peak_flow_utils/migrations/20150908090800_create_handler_texts.rb
 - lib/peak_flow_utils/migrations/20160411190500_create_scanned_files.rb
-- lib/peak_flow_utils/migrations/peak_flow_utils/application_migration.rb
+- lib/peak_flow_utils/notifier.rb
+- lib/peak_flow_utils/notifier_error_parser.rb
+- lib/peak_flow_utils/notifier_rack.rb
+- lib/peak_flow_utils/notifier_rails.rb
+- lib/peak_flow_utils/notifier_response.rb
+- lib/peak_flow_utils/notifier_sidekiq.rb
 - lib/peak_flow_utils/rspec_helper.rb
 - lib/peak_flow_utils/version.rb
 - lib/tasks/peak_flow_utils_tasks.rake
@@ -196,7 +188,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="