aws_cloud_search 0.0.1 → 0.0.2

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@aws_cloud_search --create

data/Rakefile

@@ -3,3 +3,5 @@ require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/aws_cloud_search/search_request.rb

@@ -1,8 +1,47 @@
 module AWSCloudSearch
   class SearchRequest
 
-    attr_accessor :q, :bq, :rank, :results_type, :return_fields, :size, :start
+    attr_accessor :q, :bq, :rank, :results_type, :return_fields, :size, :start, :facet
+    attr_accessor :facet_constraints, :facet_sort, :facet_top_n, :t
 
+    def initialize
+      @facet_constraints, @facet_sort, @facet_top_n, @t = {}, {}, {}, {}
+    end
+
+    # Specifies the facet constraints for a field
+    # @param [String] field The field for which to add the facet constraints
+    # @param [String] constraints The facet contraints
+    def add_facet_constraints(field, constraints)
+      @facet_constraints["facet-#{field}-constraints"] = constraints
+    end
+
+    # Specifies how to sort a facet field.
+    # @param [String] field The field for which to add the facet sort
+    # @param [String] sort The facet sort method: alpha, count, max, sum
+    def add_facet_sort(field, sort)
+      @facet_sort["facet-#{field}-sort"] = sort
+    end
+
+    # Specifies how many facet constraints to return.
+    # @param [String] field The field for which to add the facet top n constraints.
+    # @param [Integer] top_n The maximum number of facet constraints to add for a field.
+    def add_facet_top_n(field, top_n)
+      raise ArgumentError.new("top_n must be of type Integer") unless top_n.kind_of? Integer
+      @facet_top_n["facet-#{field}-top-n"] = top_n
+    end
+
+    # Restricts the records returned based on the values from the rank expression. The t-field value is a range.
+    # @param [String] field The field for which to add.
+    # @param [Integer] t_from Beginning of the range, may be nil or blank string.
+    # @param [Integer] t_to   End of the range, may be nil or blank string.
+    def add_t(field, t_from, t_to)
+      raise ArgumentError.new("Range must have a beginning or ending value or both.") if t_from.nil? and t_to.nil?
+      raise ArgumentError.new("Range values must be of type Integer") unless t_from.kind_of? Integer and t_to.kind_of? Integer
+      @t["t-#{field}"] = "#{t_from}..#{t_to}"
+    end
+
+    # Returns the hash of all the values for this SearchRequest. Useful for creating URL params.
+    # @return [Hash] The object converted to a Hash
     def to_hash
       hash = {}
       hash['q']     = @q unless @q.nil?
@@ -12,7 +51,8 @@ module AWSCloudSearch
       hash['start'] = @start unless @start.nil?
       hash['results-type']  = @results_type unless @results_type.nil?
       hash['return-fields'] = @return_fields.join(',') unless @return_fields.nil?
-      hash
+      hash['facet'] = @facet unless @facet.nil?
+      hash.merge(@facet_constraints).merge(@facet_sort).merge(@facet_top_n).merge(@t)
     end
 
   end

data/lib/aws_cloud_search/search_response.rb

@@ -6,7 +6,7 @@ module AWSCloudSearch
     alias :results :hits
 
     # error is an undocumented field that occurs when an error is returned
-    FIELDS = [ :match_expr, :rank, :cpu_time_ms, :time_ms, :rid, :found, :start, :error, :messages ].freeze
+    FIELDS = [ :match_expr, :rank, :cpu_time_ms, :time_ms, :rid, :found, :start, :error, :messages, :facets ].freeze
     FIELDS.each { |f| attr_accessor f }
 
     # Takes in the hash, representing the json object returned from a search request

data/lib/aws_cloud_search/version.rb

@@ -1,3 +1,3 @@
 module AWSCloudSearch
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/aws_cloud_search/search_request_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe AWSCloudSearch::SearchResponse do
+  let(:search_req) { AWSCloudSearch::SearchRequest.new }
+
+  context "#add_facet_top_n" do
+    it "should raise ArgumentError when param is not an Integer" do
+      expect { search_req.add_facet_top_n("fieldname", "string") }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "#ad_t" do
+    it "should raise ArgumentError when range beginning and end are nil" do
+      expect {search_req.add_t("fieldname", nil, nil)}.to raise_error(ArgumentError)
+    end
+
+    it "should raise ArgumentError when t_from or t_to are not an Integers" do
+      expect {search_req.add_t("fieldname", "string", 10)}.to raise_error(ArgumentError)
+      expect {search_req.add_t("fieldname", 10, "string")}.to raise_error(ArgumentError)
+      expect {search_req.add_t("fieldname", "string", "string")}.to raise_error(ArgumentError)
+    end
+  end
+
+  context "#to_hash" do
+    it "should return an empty hash" do
+      search_req.to_hash.should eq({})
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws_cloud_search
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-18 00:00:00.000000000Z
+date: 2012-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &9414220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *9414220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &9413280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +38,12 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *9413280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 description: AWSCloudSearch Search gem
 email:
 - david.jensen@spoke.com
@@ -44,6 +54,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rvmrc
 - Gemfile
 - LICENSE
 - README.md
@@ -62,6 +73,7 @@ files:
 - spec/aws_cloud_search/cloud_search_spec.rb
 - spec/aws_cloud_search/document_batch_spec.rb
 - spec/aws_cloud_search/document_spec.rb
+- spec/aws_cloud_search/search_request_spec.rb
 - spec/aws_cloud_search/search_response_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -84,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Implementation of the AWS CloudSearch API
@@ -92,5 +104,6 @@ test_files:
 - spec/aws_cloud_search/cloud_search_spec.rb
 - spec/aws_cloud_search/document_batch_spec.rb
 - spec/aws_cloud_search/document_spec.rb
+- spec/aws_cloud_search/search_request_spec.rb
 - spec/aws_cloud_search/search_response_spec.rb
 - spec/spec_helper.rb