bonsai-searchkick 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9bf2dab6cc21e84b90a14e6a13ab6458e254afc67f113e26e2796f12474212a
+  data.tar.gz: 470591003045ccfa8a9e32ccc0983045d2a8e8747802ecf4aff0daac700e581a
+SHA512:
+  metadata.gz: e8360eba2d6511300e7938e8374913df2a98f9e3b9d1a4ffc0b6885d851a5a3e216a196b5e72f19f8e23b9c76e761a1702198d877f2f683799cf1ae56ff9360f
+  data.tar.gz: 0d5446066e2f7ecbe21ae7d5bd85e8647136f7b87c1a4b9498607fa06d1d7e19f78ceed67a4680e7ff5e2762ccca4eff27125d8c39168bda3e7bff66f76c50cc

data/lib/bonsai-searchkick.rb

@@ -0,0 +1,3 @@
+if defined?(Rails)
+  require File.expand_path('bonsai/searchkick/railtie', File.dirname(__FILE__))
+end

data/lib/bonsai/searchkick/railtie.rb

@@ -0,0 +1,105 @@
+module Bonsai
+  module Searchkick
+    # Use Railties
+    class Railtie < ::Rails::Railtie
+      attr_reader :url, :port, :filtered_url, :ported_url, :logger
+
+      # Create an initializer to set up the Searchkick client with the proper URL
+      initializer 'setup_searchkick' do
+        if @url.present? && @url.is_a?(String) && @url.is_valid_searchkick_url?
+          @logger.debug("Bonsai: Initializing default Searchkick client with #{@filtered_url}")
+          ENV['ELASTICSEARCH_URL'] = @ported_url
+        else
+          @logger.debug('Bonsai: Neither BONSAI_URL nor ELASTICSEARCH_URL are set in this environment.')
+          @logger.debug('Bonsai: Proceeding with Searchkick default of http://localhost:9200.')
+        end
+      end
+
+      # Method to determine what happens when an instance of this class is
+      # initialized
+      def initialize
+
+        # Append a method to the String class so we can get a nice way to check
+        # that a String is a valid URL. `_searchkick_` is part of the method
+        # name to avoid possible collisions.
+        String.class_eval do
+            def is_valid_searchkick_url?
+                uri = URI.parse self
+                uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+            rescue URI::InvalidURIError
+                false
+            end
+        end
+
+        # Class attributes
+        @logger = Logger.new(STDOUT)
+        @url = ENV['BONSAI_URL'] || ENV['ELASTICSEARCH_URL'] || ''
+        @port = searchkick_port
+        @ported_url = maybe_add_port
+        @filtered_url = filtered_url
+      end
+
+      # Check the URL for a port.
+      #
+      # Returns
+      #   * An Integer representing the port, or nil if no port is given.
+      #
+      def searchkick_port
+        return nil unless @url.is_valid_searchkick_url?
+
+        port = @url[/:([0-9]{0,5}$)/, 1]
+        return port.to_i if port.present?
+        nil
+      end
+
+      # Append a port to the URL string if necessary.
+      #
+      # The Elasticsearch-ruby gem that Searchkick uses introduced a bug into
+      # its URL-parsing. Essentially, it will *always* assume port 9200,
+      # regardless of the protocol used. In other words, if you initialize
+      # the client with https://my-cluster.com, it will assume that you mean
+      # https://my-cluster.com:9200 and not https://my-cluster.com:443 (the
+      # standard port for HTTPS).
+      #
+      # This method will ensure the URL port is correctly called out when using
+      # a Bonsai cluster.
+      #
+      # Returns
+      #   * A String for the URL, possibly appended with a Bonsai-supported
+      #     port.
+      #
+      def maybe_add_port
+        if ENV['BONSAI_URL'].present?
+          uri = URI.parse(@url) rescue ''
+          if uri.kind_of?(URI::HTTPS) || uri.kind_of?(URI::HTTP)
+            port = (uri.kind_of?(URI::HTTPS)) ? 443 : 80
+            if !@port.present?
+              @logger.debug("Bonsai: Appending port #{port} to the cluster URL for production environment.")
+              return "#{@url}:#{port}".gsub('::', ':')
+            elsif @port != port
+              @logger.debug("Bonsai: Overriding the requested port #{@port} with the standard #{port} for production environment.")
+              return "#{@url.rpartition(':').first}:#{port}"
+            end
+          end
+        end
+        @url
+      end
+
+      # Filter out the credentials from the logs.
+      #
+      # This gem outputs some debug messages to indicate that it has
+      # successfully loaded and initialized the correct cluster. Cluster URLs
+      # can contain user credentials, which we do not want logged anywhere. This
+      # method filters out the password from the URL and replaces it with an
+      # anonymized value, making it safe to print.
+      #
+      # Returns
+      #   * A String for the URL, with the credentials filtered for safe
+      #     printing.
+      #
+      def filtered_url
+        @ported_url.sub(/:[^:@]+@/, ':FILTERED@')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: bonsai-searchkick
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rob Sears
+- Maddie Jones
+- Leo Shue Schuster
+- Nick Zadrozny
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: searchkick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '99'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '99'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+description: |2
+    This gem offers a shim to set up Searchkick to work with a Bonsai
+    Elasticsearch cluster. The bonsai-searchkick gem automatically sets up the
+    Searchkick client correctly so users don't need to worry about configuring it
+    in their code or writing an initializer. Further details and documentation
+    can be found on this gem's Github repository.
+email:
+- rob@onemorecloud.com
+- maddie@onemorecloud.com
+- leo@onemorecloud.com
+- nick@onemorecloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bonsai-searchkick.rb
+- lib/bonsai/searchkick/railtie.rb
+homepage: https://github.com/omc/bonsai-searchkick
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Initialize your Searchkick client with Bonsai.
+test_files: []