swiftype 0.0.4 → 0.0.5

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.DS_Store

data/README.md

@@ -15,7 +15,7 @@ Installation
 
 To install the gem, execute:
 
-        gem install swiftype       
+        gem install swiftype
 
 Or place `gem 'swiftype'` in your `Gemfile` and run `bundle install`.
 
@@ -62,9 +62,11 @@ Configuration:
 
 Before issuing commands to the API, configure the client with your API key:
 
-	Swiftype.configure do |config|
-          config.api_key = 'YOUR_API_KEY'
-	end
+```ruby
+Swiftype.configure do |config|
+  config.api_key = 'YOUR_API_KEY'
+end
+```
 
 Indexing:
 ---
@@ -233,7 +235,30 @@ Search a `document_type` for the query "lucene":
 	type = engine.document_type('books')
 	results = type.search("lucene")
 
-You can pass the following options to the search method: `page`, `per_page`, `fetch_fields`, `search_fields`, and `filters`.
+Searches return a `ResultSet` object from which you retrieve the results. Results are grouped by their `DocumentType`, so you retrieve the results for a specific `DocumentType` as follows:
+
+	resultset = type.search('lucene')
+	book_results = resultset['books']
+	book_results.each do |book|
+		puts book.title
+		puts book.author
+		puts book.genre
+	end
+
+The `ResultSet` object also contains meta data for the search, such as pagination and facets if the user has specified them.
+
+#### Pagination
+
+To get pagination information from a `ResultSet`, you call the `num_pages`, `current_page`, and `per_page` methods. For example:
+
+	resultset = type.search('lucene')
+	puts "Current page of results: #{resultset.current_page}"
+	puts "Total pages in this result set: #{resultset.num_pages}"
+	puts "Number of results per page: #{resultset.per_page}"
+
+#### Search Options
+
+You can pass the following options to the search method: `page`, `per_page`, `fetch_fields`, `search_fields`, `filters`, and `facets`.
 
 * `page` should be an integer of the page of results you want
 * `per_page` should be an integer of the number of results you want from each page
@@ -241,21 +266,24 @@ You can pass the following options to the search method: `page`, `per_page`, `fe
 * `search_fields` is a hash containing arrays of the fields you want to match your query against for each object of each document_type
 * `functional_boosts` is a hash containing boosts that are to be applied to numerically valued fields
 * `filters` is a hash specifying additional conditions that should be applied to your query for each document_type
+* `facets` is a hash specifying fields for faceted counts for each document type
 
 An example of using search options is as follows:
 
-	results = type.search('lucene', :filters => { :books => { :in_stock => false, :genre => 'fiction' }}, :per_page => 10, :page => 2, :fetch_fields => {:books => ['title','genre']}, :search_fields => {:books => ['title']})
+	resultset = type.search('lucene', :filters => { :books => { :in_stock => false, :genre => 'fiction' }}, :per_page => 10, :page => 2, :fetch_fields => {:books => ['title','genre']}, :search_fields => {:books => ['title']})
 
 Filters also support datetime range queries. For example, to return only those books with an `updated_at` field between `2012-02-16` and now, use the following filter:
 
-	results = type.search('lucene', :filters => { :books => { :updated_at => '[2012-02-16 TO *]' }})
+	resultset = type.search('lucene', :filters => { :books => { :updated_at => '[2012-02-16 TO *]' }})
+
+See the (Swiftype Documentation)[http://swiftype.com/documentation/searching] for more details and examples of search options.
 
 
 ##### Functional Boosts
 
 Functional boosts allow you to boost result scores based on some numerically valued field. For example, you might want your search engine to return the most popular books first, so you would boost results on the `total_purchases` field, which contains an `integer` of the total number of purchases of that book:
 
-	results = type.search('lucene', :functional_boosts => { :books => { :total_purchases => 'logarithmic' }})
+	resultset = type.search('lucene', :functional_boosts => { :books => { :total_purchases => 'logarithmic' }})
 
 There are 3 types of functional boosts:
 
@@ -265,6 +293,18 @@ There are 3 types of functional boosts:
 
 Functional boosts may be applied to `integer` and `float` valued fields.
 
+##### Facets
+
+You may get facets for your search results by passing the facets option when you search. For example, to get aggregate counts for the number of results in each genre, use the following:
+
+	resultset = type.search('lucene', :facets => { :books => ['genre']})
+
+You can retrieve the facet counts from the `ResultSet` as follows:
+
+	resultset = type.search('lucene', :facets => { :books => ['genre']})
+	resultset.facets('books')
+	=> {"genre"=>{"fiction"=>5, "non-fiction"=>2, "political"=>1, "fantasy"=>1}}
+
 #### Autocomplete
 
 Get autocomplete suggestions from a `document_type` for the prefix "act"

data/lib/swiftype/configuration.rb

@@ -2,7 +2,7 @@ require 'swiftype/version'
 
 module Swiftype
   module Configuration
-    DEFAULT_ENDPOINT = "http://api.swiftype.com/api/v1/"
+    DEFAULT_ENDPOINT = "https://api.swiftype.com/api/v1/"
     DEFAULT_USER_AGENT = "Swiftype-Ruby/#{Swiftype::VERSION}"
 
     VALID_OPTIONS_KEYS = [
@@ -39,4 +39,4 @@ module Swiftype
       options
     end
   end
-end
+end

data/lib/swiftype/easy.rb

@@ -10,7 +10,6 @@ module Swiftype
 
     module Engine
       def engines
-        test_search_module
         get("engines.json")
       end
       def create_engine(engine={})

data/lib/swiftype/version.rb

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

data/swiftype.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
-  s.add_runtime_dependency "json"
+  s.add_runtime_dependency "json", ['~> 1.7.7']
   s.add_runtime_dependency "faraday", ['~> 0.8.1']
   s.add_runtime_dependency "faraday_middleware", ['~> 0.8.7']
   s.add_runtime_dependency "hashie", ['~> 1.2.0']
-  s.add_runtime_dependency 'activesupport', ['>= 2.3.9', '< 4']
+  s.add_runtime_dependency 'activesupport', ['>= 2.3.9']
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swiftype
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,24 +10,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-31 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -84,9 +84,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.9
-    - - <
-      - !ruby/object:Gem::Version
-        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -95,9 +92,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.9
-    - - <
-      - !ruby/object:Gem::Version
-        version: '4'
 description: Official gem for accessing the Swiftype Search API
 email:
 - team@swiftype.com
@@ -145,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Swiftype API Gem