elastic_adapter 0.0.1 → 0.0.2

data/lib/elastic_adapter/document_type.rb

@@ -1,13 +1,24 @@
+# rubocop:disable Metrics/LineLength
 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
   #
+  # @example
+  #   document_type = ElasticAdatper::DocumentType.new("test_doc", {
+  #     test_doc: {
+  #       properties: {
+  #         name: {
+  #           type: "string"
+  #         }
+  #       }
+  #     }
+  #   })
+  #
   # @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
@@ -16,6 +27,5 @@ module ElasticAdapter
       @name = name
       @mappings = mappings
     end
-
   end
 end

data/lib/elastic_adapter/index.rb

@@ -1,19 +1,60 @@
 module ElasticAdapter
-  # This class encapsulates the access to an elasticsearch index
+  # This class encapsulates the access to a Elasticsearch::Transport::Client
+  # and provides an implementation of the repository pattern
+  #
+  # @attr_reader [String] name the name of the index
+  # @attr_reader [Hash] settings the index settings
+  # @attr_reader [DocumentType] document_type a DocumentType
+  #   with the document name and it's mappings
+  # @attr_reader [String] url the url to elasticsearch
+  # @attr_reader [Boolean] log print degub log to $stdout
+  # @attr_reader [Client] client the client who
+  #   handles the communication with elasticsearch
+  #
+  # @example Initialization
+  #   index = ElasticAdapter::Index.new(
+  #     name: "test_index",
+  #     settings: { number_of_shards: 1 },
+  #     document_type: ElasticAdapter::DocumentType.new("test_doc", mappings: {
+  #         test_doc: {
+  #           properties: {
+  #             foo: { type: "string" }
+  #           }
+  #         }
+  #       }
+  #     ),
+  #     url: "localhost:9200",
+  #     log: true
+  #   )
   class Index
     attr_reader :name, :settings, :document_type, :url, :log, :client
 
+    # @param [Hash] params
+    # @option params [String] :name required
+    # @option params [Hash] :settings required
+    # @option params [DocumentType] :document_type required
+    # @option params [String] :url required
+    # @option params [Boolean] :log required
+    # @option params [Client] client optional: A client. Defaults to
+    #   Elasticsearch#Transport#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))
+      @client = params.fetch :client do
+        Elasticsearch::Client.new(url: url, log: log)
+      end
 
       self
     end
 
+    # Creates the index with it's settings and mappings
+    #
+    # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html Elasticsearch create index
+    #
+    # @return [ElasticAdapter::Response]
     def create_index
       handle_api_call do
         client.indices.create(
@@ -26,18 +67,40 @@ module ElasticAdapter
       end
     end
 
+    # Deletes the index
+    #
+    # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html Elasticsearch delete index
+    #
+    # @return [ElasticAdapter::Response]
     def delete_index
       handle_api_call do
         client.indices.delete index: name
       end
     end
 
-    def count(query = {query:{match_all: {}}})
+    # Returns the document count for the index
+    #
+    # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-count.html#search-count Elasticsearch count api
+    #
+    # @param [Hash] query a query to count the documents for a given query. Defaults to match all
+    # @return [Decoration::CountResponse] the count
+    def count(query = { query: { match_all: {} } })
       handle_api_call do
         client.count index: name, body: query
       end
     end
 
+    # Indexes a Hash or anything that responds to to_hash as a document
+    # in the index
+    #
+    # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html Elasticsearch index api
+    #
+    # @example
+    #   test_index = ElasticAdapter::Index.new(...)
+    #   test_index.index(id: 1, name: "foo")
+    #
+    # @param [Hash] document
+    # @return [Response]
     def index(document)
       doc = document.to_hash.merge({})
 
@@ -55,6 +118,12 @@ module ElasticAdapter
       response
     end
 
+    # Returns the document with the given id from the index
+    #
+    # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html Elasticsearch get api
+    #
+    # @param [Integer] id
+    # @return [ElasticAdapter::HitDecorator]
     def get(id)
       handle_api_call do
         client.get(
@@ -65,6 +134,16 @@ module ElasticAdapter
       end
     end
 
+    # Searches the index for documents matching the passed query.
+    #
+    # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search.html Elasticsearch search apis
+    #
+    # @example
+    #   test_index = ElasticAdatper::Index.new(...)
+    #   test_index.seach(query: {match: {foo: "bar"}})
+    #
+    # @param [Hash] query
+    # @return [ElasticAdapter::SearchResponse]
     def search(query)
       handle_api_call do
         client.search(
@@ -74,6 +153,16 @@ module ElasticAdapter
       end
     end
 
+    # Searches the index for suggestions for the passed suggest query
+    #
+    # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-suggesters.html Elasticsearch suggesters
+    #
+    # @example
+    #   test_index = ElasticAdatper::Index.new(...)
+    #   test_index.seach(name_suggestions: {text: "foo", completion: {field: "name"}})
+    #
+    # @param [Hash] query
+    # @return [ElasticAdapter::SuggestResponse]
     def suggest(query)
       handle_api_call do
         client.suggest(
@@ -83,6 +172,12 @@ module ElasticAdapter
       end
     end
 
+    # Validates the passed query
+    #
+    # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-validate.html Elasticsearch validate api
+    #
+    # @param [Hash] query
+    # @return [ElasticAdapter::ValidationResponse]
     def validate(query)
       handle_api_call do
         client.indices.validate_query(
@@ -96,13 +191,11 @@ module ElasticAdapter
     private
 
     def handle_api_call
-      begin
-        Response.new(yield).decorate
-      rescue Elasticsearch::Transport::Transport::Error => e
-        Response.new(
-          exception: e
-        )
-      end
+      Response.new(yield).decorate
+    rescue Elasticsearch::Transport::Transport::Error => e
+      Response.new(
+        exception: e
+      )
     end
   end
 end

data/lib/elastic_adapter/response.rb

@@ -1,7 +1,6 @@
 module ElasticAdapter
   # Serves to wrap the responses from elasticsearch
   class Response < ::ElasticAdapter::Decoration::Decorator
-
     # Checks if the operation was successfull
     #
     # @return [Boolean]
@@ -32,6 +31,8 @@ module ElasticAdapter
     # @param [Hash] hash
     # @return [Hash]
     def alter_object(object)
+      return object unless [Hash, Array].include? object.class
+
       object.inject({}) do |result, (key, value)|
         new_value = nil
 

data/lib/elastic_adapter/version.rb

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

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

@@ -26,5 +26,5 @@ http_interactions:
       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_at: Sat, 07 Feb 2015 19:44:08 GMT
 recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_count/empty_index/{returs_the_amount_of_all_documents.yml → returns_the_amount_of_all_documents.yml}

@@ -26,5 +26,5 @@ http_interactions:
       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_at: Sat, 07 Feb 2015 19:44:08 GMT
 recorded_with: VCR 2.9.3

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

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://localhost:9200/test_index
+    body:
+      encoding: UTF-8
+      string: '{"mappings":{"test_doc":{"properties":{"foo":{"type":"string"},"foo_suggest":{"type":"completion"}}}},"settings":{}}'
+    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:
+      - '21'
+    body:
+      encoding: UTF-8
+      string: '{"acknowledged":true}'
+    http_version: 
+  recorded_at: Sat, 07 Feb 2015 19:44:05 GMT
+- request:
+    method: delete
+    uri: http://localhost:9200/test_index
+    body:
+      encoding: US-ASCII
+      string: ''
+    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:
+      - '21'
+    body:
+      encoding: UTF-8
+      string: '{"acknowledged":true}'
+    http_version: 
+  recorded_at: Sat, 07 Feb 2015 19:44:08 GMT
+recorded_with: VCR 2.9.3

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

@@ -26,5 +26,5 @@ http_interactions:
       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_at: Sat, 07 Feb 2015 19:44:14 GMT
 recorded_with: VCR 2.9.3

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

@@ -26,5 +26,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"count":1,"_shards":{"total":5,"successful":5,"failed":0}}'
     http_version: 
-  recorded_at: Thu, 05 Feb 2015 19:30:15 GMT
+  recorded_at: Sat, 07 Feb 2015 19:44:14 GMT
 recorded_with: VCR 2.9.3

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

@@ -0,0 +1,84 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://localhost:9200/test_index
+    body:
+      encoding: UTF-8
+      string: '{"mappings":{"test_doc":{"properties":{"foo":{"type":"string"},"foo_suggest":{"type":"completion"}}}},"settings":{}}'
+    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:
+      - '21'
+    body:
+      encoding: UTF-8
+      string: '{"acknowledged":true}'
+    http_version: 
+  recorded_at: Sat, 07 Feb 2015 19:44:08 GMT
+- request:
+    method: post
+    uri: http://localhost:9200/test_index/test_doc
+    body:
+      encoding: UTF-8
+      string: '{"foo":"bar"}'
+    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: 201
+      message: Created
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '99'
+    body:
+      encoding: UTF-8
+      string: '{"_index":"test_index","_type":"test_doc","_id":"AUtlkiRsm1jcpZVj70ky","_version":1,"created":true}'
+    http_version: 
+  recorded_at: Sat, 07 Feb 2015 19:44:11 GMT
+- request:
+    method: delete
+    uri: http://localhost:9200/test_index
+    body:
+      encoding: US-ASCII
+      string: ''
+    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:
+      - '21'
+    body:
+      encoding: UTF-8
+      string: '{"acknowledged":true}'
+    http_version: 
+  recorded_at: Sat, 07 Feb 2015 19:44:14 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_create_index/index_is_present/response/has_an_exception.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: http://localhost:9200/test_index
     body:
       encoding: UTF-8
-      string: '{"mappings":{"test_index":{"properties":{"foo":{"type":"string"}}}},"settings":{"number_of_shards":1}}'
+      string: '{"mappings":{"test_index":{"properties":{"foo":{"type":"string","foo_suggest":{"type":"completion"}}}}},"settings":{"number_of_shards":1}}'
     headers:
       User-Agent:
       - Faraday v0.9.1
@@ -26,5 +26,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"error":"IndexAlreadyExistsException[[test_index] already exists]","status":400}'
     http_version: 
-  recorded_at: Thu, 05 Feb 2015 19:30:15 GMT
+  recorded_at: Sat, 07 Feb 2015 19:44:17 GMT
 recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_create_index/index_is_present/response/is_a_Response.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: http://localhost:9200/test_index
     body:
       encoding: UTF-8
-      string: '{"mappings":{"test_index":{"properties":{"foo":{"type":"string"}}}},"settings":{"number_of_shards":1}}'
+      string: '{"mappings":{"test_index":{"properties":{"foo":{"type":"string","foo_suggest":{"type":"completion"}}}}},"settings":{"number_of_shards":1}}'
     headers:
       User-Agent:
       - Faraday v0.9.1
@@ -26,5 +26,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"error":"IndexAlreadyExistsException[[test_index] already exists]","status":400}'
     http_version: 
-  recorded_at: Thu, 05 Feb 2015 19:30:15 GMT
+  recorded_at: Sat, 07 Feb 2015 19:44:17 GMT
 recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_create_index/index_is_present.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://localhost:9200/test_index
+    body:
+      encoding: UTF-8
+      string: '{"mappings":{"test_doc":{"properties":{"foo":{"type":"string"},"foo_suggest":{"type":"completion"}}}},"settings":{}}'
+    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:
+      - '21'
+    body:
+      encoding: UTF-8
+      string: '{"acknowledged":true}'
+    http_version: 
+  recorded_at: Sat, 07 Feb 2015 19:44:14 GMT
+- request:
+    method: delete
+    uri: http://localhost:9200/test_index
+    body:
+      encoding: US-ASCII
+      string: ''
+    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:
+      - '21'
+    body:
+      encoding: UTF-8
+      string: '{"acknowledged":true}'
+    http_version: 
+  recorded_at: Sat, 07 Feb 2015 19:44:17 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_create_index/index_not_present/response/has_no_exception.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: http://localhost:9200/test_index
     body:
       encoding: UTF-8
-      string: '{"mappings":{"test_index":{"properties":{"foo":{"type":"string"}}}},"settings":{"number_of_shards":1}}'
+      string: '{"mappings":{"test_index":{"properties":{"foo":{"type":"string","foo_suggest":{"type":"completion"}}}}},"settings":{"number_of_shards":1}}'
     headers:
       User-Agent:
       - Faraday v0.9.1
@@ -26,32 +26,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"acknowledged":true}'
     http_version: 
-  recorded_at: Thu, 05 Feb 2015 19:30:15 GMT
-- request:
-    method: delete
-    uri: http://localhost:9200/test_index
-    body:
-      encoding: US-ASCII
-      string: ''
-    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:
-      - '21'
-    body:
-      encoding: UTF-8
-      string: '{"acknowledged":true}'
-    http_version: 
-  recorded_at: Thu, 05 Feb 2015 19:30:15 GMT
+  recorded_at: Sat, 07 Feb 2015 19:44:17 GMT
 recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_create_index/index_not_present/response/is_a_Response.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: http://localhost:9200/test_index
     body:
       encoding: UTF-8
-      string: '{"mappings":{"test_index":{"properties":{"foo":{"type":"string"}}}},"settings":{"number_of_shards":1}}'
+      string: '{"mappings":{"test_index":{"properties":{"foo":{"type":"string","foo_suggest":{"type":"completion"}}}}},"settings":{"number_of_shards":1}}'
     headers:
       User-Agent:
       - Faraday v0.9.1
@@ -26,32 +26,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"acknowledged":true}'
     http_version: 
-  recorded_at: Thu, 05 Feb 2015 19:30:15 GMT
-- request:
-    method: delete
-    uri: http://localhost:9200/test_index
-    body:
-      encoding: US-ASCII
-      string: ''
-    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:
-      - '21'
-    body:
-      encoding: UTF-8
-      string: '{"acknowledged":true}'
-    http_version: 
-  recorded_at: Thu, 05 Feb 2015 19:30:15 GMT
+  recorded_at: Sat, 07 Feb 2015 19:44:17 GMT
 recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_create_index/index_not_present/response.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: http://localhost:9200/test_index
+    body:
+      encoding: US-ASCII
+      string: ''
+    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:
+      - '21'
+    body:
+      encoding: UTF-8
+      string: '{"acknowledged":true}'
+    http_version: 
+  recorded_at: Sat, 07 Feb 2015 19:44:17 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_delete_index/index_not_present/repsonse/has_an_exception.yml

@@ -26,5 +26,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"error":"IndexMissingException[[test_index] missing]","status":404}'
     http_version: 
-  recorded_at: Thu, 05 Feb 2015 19:30:15 GMT
+  recorded_at: Sat, 07 Feb 2015 19:44:23 GMT
 recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_delete_index/index_not_present/repsonse/is_a_Response.yml

@@ -26,5 +26,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"error":"IndexMissingException[[test_index] missing]","status":404}'
     http_version: 
-  recorded_at: Thu, 05 Feb 2015 19:30:15 GMT
+  recorded_at: Sat, 07 Feb 2015 19:44:23 GMT
 recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_delete_index/index_present/repsonse/has_no_exception.yml

@@ -1,32 +1,5 @@
 ---
 http_interactions:
-- request:
-    method: put
-    uri: http://localhost:9200/test_index
-    body:
-      encoding: UTF-8
-      string: '{"mappings":{"test_doc":{"properties":{"foo":{"type":"string"}}}},"settings":{}}'
-    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:
-      - '21'
-    body:
-      encoding: UTF-8
-      string: '{"acknowledged":true}'
-    http_version: 
-  recorded_at: Thu, 05 Feb 2015 19:30:15 GMT
 - request:
     method: delete
     uri: http://localhost:9200/test_index
@@ -53,5 +26,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"acknowledged":true}'
     http_version: 
-  recorded_at: Thu, 05 Feb 2015 19:30:15 GMT
+  recorded_at: Sat, 07 Feb 2015 19:44:23 GMT
 recorded_with: VCR 2.9.3