swiftype 0.0.3 → 0.0.4

data/README.md

@@ -13,20 +13,15 @@ Prerequisites
 Installation
 ---
 
-For now, just clone this repository and then pull in the library:
+To install the gem, execute:
 
-#### Bundler
+        gem install swiftype       
 
-	gem 'swiftype-rb', :git => "https://github.com/swiftype/swiftype-rb.git", :require => 'swiftype'
+Or place `gem 'swiftype'` in your `Gemfile` and run `bundle install`.
 
-#### Non-Bundler
-
-	git clone https://github.com/swiftype/swiftype-rb.git
-
-	rake build && rake install
-
-	require 'swiftype'
+To use the GitHub version, you may add this to your Gemfile:
 
+	gem 'swiftype', :git => "https://github.com/swiftype/swiftype-rb.git"
 
 Overview
 ---
@@ -65,11 +60,10 @@ Basic Usage
 Configuration:
 ---
 
-Before issuing commands to the API, configure the client with your authentication credentials:
+Before issuing commands to the API, configure the client with your API key:
 
 	Swiftype.configure do |config|
-	  config.username = "{YOUR_SWIFTYPE_LOGIN}"
-	  config.password = "{YOUR_SWIFTYPE_PASSWORD}"
+          config.api_key = 'YOUR_API_KEY'
 	end
 
 Indexing:
@@ -382,4 +376,4 @@ Questions?
 ===
 Get in touch! We would be happy to help you get up and running.
 
-[Quin](mailto:quin@swiftype.com) and [Matt](mailto:matt@swiftype.com) from [Swiftype](http://swiftype.com)
+[Quin](mailto:quin@swiftype.com) and [Matt](mailto:matt@swiftype.com) from [Swiftype](http://swiftype.com)

data/lib/swiftype.rb

@@ -9,6 +9,7 @@ module Swiftype
   autoload :Client, 'swiftype/client'
   autoload :BaseModel, 'swiftype/base_model'
   autoload :Request, 'swiftype/request'
+  autoload :ResultSet, 'swiftype/result_set'
   autoload :Search, 'swiftype/search'
   autoload :Engine, 'swiftype/engine'
   autoload :DocumentType, 'swiftype/document_type'

data/lib/swiftype/base_model.rb

@@ -21,10 +21,6 @@ module Swiftype
       end
     end
 
-    def id
-      self._id
-    end
-
     def to_hash
       table
     end

data/lib/swiftype/document_type.rb

@@ -63,10 +63,7 @@ module Swiftype
 
     def search(query, options={})
       search_params = { :q => query }.merge(parse_search_options(options))
-      response = post("engines/#{engine_id}/document_types/#{slug}/search.json", search_params)
-      results = {}
-      response['records'].each { |document_type, records| results[document_type] = records.map { |d| Swiftype::Document.new(d) }}
-      results
+      ResultSet.new(post("engines/#{engine_id}/document_types/#{slug}/search.json", search_params))
     end
   end
 end

data/lib/swiftype/easy.rb

@@ -21,17 +21,11 @@ module Swiftype
       end
       def suggest(engine_id, query, options={})
         search_params = { :q => query }.merge(parse_suggest_options(options))
-        response = post("engines/#{engine_id}/suggest.json", search_params)
-        results = {}
-        response['records'].each { |document_type, records| results[document_type] = records.map { |d| Swiftype::Document.new(d) }}
-        results
+        ResultSet.new(post("engines/#{engine_id}/suggest.json", search_params))
       end
       def search(engine_id, query, options={})
         search_params = { :q => query }.merge(parse_search_options(options))
-        response = post("engines/#{engine_id}/search.json", search_params)
-        results = {}
-        response['records'].each { |document_type, records| results[document_type] = records.map { |d| Swiftype::Document.new(d) }}
-        results
+        ResultSet.new(post("engines/#{engine_id}/search.json", search_params))
       end
     end
 

data/lib/swiftype/result_set.rb

@@ -0,0 +1,45 @@
+module Swiftype
+  class ResultSet
+    attr_accessor :records, :info
+    
+    def initialize(results)
+      @records = {}
+      results['records'].each do |document_type, documents|
+        @records[document_type] = documents.map { |d| Swiftype::Document.new(d) }
+      end
+      @info = results['info']
+    end
+
+    def [](document_type)
+      records[document_type]
+    end
+
+    def facets(document_type)
+      info[document_type]['facets']
+    end
+
+    def current_page
+      info[info.keys.first]['current_page']
+    end
+
+    def per_page
+      info[info.keys.first]['per_page']
+    end
+
+    def num_pages(document_type=nil)
+      if document_type
+        info[document_type]['num_pages']
+      else
+        info.values.map { |v| v['num_pages'] }.max
+      end
+    end
+
+    def total_result_count(document_type)
+      info[document_type]['total_result_count']
+    end
+
+    def query
+      info[info.keys.first]['query']
+    end
+  end
+end

data/lib/swiftype/search.rb

@@ -1,7 +1,7 @@
 module Swiftype
   module Search
     VALID_SUGGEST_OPTIONS = [:fetch_fields, :search_fields, :filters, :document_types, :functional_boosts, :page, :per_page]
-    VALID_SEARCH_OPTIONS =  [:fetch_fields, :search_fields, :filters, :document_types, :functional_boosts, :page, :per_page, :sort_field, :sort_direction]
+    VALID_SEARCH_OPTIONS =  [:fetch_fields, :search_fields, :filters, :document_types, :functional_boosts, :page, :per_page, :sort_field, :sort_direction, :facets]
 
     def parse_search_options(options)
       parse_options(options, VALID_SEARCH_OPTIONS)

data/lib/swiftype/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swiftype
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000 Z
+date: 2012-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -121,6 +121,7 @@ files:
 - lib/swiftype/engine.rb
 - lib/swiftype/exceptions.rb
 - lib/swiftype/request.rb
+- lib/swiftype/result_set.rb
 - lib/swiftype/search.rb
 - lib/swiftype/version.rb
 - swiftype.gemspec