waistband 0.16.2 → 0.16.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzdkOGE5ZjVhYmU3ZmJiZDNmMmZhNzdjMTIwNzg0YmE5YjRiODUyZQ==
+    YmI3ZDUzZTFhN2VlODQxMTVlNWRlMDQxNDBhMjlmY2E1MWI1YjQ0MA==
   data.tar.gz: !binary |-
-    MzJhYjY3MGEzODM2ZDgwNGM0MTlmZDMyMjVlOTljMzNkNzllZGUyMg==
+    MjdkNTI0OWQyODAzZGM5ZGMxOTZhOTE5OWIwZDA3ODRhOTY2ZDk2Yw==
 SHA512:
   metadata.gz: !binary |-
-    YWZiZjBkOWU0ZDQ1OWI5OGQ0NWYyMTQzMTIxYzY3MTg1ZjQ3YTk1YmI2MzE3
-    NGM4MWY0MTVlZGExMDk2NjRjYjg1ZWY1Y2NmZmY5M2VlNWNjODNjMGNlMTVm
-    ZjkyOTdiNzhhZDc2NDEyMjExMjFiMWJjZjMwOWRkMzI3Mzg1ZTk=
+    MTkzMmRkY2Y1NDU3MjkzYmY1NjU3Y2VlNGI0ZjI4YjA4ZTAwODMwZmM4ZDBj
+    YjE4ODNjMWE2NzBmMzFkZmZmN2Y0NTQwYmUwOTkxNmNlY2UxMzc0YzljZmM2
+    NmU2ZDI2OTNlZjllZTRlZDBkN2UxZjBmY2EwNTJhNDk5NDAyN2E=
   data.tar.gz: !binary |-
-    OWVmM2NlMGQzODYwMzAxYTkzNzdkMzBmMGJlNmJlOGNiYzBlZDU4Y2ExY2Q4
-    Y2U5MTk3YWRmN2Y5YmEzMjhkYjU3MzViOWYwZmU5OTAzYTFhOTg5OTEyMjEy
-    ZjJkOTk4ZjJhYjVmOWQ2Yzg2OGQ2MzcwZTVlOTYwOTllZDU3N2Y=
+    Yzc4MWZkNWFhZDZhMGY4NWVjODQ1NTBjNGE2ODU0ODgyN2RiNGI3ZWEwYTBl
+    ZjQ2MmQ5N2I5YTI2ZTZhMzE3YzkzOWFhZDhkMzQ4M2FiNTJiNWUxYWIxODQ1
+    OGVmYzk2N2YwOGViOTg5NDQ3YWU0Y2EyZDk0OThjNTY3ZDQxMDA=

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+
+script: bundle exec rspec spec
+
+services:
+  - elasticsearch

data/Gemfile

@@ -4,5 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rspec', '~> 3.1.0'
-gem 'debugger', '~> 1.6.8'
 gem 'timecop', '~> 0.7.1'
+
+unless ENV['ON_TRAVIS']
+  gem 'debugger', '~> 1.6.8'
+end

data/README.md

@@ -1,7 +1,11 @@
 # Waistband
 
+[![Build Status](https://travis-ci.org/taskrabbit/waistband.png?branch=master)](https://travis-ci.org/taskrabbit/waistband)
+
 Configuration and sensible defaults for ElasticSearch on Ruby.  Handles configuration, index creation, quality of life, etc, of Elastic Search in Ruby.
 
+Waistband doens't handle connections or API requests, it merely acts as a translator between commonly used patterns and the underlying elasticsearch gems.
+
 # Installation
 
 Install ElasticSearch:
@@ -39,7 +43,9 @@ development:
             port: 9200
 ```
 
-You can name the servers whatever you want, and one of them is selected at random using `Array.sample`, excluding blacklisted servers, when conduction operations on the server.  Here's an example with two servers:
+You can name the servers whatever you want.  The connection, retries, timeouts, etc are handled by the `elasticsearch-transport` gem.
+
+Here's an example with two servers:
 
 ```yml
 # #{APP_DIR}/config/waistband/waistband.yml
@@ -73,6 +79,33 @@ development:
                 includes: ["*"]
 ```
 
+Note that you can configure specific connection settings for a particular index, if for some reason or another that index in particular uses a different set of servers:
+
+```yml
+development:
+  connection:
+    timeout: 2
+    retries: 5
+    reload_on_failure: true
+    servers:
+      server1:
+        host: 192.168.31.112
+        port: 9200
+        protocol: http
+      server2:
+        host: 192.168.31.113
+        port: 9200
+        protocol: http
+  settings:
+    index:
+      number_of_shards: 1
+      number_of_replicas: 1
+  mappings:
+    event:
+      _source:
+        includes: ["*"]
+```
+
 ## List of config settings:
 
 * `settings`: settings for the Elastic Search index.  Refer to the ["admin indices update settings"](http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/) document for more info.
@@ -82,6 +115,8 @@ development:
 * `timeout`: seconds till a timeout exception is raise when trying to connect to the node.
 * `name`: optional - name of the index.  You can (and probably should) have a different name for the index for your test environment.  If not specified, it defaults to the name of the yml file minus the `waistband_` portion, so in the above example, the index name would become `search_#{env}`, where env is your environment variable as defined in `Waistband::Configuration#setup` (determined by `RAILS_ENV` or `RACK_ENV`).
 * `stringify`: optional - determines wether whatever is stored into the index is going to be converted to a string before storage.  Usually false unless you need it to be true for specific cases, like if for some `key => value` pairs the value is of different types some times.
+* `connection`: optional - determines which server/s the index uses.  If not present, it'll use the default connection settings specified in `config/waistband.yml`.
+* `permissions`: optional - determines which permissions to allow on this index, please refer to the [permissions section](#permissions) for more information.
 
 ## Initializer
 
@@ -220,6 +255,42 @@ index.alias_exists?('my_super_events_alias') # => true
 
 The `alias` methods receives a param to define the alias name.  The same pattern can be used when using index versions.
 
+### Permissions
+
+We've found it safer to tighten up the permissions to determine which actions can be done on each index based on environments.  For example, you might want to allow an index to be created and deleted at will on the development or staging environments, but you probably don't want to allow it to be deleted on production.  To that effect, you're able to set permissions on each index's config file:
+
+```yml
+production:
+    permissions:
+        create: true
+        delete_index: false
+        destroy: true
+        read: true
+        write: true
+```
+
+By default, all permissions are true unless set otherwise.
+
+The specific permissions are:
+
+* `create`: can Waistband create the index?
+* `delete_index`: can Waistband delete the entire index?
+* `destroy`: can Waistband destroy an object in the index?
+* `read`: can Waistband `read`, `find`, or `find_result` in the index?
+* `write`: can Waistband `save` (create or update) an object to the index?
+
+### Logging
+
+It's very useful to log what the output from all operations is, with that in mind, you can specify a log for Waistband easily:
+
+```ruby
+Waistband.configure do |c|
+  c.logger = Rails.logger.dup
+end
+```
+
+You can do this in an initializer, even the same initializer you used to specify the `config_dir` ealirer if you did so.
+
 ## Contributing
 
 1. Fork it

data/lib/waistband/errors.rb

@@ -1,9 +1,20 @@
 module Waistband
   module Errors
 
+    module Permissions
+      class PermissionError < StandardError; end
+
+      class Create < PermissionError; end
+      class DeleteIndex < PermissionError; end
+      class Destroy < PermissionError; end
+      class Read < PermissionError; end
+      class Write < PermissionError; end
+    end
+
     class IndexExists < StandardError; end
     class IndexNotFound < StandardError; end
     class NoSearchHits < StandardError; end
+    class UnableToSave < StandardError; end
 
   end
 end

data/lib/waistband/index.rb

@@ -3,6 +3,7 @@ require 'active_support/core_ext/array/extract_options'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/hash/reverse_merge'
 require 'elasticsearch'
 
 module Waistband
@@ -39,12 +40,16 @@ module Waistband
     end
 
     def update_all_mappings
+      check_permission!('create')
+
       responses = types.map do |type|
         update_mapping(type).merge('_type' => type)
       end
     end
 
     def update_mapping(type)
+      check_permission!('create')
+
       properties = config['mappings'][type]['properties'] || {}
 
       mapping_hash = {type => {properties: properties}}
@@ -57,6 +62,8 @@ module Waistband
     end
 
     def update_settings
+      check_permission!('create')
+
       client.indices.put_settings(
         index: config_name,
         body: settings
@@ -70,7 +77,9 @@ module Waistband
     end
 
     def create!
-      client.indices.create index: config_name, body: config.except('name', 'stringify', 'log_level')
+      check_permission!('create')
+
+      client.indices.create index: config_name, body: config.except('name', 'permissions', 'stringify', 'log_level')
     rescue Elasticsearch::Transport::Transport::Errors::BadRequest => ex
       raise ex unless ex.message.to_s =~ /IndexAlreadyExistsException/
       raise ::Waistband::Errors::IndexExists.new("Index already exists")
@@ -83,13 +92,17 @@ module Waistband
     end
 
     def delete!
+      check_permission!('delete_index')
+
       client.indices.delete index: config_name
     rescue Elasticsearch::Transport::Transport::Errors::NotFound => ex
       raise ex unless ex.message.to_s =~ /IndexMissingException/
       raise ::Waistband::Errors::IndexNotFound.new("Index not found")
     end
 
-    def save(*args)
+    def save!(*args)
+      check_permission!('write')
+
       body_hash = args.extract_options!
       id = args.first
       _type = body_hash.delete(:_type) || body_hash.delete('_type') || default_type_name
@@ -106,7 +119,17 @@ module Waistband
         body: body_hash
       )
 
-      saved['_id'].present?
+      unless saved['_id'].present?
+        raise ::Waistband::Errors::UnableToSave.new("Unable to save to index: #{config_name}, type: #{_type}, id: #{id}: result: #{saved}")
+      end
+
+      saved
+    end
+
+    def save(*args)
+      save!(*args)
+    rescue ::Waistband::Errors::UnableToSave => ex
+      false
     end
 
     def find(id, options = {})
@@ -138,6 +161,8 @@ module Waistband
     end
 
     def read!(id, options = {})
+      check_permission!('read')
+
       options = options.with_indifferent_access
       type = options[:_type] || default_type_name
 
@@ -155,6 +180,8 @@ module Waistband
     end
 
     def destroy!(id, options = {})
+      check_permission!('destroy')
+
       options = options.with_indifferent_access
       type = options[:_type] || default_type_name
 
@@ -168,8 +195,10 @@ module Waistband
     def search(body_hash)
       page, page_size = get_page_info body_hash
       body_hash       = parse_search_body(body_hash)
+      _type           = body_hash.delete(:_type)
       search_hash     = {index: config_name, body: body_hash}
 
+      search_hash[:type] = _type if _type
       search_hash[:from] = body_hash[:from] if body_hash[:from]
       search_hash[:size] = body_hash[:size] if body_hash[:size]
 
@@ -297,9 +326,17 @@ module Waistband
       end
 
       def default_type_name
+        return default_type_name_from_mappings if default_type_name_from_mappings
         @index_name.singularize
       end
 
+      def default_type_name_from_mappings
+        @default_type_name_from_mappings ||= begin
+          mappings = (config['mappings'] || {})
+          mappings.keys.first
+        end
+      end
+
       def settings
         settings = config['settings']['index'].except('number_of_shards')
         {index: settings}
@@ -314,6 +351,24 @@ module Waistband
         "#{@index_name}_#{::Waistband.config.env}"
       end
 
+      def check_permission!(permission)
+        raise "::Waistband::Errors::Permissions::#{permission.classify}".constantize.new("Don't have enough permissions to #{permission} on index #{config_name}") unless check_permission?(permission)
+      end
+
+      def check_permission?(permission)
+        !!permissions[permission]
+      end
+
+      def permissions
+        @permissions ||= (config['permissions'] || {}).reverse_merge({
+          'create'       => true,
+          'delete_index' => true,
+          'destroy'      => true,
+          'read'         => true,
+          'write'        => true
+        }).with_indifferent_access
+      end
+
     # /private
 
   end

data/lib/waistband/version.rb

@@ -1,3 +1,3 @@
 module Waistband
-  VERSION = "0.16.2"
+  VERSION = "0.16.3"
 end

data/spec/config/waistband/waistband_events_with_env_permissions.yml

@@ -0,0 +1,27 @@
+development: &DEV
+  name: events
+  permissions:
+    create: true
+    delete_index: true
+    destroy: true
+    read: true
+    write: true
+  stringify: true
+  settings:
+    index:
+      number_of_shards: 1
+      number_of_replicas: 1
+  mappings:
+    event:
+      _source:
+        includes: ["*"]
+
+test:
+  <<: *DEV
+  name: events_test
+  permissions:
+    create: true
+    delete_index: false
+    destroy: true
+    read: true
+    write: true

data/spec/config/waistband/waistband_events_with_permissions.yml

@@ -0,0 +1,21 @@
+development: &DEV
+  name: events
+  permissions:
+    create: false
+    delete_index: false
+    destroy: false
+    read: false
+    write: false
+  stringify: true
+  settings:
+    index:
+      number_of_shards: 1
+      number_of_replicas: 1
+  mappings:
+    event:
+      _source:
+        includes: ["*"]
+
+test:
+  <<: *DEV
+  name: events_test

data/spec/config/waistband/waistband_no_mappings.yml

@@ -0,0 +1,8 @@
+development: &DEV
+  settings:
+    index:
+      number_of_shards: 1
+      number_of_replicas: 1
+
+test:
+  <<: *DEV

data/spec/config/waistband/waistband_search.yml

@@ -6,7 +6,7 @@ development: &DEV
       number_of_shards: 1
       number_of_replicas: 1
   mappings:
-    event:
+    search:
       _source:
         includes: ["*"]
 

data/spec/lib/body_size_logging_spec.rb

@@ -22,4 +22,4 @@ describe Waistband::Index do
     expect(data).to be_present
   end
 
-end
+end

data/spec/lib/{index_spec.rb → index/index_spec.rb}

@@ -69,13 +69,6 @@ describe Waistband::Index do
     expect(response['acknowledged']).to be true
   end
 
-  it "proxies to the client's search" do
-    result = index.search({})
-    expect(result).to be_a Waistband::SearchResults
-    expect(result.took).to be_present
-    expect(result.hits).to be_an Array
-  end
-
   it "correctly sets hosts" do
     expect(index.client.send(:hosts)).to eql([
       {"host" => "localhost", "port" => 9200, "protocol" => "http"},
@@ -83,10 +76,25 @@ describe Waistband::Index do
     ])
   end
 
+  describe "searching" do
+
+    it "proxies to the client's search" do
+      result = index.search({})
+      expect(result).to be_a Waistband::SearchResults
+      expect(result.took).to be_present
+      expect(result.hits).to be_an Array
+    end
+
+    it "does not blow up when an index type is specified" do
+      expect{ index.search({_type: 'event'}) }.to_not raise_error
+    end
+
+  end
+
   describe "storing" do
 
     it "stores data" do
-      expect(index.save('__test_write', {'ok' => 'yeah'})).to be true
+      expect(index.save('__test_write', {'ok' => 'yeah'})).to be_present
       expect(index.read('__test_write')).to eql({
         '_id' => '__test_write',
         '_index' => 'events_test',

data/spec/lib/index/permissions_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe "Waistband::Index - Permissions" do
+
+  let(:index)  { Waistband::Index.new('events') }
+  let(:index2) { Waistband::Index.new('events_with_permissions') }
+  let(:index3) { Waistband::Index.new('events_with_env_permissions') }
+
+  it "detaults all permissions to true when not found" do
+    expect(index.send(:permissions)).to eql({
+      'create' => true,
+      'delete_index' => true,
+      'destroy' => true,
+      'read' => true,
+      'write' => true
+    })
+  end
+
+  it "allows overriding permissions" do
+    expect(index2.send(:permissions)).to eql({
+      'create' => false,
+      'delete_index' => false,
+      'destroy' => false,
+      'read' => false,
+      'write' => false
+    })
+  end
+
+  it "allows environment specific overriding" do
+    expect(index3.send(:permissions)).to eql({
+      'create' => true,
+      'delete_index' => false,
+      'destroy' => true,
+      'read' => true,
+      'write' => true
+    })
+  end
+
+  it "doesn't allow writing" do
+    expect {
+      index2.create!
+    }.to raise_error(Waistband::Errors::Permissions::Create)
+  end
+
+  it "doesn't allow deleting" do
+    expect {
+      index2.delete!
+    }.to raise_error(Waistband::Errors::Permissions::DeleteIndex)
+  end
+
+  it "doesn't allow destroying" do
+    expect {
+      index2.destroy!('123')
+    }.to raise_error(Waistband::Errors::Permissions::Destroy)
+  end
+
+  it "doesn't allow reading" do
+    expect {
+      index2.read!('123')
+    }.to raise_error(Waistband::Errors::Permissions::Read)
+  end
+
+  it "doesn't allow finding" do
+    expect {
+      index2.find!('123')
+    }.to raise_error(Waistband::Errors::Permissions::Read)
+  end
+
+  it "doesn't allow read_resulting" do
+    expect {
+      index2.read_result!('123')
+    }.to raise_error(Waistband::Errors::Permissions::Read)
+  end
+
+  it "doesn't allow writing" do
+    expect {
+      index2.save!('123', {ok: 'nook'})
+    }.to raise_error(Waistband::Errors::Permissions::Write)
+  end
+
+end

data/spec/lib/index/type_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe "Waistband::Index - Type" do
+
+  it "defaults to the first type we find in the mappings if possible" do
+    index = Waistband::Index.new('events_no_name')
+    expect(index.send(:default_type_name)).to eql 'event'
+  end
+
+  it "defaults to singular index name if no mappings" do
+    index = Waistband::Index.new('no_mappings')
+    expect(index.send(:default_type_name)).to eql 'no_mapping'
+  end
+
+end

data/spec/lib/index_multi_connection_spec.rb

@@ -22,7 +22,7 @@ describe Waistband::Index do
   it "works" do
     index.delete
     index.create
-    index.save('testing123', {ok: 'yeah'})
+    saved = index.save('testing123', {ok: 'yeah'})
     index.refresh
     data = index.read('testing123')
     expect(data['_source']['ok']).to eql 'yeah'

data/spec/spec_helper.rb

@@ -8,7 +8,10 @@ require 'waistband'
 require 'rspec'
 require 'timecop'
 require 'active_support/core_ext/integer/time'
-require 'debugger'
+
+unless ENV['ON_TRAVIS']
+  require 'debugger'
+end
 
 Dir["#{APP_DIR}/spec/support/**/*.rb"].each {|f| require f}
 

data/spec/support/fake_log.rb

@@ -9,4 +9,5 @@ class FakeLog
   def debug(val); end
   def fatal(val); end
   def warn(val); end
+  def error(val);  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waistband
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.16.3
 platform: ruby
 authors:
 - David Jairala
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-13 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -92,6 +92,7 @@ files:
 - .rspec
 - .ruby-gemset
 - .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -109,13 +110,18 @@ files:
 - spec/config/waistband/waistband.yml
 - spec/config/waistband/waistband_events.yml
 - spec/config/waistband/waistband_events_no_name.yml
+- spec/config/waistband/waistband_events_with_env_permissions.yml
+- spec/config/waistband/waistband_events_with_permissions.yml
 - spec/config/waistband/waistband_geo.yml
 - spec/config/waistband/waistband_multi_connection_events.yml
+- spec/config/waistband/waistband_no_mappings.yml
 - spec/config/waistband/waistband_search.yml
 - spec/lib/body_size_logging_spec.rb
 - spec/lib/configuration_spec.rb
+- spec/lib/index/index_spec.rb
+- spec/lib/index/permissions_spec.rb
+- spec/lib/index/type_spec.rb
 - spec/lib/index_multi_connection_spec.rb
-- spec/lib/index_spec.rb
 - spec/lib/result_spec.rb
 - spec/lib/search_results_spec.rb
 - spec/spec_helper.rb
@@ -150,13 +156,18 @@ test_files:
 - spec/config/waistband/waistband.yml
 - spec/config/waistband/waistband_events.yml
 - spec/config/waistband/waistband_events_no_name.yml
+- spec/config/waistband/waistband_events_with_env_permissions.yml
+- spec/config/waistband/waistband_events_with_permissions.yml
 - spec/config/waistband/waistband_geo.yml
 - spec/config/waistband/waistband_multi_connection_events.yml
+- spec/config/waistband/waistband_no_mappings.yml
 - spec/config/waistband/waistband_search.yml
 - spec/lib/body_size_logging_spec.rb
 - spec/lib/configuration_spec.rb
+- spec/lib/index/index_spec.rb
+- spec/lib/index/permissions_spec.rb
+- spec/lib/index/type_spec.rb
 - spec/lib/index_multi_connection_spec.rb
-- spec/lib/index_spec.rb
 - spec/lib/result_spec.rb
 - spec/lib/search_results_spec.rb
 - spec/spec_helper.rb