idol-search 0.5.0 → 0.6.0

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/idol-search.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "idol-search"
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Shane Sherman"]
@@ -26,6 +26,8 @@ Gem::Specification.new do |s|
     "VERSION",
     "examples.rb",
     "idol-search.gemspec",
+    "lib/abridged_results_parser.rb",
+    "lib/filters.rb",
     "lib/hash_from_xml.rb",
     "lib/idol-search.rb",
     "test/helper.rb",

data/lib/abridged_results_parser.rb

@@ -0,0 +1,76 @@
+module Idol
+  
+  class AbridgedResultsParser
+    attr_accessor :result, :parsed_result
+    def initialize(result)
+      @result = result
+    end
+
+    def parse
+      fields = []
+      autoparsed_result = Hash.from_xml(@result)
+      xml = Nokogiri::XML(@result)
+
+      autn_ids = xml.xpath('//autn:abrid').first.content.split(",")
+      weights = xml.xpath('//autn:abrweight')[0].content.split(',').map{|w|w.to_i}
+
+      # parse out the field meta data
+      xml.xpath('//autn:abrfield').each do |field_data|
+        name = field_data.xpath('autn:abrname')[0].content
+        lengths = field_data.xpath('autn:abrlength')[0].content.split(',').map{|l| l.to_i }
+        values = field_data.xpath('autn:abrvalue')[0].content.strip
+        array_size_of_values = field_data.xpath('autn:abrnumber')[0].content.split(',').map{|n| n.to_i }
+        
+        current_values_position = 0
+        parsed_values = []
+
+        # the abridged results store everything in a big long string with the lengths to
+        # split on in a different comma seperated string. so it's parse out the values based
+        # on the value length
+        lengths.each do |length|
+          parsed_values << values[current_values_position, length]
+          current_values_position += length
+        end
+
+        # if the value is an array there's some additional magic that needs to be done to get the right array value
+        final_values = []
+        index = 0
+        array_size_of_values.each do |array_size|
+          if array_size == 1
+            final_values << parsed_values[index]
+          elsif array_size > 1
+            final_values << parsed_values[index, array_size]
+          end
+          index += 1
+        end
+
+        fields << {:name => name, :values => final_values} 
+      end
+
+      normalized_results = []
+      index = 0
+
+      # build a hash that mimics the hash from the unabridged normal results
+      autn_ids.each do |id|
+        result = {:id => id, :weight => weights[index], :content => {}}
+        fields.each do |field|
+          section, name = field[:name].split("/")
+          unless result[:content].has_key?(section)
+            result[:content][section] = {}
+          end
+          result[:content][section][name] = field[:values][index]
+        end
+        normalized_results << result
+        index += 1
+      end
+
+      response_data = autoparsed_result[:autnresponse][:responsedata]
+      response_data[:hit] = normalized_results
+      response_data.delete(:abrid)
+      response_data.delete(:abrweight)
+      response_data.delete(:abrfield)
+      @parsed_result = autoparsed_result
+      @parsed_result
+    end
+  end
+end

data/lib/filters.rb

@@ -0,0 +1,88 @@
+module Idol
+  module Conjunctions
+    AND = "AND"
+    OR = "OR"
+    NOT = "NOT"
+    BEFORE = "BEFORE"
+    AFTER = "AFTER"
+  end
+
+  module Filters
+    MATCH = "MATCH"
+    EQUAL = "EQUAL"
+    GREATER = "GREATER"
+    LESS = "LESS"
+    NRANGE = "NRANGE"
+    NOT_EQUAL = "NOTEQUAL"
+    WILD = "WILD"
+
+    MATCH_ALL = "MATCHALL"
+    EQUAL_ALL = "EQUALALL"
+
+    NOT_MATCH = "NOTMATCH"
+    NOT_STRING = "NOTSTRING"
+    NOT_WILD = "NOTWILD"
+
+    STRING = "STRING"
+    STRING_ALL = "STRINGALL"
+    SUBSTRING = "SUBSTRING"
+
+    TERM = "TERM"
+    TERM_ALL = "TERMALL"
+    TERM_EXACT = "TERMEXACT"
+    TERM_EXACT_ALL = "TERMEXACTALL"
+    TERM_EXACT_PHRASE = "TERMEXACTPHRASE"
+    TERM_PHRASE = "TERMPHRASE"
+  end
+
+  class FieldTextFilter
+    attr_accessor :fields, :specifier, :values
+    def initialize(fields, specifier, values)
+      @fields = fields.is_a?(Array) ? fields : [fields]
+      @specifier = specifier
+      @values = values.is_a?(Array) ? values : [values]
+    end
+
+    def to_idol_syntax
+      values_string = @values.map{|v| escape(v) }.join(",")
+      "#{specifier}{#{values_string}}:#{fields.join(':')}"
+    end
+
+    private
+    def escape(value)
+      value.gsub("&", "%26").gsub("\\", "%5C").gsub("%", "%25").gsub("{", "%257B").gsub("{", "%257D")
+    end
+  end
+
+  class FieldTextFilterCollection
+    include Enumerable
+    def initialize
+      @filters = []
+      @conjunctions = []
+    end
+
+    def <<(filter)
+      @filters << filter
+    end
+    
+    def add(filter, conjunction=Idol::Conjunctions::AND)
+      self << filter
+      @conjunctions << conjunction
+      return self
+    end
+
+    def each(&block)
+      @filters.each(&block)
+    end
+
+    def to_idol_syntax
+      idol_syntax = []
+      @filters.each_with_index do |filter, index|
+        idol_syntax << @conjunctions[index] unless index == 0
+        idol_syntax << filter.to_idol_syntax
+      end
+      idol_syntax.join(" ").strip
+    end
+
+  end
+end

data/lib/idol-search.rb

@@ -1,42 +1,9 @@
 require 'curb'
 require_relative 'hash_from_xml'
-module Idol
-
-  module Conjunctions
-    AND = "AND"
-    OR = "OR"
-    NOT = "NOT"
-    BEFORE = "BEFORE"
-    AFTER = "AFTER"
-  end
-
-  module Filters
-    MATCH = "MATCH"
-    EQUAL = "EQUAL"
-    GREATER = "GREATER"
-    LESS = "LESS"
-    NRANGE = "NRANGE"
-    NOT_EQUAL = "NOTEQUAL"
-    WILD = "WILD"
-
-    MATCH_ALL = "MATCHALL"
-    EQUAL_ALL = "EQUALALL"
-
-    NOT_MATCH = "NOTMATCH"
-    NOT_STRING = "NOTSTRING"
-    NOT_WILD = "NOTWILD"
-
-    STRING = "STRING"
-    STRING_ALL = "STRINGALL"
-    SUBSTRING = "SUBSTRING"
+require_relative 'abridged_results_parser'
+require_relative 'filters'
 
-    TERM = "TERM"
-    TERM_ALL = "TERMALL"
-    TERM_EXACT = "TERMEXACT"
-    TERM_EXACT_ALL = "TERMEXACTALL"
-    TERM_EXACT_PHRASE = "TERMEXACTPHRASE"
-    TERM_PHRASE = "TERMPHRASE"
-  end
+module Idol
 
   module OptionalParams
     def has_optional_params(*params)
@@ -44,18 +11,13 @@ module Idol
 
         # write the value to params
         define_method :"#{opt_param}" do |value|
-          instance_variable_set("@#{opt_param}", value)
-          self.class.send(:attr_accessor, opt_param)
-          @parameters[opt_param.gsub("_", "")] = value
+          @parameters[opt_param.to_sym] = value
           return self
         end
-
       end
     end
   end
 
-
-
   module BasicIdolFunctionality
     attr_accessor :url, :filters, :parameters, :raw_results
     attr_reader :action
@@ -67,6 +29,10 @@ module Idol
       @filters = FieldTextFilterCollection.new
     end
 
+    def to_hash
+      @parameters
+    end
+
     def filters
       @filters
     end    
@@ -103,86 +69,12 @@ module Idol
       end
 
       @parameters.each do |name, values|
-        post_fields << Curl::PostField.content(name, values)
+        post_fields << Curl::PostField.content(name.gsub("_", ""), values)
       end
       post_fields
     end
   end
 
-  class AbridgedResultsParser
-    attr_accessor :result, :parsed_result
-    def initialize(result)
-      @result = result
-    end
-
-    def parse
-      fields = []
-      autoparsed_result = Hash.from_xml(@result)
-      xml = Nokogiri::XML(@result)
-
-      autn_ids = xml.xpath('//autn:abrid').first.content.split(",")
-      weights = xml.xpath('//autn:abrweight')[0].content.split(',').map{|w|w.to_i}
-
-      # parse out the field meta data
-      xml.xpath('//autn:abrfield').each do |field_data|
-        name = field_data.xpath('autn:abrname')[0].content
-        lengths = field_data.xpath('autn:abrlength')[0].content.split(',').map{|l| l.to_i }
-        values = field_data.xpath('autn:abrvalue')[0].content.strip
-        array_size_of_values = field_data.xpath('autn:abrnumber')[0].content.split(',').map{|n| n.to_i }
-        
-        current_values_position = 0
-        parsed_values = []
-
-        # the abridged results store everything in a big long string with the lengths to
-        # split on in a different comma seperated string. so it's parse out the values based
-        # on the value length
-        lengths.each do |length|
-          parsed_values << values[current_values_position, length]
-          current_values_position += length
-        end
-
-        # if the value is an array there's some additional magic that needs to be done to get the right array value
-        final_values = []
-        index = 0
-        array_size_of_values.each do |array_size|
-          if array_size == 1
-            final_values << parsed_values[index]
-          elsif array_size > 1
-            final_values << parsed_values[index, array_size]
-          end
-          index += 1
-        end
-
-        fields << {:name => name, :values => final_values} 
-      end
-
-      normalized_results = []
-      index = 0
-
-      # build a hash that mimics the hash from the unabridged normal results
-      autn_ids.each do |id|
-        result = {:id => id, :weight => weights[index], :content => {}}
-        fields.each do |field|
-          section, name = field[:name].split("/")
-          unless result[:content].has_key?(section)
-            result[:content][section] = {}
-          end
-          result[:content][section][name] = field[:values][index]
-        end
-        normalized_results << result
-        index += 1
-      end
-
-      response_data = autoparsed_result[:autnresponse][:responsedata]
-      response_data[:hit] = normalized_results
-      response_data.delete(:abrid)
-      response_data.delete(:abrweight)
-      response_data.delete(:abrfield)
-      @parsed_result = autoparsed_result
-      @parsed_result
-    end
-  end
-
   class Query
     extend OptionalParams
     include BasicIdolFunctionality
@@ -206,55 +98,5 @@ module Idol
     end
   end
 
-  class FieldTextFilter
-    attr_accessor :fields, :specifier, :values
-    def initialize(fields, specifier, values)
-      @fields = fields.is_a?(Array) ? fields : [fields]
-      @specifier = specifier
-      @values = values.is_a?(Array) ? values : [values]
-    end
-
-    def to_idol_syntax
-      values_string = @values.map{|v| escape(v) }.join(",")
-      "#{specifier}{#{values_string}}:#{fields.join(':')}"
-    end
-
-    private
-    def escape(value)
-      value.gsub("&", "%26").gsub("\\", "%5C").gsub("%", "%25").gsub("{", "%257B").gsub("{", "%257D")
-    end
-  end
-
-  class FieldTextFilterCollection
-    include Enumerable
-    def initialize
-      @filters = []
-      @conjunctions = []
-    end
-
-    def <<(filter)
-      @filters << filter
-    end
-    
-    def add(filter, conjunction=Idol::Conjunctions::AND)
-      self << filter
-      @conjunctions << conjunction
-      return self
-    end
-
-    def each(&block)
-      @filters.each(&block)
-    end
-
-    def to_idol_syntax
-      idol_syntax = []
-      @filters.each_with_index do |filter, index|
-        idol_syntax << @conjunctions[index] unless index == 0
-        idol_syntax << filter.to_idol_syntax
-      end
-      idol_syntax.join(" ").strip
-    end
-
-  end
 
 end

data/test/test_idol-search.rb

@@ -125,8 +125,20 @@ END_DATA
     should "parse the data correctly" do
       assert_equal 6, @parsed_result[:autnresponse][:responsedata][:hit].count
     end
+  end
 
+  context "a idol query with various options set" do
+    setup do
+      @query = Idol::Query.new("http://autonomy.moxiesoft.com")
+      @query.text("test").print_fields("id,summary").combine("simple").max_results(500)
+    end
 
+    should "properly set the options" do
+      assert_equal "test", @query.to_hash[:text]
+      assert_equal "id,summary", @query.to_hash[:print_fields]
+      assert_equal "simple", @query.to_hash[:combine]
+      assert_equal 500, @query.to_hash[:max_results]
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idol-search
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -140,6 +140,8 @@ files:
 - VERSION
 - examples.rb
 - idol-search.gemspec
+- lib/abridged_results_parser.rb
+- lib/filters.rb
 - lib/hash_from_xml.rb
 - lib/idol-search.rb
 - test/helper.rb
@@ -159,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3334920589825193263
+      hash: -2690028528026669019
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: