elasticsearch-resources 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "elasticsearch/resources"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/elasticsearch-resources.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elasticsearch/resources/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elasticsearch-resources"
+  spec.version       = Elasticsearch::Resources::VERSION
+  spec.authors       = ["David Elner"]
+  spec.email         = ["david@davidelner.com"]
+
+  spec.summary       = %q{Access well-known Elasticsearch indexes like resources.}
+  spec.description   = %q{Allows you to strongly-type Elasticsearch types and query them more easily.}
+  spec.homepage      = "https://github.com/delner/elasticsearch-resources"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "i18n", "~> 0.7"
+  spec.add_dependency "elasticsearch", "~> 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-collection_matchers", "~> 1.1"
+  spec.add_development_dependency "simplecov", "~> 0.12"
+end

data/lib/elasticsearch/resources.rb

@@ -0,0 +1,35 @@
+# Load library dependencies
+require 'i18n'
+require 'elasticsearch'
+
+# Load classes and modules
+require "elasticsearch/resources/version"
+require 'elasticsearch/resources/configuration'
+
+require 'elasticsearch/resources/configurable'
+require 'elasticsearch/resources/identifiable'
+require 'elasticsearch/resources/describable'
+require 'elasticsearch/resources/nameable'
+require 'elasticsearch/resources/clusterable'
+require 'elasticsearch/resources/indexable'
+require 'elasticsearch/resources/typeable'
+require 'elasticsearch/resources/queryable'
+require 'elasticsearch/resources/document_factory'
+require 'elasticsearch/resources/response_factory'
+
+require 'elasticsearch/resources/resource'
+require 'elasticsearch/resources/document'
+require 'elasticsearch/resources/type'
+require 'elasticsearch/resources/index'
+require 'elasticsearch/resources/cluster'
+
+module Elasticsearch
+  module Resources
+    def self.locales_paths
+      Dir[File.join(File.expand_path('../resources', __FILE__), '**/locales/*.yml')]
+    end
+  end
+end
+
+# Load i18n locales
+I18n.load_path += Elasticsearch::Resources.locales_paths

data/lib/elasticsearch/resources/cluster.rb

@@ -0,0 +1,59 @@
+module Elasticsearch
+  module Resources
+    class Cluster
+      include Resource
+      include Queryable
+      include Configurable
+      include Nameable
+
+      define_configuration class_name: Configuration::Cluster
+
+      def initialize(&block)
+        configure(id: self.class.configuration.id, &block)
+      end
+
+      def setup!
+        client
+        super
+      end
+
+      def client
+        settings.client
+      end
+
+      def indexes
+        []
+      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
+      end
+
+      def find_index(index:)
+        indexes.find do |i|
+          i.find_index(index: index)
+        end
+      end
+
+      def find_type(index:, type:)
+        find_index(index: index)&.find_type(index: index, type: type)
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/clusterable.rb

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

data/lib/elasticsearch/resources/configurable.rb

@@ -0,0 +1,52 @@
+module Elasticsearch
+  module Resources
+    module Configurable
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.include(InstanceMethods)
+      end
+
+      module ClassMethods
+        def configuration
+          @configuration ||= superclass.respond_to?(:configuration) ? superclass.configuration.dup : Configuration.new
+        end
+
+        protected
+
+        def define_configuration(options = {})
+          @configuration = configuration.tap do |c|
+            options.each do |name, value|
+              c.send("#{name.to_s}=", value) if c.respond_to?("#{name.to_s}=") && !value.nil?
+            end
+          end
+        end
+      end
+
+      module InstanceMethods
+        attr_reader :settings
+
+        def default_settings
+          default_expression = self.class.configuration.default
+          default_expression ? self.instance_exec(&default_expression) : nil
+        end
+
+        def configure(options = {}, &block)
+          @settings = default_settings&.dup || self.class.configuration.class_name&.new(**options)
+          settings.tap do |s|
+            yield(s) if block_given?
+          end
+        end
+      end
+
+      class Configuration
+        ATTRIBUTES = [:id, :class_name, :default].freeze
+
+        attr_accessor *ATTRIBUTES
+
+        def ==(obj)
+          ATTRIBUTES.all? { |a| obj.send(a) == self.send(a) }
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/configuration.rb

@@ -0,0 +1,11 @@
+require 'elasticsearch/resources/configuration/type'
+require 'elasticsearch/resources/configuration/index'
+require 'elasticsearch/resources/configuration/cluster'
+require 'elasticsearch/resources/configuration/settings'
+
+module Elasticsearch
+  module Resources
+    module Configuration
+    end
+  end
+end

data/lib/elasticsearch/resources/configuration/cluster.rb

@@ -0,0 +1,67 @@
+module Elasticsearch
+  module Resources
+    module Configuration
+      class Cluster
+        attr_reader :id, :name
+
+        def initialize(id:)
+          @id = id
+        end
+
+        def client
+          @client ||= Elasticsearch::Client.new(host: host)
+        end
+
+        def indexes
+          @indexes ||= default_indexes
+        end
+
+        def index(id)
+          indexes.find { |t| t.id == id.to_sym }.tap do |t|
+            yield(t) if block_given?
+          end
+        end
+
+        def name=(name)
+          raise NullNameError.new if name.nil?
+          @name = name.to_s
+        end
+
+        def host
+          @host ||= '127.0.0.1:9200'
+        end
+
+        def host=(host)
+          raise NullHostError.new if host.nil?
+          @host = host
+        end
+
+        class NullNameError < ArgumentError
+          def initialize
+            super(message)
+          end
+
+          def message
+            I18n.t('elasticsearch.resources.configuration.cluster.null_name_error.message')
+          end
+        end
+
+        class NullHostError < ArgumentError
+          def initialize
+            super(message)
+          end
+
+          def message
+            I18n.t('elasticsearch.resources.configuration.cluster.null_host_error.message')
+          end
+        end
+
+        protected
+
+        def default_indexes
+          []
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/configuration/index.rb

@@ -0,0 +1,45 @@
+module Elasticsearch
+  module Resources
+    module Configuration
+      class Index
+        attr_reader :id, :name, :cluster
+
+        def initialize(id:, cluster:)
+          @id = id
+          @cluster = cluster
+        end
+
+        def types
+          @types ||= default_types
+        end
+
+        def type(id)
+          types.find { |t| t.id == id.to_sym }.tap do |t|
+            yield(t) if block_given? && !t.nil?
+          end
+        end
+
+        def name=(name)
+          raise NullNameError.new if name.nil?
+          @name = name.to_s
+        end
+
+        class NullNameError < ArgumentError
+          def initialize
+            super(message)
+          end
+
+          def message
+            I18n.t('elasticsearch.resources.configuration.index.null_name_error.message')
+          end
+        end
+
+        protected
+
+        def default_types
+          []
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/configuration/settings.rb

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module Resources
+    module Configuration
+      class Settings
+        def clusters
+          @clusters ||= default_clusters
+        end
+
+        def cluster(id)
+          clusters.find { |t| t.id == id.to_sym }.tap do |t|
+            yield(t) if block_given?
+          end
+        end
+
+        protected
+
+        def default_clusters
+          [
+            Elasticsearch::Resources::Configuration::Cluster.new(id: :default)
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/configuration/type.rb

@@ -0,0 +1,29 @@
+module Elasticsearch
+  module Resources
+    module Configuration
+      class Type
+        attr_reader :id, :name, :index
+
+        def initialize(id:, index:)
+          @id = id
+          @index = index
+        end
+
+        def name=(name)
+          raise NullNameError.new if name.nil?
+          @name = name.to_s
+        end
+
+        class NullNameError < ArgumentError
+          def initialize
+            super(message)
+          end
+
+          def message
+            I18n.t('elasticsearch.resources.configuration.type.null_name_error.message')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/resources/describable.rb

@@ -0,0 +1,49 @@
+module Elasticsearch
+  module Resources
+    module Describable
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.include(InstanceMethods)
+      end
+
+      module ClassMethods
+        def attributes
+          @attributes ||= []
+        end
+
+        protected
+
+        def define_attributes(*attributes)
+          new_attributes = attributes.collect(&:to_sym) - self.attributes.collect(&:to_sym)
+          self.attributes.concat(new_attributes).tap { |a| define_attribute_helpers(new_attributes) }
+        end
+
+        private
+
+        def define_attribute_helpers(attributes)
+          attributes.each do |attribute|
+            self.send(:define_method, "#{attribute}") do
+              self.attributes[attribute.to_s]
+            end
+
+            self.send(:define_method, "#{attribute}=") do |value|
+              self.attributes[attribute.to_s] = value
+            end
+          end
+        end
+      end
+
+      module InstanceMethods
+        def attributes
+          @attributes ||= {}
+        end
+
+        protected
+
+        def attributes=(attributes = {})
+          @attributes = attributes.collect { |k, v| [k.to_s, v] }.to_h
+        end
+      end
+    end
+  end
+end