drawbridge 0.2.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Hoitomt
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Drawbridge
+
+[![Code Climate](https://codeclimate.com/repos/51d44e1c13d637371b0595e6/badges/f566eeb7ce85f64716ec/gpa.png)](https://codeclimate.com/repos/51d44e1c13d637371b0595e6/feed)
+
+It draws the bridge between Endeca JSON bridge and IDG sites.
+
+Sometimes it's up, sometimes it's down.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'drawbridge'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install drawbridge
+
+## Setup
+
+To use:
+
+```ruby
+require 'drawbridge'
+
+Drawbridge.setup do |config|
+  config.bridge_url = "http://example.com:8080"
+  config.bridge_path = "BridgeAPIService_apt64/servlet/bridgeapi.json"
+  # e.g. ENDECA_DEBUG=true rackup
+  config.endeca_debug = ENV.fetch('ENDECA_DEBUG') { false }
+  # optional, default is 5
+  config.timeout = 5
+  # optional, default is to change ' into ' before JSON is parsed
+  config.skip_single_quote_encoding = true
+end
+```
+
+## Usage
+
+[Endeca documentation here](https://github.com/primedia/idg/wiki/Endeca)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+task :spec    => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.test_files = FileList['spec/*_spec.rb']
+end

data/drawbridge.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'drawbridge/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "drawbridge"
+  gem.version       = Drawbridge::VERSION
+  gem.authors       = ["Michael Hoitomt"]
+  gem.email         = ["mhoitomt@primedia.com"]
+  gem.description   = %q{Papi's Wife}
+  gem.summary       = %q{Papi's Replacement}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency('turn', '~> 0.8.3')
+  gem.add_development_dependency('mocha', '~> 0.13.0')
+  gem.add_development_dependency('rake')
+
+  gem.add_dependency('curb', '~> 0.8.4')
+  gem.add_dependency('oj', '~> 2.0.14')
+  gem.add_dependency('activesupport', '>= 3.2.9')
+end

data/lib/drawbridge.rb

@@ -0,0 +1,13 @@
+require 'active_support/core_ext/object/blank'
+require 'drawbridge/version'
+require 'drawbridge/config'
+require 'drawbridge/debug'
+require 'drawbridge/transformer'
+require 'drawbridge/adapter'
+require 'drawbridge/mapper'
+require 'drawbridge/request'
+require 'drawbridge/result'
+require 'drawbridge/refinement_scrubber'
+
+module Drawbridge
+end

data/lib/drawbridge/adapter.rb

@@ -0,0 +1,35 @@
+module Drawbridge
+  class Adapter
+    include Drawbridge::Transformer
+
+    attr_accessor :mapper
+
+    def initialize(mapper)
+      @mapper = mapper
+    end
+
+    def search_path
+      "#{Drawbridge.config.bridge_url}/#{Drawbridge.config.bridge_path}"
+    end
+
+    def build_all_query
+      params = {
+        select:             mapper.fields,
+        where:              mapper.record_search,
+        record_filters:     mapper.record_filters,
+        root_navigtion:     mapper.navigation,
+        expand_refinements: mapper.dimensions,
+        geo_filter:         mapper.geo_filters,
+        range_filter:       mapper.range_filter,
+        rollup:             mapper.rollup_key,
+        match_mode:         mapper.mode,
+        aggregate_offset:   mapper.aggregate_offset,
+        offset:             mapper.offset,
+        limit:              mapper.limit_param,
+        order:              mapper.sort_key
+      }
+      transform(params)
+    end
+
+  end
+end

data/lib/drawbridge/config.rb

@@ -0,0 +1,48 @@
+module Drawbridge
+  class Config
+    attr_accessor :data
+    def initialize(data={})
+      @data = {}
+      update!(data)
+    end
+
+    def update!(data)
+      data.each do |key, value|
+        self[key.to_sym] = value
+      end
+    end
+
+    def [](key)
+      @data[key.to_sym]
+    end
+
+    def []=(key, value)
+      @data[key.to_sym] = value
+    end
+
+    def keys
+      @data.keys
+    end
+
+    def to_hash
+      @data
+    end
+
+    def method_missing(sym, *args)
+      if sym.to_s =~ /(.+)=$/
+        self[$1] = args.first
+      else
+        self[sym]
+      end
+    end
+  end
+
+  class << self
+    attr_accessor :config, :data
+
+    def setup
+      self.config ||= Config.new
+      yield config
+    end
+  end
+end

data/lib/drawbridge/debug.rb

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+module Drawbridge
+  class Debug
+
+    def self.draw_line
+      @draw_line ||= "*"*80
+    end
+
+    # @params prepend_text: Endeca_Params
+    # @params debug_value: any object thaat can be inspected
+    def self.log(prepend_text, debug_value)
+      if Drawbridge.config.endeca_debug
+        puts "#{draw_line}\n#{prepend_text}: #{debug_value.inspect}\n#{draw_line}"
+      end
+    end
+
+  end
+end

data/lib/drawbridge/mapper.rb

@@ -0,0 +1,214 @@
+module Drawbridge
+  class Mapper
+
+
+    # Class Level accessor - Makes pretty
+    class << self
+      def where(params)
+        self.new.where(params)
+      end
+    end
+
+    def initialize
+    end
+
+    def where(params)
+      params.each do |k, v|
+        # regex should handle md5hash, and anything that doesn't have word characters
+        unless k[/\W|^\h+$/]
+          Mapper.send(:attr_accessor, k)
+          instance_variable_set("@#{k}", v)
+        end
+      end
+      self
+    end
+
+    def order_by(sort_string)
+      @sort_string = sort_string
+      self
+    end
+
+    def sort_args
+      return [] unless @sort_string
+      sort_string = @sort_string.split(',').join('^+^')
+      sort_array = parse_sort(sort_string.gsub('-', '^'))
+      sort_array
+    end
+
+    def all
+      adapter       = Drawbridge::Adapter.new(self)
+      query         = adapter.build_all_query
+      result_params = Request.perform adapter.search_path, query
+      Result.new(result_params)
+    end
+
+    def first
+      results = all
+      results.records.empty? ? nil : results.records.first
+    end
+
+    def default_refinements
+      []
+    end
+
+    # N
+    def navigation
+      (process_refinements(endeca_refinements) + default_refinements).flatten
+    end
+
+    # Ne - placeholder, might make more sense to hard-code in the adapter
+    def exposed_refinements
+      dimensions
+    end
+
+    # Ntt and Ntk
+    def record_search
+      record_key_values
+    end
+
+    # Ns
+    def sort_key
+      combined_sort
+    end
+
+    # Nr
+    def record_filters
+      []
+    end
+
+    # Nf
+    def range_filter
+      []
+    end
+
+    # Nf
+    def geo_filters
+      {}
+    end
+
+    # Nu
+    def rollup_key
+      ""
+    end
+
+    # No
+    def offset
+      page_param.to_i * limit_param.to_i
+    end
+
+    # Nao
+    def aggregate_offset
+      page_param.to_i * limit_param.to_i
+    end
+
+    def page_param
+      @page ? @page.to_i - 1 : 0
+    end
+
+    def limit_param
+      @limit ||= 20
+      @limit.to_i
+    end
+
+    def radius_param
+      @radius ||= @rad
+    end
+
+    def combined_sort
+      (base_sort + sort_args).flatten.uniq
+    end
+
+    def base_sort
+      []
+    end
+
+    def record_key_values
+      {}
+    end
+
+    def dimensions
+      []
+    end
+
+    def dimensions=(dimension_list)
+      dimension_list
+    end
+
+    def fields
+      []
+    end
+
+    def fields=(field_list)
+      field_list
+    end
+
+    def method_missing(meth)
+      nil
+    end
+
+    def name
+      ""
+    end
+
+    def mode
+      []
+    end
+
+    # converts refinements to int ids if they were base(36) encoded before
+    # @params - Array
+    # ["4j7"] => ['5875']
+    def process_refinements(refinements)
+      return [] if refinements.blank?
+
+      refinements.collect! do |ref|
+        ref.to_i(36).to_s
+      end
+    end
+
+    def parse_refinements(refinements)
+      refinements.collect! do |ref|
+        ref.to_s[/^\d+$/] ? ref.to_s : ref.to_i(36).to_s
+      end
+    end
+
+    protected
+
+    def refinements
+      @refinements ||= ""
+    end
+
+    def endeca_refinements
+      return [] if @refinements.nil?
+      split_out_dimension_codes(@refinements.dup) || []
+    end
+
+    def split_out_dimension_codes(refs)
+      nodes = refs.split('-').last
+      nodes = nodes.split(/\+|\s/) if nodes
+      nodes == ['miles'] ? nil : nodes
+    end
+
+    def parse_sort(sort)
+      return [] if sort.nil? || sort.empty?
+      [].tap do |a|
+        aray_sort = sort.split('^+^')
+        aray_sort.each do |s|
+          key, val = s.split('^')
+          a << {key => endeca_sort_value(val)}
+        end
+      end
+    end
+
+    def endeca_sort_value(value)
+      case value
+      when "asc"
+        return "0"
+      when "desc"
+        return "1"
+      else
+        return value
+      end
+    end
+
+  end
+end