elasticsearch-resources 0.1.0

data/lib/elasticsearch/resources/document.rb

@@ -0,0 +1,73 @@
+module Elasticsearch
+  module Resources
+    class Document
+      include Resource
+      include Queryable
+      include Typeable
+      include Identifiable
+      include Describable
+
+      def initialize(id:, attributes: {}, type:)
+        self.type = type
+        self.id = id
+        self.attributes = attributes
+      end
+
+      def cluster
+        index.cluster
+      end
+
+      def index
+        type.index
+      end
+
+      def client
+        type.client
+      end
+
+      def query(action, options = {})
+        params = {
+          index: index.name,
+          type: type.name,
+          id: id
+        }.merge(options)
+
+        super(action, **params)
+      end
+
+      def create(options = {})
+        params = {
+          body: attributes
+        }.merge(options)
+
+        query(:create, params)
+      end
+
+      def update(options = {})
+        params = {
+          body: attributes
+        }.merge(options)
+
+        query(:update, params)
+      end
+
+      [:exists?, :delete, :get].each do |action|
+        define_method action do |options = {}|
+          query(action, options)
+        end
+      end
+
+      def find_cluster
+        self.cluster
+      end
+
+      def find_index(index: nil)
+        self.index
+      end
+
+      def find_type(index: nil, type: nil)
+        self.type
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/document_factory.rb

@@ -0,0 +1,49 @@
+module Elasticsearch
+  module Resources
+    class DocumentFactory
+      attr_reader :content, :resources
+
+      def initialize(content:, resources: {})
+        @content = content
+        @resources = resources
+      end
+
+      def build
+        type = get_type
+        type.document_class.new(
+          type: type,
+          id: content['_id'],
+          attributes: content['_source']
+        )
+      end
+
+      def get_type
+        resources[:type] || build_type
+      end
+
+      def build_type
+        Elasticsearch::Resources::Type.new(index: get_index) do |type|
+          type.name = content['_type']
+        end
+      end
+
+      def get_index
+        resources[:index] || build_index
+      end
+
+      def build_index
+        Elasticsearch::Resources::Index.new(cluster: get_cluster) do |index|
+          index.name = content['_index']
+        end
+      end
+
+      def get_cluster
+        resources[:cluster] || build_cluster
+      end
+
+      def build_cluster
+        Elasticsearch::Resources::Cluster.new
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/identifiable.rb

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module Resources
+    module Identifiable
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.include(InstanceMethods)
+      end
+
+      module ClassMethods
+      end
+
+      module InstanceMethods
+        attr_reader :id
+
+        protected
+
+        def id=(id)
+          raise NullIdError.new if id.nil?
+          @id = id.to_s
+        end
+      end
+
+      class NullIdError < ArgumentError
+        def initialize
+          super(message)
+        end
+
+        def message
+          I18n.t('elasticsearch.resources.identifiable.null_id_error.message')
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/index.rb

@@ -0,0 +1,108 @@
+module Elasticsearch
+  module Resources
+    class Index
+      include Resource
+      include Queryable
+      include Configurable
+      include Clusterable
+      include Nameable
+
+      define_configuration \
+        class_name: Configuration::Index,
+        default: -> { cluster.settings.index(self.class.configuration.id) }
+
+      def initialize(cluster:, &block)
+        self.cluster = cluster
+        configure(id: self.class.configuration.id, cluster: cluster.settings, &block)
+      end
+
+      def setup!
+        unless exists?
+          create
+          super
+        end
+      end
+
+      def teardown!
+        if exists?
+          delete
+          super
+        end
+      end
+
+      def client
+        cluster.client
+      end
+
+      def name
+        settings.name || super
+      end
+
+      def types
+        []
+      end
+
+      def query_index(action, options = {})
+        params = {
+          index: name
+        }.merge(options)
+
+        client.indices.send(action, **params)
+      end
+
+      def query(action, options = {})
+        params = {
+          index: name
+        }.merge(options)
+
+        super(action, **params)
+      end
+
+      def exists?
+        query_index(:exists?)
+      end
+
+      def create
+        query_index(:create)
+      end
+
+      def put_mapping(options = {})
+        query_index(:put_mapping, options)
+      end
+
+      def delete
+        query_index(:delete)
+      end
+
+      def search(body, options = {})
+        params = {
+          body: body
+        }.merge(options)
+
+        query(:search, params)
+      end
+
+      def count(body, options = {})
+        params = {
+          body: body
+        }.merge(options)
+
+        query(:count, params)
+      end
+
+      def find_cluster
+        self.cluster
+      end
+
+      def find_index(index: nil)
+        matches_name?(index) ? self : nil
+      end
+
+      def find_type(index: nil, type:)
+        types.find do |t|
+          t.find_type(type: type)
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/indexable.rb

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module Resources
+    module Indexable
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.include(InstanceMethods)
+      end
+
+      module ClassMethods
+      end
+
+      module InstanceMethods
+        attr_reader :index
+
+        protected
+
+        def index=(index)
+          raise NullIndexError.new if index.nil?
+          @index = index
+        end
+      end
+
+      class NullIndexError < ArgumentError
+        def initialize
+          super(message)
+        end
+
+        def message
+          I18n.t('elasticsearch.resources.indexable.null_index_error.message')
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/locales/en.yml

@@ -0,0 +1,29 @@
+en:
+  elasticsearch:
+    resources:
+      configuration:
+        cluster:
+          null_name_error:
+            message: 'Cluster cannot be assigned a nil name!'
+          null_host_error:
+            message: 'Cluster cannot be assigned a nil host!'
+        index:
+          null_name_error:
+            message: 'Index cannot be assigned a nil name!'
+        type:
+          null_name_error:
+            message: 'Type cannot be assigned a nil name!'
+      identifiable:
+        null_id_error:
+          message: "ID cannot be assigned a nil value!"
+      indexable:
+        null_index_error:
+          message: "Index cannot be nil!"
+      queryable:
+        client:
+          not_implemented_error: 'This resource does not implement #client.'
+        null_client_error:
+          message: "No client set. Cannot query!"
+      typeable:
+        null_type_error:
+          message: "Type cannot be nil!"

data/lib/elasticsearch/resources/nameable.rb

@@ -0,0 +1,28 @@
+module Elasticsearch
+  module Resources
+    module Nameable
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.include(InstanceMethods)
+      end
+
+      module ClassMethods
+        attr_reader :default_name
+
+        def define_default_name(name)
+          @default_name = name&.to_s
+        end
+      end
+
+      module InstanceMethods
+        def name
+          self.class.default_name
+        end
+
+        def matches_name?(name)
+          name.to_s == self.name.to_s
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/queryable.rb

@@ -0,0 +1,36 @@
+module Elasticsearch
+  module Resources
+    module Queryable
+      def self.included(base)
+        base.include(Resource)
+        base.extend(ClassMethods)
+        base.include(InstanceMethods)
+      end
+
+      module ClassMethods
+      end
+
+      module InstanceMethods
+        def client
+          raise NotImplementedError.new(I18n.t('elasticsearch.resources.queryable.client.not_implemented_error'))
+        end
+
+        def query(action, params = {})
+          raise NullClientError.new if client.nil?
+          response = client.send(action, **params)
+          ResponseFactory.new(resource: self, action: action, response: response).build
+        end
+      end
+
+      class NullClientError < ArgumentError
+        def initialize
+          super(message)
+        end
+
+        def message
+          I18n.t('elasticsearch.resources.queryable.null_client_error.message')
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/resource.rb

@@ -0,0 +1,39 @@
+module Elasticsearch
+  module Resources
+    module Resource
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.include(InstanceMethods)
+      end
+
+      module ClassMethods
+      end
+
+      module InstanceMethods
+        def find_cluster
+          nil
+        end
+
+        def find_index(index: nil)
+          nil
+        end
+
+        def find_type(index: nil, type: nil)
+          nil
+        end
+
+        def setup!
+          nil
+        end
+
+        def populate!
+          nil
+        end
+
+        def teardown!
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/response_factory.rb

@@ -0,0 +1,49 @@
+module Elasticsearch
+  module Resources
+    class ResponseFactory
+      attr_reader :resource, :action, :response
+
+      def initialize(resource:, action:, response:)
+        @resource = resource
+        @action = action
+        @response = response
+      end
+
+      def build
+        case action
+        when :get
+          build_get
+        when :search
+          build_search
+        else
+          response
+        end
+      end
+
+      def build_get
+        DocumentFactory.new(
+          content: response,
+          resources: resources_for(response)
+        ).build
+      end
+
+      def build_search
+        raw_documents = response['hits']['hits']
+        raw_documents.collect do |raw_document|
+          DocumentFactory.new(
+            content: raw_document,
+            resources: resources_for(raw_document)
+          ).build
+        end
+      end
+
+      def resources_for(content)
+        {
+          cluster: resource.find_cluster,
+          index: resource.find_index(index: content['_index']),
+          type: resource.find_type(index: content['_index'], type: content['_type'])
+        }
+      end
+    end
+  end
+end