bonsai-elasticsearch-rails 0.0.4 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    N2Y1YjZiOTllZDY2MWI2ZWEyMTdkOTgxYWVmZjdkY2E0NmU0ZDdiNw==
-  data.tar.gz: !binary |-
-    NjNlMTE4ZTc1YWQ4MGM2OGFmNTIwYjE4Y2IzY2I1ZTgwNDRjMDFiMw==
+SHA1:
+  metadata.gz: 3f48a0171a0973f1ef02157d1e92077986a080e6
+  data.tar.gz: 02b6d110cfa04774046c2ac8573240883db2d9ba
 SHA512:
-  metadata.gz: !binary |-
-    YmI0OWEwZTZiYWExMjk5NTRkN2I0ODc1MjljNWU5OTQwYzVhNjhlZGYyNTQy
-    Y2VhNDg1ODU4M2VhMzQxYWI0YjA5NTM1MWFhODdhZDMzMzk3YWQyMjlmNThk
-    MGIwMTk0OTBhNDM2MjIzZjcwMzZmYzNlNmQ1N2E1YTY0NWI0Yjg=
-  data.tar.gz: !binary |-
-    NDk5ZTExNDhjZWFhYjhjNjMwOTQ4MzBhYzQwNmU2Y2NiODFkZWI5Yzg4ZWU4
-    N2UwNDI5MmExMzBiNzI4YmRmYWY2M2M5ZTRkZTdiOTJkZjc1ZTNmMTgxODgw
-    M2Q1ODg1ZjhmOTRkOTk5ZDIzOGI2MTc4NmRkOGIwMzY0NzhkY2Q=
+  metadata.gz: 773acedb2d176d60ed96f6313aa3352d2295e7ea87da02d989b11bd241396cb59bedd0b68adc4aeb33c7903d20a3cac41a1e674a648c31e4a963daed41375b7c
+  data.tar.gz: 9b7ba251a37ddbee2f3ec8aaf739b258b8614c4c432c51c46227c7179db428849c685b34608bc770eadfb442a5ba96102699bb736f70b0ec35d0ea7f28a636c7

data/lib/bonsai-elasticsearch-rails.rb

@@ -0,0 +1,13 @@
+require 'elasticsearch/model'
+require 'elasticsearch/rails'
+
+Rails.logger = Logger.new(STDOUT) if Rails.logger.nil?
+url    = ENV['BONSAI_URL'] || ENV['ELASTICSEARCH_URL']
+
+unless url.nil?
+  url_safe = url.gsub(/\:[a-z0-9]{1,}@/, ":redacted@")
+  Rails.logger.info("Starting up a new Bonsai Elasticsearch client with url: #{url_safe}")
+  Elasticsearch::Model.client = Elasticsearch::Client.new url: url
+else
+  Rails.logger.warn('Could not find a `BONSAI_URL` environment variable with a cluster URL. The bonsai-elasticsearch-rails can not create an Elasticsearch client. Please contact support at: support@bonsai.io')
+end

metadata

@@ -1,73 +1,110 @@
 --- !ruby/object:Gem::Specification
 name: bonsai-elasticsearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Rob Sears
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-02 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: elasticsearch-model
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: elasticsearch-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: elasticsearch-rails
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Integrate your elasticsearch-rails gem with bonsai.
+        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 connect Rails apps with a Bonsai
+                            Elasticsearch cluster. The official Elasticsearch gem package
+                            requires some minor configuration tweaks in order to work
+                            correctly with Bonsai (namely the client needs to be instantiated
+                            with the cluster location and HTTP authentication details), and
+                            the process can be somewhat complicated for users who are
+                            unfamiliar with the system.
+
+                            The bonsai-elasticsearch-rails gem automatically sets up the
+                            Elasticsearch client correctly so users don't need to worry about
+                            configuring it in their code or writing an initializer.
+
+                            In order for the gem to work correctly, the application needs an
+                            environment variable called `BONSAI_URL`, which is populated with
+                            the complete Bonsai Elaticsearch cluster URL, including the HTTP
+                            authentication. The cluster URL will follow this pattern:
+
+                            https://user1234:pass5678@cluster-slug-123.aws-region-X.bonsai.io/
+
+                            On Heroku, this variable is created and populated automatically
+                            when Bonsai is added to the application. Heroku users therefore do
+                            not need to perform any additional configuration to connect to
+                            their cluster after adding the bonsai-elasticsearch-rails gem.
+
+                            Users who are self-hosting their Rails app will need to make sure
+                            this environment variable is present:
+
+                            export BONSAI_URL="https://user1234:pass5678@aws-region-X.bonsai.io/"
+
+                            The cluster URL is available via the Bonsai dashboard.
 email:
-- rc.sears@gmail.com
+- rob@onemorecloud.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- bonsai-elasticsearch-rails.gemspec
-- lib/bonsai/elasticsearch/rails.rb
-- lib/bonsai/elasticsearch/rails/version.rb
-homepage: http://bonsai.io
+- lib/bonsai-elasticsearch-rails.rb
+homepage: https://github.com/omc/bonsai-elasticsearch-rails
 licenses:
 - MIT
 metadata: {}
@@ -77,18 +114,18 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
-summary: Integrate your elasticsearch-rails gem with bonsai.
+summary: Integrate your elasticsearch-rails gem with Bonsai Elasticsearch.
 test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/Gemfile

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

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 TODO: Write your name
-
-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,22 +0,0 @@
-# Bonsai::Elasticsearch::Rails
-
-This gem works with the elasticsearch-rails gem to allow users of [bonsai](http://bonsai.io) to more easily integrate their app with bonsai's service.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'bonsai-elasticsearch-rails'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install bonsai-elasticsearch-rails
-
-## Usage
-
-You should not need to do anything special to use the gem. The integration will be performed transparently.
-

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/bonsai-elasticsearch-rails.gemspec

@@ -1,24 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'bonsai/elasticsearch/rails/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "bonsai-elasticsearch-rails"
-  spec.version       = Bonsai::Elasticsearch::Rails::VERSION
-  spec.authors       = ["Rob Sears"]
-  spec.email         = ["rc.sears@gmail.com"]
-  spec.summary       = %q{Integrate your elasticsearch-rails gem with bonsai.}
-  spec.description   = %q{Integrate your elasticsearch-rails gem with bonsai.}
-  spec.homepage      = "http://bonsai.io"
-  spec.license       = "MIT"
-
-  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", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "elasticsearch-rails"
-end

data/lib/bonsai/elasticsearch/rails.rb

@@ -1,4 +0,0 @@
-require "bonsai/elasticsearch/rails/version"
-
-puts "Starting up a new ElasticSearch client with #{ENV['BONSAI_URL']}"
-Elasticsearch::Model.client = Elasticsearch::Client.new url: ENV['BONSAI_URL']

data/lib/bonsai/elasticsearch/rails/version.rb

@@ -1,7 +0,0 @@
-module Bonsai
-  module Elasticsearch
-    module Rails
-      VERSION = "0.0.4"
-    end
-  end
-end