solr_makr 0.0.1

data/lib/solr_makr.rb

@@ -0,0 +1,42 @@
+require "fileutils"
+require "pathname"
+
+class Pathname
+  alias_method :to_str, :to_s
+end
+
+require "active_support/concern"
+require "active_support/configurable"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/module/delegation"
+require "attr_lazy"
+require "commander"
+require "nokogiri"
+require "typhoeus"
+require "virtus"
+
+require "solr_makr/version"
+require "solr_makr/solr_request"
+require "solr_makr/core_status"
+require "solr_makr/solr_configuration"
+require "solr_makr/core"
+require "solr_makr/commands"
+require "solr_makr/commands/shared"
+require "solr_makr/commands/create_core"
+require "solr_makr/commands/destroy_core"
+require "solr_makr/commands/list_cores"
+require "solr_makr/application"
+
+module SolrMakr
+  class << self
+    TEMPLATE_PATH = Pathname.new(File.dirname(__FILE__)).join('files')
+
+    # @param [String] path
+    # @raise [Errno::ENOENT] if undefined template
+    # @return [String] contents of file
+    def template(path)
+      TEMPLATE_PATH.join(path).read
+    end
+  end
+end

data/lib/solr_makr/application.rb

@@ -0,0 +1,49 @@
+module SolrMakr
+  class Application
+    include Commander::Methods
+
+    NAME = 'solr-makr'
+
+    def run
+      program :name, NAME
+      program :version, SolrMakr::VERSION
+      program :description, 'Create a solr core programmatically'
+      program :help, 'Author', 'Alexa Grey <alexag@hranswerlink.com>'
+      program :help_formatter, Commander::HelpFormatter::TerminalCompact
+
+      default_command :help
+
+      global_option '-d', '--solr-home DIR', 'Path to the solr home directory'
+      global_option '-p', '--solr-port PORT', Integer, 'Port to use to communicate with the solr API'
+      global_option '-V', '--verbose', 'Show verbose output.'
+
+      command :create do |c|
+        c.syntax      = "#{NAME} create NAME"
+
+        c.description = "Create and register a solr core."
+
+        c.when_called Commands::CreateCore, :run!
+      end
+
+      command :list do |c|
+        c.syntax      = "#{NAME} list"
+
+        c.description = "List installed solr cores."
+
+        c.when_called Commands::ListCores, :run!
+      end
+
+      command :destroy do |c|
+        c.syntax      = "#{NAME} destroy NAME"
+
+        c.option '--purge', 'Purge the solr core\'s instance directory'
+
+        c.description = "Unload and remove a solr core."
+
+        c.when_called Commands::DestroyCore, :run!
+      end
+
+      run!
+    end
+  end
+end

data/lib/solr_makr/commands.rb

@@ -0,0 +1,5 @@
+module SolrMakr
+  # @api private
+  module Commands
+  end
+end

data/lib/solr_makr/commands/create_core.rb

@@ -0,0 +1,21 @@
+module SolrMakr
+  module Commands
+    class CreateCore
+      include Shared
+
+      config.acts_on_single_core = true
+
+      def run
+        with_message "initializing configuration" do
+          core.initialize_configuration!
+        end
+
+        with_message "registering new core with solr" do
+          core.register_with_solr!
+        end
+
+        say "Created core: #{core_name}"
+      end
+    end
+  end
+end

data/lib/solr_makr/commands/destroy_core.rb

@@ -0,0 +1,17 @@
+module SolrMakr
+  module Commands
+    class DestroyCore
+      include Shared
+
+      config.acts_on_single_core = true
+
+      def run
+        with_message "registering new core with solr" do
+          core.unload_from_solr!(purge: options.purge)
+        end
+
+        say "Destroyed core: #{core_name}"
+      end
+    end
+  end
+end

data/lib/solr_makr/commands/list_cores.rb

@@ -0,0 +1,17 @@
+module SolrMakr
+  module Commands
+    class ListCores
+      include Shared
+
+      def run
+        say "Listing core(s)."
+
+        cores = solr_config.solr_status
+
+        cores.each do |core|
+          say sprintf(" * %s -- %d document(s) / %s", core.name, core.documents, core.size)
+        end
+      end
+    end
+  end
+end

data/lib/solr_makr/commands/shared.rb

@@ -0,0 +1,82 @@
+module SolrMakr
+  module Commands
+    module Shared
+      extend ActiveSupport::Concern
+
+      included do
+        include ActiveSupport::Configurable
+
+        config.core_name_index = 0
+      end
+
+      delegate :name, allow_nil: true, to: :core, prefix: true
+
+      # @!attribute [r] solr_config
+      # @return [SolrMakr::SolrConfiguration]
+      attr_reader :solr_config
+
+      # @!attribute [r] args
+      # @return [<String>]
+      attr_reader :args
+
+      # @!attribute [r] options
+      # @return [Struct]
+      attr_reader :options
+
+      delegate :home, :port, prefix: :solr, to: :solr_config
+
+      alias_method :port, :solr_port
+
+      # @abstract
+      # @return [void]
+      def run
+        raise NotImplementedError, "Must implement #run"
+      end
+
+      # @return [void]
+      def run!(args, options)
+        @args     = args
+        @options  = options
+
+        options.default shared_options
+
+        solr_config.home = options.solr_home
+        solr_config.port = options.solr_port
+
+        run
+      end
+
+      # @!attribute [r] solr_config
+      # @return [SolrMakr::SolrConfiguration]
+      attr_lazy_reader :solr_config do
+        SolrMakr::SolrConfiguration.new
+      end
+
+      # @!attribute [r] core
+      # @return [SolrMakr::Core]
+      attr_lazy_reader :core do
+        core_name = args[config.core_name_index]
+
+        if core_name.present? || config.acts_on_single_core
+          solr_config.core(name: core_name)
+        end
+      end
+
+      def with_message(message, &block)
+        retval = yield
+
+        if retval != false && options.verbose
+          say message
+        end
+      end
+
+      private
+      def shared_options
+        {
+          solr_home: solr_home,
+          solr_port: solr_port
+        }
+      end
+    end
+  end
+end

data/lib/solr_makr/core.rb

@@ -0,0 +1,92 @@
+module SolrMakr
+  # @api private
+  class CoreName < Virtus::Attribute
+    NAME_FORMAT = /\A[\w\-]+\z/i
+
+    # @param [String] value
+    # @return [String]
+    def coerce(value)
+      value = value.to_s
+
+      raise 'Invalid Core Name' unless value.present?
+      raise 'Invalid Core Name Format' unless value =~ NAME_FORMAT
+
+      return value
+    end
+  end
+
+  class Core
+    include Virtus.model strict: true
+    include SolrRequest
+
+    CONF_PATH   = 'conf'
+
+    CONF_FILES = %w[schema.xml solrconfig.xml]
+
+    attribute :name, CoreName
+    attribute :config, SolrConfiguration
+
+    delegate :core_directory, :port, to: :config
+    delegate :exist?, to: :instance_dir
+
+    # @return [Pathname]
+    def instance_dir
+      core_directory.join name
+    end
+
+    def conf_dir
+      instance_dir.join(CONF_PATH)
+    end
+
+    def initialize_configuration!
+      conf_dir.mkpath
+
+      CONF_FILES.each do |conf_file|
+        path = conf_dir.join(conf_file)
+
+        path.write(SolrMakr.template(conf_file))
+      end
+    end
+
+    # @return [void]
+    def register_with_solr!
+      params = {
+        action:         'CREATE',
+        name:           name,
+        persist:        'true',
+        instanceDir:    instance_dir.to_s,
+        loadOnStartup:  'true',
+        config:         'solrconfig.xml',
+        schema:         'schema.xml'
+      }
+
+      solr_request solr_cores_url, params: params
+    end
+
+    def reload!
+      params = {
+        action: 'RELOAD',
+        core:   name
+      }
+
+      solr_request solr_cores_url, params: params
+    end
+
+    def unload_from_solr!(purge: false)
+      params = {
+        core:           name,
+        action:         'UNLOAD',
+        deleteIndex:    'true',
+        deleteDataDir:  'true'
+      }
+
+      if purge
+        say "Deleting entire instance dir!!!"
+        params[:deleteInstanceDir] = 'true'
+      end
+
+      solr_request solr_cores_url, params: params
+    end
+
+  end
+end

data/lib/solr_makr/core_status.rb

@@ -0,0 +1,56 @@
+module SolrMakr
+  class CoreStatus
+    include Virtus.model strict: true
+
+    attribute :name,          String
+    attribute :start_time,    Time
+    attribute :uptime,        Integer,  default: 0
+    attribute :default_core,  Boolean,  default: false
+    attribute :size,          String,   default: '0 bytes'
+    attribute :size_in_bytes, Integer,  default: 0
+    attribute :documents,     Integer,  default: 0
+
+    class << self
+      LOOKS_TRUE        = /\At(?:rue)?\z/i
+
+      NAME_XML          = 'str[name="name"]'
+      DEFAULT_CORE_XML  = 'bool[name="isDefaultCore"]'
+      SIZE_XML          = 'str[name="size"]'
+      SIZE_IN_BYTES_XML = 'long[name="sizeInBytes"]'
+      START_TIME_XML    = 'date[name="startTime"]'
+      UPTIME_XML        = 'long[name="uptime"]'
+      DOCUMENTS_XML     = 'int[name="numDocs"]'
+
+      # @return [SolrMakr::CoreStatus]
+      def from_xml(node)
+        params = {
+          name:           text_at_css(node, NAME_XML),
+          size:           text_at_css(node, SIZE_XML),
+          size_in_bytes:  text_at_css(node, SIZE_IN_BYTES_XML),
+          documents:      text_at_css(node, DOCUMENTS_XML),
+          uptime:         text_at_css(node, UPTIME_XML)
+        }
+
+        params[:default_core] = text_at_css(node, DEFAULT_CORE_XML) do |res|
+          res.to_s.match(LOOKS_TRUE).present?
+        end
+
+        params[:start_time] = text_at_css(node, START_TIME_XML) do |res|
+          Time.parse res if res.present?
+        end
+
+        new params
+      end
+
+      def text_at_css(node, selector, &block)
+        result = node.at_css(selector).try(:text)
+
+        if block_given?
+          yield result
+        else
+          result
+        end
+      end
+    end
+  end
+end

data/lib/solr_makr/solr_configuration.rb

@@ -0,0 +1,78 @@
+module SolrMakr
+  # @api private
+  class Pathlike < Virtus::Attribute
+    # @param [String / Pathname] value
+    # @return [Pathname]
+    def coerce(value)
+      Pathname.new value
+    end
+  end
+
+  class SolrConfiguration
+    include Virtus.model strict: true
+    include SolrRequest
+
+    DEFAULT_HOME  = '/opt/solr/jetty-solr/'
+    DEFAULT_PORT  = 8983
+
+    attribute :home, Pathlike, default: :default_home
+    attribute :port, Integer, default: :default_port
+
+    def initialize(env = ENV)
+      @_env = env
+
+      super()
+    end
+
+    def env
+      @_env ||= ENV
+    end
+
+    def core(name: nil)
+      Core.new name: name, config: self
+    end
+
+    def cores
+      core_directory.children.each_with_object [] do |path, cores|
+        cores << core(name: path.basename) if looks_like_core_directory?(path)
+      end
+    end
+
+    # @return [String]
+    def core_directory
+      home.join 'solr'
+    end
+
+    # @return [<SolrMakr::CoreStatus>]
+    def solr_status
+      resp = solr_request solr_cores_url, params: { action: 'STATUS' }
+
+      parsed = Nokogiri::XML(resp.body)
+
+      statuses = parsed.at_css('lst[name="status"]').try(:children)
+
+      return [] unless statuses.present?
+
+      statuses.each_with_object [] do |status, list|
+        created = SolrMakr::CoreStatus.from_xml status# rescue nil
+
+        list << created if created.present?
+      end
+    end
+
+    private
+    def looks_like_core_directory?(path)
+      path.join('data').exist?
+    end
+
+    def default_port
+      Integer(env.fetch 'SOLR_PORT', DEFAULT_PORT)
+    rescue ArgumentError
+      DEFAULT_PORT
+    end
+
+    def default_home
+      Pathname.new env.fetch 'SOLR_HOME', DEFAULT_HOME
+    end
+  end
+end