drawbridge 0.2.0

data/lib/drawbridge/version.rb

@@ -0,0 +1,3 @@
+module Drawbridge
+  VERSION = '0.2.0'
+end

data/spec/debug_spec.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+describe Drawbridge::Debug do
+  it "should return line" do
+    Drawbridge::Debug.draw_line.must_equal "*"*80
+  end
+
+  it "should output debugg" do
+    Drawbridge.config.expects(:endeca_debug).returns(true)
+    Drawbridge::Debug.expects(:puts).at_most(3)
+
+    Drawbridge::Debug.log 'test', []
+  end
+
+  it "should not do any debugging" do
+    Drawbridge.config.expects(:endeca_debug).returns(false)
+    Drawbridge::Debug.expects(:puts).never
+
+    Drawbridge::Debug.log 'test', []
+
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,18 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "drawbridge"
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/mock'
+require 'mocha/setup'
+
+begin
+  require 'turn'
+rescue LoadError
+  warn 'could not load turn gem'
+end
+
+Drawbridge.setup do |config|
+  config.endeca_debug = ENV.fetch('ENDECA_DEBUG') { false }
+end

data/spec/refinement_scrubber_spec.rb

@@ -0,0 +1,68 @@
+require 'helper'
+
+describe Drawbridge::RefinementScrubber do
+
+  describe '::scrub' do
+
+    describe 'aggregated refinements' do
+      let(:refinements) { Drawbridge::RefinementScrubber.scrub(aggr_refinements) }
+      let(:properties){ refinements[2]['dimensionvalues'].first['dimvalueproperties'] }
+
+      it 'should add an aggrbins key' do
+        properties['aggrbins'].wont_be_nil
+      end
+
+      it 'should copy the data from DGraph.AggrBins' do
+        properties['aggrbins'].must_equal properties['dgraph.aggrbins']
+      end
+    end
+
+    describe 'non-aggregated refinements' do
+      let(:refinements) {Drawbridge::RefinementScrubber.scrub(non_aggr_refinements)}
+
+    end
+  end
+
+  def aggr_refinements
+    [
+      {"dimensionid"=>5885, "dimensionname"=>"price_range"},
+      {"dimensionid"=>3, "dimensionname"=>"bedrooms"},
+      {
+        "dimensionid"=>5974,
+        "dimensionname"=>"_telco",
+        "dimensionvalues"=>
+        [
+          {
+            "dimvaluename"=>"Time Warner Cable",
+            "dimvalueproperties"=>
+             {
+               "dgraph.aggrbins"=>"10",
+               "sortname"=>"Time Warner",
+               "sortfield"=>"timewarner"
+             },
+           "numberofrecords"=>"332",
+           "dimvalueid"=>5978},
+          {
+            "dimvaluename"=>"Verizon FiOS",
+            "dimvalueproperties"=>
+             {
+               "dgraph.aggrbins"=>"33",
+               "sortbar"=>"vzn_sort_bar",
+               "sortname"=>"Verizon",
+               "sortfield"=>"verizon"
+             },
+            "numberofrecords"=>"627",
+            "dimvalueid"=>5976
+          }
+        ]
+      }
+    ]
+  end
+
+  def non_aggr_refinements
+    [
+      {"dimensionid"=>5885, "dimensionname"=>"price_range"},
+      {"dimensionid"=>3, "dimensionname"=>"bedrooms"}
+    ]
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,84 @@
+require 'helper'
+
+describe Drawbridge::Request do
+
+  let(:uri) { 'http://example.com/some-api-path' }
+  let(:query) {  'query=foo' }
+  let(:default_timeout) { 5 }
+  let(:success_code) { 200 }
+  let(:not_found_code) { 404 }
+
+  describe ".perform" do
+
+    it "should initialize new Object and perform a request" do
+      request = MiniTest::Mock.new
+      request.expect :perform, {}
+      Drawbridge::Request.expects(:new).with(uri, query, default_timeout).returns(request)
+      Drawbridge::Request.perform(uri, query)
+    end
+
+  end
+
+  describe "#perform" do
+
+    let(:request) { Drawbridge::Request.new uri, query, default_timeout }
+
+    it "should only make one request" do
+      request.expects(:get_response).once.returns({})
+      request.expects(:handle_response).once.returns({})
+      request.perform
+    end
+
+    describe "sucess" do
+
+      before do
+        mock_curb =  MiniTest::Mock.new
+        mock_curb.expect :response_code, success_code
+        mock_curb.expect :body_str, "{\"foo\":\"bar'\t\"}"
+        Curl::Easy.expects(:perform).returns(mock_curb)
+      end
+
+      it "should return json parsed data" do
+        results = request.perform
+        results['foo'].must_equal 'bar''
+      end
+
+      it "does not encode single quotes when skipped" do
+        Drawbridge.config.skip_single_quote_encoding = true
+        results = request.perform
+        results['foo'].must_equal "bar'"
+      end
+
+    end
+
+    describe "unsucess" do
+      let(:mock_curb) { MiniTest::Mock.new }
+
+      it "should return default json" do
+        mock_curb.expect :response_code, not_found_code
+        mock_curb.expect :body_str, ""
+        mock_curb.expect :nil?, true
+        Curl::Easy.expects(:perform).returns(mock_curb)
+        request.perform.must_equal Drawbridge::Request::ResultsError
+      end
+
+      it "should throw RequestError when making HTTP request" do
+        Curl::Easy.expects(:perform).raises(StandardError)
+        lambda{ request.send(:get_response) }.must_raise Drawbridge::Request::RequestError
+      end
+
+      it 'should throw Curl::Err::TimeoutError when request times out' do
+        Curl::Easy.expects(:perform).raises(Curl::Err::TimeoutError)
+        lambda { request.send(:get_response) }.must_raise Curl::Err::TimeoutError
+      end
+
+      it "should throw Oj::ParseError" do
+        mock_curb.expect :response_code, success_code
+        mock_curb.expect :body_str, "!@!@#@NoData|*}"
+        lambda{ request.send(:handle_response, mock_curb) }.must_raise Drawbridge::Request::RequestError
+      end
+    end
+
+  end
+
+end

data/spec/result_spec.rb

@@ -0,0 +1,388 @@
+require 'helper'
+
+describe Drawbridge::Result do
+
+  describe "aggregated results" do
+    let(:result) { Drawbridge::Result.new(aggregate_result_params) }
+
+    describe 'refinements' do
+      it "should not be empty" do
+        result.refinements.wont_be_empty
+      end
+
+      it "should include dimensionid" do
+        result.refinements.first['dimensionid'].must_equal 5885
+      end
+
+      it "should be downcased" do
+        result.refinements.first['dimensionid'].wont_be_nil
+      end
+
+      it "should downcase inner elements" do
+        result.refinements[2]['dimensionvalues'].first['dimvaluename'].wont_be_nil
+      end
+    end
+
+    describe "#meta_info" do
+      it "should not be empty" do
+        result.meta_info.wont_be_empty
+      end
+
+      it "should include pagenumber" do
+        result.meta_info['pagenumber'].must_equal 1
+      end
+    end
+
+    describe "#records" do
+      it "should not be empty" do
+        result.records.wont_be_empty
+      end
+
+      it "should access property" do
+        result.records.first['endeca_id'].must_equal '000001'
+      end
+
+      it "should include DerivedProperties in a record" do
+        result.records.first['bed_high'].must_equal '2'
+      end
+
+      describe 'geocode' do
+        it "should convert miles" do
+          result.records.first['miles_to_geocode'].must_equal "9.3"
+        end
+
+        it "should convert kilometers" do
+          result.records.first['kilometers_to_geocode'].must_equal "14.9669"
+        end
+      end
+
+      it 'should include matched_on' do
+        result.records.first['matched_on'].must_equal({'showapartment' => '1'})
+      end
+    end
+
+    describe "#breadcrumbs" do
+      let(:breadcrumbs) { result.breadcrumbs.first }
+
+      it "should not be empty" do
+        breadcrumbs.wont_be_empty
+      end
+
+      it "should include DimensionName" do
+        breadcrumbs['dimensionname'].must_equal '_source'
+      end
+
+      it "should include DimensionName" do
+        breadcrumbs['dimensionname'].must_equal '_source'
+      end
+
+      describe "DimensionValues" do
+        let(:dim_values) { breadcrumbs['dimensionvalues'].first }
+
+        it "should have DimValueName" do
+          dim_values['dimvaluename'].must_equal 'APTGUIDE'
+        end
+
+        it "should have DimValueID" do
+          dim_values['dimvalueid'].must_equal 5875
+        end
+      end
+    end
+
+    describe "#to_stats_hash" do
+      let(:hash) { result.to_stats_hash }
+
+      it "should have meta_info" do
+        hash[:meta_info].wont_be_empty
+      end
+
+      it "should have breadcrumbs" do
+        hash[:breadcrumbs].wont_be_empty
+      end
+
+      it "should have refinements" do
+        hash[:refinements].wont_be_empty
+      end
+    end
+
+  end
+
+  describe "non-aggregated results" do
+
+    let(:result) { Drawbridge::Result.new(no_aggregate_result_params) }
+
+    describe 'refinements' do
+      it "should not be empty" do
+        result.refinements.wont_be_empty
+      end
+
+      it "should include dimensionid" do
+        result.refinements.first['dimensionid'].must_equal 5885
+      end
+    end
+
+    describe "meta_info" do
+      it "should not be empty" do
+        result.meta_info.wont_be_empty
+      end
+
+      it "should include pagenumber" do
+        result.meta_info['pagenumber'].must_equal 1
+      end
+
+      it 'should include matched_on' do
+        result.records.first['matched_on'].must_equal nil
+      end
+
+      it "should be downcased" do
+        result.meta_info['pagenumber'].must_equal 1
+      end
+    end
+
+    describe "records" do
+      it "should not be empty" do
+        result.records.wont_be_empty
+      end
+
+      it "should asseess property" do
+        result.records.first['endeca_id'].must_equal '000001'
+      end
+    end
+
+    describe "empty results" do
+      it "should not throw an exception" do
+        result = Drawbridge::Result.new({})
+        result.records.must_equal []
+      end
+
+    end
+  end
+
+  describe "Endeca Error" do
+    { 404 => "error_result_404", 500 => "error_result_500" }.each do |status, responze|
+      describe "STATUS #{status}" do
+        let(:result) { Drawbridge::Result.new(send(responze)) }
+
+        it "should have Breadcrumbs" do
+          result.breadcrumbs.must_equal []
+        end
+
+        it "should have MetaInfo" do
+          result.meta_info.must_equal({})
+        end
+
+        it "should have Refinements" do
+          result.refinements.must_equal []
+        end
+
+        it "should have status" do
+          result.status.must_equal status
+        end
+      end
+    end
+  end
+
+  describe '#parse_matched_on' do
+    let(:result) { Drawbridge::Result.new({}) }
+    let(:record) {
+      { 'DGraph.WhyDidItMatch' => ["City: Chapel Hill",
+                                   "communitystatename: North Carolina"] }
+    }
+
+    it 'hashifies multi-item array of DGraph.WhyDidItMatch results' do
+      expected = { 'City' => 'Chapel Hill',
+                   'communitystatename' => 'North Carolina' }
+      result.send(:parse_matched_on, record).must_equal expected
+    end
+  end
+
+  private
+
+
+    def error_result_500
+      {
+        "methodResponse" => {
+          "fault" => {
+            "value" => {
+              "faultCode" => "-1",
+              "faultString" => "Error establishing connection to retrieve Navigation \
+              Engine request 'http://localhost:15400/graph?node=5875+5922+5966&select=\
+              agappointmentactive|attuverse|avgoverallrating|bathscat|bedbathleads|\
+              bedbathleadsreq|bold|brighthouse|charter|communityvideo|communityvideourl|\
+              comvideoheight|comvideowidth|coupon|coupontext|defaulttreatment|directv|\
+              emercialurl|endeca_id|floorplans|fpoptout|geocode|hashdfp|hashdphotos|hdtour\
+              |hdtoururl|hdtoururlmobile|hdvideo|hdvideourl|hidecurrentrentspecialsreq|\
+              iscollege|iscorporate|isincome|isluxury|ismilitary|ispet|issenior|\
+              largecustomcoupon|latitude|leadconfirmemail|leadmovedate|leadmovedatecal|\
+              leadmovedatecalreq|leadmovedatereq|leadmovereason|leadmovereasonreq|\
+              leadphonerequired|leadpricerange|leadpricerangereq|listingbedhigh|listingbedlow|\
+              listingid|listingpoints|listingpricehigh|listingpricelow|listingseopath|\
+              listingtier|livechat|longitude|mgtcodescription|mgtcoid|mktratingson|\
+              neighborhoods|numratings|officehours|overallratings|photoplus|photos|\
+              propertycity|propertyname|propertystatelong|propertyzip|ratings|semtollfree|\
+              showapartment|sortpricehigh|sortpricelow|sources|telcoadcode|timewarner|tour|\
+              tourend|tourheight|tourstart|toururl|tourwidth|twonameleads|verizon|webtollfree|\
+              xfinity|xfinityprefix|zipcode&group=5948+5923+5974+23+3+24+5951+4+22+5885+8+5967+\
+              25&sort=searchonly|asc||isapartment|desc||pri_isnewyork|desc||sort_isnewyork|desc|\
+              |geocode(40.7204,-73.9946)|asc&groupby=listingid&offset=0&nbins=20&allbins=1&attrs=\
+              showapartment|1&pred=geocode%7cGCLT+40.7204%2c-73.9946+16.093470878864444&\
+              irversion=640'. Connection refused"
+            }
+          }
+        }
+      }
+    end
+
+    def error_result_404
+      {
+        "methodResponse" => {
+          "fault" => {
+            "value" => {
+              "faultCode" => "-1",
+              "faultString" => "HTTP Error 404 - Navigation Engine not able to process request \
+              'http://localhost:15400/graph?node=0&groupby=somethingwrong&offset=0&nbins=10&allbins=1&irversion=640'."
+            }
+          }
+        }
+      }
+    end
+
+    def aggregate_result_params
+      {
+        "MetaInfo"=>{
+          "PageNumber"=>1
+        },
+        "Breadcrumbs" => [
+          {
+            "DimensionName" => "_source",
+            "DimensionValues" => [
+              {
+                "DimValueName" => "APTGUIDE",
+                "DimValueID" => 5875
+              }
+            ],
+            "Type" => "Navigation"
+          }
+        ],
+        "AggrRecords"=>[
+          {
+            "Records"=>[
+              {
+                "RecordSpec"=>"000001",
+                "Dimensions"=>{
+                  "propertyzip"=>["99689"],
+                  "propertycity"=>["Yakutat"]
+                },
+                "Properties"=>{
+                  "leadphonerequired"=>"1",
+                  "endeca_id"=>"000001",
+                  "miles_to_geocode(40.720400,-73.994600)" => "9.3",
+                  "kilometers_to_geocode(40.720400,-73.994600)" => "14.9669",
+                  "DGraph.WhyDidItMatch" => "showapartment: 1"
+                }
+              }
+            ],
+            "RecordCount"=>3,
+            "DerivedProperties"=>{
+              "bed_high"=>"2",
+              "bed_low"=>"1"
+            }
+          },
+          {
+            "Records"=>[
+              {
+                "RecordSpec"=>"000002",
+                "Dimensions"=>{
+                  "propertyzip"=>["99689"],
+                  "propertycity"=>["Yakutat"]
+                },
+                "Properties"=>{
+                  "leadphonerequired"=>"1",
+                  "endeca_id"=>"000002"
+                }
+              }
+            ],
+            "RecordCount"=>3,
+            "DerivedProperties"=>{
+              "bed_high"=>"2",
+              "bed_low"=>"1"
+            }
+          }
+        ],
+        "Refinements"=>[
+          {
+            "DimensionID"=>5885,
+            "DimensionName"=>"price_range"
+          },
+          {
+            "DimensionID"=>3,
+            "DimensionName"=>"bedrooms"
+          },
+          {
+            "DimensionID" => 5974,
+            "DimensionName" => "_telco",
+            "DimensionValues" =>
+            [
+              {
+                "DimValueName" => "Time Warner Cable",
+                "DimValueProperties" => {"DGraph.AggrBins" => "10","sortname" => ["Time Warner"],"sortfield" => ["timewarner"]},
+                "NumberofRecords" => "332",
+                "DimValueID" => 5978
+              },
+              {
+                "DimValueName" => "Verizon FiOS",
+                "DimValueProperties" => {"DGraph.AggrBins" => "33","sortbar" => ["vzn_sort_bar"],"sortname" => ["Verizon"],"sortfield" => ["verizon"]},
+                "NumberofRecords" => "627",
+                "DimValueID" => 5976
+              }
+            ]
+          }
+        ]
+      }
+    end
+
+    def no_aggregate_result_params
+      {
+        "MetaInfo"=>{
+          "PageNumber"=>1
+        },
+        "Records"=>[
+          {
+            "RecordSpec"=>"000001",
+            "Dimensions"=>{
+              "propertyzip"=>["99689"],
+              "propertycity"=>["Yakutat"]
+            },
+            "Properties"=>{
+              "leadphonerequired"=>"1",
+              "endeca_id"=>"000001",
+              "miles_to_geocode(40.720400,-73.994600)" => "9.3",
+              "kilometers_to_geocode(40.720400,-73.994600)" => "14.9669"
+            }
+          },
+          {
+            "RecordSpec"=>"000002",
+            "Dimensions"=>{
+              "propertyzip"=>["99689"],
+              "propertycity"=>["Yakutat"]
+            },
+            "Properties"=>{
+              "leadphonerequired"=>"1",
+              "endeca_id"=>"000002"
+            }
+          }
+        ],
+        "Refinements"=>[
+          {
+            "DimensionID"=>5885,
+            "DimensionName"=>"price_range"
+          },
+          {
+            "DimensionID"=>3,
+            "DimensionName"=>"bedrooms"
+          }
+        ]
+      }
+    end
+
+end