search-kit 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ee72c3e484109f7d168a4c38def107a4aba6405
-  data.tar.gz: 6c5a06d38106c3db998d2998a808ba509d8aed10
+  metadata.gz: 931bd5667f77b68c5150e37a0a4c07495f51574e
+  data.tar.gz: 2bbaf39e5215f1066277e42cc4696cd8fc704b28
 SHA512:
-  metadata.gz: 76ea4042783f93b854d90a053c781f9eb2c80d70d015395be62246b356b560c0ea71dd7b8e2d43741b7602f7c56310950758125cb57f3e4b06bd3cea9d6224e4
-  data.tar.gz: 99f49469151c8977dc9a440cab9ac0ec4ca36d3e9eb9bfcc882761ff59a312ffbb6c9e534231ad323a7415bd943d897348661540ea52e05b50f2eb5816fbb705
+  metadata.gz: 90d6c826b8895c6907e4d13582b52ee1bb8680619ed1e155f4ad0854c0fae5fbc80862d683ed4dda11959f5ff83b5749914aa7a17e33f88dadc5ce8c55aed46f
+  data.tar.gz: 1e42b9b321acfb838218a63f0a3f68d0eb344f905e72c764caf905b8fd2af165034a4af2856da1800818d1c266ab23b263fe39ec09c55a81d13c640397151c72

data/.gitignore

@@ -6,6 +6,7 @@ _yardoc/
 .sass-cache/
 .yardoc
 *.db
+demo/
 coverage/
 Gemfile.lock
 log/

data/config/locales/en.yml

@@ -1,6 +1,115 @@
 en:
   http:
-    400: "Bad request"
+    400: Bad request given
     401:
-      inactive: "Inactive or expired token"
-      privilege: "Inadequate permissions on token"
+      inactive: Inactive or expired token
+      privilege: Inadequate permissions on token
+    404: Unable to find %{type} at the given uri
+    422: Options given unprocessable
+  cli:
+    errors:
+      json_parse: "%{type} must be given in the form of a JSON string."
+      no_server: No running SearchKit service found at %{uri}.
+      unreadable: "Response unreadable: %{error}"
+    documents:
+      update:
+        command: update SLUG ID DOCUMENT
+        summary: Update a document with a json string
+        detail: |
+          Updating a document usage and purpose
+      delete:
+        command: delete SLUG ID
+        summary: Delete a document
+        detail: |
+          Deleting a document usage and purpose
+      create:
+        command: create SLUG DOCUMENT
+        summary: Create a document with a json string
+        detail: |
+          Creating a document usage and purpose
+      show:
+        command: show SLUG ID
+        summary: View a document
+        detail: |
+          # View a document (detail)
+
+          I like to pretend this is in markdown, or can be done in markdown. But is it really necessary?
+
+          1. I have no idea.
+
+          2. Who knows.
+    events:
+      complete:
+        command: complete ID
+        summary: Complete event for a given ID
+        detail: |
+          Detail about event completion
+        success: Event %{id} completed
+      pending:
+        command: pending
+        summary: Get all pending events, --channel to filter by channel
+        detail: |
+          Get all pending events, --channel to filter by channel
+        success:
+          index:
+            discovered: "Pending events:"
+            empty: No pending events found
+          filtered:
+            discovered: "Pending events for channel `%{channel}`:"
+            empty: No pending events found for channel `%{channel}`
+      publish:
+        command: publish CHANNEL PAYLOAD
+        summary: Publish an event payload (as a json string) to CHANNEL
+        detail: |
+          Publish an event payload (as a json string) to CHANNEL
+        success: |
+          Event published, check status with this command:
+
+          search-kit events status %{id}
+
+          Or look at use this command to to see this event and all neighboring events:
+
+          search-kit events pending %{channel}
+      status:
+        command: status ID
+        summary: Check status of a specific event ID
+        detail: |
+          Check status of a specific event ID
+        success: "Event %{id} status: %{status}"
+    indices:
+      archive:
+        command: archive SLUG
+        summary: Archive an index
+        detail: |
+          Archive an index
+      create:
+        command: create NAME
+        summary: Create an index
+        detail: |
+          Create an index
+      scaffold:
+        command: scaffold NAME JSON
+        summary: Create an index and populate it with a list of documents
+        detail: |
+          Create an index and populate it with a list of documents
+      show:
+        command: show SLUG
+        summary: View an index
+        detail: |
+          View an index
+      update:
+        command: update SLUG
+        summary: Update an index
+        detail: |
+          In depth detail about index updating
+    search:
+      create:
+        command: search SLUG PHRASE
+        summary: Search an index
+        detail: |
+          Search an index
+        success:
+          headline: |
+            "Searching `%{slug}` for titles matching `%{phrase}`:"
+          info: |
+            " - Found %{search.results} titles in %{search.time}ms"

data/lib/search_kit.rb

@@ -1,18 +1,17 @@
 require 'bundler/setup'
 require 'i18n'
 require "search_kit/version"
+require "search_kit/thor"
 
 module SearchKit
   autoload :CLI,           'search_kit/cli'
-  autoload :Client,        'search_kit/client'
+  autoload :Clients,       'search_kit/clients'
   autoload :Configuration, 'search_kit/configuration'
-  autoload :Documents,     'search_kit/documents'
   autoload :Errors,        'search_kit/errors'
-  autoload :Events,        'search_kit/events'
-  autoload :Indices,       'search_kit/indices'
   autoload :Logger,        'search_kit/logger'
-  autoload :Messaging,     'search_kit/messaging'
-  autoload :Search,        'search_kit/search'
+  autoload :Messages,      'search_kit/messages'
+  autoload :Models,        'search_kit/models'
+  autoload :Polling,       'search_kit/polling'
 
   def self.logger
     @logger ||= Logger.new

data/lib/search_kit/cli.rb

@@ -1,33 +1,68 @@
+require 'ansi'
+require 'highline'
 require 'thor'
+require 'search_kit/thor'
 
 module SearchKit
   class CLI < Thor
-    include Messaging
+    autoload :Documents,   'search_kit/cli/documents'
+    autoload :Events,      'search_kit/cli/events'
+    autoload :Indices,     'search_kit/cli/indices'
+    autoload :Search,      'search_kit/cli/search'
+    autoload :Subscribers, 'search_kit/cli/subscribers'
+
+    no_commands do
+      def cli
+        @cli ||= HighLine.new
+      end
+
+      def messages
+        @messages ||= Messages.new
+      end
+    end
 
     desc "documents", "Manage individual SearchKit documents"
-    subcommand "documents", SearchKit::Documents::CLI
+    subcommand "documents", SearchKit::CLI::Documents
 
     desc "events", "Publish and subscribe to SearchKit events"
-    subcommand "events", SearchKit::Events::CLI
+    subcommand "events", SearchKit::CLI::Events
 
     desc "indices", "Manage your SearchKit indices"
-    subcommand "indices", SearchKit::Indices::CLI
+    subcommand "indices", SearchKit::CLI::Indices
 
     desc "search", "Quickly search your indices"
-    subcommand "search", SearchKit::Search::CLI
+    subcommand "search", SearchKit::CLI::Search
+
+    desc "subscribers", "Register and control a subscriber account"
+    subcommand "subscribers", SearchKit::CLI::Subscribers
 
     desc "config SETTING [VALUE]", "Configure or view your SearchKit settings"
     def config(setting, value = nil)
       if value
         SearchKit.set_config(setting, value)
-        info "Set #{setting}: #{value}"
+        messages.info "Set #{setting}: #{value}"
       else
         value = SearchKit.show_config(setting)
-        info "SearchKit settings for #{setting}:"
-        info " - ~/.search-kit/config.yml: #{value}"
-        info " - ENV: #{ENV.fetch(setting.upcase, "Not set")}"
-        info " - Runtime: #{SearchKit.config.send(setting)}"
+        messages.info "SearchKit settings for #{setting}:"
+        messages.info " - ~/.search-kit/config.yml: #{value}"
+        messages.info " - ENV: #{ENV.fetch(setting.upcase, "Not set")}"
+        messages.info " - Runtime: #{SearchKit.config.send(setting)}"
       end
     end
+
+    desc "setup", "Set up your search-kit environment"
+    def setup
+      email    = cli.ask("Email: ".ansi(:cyan))
+      password = cli.ask("Password: ".ansi(:cyan)) do |query|
+        query.echo = '*'
+      end
+
+      client     = SearchKit::Clients::Subscribers.new
+      subscriber = client.create(email: email, password: password)
+
+      config("app_token", subscriber.creator_tokens.first)
+      messages.info("Alright!  Your search-kit install has been set up.")
+    end
+
   end
 end

data/lib/search_kit/cli/documents.rb

@@ -0,0 +1,75 @@
+require 'thor'
+require 'search_kit/thor'
+
+module SearchKit
+  class CLI < Thor
+    class Documents < Thor
+      namespace :documents
+
+      no_commands do
+        def client
+          @client ||= SearchKit::Clients::Documents.new
+        end
+
+        def messages
+          @messages ||= SearchKit::Messages.new
+        end
+      end
+
+      document :create
+      def create(slug, document)
+        document = JSON.parse(document, symbolize_names: true)
+        response = client.create(slug, document)
+        messages.info response.to_json
+      rescue Errors::IndexNotFound
+        messages.not_found
+      rescue Errors::BadRequest
+        messages.bad_request
+      rescue Errors::Unprocessable
+        messages.unprocessable
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      rescue JSON::ParserError
+        messages.json_parse_error
+      end
+
+      document :delete
+      def delete(slug, id)
+        response = client.delete(slug, id)
+        messages.info response.to_json
+      rescue Errors::IndexNotFound
+        messages.not_found
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      end
+
+      document :show
+      def show(slug, id)
+        response = client.show(slug, id)
+        messages.info response.to_json
+      rescue Errors::IndexNotFound
+        messages.not_found
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      end
+
+      document :update
+      def update(slug, id, document)
+        document = JSON.parse(document, symbolize_names: true)
+        response = client.update(slug, id, document)
+        messages.info response.to_json
+      rescue JSON::ParserError
+        messages.json_parse_error
+      rescue Errors::BadRequest
+        messages.bad_request
+      rescue Errors::IndexNotFound
+        messages.not_found
+      rescue Errors::Unprocessable
+        messages.unprocessable
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      end
+
+    end
+  end
+end

data/lib/search_kit/cli/events.rb

@@ -0,0 +1,88 @@
+require 'thor'
+require 'search_kit/thor'
+
+module SearchKit
+  class CLI < Thor
+    class Events < Thor
+      namespace :events
+
+      no_commands do
+        def client
+          @client ||= SearchKit::Clients::Events.new
+        end
+
+        def messages
+          @messages ||= SearchKit::Messages.new
+        end
+      end
+
+      document :complete
+      def complete(id)
+        client.complete(id)
+        messages.info I18n.t('cli.events.complete.success', id: id)
+      rescue Errors::EventNotFound
+        messages.not_found
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      end
+
+      document :pending
+      def pending(channel = nil)
+        events = channel ? client.pending(channel) : client.index
+
+        message_path = %w(cli events pending success)
+        message_path << (channel ? 'filtered' : 'index')
+        message_path << (events.any? ? 'discovered' : 'empty')
+        message = I18n.t(message_path.join('.'), channel: channel)
+
+        messages.info(message)
+        events.each { |event| messages.info(event.to_json) }
+      rescue Errors::BadRequest
+        messages.bad_request
+      rescue Errors::Unauthorized
+        messages.unauthorized
+      rescue Errors::Unprocessable
+        messages.unprocessable
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      end
+
+      document :publish
+      def publish(channel, payload)
+        payload = JSON.parse(payload, symbolize_names: true)
+        event   = client.publish(channel, payload)
+
+        message = I18n.t('cli.events.publish.success',
+          channel: channel,
+          id:      event.id
+        )
+
+        messages.info(message)
+      rescue Errors::BadRequest
+        messages.bad_request
+      rescue Errors::Unauthorized
+        messages.unauthorized
+      rescue Errors::Unprocessable
+        messages.unprocessable
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      rescue JSON::ParserError
+        messages.json_parse_error
+      end
+
+      document :status
+      def status(id)
+        event  = client.show(id)
+        status = event.state
+
+        message = I18n.t('cli.events.status.success', id: id, status: status)
+        messages.info(message)
+      rescue Errors::EventNotFound
+        messages.not_found
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      end
+
+    end
+  end
+end

data/lib/search_kit/cli/indices.rb

@@ -0,0 +1,96 @@
+require 'thor'
+require 'search_kit/thor'
+
+module SearchKit
+  class CLI < Thor
+    class Indices < Thor
+      namespace :indices
+
+      no_commands do
+        def client
+          @client ||= SearchKit::Clients::Indices.new
+        end
+
+        def messages
+          @messages ||= Messages.new
+        end
+      end
+
+      document :archive
+      def archive(slug)
+        response = client.archive(slug)
+        messages.info response.to_json
+      rescue Errors::Unauthorized
+        messages.unauthorized
+      rescue Errors::IndexNotFound
+        messages.not_found
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      end
+
+      document :create
+      def create(name)
+        response = client.create(name)
+        messages.info response.to_json
+      rescue Errors::Unauthorized
+        messages.unauthorized
+      rescue Errors::BadRequest
+        messages.bad_request
+      rescue Errors::Unprocessable
+        messages.unprocessable
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      end
+
+      document :scaffold
+      def scaffold(name, json = "[]")
+        documents = JSON.parse(json, symbolize_names: true)
+        response  = client.scaffold(name, documents)
+
+        messages.info response.to_json
+      rescue Errors::Unauthorized
+        messages.unauthorized
+      rescue Errors::BadRequest
+        messages.bad_request
+      rescue Errors::Unprocessable
+        messages.unprocessable
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      rescue JSON::ParserError
+        messages.json_parse_error
+      end
+
+      document :show
+      def show(slug)
+        response = client.show(slug)
+        messages.info response.to_json
+      rescue Errors::Unauthorized
+        messages.unauthorized
+      rescue Errors::IndexNotFound
+        messages.not_found
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      end
+
+      document :update
+      def update(slug, update_json)
+        options  = JSON.parse(update_json, symbolize_names: true)
+        response = client.update(slug, options)
+        messages.info response.to_json
+      rescue Errors::Unauthorized
+        messages.unauthorized
+      rescue Errors::BadRequest
+        messages.bad_request
+      rescue Errors::IndexNotFound
+        messages.not_found
+      rescue Errors::Unprocessable
+        messages.unprocessable
+      rescue Faraday::ConnectionFailed
+        messages.no_service
+      rescue JSON::ParserError
+        messages.json_parse_error
+      end
+
+    end
+  end
+end