endeca_xml 0.5.6 → 0.7.5

data/README.rdoc

@@ -45,6 +45,64 @@ A lot more work has been done since the previous version. endeca_xml now constru
 
 This example is a complete example. It is not necessary to include anything that you don't intend to use (ie. blank or empty hash's/values). If you don't need an option, don't include the input field, and if you don't need a value within an option don't include it.
 
+This is the command that would send the above request:
+  EndecaXml.request(params[:endeca])
+
+Below are examples of how you could access the response data:
+
+Records:
+
+  EndecaXml.records.each do |record|
+    puts "---------- BEGIN RECORD"
+    puts "RECORD: #{record.inspect}"
+    puts "---------- END"
+  end
+
+Breadcrumbs:
+
+  EndecaXml.breadcrumbs.each do |crumb|
+    puts "---------- BEGIN CRUMB"
+    puts "CRUMB: #{crumb.inspect}"
+    puts "---------- END"
+  end
+
+Dimensions:
+
+  EndecaXml.dimensions.each do |dimension|
+    puts "---------- BEGIN DIMENSION"
+    puts "DIMENSION: #{dimension.inspect}"
+    puts "DIMENSION VALUES: #{dimension.dimensionvalues}"
+    puts "DIMENSION VALUES ARRAY: #{dimension.dimension_values}"
+    puts "---------- END"
+  end
+
+Rules:
+
+  EndecaXml.rules.each do |rule|
+    puts "---------- BEGIN RULE"
+    puts "RULE: #{rule.inspect}"
+    puts "RULE PROPERTIES: #{rule.properties}"
+    puts "RULE PROPERTIES_ARRAY: #{rule.properties_array}"
+    puts "RULE RECORDS: #{rule.records}"
+    puts "---------- END"
+  end
+
+Filters:
+
+  EndecaXml.filters.each do |filter|
+    puts "---------- BEGIN FILTER"
+    puts "FILTER: #{filter.inspect}"
+    puts "---------- END"
+  end
+  
+Each object will have associated instance variables that will allow you directly call any value on that object (the values below aren't actual response values):
+
+  EndecaXml.records.each do |record|
+    record.name
+    record.price
+    etc...
+  end
+
 == TODO
 
 * (complete) Pass all parameters into the initializer and have EndecaXml deconstruct the url and reconstruct it as XML rather than having the developer use each method individually.

data/endeca_xml.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['sdomino']
   s.email       = ['sdomino@pagodabox.com']
-  s.homepage    = 'http://www.pagodabox.com'
+  s.homepage    = 'http://github.com/sdomino/endeca_xml'
   s.summary     = 'endeca_xml provides an interface between your web application and the thanxmedia Endeca XML API'
   s.description = 'endeca_xml provides an interface between your web application and the thanxmedia Endeca XML API'
 

data/lib/endeca_xml/crumb.rb

@@ -0,0 +1,14 @@
+module EndecaXml
+  class Crumb
+
+    def initialize(crumb)
+      crumb.each do |key, value|
+        self.instance_variable_set(:"@#{key.downcase}", value)
+      end
+    end
+    
+    # is there anyway to do this dynamically?
+    attr_reader :name, :original_id, :id
+
+  end
+end

data/lib/endeca_xml/dimension.rb

@@ -0,0 +1,16 @@
+module EndecaXml
+  class Dimension
+    
+    def initialize(dimension)
+      dimension.each do |key, value|
+        self.instance_variable_set(:"@#{key.downcase}", value)
+      end
+      
+      @dimension_values = []
+    end
+    
+    # is there anyway to do this dynamically?
+    attr_reader :name, :id, :group_name, :hasmore, :dimensionvalues, :dimension_values
+
+  end
+end

data/lib/endeca_xml/record.rb

@@ -0,0 +1,14 @@
+module EndecaXml
+  class Record
+
+    def initialize(record)
+      record.each do |key, value|
+        self.instance_variable_set(:"@#{key.downcase}", value)
+      end
+    end
+    
+    # is there anyway to do this dynamically?
+    attr_reader :p_name, :p_category_id, :p_dax_item_number, :p_image, :p_price_retail, :p_price_sale, :p_price_sort, :p_url_detail
+
+  end
+end

data/lib/endeca_xml/rule.rb

@@ -0,0 +1,17 @@
+module EndecaXml
+  class Rule
+    
+    def initialize(rule)
+      rule.each do |key, value|
+        self.instance_variable_set(:"@#{key.downcase}", value)
+      end
+      
+      @properties_array   = []
+      @records            = []
+    end
+    
+    # is there anyway to do this dynamically?
+    attr_reader :title, :id, :style, :zone, :recordcount, :recordset, :properties, :properties_array, :records
+
+  end
+end

data/lib/endeca_xml/version.rb

@@ -1,3 +1,3 @@
-class EndecaXml
-  VERSION = "0.5.6"
+module EndecaXml
+  VERSION = "0.7.5"
 end

data/lib/endeca_xml.rb

@@ -1,3 +1,5 @@
+Dir["#{File.dirname(__FILE__)}/endeca_xml/*"].each { |file| require(file)}
+
 require 'builder'
 # require 'crack' # NOTE: see .gemspec
 require 'crackoid'
@@ -20,9 +22,9 @@ require 'uri'
 #   <input type="submit" />
 # </form>
 
-class EndecaXml
+module EndecaXml
 
-  def initialize(params)
+  def self.request(params)
     @body = Builder::XmlMarkup.new(:indent => 2)
 
     # puts "PARAMS: #{params}"
@@ -44,22 +46,49 @@ class EndecaXml
     send_request
   end
 
-  def host(options)
+  def self.records
+    @records
+  end
+  
+  def self.breadcrumbs
+    @breadcrumbs
+  end
+  
+  def self.dimensions
+    @dimensions
+  end
+  
+  def self.rules
+    @business_rules
+  end
+  
+  def self.filters
+    @applied_filters
+  end
+  
+  private
+  
+  ### XML REQUEST ###
+  
+  # constructs the http request
+  def self.host(options)
     options.each do |key, value|
       @uri = URI.parse(value)
     end
     @http = Net::HTTP.new(@uri.host, @uri.port)
   end
-
-  def base(options)
+  
+  # adds BASE OPTIONS to the XML request
+  def self.base(options)
     # puts "BASE: #{options}"
     options.each do |key, value|
       @body.tag!(key, value)
     end
     # print @body.target!
   end
-
-  def nav(options)
+  
+  # adds NAV to the XML request
+  def self.nav(options)
     # puts "NAV: #{options}"
     case options['type']
     when 'category'
@@ -79,8 +108,9 @@ class EndecaXml
     end
     # puts @body.target!
   end
-
-  def search(options)
+  
+  # adds SEARCHES to the XML request
+  def self.search(options)
     # puts "SEARCH: #{options}"
     @body.Searches do
       @body.Search do
@@ -91,8 +121,9 @@ class EndecaXml
     end
     # puts @body.target!
   end
-
-  def sort(options)
+  
+  # adds SORTS to the XML request
+  def self.sort(options)
     # puts "SORT: #{options}"
     @body.Sorts do
       @body.Sort do
@@ -103,24 +134,27 @@ class EndecaXml
     end
     # puts @body.target!
   end
-
-  def paging(options)
+  
+  # adds PAGING to the XML request
+  def self.paging(options)
     # puts "PAGING: #{options}"
     options.each do |key, value|
       @body.tag!(key, value)
     end
     # puts @body.target!
   end
-
-  def parameters(options)
+  
+  # adds ADVANCED PARAMETERS to the XML request
+  def self.parameters(options)
     # puts "PARAMETERS: #{options}"
     options.each do |key, value|
       @body.tag!(key, value)
     end
     # puts @body.target!
   end
-
-  def profiles(options)
+  
+  # adds PROFILES to the XML request
+  def self.profiles(options)
     # puts "PROFILES: #{options}"
     @body.UserProfiles do
       options.each do |key, value|
@@ -132,8 +166,9 @@ class EndecaXml
     end
     # puts @body.target!
   end
-
-  def filters(options)
+  
+  # adds FILTERS to the XML request
+  def self.filters(options)
     # puts "FILTERS: #{options}"
     @body.RangeFilters do
       options.each do |key, value|
@@ -148,98 +183,91 @@ class EndecaXml
     # puts @body.target!
   end
 
-  def get_records
+  # complete the endeca XML reqeust and send the request to the endeca API
+  def self.send_request
+    # insert all of the XML blocks that have been included in the request into the endeca Query XML tag
+    query = Builder::XmlMarkup.new(:indent => 2)
+    query.Query do
+      query << @body.target!
+    end
+
+    # puts "QUERY: #{query.target!}"
+
+    begin
+      request, response = @http.post(@uri.path, query.target!, 'Content-type' => 'application/xml')
+      handle_response(Crackoid::XML.parse(response))
+    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => error
+      puts "ERROR: #{error.message}"
+    end
+  end
+
+  # get the request response and parse it into an hash
+  def self.handle_response(response)
+    # puts "RESPONSE: #{response}"
+    @response = response['Final']
+
+    self.build_data
+  end
+  
+  def self.build_data
+    self.build_records
+    self.build_breadcrumbs
+    self.build_dimensions
+    self.build_business_rules
+    # self.build_applied_filters
+  end
+  
+  # builds the RECORDS hash
+  @records = []
+  def self.build_records
     @response['RecordsSet']['Record'].each do |record|
-      record.each do |key, value|
-        puts "#{key}: #{value}"
-      end
+      @records.push(EndecaXml::Record.new(record))
     end unless @response['RecordsSet'].nil?
   end
-
-  def get_breadcrumbs
+  
+  # builds the BREADCRUMBS hash
+  @breadcrumbs = []
+  def self.build_breadcrumbs
     @response['Breadcrumbs']['Breads'].each do |crumb|
-      crumb.each do |key, value|
-        puts "#{key}: #{value}"
-      end
+      @breadcrumbs.pusn(EndecaXml::Crumb.new(crumb))
     end unless @response['Breadcrumbs'].nil?
   end
-
-  def get_dimensions
+  
+  # builds the DIMENSIONS hash
+  @dimensions = []
+  def self.build_dimensions
     @response['Dimensions']['Dimension'].each do |dimension|
+      @dimension = EndecaXml::Dimension.new(dimension)
       dimension.each do |key, value|
-        puts "#{key}: #{value}"
-        if key == 'DimensionValues'
-          if value['DimensionValue'].instance_of?(Array)
-            value['DimensionValue'].each do |value|
-              value.each do |key, value|
-                puts "  #{key}: #{value}"
-              end
-            end
-          elsif value['DimensionValue'].instance_of?(Hash)
-            value['DimensionValue'].each do |key, value|
-              puts "  #{key}: #{value}"
-            end
-          end
-        end
+        value['DimensionValue'].each do |value|
+          @dimension.dimension_values.push(EndecaXml::Dimension.new(value))
+        end if key == 'DimensionValues'
       end
+      @dimensions.push(@dimension)
     end unless @response['Dimensions'].nil?
   end
-
-  def get_business_rules
+  
+  # builds the BUSINESS RULES hash
+  @business_rules = []
+  def self.build_business_rules
     @response['BusinessRulesResult']['BusinessRules']['BusinessRule'].each do |rule|
+      @business_rule = EndecaXml::Rule.new(rule)
       rule.each do |key, value|
-        puts "#{key}: #{value}"
-        value.each do |key, value|
-          puts "  #{key}: #{value}"
-        end if key == 'properties'
-
+        @business_rule.properties_array.push(EndecaXml::Rule.new(value)) if key == 'properties'
         if key == 'RecordSet'
-          if value.instance_of?(Array)
-            value['Record'].each do |record|
-              record.each do |key, value|
-                puts "  #{key}: #{value}"
-              end
-            end
-          elsif value.instance_of?(Hash)
-            value['Record'].each do |key, value|
-              puts "  #{key}: #{value}"
-            end
-          end
+          @business_rule.records.push(EndecaXml::Record.new(value['Record'])) unless value.nil?
         end
       end
+      @business_rules.push(@business_rule)
     end unless @response['BusinessRulesResult'].nil?
   end
-
-  def get_applied_filters
+  
+  # builds the APPLIED FILTERS hash
+  @applied_filters = []
+  def self.build_applied_filters
     @response['AppliedFilters'].each do |filter|
-      puts "FILTER: #{filter}"
+      # puts "FILTER: #{filter}"
     end unless @response['AppliedFilters'].nil?
   end
 
-  private
-
-  # complete the endeca XML reqeust and send the request to the endeca API
-  def send_request
-    # insert all of the XML blocks that have been included in the request into the endeca Query XML tag
-    query = Builder::XmlMarkup.new(:indent => 2)
-    query.Query do
-      query << @body.target!
-    end
-
-    # puts "QUERY: #{query.target!}"
-
-    begin
-      request, response = @http.post(@uri.path, query.target!, 'Content-type' => 'application/xml')
-      handle_response(Crackoid::XML.parse(response))
-    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => error
-      puts "ERROR: #{error.message}"
-    end
-  end
-
-  # get the request response and parse it into an hash
-  def handle_response(response)
-    puts "RESPONSE: #{response}"
-    # @response = response['Final']
-  end
-
 end

metadata

@@ -2,7 +2,7 @@
 name: endeca_xml
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.6
+  version: 0.7.5
 platform: ruby
 authors: 
 - sdomino
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-05 00:00:00 Z
+date: 2011-07-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: crackoid
@@ -51,8 +51,13 @@ files:
 - Rakefile
 - endeca_xml.gemspec
 - lib/endeca_xml.rb
+- lib/endeca_xml/crumb.rb
+- lib/endeca_xml/dimension.rb
+- lib/endeca_xml/filter.rb
+- lib/endeca_xml/record.rb
+- lib/endeca_xml/rule.rb
 - lib/endeca_xml/version.rb
-homepage: http://www.pagodabox.com
+homepage: http://github.com/sdomino/endeca_xml
 licenses: []
 
 post_install_message: