search-kit 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15db1362c1d79c7ec4580c019952b4292f53977e
-  data.tar.gz: 56008480e65b1da0791b2ff4f7611c337bc228fd
+  metadata.gz: 1e88f01855db98a5cfca7a2495d41db74a5e1c41
+  data.tar.gz: 36fbbf38dfdc51d4b678c84655fb871df6938cba
 SHA512:
-  metadata.gz: 93e1eef4d91c3ce6f4147467b5c97deca380809f9b481195a538415fdf503c9a13292ba53f2a46df618922e91d17806bf558cf0f6b1c7e7f1e967758e5d55b7e
-  data.tar.gz: f030af5547d2120e5fc9091cb6881d5e452ab476dc237028462daf88b9dd286e411c3cf12d9ccfe328a6288c15cca1f57a94b89fc841eb824f543077e4bf3c2c
+  metadata.gz: f16ab3ea6602464d5f5e190004b6eb2fabd662f2bca19000e64ce51f4e734d9d422c0eaa3052fc5471d51e14902b294dae0d5680bb44d22d9f0d12d0f38aa10b
+  data.tar.gz: 75654d3e93280299cf3261b8cec6358815173bb0d0fc0864f520ac7df6787ff75406b97c8d1ac8c3b43fd23c5240088094550e81c8274389029388615150c418

data/README.md

@@ -4,18 +4,168 @@ Welcome to your new gem! In this directory, you'll find the files you need to be
 
 ## Installation
 
-* Notes about pulling, renaming, and spots to rename.
+You can start by [installing the ruby CLI tools](https://github.com/qbox-io/search-kit), which requires Ruby 2.0 or later:
 
-## Usage
+    gem install search-kit
 
-* Details about configuration and ENV variables.
-  * APP_ENV / app_env
-  * APP_DIR / app_dir
-  * APP_URI / app_uri
-  * LOG_DIR / log_dir
+Now set it up, by creating a SearchKit account:
 
-## Development
+```
+$ search-kit setup
+--> [ development ]:  Setting up a new SearchKit account
+--> [ development ]:
+--> [ development ]:  Email:
+--> [ development ]:  Password:
+```
+
+Put in a name and password which you'd like to use.  Afterward, your
+kit will be automatically configured with an API key:
+
+```
+--> [ development ]:  Set app_token: <token>
+--> [ development ]:  Alright!  Your search-kit install has been set up.
+```
+
+This gives you a subscriber account for SearchKit, and an access token which can be used to access the API.  This first token is a creator token, which has universal permissions - don't worry, you can make a consumer (read-only) key later if you're concerned about security.
+
+## Getting Started: Search in five minutes
+
+Building an index is your first major step.  Let's assume you have a collection of documents which look a bit like this:
+
+```json
+{
+  "body": "Some lorem ipsum",
+  "id": "document_1",
+  "title": "Blog post"
+}
+```
+### Anatomy and document schema
+
+The `id` field, here, is important.  SearchKit requires the `id` field for all documents, or it will throw a bad request at you.  On the other hand, the `id` isn't necessarily a number - it's stored on our end as a string, and it can be any unique value you can think of.
+
+As far as anatomy goes, a flat, universal representation of what you expect to create is important.  It's easier to understand and navigate through flat JSON than an elaborate nested structure.
+
+Finally, SearchKit has no knowledge of relationships between documents. Because of that, we recommend that you have a clear idea of what you want use you're going to put a particular index to.
+
+### Scaffolding
+
+To quickly create a searchable index using the CLI:
+
+```
+$ search-kit scaffolds create "My Blog Posts" '[{
+  "body": "Some lorem ipsum",
+  "id": "document_1",
+  "title": "Blog post"
+}]'
+```
+
+Here, we're submitting in the form of a raw JSON array - SearchKit will parse the JSON, build an index named "My Blog Posts", and populate it with the given document.
+
+Or, if you just want to use the Ruby client:
+
+```ruby
+documents = [{
+  body:  "Some lorem ipsum",
+  id:    "document_1",
+  title: "Blog post"
+}]
+
+scaffold = SearchKit::Clients::Scaffold.new
+scaffold.create("My Blog Posts", documents)
+```
+
+In most cases, the Ruby client attempts to coerce API responses into [Virtus](https://github.com/solnic/virtus) models, so that you'll have access to some nice ruby [barewords](http://devblog.avdi.org/2012/10/01/barewords/) on your response objects.
+
+### Index identity
+
+If you don't want to create and populate an index in one fell stroke, you can do it programmatically or through the CLI.
+
+#### CLI:
+
+```
+search-kit indices create "My Blog Posts"
+```
+
+#### Ruby
+
+```ruby
+indices = SearchKit::Clients::Indices.new
+indices.create("My Blog Posts")
+```
+
+So you've created an index.  You've given it the name "My Blog Posts".  Now it's out there, linked to your account, accessable by your api token, and it's also been given a distinct uri by turning the name into a `slug`.  A slug is derived from an Index name, and is turned into a uri-friendly string.  It's always given back in the response body of a successful index creation.
+
+In this case, the slug would be `my-blog-posts`.  From here on out, you will pass the slug into SearchKit clients to access that index and its child resources (Documents, Populate, Scaffold, Search).
+
+In other words, to search the index, we want to use its slug:
+
+#### CLI - Searching an index
+
+```
+$ search-kit search create my-blog-posts post
+```
+
+This gives you back a set of results that look a bit like this:
+
+```
+--> [ development ]:  Searching `my-blog-psts` for titles matching `post`:
+--> [ development ]:   - Found 1 titles in 9ms
+--> [ development ]:   -- document_1 | score: 0.8637942
+```
+
+Not too helpful just to get the ID/score back.  Let's get some more information:
+
+```
+$ search-kit search create my-blog-posts post -d title
+--> [ development ]:  Searching `my-blog-psts` for titles matching `post`:
+--> [ development ]:   - Found 1 titles in 9ms
+--> [ development ]:   -- Blog post | score: 0.8637942
+```
+
+Better!
+
+#### Ruby - Searching an index
+
+```ruby
+search = SearchKit::Clients::Search.new
+search.create("my-blog-posts", phrase: "post")
+```
+
+This one is a great deal friendlier, if you know how to script in Ruby, because it returns a helpful Search model with child document models.
+
+## Overview
+
+From there on out, you have a ton of options - whether through the Ruby CLI, the Ruby bindings which power it, or the raw API, itself.
+
+You have individual, atomic document control with the Document client:
+
+```ruby
+# Atomic CRUD on individual documents
+#
+documents = SearchKit::Clients::Documents.new
+documents.create('my-blog-posts', blog_post)
+documents.show('my-blog-posts', blog_post_id)
+documents.update('my-blog-posts', blog_post_id, blog_post)
+documents.delete('my-blog-posts', blog_post)
+```
+
+You have batch control with the Populate client:
+
+```ruby
+# Batch CRUD
+#
+populate = SearchKit::Clients::Populate.new
+populate.create('my-blog-posts', blog_posts)
+populate.update('my-blog-posts', blog_posts)
+populate.delete('my-blog-posts', blog_post_ids)
+```
+
+And so on.  The various domains of the API will be explained in depth soon.
+
+## One last thing
+
+SearchKit is heavily influenced by the [jsonapi spec](http://jsonapi.org).  All response bodies follow this hypermedia representation, contain resource links, and exist in a data namespace.  It isn't 100% compliant yet, but it is _close_, and it does recognize the API format.  So in other words, if you know how to use or design hypermedia clients, you're in luck.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/esmevane/service-layer.
+Bug reports and pull requests are welcome on GitHub at https://github.com/qbox-io/search-kit - please don't hesitate!

data/lib/search_kit/cli/search.rb

@@ -21,7 +21,7 @@ module SearchKit
       document :create
       option :display, aliases: ['-d'], type: :array, required: false
       def create(slug, phrase)
-        search    = client.search(slug, phrase: phrase)
+        search    = client.create(slug, phrase: phrase)
         head_path = 'cli.search.create.success.headline'
         info_path = 'cli.search.create.success.info'
         headline  = I18n.t(head_path, slug: slug, phrase: phrase)

data/lib/search_kit/clients/documents.rb

@@ -12,10 +12,10 @@ module SearchKit
         @token      = SearchKit.config.app_token
       end
 
-      def create(slug, options)
+      def create(slug, document)
         document = {
           token: token,
-          data: { type: "documents", attributes: options }
+          data: { type: "documents", attributes: document }
         }
 
         response = connection.post(slug, document)
@@ -49,10 +49,10 @@ module SearchKit
         body
       end
 
-      def update(slug, id, options)
+      def update(slug, id, document)
         document = {
           token: token,
-          data: { type: "documents", id: id, attributes: options }
+          data: { type: "documents", id: id, attributes: document }
         }
 
         response = connection.patch("#{slug}/#{id}", document)

data/lib/search_kit/clients/search.rb

@@ -12,7 +12,7 @@ module SearchKit
         @token      = SearchKit.config.app_token
       end
 
-      def search(slug, options)
+      def create(slug, options)
         params = {
           token: token, data: { type: "searches", attributes: options }
         }

data/lib/search_kit/models/document.rb

@@ -23,6 +23,16 @@ module SearchKit
         fail AttributeNotFound, field
       end
 
+      def respond_to_missing?(method_name, include_private = false)
+        source.has_key?(method_name) || super(method_name, include_private)
+      end
+
+      def method_missing(method_name, *arguments, &block)
+        get(method_name)
+      rescue AttributeNotFound
+        super(method_name, *arguments, &block)
+      end
+
     end
   end
 end

data/lib/search_kit/version.rb

@@ -12,7 +12,7 @@ module SearchKit
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY  = 7
+    TINY  = 8
     PRE   = nil
 
     STRING = [ MAJOR, MINOR, TINY, PRE ].compact.join(".")

data/search-kit.gemspec

@@ -14,8 +14,9 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/qbox-io/search-kit"
   spec.license       = "MIT"
 
-  spec.files         = Dir.glob('**/*')
-  spec.test_files    = Dir.glob('spec/**/*')
+  spec.files         = %w[search-kit.gemspec]
+  spec.files        += Dir['*.md', 'bin/*', 'lib/**/*.rb']
+  spec.test_files    = Dir['spec/**/*.rb']
   spec.require_paths = ["lib"]
 
   spec.executables   << 'search-kit'

data/spec/search_kit/cli/search_spec.rb

@@ -10,12 +10,12 @@ describe SearchKit::CLI::Search do
   subject { cli }
 
   describe '#create' do
-    before { allow(cli.client).to receive(:search).and_return(response) }
+    before { allow(cli.client).to receive(:create).and_return(response) }
 
     subject { cli.create(slug, phrase) }
 
     it "calls client.search with the slug, and phrase" do
-      expect(cli.client).to receive(:search).with(slug, phrase: phrase)
+      expect(cli.client).to receive(:create).with(slug, phrase: phrase)
       subject
     end
 
@@ -25,7 +25,7 @@ describe SearchKit::CLI::Search do
     end
 
     context 'error handling' do
-      before { allow(cli.client).to receive(:search).and_raise(*error) }
+      before { allow(cli.client).to receive(:create).and_raise(*error) }
 
       context 'unauthorized error' do
         let(:error) { SearchKit::Errors::Unauthorized }

data/spec/search_kit/clients/search_spec.rb

@@ -23,7 +23,7 @@ describe SearchKit::Clients::Search do
     it { is_expected.to be_instance_of Faraday::Connection }
   end
 
-  describe '#search' do
+  describe '#create' do
     let(:filters) { { size: 10.5, width: "Wide", gender: "Mens" } }
     let(:options) { { phrase: phrase, filters: filters } }
     let(:phrase)  { "red boots" }
@@ -36,7 +36,7 @@ describe SearchKit::Clients::Search do
       }
     end
 
-    subject { client.search(slug, options) }
+    subject { client.create(slug, options) }
 
     it { is_expected.to be_instance_of SearchKit::Models::Search }
 

data/spec/search_kit/models/document_spec.rb

@@ -17,11 +17,16 @@ describe SearchKit::Models::Document do
 
     context 'when the source has the available content' do
       let(:content)       { :key_content }
-      let(:document_data) { { attributes: { key => content } } }
+      let(:document_data) { { source: { key => content } } }
 
       it "returns the content" do
         expect(subject).to eq content
       end
+
+      context 'method missing coverage' do
+        it { expect(document).to respond_to :a_key }
+        it { expect(document.a_key).to eq content }
+      end
     end
 
     context 'otherwise' do
@@ -29,6 +34,11 @@ describe SearchKit::Models::Document do
         expect { subject }
           .to raise_exception(described_class::AttributeNotFound)
       end
+
+      context 'method missing coverage' do
+        it { expect(document).not_to respond_to :a_key }
+        it { expect { document.a_key }.to raise_exception(NoMethodError) }
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search-kit
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Joseph McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-30 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
@@ -215,40 +215,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
 - README.md
-- Rakefile
 - bin/search-kit
-- config/locales/en.yml
-- coverage/assets/0.10.0/application.css
-- coverage/assets/0.10.0/application.js
-- coverage/assets/0.10.0/colorbox/border.png
-- coverage/assets/0.10.0/colorbox/controls.png
-- coverage/assets/0.10.0/colorbox/loading.gif
-- coverage/assets/0.10.0/colorbox/loading_background.png
-- coverage/assets/0.10.0/favicon_green.png
-- coverage/assets/0.10.0/favicon_red.png
-- coverage/assets/0.10.0/favicon_yellow.png
-- coverage/assets/0.10.0/loading.gif
-- coverage/assets/0.10.0/magnify.png
-- coverage/assets/0.10.0/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
-- coverage/assets/0.10.0/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
-- coverage/assets/0.10.0/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
-- coverage/assets/0.10.0/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
-- coverage/assets/0.10.0/smoothness/images/ui-bg_glass_75_dadada_1x400.png
-- coverage/assets/0.10.0/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
-- coverage/assets/0.10.0/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
-- coverage/assets/0.10.0/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
-- coverage/assets/0.10.0/smoothness/images/ui-icons_222222_256x240.png
-- coverage/assets/0.10.0/smoothness/images/ui-icons_2e83ff_256x240.png
-- coverage/assets/0.10.0/smoothness/images/ui-icons_454545_256x240.png
-- coverage/assets/0.10.0/smoothness/images/ui-icons_888888_256x240.png
-- coverage/assets/0.10.0/smoothness/images/ui-icons_cd0a0a_256x240.png
-- coverage/index.html
-- demo/videos
-- demo/videos.json
 - lib/search_kit.rb
 - lib/search_kit/cli.rb
 - lib/search_kit/cli/all.rb
@@ -285,15 +253,6 @@ files:
 - lib/search_kit/polling/process.rb
 - lib/search_kit/thor.rb
 - lib/search_kit/version.rb
-- log/search-kit-development.log
-- log/search-kit-test.log
-- log/service-layer-development.log
-- log/service-layer-test.log
-- pkg/search-kit-0.0.3.gem
-- pkg/search-kit-0.0.4.gem
-- pkg/search-kit-0.0.5.gem
-- pkg/search-kit-0.0.6.gem
-- scripts/console
 - search-kit.gemspec
 - spec/integrations/subscriber_model_spec.rb
 - spec/search_kit/cli/documents_spec.rb
@@ -323,8 +282,6 @@ files:
 - spec/search_kit/polling_spec.rb
 - spec/search_kit_spec.rb
 - spec/spec_helper.rb
-- tmp/modeling.rb
-- tmp/vidya.json
 homepage: https://github.com/qbox-io/search-kit
 licenses:
 - MIT

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in service-layer.gemspec
-gemspec

data/Gemfile.lock

@@ -1,88 +0,0 @@
-PATH
-  remote: .
-  specs:
-    search-kit (0.0.6)
-      ansi (~> 1.5)
-      faraday (~> 0.9)
-      highline (~> 1.7)
-      i18n (~> 0.7)
-      thor (~> 0.19)
-      user_config (~> 0.0)
-      virtus (~> 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
-    coderay (1.1.0)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    equalizer (0.0.11)
-    faraday (0.9.2)
-      multipart-post (>= 1.2, < 3)
-    highline (1.7.8)
-    i18n (0.7.0)
-    ice_nine (0.11.1)
-    json (1.8.3)
-    method_source (0.8.2)
-    multipart-post (2.0.0)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rack (1.6.4)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rake (10.4.2)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.0)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.0)
-    ruby-prof (0.15.8)
-    simplecov (0.10.0)
-      docile (~> 1.1.0)
-      json (~> 1.8)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    slop (3.6.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    user_config (0.0.4)
-    virtus (1.0.5)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.8)
-  pry (~> 0.10)
-  rack-test (~> 0.6)
-  rake (~> 10.0)
-  rspec (~> 3.3)
-  ruby-prof (~> 0.15)
-  search-kit!
-  simplecov (~> 0.10)
-
-BUNDLED WITH
-   1.10.6