elastic_search_framework 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3462f6d260c17cc73a60848b61901bd26672a8b7
+  data.tar.gz: 9b3ec91367cc9e54d4dea7d6cb2a226c6d3a4486
+SHA512:
+  metadata.gz: a367754c71d545eaf6fb439ce9c4c11c5f0dd49dc4c935316c2fa708c3c8464af7125c1f10b6abcf7c5d25babf84a785f54ae142ea3ad907da28453361b79cbf
+  data.tar.gz: 845e279c30d93a5542bd23552993bec60ea81912e8ee22ed79f8848a4b5e61a1507f6fed8bcf29982f3232f4e793ac4140b92e1cc3d393b195ca413e8ba2461b

data/lib/elastic_search_framework.rb

@@ -0,0 +1,38 @@
+require 'hash_kit'
+require 'json'
+require 'curb'
+require_relative 'elastic_search_framework/version'
+require_relative 'elastic_search_framework/logger'
+require_relative 'elastic_search_framework/exceptions'
+require_relative 'elastic_search_framework/repository'
+require_relative 'elastic_search_framework/index'
+require_relative 'elastic_search_framework/query'
+
+require 'date'
+
+module ElasticSearchFramework
+  def self.namespace=(value)
+    @namespace = value
+  end
+  def self.namespace
+    @namespace
+  end
+  def self.namespace_delimiter=(value)
+    @namespace_delimiter = value
+  end
+  def self.namespace_delimiter
+    @namespace_delimiter ||= '.'
+  end
+  def self.host=(value)
+    @host = value
+  end
+  def self.host
+    @host
+  end
+  def self.port=(value)
+    @port = value
+  end
+  def self.port
+    @port ||= 9200
+  end
+end

data/lib/elastic_search_framework/exceptions.rb

@@ -0,0 +1 @@
+require_relative 'exceptions/index_error'

data/lib/elastic_search_framework/exceptions/index_error.rb

@@ -0,0 +1,6 @@
+module ElasticSearchFramework
+  module Exceptions
+    class IndexError < StandardError
+    end
+  end
+end

data/lib/elastic_search_framework/index.rb

@@ -0,0 +1,177 @@
+module ElasticSearchFramework
+  module Index
+    def index(name:, shards: nil)
+      unless instance_variable_defined?(:@elastic_search_index_def)
+        instance_variable_set(:@elastic_search_index_def, {
+            name: "#{name}", shards: shards
+        })
+      else
+        raise ElasticSearchFramework::Exceptions::IndexError.new("[#{self.class}] - Duplicate index description. Name: #{name} | Shards: #{shards}.")
+      end
+    end
+
+    def id(field)
+      unless instance_variable_defined?(:@elastic_search_index_id)
+        instance_variable_set(:@elastic_search_index_id, field)
+      else
+        raise ElasticSearchFramework::Exceptions::IndexError.new("[#{self.class}] - Duplicate index id. Field: #{field}.")
+      end
+    end
+
+    def mapping(name:, field:, type:, analyser:)
+
+      unless instance_variable_defined?(:@elastic_search_index_mappings)
+        instance_variable_set(:@elastic_search_index_mappings, {})
+      end
+
+      mappings = instance_variable_get(:@elastic_search_index_mappings)
+
+      if mappings[name] == nil
+        mappings[name] = {}
+      end
+
+      mappings[name][field] = { type: type, analyser: analyser}
+
+      instance_variable_set(:@elastic_search_index_mappings, mappings)
+
+    end
+
+    def create
+
+      if !valid?
+        raise ElasticSearchFramework::Exceptions::IndexError.new("[#{self.class}] - Invalid Index description specified.")
+      end
+
+      if exists?
+        ElasticSearchFramework.logger.debug { "[#{self.class}] - Index already exists."}
+        return
+      end
+
+      payload = create_payload(description: description, mappings: mappings)
+
+      put(payload: payload)
+
+    end
+
+    def put(payload:)
+      client = curl
+      client.url = "#{host}/#{full_name}"
+      json = JSON.dump(payload)
+      client.http_put(json)
+      unless is_valid_response?(client)
+        raise ElasticSearchFramework::Exceptions::IndexError.new("[#{self}] - Failed to put index. Payload: #{payload} | Response: #{client.body_str}")
+      end
+      true
+    end
+
+    def get
+      client = curl
+      client.url = "#{host}/#{full_name}"
+      client.http_get
+      result = nil
+      if is_valid_response?(client)
+        result = JSON.parse(client.body_str)
+      end
+      result
+    end
+
+    def exists?
+      get != nil
+    end
+
+    def delete
+      client = curl
+      client.url = "#{host}/#{full_name}"
+      client.http_delete
+      is_valid_response?(client) || client.response_code == 404
+    end
+
+    def create_payload(description:, mappings:)
+      payload = {}
+
+      if description[:shards] != nil
+        payload[:settings] = {
+            number_of_shards: Integer(description[:shards])
+        }
+      end
+
+      if mappings.keys.length > 0
+
+        payload[:mappings] = {}
+
+        mappings.keys.each do |name|
+          payload[:mappings][name] = {
+              properties: {}
+          }
+          mappings[name].keys.each do |field|
+            payload[:mappings][name][:properties][field] = {
+                type: mappings[name][field][:type],
+                index: mappings[name][field][:analyser]
+            }
+          end
+        end
+
+      end
+
+      payload
+    end
+
+    def valid?
+      self.instance_variable_get(:@elastic_search_index_def) ? true : false
+    end
+
+    def description
+      hash = self.instance_variable_get(:@elastic_search_index_def)
+      if instance_variable_defined?(:@elastic_search_index_id)
+        hash[:id] = self.instance_variable_get(@elastic_search_index_id)
+      else
+        hash[:id] = :id
+      end
+      hash
+    end
+
+    def mappings
+      self.instance_variable_defined?(:@elastic_search_index_mappings) ? self.instance_variable_get(:@elastic_search_index_mappings) : {}
+    end
+
+    def curl
+      Curl::Easy.new
+    end
+
+    def is_valid_response?(client)
+      [200,201,202].include?(client.response_code)
+    end
+
+    def full_name
+      if ElasticSearchFramework.namespace != nil
+        "#{ElasticSearchFramework.namespace}#{ElasticSearchFramework.namespace_delimiter}#{description[:name].downcase}"
+      else
+        description[:name].downcase
+      end
+    end
+
+    def host
+      "#{ElasticSearchFramework.host}:#{ElasticSearchFramework.port}"
+    end
+
+    def repository
+      ElasticSearchFramework::Repository.new
+    end
+
+    def get_item(id:, type: 'default')
+      repository.get(index: self, id: id, type: type)
+    end
+
+    def put_item(type: 'default', item:)
+      repository.set(entity: item, index: self, type: type)
+    end
+
+    def delete_item(id:, type: 'default')
+      repository.drop(index: self, id: id, type: type)
+    end
+
+    def query
+      ElasticSearchFramework::Query.new(index: self)
+    end
+  end
+end

data/lib/elastic_search_framework/logger.rb

@@ -0,0 +1,15 @@
+require 'logger'
+
+module ElasticSearchFramework
+
+  def self.logger
+    return @@logger
+  end
+
+  def self.set_logger(logger)
+    @@logger = logger
+  end
+
+  ElasticSearchFramework.set_logger(Logger.new(STDOUT))
+
+end

data/lib/elastic_search_framework/query.rb

@@ -0,0 +1,124 @@
+module ElasticSearchFramework
+  class Query
+
+    class InvalidQueryError < StandardError
+      def initialize(message)
+        super(message)
+      end
+    end
+
+    def initialize(index:)
+      @index = index
+      @parts = []
+    end
+
+    def method_missing(name)
+      @parts << { type: :field, value: name }
+      self
+    end
+
+    def eq(value)
+      condition(expression: ':', value: value)
+      self
+    end
+
+    def contains?(value)
+      condition(expression: ':', value: value)
+      self
+    end
+
+    def not_eq(value)
+      field = @parts.last
+      unless field[:type] == :field
+        raise ::InvalidQueryError.new('The not_eq query part can only be chained to a field.')
+      end
+      @parts.pop
+      @parts << { type: :not_eq, field: field[:value], value: value }
+      self
+    end
+
+    def gt(value)
+      condition(expression: ':>', value: value)
+      self
+    end
+
+    def gt_eq(value)
+      condition(expression: ':>=', value: value)
+      self
+    end
+
+    def lt(value)
+      condition(expression: ':<', value: value)
+      self
+    end
+
+    def lt_eq(value)
+      condition(expression: ':<=', value: value)
+      self
+    end
+
+    def exists?
+      field = @parts.last
+      unless field[:type] == :field
+        raise ::InvalidQueryError.new('The exists? query part can only be chained to a field.')
+      end
+      @parts.pop
+      @parts << { type: :exists?, field: field[:value] }
+      self
+    end
+
+    def and
+      @parts << { type: :and }
+      self
+    end
+
+    def or
+      @parts << { type: :or }
+      self
+    end
+
+    def execute(limit: 10, count: false)
+      query = build
+      repository = ElasticSearchFramework::Repository.new
+      repository.query(index: @index, expression: query, limit: limit, count: count)
+    end
+
+    def build
+      @expression_string = ''
+
+      @parts.each do |p|
+        case p[:type]
+          when :field
+            @expression_string += ' ' + p[:value].to_s
+          when :condition
+            @expression_string += p[:expression].to_s + format_value(p[:value])
+          when :exists
+            @expression_string += ' _exists_:' + p[:field].to_s
+          when :not_eq
+            @expression_string += ' NOT (' + p[:field].to_s + ':' + format_value(p[:value]) + ')'
+          when :and
+            @expression_string += ' AND'
+          when :or
+            @expression_string += ' OR'
+          else
+            raise 'Invalid query part'
+        end
+      end
+
+      return @expression_string.strip
+    end
+
+    def condition(expression:, value:)
+      @parts << { type: :condition, expression: expression, value: value }
+    end
+
+    def format_value(value)
+      result = value.to_s
+      if value.is_a?(String)
+        result = '"' + value + '"'
+      end
+      result
+    end
+
+  end
+end

data/lib/elastic_search_framework/repository.rb

@@ -0,0 +1,79 @@
+module ElasticSearchFramework
+  class Repository
+
+    def set(index:, entity:, type: 'default')
+      client = curl
+      client.url = "#{host}/#{index.full_name}/#{type.downcase}/#{get_id_value(index: index, entity: entity)}"
+      hash = hash_helper.to_hash(entity)
+      client.http_put(JSON.dump(hash))
+      unless is_valid_response?(client)
+        raise ElasticSearchFramework::Exceptions::IndexError.new("An error occurred setting an index document. Response: #{client.body_str}")
+      end
+      return true
+    end
+
+    def get(index:, id:, type: 'default')
+      client = curl
+      client.url = "#{host}/#{index.full_name}/#{type.downcase}/#{id}/_source"
+      client.get
+      if is_valid_response?(client)
+        result = JSON.load(client.body_str)
+        hash_helper.indifferent!(result)
+        return result
+      elsif client.response_code == 404
+        return nil
+      else
+        raise ElasticSearchFramework::Exceptions::IndexError.new("An error occurred getting an index document. Response: #{client.body_str}")
+      end
+    end
+
+    def drop(index:, id:, type: 'default')
+      client = curl
+      client.url = "#{host}/#{index.full_name}/#{type.downcase}/#{id}"
+      client.delete
+      if is_valid_response?(client) || client.response_code == 404
+        return true
+      else
+        raise ElasticSearchFramework::Exceptions::IndexError.new("An error occurred dropping an index document. Response: #{client.body_str}")
+      end
+    end
+
+    def query(index:, expression:, type: 'default', limit: 10, count: false)
+      client = curl
+      client.url = "#{host}/#{index.full_name}/#{type}/_search?q=#{URI.encode(expression)}&size=#{limit}"
+      client.get
+      if is_valid_response?(client)
+        result = JSON.parse(client.body_str)
+        hash_helper.indifferent!(result)
+        if count
+          return result[:hits][:total]
+        else
+          return result[:hits][:total] > 0 ? result[:hits][:hits] : []
+        end
+      else
+        raise ElasticSearchFramework::Exceptions::IndexError.new("An error occurred executing an index query. Response: #{client.body_str}")
+      end
+    end
+
+    def curl
+      Curl::Easy.new
+    end
+
+    def is_valid_response?(client)
+      [200,201,202].include?(client.response_code)
+    end
+
+    def host
+      "#{ElasticSearchFramework.host}:#{ElasticSearchFramework.port}"
+    end
+
+    def hash_helper
+      @hash_helper ||= HashKit::Helper.new
+    end
+
+    def get_id_value(index:, entity:)
+      entity.instance_variable_get("@#{index.description[:id]}")
+    end
+
+  end
+end

data/lib/elastic_search_framework/version.rb

@@ -0,0 +1,3 @@
+module ElasticSearchFramework
+  VERSION = '0.1.0'
+end

data/spec/example_index.rb

@@ -0,0 +1,21 @@
+class ExampleIndex
+  extend ElasticSearchFramework::Index
+
+  index name: 'example_index'
+
+  mapping name: 'default', field: :name, type: :string, analyser: :not_analyzed
+
+end
+
+class ExampleIndexWithShard
+  extend ElasticSearchFramework::Index
+
+  index name: 'example_index', shards: 1
+
+  mapping name: 'default', field: :name, type: :string, analyser: :not_analyzed
+
+end
+
+class InvalidExampleIndex
+  extend ElasticSearchFramework::Index
+end

data/spec/index_spec.rb

@@ -0,0 +1,206 @@
+RSpec.describe ElasticSearchFramework::Index do
+
+  describe '#description' do
+    it 'should return the index details' do
+      expect(ExampleIndex.description).to be_a(Hash)
+      expect(ExampleIndex.description[:name]).to eq 'example_index'
+      expect(ExampleIndexWithShard.description[:shards]).to eq 1
+    end
+  end
+
+  describe '#full_name' do
+    let(:namespace) { 'uat' }
+    let(:namespace_delimiter) { '.' }
+    before do
+      ElasticSearchFramework.namespace = namespace
+      ElasticSearchFramework.namespace_delimiter = namespace_delimiter
+    end
+    it 'should return the full index name including namespace and delimiter' do
+      expect(ExampleIndex.full_name).to eq "#{ElasticSearchFramework.namespace}#{ElasticSearchFramework.namespace_delimiter}#{ExampleIndex.description[:name]}"
+    end
+  end
+
+  describe '#mapping' do
+    it 'should add mapping details to the index definition' do
+      mappings = ExampleIndex.mappings
+      expect(mappings).to be_a(Hash)
+      expect(mappings.length).to eq 1
+      expect(mappings['default'][:name][:type]).to eq :string
+      expect(mappings['default'][:name][:analyser]).to eq :not_analyzed
+    end
+  end
+
+  describe '#valid?' do
+    context 'for a valid index definition' do
+      it 'should return true' do
+        expect(ExampleIndex.valid?).to be true
+      end
+    end
+    context 'for an invalid index definition' do
+      it 'should return true' do
+        expect(InvalidExampleIndex.valid?).to be false
+      end
+    end
+  end
+
+  describe '#create' do
+    before do
+      if ExampleIndex.exists?
+        ExampleIndex.delete
+      end
+    end
+    it 'should create an index' do
+      expect(ExampleIndex.exists?).to be false
+      ExampleIndex.create
+      expect(ExampleIndex.exists?).to be true
+    end
+    after do
+      ExampleIndex.delete
+    end
+  end
+
+  describe '#delete' do
+    before do
+      unless ExampleIndex.exists?
+        ExampleIndex.create
+      end
+    end
+    it 'should create an index' do
+      expect(ExampleIndex.exists?).to be true
+      ExampleIndex.delete
+      expect(ExampleIndex.exists?).to be false
+    end
+  end
+
+  describe '#exists?' do
+    context 'when an index exists' do
+      before do
+        ExampleIndex.delete
+        ExampleIndex.create
+      end
+      it 'should return true' do
+        expect(ExampleIndex.exists?).to be true
+      end
+    end
+    context 'when an index exists' do
+      before do
+        ExampleIndex.delete
+      end
+      it 'should return false' do
+        expect(ExampleIndex.exists?).to be false
+      end
+    end
+  end
+
+  describe '#curl' do
+    it 'should return a Curl::Easy instance' do
+      expect(ExampleIndex.curl).to be_a(Curl::Easy)
+    end
+    it 'should return a unique Curl::Easy instance' do
+      expect(ExampleIndex.curl).not_to eq ExampleIndex.curl
+    end
+  end
+
+  describe '#is_valid_response?' do
+    let(:client) { double }
+    context 'when a 200 response code is returned' do
+      before do
+        allow(client).to receive(:response_code).and_return(200)
+      end
+      it 'should return true' do
+        expect(ExampleIndex.is_valid_response?(client)).to be true
+      end
+    end
+    context 'when a 201 response code is returned' do
+      before do
+        allow(client).to receive(:response_code).and_return(201)
+      end
+      it 'should return true' do
+        expect(ExampleIndex.is_valid_response?(client)).to be true
+      end
+    end
+    context 'when a 202 response code is returned' do
+      before do
+        allow(client).to receive(:response_code).and_return(202)
+      end
+      it 'should return true' do
+        expect(ExampleIndex.is_valid_response?(client)).to be true
+      end
+    end
+    context 'when a 400 response code is returned' do
+      before do
+        allow(client).to receive(:response_code).and_return(400)
+      end
+      it 'should return false' do
+        expect(ExampleIndex.is_valid_response?(client)).to be false
+      end
+    end
+    context 'when a 401 response code is returned' do
+      before do
+        allow(client).to receive(:response_code).and_return(401)
+      end
+      it 'should return false' do
+        expect(ExampleIndex.is_valid_response?(client)).to be false
+      end
+    end
+    context 'when a 500 response code is returned' do
+      before do
+        allow(client).to receive(:response_code).and_return(500)
+      end
+      it 'should return false' do
+        expect(ExampleIndex.is_valid_response?(client)).to be false
+      end
+    end
+  end
+
+  describe '#host' do
+    it 'should return the expected host based on default host & port values' do
+      expect(ExampleIndex.host).to eq "#{ElasticSearchFramework.host}:#{ElasticSearchFramework.port}"
+    end
+  end
+
+  describe '#repository' do
+    it 'should return a ElasticSearchFramework::Repository instance' do
+      expect(ExampleIndex.repository).to be_a(ElasticSearchFramework::Repository)
+    end
+    it 'should return a unique ElasticSearchFramework::Repository instance' do
+      expect(ExampleIndex.repository).not_to eq ExampleIndex.repository
+    end
+  end
+
+  describe '#get_item' do
+    let(:id) { 10 }
+    let(:type) { 'default' }
+    it 'should call get on the repository' do
+      expect_any_instance_of(ElasticSearchFramework::Repository).to receive(:get).with(index: ExampleIndex, id: id, type: type)
+      ExampleIndex.get_item(id: id, type: type)
+    end
+  end
+
+  describe '#put_item' do
+    let(:id) { 10 }
+    let(:type) { 'default' }
+    let(:item) do
+      TestItem.new.tap do |i|
+        i.id = id
+        i.name = 'abc'
+        i.timestamp = Time.now.to_i
+        i.number = 5
+      end
+    end
+    it 'should call set on the repository' do
+      expect_any_instance_of(ElasticSearchFramework::Repository).to receive(:set).with(entity: item, index: ExampleIndex, type: type)
+      ExampleIndex.put_item(type: type, item: item)
+    end
+  end
+
+  describe '#delete_item' do
+    let(:id) { 10 }
+    let(:type) { 'default' }
+    it 'should call drop on the repository' do
+      expect_any_instance_of(ElasticSearchFramework::Repository).to receive(:drop).with(index: ExampleIndex, id: id, type: type)
+      ExampleIndex.delete_item(id: id, type: type)
+    end
+  end
+
+end

data/spec/query_spec.rb

@@ -0,0 +1,82 @@
+RSpec.describe ElasticSearchFramework::Query do
+
+  subject do
+    ElasticSearchFramework::Query.new(index: ExampleIndex)
+  end
+
+  describe '#build' do
+    it 'should build the expected query string' do
+      subject.name.eq('fred').and.age.gt(18).and.gender.not_eq('male')
+      expect(subject.build).to eq 'name:"fred" AND age:>18 AND NOT (gender:"male")'
+    end
+  end
+
+  let(:item1) do
+    TestItem.new.tap do |i|
+      i.id = 1
+      i.name = 'fred'
+      i.timestamp = Time.now.to_i
+      i.number = 5
+    end
+  end
+  let(:item2) do
+    TestItem.new.tap do |i|
+      i.id = 2
+      i.name = 'john'
+      i.timestamp = Time.now.to_i - 100
+      i.number = 10
+    end
+  end
+  let(:item3) do
+    TestItem.new.tap do |i|
+      i.id = 3
+      i.name = 'mark'
+      i.timestamp = Time.now.to_i - 200
+      i.number = 15
+    end
+  end
+  let(:item4) do
+    TestItem.new.tap do |i|
+      i.id = 4
+      i.name = 'paul'
+      i.timestamp = Time.now.to_i + 300
+      i.number = 20
+    end
+  end
+
+  describe '#execute' do
+    before do
+      ExampleIndex.delete
+      ExampleIndex.create
+
+      ExampleIndex.put_item(item: item1)
+      ExampleIndex.put_item(item: item2)
+      ExampleIndex.put_item(item: item3)
+      ExampleIndex.put_item(item: item4)
+      sleep 1
+    end
+
+    it 'should return the expected query results' do
+      results = ExampleIndex.query.name.eq('fred').execute
+      expect(results.length).to eq 1
+      expect(results[0][:_source][:name]).to eq item1.name
+      expect(results[0][:_source][:id]).to eq item1.id
+      expect(results[0][:_source][:timestamp]).to eq item1.timestamp
+      expect(results[0][:_source][:number]).to eq item1.number
+
+      results = ExampleIndex.query.number.gt(5).execute
+      expect(results.length).to eq 3
+
+      results = ExampleIndex.query.number.gt_eq(15).execute
+      expect(results.length).to eq 2
+
+      results = ExampleIndex.query.name.not_eq('john').execute
+      expect(results.length).to eq 3
+    end
+
+    after do
+      ExampleIndex.delete
+    end
+  end
+
+end

data/spec/repository_spec.rb

@@ -0,0 +1,119 @@
+RSpec.describe ElasticSearchFramework::Repository do
+  let(:item1) do
+    TestItem.new.tap do |i|
+      i.id = 1
+      i.name = 'fred'
+      i.timestamp = Time.now.to_i
+      i.number = 5
+    end
+  end
+  let(:item2) do
+    TestItem.new.tap do |i|
+      i.id = 2
+      i.name = 'john'
+      i.timestamp = Time.now.to_i - 100
+      i.number = 10
+    end
+  end
+  let(:item3) do
+    TestItem.new.tap do |i|
+      i.id = 3
+      i.name = 'mark'
+      i.timestamp = Time.now.to_i - 200
+      i.number = 15
+    end
+  end
+  let(:item4) do
+    TestItem.new.tap do |i|
+      i.id = 4
+      i.name = 'paul'
+      i.timestamp = Time.now.to_i + 300
+      i.number = 20
+    end
+  end
+
+  describe '#get' do
+    before do
+      ExampleIndex.delete
+      ExampleIndex.create
+    end
+    context 'when no index document exists' do
+      it 'should return nil' do
+        expect(subject.get(index: ExampleIndex, id: item1.id)).to eq nil
+      end
+    end
+    after do
+      ExampleIndex.delete
+    end
+  end
+
+  describe '#CRUD' do
+    before do
+      ExampleIndex.delete
+      ExampleIndex.create
+    end
+
+    it 'should create, read and delete an index document' do
+      subject.set(index: ExampleIndex, entity: item1)
+      subject.set(index: ExampleIndex, entity: item2)
+      index_item1 = subject.get(index: ExampleIndex, id: item1.id)
+      expect(index_item1[:id]).to eq item1.id
+      expect(index_item1[:name]).to eq item1.name
+      expect(index_item1[:timestamp]).to eq item1.timestamp
+      expect(index_item1[:number]).to eq item1.number
+      index_item2 = subject.get(index: ExampleIndex, id: item2.id)
+      expect(index_item2[:id]).to eq item2.id
+      expect(index_item2[:name]).to eq item2.name
+      expect(index_item2[:timestamp]).to eq item2.timestamp
+      expect(index_item2[:number]).to eq item2.number
+      subject.drop(index: ExampleIndex, id: item1.id)
+      expect(subject.get(index: ExampleIndex, id: item1.id)).to be_nil
+    end
+
+    after do
+      ExampleIndex.delete
+    end
+  end
+
+  describe '#query' do
+    before do
+      ExampleIndex.delete
+      ExampleIndex.create
+
+      subject.set(index: ExampleIndex, entity: item1)
+      subject.set(index: ExampleIndex, entity: item2)
+      subject.set(index: ExampleIndex, entity: item3)
+      subject.set(index: ExampleIndex, entity: item4)
+      sleep 1
+    end
+
+    it 'should return the expected query results' do
+      results = subject.query(index: ExampleIndex, expression: 'name:"fred"')
+      expect(results.length).to eq 1
+      expect(results[0][:_source][:name]).to eq item1.name
+      expect(results[0][:_source][:id]).to eq item1.id
+      expect(results[0][:_source][:timestamp]).to eq item1.timestamp
+      expect(results[0][:_source][:number]).to eq item1.number
+
+      results = subject.query(index: ExampleIndex, expression: 'number:>5')
+      expect(results.length).to eq 3
+
+      results = subject.query(index: ExampleIndex, expression: 'number:>=15')
+      expect(results.length).to eq 2
+
+      results = subject.query(index: ExampleIndex, expression: 'NOT (name:john)')
+      expect(results.length).to eq 3
+    end
+
+    after do
+      ExampleIndex.delete
+    end
+  end
+
+  describe '#host' do
+    it 'should return the expected host based on default host & port values' do
+      expect(subject.host).to eq "#{ElasticSearchFramework.host}:#{ElasticSearchFramework.port}"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require "rubygems"
+require "bundler"
+require 'elastic_search_framework'
+require_relative '../spec/test_item.rb'
+require_relative '../spec/example_index'
+require 'pry'
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.order = :defined
+end
+
+ElasticSearchFramework.logger.level = Logger::ERROR
+ElasticSearchFramework.host = 'http://elasticsearch'
+ElasticSearchFramework.port = 9200

data/spec/test_item.rb

@@ -0,0 +1,6 @@
+class TestItem
+  attr_accessor :id
+  attr_accessor :name
+  attr_accessor :timestamp
+  attr_accessor :number
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: elastic_search_framework
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- vaughanbrittonsage
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hash_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A lightweight framework to for working with elastic search.
+email:
+- vaughanbritton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/elastic_search_framework.rb
+- lib/elastic_search_framework/exceptions.rb
+- lib/elastic_search_framework/exceptions/index_error.rb
+- lib/elastic_search_framework/index.rb
+- lib/elastic_search_framework/logger.rb
+- lib/elastic_search_framework/query.rb
+- lib/elastic_search_framework/repository.rb
+- lib/elastic_search_framework/version.rb
+- spec/example_index.rb
+- spec/index_spec.rb
+- spec/query_spec.rb
+- spec/repository_spec.rb
+- spec/spec_helper.rb
+- spec/test_item.rb
+homepage: https://github.com/sage/elastic_search_framework
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A lightweight framework to for working with elastic search.
+test_files: []