search-kit 0.0.1

data/lib/search_kit/logger.rb

@@ -0,0 +1,31 @@
+require 'forwardable'
+
+module SearchKit
+  # The SearchKit logger, handled in its own class mainly for the purpose
+  # of allowing the daemonized process to quickly and cleanly reinitialize its
+  # connection to logfiles even after its process has been decoupled.
+  #
+  class Logger
+    extend Forwardable
+
+    attr_reader :logger
+
+    def_delegators :logger, :info, :warn
+
+    def initialize
+      environment = SearchKit.config.app_env
+
+      loginfo = [
+        SearchKit.config.app_dir,
+        SearchKit.config.log_dir,
+        "service-layer-#{environment}.log"
+      ]
+
+      logpath = File.join(*loginfo)
+      default = ::Logger.new(logpath, "daily")
+
+      @logger = SearchKit.config.logger || default
+    end
+  end
+
+end

data/lib/search_kit/messaging.rb

@@ -0,0 +1,44 @@
+require 'ansi'
+
+module SearchKit
+  # The goal of the Messaging module is to provide an easy to include internal
+  # interface which will allow a SearchKit gem to dutifully log and provide
+  # output of what it's up to and how it may be doing.
+  #
+  module Messaging
+    def info(message)
+      Message.new(message).info
+    end
+
+    def warning(message)
+      Message.new(message).warn
+    end
+
+    private
+
+    # Most of the logic for the Messaging module exists in this (not so)
+    # private class.  This lets more complex handling of message logic enter
+    # into the module gracefully, for example silence or logging level.
+    #
+    class Message
+      attr_reader :env, :feedback, :message
+
+      def initialize(message)
+        @env      = SearchKit.config.app_env.to_s.ansi(:magenta)
+        @feedback = SearchKit.config.verbose
+        @message  = message
+      end
+
+      def warn
+        Kernel.warn("--> [ #{env} ]: #{message.ansi(:red)}") if feedback
+        SearchKit.logger.warn message
+      end
+
+      def info
+        Kernel.puts("--> [ #{env} ]: #{message.ansi(:cyan)}") if feedback
+        SearchKit.logger.info message
+      end
+    end
+
+  end
+end

data/lib/search_kit/search.rb

@@ -0,0 +1,29 @@
+require 'faraday'
+require 'json'
+require 'uri'
+
+module SearchKit
+  class Search
+    autoload :CLI, 'search_kit/search/cli'
+
+    attr_reader :connection
+
+    def initialize
+      @connection ||= SearchKit::Client.connection
+    end
+
+    def search(slug, options)
+      params   = { data: { type: "searches", attributes: options } }
+      response = connection.post(slug, params)
+
+      body = JSON.parse(response.body, symbolize_names: true)
+
+      fail Errors::BadRequest    if response.status == 400
+      fail Errors::IndexNotFound if response.status == 404
+      fail Errors::Unprocessable if response.status == 422
+
+      body
+    end
+
+  end
+end

data/lib/search_kit/search/cli.rb

@@ -0,0 +1,49 @@
+require 'thor'
+
+module SearchKit
+  class Search
+    class CLI < Thor
+      autoload :Actions, 'search_kit/search/cli/actions'
+
+      include Messaging
+
+      namespace :search
+
+      desc "search SLUG PHRASE", "Search an index".ansi(:cyan, :bold)
+      option :filters, aliases: ['-f'], type: :hash, required: false
+      option :display, aliases: ['-d'], type: :array, required: false
+      def search(slug, phrase)
+        search = Actions::Search.perform(
+          client: client,
+          phrase: phrase,
+          slug:   slug
+        )
+
+        info "Searching `#{slug}` for titles matching `#{phrase}`:"
+        info " - Found #{search.results} titles in #{search.time}ms"
+
+        display = options.fetch('display', [])
+
+        search.documents.each do |document|
+          if display.any?
+            fields = display.map { |field| document.get(field) }
+            info " -- #{fields.join(' | ')} | score: #{document.score}"
+          else
+            info " -- #{document.id} | score: #{document.score}"
+          end
+        end
+      end
+
+      no_commands do
+        alias_method :s, :search
+      end
+
+      private
+
+      def client
+        @client ||= Client.new
+      end
+
+    end
+  end
+end

data/lib/search_kit/search/cli/actions.rb

@@ -0,0 +1,104 @@
+require 'thor'
+
+module SearchKit
+  class Search
+    class CLI < Thor
+      module Actions
+        class Search
+          def self.perform(options = {})
+            new(options).perform
+          end
+
+          include Messaging
+
+          attr_reader :client, :slug, :phrase
+
+          def initialize(options = {})
+            @client = options.fetch(:client)
+            @slug   = options.fetch(:slug)
+            @phrase = options.fetch(:phrase, nil)
+          end
+
+          def perform
+            SearchResult.new(search_response)
+          rescue Errors::IndexNotFound
+            warning "No resource for `#{slug}` found"
+          rescue Errors::BadRequest
+            warning "Some request parameters were not supplied"
+          rescue Errors::Unprocessable
+            warning "Search request unprocessable"
+          rescue Faraday::ConnectionFailed
+            warning "No running service found"
+          end
+
+          private
+
+          def search_response
+            client.search(slug, phrase: phrase)
+          end
+
+          class SearchResult
+            attr_reader :attributes
+
+            def initialize(response)
+              @attributes = response.fetch(:data, {}).fetch(:attributes, {})
+            end
+
+            def documents
+              list = attributes.fetch(:documents, [])
+              Documents.new(list)
+            end
+
+            def time
+              attributes.fetch(:time)
+            end
+
+            def results
+              attributes.fetch(:results)
+            end
+
+            class Documents
+              class Document
+                class AttributeNotFound < StandardError; end
+
+                attr_reader :attributes
+
+                def initialize(document_data)
+                  @attributes = document_data.fetch(:attributes, {})
+                end
+
+                def id
+                  get(:id)
+                end
+
+                def get(field)
+                  attributes.fetch(field.to_sym)
+                rescue KeyError
+                  fail AttributeNotFound, field
+                end
+
+                def score
+                  get(:score)
+                end
+              end
+
+              include Enumerable
+
+              attr_reader :contents
+
+              def initialize(raw_list = [])
+                @contents = raw_list.map { |item| Document.new(item) }
+              end
+
+              def each(&block)
+                contents.each(&block)
+              end
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/search_kit/version.rb

@@ -0,0 +1,20 @@
+module SearchKit
+  def self.gem_version
+    Gem::Version.new(version_string)
+  end
+
+  def self.version_string
+    VERSION::STRING
+  end
+
+  # A convenience measure for easy and quick-to-read version changes and lookup.
+  #
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+    PRE   = nil
+
+    STRING = [ MAJOR, MINOR, TINY, PRE ].compact.join(".")
+  end
+end

data/scripts/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "search_kit"
+require "pry"
+
+Pry.start

data/search-kit.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'search_kit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "search-kit"
+  spec.version       = SearchKit.version_string
+  spec.authors       = ["Joseph McCormick"]
+  spec.email         = ["esmevane@gmail.com"]
+
+  spec.summary       = %q{Client gem for search kit}
+  spec.description   = %q{Build simple and powerful search quickly}
+  spec.homepage      = "https://github.com/qbox-io/search-kit"
+  spec.license       = "MIT"
+
+  spec.bindir        = "bin"
+  spec.require_paths = ["lib"]
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |file|
+    file.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = spec.files.grep(%r{^bin/}) do |file|
+    File.basename(file)
+  end
+
+  spec.add_dependency "ansi", "~> 1.5"
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "i18n", "~> 0.7"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "rack-test", "~> 0.6"
+  spec.add_development_dependency "simplecov", "~> 0.10"
+  spec.add_development_dependency "ruby-prof", "~> 0.15"
+
+end

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification
+name: search-kit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joseph McCormick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: Build simple and powerful search quickly
+email:
+- esmevane@gmail.com
+executables:
+- search-kit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/search-kit
+- config/locales/en.yml
+- lib/search_kit.rb
+- lib/search_kit/cli.rb
+- lib/search_kit/client.rb
+- lib/search_kit/configuration.rb
+- lib/search_kit/documents.rb
+- lib/search_kit/documents/cli.rb
+- lib/search_kit/errors.rb
+- lib/search_kit/events.rb
+- lib/search_kit/events/cli.rb
+- lib/search_kit/events/cli/complete.rb
+- lib/search_kit/events/cli/list.rb
+- lib/search_kit/events/cli/pending.rb
+- lib/search_kit/events/cli/publish.rb
+- lib/search_kit/events/cli/status.rb
+- lib/search_kit/events/publish.rb
+- lib/search_kit/indices.rb
+- lib/search_kit/indices/cli.rb
+- lib/search_kit/logger.rb
+- lib/search_kit/messaging.rb
+- lib/search_kit/search.rb
+- lib/search_kit/search/cli.rb
+- lib/search_kit/search/cli/actions.rb
+- lib/search_kit/version.rb
+- scripts/console
+- search-kit.gemspec
+homepage: https://github.com/qbox-io/search-kit
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Client gem for search kit
+test_files: []