threetaps-client 0.5.1

data/spec/client/posting_client_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe PostingClient do
+  before(:all) do
+  end
+
+  before(:each) do
+    @posting_client = PostingClient.new
+  end
+
+  it "should return Posting object" do
+    stub_get_and_json_decode
+    @posting_client.get_posting("").is_a?(Posting).should be_true
+  end
+
+  # no spec for creation - see tests
+
+  it "should return UpdateResponse object" do
+    stub_post_and_json_decode
+    UpdateResponse.should_receive(:from_hash).with([])
+    post = mock "Posting" , :to_json_for_update=>""
+    @posting_client.update_posting(post).class == UpdateResponse.class#).should be_true
+  end
+
+  it "should return DeleteResponse object" do
+    stub_post_and_json_decode
+    DeleteResponse.should_receive(:from_hash).with([])
+    @posting_client.delete_posting("").class == DeleteResponse.class
+  end
+
+  it "should return boolean value" do
+    stub_post_and_json_decode
+    @posting_client.exists_posting(mock("")).should be_true
+  end
+end
+

data/spec/client/reference_client_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ReferenceClient do
+  before(:each) do
+    @reference_client = ReferenceClient.new
+  end
+
+  it "should send GET request and create Categories array from result" do
+    categories_response = mock "categories_array"
+    Category.should_receive(:from_array).and_return categories_response
+
+    @reference_client.get_categories.should == categories_response
+  end
+
+  it "should send GET request and create Category from result" do
+    category_response = mock "category"
+    category_code = "VAUT"
+    Category.should_receive(:from_hash).and_return category_response
+
+    @reference_client.get_category(category_code).should == category_response
+  end
+
+  it "should send GET request and create Locations array from result" do
+    locations_response = mock "locations_array"
+    Location.should_receive(:from_array).and_return locations_response
+
+    @reference_client.get_locations.should == locations_response
+  end
+
+  it "should send GET request and create Sources array from result" do
+    sources_response = mock "sources_array"
+    Source.should_receive(:from_array).and_return sources_response
+
+    @reference_client.get_sources.should == sources_response
+  end
+
+end

data/spec/client/search_client_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SearchClient do
+  before(:each) do
+    @search_client = SearchClient.new
+  end
+
+  it "should send GET request and create SearchResponse from result" do
+    search_request = mock "search_request"
+    search_request.should_receive(:query_params)
+    search_response = mock "search_response"
+    SearchResponse.should_receive(:new).and_return search_response
+
+    @search_client.search(search_request).should == search_response
+  end
+
+  it "should send GET request and create RangeResponse from result" do
+    stub_get_and_json_decode
+    range_request = mock "range_request"
+    range_request.should_receive(:query_params)
+    range_response = mock "range_response"
+    RangeResponse.should_receive(:from_array).and_return range_response
+
+    @search_client.range(range_request).should == range_response
+  end
+
+  it "should send GET request and create SummaryResponse from result" do
+    summary_request = mock "summary_request"
+    summary_request.should_receive(:query_params)
+    summary_response = mock "summary_response"
+    SummaryResponse.should_receive(:from_hash).and_return summary_response
+
+    @search_client.summary(summary_request).should == summary_response
+  end
+
+  it "should send GET request and create CountResponse from result" do
+    search_request = mock "search_request"
+    search_request.should_receive(:query_params)
+    count_response = mock "count_response"
+    CountResponse.should_receive(:new).and_return count_response
+
+    @search_client.count(search_request).should == count_response
+  end
+  it "should send GET request and create BestMatchResponse from result" do
+    keywords = ""
+    bestmatch_response = mock "bestmatch_response"
+    BestMatchResponse.should_receive(:from_hash).and_return bestmatch_response
+
+    @search_client.best_match(keywords).should == bestmatch_response
+  end
+
+end
+

data/spec/client/status_client_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe StatusClient do
+  before(:each) do
+    @status_client = StatusClient.new
+  end
+
+  it "should send POST request and create Message from result" do
+    stub_post_and_json_decode
+    posting = mock "posting"
+    message = mock "message"
+    status_update_request = mock "status_update_request"
+    Message.should_receive(:new).and_return message
+    posting.should_receive(:status).and_return status_update_request
+    status_update_request.should_receive(:event).and_return ""
+
+    @status_client.update_status(posting).should == message
+  end
+
+  it "should send POST request and create GetResponse from result" do
+    stub_post_and_json_decode
+    postings = mock "posting"
+    postings.should_receive(:to_json_for_status_client)
+    array = mock "array"
+    GetStatusResponse.should_receive(:from_array).and_return array
+
+    @status_client.get_status(postings).should == array
+  end
+
+  it "should send GET request and create Message from result" do
+    stub_get_and_json_decode
+    message = mock "message"
+    Message.should_receive(:new).and_return message
+
+    @status_client.system_status.should == message
+  end
+
+end
+

data/spec/dto/geocoder/geocoder_response_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+describe GeocoderResponse do
+  #before(:each) do
+  #    @geocoder_response = Geocoder.new
+  #end
+  it "should initialize multiple objects form array" do
+    array = [1,2,3]
+    array.size.times do
+      GeocoderResponse.should_receive(:from_hash)
+    end
+    GeocoderResponse.from_array(array)
+  end
+
+end

data/spec/dto/search/search_request_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe SearchRequest do
+  before(:each) do
+    @search_request = SearchRequest.new
+  end
+
+  it "should return valid query params" do
+    @search_request.rpp = 20
+    @search_request.page = 14
+    #@search_request.source = 'SRC'
+    @search_request.category = 'STOO'
+    #@search_request.location = 'LOC'
+    #@search_request.heading = 'HD'
+    #@search_request.body = 'BD'
+    @search_request.text = 'BMW'
+    #@search_request.external_id = 'EXID'
+    #@search_request.start = Date.new(2011,4,10)
+    #@search_request.end = Date.new(2011,4,10)
+    @search_request.annotations = Hash["Status", 'for+free']
+    #@search_request.trusted_annotations = Hash["TR1", '1000', "TR2", '2000']
+    @search_request.retvals = ["category", "location", "heading", "externalURL", "timestamp", "postKey", "source", "image"]
+    @search_request.query_params.should_not == ""
+  end
+end
+

data/spec/dto/search/search_response_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe SearchResponse do
+  before(:each) do
+    @search_response = SearchResponse.new
+  end
+
+  it "should desc" do
+   
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'supermodel'
+require 'curb'
+require 'threetaps-client'
+require 'cgi'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end
+
+def stub_json_decode
+  ActiveSupport::JSON.stub!(:decode).and_return []
+end
+
+def stub_get_and_json_decode
+  Curl::Easy.stub!(:new).and_return mock("Request", :perform => nil, :body_str => "")
+  stub_json_decode
+end
+
+def stub_post_and_json_decode
+  Curl::Easy.stub!(:http_post).and_return mock("Request", :perform => nil, :body_str => "")
+  stub_json_decode
+end

data/test/client/test_client.rb

@@ -0,0 +1,11 @@
+require 'helper'
+
+class TestClient < Test::Unit::TestCase
+  should "test GET request" do
+
+  end
+
+  should "test POST request" do
+
+  end
+end

data/test/client/test_geocoder_client.rb

@@ -0,0 +1,43 @@
+require 'helper'
+
+class TestGeocoderClient < Test::Unit::TestCase
+  should "test coordinats geocode" do
+    geocoder_client = GeocoderClient.new
+    geocoder_request = GeocoderRequest.new
+    geocoder_request.latitude = '37.77493'
+    geocoder_request.longitude = '-122.41942'
+    request = geocoder_request
+    response = geocoder_client.geocode(request)
+    assert_equal Array, response.class
+    assert_equal GeocoderResponse, response.first.class
+    assert_equal "CAZ", response.first.code
+  end
+
+  should "test city geocode" do
+    geocoder_client = GeocoderClient.new
+    geocoder_request = GeocoderRequest.new
+    geocoder_request.city = 'los angeles'
+    request = geocoder_request
+    response = geocoder_client.geocode(request)
+    assert_equal Array, response.class
+    assert_equal GeocoderResponse, response.first.class
+    assert_equal "LAX",  response.first.code
+  end
+
+  should "test both city and geocode" do
+    geocoder_client = GeocoderClient.new
+    geocoder_request1 = GeocoderRequest.new
+    geocoder_request1.latitude = '37.77493'
+    geocoder_request1.longitude = '-122.41942'
+
+    geocoder_request2 = GeocoderRequest.new
+    geocoder_request2.city = 'los angeles'
+
+    request = [geocoder_request1, geocoder_request2]
+    response = geocoder_client.geocode(request)
+    assert_equal Array, response.class
+    assert_equal GeocoderResponse, response.first.class
+    assert_equal "CAZ", response.first.code
+    assert_equal "LAX", response[1].code
+  end
+end

data/test/client/test_posting_client.rb

@@ -0,0 +1,88 @@
+require 'helper'
+
+class TestPostingClient < Test::Unit::TestCase
+  should "test single posting creation and deletion" do
+    keys = []
+    client = PostingClient.new
+    posting = Posting.new(
+      :source => "3TAPS",
+      :heading => "Svitla posting",
+      :timestamp => Time.now
+    )
+    response = client.create_posting(posting)
+    assert_equal Array, response.class
+    assert_equal CreateResponse, response.first.class
+    assert_nil response.first.error
+    posting_key = response.first.post_key
+    posting.heading = "Svitla posting +++#{rand(100)}+++"
+    posting.postKey = posting_key
+    posting.body = "posting"
+
+    response = client.update_posting(posting)
+    assert_equal true, response.success
+
+    keys << posting_key
+
+    posting = Posting.new(
+      :source => "3TAPS",
+      :heading => "Svitla posting",
+      :timestamp => Time.now
+    )
+    response = client.create_posting(posting)
+    assert_equal Array, response.class
+    assert_equal CreateResponse, response.first.class
+    assert_nil response.first.error
+    posting_key = response.first.post_key
+
+    keys << posting_key
+
+    response = client.delete_posting(keys)
+    assert_equal DeleteResponse, response.class
+    assert_equal true, response.success
+  end
+
+  should "test multiple postings creation and deletion" do
+    client = PostingClient.new
+    posting1 = Posting.new(
+      :source => "3TAPS",
+      :heading => "Svitla posting1",
+      :timestamp => Time.now
+    )
+    posting2 = Posting.new(
+      :source => "3TAPS",
+      :heading => "Svitla posting2",
+      :timestamp => Time.now
+    )
+    response = client.create_posting([posting1, posting2])
+    assert_equal Array, response.class
+    assert_equal CreateResponse, response.first.class
+    assert_nil response.first.error
+
+    posting_key = response[0].post_key
+    posting1.postKey = posting_key
+    posting_key = response[1].post_key
+    posting2.postKey = posting_key
+    posting1.body = "posting1"
+    posting2.body = "posting2"
+    response = client.update_posting([posting1, posting2])
+    assert_equal true, response.success
+
+    keys = [posting1.postKey, posting2.postKey]
+    response = client.delete_posting(keys)
+    assert_equal DeleteResponse, response.class
+    assert_equal true, response.success
+  end
+
+  should "test posting retrieval" do
+    client = PostingClient.new
+    posting = client.get_posting("BF87BFW")
+    assert_equal Posting, posting.class
+    assert_equal "BF87BFW", posting.postKey
+  end
+
+  should "test posting deletion" do
+    client = PostingClient.new
+    result = client.delete_posting('post_key')
+    assert_equal DeleteResponse, result.class
+  end
+end

data/test/client/test_reference_client.rb

@@ -0,0 +1,32 @@
+require 'helper'
+
+class TestReferenceClient < Test::Unit::TestCase
+  should "test get categories" do
+    client = ReferenceClient.new
+    categories = client.get_categories
+    assert_equal Array, categories.class
+    assert_equal Category, categories.first.class
+  end
+
+  should "test get category" do
+    client = ReferenceClient.new
+    category = client.get_category("VAUT")
+    assert_equal "VAUT", category.code
+    assert_equal "Autos", category.category
+    assert_equal "Vehicles", category.group
+  end
+
+  should "test get locations" do
+    client = ReferenceClient.new
+    locations = client.get_locations
+    assert_equal Array, locations.class
+    assert_equal Location, locations.first.class
+  end
+
+  should "test get sources" do
+    client = ReferenceClient.new
+    sources = client.get_sources
+    assert_equal Array, sources.class
+    assert_equal Source, sources.first.class
+  end
+end

data/test/client/test_search_client.rb

@@ -0,0 +1,56 @@
+require 'helper' 
+
+class TestSearchClient < Test::Unit::TestCase
+  should "get the range request result" do
+    range_request = RangeRequest.new
+    search_request = SearchRequest.new
+    search_request.category = 'VAUT'
+    search_request.annotations = {:Make => "porsche"}
+    range_request.search_request = search_request
+    range_request.fields = ['price', 'year']
+    client = SearchClient.new
+    range_response = client.range(range_request)
+    assert_equal RangeResponse, range_response.class
+    assert_equal range_request.fields, range_response.ranges.collect{|r| r['field']}
+  end
+
+  should "get the search request result" do
+    search_request = SearchRequest.new
+    search_request.category = 'VAUT'
+    search_request.rpp = 2
+    search_request.annotations = {:Make => "porsche"}
+    client = SearchClient.new
+    search_response = client.search(search_request)
+    assert_equal SearchResponse, search_response.class
+    assert_equal Array, search_response.results.class
+    assert_equal Posting, search_response.results.first.class
+  end
+
+  should "get the count request result" do
+    search_request = SearchRequest.new
+    search_request.category = 'VAUT'
+    search_request.annotations = {:Make => "porsche"}
+    client = SearchClient.new
+    count_response = client.count(search_request)
+    assert_equal CountResponse, count_response.class
+    assert_not_equal nil , count_response.count
+
+  end
+
+  should "get the summary result" do
+    search_request = SearchRequest.new
+    search_request.category = 'VAUT'
+    search_request.annotations = {:Make => "porsche"}
+    client = SearchClient.new
+    summary_response = client.summary(search_request)
+    assert_equal SummaryResponse, summary_response.class
+  end
+
+  should "get the best match result" do
+    search_keywords = "iPad,Apple,iPhone"
+    client = SearchClient.new
+    best_match_response = client.best_match(search_keywords)
+    assert_equal BestMatchResponse, best_match_response.class
+    assert_equal 'SELE', best_match_response.category
+  end
+end

data/test/client/test_status_client.rb

@@ -0,0 +1,49 @@
+require 'helper'
+
+class TestStatusClient < Test::Unit::TestCase
+
+  should "get status for posting with BD9FHQC postKey" do
+    posting_client = PostingClient.new
+    existing_postings = posting_client.get_posting("BD9FHQC")
+    client = StatusClient.new
+    response = client.get_status(existing_postings)
+    assert_equal Array, response.class
+  end
+
+  should "test update status" do
+    posting_client = PostingClient.new
+    status_client = StatusClient.new
+    posting = posting_client.get_posting("BD9FHQC")
+    error = Message.from_hash(:code => 666, :message => "UFO posting error")
+    posting.status.errors << error
+    posting.status.attributes = {:postKey => "TESTKEY", :message => "UFO test message"}
+    posting.status.event = 'lost'
+    assert_equal String, posting.status.to_params.class
+    update_response = status_client.update_status(posting)
+    assert_equal Message , update_response.class
+    assert_equal 200 , update_response.code
+  end
+
+  should "test get status" do
+    search_request = SearchRequest.new
+    search_request.category = 'VAUT'
+    search_request.annotations = {:Make => "porsche"}
+    search_request.rpp = 2
+    search_request.page = 4
+    search_request.retvals = ["category", "location", "heading", "externalURL", "timestamp", "postKey", "source", "image", "externalID"]
+
+    client = SearchClient.new
+    search_response = client.search(search_request)
+    existing_postings = search_response.results
+    client = StatusClient.new
+    response = client.get_status(existing_postings)
+    assert_equal Array, response.class
+  end
+  
+  should "test system status" do
+    client = StatusClient.new
+    status_response = client.system_status
+    assert_equal Message, status_response.class
+  end
+
+end

data/test/dto/geocoder/test_geocoder_request.rb

@@ -0,0 +1,16 @@
+require 'helper'
+
+class TestGeoCoderRequest < Test::Unit::TestCase
+  should "receive params and perform them" do
+    geocoder_request = GeocoderRequest.new
+    geocoder_request.latitude = '12'
+    geocoder_request.longitude = '12'
+    geocoder_request.country = 'US'
+    geocoder_request.state = 'CA'
+    geocoder_request.city = 'Palo Alto'
+    geocoder_request.locality = 'unknown'
+    geocoder_request.postal = '90001'
+    geocoder_request.text = 'custom message here'
+    assert_equal String, geocoder_request.to_params.class
+  end
+end

data/test/dto/geocoder/test_geocoder_response.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+class TestGeoCoderResponse < Test::Unit::TestCase
+  should "receive an array and perform it into hash" do
+    geocoder_response = GeocoderResponse.from_array([['TEST','123.9876','-123.98765'],['TEST','123.9876','-123.98765']])
+    assert_equal Array, geocoder_response.class
+    geocoder_response.each do |geocode|
+      assert_equal GeocoderResponse, geocode.class
+      assert_equal 'TEST', geocode.code
+      assert_equal '123.9876', geocode.latitude
+      assert_equal '-123.98765', geocode.longitude
+    end
+  end
+end

data/test/dto/search/test_best_match_response.rb

@@ -0,0 +1,10 @@
+require 'helper'
+
+class TestBestMatchResponse < Test::Unit::TestCase
+  should "get numResults attribute" do
+    response = BestMatchResponse.from_hash("numResults" => 200, "category" => "VAULT")
+    assert_equal 200, response.numResults
+    assert_equal 200, response.num_results
+    assert_equal "VAULT", response.category
+  end
+end

data/test/dto/search/test_range_request.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+class TestRangeRequest < Test::Unit::TestCase
+  should "return valid http params string" do
+    search_request = SearchRequest.new()
+    search_request.category = 'VAUT'
+    search_request.annotations = {:Make => "porsche"}
+    range_request = RangeRequest.from_hash(:search_request => search_request, :fields => ["year","price"])
+    assert_equal RangeRequest,  range_request.class
+    assert_equal SearchRequest,  range_request.search_request.class
+    assert_equal String,  range_request.query_params.class
+  end
+end

data/test/dto/status/test_status_update_request.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+class TestStatusUpdateRequest < Test::Unit::TestCase
+  should "Test update status request methods" do
+    posting = Posting.new(:externalID => "1234567890", :source => '3TAPS')
+    assert_equal "source:'3TAPS', externalID:1234567890", posting.to_json_for_status_client
+    assert_equal StatusUpdateRequest, posting.status.class
+    assert_equal Array, posting.status.errors.class
+    assert_equal Hash, posting.status.attributes.class
+
+    error = Message.from_hash(:code => 666, :message => "UFO posting error")
+    posting.status.errors << error
+    posting.status.attributes = {:postKey => "TESTKEY", :message => "UFO test message"}
+    posting.status.event = 'lost'
+    assert_equal String, posting.status.to_params.class
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'threetaps-client'
+
+class Test::Unit::TestCase
+end

data/test/models/test_posting.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestPosting < Test::Unit::TestCase
+  should "create posting with empty images array" do
+    posting = Posting.new
+    assert_equal [], posting.images
+    assert_equal({}, posting.annotations)
+  end
+
+  should "create posting with empty status attribute" do
+    posting = Posting.new
+    assert_equal StatusUpdateRequest, posting.status.class
+    assert_equal String, posting.status.event.class
+    assert_equal Hash, posting.status.attributes.class
+    assert_equal Array, posting.status.errors.class
+  end
+
+  should "create posting with not empty images array" do
+    posting = Posting.new(
+      :images => ["image_path"],
+      :history => ["old_posting"],
+      :annotations => {'annotation' => "value"}
+    )
+    assert_equal ["image_path"], posting.images
+    assert_equal ["old_posting"], posting.history
+    assert_equal({'annotation' => "value"}, posting.annotations)
+  end
+end