barsoom_utils 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5c4a4cdd58c36b3f57238e598a74ca4e3a2c64c3c4fea946413c451141a6545
+  data.tar.gz: 42215d01e3f207796368dd691a46c05f761f2c2031d0047a4d17173914c15e0d
+SHA512:
+  metadata.gz: bc2d73e1c4b8e876a75286387bf25c3982d5229d2bf2b600b66ad292799b009acc68395512485e489540b50dc28fd65ec764b15c9179fe8f4fcf75e0c2ec096f
+  data.tar.gz: a9a1bb896ead589837004ff62cce39d98536c14bed2341aa5e563ed90807356ba1a7aa265bb81bb7a71e913f0ea1c7878254e8768f6e1c21601cccf7cbffa20c

data/.gitignore

@@ -0,0 +1,13 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all tempfiles.
+/tmp
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: "./shared_rubocop.yml"

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in barsoom_utils.gemspec
+gemspec

data/README.md

@@ -0,0 +1,94 @@
+# BarsoomUtils
+
+Barsoom Utils is our internal toolbox for small classes that we share in most of our projects.
+
+This gem is intentionally not released since it's for internal use, but we keep it open
+source since it might have some value for others.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "barsoom_utils", github: "barsoom/barsoom_utils"
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+You need to explicitly require each class you want to use.
+Also note that we use BarsoomUtils as namespace.
+
+List of utils:
+
+```ruby
+require "barsoom_utils/exception_notifier" #  Notify devs about an exception without necessarily letting it appear to the user as a 500 error.
+require "barsoom_utils/spec/debug_helpers" #  Add show_page helper for capybara feature specs
+require "barsoom_utils/feature_toggle"     #  Convenient way of hiding/showing a feature.
+require "barsoom_utils/ping_health_check"  #  Report running of background jobs to healthchecks.io. NOTE: You need to set the env ENABLE_HEALTH_CHECKS=true to enable reporting (only set it in production).
+```
+
+We also have some shared configuration. To use our Rubocop configuration, add this to the beginning of your `.rubocop.yml`.
+
+If you use Rails (also make sure `rubocop-rails` is in your `Gemfile`):
+
+```yaml
+require: rubocop-rails
+
+inherit_gem:
+  barsoom_utils:
+    - shared_rubocop.yml
+    - shared_rubocop_rails.yml
+```
+
+If you don't use Rails:
+
+```yaml
+inherit_gem:
+  barsoom_utils:
+    - shared_rubocop.yml
+```
+
+## Developing
+
+Running tests:
+
+    rake
+
+## Contributing
+
+1. Fork it ( https://github.com/barsoom/barsoom_utils/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Add some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Credits and license
+
+By [Barsoom](http://barsoom.se) under the MIT license:
+
+Copyright (c) 2014 Barsoom AB
+
+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/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/barsoom_utils.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "barsoom_utils/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "barsoom_utils"
+  spec.version       = BarsoomUtils::VERSION
+  spec.authors       = [ "Tomas Skogberg" ]
+  spec.email         = [ "tomas.skogberg@gmail.com" ]
+  spec.summary       = %q{Various helpful utils}
+  spec.homepage      = "http://barsoom.se"
+  spec.license       = "MIT"
+  spec.metadata      = { "rubygems_mfa_required" => "true" }
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = [ "lib" ]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "httparty"
+  spec.add_development_dependency "lolcat"
+  spec.add_development_dependency "attr_extras"
+  spec.add_development_dependency "redis"
+  spec.add_development_dependency "honeybadger"
+  spec.add_development_dependency "fixme"
+  spec.add_development_dependency "rubocop"
+
+  # Run time dependencies should not be specified here. You are unlikely to use all of BarsoomUtils in each project, so instead, add the gems that are needed in the project.
+end

data/lib/barsoom_utils/exception_notifier.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+# Notify devs about an exception without necessarily
+# letting it appear to the user as a 500 error.
+
+module BarsoomUtils
+  class ExceptionNotifier
+    def self.notify(exception, context: {})
+      # Inelegant workaround for the fact that we've confused this method with .message at least once.
+      # TODO: Fold them into a single method?
+      unless exception.is_a?(Exception)
+        raise "Expected an exception but got: #{exception.inspect}"
+      end
+
+      Honeybadger.notify(exception, context: context)
+    end
+
+    def self.message(message, details_or_context = nil, context_or_nothing = nil)
+      if context_or_nothing
+        details = details_or_context
+        context = context_or_nothing
+      elsif details_or_context.is_a?(Hash)
+        details = nil
+        context = details_or_context
+      else
+        details = details_or_context
+        context = {}
+      end
+
+      details ||= "(no message)"
+
+      Honeybadger.notify(
+        error_class: message,
+        error_message: details.to_s,
+        context: context.to_h,
+      )
+    end
+
+    # Wrap this around code to add context when reporting errors.
+    def self.run_with_context(context, &block)
+      # The load/dump achieves a "deep dup" without the "deep dep" of Active Support 🥁
+      old_context = Marshal.load(Marshal.dump(Honeybadger.get_context))
+
+      Honeybadger.context(context)
+      block.call
+    ensure
+      Honeybadger.context.clear!
+      Honeybadger.context(old_context)
+    end
+
+    # While developing a feature we'd like the feature developers to be responsible for any errors that occur.
+    # Wrapping the new code with this tags the errors as "wip" in order to hide them from the dashboard.
+    def self.developers_working_on_this_feature_are_responsible_for_errors_until(expire_on, &block)
+      block.call
+    rescue => ex
+      FIXME "#{expire_on}: WIP error-handling code needs to be removed!"
+      notify(ex, context: { tags: "wip" })
+
+      is_rails_production = defined?(Rails) && Rails.env.production?
+      raise unless is_rails_production
+    end
+  end
+end

data/lib/barsoom_utils/feature_toggle.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+require "attr_extras"
+require "redis"
+
+module BarsoomUtils
+  class FeatureToggle
+    # We (counter-intuitively, perhaps) store disabled toggles, so we can assume them to be enabled by default in dev, staging and tests.
+    REDIS_KEY = "disabled_feature_toggles"
+
+    def self.redis=(redis)
+      @redis = redis
+    end
+
+    def self.redis
+      @redis || $redis
+    end
+
+    def self.on?(feature, controller_or_view = nil, redis: self.redis)
+      new(feature, controller_or_view: controller_or_view, redis: redis).on?
+    end
+
+    def self.off?(feature, controller_or_view = nil, redis: self.redis)
+      new(feature, controller_or_view: controller_or_view, redis: redis).off?
+    end
+
+    def self.turn_on(feature, redis: self.redis)
+      new(feature, redis: redis).turn_on
+    end
+
+    def self.turn_off(feature, redis: self.redis)
+      new(feature, redis: redis).turn_off
+    end
+
+    def self.list
+      redis.smembers(REDIS_KEY).sort
+    end
+
+    pattr_initialize :feature_name, [ :controller_or_view, :redis ]
+
+    def on?
+      if has_param_override?
+        on_according_to_param?
+      else
+        on_according_to_redis?
+      end
+    end
+
+    def off?
+      not on?
+    end
+
+    def turn_off
+      redis.sadd REDIS_KEY, feature_name
+    end
+
+    def turn_on
+      redis.srem REDIS_KEY, feature_name
+    end
+
+    private
+
+    def has_param_override?
+      controller_or_view && controller_or_view.params.has_key?("ft_#{feature_name}")
+    end
+
+    def on_according_to_param?
+      value = controller_or_view && controller_or_view.params["ft_#{feature_name}"]
+      value == "true"
+    end
+
+    def on_according_to_redis?
+      not redis.sismember(REDIS_KEY, feature_name)
+    end
+
+    def redis
+      @redis || self.class.redis
+    end
+
+    def feature_name
+      @feature_name.to_s
+    end
+  end
+end

data/lib/barsoom_utils/ping_health_check.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require "httparty"
+require "attr_extras"
+require "barsoom_utils/exception_notifier"
+
+module BarsoomUtils
+  class PingHealthCheck
+    method_object :id
+
+    def call
+      return unless ENV["ENABLE_HEALTH_CHECKS"]
+
+      response = ping_healthcheck
+
+      if response.code != 200
+        # "The presence of the cf-request-id header in the response confirms
+        # the request was proxied through Cloudflare"
+        #   https://support.cloudflare.com/hc/en-us/articles/203118044-Gathering-information-for-troubleshooting-sites
+        raise "Bad response, cf-request-id header: #{response.headers["cf-request-id"]}, response body: #{response.inspect}"
+      else
+        response
+      end
+    rescue => ex
+      BarsoomUtils::ExceptionNotifier.message("Couldn't report to healthchecks.io, maybe the service is down?", "Check: #{id}, Error: #{ex.inspect}")
+    end
+
+    private
+
+    def ping_healthcheck
+      HTTParty.get("https://hchk.io/#{id}")
+    end
+  end
+end

data/lib/barsoom_utils/spec/debug_helpers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require "lolcat"
+
+module BarsoomUtils
+  module Spec
+    module DebugHelpers
+      def show_page
+        path = Rails.root.join("public/show_page.html")
+        File.write(path, page.source)
+        Lol.println "show_page: http://#{hostname}/show_page.html", os: 10, freq: 0.1, spread: 1
+      end
+
+      def hostname
+        raise "Implement me. Ex: def hostname; \"auctionet.dev\"; end"
+      end
+    end
+  end
+end

data/lib/barsoom_utils/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module BarsoomUtils
+  VERSION = "0.1.1"
+end

data/lib/barsoom_utils.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require "barsoom_utils/version"
+
+module BarsoomUtils
+end

data/script/test

@@ -0,0 +1,2 @@
+#!/bin/sh
+rspec $@

data/shared_rubocop.yml

@@ -0,0 +1,247 @@
+# Configuration for the Rubocop code linting tool. See README.
+
+AllCops:
+  DisabledByDefault: true
+  DisplayStyleGuide: true
+  SuggestExtensions: false
+  Exclude:
+    - db/schema.rb
+    - vendor/**/*
+    - node_modules/**/*
+    - tmp/**/*
+    - deploy/tmp/**/*
+
+# Enable all Security cops
+Security:
+  Enabled: true
+
+# Allow:
+#
+#     foo
+#       .bar
+#
+# Disallow:
+#
+#     foo.
+#       bar
+#
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+# Allow: "foo"
+# Disallow: 'foo'
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  StyleGuide: https://github.com/barsoom/devbook/tree/master/styleguide#double-quote-strings-unless-the-string-contains-double-quotes
+
+#https://docs.rubocop.org/rubocop/cops_style.html#stylequotedsymbols
+Style/QuotedSymbols:
+  EnforcedStyle: same_as_string_literals
+
+# Require a comma after the last item in a multi-line hash or array.
+#
+# The "consistent_comma" setting allows
+#
+#     [
+#       1, 2,
+#       3,
+#     ]
+#
+# Whereas the "comma" setting seems to not want the comma after 3 if 1 and 2 were on the same line.
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+  StyleGuide: https://github.com/barsoom/devbook/tree/master/styleguide#add-commas-to-the-end-of-multiline-lists-and-hashes
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+  StyleGuide: https://github.com/barsoom/devbook/tree/master/styleguide#add-commas-to-the-end-of-multiline-lists-and-hashes
+
+# Allow:
+#
+#     list.map { |x| x }
+#
+# Disallow:
+#
+#     list.map{ |x| x }
+#
+# Not in our styleguide, but it's what we've done for the most part.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Allow:
+#
+#     list.map {|x| x }
+#
+# Disallow:
+#
+#     list.map {|x| x }
+#
+# Not in our styleguide, but it's what we've done for the most part.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Allow:
+#
+#     { a: 1 }
+#
+# Disallow:
+#
+#     {a: 1}
+#
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  StyleGuide: https://github.com/barsoom/devbook/tree/master/styleguide#whitespace-in-arrays-and-hashes
+
+# Allow:
+#
+#     [ 1 ]
+#
+# Disallow:
+#
+#     [1]
+#
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: space
+  StyleGuide: https://github.com/barsoom/devbook/tree/master/styleguide#whitespace-in-arrays-and-hashes
+
+# Allow:
+#
+#     "foo" + 1 * 2 / 3**4
+#
+# Disallow:
+#
+#     "foo"+1*2/3 ** 4
+#
+# Not in our styleguide, but it's what we've done for the most part.
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+# bad: f( 3)
+# good: f(3)
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# bad: "foo #{ var } bar"
+# good: "foo #{var} bar"
+Layout/SpaceInsideStringInterpolation:
+  Enabled: true
+
+# Disallow trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+  StyleGuide: https://github.com/barsoom/devbook/tree/master/styleguide#avoid-trailing-whitespace
+
+# `BigDecimal.new` is deprecated on Ruby 2.5 in favour of `BigDecimal()`.
+Lint/BigDecimalNew:
+  Enabled: true
+
+Lint/DuplicateMethods:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+  StyleGuide: https://github.com/barsoom/devbook/tree/master/styleguide#put-a-blank-line-below-guard-statements
+
+# Allow:
+#
+#     Date.new(2019, 1, 2)
+#
+# Disallow:
+#
+#     Date.new(2019,1,2)
+#
+# Not in our styleguide, but it's what we've done for the most part.
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/StabbyLambdaParentheses:
+  Enabled: true
+  EnforcedStyle: require_parentheses
+  StyleGuide: https://github.com/barsoom/devbook/tree/master/styleguide#lambdas-should-stab-their-arguments
+
+# Not in our styleguide, but it's what we've done for the most part. And it ensures "rubocop --auto-correct" doesn't make the StabbyLambdaParentheses rule add in unconventional-to-us spaces.
+Layout/SpaceInLambdaLiteral:
+  Enabled: true
+  EnforcedStyle: require_no_space
+
+Lint/RaiseException:
+  Enabled: true
+
+# Skip redundant "begin"/"end" at the top level of method definitions or blocks.
+Style/RedundantBegin:
+  Enabled: true
+
+# Allow:
+#
+#     foo.bar
+#
+# Disallow:
+#
+#     foo.bar()
+#
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: true
+
+# https://docs.rubocop.org/rubocop/cops_style.html#enforcedstyleformultiline-comma
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+# Warn about "too many positional arguments in the parameter list" when more than 5.
+# Warn about "too many positional arguments with optional values" when more than 3.
+Metrics/ParameterLists:
+  Enabled: true
+  CountKeywordArgs: false
+  Max: 5
+  MaxOptionalParameters: 3
+
+# https://docs.rubocop.org/rubocop/cops_lint.html#lintparenthesesasgroupedexpression
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: true
+
+# https://docs.rubocop.org/rubocop/cops_lint.html#lintuselessassignment
+Lint/UselessAssignment:
+  Enabled: true
+
+# https://docs.rubocop.org/rubocop/cops_layout.html#layoutindentationwidth
+Layout/IndentationWidth:
+  Enabled: true
+
+# https://docs.rubocop.org/rubocop/cops_layout.html#layoutindentationconsistency
+Layout/IndentationConsistency:
+  Enabled: true
+
+# https://docs.rubocop.org/rubocop/cops_layout.html#layoutclassstructure
+# https://github.com/barsoom/devbook/tree/master/styleguide#use-a-consistent-class-layout
+# AutoCorrect: false because it has a tendency to make private delegates public, and it messes up whitespace
+Layout/ClassStructure:
+  Enabled: true
+  AutoCorrect: false
+  ExpectedOrder:
+    - module_inclusion
+    - constants
+    - association
+    - public_attribute_macros
+    - public_delegate
+    - macros
+    - public_class_methods
+    - initializer
+    - public_methods
+    - protected_attribute_macros
+    - protected_methods
+    - private_attribute_macros
+    - private_delegate
+    - private_methods
+
+# https://docs.rubocop.org/rubocop/cops_style.html#stylehashsyntax
+Style/HashSyntax:
+  Enabled: true
+  EnforcedStyle: ruby19
+
+Security/IoMethods: # new in 1.22
+  Enabled: true

data/shared_rubocop_rails.yml

@@ -0,0 +1,3 @@
+# Configuration for the RuboCop Rails extension. See README.
+
+# TODO: Add something useful!

data/spec/exception_notifier_spec.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+require "barsoom_utils/exception_notifier"
+require "honeybadger"
+require "fixme"
+
+RSpec.describe BarsoomUtils::ExceptionNotifier do
+  before do
+    allow(Honeybadger).to receive(:notify)
+  end
+
+  describe ".notify" do
+    let(:ex) { StandardError.new("boom") }
+
+    it "passes an exception to Honeybadger" do
+      BarsoomUtils::ExceptionNotifier.notify(ex)
+
+      expect(Honeybadger).to have_received(:notify).with(ex, context: {})
+    end
+
+    it "can pass through context info" do
+      BarsoomUtils::ExceptionNotifier.notify(ex, context: { foo: "bar" })
+
+      expect(Honeybadger).to have_received(:notify).with(ex, context: { foo: "bar" })
+    end
+
+    it "complains if given a non-exception" do
+      expect {
+        BarsoomUtils::ExceptionNotifier.notify({ foo: "bar" })
+      }.to raise_error(/Expected an exception but got:.*foo.*bar/)
+
+      expect(Honeybadger).not_to have_received(:notify)
+    end
+  end
+
+  describe ".message" do
+    it "passes a message to Honeybadger" do
+      BarsoomUtils::ExceptionNotifier.message("Boom!")
+
+      expect(Honeybadger).to have_received(:notify).with(
+        error_class: "Boom!",
+        error_message: "(no message)",
+        context: {},
+      )
+    end
+
+    it "can take a custom details string" do
+      BarsoomUtils::ExceptionNotifier.message("Boom!", "Details!")
+
+      expect(Honeybadger).to have_received(:notify).with(
+        error_class: "Boom!",
+        error_message: "Details!",
+        context: {},
+      )
+    end
+
+    it "can take a context hash" do
+      BarsoomUtils::ExceptionNotifier.message("Boom!", foo: "bar")
+
+      expect(Honeybadger).to have_received(:notify).with(
+        error_class: "Boom!",
+        error_message: "(no message)",
+        context: { foo: "bar" },
+      )
+    end
+
+    it "can take a custom details string and a context hash" do
+      BarsoomUtils::ExceptionNotifier.message("Boom!", "Details!", foo: "bar")
+
+      expect(Honeybadger).to have_received(:notify).with(
+        error_class: "Boom!",
+        error_message: "Details!",
+        context: { foo: "bar" },
+      )
+    end
+  end
+
+  describe ".run_with_context" do
+    it "updates the context just within the block" do
+      allow(Honeybadger).to receive(:context).and_call_original
+      Honeybadger.context({ my_old_context: "hello" })
+
+      context_in_block = nil
+
+      expect {
+        BarsoomUtils::ExceptionNotifier.run_with_context({ my_new_context: "what up" }) do
+          context_in_block = Honeybadger.get_context
+          raise "boom"
+        end
+      }.to raise_error /boom/
+
+      # Adds the new context while running the code.
+      expect(context_in_block).to eq({ my_old_context: "hello", my_new_context: "what up" })
+
+      # Resets the old context, without keeping the new.
+      expect(Honeybadger.get_context).to eq({ my_old_context: "hello" })
+    end
+  end
+
+  describe ".developers_working_on_this_feature_are_responsible_for_errors_until" do
+    before do
+      # We need some value, and this value means we don't have to rescue exceptions in some tests.
+      set_rails_production(true)
+    end
+
+    it "notifies Honeybadger with a 'wip' tag" do
+      ex = StandardError.new
+
+      BarsoomUtils::ExceptionNotifier.developers_working_on_this_feature_are_responsible_for_errors_until("9999-01-01") do
+        raise ex
+      end
+
+      expect(Honeybadger).to have_received(:notify).with(ex, context: { tags: "wip" })
+    end
+
+    it "does not raise the error in production" do
+      set_rails_production(true)
+
+      ex = StandardError.new
+
+      expect {
+        BarsoomUtils::ExceptionNotifier.developers_working_on_this_feature_are_responsible_for_errors_until("9999-01-01") do
+          raise ex
+        end
+      }.not_to raise_error
+    end
+
+    it "raises the error in non-production" do
+      set_rails_production(false)
+
+      ex = StandardError.new
+
+      expect {
+        BarsoomUtils::ExceptionNotifier.developers_working_on_this_feature_are_responsible_for_errors_until("9999-01-01") do
+          raise ex
+        end
+      }.to raise_error(ex)
+    end
+
+    it "sets a FIXME raise" do
+      set_rails_production(false)
+
+      expect {
+        BarsoomUtils::ExceptionNotifier.developers_working_on_this_feature_are_responsible_for_errors_until("1999-01-01") do
+          raise "hola"
+        end
+      }.to raise_error(Fixme::UnfixedError, /Fix by 1999-01-01: WIP error-handling/)
+    end
+
+    private
+
+    def set_rails_production(bool)
+      string_env = bool ? "production" : "test"
+      stub_const("Rails", double(:rails, env: double(:env, production?: bool, to_s: string_env)))
+    end
+  end
+end

data/spec/feature_toggle_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require "barsoom_utils/feature_toggle"
+
+RSpec.describe BarsoomUtils::FeatureToggle, ".turn_on" do
+  it "sets the feature as not disabled" do
+    redis = double
+    expect(redis).to receive(:srem).with("disabled_feature_toggles", "foo")
+    BarsoomUtils::FeatureToggle.turn_on(:foo, redis: redis)
+  end
+end
+
+RSpec.describe BarsoomUtils::FeatureToggle, ".turn_off" do
+  it "sets the feature as disabled" do
+    redis = double
+    expect(redis).to receive(:sadd).with("disabled_feature_toggles", "foo")
+    BarsoomUtils::FeatureToggle.turn_off(:foo, redis: redis)
+  end
+end
+
+RSpec.describe BarsoomUtils::FeatureToggle, ".on?, .off?" do
+  let(:redis) { double(sismember: false) }
+
+  context "by default" do
+    specify { expect(BarsoomUtils::FeatureToggle.on?(:foo, redis: redis)).to be true }
+    specify { expect(BarsoomUtils::FeatureToggle.off?(:foo, redis: redis)).to be false }
+  end
+
+  context "when disabled" do
+    before do
+      allow(redis).to receive(:sismember).with("disabled_feature_toggles", "foo").and_return(true)
+    end
+
+    specify { expect(BarsoomUtils::FeatureToggle.on?(:foo, redis: redis)).to be false }
+    specify { expect(BarsoomUtils::FeatureToggle.off?(:foo, redis: redis)).to be true }
+  end
+
+  context "with a param override" do
+    it "overrides the value in Redis" do
+      expect(BarsoomUtils::FeatureToggle.on?(:foo, redis: redis)).to be true
+
+      controller = double(params: { "ft_foo" => "false" })
+      expect(BarsoomUtils::FeatureToggle.on?(:foo, controller, redis: redis)).to be false
+      expect(BarsoomUtils::FeatureToggle.off?(:foo, controller, redis: redis)).to be true
+
+      controller = double(params: { "ft_foo" => "true" })
+      expect(BarsoomUtils::FeatureToggle.on?(:foo, controller, redis: redis)).to be true
+      expect(BarsoomUtils::FeatureToggle.off?(:foo, controller, redis: redis)).to be false
+    end
+  end
+end

data/spec/ping_health_check_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require "barsoom_utils/ping_health_check"
+
+RSpec.describe BarsoomUtils::PingHealthCheck, ".call" do
+  around do |example|
+    ENV["ENABLE_HEALTH_CHECKS"] = "true"
+    example.run
+    ENV["ENABLE_HEALTH_CHECKS"] = nil
+  end
+
+  it "does nothing on a 200 OK response" do
+    expect(HTTParty).to receive(:get).with("https://hchk.io/foo").and_return(double(:response, code: 200, headers: {}))
+
+    BarsoomUtils::PingHealthCheck.call("foo")
+  end
+
+  it "includes CloudFlare request ID header information in failure message" do
+    expect(HTTParty).to receive(:get).with("https://hchk.io/foo").and_return(double(:response, code: 503, headers: { "cf-request-id" => "023aa754ae0000517ab8829200000001" }))
+    expect(BarsoomUtils::ExceptionNotifier).to receive(:message).with(anything, /cf-request-id header: 023aa754ae0000517ab8829200000001/)
+
+    BarsoomUtils::PingHealthCheck.call("foo")
+  end
+
+  it "silently reports an error to devs if it fails with a bad response code" do
+    expect(HTTParty).to receive(:get).with("https://hchk.io/foo").and_return(double(:response, code: 404, headers: {}))
+    expect(BarsoomUtils::ExceptionNotifier).to receive(:message).with(anything, /foo/)
+
+    BarsoomUtils::PingHealthCheck.call("foo")
+  end
+
+  it "silently reports an error to devs if it fails with an exception" do
+    expect(HTTParty).to receive(:get).with("https://hchk.io/foo").and_raise("fail")
+    expect(BarsoomUtils::ExceptionNotifier).to receive(:message).with(anything, /foo/)
+
+    BarsoomUtils::PingHealthCheck.call("foo")
+  end
+end

data/spec/spec/debug_helpers_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require "barsoom_utils/spec/debug_helpers"
+
+RSpec.describe BarsoomUtils::Spec::DebugHelpers do
+  before { module Rails; end }
+
+  let(:page) { double(:page, source: "wow such html") }
+  let(:helper) { HelperTestClass.new(page) }
+
+  it "writes the page to the filesystem" do
+    allow(Rails).to receive(:root).and_return([])
+
+    # writes the capybara page contents to the file system
+    expect(File).to receive(:write).with("", page.source)
+
+    # asserts that we expect a hostname to be defined
+    expect { helper.show_page }.to raise_error(/Implement me/)
+  end
+
+  class HelperTestClass
+    include BarsoomUtils::Spec::DebugHelpers
+    attr_accessor :page
+
+    def initialize(page)
+      @page = page
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.order = "random"
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: barsoom_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tomas Skogberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-19 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: rspec
+  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: httparty
+  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: lolcat
+  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: attr_extras
+  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: redis
+  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: honeybadger
+  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: fixme
+  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: rubocop
+  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:
+- tomas.skogberg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- barsoom_utils.gemspec
+- lib/barsoom_utils.rb
+- lib/barsoom_utils/exception_notifier.rb
+- lib/barsoom_utils/feature_toggle.rb
+- lib/barsoom_utils/ping_health_check.rb
+- lib/barsoom_utils/spec/debug_helpers.rb
+- lib/barsoom_utils/version.rb
+- script/test
+- shared_rubocop.yml
+- shared_rubocop_rails.yml
+- spec/exception_notifier_spec.rb
+- spec/feature_toggle_spec.rb
+- spec/ping_health_check_spec.rb
+- spec/spec/debug_helpers_spec.rb
+- spec/spec_helper.rb
+homepage: http://barsoom.se
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+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: []
+rubygems_version: 3.2.31
+signing_key: 
+specification_version: 4
+summary: Various helpful utils
+test_files:
+- spec/exception_notifier_spec.rb
+- spec/feature_toggle_spec.rb
+- spec/ping_health_check_spec.rb
+- spec/spec/debug_helpers_spec.rb
+- spec/spec_helper.rb