ownership 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 38e0f9794b246e9f4d788f460db5aeb663f6f45e
-  data.tar.gz: a7d3477d27cbd3aa0cddd55269246922d198a919
+SHA256:
+  metadata.gz: c82864cfbec98aec876ca43197e865d246e6dad17187844c4024fc46af6b81f2
+  data.tar.gz: 04e54a16dfce05d2ff93a789edd861df94af852950439c7a3a8ba65506aa610d
 SHA512:
-  metadata.gz: c57c183a32991967c30aba4a926d4c1ef2076b8100d4ae7aa09e32e3ea395214fe3d833209263fd399547105c3ab9484676eeba0f9ee5577889f1b60524b6146
-  data.tar.gz: d3df7b1a97faacd87fb05248001358244466c656a2fc9fa2fb2638a670729f9cd60ac42468d207afe1f0c68f6ff9471bec0bb992559056bb1ee787ac9999218d
+  metadata.gz: 56da0f7adfacf7fc289ceddc5fb0061d7b138539158fc7769081755b8f9d7af2020853212b544554708f62a67547852c93297487dff9f0fe7adeee11c973d7b7
+  data.tar.gz: 457826075fb853877bc3940bb0cc3364807983a42fe0ec29a0cd66e732186e03b7cb5534a643d785d87fb1e9a4341d926533b49e72babb2ccd1d34f88b7fc5d7

data/CHANGELOG.md

@@ -1,3 +1,18 @@
-## 0.1.0
+## 0.2.0 (2022-04-26)
+
+- Fixed issue with nested `owner` blocks
+- Dropped support for Ruby < 2.6
+
+## 0.1.2 (2022-03-11)
+
+- Added Active Record query log tags integration
+
+## 0.1.1 (2019-10-27)
+
+- Added Honeybadger integration
+- Made `owner` method private to behave like `Kernel` methods
+- Fixed conflict with Pry
+
+## 0.1.0 (2017-11-05)
 
 - First release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017-2022 Andrew Kane
+
+MIT License
+
+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

@@ -1,15 +1,19 @@
 # Ownership
 
-Code ownership for your Rails app
+Code ownership for Rails
+
+Check out [Scaling the Monolith](https://ankane.org/scaling-the-monolith) for other tips
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
+[![Build Status](https://github.com/ankane/ownership/workflows/build/badge.svg?branch=master)](https://github.com/ankane/ownership/actions)
+
 ## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'ownership'
+gem "ownership"
 ```
 
 ## Getting Started
@@ -63,9 +67,49 @@ Ownership.default_owner = :logistics
 
 There are a few built-in integrations with other gems.
 
+- [Active Record](#active-record)
+- [Honeybadger](#honeybadger)
+- [Marginalia](#marginalia)
+- [Rollbar](#rollbar)
+
+You can also add [custom integrations](#custom-integrations).
+
+### Active Record
+
+Active Record 7+ has the option to add comments to queries.
+
+```sql
+SELECT ...
+/*application:MyApp,controller:posts,action:index,owner:logistics*/
+```
+
+Add to `config/application.rb`:
+
+```ruby
+config.active_record.query_log_tags_enabled = true
+config.active_record.query_log_tags << :owner
+```
+
+### Honeybadger
+
+[Honeybadger](https://github.com/honeybadger-io/honeybadger-ruby) tracks exceptions. This integration makes it easy to send exceptions to different projects based on the owner. We recommend having a project for each team.
+
+```ruby
+Ownership::Honeybadger.api_keys = {
+  logistics: "token1",
+  customers: "token2"
+}
+```
+
+Also works with a proc
+
+```ruby
+Ownership::Honeybadger.api_keys = ->(owner) { ENV["#{owner.to_s.upcase}_HONEYBADGER_API_KEY"] }
+```
+
 ### Marginalia
 
-[Marginalia](https://github.com/basecamp/marginalia) adds comments to ActiveRecord queries. If installed, the owner is added.
+[Marginalia](https://github.com/basecamp/marginalia) adds comments to Active Record queries. If installed, the owner is added.
 
 ```sql
 SELECT ...
@@ -88,7 +132,13 @@ Ownership::Rollbar.access_token = {
 Also works with a proc
 
 ```ruby
-Ownership::Rollbar.access_token = -> (owner) { ENV["#{owner.to_s.upcase}_ROLLBAR_ACCESS_TOKEN"] }
+Ownership::Rollbar.access_token = ->(owner) { ENV["#{owner.to_s.upcase}_ROLLBAR_ACCESS_TOKEN"] }
+```
+
+For version 3.1+ of the `rollbar` gem, add to `config/initializers/rollbar.rb`:
+
+```ruby
+config.use_payload_access_token = true
 ```
 
 ## Custom Integrations
@@ -137,3 +187,12 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/ownership/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/ownership.git
+cd ownership
+bundle install
+bundle exec rake test
+```

data/lib/ownership/global_methods.rb

@@ -1,6 +1,13 @@
 module Ownership
   module GlobalMethods
-    def owner(owner, &block)
+    private
+
+    def owner(*args, &block)
+      return super if is_a?(Method) # hack for pry
+
+      owner = args[0]
+      # same error message as Ruby
+      raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 1)" if args.size != 1
       raise ArgumentError, "Missing block" unless block_given?
 
       previous_value = Thread.current[:ownership_owner]
@@ -15,7 +22,7 @@ module Ownership
             block.call
           end
         rescue Exception => e
-          e.owner = owner
+          e.owner ||= owner
           raise
         end
       ensure

data/lib/ownership/honeybadger.rb

@@ -0,0 +1,47 @@
+module Ownership
+  module Honeybadger
+    class << self
+      attr_reader :api_keys
+
+      def api_keys=(api_keys)
+        @api_keys = api_keys
+        @configuration ||= configure
+        api_keys
+      end
+
+      private
+
+      def add_owner_as_tag(notice, current_owner)
+        return unless current_owner
+
+        notice.tags << current_owner.to_s
+      end
+
+      def configure
+        ::Honeybadger.configure do |config|
+          config.before_notify do |notice|
+            current_owner = notice.exception.owner if notice.exception.is_a?(Exception)
+            current_owner ||= Ownership.owner
+
+            add_owner_as_tag(notice, current_owner)
+            use_owner_api_key(notice, current_owner)
+          end
+        end
+      end
+
+      def owner_api_key(current_owner)
+        api_keys.respond_to?(:call) ? api_keys.call(current_owner) : api_keys[current_owner]
+      end
+
+      def use_owner_api_key(notice, current_owner)
+        return unless current_owner
+
+        if (api_key = owner_api_key(current_owner))
+          notice.api_key = api_key
+        else
+          warn "[ownership] Missing Honeybadger API key for owner: #{current_owner}"
+        end
+      end
+    end
+  end
+end

data/lib/ownership/version.rb

@@ -1,3 +1,3 @@
 module Ownership
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/ownership.rb

@@ -1,4 +1,5 @@
 require "ownership/global_methods"
+require "ownership/honeybadger"
 require "ownership/rollbar"
 require "ownership/version"
 
@@ -13,7 +14,7 @@ module Ownership
   end
 end
 
-Object.send :include, Ownership::GlobalMethods
+Object.include Ownership::GlobalMethods
 
 if defined?(ActiveSupport)
   ActiveSupport.on_load(:action_controller) do
@@ -22,6 +23,10 @@ if defined?(ActiveSupport)
   end
 
   ActiveSupport.on_load(:active_record) do
+    if ActiveRecord::VERSION::MAJOR >= 7
+      ActiveRecord::QueryLogs.taggings[:owner] ||= -> { Ownership.owner }
+    end
+
     require "ownership/marginalia" if defined?(Marginalia)
   end
 

metadata

@@ -1,109 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: ownership
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  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'
-- !ruby/object:Gem::Dependency
-  name: activejob
-  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'
-- !ruby/object:Gem::Dependency
-  name: marginalia
-  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: 
-email:
-- andrew@chartkick.com
+date: 2022-04-26 00:00:00.000000000 Z
+dependencies: []
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
+- LICENSE.txt
 - README.md
-- Rakefile
 - lib/ownership.rb
 - lib/ownership/controller_methods.rb
 - lib/ownership/global_methods.rb
+- lib/ownership/honeybadger.rb
 - lib/ownership/job_methods.rb
 - lib/ownership/marginalia.rb
 - lib/ownership/rollbar.rb
 - lib/ownership/version.rb
-- ownership.gemspec
 homepage: https://github.com/ankane/ownership
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,16 +39,15 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: Code ownership for your Rails app
+summary: Code ownership for Rails
 test_files: []

data/.gitignore

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

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in ownership.gemspec
-gemspec

data/Rakefile

@@ -1,11 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-  t.warning = false
-end
-
-task default: :test

data/ownership.gemspec

@@ -1,27 +0,0 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ownership/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "ownership"
-  spec.version       = Ownership::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-
-  spec.summary       = "Code ownership for your Rails app"
-  spec.homepage      = "https://github.com/ankane/ownership"
-
-  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"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "activejob"
-  spec.add_development_dependency "marginalia"
-end