gsa 0.6.1 → 0.7.0

data/lib/gsa.rb

@@ -8,10 +8,14 @@ require_relative 'gsa/modules/xmlizer'
 require_relative 'gsa/records_converter'
 require_relative 'gsa/feeder'
 require_relative 'gsa/searcher'
-require_relative 'gsa/faceter'
 require_relative 'gsa/search_converter'
 require_relative 'gsa/uid_extractor'
 require_relative 'gsa/exceptions'
+require_relative 'gsa/readable_results'
+require_relative 'gsa/readable_results/readable_buckets'
+require_relative 'gsa/readable_results/readable_facets'
+require_relative 'gsa/readable_results/readable_metatags'
+require_relative 'gsa/readable_results/readable_result_sets'
 
 require_relative 'defaults'
 require_relative 'facade'

data/lib/gsa/readable_results.rb

@@ -0,0 +1,14 @@
+module GSA
+  class ReadableResults
+    extend Injector
+
+    def self.extract(search_results)
+      search_results[GSA::GOOGLE_SEARCH_PROTOCOL][GSA::RESULTS]
+    end
+
+    def self.parse_core(parsables)
+      parsables = [parsables] if parsables.is_a? Hash
+      inject_a(parsables) {|parsable| yield(parsable) }
+    end
+  end
+end

data/lib/gsa/readable_results/readable_buckets.rb

@@ -0,0 +1,19 @@
+module GSA
+  class ReadableBuckets < ReadableResults
+
+    def self.parse(buckets)
+      buckets = (buckets.select {|key, value| key == GSA::BUCKET})[GSA::BUCKET]
+      parse_core(buckets) {|bucket| convert(bucket) }
+    end
+
+    def self.convert(bucket)
+      bucket = Hash[*bucket] if bucket.is_a? Array
+      {
+        :bucket_value      => bucket[GSA::BUCKET_VALUE], 
+        :bucket_low_range  => bucket[GSA::BUCKET_LOW_RANGE],
+        :bucket_high_range => bucket[GSA::BUCKET_HIGH_RANGE],
+        :bucket_count      => bucket[GSA::BUCKET_COUNT]
+      }
+    end
+  end
+end

data/lib/gsa/readable_results/readable_facets.rb

@@ -0,0 +1,22 @@
+module GSA
+  class ReadableFacets < ReadableResults
+
+    def self.extract(search_results)
+      (search_results[GSA::FACETS].select {|key, value| key == GSA::FACET })[GSA::FACET]
+    end
+
+    def self.parse(facets)
+      parse_core(facets) {|facet| convert(facet) }
+    end
+
+    def self.convert(facet)
+      {
+        :facet_raw_name     => facet[GSA::FACET_RAW_NAME],
+        :facet_display_name => facet[GSA::FACET_DISPLAY_NAME],
+        :facet_is_range     => facet[GSA::FACET_IS_RANGE],
+        :facet_type         => facet[GSA::FACET_TYPE],
+        :buckets            => ReadableBuckets::parse(facet)
+      }
+    end
+  end
+end

data/lib/gsa/readable_results/readable_metatags.rb

@@ -0,0 +1,15 @@
+module GSA
+  class ReadableMetatags < ReadableResults
+
+    def self.parse(metatags)
+      parse_core(metatags) {|meta_pair| convert(meta_pair) }
+    end
+
+    def self.convert(meta_pair)
+      {
+        :meta_name => meta_pair[GSA::META_NAME], 
+        :meta_value => meta_pair[GSA::META_VALUE]
+      }
+    end
+  end
+end

data/lib/gsa/readable_results/readable_result_sets.rb

@@ -0,0 +1,22 @@
+module GSA
+  class ReadableResultSets < ReadableResults
+
+    def self.extract(search_results)
+      (search_results.select {|key, value| key == GSA::RESULT })[GSA::RESULT]
+    end
+
+    def self.parse(results_sets)
+      parse_core(results_sets) {|set| convert(set) }
+    end
+
+    def self.convert(set)
+      {
+        :result_number         => set[GSA::RESULT_NUMBER], 
+        :url                   => set[GSA::URL],
+        :title                 => set[GSA::TITLE],
+        :metatags              => GSA::ReadableMetatags.parse(set[GSA::METATAGS]),
+        :search_result_snippet => set[GSA::SEARCH_RESULT_SNIPPET]
+      } 
+    end
+  end
+end

data/lib/gsa/search_converter.rb

@@ -1,41 +1,18 @@
 module GSA
   class SearchConverter
-    extend Injector
 
     def self.convert(convertable)
-      parse result_sets_from results_param_in convertable
-    end
-
-    def self.results_param_in(convertable)
-      convertable[GSA::GOOGLE_SEARCH_PROTOCOL][GSA::RESULTS]
-    end
-
-    def self.result_sets_from(results)
-      (results.keep_if {|key, value| key == GSA::RESULT })[GSA::RESULT]
-    end
+      results     = GSA::ReadableResults.extract(convertable)
 
-    def self.parse(result_sets)
-
-      # if there is only one result, convert to the expected array.
-      result_sets = [result_sets] if result_sets.is_a? Hash
-
-      inject_a(result_sets) {|set|
-        { 
-          :result_number          => set[GSA::RESULT_NUMBER], 
-          :url                    => set[GSA::URL],
-          :title                  => set[GSA::TITLE],
-          :metatags               => parse_metatags(set[GSA::METATAGS]),
-          :search_result_snippet  => set[GSA::SEARCH_RESULT_SNIPPET]
-        }
-      }
-    end
-
-    def self.parse_metatags(metatags)
-      inject_a(metatags) {|meta_pair| convert_meta_pair(meta_pair) }
-    end
+      result_sets = GSA::ReadableResultSets.extract(results)
+      result_sets = GSA::ReadableResultSets.parse(result_sets)
+      
+      if results.include?(GSA::FACETS)
+        facets    = GSA::ReadableFacets.extract(results)
+        facets    = GSA::ReadableFacets.parse(facets)
+      end
 
-    def self.convert_meta_pair(meta_pair)
-      {:meta_name => meta_pair[GSA::META_NAME], :meta_value => meta_pair[GSA::META_VALUE]}
+      { :result_sets => result_sets, :facets => (facets || GSA::NO_RESULTS) }
     end
   end
 end

data/lib/gsa/searcher.rb

@@ -8,9 +8,10 @@ module GSA
       num             = args[:num]       || GSA::DEFAULT_NUM  
       output          = args[:output]    || GSA::DEFAULT_OUTPUT
       start           = args[:start]     || GSA::DEFAULT_START
+      client          = args[:client]    || GSA::DEFAULT_CLIENT
       requiredfields  = args[:filters]   || nil
 
-      search = "#{GSA.base_uri}/search?q=#{query}&filter=#{filter}&getfields=#{getfields}&sort=#{sort}&num=#{num}&start=#{start}&output=#{output}"
+      search = "#{GSA.base_uri}/search?q=#{query}&filter=#{filter}&getfields=#{getfields}&sort=#{sort}&num=#{num}&start=#{start}&output=#{output}&client=#{client}"
       search = "#{search}&requiredfields=#{clean_query(requiredfields)}" if requiredfields
 
       search_results = parsed_json( RestClient.get(search) )

data/lib/gsa/version.rb

@@ -1,3 +1,3 @@
 module GSA
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/spec/lib/gsa_spec.rb

@@ -14,6 +14,7 @@ describe GSA do
       context "many records" do
 
         it "successfully adds the records to the gsa index" do
+
           VCR.use_cassette("many_records") do
             results = GSA.feed(
               :records         => many_records, 
@@ -30,6 +31,7 @@ describe GSA do
       context "a single record" do
 
         it "successfully adds the records to the gsa index" do
+
           VCR.use_cassette("single_record") do
             results = GSA.feed(
               :records         => many_records, 
@@ -49,6 +51,7 @@ describe GSA do
       context "many records" do
 
         it "successfully deletes the records from the gsa index" do
+
           VCR.use_cassette("delete_many_records") do
             results = GSA.feed(
               :records         => many_records, 
@@ -66,6 +69,7 @@ describe GSA do
       context "a single record" do
 
         it "successfully deletes the record from the gsa index" do
+
           VCR.use_cassette("delete_single_record") do
             results = GSA.feed(
               :records         => one_records, 
@@ -114,6 +118,7 @@ describe GSA do
         let(:results_set) { many_results }
 
         it "returns many records" do
+
           VCR.use_cassette("many_results_no_filters") do
             results = GSA.search(query)
             results.count.should eq results_set.count
@@ -121,6 +126,7 @@ describe GSA do
         end
 
         it "returns results in the expected 'pretty' format" do
+
           VCR.use_cassette("many_results_no_filters") do
             results = GSA.search(query)
             results.should eq results_set
@@ -134,16 +140,18 @@ describe GSA do
         let(:result_set) { one_results }
 
         it "returns a single record" do
+
           VCR.use_cassette("single_result_no_filters") do
             results = GSA.search(query)
-            results.count.should eq 1
+            results[:result_sets].count.should eq 1
           end
         end
 
         it "returns the single result in the expected 'pretty' format" do
+
           VCR.use_cassette("single_result_no_filters") do
             results = GSA.search(query)
-            results.should eq result_set
+            results[:result_sets].should eq result_set[:result_sets]
           end
         end
       end
@@ -153,6 +161,7 @@ describe GSA do
         let(:query) { none_query }
 
         it "returns the no record flag" do
+
           VCR.use_cassette("no_result_no_filters") do
             results = GSA.search(query)
             results.should eq GSA::NO_RESULTS
@@ -167,23 +176,25 @@ describe GSA do
 
         let(:query)        { many_query }
         let(:results_set)  { many_results }
-        let(:filter_name)  { "brand" }
-        let(:filter_value) { "Philips" }
+        let(:filter_name)  { "attribute_brand" }
+        let(:filter_value) { "HLS" }
         let(:filters)      { "#{filter_name}:#{filter_value}" }
 
         it "returns less than the unfiltered results" do
+
           VCR.use_cassette("many_results_with_filters") do
             results = GSA.search(query, :filters => filters)
-            results.count.should be < results_set.count
+            results[:result_sets].count.should be < results_set[:result_sets].count
           end
         end
 
         it "should only contain results matched in the unfiltered results" do
+
           VCR.use_cassette("many_results_with_filters") do
             results = GSA.search(query, :filters => filters)
 
             filtered_results = []
-            results_set.each {|result| 
+            results_set[:result_sets].each {|result| 
               result[:metatags].each {|tag| 
                 if tag[:meta_name] == filter_name && tag[:meta_value] == filter_value
                   filtered_results << result
@@ -191,7 +202,7 @@ describe GSA do
               }
             }
 
-            result_uids   = GSA.uids(results, uid)
+            result_uids   = GSA.uids(results[:result_sets], uid)
             filtered_uids = GSA.uids(filtered_results, uid)
             result_uids.should eq filtered_uids
           end
@@ -202,24 +213,26 @@ describe GSA do
 
         let(:query)          { many_query }
         let(:results_set)    { many_results }
-        let(:filter_1_name)  { "brand" }
-        let(:filter_1_value) { "Philips" }
-        let(:filter_2_name)  { "material" }
-        let(:filter_2_value) { "Brass" }
+        let(:filter_1_name)  { "attribute_color" }
+        let(:filter_1_value) { "Red" }
+        let(:filter_2_name)  { "attribute_brand" }
+        let(:filter_2_value) { "Vickerman" }
         let(:filters)        { "#{filter_1_name}:#{filter_1_value}.#{filter_2_name}:#{filter_2_value}" }
 
         it "returns a single filtered result" do
+
           VCR.use_cassette("single_result_with_filters") do
             results = GSA.search(query, :filters => filters)
-            results.count.should eq 1
+            results[:result_sets].count.should eq 1
           end
         end
 
         it "returns a result with the expected matching filters" do
+
           VCR.use_cassette("single_result_with_filters") do
             results = GSA.search(query, :filters => filters)
 
-            results.each.inject([]) {|flags, result| result[:metatags].each {|tag|
+            results[:result_sets].each.inject([]) {|flags, result| result[:metatags].each {|tag|
                 flags << 1 if tag[:meta_name] == filter_1_name && tag[:meta_value] == filter_1_value
                 flags << 1 if tag[:meta_name] == filter_2_name && tag[:meta_value] == filter_2_value
               }
@@ -235,6 +248,7 @@ describe GSA do
         let(:filters) { "brand:FooBar" }
 
         it "returns the no record flag" do
+
           VCR.use_cassette("no_result_with_filters") do
             results = GSA.search(query, :filters => filters)
             results.should eq GSA::NO_RESULTS
@@ -252,6 +266,7 @@ describe GSA do
         end
 
         it "raises an error" do
+
           expect { 
 
             GSA.search(query, :filters => filters) 
@@ -262,33 +277,6 @@ describe GSA do
     end
   end
 
-  describe "#facet" do
-
-    let(:results_set) { many_results }
-
-    context "with multiple facets" do
-
-      let(:facetables)    { many_facets }
-      let(:facet_results) { many_facet_results }
-
-      it "returns multiple facets in the expected form" do
-        results = GSA.facet(results_set, facetables)
-        results.should eq facet_results
-      end
-    end
-
-    context "with a single facet" do
-
-      let(:facetables)    { one_facets }
-      let(:facet_results) { one_facet_results }
-
-      it "returns a single facet in the expected form" do
-        results = GSA.facet(results_set, facetables)
-        results.should eq facet_results
-      end
-    end
-  end
-
   describe "#uids" do
 
     context "with multiple records passed in" do
@@ -297,7 +285,8 @@ describe GSA do
       let(:uids)        { many_uids }
 
       it "returns multiple uids" do
-        results = GSA.uids(results_set, uid)
+
+        results = GSA.uids(results_set[:result_sets], uid)
         results.should eq uids
       end
     end
@@ -308,7 +297,8 @@ describe GSA do
       let(:uids)        { one_uids }
 
       it "returns a single uid" do
-        results = GSA.uids(results_set, uid)
+
+        results = GSA.uids(results_set[:result_sets], uid)
         results.should eq uids
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gsa
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Daniel J. Long
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-03 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,17 +162,13 @@ files:
 - fixtures/cassette_library/single_record.yml
 - fixtures/cassette_library/single_result_no_filters.yml
 - fixtures/cassette_library/single_result_with_filters.yml
-- fixtures/facets/many.txt
-- fixtures/facets/single.txt
 - fixtures/feeds/15_records.txt
 - fixtures/feeds/1_records.txt
 - fixtures/queries/many.txt
 - fixtures/queries/none.txt
 - fixtures/queries/single.txt
 - fixtures/result_sets/many.txt
-- fixtures/result_sets/many_facets.txt
 - fixtures/result_sets/single.txt
-- fixtures/result_sets/single_facets.txt
 - fixtures/uids/many.txt
 - fixtures/uids/single.txt
 - gsa.gemspec
@@ -180,10 +176,14 @@ files:
 - lib/facade.rb
 - lib/gsa.rb
 - lib/gsa/exceptions.rb
-- lib/gsa/faceter.rb
 - lib/gsa/feeder.rb
 - lib/gsa/modules/injector.rb
 - lib/gsa/modules/xmlizer.rb
+- lib/gsa/readable_results.rb
+- lib/gsa/readable_results/readable_buckets.rb
+- lib/gsa/readable_results/readable_facets.rb
+- lib/gsa/readable_results/readable_metatags.rb
+- lib/gsa/readable_results/readable_result_sets.rb
 - lib/gsa/records_converter.rb
 - lib/gsa/search_converter.rb
 - lib/gsa/searcher.rb