slingshot-rb 0.0.4 → 0.0.5

data/README.markdown

@@ -11,7 +11,7 @@ RESTful database communicating by JSON over HTTP, based on [Lucene](http://lucen
 written in Java. It manages to very simple and very powerful at the same time.
 You should seriously consider it to power search in your Ruby applications:
 it will deliver all the features you want — and many more you may have not
-imagined yet (native geo search? histogram facets?)
+imagined yet (native geo search? histogram facets for dates?)
 
 _Slingshot_ currently allows basic operation with the index and searching. More is planned.
 
@@ -21,9 +21,9 @@ Installation
 
 First, you need a running _ElasticSearch_ server. Thankfully, it's easy. Let's define easy:
 
-    $ curl -L -o elasticsearch-0.14.4.tar.gz http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.14.4.tar.gz
-    $ tar -zxvf elasticsearch-0.14.4.tar.gz
-    $ ./elasticsearch-0.14.4/bin/elasticsearch -f
+    $ curl -k -L -o elasticsearch-0.15.0.tar.gz http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.15.0.tar.gz
+    $ tar -zxvf elasticsearch-0.15.0.tar.gz
+    $ ./elasticsearch-0.15.0/bin/elasticsearch -f
 
 OK, easy. Now, install the gem via Rubygems:
 
@@ -40,9 +40,10 @@ Usage
 -----
 
 Currently, you can use _Slingshot_ via the DSL (eg. by extending your class with it).
-Plans for full ActiveModel integration (and other convenience layers) are in progress.
+Plans for full ActiveModel integration (and other convenience layers) are in progress
+(see the [`activemodel`](https://github.com/karmi/slingshot/compare/activemodel) branch).
 
-To kick the tiers, require the gem in an IRB session or a Ruby script
+To kick the tires, require the gem in an IRB session or a Ruby script
 (note that you can run the full example from [`examples/dsl.rb`](https://github.com/karmi/slingshot/blob/master/examples/dsl.rb)):
 
     require 'rubygems'
@@ -112,7 +113,9 @@ We can display the full query JSON:
     puts s.to_json
     # {"facets":{"current-tags":{"terms":{"field":"tags"}},"global-tags":{"global":true,"terms":{"field":"tags"}}},"sort":[{"title":"desc"}],"query":{"terms":{"tags":["ruby"]}}}
 
-See, a Ruby DSL for this thing is kinda handy? We can query _ElasticSearch_ manually with `curl`, simply:
+See, a Ruby DSL for this thing is kinda handy?
+
+You can display the corresponding `curl` command easily:
 
     puts s.to_curl
     # curl -X POST "http://localhost:9200/articles/_search?pretty=true" -d '{"facets":{"current-tags":{"terms":{"field":"tags"}},"global-tags":{"global":true,"terms":{"field":"tags"}}},"sort":[{"title":"desc"}],"query":{"terms":{"tags":["ruby"]}}}'
@@ -128,7 +131,7 @@ Currently, _Slingshot_ supports only a limited subset of vast _ElasticSearch_ [S
 * [Querying](https://github.com/karmi/slingshot/blob/master/examples/dsl.rb) the index with the `query_string`, `term` and `terms` types of queries
 * Sorting the results by `fields`
 * Retrieving a _terms_ type of [facets](http://www.elasticsearch.org/guide/reference/api/search/facets/index.html) -- other types are high priority
-* Returning just specific fields from documents
+* Returning just specific `fields` from documents
 * Paging with `from` and `size` query options
 
 See the [`examples/dsl.rb`](blob/master/examples/dsl.rb).
@@ -145,12 +148,13 @@ Todo & Plans
 
 In order of importance:
 
-* Seamless _ActiveModel_ compatibility for easy usage in _Rails_ applications (this also means nearly full _ActiveRecord_ compatibility)
+* Seamless _ActiveModel_ compatibility for easy usage in _Rails_ applications (this also means nearly full _ActiveRecord_ compatibility). See the [`activemodel`](https://github.com/karmi/slingshot/compare/activemodel) branch
 * Seamless [will_paginate](https://github.com/mislav/will_paginate) compatibility for easy pagination
+* [Mapping](http://www.elasticsearch.org/guide/reference/mapping/) definition for models
+* Proper RDoc annotations for the source code
+* Dual interface: allow to simply pass queries/options for _ElasticSearch_ as a Hash in any method
 * [Histogram](http://www.elasticsearch.org/guide/reference/api/search/facets/histogram-facet.html) facets
 * Seamless support for [auto-updating _river_ index](http://www.elasticsearch.org/guide/reference/river/couchdb.html) for _CouchDB_ `_changes` feed
-* [Mapping](http://www.elasticsearch.org/guide/reference/mapping/) management
-* Proper RDoc annotations for the source code
 * Infrastructure for query filters
 * [Range](http://www.elasticsearch.org/guide/reference/query-dsl/range-filter.html) filters and queries
 * [Geo Filters](http://www.elasticsearch.org/blog/2010/08/16/geo_location_and_search.html) for queries
@@ -160,7 +164,7 @@ In order of importance:
 * [Analyze](http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze.html) API support
 * [Highligting](http://www.elasticsearch.org/guide/reference/api/search/highlighting.html) support
 * [Bulk](http://www.elasticsearch.org/guide/reference/api/bulk.html) API
-* Embedded webserver to display cluster statistics and allow easy searches
+* Embedded webserver to display statistics and to allow easy searches
 
 
 Other Clients

data/lib/slingshot/index.rb

@@ -13,12 +13,17 @@ module Slingshot
       false
     end
 
-    def create
-      Configuration.client.post "#{Configuration.url}/#{@name}", ''
+    def create(options={})
+      # http://www.elasticsearch.org/guide/reference/api/admin-indices-create-index.html
+      Configuration.client.post "#{Configuration.url}/#{@name}", Yajl::Encoder.encode(options)
     rescue
       false
     end
 
+    def mapping
+      JSON.parse( Configuration.client.get("#{Configuration.url}/#{@name}/_mapping") )[@name]
+    end
+
     def store(*args)
       # TODO: Infer type from the document (hash property, method)
 

data/lib/slingshot/version.rb

@@ -1,3 +1,3 @@
 module Slingshot
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/integration/index_mapping_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+module Slingshot
+
+  class IndexMappingTest < Test::Unit::TestCase
+    include Test::Integration
+
+    context "Default mapping" do
+      teardown { Slingshot.index('mapped-index').delete }
+
+      should "create and return the default mapping" do
+
+        index = Slingshot.index 'mapped-index' do
+          create
+          store :article, :title => 'One'
+          refresh
+        end
+        sleep 1
+
+        assert_equal 'string', index.mapping['article']['properties']['title']['type'],  index.mapping.inspect
+        assert_nil             index.mapping['article']['properties']['title']['boost'], index.mapping.inspect
+      end
+    end
+
+    context "Creating index with mapping" do
+      teardown { Slingshot.index('mapped-index').delete; sleep 1 }
+    
+      should "create the specified mapping" do
+    
+        index = Slingshot.index 'mapped-index' do
+          create :mappings => { :article => { :properties => { :title => { :type => 'string', :boost => 2.0, :store => 'yes' } } } }
+        end
+        sleep 1
+
+        # p index.mapping    
+        assert_equal 2.0,   index.mapping['article']['properties']['title']['boost'],  index.mapping.inspect
+        assert_equal 'yes', index.mapping['article']['properties']['title']['store'],  index.mapping.inspect
+    
+      end
+    end
+
+  end
+
+end

data/test/unit/index_test.rb

@@ -37,6 +37,44 @@ module Slingshot
         assert_nothing_raised { assert @index.refresh }
       end
 
+      context "mapping" do
+
+        should "create index with mapping" do
+          Configuration.client.expects(:post).returns('{"ok":true,"acknowledged":true}')
+
+          assert @index.create :settings => { :number_of_shards => 1 },
+                               :mappings => { :article => {
+                                                :properties => {
+                                                  :title => { :boost => 2.0,
+                                                              :type => 'string',
+                                                              :store => 'yes',
+                                                              :analyzer => 'snowball' }
+                                                }
+                                              }
+                                            }
+        end
+
+        should "return the mapping" do
+          json =<<-JSON
+          {
+            "dummy" : {
+              "article" : {
+                "properties" : {
+                  "title" :    { "type" : "string", "boost" : 2.0 },
+                  "category" : { "type" : "string", "analyzed" : "no" }
+                }
+              }
+            }
+          }
+          JSON
+          Configuration.client.stubs(:get).returns(json)
+
+          assert_equal 'string', @index.mapping['article']['properties']['title']['type']
+          assert_equal 2.0,      @index.mapping['article']['properties']['title']['boost']
+        end
+
+      end
+
       context "when storing" do
 
         should "properly set type from args" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: slingshot-rb
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Karel Minarik
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 +01:00
+date: 2011-03-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -174,6 +174,7 @@ files:
 - test/fixtures/articles/4.json
 - test/fixtures/articles/5.json
 - test/integration/facets_test.rb
+- test/integration/index_mapping_test.rb
 - test/integration/index_store_test.rb
 - test/integration/query_string_test.rb
 - test/integration/results_test.rb
@@ -233,6 +234,7 @@ test_files:
 - test/fixtures/articles/4.json
 - test/fixtures/articles/5.json
 - test/integration/facets_test.rb
+- test/integration/index_mapping_test.rb
 - test/integration/index_store_test.rb
 - test/integration/query_string_test.rb
 - test/integration/results_test.rb