endeca_xml 0.2.5

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org
+
+# Specify your gem's dependencies in compressit.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/endeca_xml.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'endeca_xml/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'endeca_xml'
+  s.version     = EndecaXml::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['sdomino']
+  s.email       = ['sdomino@pagodabox.com']
+  s.homepage    = 'http://www.pagodabox.com'
+  s.summary     = ''
+  s.description = ''
+
+  s.rubyforge_project = 'endeca_xml'
+  
+  s.add_dependency 'crack'
+  s.add_dependency 'builder'
+  
+  s.add_development_dependency 'rspec'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/endeca_xml/version.rb

@@ -0,0 +1,3 @@
+class EndecaXml
+  VERSION = "0.2.5"
+end

data/lib/endeca_xml.rb

@@ -0,0 +1,138 @@
+require 'builder'
+require 'crack'
+require 'net/http'
+require 'uri'
+
+class EndecaXml
+  
+  def initialize
+    @body = Builder::XmlMarkup.new(:indent => 2)
+  end
+  
+  # adds endeca base options to the endeca query (ex. endeca.add_base_options(['Dimensions', true], ['RecordsSet', true], ['BusinessRulesResult', true], ['AppliedFilters', true]))
+  def add_base_options(*options)
+    options.each do |option|
+      @body.tag!(option[0], option[1])
+    end
+  end
+  
+  # IMPORTANT: this option is mutually exclusive with the add_search option
+  # makes the endeca query a type nav (ex. endeca.add_nav('category', [1, 2, 3, 4, 5]))
+  def add_nav(type, ids)
+    case type
+    when 'category'
+      @body.SelectedDimensionalValueIds do
+        ids.each do |id|
+          @body.tag!('DimensionValueId', id)
+        end
+      end
+    when 'dimension'
+      @body.Category do
+        ids.each do |id|
+          @body.tag!('Category', id)
+        end
+      end
+    end
+  end
+  
+  # IMPORTANT: this option is mutually exclusive with the add_nav option
+  # makes the endeca query a type search (ex. endeca.add_searches(['searck-key', 'primary'], ['serach-term', 'gold']))
+  def add_searches(*options)
+    @body.Searches do
+      @body.Search do
+        options.each do |option|
+          @body.tag!(option[0], option[1])
+        end
+      end
+    end
+  end
+  
+  # add sorting to the endeca query (ex. endeca.add_sorting(['sort-key', 'p_price_sort'], ['sort-direction', 'Descending']))
+  def add_sorting(*options)
+    @body.Sorts do
+      @body.Sort do 
+        options.each do |option|
+          @body.tag!(option[0], option[1])
+        end
+      end
+    end
+  end
+  
+  # adds paging to the endeca query (ex. endeca.add_paging(['RecrodOffset', 0], ['RecordsPerPage', 10]))
+  def add_paging(*options)
+    options.each do |option|
+      @body.tag!(option[0], option[1])
+    end
+  end
+  
+  # adds advanced parameters to the endeca query (ex. endeca.add_advanced_parameters(['AggregationKey', 'p_group_id']))
+  def add_advanced_parameters(*parameters)
+    parameters.each do |parameter|
+      @body.tag!(parameter[0], parameter[1])
+    end
+  end
+  
+  # adds user profiles to the endeca query (ex. endeca.add_user_profiles([1, 2, 3, 4, 5]))
+  def add_user_profiles(profiles)
+    @body.UserProfiles do
+      profiles.each do |profile|
+        @body.tag!('UserProfile', profile)
+      end
+    end
+  end
+  
+  # FILTERS                   VALUE                   DEFAULT
+  # ---------------------------------------------------------
+  # Between
+  # LessThan
+  # LessThanOrEqual
+  # GreaterThan
+  # GreaterThanOrEqual
+  # GeocodeLessThan
+  # GeocodeGreaterThan
+  # GeocodeBetween
+    
+  # OPTIONS                   VALUE                   DEFAULT
+  # ---------------------------------------------------------
+  # attribute-name
+  # lower-bound
+  # upper-bound
+  # lat-long
+  # distance
+  def add_filters(*filters)
+    filters.each do |filter|
+      @body.RangeFilters do
+        @body.tag!(filter[0], filter[1]) do
+          filters[2].each do |option|
+            @body.tag!(option[0], option[1])
+          end
+        end
+      end
+    end
+  end
+  
+  # complete the endeca XML reqeust and send the request to the endeca API
+  def 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
+    
+    uri = URI.parse('http://workbench.deliverframework.net:4000/ws/main')
+    http = Net::HTTP.new(uri.host, uri.port)
+    
+    begin
+      request, @response = http.post(uri.path, query.target!, 'Content-type' => 'application/xml')
+    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => error
+      puts "ERROR: #{error.message}"
+    end
+  end
+  
+  # return the request response
+  def response
+    # parse XML response into an hash and return
+    return Crack::XML.parse(@response)
+  end
+  
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: endeca_xml
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.5
+platform: ruby
+authors: 
+- sdomino
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: crack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: ""
+email: 
+- sdomino@pagodabox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- endeca_xml.gemspec
+- lib/endeca_xml.rb
+- lib/endeca_xml/version.rb
+homepage: http://www.pagodabox.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: endeca_xml
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: ""
+test_files: []
+