elastic_adapter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7d2b6efb6221dc7ad620073a1d963ce0f92415f
+  data.tar.gz: c881d1dbbfd1c00d4864224ff8296758709258bd
+SHA512:
+  metadata.gz: b8d5f3a1b40dc170c471f14e4a1cc5552cca27c6fa96542f4fb7bee5e17386a34abe7e3247f8e4ebb9afb125d84242636bfb3a238ec1d5d3d3b0ab4eb1aef974
+  data.tar.gz: 744cf2cdf6619e92f49aea07ded6d0e6e4640e769b262b6d3e566fdb52e823109b54a7dbe908d054d1a83adfd6ce7e6c08c163f6250f3dd186b4f58aff35f12c

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kristopher Bredemeier
+
+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

@@ -0,0 +1,41 @@
+# ElasticAdapter
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elastic_adapter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elastic_adapter
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## Testing and Development
+
+For a few specs I needed to place some sleep statements to make them work. To not slow down the specs with the sleep statements and for other reasons
+I decided to use VCR to capture the requests. I added a rake taks which sets an environment variable which is used in a helper function to decide either to
+`sleep 1` or not. This way the specs are not slowed down. To execute the rake task run `rake record`.
+
+Unfortunatly VCR skips recording some context blocks for unknown reason. I didn't had the time to look into that yet. That means that it is required
+to have a running elasticsearch at `localhost:9200` to run the specs.
+
+## Contributing
+
+1. Fork it ( https://github.com/kbredemeier/elastic_adapter/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

data/Rakefile

@@ -0,0 +1,24 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "fileutils"
+require "yard"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :console do
+  exec "irb -r elastic_adapter -I ./lib"
+end
+
+RSpec::Core::RakeTask.new(:record) do |t|
+  ENV['RECORDING'] = "1"
+  FileUtils.rm_rf "spec/cassettes"
+  t.rspec_opts = "--tag vcr"
+end
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files   = ['lib/**/*.rb']
+  # t.options = ['--any', '--extra', '--opts'] # optional
+  # t.stats_options = ['--list-undoc']         # optional
+end

data/elastic_adapter.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elastic_adapter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elastic_adapter"
+  spec.version       = ElasticAdapter::VERSION
+  spec.authors       = ["Kristopher Bredemeier"]
+  spec.email         = ["k.bredemeier@gmail.com"]
+  spec.summary       = %q{Repository like access to elasticseach indices}
+  spec.description   = %q{Repository like access to elasticseach indices}
+  spec.homepage      = "https://github.com/kbredemeier/elastic_adatper"
+  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_dependency "elasticsearch", "~> 1.0.6"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "vcr", "~> 2.9.3"
+  spec.add_development_dependency "webmock", "~> 1.20.4"
+  spec.add_development_dependency "pry-byebug", "~> 3.0.1"
+  spec.add_development_dependency "yard", "~> 0.8.7.6"
+end

data/example.env

@@ -0,0 +1,4 @@
+TEST_CLUSTER_NAME="elastic_adatper_test_cluster"
+TEST_CLUSTER_COMMAND="sh /path/to/elasticsearch"
+TEST_CLUSTER_PORT=9350
+TEST_CLUSTER_NODES=1

data/lib/elastic_adapter/decoration/count_response.rb

@@ -0,0 +1,18 @@
+module ElasticAdapter
+  module Decoration
+    # Used to wrap responses from the elasticsearch count api
+    # After decoration the decorator will point to the actual
+    # count returned by elasticsearch
+    class CountResponse < Decorator
+
+      # Reduced the hash to the count returned by elasticsearch
+      #
+      # @param [Object] object
+      # @return [Integer] the count returned by elasticsearch
+      def alter_object(object)
+        object[:count]
+      end
+
+    end
+  end
+end

data/lib/elastic_adapter/decoration/decorator.rb

@@ -0,0 +1,39 @@
+require "delegate"
+
+module ElasticAdapter
+  module Decoration
+    # Abstract base class for response decorators
+    # @abstract
+    #
+    # @attr [Object] original_object the original unmodified object
+    class Decorator < SimpleDelegator
+
+      attr_reader :original_object
+
+      # Takes an object and stores it in `@original_object` and saves a
+      # altered version as the decorated object
+      #
+      # @param [Object] object
+      def initialize(object)
+        @original_object = object
+        __setobj__(alter_object(object))
+      end
+
+      # Returns the underlaying altered object
+      #
+      # @return [Object] the altered object
+      def object
+        __getobj__
+      end
+
+      # Is intended to alter the passed object to change it's interface
+      #
+      # @param [Object] object
+      # @return [Object]
+      def alter_object(object)
+        fail NotImplementedError, "alter_object must be overriden in subclasses!"
+      end
+
+    end
+  end
+end

data/lib/elastic_adapter/decoration/hit_decorator.rb

@@ -0,0 +1,25 @@
+module ElasticAdapter
+  module Decoration
+    # Used to decorate responses from the elasticsearch get api or
+    # to decorate single hits returned from the elasticsearch
+    # search api
+    #
+    # @see ResponseDecoratorFactory
+    # @see SearchResponse#alter_object
+    class HitDecorator < Decorator
+      # Reduces the interface of a single hit
+      #
+      # @param [Hash] hash
+      # @return [Hash]
+      def alter_object(hash)
+        new_hash = {}
+        new_hash[:id] = hash[:id]
+        hash[:source].each do |key, value|
+          new_hash[key] = value
+        end
+
+        new_hash
+      end
+    end
+  end
+end

data/lib/elastic_adapter/decoration/response_decorator_factory.rb

@@ -0,0 +1,51 @@
+module ElasticAdapter
+  module Decoration
+    # This class is used inside the Response and is used to determin
+    # the decorator for responses returned by elasticsearch
+    # 
+    # @see Response#decorate
+    class ResponseDecoratorFactory
+      class << self
+        # Takes a response and returns it with the right decorator
+        # applied
+        #
+        # @param [Hash] response a response returned by elasticsearch
+        # @return [Docorator] a decorated response
+        def decorate(response)
+          if response.key? :acknowledged
+          elsif response.key? :created
+          elsif response.key? :exception
+          elsif response.key? :count
+            return CountResponse.new(response)
+          elsif response.key? :source
+            return HitDecorator.new(response)
+          elsif response.key? :hits
+            return SearchResponse.new(response)
+          elsif response.key? :valid
+            return ValidationResponse.new(response)
+          elsif suggestion?(response)
+            return SuggestionResponse.new(response)
+          end
+
+          response
+        end
+
+        private
+
+        # Checks if the passed response is a response
+        # from the elasticsearch suggest api
+        #
+        # @param [Hash] response
+        # @return [Boolean]
+        def suggestion?(response)
+          second_key = response[response.keys[1]]
+          return false unless second_key.is_a? Array
+          return false if second_key.empty?
+          return false unless second_key.first.is_a? Hash
+          return false unless second_key.first.key? :options
+          return true
+        end
+      end
+    end
+  end
+end

data/lib/elastic_adapter/decoration/search_response.rb

@@ -0,0 +1,29 @@
+module ElasticAdapter
+  module Decoration
+    # Used to decorate responses from the elasticsearch search api
+    #
+    # @attr_reader [Integer] count the total amount of search results
+    class SearchResponse < Decorator
+
+      attr_reader :count
+
+      # Reduces the interface and assigns the @count variable
+      #
+      # @param [Hash] hash
+      # @return [Hash]
+      def alter_object(hash)
+        new_hash = {}
+        new_hash[:count] = hash[:hits][:total]
+        @count = new_hash[:count]
+        new_hash[:hits] = []
+
+        hash[:hits][:hits].each do |hit|
+          new_hash[:hits] << HitDecorator.new(hit)
+        end
+
+        new_hash
+      end
+
+    end
+  end
+end

data/lib/elastic_adapter/decoration/suggestion_response.rb

@@ -0,0 +1,25 @@
+module ElasticAdapter
+  module Decoration
+    # Used to decorate responses from the elasticsearch suggestion api
+    # @attr_reader [Integer] count the amount of suggestions
+    class SuggestionResponse < Decorator
+
+      attr_reader :count
+
+      # Builds a Hash with a smaller interface from the
+      # decorated response
+      #
+      # @param [Hash] hash
+      # @return [Hash]
+      def alter_object(hash)
+        new_hash = {}
+        new_hash[:options] = hash[hash.keys[1]].first[:options]
+        new_hash
+      end
+
+      def count
+        @count ||= self[:options].length
+      end
+    end
+  end
+end

data/lib/elastic_adapter/decoration/validation_response.rb

@@ -0,0 +1,16 @@
+module ElasticAdapter
+  module Decoration
+    # Used to decorate responses from the elasticseach suggest api.
+    # Delegates to a Boolean
+    class ValidationResponse < Decorator
+
+      # Returns the validation status from the original hash
+      #
+      # @param [Hash] hash
+      # @return [Hash]
+      def alter_object(hash)
+        hash[:valid]
+      end
+    end
+  end
+end

data/lib/elastic_adapter/document_type.rb

@@ -0,0 +1,21 @@
+module ElasticAdapter
+  # This class is intended to hold information about
+  # a document in an elasticsearch index
+  #
+  # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping.html Elasticsearch Mappings
+  #
+  # @attr_reader [String] name the name of the document
+  # @attr_reader [Hash] mappings the mappings for the document
+  class DocumentType
+
+    attr_reader :name, :mappings
+
+    # @param [String] name
+    # @param [Hash] mappings
+    def initialize(name, mappings)
+      @name = name
+      @mappings = mappings
+    end
+
+  end
+end

data/lib/elastic_adapter/index.rb

@@ -0,0 +1,108 @@
+module ElasticAdapter
+  # This class encapsulates the access to an elasticsearch index
+  class Index
+    attr_reader :name, :settings, :document_type, :url, :log, :client
+
+    def initialize(params)
+      @name = params.fetch(:name)
+      @settings = params.fetch(:settings)
+      @document_type = params.fetch(:document_type)
+      @url = params.fetch(:url)
+      @log = params.fetch(:log)
+      @client = params.fetch(:client, Elasticsearch::Client.new(url: url, log: log))
+
+      self
+    end
+
+    def create_index
+      handle_api_call do
+        client.indices.create(
+          index: name,
+          body: {
+            mappings: document_type.mappings,
+            settings: settings
+          }
+        )
+      end
+    end
+
+    def delete_index
+      handle_api_call do
+        client.indices.delete index: name
+      end
+    end
+
+    def count(query = {query:{match_all: {}}})
+      handle_api_call do
+        client.count index: name, body: query
+      end
+    end
+
+    def index(document)
+      doc = document.to_hash.merge({})
+
+      params = {
+        index: name,
+        id: doc.delete(:id),
+        type: document_type.name,
+        body: doc
+      }
+
+      response = handle_api_call do
+        client.index(params)
+      end
+
+      response
+    end
+
+    def get(id)
+      handle_api_call do
+        client.get(
+          index: name,
+          type: document_type.name,
+          id: id
+        )
+      end
+    end
+
+    def search(query)
+      handle_api_call do
+        client.search(
+          index: name,
+          body: query
+        )
+      end
+    end
+
+    def suggest(query)
+      handle_api_call do
+        client.suggest(
+          index: name,
+          body: query
+        )
+      end
+    end
+
+    def validate(query)
+      handle_api_call do
+        client.indices.validate_query(
+          index: name,
+          explain: true,
+          body: query
+        )
+      end
+    end
+
+    private
+
+    def handle_api_call
+      begin
+        Response.new(yield).decorate
+      rescue Elasticsearch::Transport::Transport::Error => e
+        Response.new(
+          exception: e
+        )
+      end
+    end
+  end
+end

data/lib/elastic_adapter/response.rb

@@ -0,0 +1,57 @@
+module ElasticAdapter
+  # Serves to wrap the responses from elasticsearch
+  class Response < ::ElasticAdapter::Decoration::Decorator
+
+    # Checks if the operation was successfull
+    #
+    # @return [Boolean]
+    def success?
+      !failure?
+    end
+
+    # Checks if the operation failed
+    #
+    # @return [Boolean]
+    def failure?
+      key?(:exception)
+    end
+
+    # Decorates the response with the right decorator
+    #
+    # @return [Decorator] returns the decorated response
+    def decorate
+      Decoration::ResponseDecoratorFactory.decorate(self)
+    end
+
+    private
+
+    # Sanitizes a nested hash. It removes leading underscores
+    # from keys and turns them into symbols. This methods gets
+    # overridden by other response decorators.
+    #
+    # @param [Hash] hash
+    # @return [Hash]
+    def alter_object(object)
+      object.inject({}) do |result, (key, value)|
+        new_value = nil
+
+        case value
+        when Hash
+          new_value = alter_object(value)
+        when Array
+          new_value = value.map { |i| alter_object(i) }
+        else
+          new_value = value
+        end
+
+        result[remove_leading_underscore(key).to_sym] = new_value
+
+        result
+      end
+    end
+
+    def remove_leading_underscore(string)
+      /^_?(.*)$/.match(string)[1]
+    end
+  end
+end

data/lib/elastic_adapter/version.rb

@@ -0,0 +1,3 @@
+module ElasticAdapter
+  VERSION = "0.0.1"
+end

data/lib/elastic_adapter.rb

@@ -0,0 +1,21 @@
+require "elasticsearch"
+
+require "elastic_adapter/version"
+require "elastic_adapter/document_type"
+require "elastic_adapter/decoration/decorator"
+require "elastic_adapter/decoration/hit_decorator"
+require "elastic_adapter/decoration/count_response"
+require "elastic_adapter/decoration/validation_response"
+require "elastic_adapter/decoration/suggestion_response"
+require "elastic_adapter/decoration/search_response"
+require "elastic_adapter/decoration/response_decorator_factory"
+require "elastic_adapter/response"
+require "elastic_adapter/index"
+
+begin
+  require "pry"
+rescue LoadError
+end
+
+module ElasticAdapter
+end

data/spec/cassettes/ElasticAdapter_Index/_count/empty_index/is_a_response.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:9200/test_index/_count
+    body:
+      encoding: UTF-8
+      string: '{"query":{"match_all":{}}}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '59'
+    body:
+      encoding: UTF-8
+      string: '{"count":0,"_shards":{"total":5,"successful":5,"failed":0}}'
+    http_version: 
+  recorded_at: Thu, 05 Feb 2015 21:07:02 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_count/empty_index/returs_the_amount_of_all_documents.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:9200/test_index/_count
+    body:
+      encoding: UTF-8
+      string: '{"query":{"match_all":{}}}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '59'
+    body:
+      encoding: UTF-8
+      string: '{"count":0,"_shards":{"total":5,"successful":5,"failed":0}}'
+    http_version: 
+  recorded_at: Thu, 05 Feb 2015 19:30:14 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_count/not_empty_index/is_a_response.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:9200/test_index/_count
+    body:
+      encoding: UTF-8
+      string: '{"query":{"match_all":{}}}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '59'
+    body:
+      encoding: UTF-8
+      string: '{"count":1,"_shards":{"total":5,"successful":5,"failed":0}}'
+    http_version: 
+  recorded_at: Thu, 05 Feb 2015 21:05:04 GMT
+recorded_with: VCR 2.9.3