mdex_client 0.0.1

data/lib/mdex_client/mdata/record.rb

@@ -0,0 +1,59 @@
+require 'mdex_client/mdata/node'
+
+module MDEXClient
+  module MData
+    class Record < Node
+      class Attributes < Hash
+        def initialize(*args)
+          super(*args)
+          
+          @dimension_value_ids = {}
+          @dimension_ids = {}
+        end
+        
+        def dimension_value_id(key)
+          @dimension_value_ids[key]
+        end
+        
+        def dimension_id(key)
+          @dimension_ids[key]
+        end
+        
+        def dimension_keys
+          @dimension_ids.keys
+        end
+        
+        def property_keys
+          keys - dimension_keys
+        end
+        
+        def <<(node)
+          key = node["Key"]
+          self[key] = node.text
+          
+          if node.name == "AssignedDimensionValue"
+            @dimension_value_ids[key] = node["Id"]
+            @dimension_ids[key] = node["DimensionId"]
+          end
+        end
+      end
+    
+      attr_accessor :id, :attributes, :snippets
+      
+      def initialize(element_or_hash=nil)
+        @attributes = Attributes.new
+        super(element_or_hash)
+      end
+      
+      def initialize_from_element!
+        @id = @element["Id"]
+        
+        xpath("mdata:Attributes/mdata:AssignedDimensionValue | mdata:Attributes/mdata:Property").each do |attribute|
+          @attributes << attribute  
+        end
+        
+        @snippets = property_list("mdata:Snippets/mdata:Snippet")
+      end
+    end
+  end
+end

data/lib/mdex_client/mdata/refinement_config.rb

@@ -0,0 +1,44 @@
+require 'mdex_client/mdata/node'
+
+module MDEXClient
+  module MData
+    class RefinementConfig < Node
+      attr_accessor :dimension_value_id, :maximum_dimension_value_count
+      attr_writer :expose, :limit_dimension_values, :order_by_record_count
+    
+      def initialize_from_element!
+        @dimension_value_id = @element["DimensionValueId"].to_i
+        @expose = (@element["Expose"] == "true")
+        @limit_dimension_values = (@element["LimitDimensionValues"] == "true")
+        @order_by_record_count = (@element["OrderByRecordCount"] == "true")
+        
+        if element["MaximumDimensionValueCount"]
+          @maximum_dimension_value_count = @element["MaximumDimensionValueCount"].to_i
+        end
+      end
+      
+      def expose?
+        @expose
+      end
+      
+      def limit_dimension_values?
+        @limit_dimension_values
+      end
+      
+      def order_by_record_count?
+        @order_by_record_count
+      end
+      
+      def write_xml!(xml)
+        attrs = { "DimensionValueId" => dimension_value_id }
+        %w(Expose LimitDimensionValues OrderByRecordCount).each do |attribute|
+          value = self.send("#{attribute.underscore}?")
+          attrs[attribute] = value.to_s unless value.nil?
+        end
+        attrs["MaximumDimensionValueCount"] = maximum_dimension_value_count unless maximum_dimension_value_count.nil?
+        
+        xml.mdata :RefinementConfig, attrs
+      end
+    end
+  end
+end

data/lib/mdex_client/mdata/search.rb

@@ -0,0 +1,36 @@
+require 'mdex_client/mdata/node'
+
+module MDEXClient
+  module MData
+    class Search < Node
+      MODES = %w(All AllAny AllPartial Any Boolean Partial PartialMax Unknown)
+    
+      attr_accessor :key, :query, :relevance_ranking_strategy, :mode, :snippet_length, 
+        :enable_snippeting
+        
+      def write_xml!(xml)
+        attributes = { "Key" => key }
+        %w(RelevanceRankingStrategy Mode SnippetLength EnableSnippeting).each do |attribute|
+          value = send(attribute.underscore)
+          attributes[attribute] = value.to_s if value
+        end
+        
+        xml.mdata :Search, attributes, query
+      end
+      
+      def mode=(new_mode)
+        if new_mode.nil?
+          @mode = nil
+        else
+          new_mode_normalized = new_mode.to_s.classify
+          
+          if MODES.include?(new_mode_normalized)
+            @mode = new_mode_normalized
+          else
+            raise "#{new_mode} is not a valid mode.  Valid modes are: #{MODES.join(", ")}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mdex_client/mdata/sort.rb

@@ -0,0 +1,26 @@
+require 'mdex_client/mdata/node'
+
+module MDEXClient
+  module MData
+    class Sort < Node
+      attr_accessor :key, :direction, :reference_geocode
+      
+      def initialize_from_element!
+        @key = element["Key"]
+        @direction = element["Direction"]
+        
+        rgc = element.xpath("mdata:ReferenceGeocode").first
+        @reference_geocode = Geocode.new(rgc) if rgc
+      end
+      
+      def write_xml!(xml)
+        xml.mdata :Sort, "Key" => key, "Direction" => direction do |xml|
+          if reference_geocode
+            xml.mdata :ReferenceGeocode, "Latitude" => reference_geocode.latitude,
+              "Longitude" => reference_geocode.longitude
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mdex_client/version.rb

@@ -0,0 +1,3 @@
+module MDEXClient
+  VERSION = "0.0.1"
+end

data/mdex_client.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mdex_client/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nat Budin"]
+  gem.email         = ["natbudin@gmail.com"]
+  gem.description   = %q{A Rubyish API client for Endeca's MDEX search engine, using the XQuery API}
+  gem.summary       = %q{Search client for Endeca MDEX engine}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "mdex_client"
+  gem.require_paths = ["lib"]
+  gem.version       = MDEXClient::VERSION
+  
+  gem.add_dependency "savon"
+  gem.add_dependency "nokogiri"
+  gem.add_development_dependency "rspec", "~> 2.6.0"
+  gem.add_development_dependency "rack", "~> 1.3.0"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "simplecov-rcov"
+  gem.add_development_dependency "webmock", "~> 1.7.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# SimpleCov needs to be started first
+require 'simplecov'
+require 'simplecov-rcov'
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+SimpleCov.start do
+  add_filter '.bundle/'
+end
+
+# Set up webmock
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: mdex_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nat Budin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: &70271123124680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70271123124680
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70271123124260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70271123124260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70271123123720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70271123123720
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70271123123040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *70271123123040
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70271123122520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70271123122520
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: &70271123121840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70271123121840
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70271123121100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70271123121100
+description: A Rubyish API client for Endeca's MDEX search engine, using the XQuery
+  API
+email:
+- natbudin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/mdex_client.rb
+- lib/mdex_client/active_record/extensions.rb
+- lib/mdex_client/client.rb
+- lib/mdex_client/fake_mdex.rb
+- lib/mdex_client/fake_mdex/fake_mdex.rb
+- lib/mdex_client/fake_mdex/mdex.wsdl
+- lib/mdex_client/fake_mdex/mdex_response.xml
+- lib/mdex_client/mdata/aggregate_record.rb
+- lib/mdex_client/mdata/aggregation_key.rb
+- lib/mdex_client/mdata/dimension.rb
+- lib/mdex_client/mdata/dimension_value.rb
+- lib/mdex_client/mdata/geocode.rb
+- lib/mdex_client/mdata/navigation_query.rb
+- lib/mdex_client/mdata/navigation_result.rb
+- lib/mdex_client/mdata/node.rb
+- lib/mdex_client/mdata/range_filter.rb
+- lib/mdex_client/mdata/record.rb
+- lib/mdex_client/mdata/refinement_config.rb
+- lib/mdex_client/mdata/search.rb
+- lib/mdex_client/mdata/sort.rb
+- lib/mdex_client/version.rb
+- mdex_client.gemspec
+- spec/spec_helper.rb
+homepage: ''
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Search client for Endeca MDEX engine
+test_files:
+- spec/spec_helper.rb
+has_rdoc: