roda-scoutapm 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8a5ffd2676d83a613affafd83fffad4676bd2a63eefa5a6afc97635ab9ace04
-  data.tar.gz: 67b45e8a56f652229448c6a0d2421ea259f8d17857a9d56afd1436a8e0c8ed74
+  metadata.gz: b2d841f5f709f8a5a25de0c3e2cbd117475f74c7a333c12465ea4ab55f996d9e
+  data.tar.gz: 24bfd4bd3f231597a5dbcd550c2aa6b527345b7c5113cc37531094c40974d148
 SHA512:
-  metadata.gz: 6ba928b665363d4933d05fdce9acd9ac862d84b7ab083854016576c7c1f453dae8545f7151aeec31eef1c4b2d2f6db1abd3c338934c6f2e075033373af34fbfb
-  data.tar.gz: b63f9baedac17e1d9744e2b40d06da619a38e8d100e1401a292f828e8e8800c7d3c80d3c1d6afa0daf66102e4833bbc2242614352022427301e3cfd8799a48ff
+  metadata.gz: f73c7df1298c1d874289a00bd3185f04fb5c552863136ba3849f3f4a98101dda4a20bcb220b4fad599d3eff9c4e44b48122910306ae9f4cf9813987b5746d794
+  data.tar.gz: 8cc57db8f374921d1df4147ca687a024b30391b3f39c2cabdb112f2a7b14740360bc7664791bcfab40a660636cea8db821058c484517b5bae1f2de8b5dc583d5

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
+  SuggestExtensions: false
   TargetRubyVersion: 2.6
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.1.3] - 2022-11-26
+
+- Fix blank method definition when it's not needed, e.g. in Rails apps
+
+## [0.1.2] - 2022-11-11
+
+- Fix for specs
+
 ## [0.1.0] - 2022-11-11
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roda-scoutapm (0.1.0)
+    roda-scoutapm (0.1.3)
       roda
       scout_apm
 

data/README.md

@@ -1,8 +1,8 @@
-# Roda::Scoutapm
+# Roda plugin for ScoutApm instrumentation
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/roda/scoutapm`. To experiment with that code, run `bin/console` for an interactive prompt.
+This plugin adds [ScoutApm](https://scoutapm.com/) instrumentation to [Roda](https://github.com/jeremyevans/roda) applications.
 
-TODO: Delete this and the text above, and describe your gem
+It uses ScoutApm [Rack instrumentation ](https://scoutapm.com/docs/ruby/rack)
 
 ## Installation
 
@@ -16,7 +16,33 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+First, you need to add credentials to config/scout_apm.yml or ENV variables as ScoutApm requires.
+
+Than you need to add the ScoutApm::Rack.install! startup call as close to the spot you run your Rack application as possible. install! should be called after you require other gems (ActiveRecord, Mongo, etc) to install instrumentation for those libraries.
+
+```ruby
+#config.ru
+require_relative 'app'
+
+require 'scout_apm'
+ScoutApm::Rack.install!
+
+run App
+```
+
+```ruby
+class App < Roda
+  plugin :scoutapm
+
+  route do |r|
+    r.is 'foo' do
+      r.get do
+        'hello world'
+      end
+    end
+  end
+end
+```
 
 ## Development
 
@@ -26,7 +52,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/roda-scoutapm.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Alexey2257/roda-scoutapm.
 
 ## License
 

data/lib/roda/plugins/scoutapm/version.rb

@@ -3,7 +3,7 @@
 class Roda
   module RodaPlugins
     module Scoutapm
-      VERSION = "0.1.0"
+      VERSION = "0.1.3"
     end
   end
 end

data/lib/roda/plugins/scoutapm.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
-require_relative '../../blank'
+
+require_relative "../../blank" unless String.new.respond_to?(:blank?)
 
 class Roda
+  # Integrate in Roda
   module RodaPlugins
     module Scoutapm
-      # module ClassMethods
-      #   def call(env)
-      #     ScoutApm::Rack.transaction(env['REQUEST_PATH'], env) do
-      #       app.call(env)
-      #     end
-      #   end
-      # end
+      # Inspect transaction on every request
       module RequestMethods
         private
 
         def always
-          ScoutApm::Rack.transaction(inspect.gsub(/[#<>]/, ''), env) do
+          if defined? ::ScoutApm
+            ::ScoutApm::Rack.transaction(inspect.gsub(/[#<>]/, ""), env) do
+              super
+            end
+          else
             super
           end
         end

data/roda-scoutapm.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "roda/plugins/scoutapm/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "roda-scoutapm"
+  spec.version = Roda::RodaPlugins::Scoutapm::VERSION
+  spec.authors = ["Alexey Ivanov"]
+  spec.email = ["a.ivanov@3commas.io"]
+
+  spec.summary = "ScoutApm instrumentation for Roda apps/routes"
+  spec.description = "ScoutApm instrumentation for Roda apps/routes"
+  spec.homepage = "https://github.com/Alexey2257/roda-scoutapm"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Alexey2257/roda-scoutapm"
+  spec.metadata["changelog_uri"] = "https://github.com/Alexey2257/roda-scoutapm/CHANGELOG"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "roda"
+  spec.add_dependency "scout_apm"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda-scoutapm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Alexey Ivanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-12 00:00:00.000000000 Z
+date: 2022-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roda
@@ -56,6 +56,7 @@ files:
 - lib/roda/plugins/scoutapm.rb
 - lib/roda/plugins/scoutapm/version.rb
 - lib/roda/scoutapm.rb
+- roda-scoutapm.gemspec
 - sig/roda/scoutapm.rbs
 homepage: https://github.com/Alexey2257/roda-scoutapm
 licenses:
@@ -64,6 +65,7 @@ metadata:
   homepage_uri: https://github.com/Alexey2257/roda-scoutapm
   source_code_uri: https://github.com/Alexey2257/roda-scoutapm
   changelog_uri: https://github.com/Alexey2257/roda-scoutapm/CHANGELOG
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -72,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="