threetaps-client 0.5.1

data/lib/dto/search/best_match_response.rb

@@ -0,0 +1,20 @@
+# Class BestMatchResponse represents server response on +best_match+ Search API
+# request. Server response is sent to initializer which creates objects with
+# attributes +category+, +numResults+ accessible via getters:
+# * +category+
+# * +num_results+
+# * +numResults+
+#
+# Examples:
+#
+#  response = BestMatchResponse.new("category" => "VAUT", "numResults" => 20)
+#  response.category     # => "VAUT"
+#  response.numResults   # => 20
+#  response.num_results  # => 20
+#
+class BestMatchResponse < Struct.new(:category, :numResults) do
+    def num_results
+      numResults
+    end
+  end
+end

data/lib/dto/search/count_response.rb

@@ -0,0 +1,9 @@
+# Class CountResponse represents server response on +count+ Search API
+# request. Server response is sent to initializer which creates objects with
+# attribute +count+ accessible via getter:
+#
+#  response = CountResponse.new("count" => 20)
+#  response.count  # => 20
+#
+class CountResponse < Struct.new(:count)
+end

data/lib/dto/search/range_request.rb

@@ -0,0 +1,23 @@
+# Returns the minium and maximum values currently in 3taps for the given fields
+# that match the given Common Search Criteria. The purpose of the range method
+# is to provide developers with sensible values for range-based UI filters.
+#
+# 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 = ['year', 'price']
+#
+class RangeRequest < Struct.new(:search_request, :fields)
+
+  def add_field(field)
+    fields << field
+  end
+
+  def query_params
+    query_params = search_request.query_params
+    query_params += "fields=#{CGI.escape(fields.join(','))}"
+    query_params
+  end
+end

data/lib/dto/search/range_response.rb

@@ -0,0 +1,26 @@
+# Class RangeResponse represents server response on +range+ Search API
+# request. Server response is sent to +from_array+ method which creates objects
+# with attribute +ranges+ accessible via getter:
+#
+#  response = RangeResponse.from_array(...)
+#  response.ranges     # => Array
+#
+class RangeResponse < Struct.new(:ranges) 
+  
+  # Class Range represents elements of server response on +range+ Search API
+  # request. Server response is sent to initializer which creates object
+  # with attributes +field+, +min+, +max+ accessible via getters:
+  #
+  #  range = Range.new(...)
+  #  range.field   # => Array
+  #  range.min     # => 10
+  #  range.max     # => 20
+  #
+  class Range < Struct.new(:field, :min, :max)
+  end
+
+  # Method +from_array+ creates RangeResponse object with a set of Range objects.
+  def self.from_array(json)
+    self.from_hash(:ranges => json.collect { |key, value| Range.from_hash( :field => key, :max => value["max"], :min => value["min"])})
+  end
+end

data/lib/dto/search/search_request.rb

@@ -0,0 +1,79 @@
+class SearchRequest
+  # annotations attribute should be a Hash object
+  attr_accessor :rpp, :page, :source, :category, :location, :heading,
+    :body, :text, :external_id, :start, :end, :annotations,
+    :trusted_annotations, :retvals
+
+  def add_retval(retval)
+    @retvals << retval
+  end
+
+  def query_params
+    query = Hash.new
+    url_params = ''
+    if (rpp != nil)
+      query[:rpp] = rpp.to_s;
+      url_params += "rpp=#{CGI.escape(query[:rpp])}&"
+    end
+    if (page != nil)
+      query[:page] = page.to_s;
+      url_params += "page=#{CGI.escape(query[:page])}&"
+    end
+    if (source != nil)
+      query[:source] = source.to_s;
+      url_params += "source=#{CGI.escape(query[:source])}&"
+    end
+    if (category != nil)
+      query[:category] = category.to_s;
+      url_params += "category=#{CGI.escape(query[:category])}&"
+    end
+    if (location != nil)
+      query[:location] = location.to_s;
+      url_params += "location=#{CGI.escape(query[:location])}&"
+    end
+    if (heading != nil)
+      query[:heading] = heading.to_s;
+      url_params += "heading=#{CGI.escape(query[:heading])}&"
+    end
+    if (body != nil)
+      query[:body] = body.to_s;
+      url_params += "body=#{CGI.escape(query[:body])}&"
+    end
+    if (text != nil)
+      query[:text] = text.to_s;
+      url_params += "text=#{CGI.escape(query[:text])}&"
+    end
+    if (external_id != nil)
+      query[:external_id] = external_id.to_s;
+      url_params += "external_id=#{CGI.escape(query[:external_id])}&"
+    end
+    if (start != nil)
+      query[:start] = start.to_s;
+      url_params += "start=#{CGI.escape(query[:start])}&"
+    end
+    if (self.end != nil)
+      query[:end] = self.end.to_s;
+      url_params += "end=#{CGI.escape(query[:end])}&"
+    end
+
+    if (annotations != nil && annotations.size > 0)
+#      query[:annotations] = ActiveSupport::JSON.encode(annotations)
+      query[:annotations] = annotations
+#      query.each do |key, value|
+#        url_params += "#{key}=#{value}&"
+#      end
+      url_params += "annotations=#{CGI.escape(ActiveSupport::JSON.encode(query[:annotations]))}&" #'annotations=#{CGI.escape(ActiveSupport::JSON.encode(search.annotations))}'
+    end
+    if (trusted_annotations != nil && trusted_annotations.size > 0)
+      #query[:trusted_annotations] = ActiveSupport::JSON.encode(trusted_annotations)
+      query[:trusted_annotations] = trusted_annotations
+      url_params += "trusted_annotations=#{CGI.escape(ActiveSupport::JSON.encode(query[:trusted_annotations]))}&"
+    end
+    if (retvals != nil)
+      query[:retvals] = retvals.join(',')  #queryParams.put("retvals", Utils.join(retvals));
+      url_params += "retvals=#{CGI.escape(query[:retvals])}&"
+    end
+    
+    url_params
+  end
+end

data/lib/dto/search/search_response.rb

@@ -0,0 +1,37 @@
+# Class SearchResponse represents server response on +search+ Search API
+# request. Server response is sent to initializer which creates object with
+# attributes +success+, +numResults+, +execTimeMs+, +results+ accessible via getters:
+# * +success+
+# * +num_results+
+# * +numResults+
+# * +execTimeMs+
+# * +exec_time_ms+
+# * +results+
+#
+# Examples:
+#
+#  response = SearchResponse.new("success" => "true", "numResults" => 0, "execTimeMs" => 100, "results" => [])
+#  response.category     # => "VAUT"
+#  response.numResults   # => 0
+#  response.num_results  # => 0
+#  response.execTimeMs   # => 100
+#  response.exec_time_ms # => 100
+#  response.results      # => []
+#
+class SearchResponse < Struct.new(:success, :numResults, :execTimeMs, :results) do
+    def num_results
+      numResults
+    end
+    def exec_time_ms
+      execTimeMs
+    end
+  end
+
+  # Initializer receives hash as a parameter and fills object fields from it. 
+  # +results+ field is filled with array of Posting objects.
+  def initialize(hash = {})
+    hash.each do |key, value|
+      self.send("#{key}=".to_sym, key == 'results' ? value.collect {|item| Posting.new(item)} : value )
+    end
+  end
+end

data/lib/dto/search/summary_request.rb

@@ -0,0 +1,13 @@
+#private SearchRequest searchRequest;
+#private String dimension;
+class SummaryRequest
+  attr_accessor :search_request, :dimension
+  
+  def query_params
+    query_params = ''
+    query_params = "dimension=#{CGI.escape(dimension)}&" if (dimension != nil)
+    query_params += search_request.query_params if (search_request != nil)
+    query_params
+  end
+
+end

data/lib/dto/search/summary_response.rb

@@ -0,0 +1,20 @@
+# Class SummaryResponse represents server response on +summary+ Search API
+# request. Server response is sent to initializer which creates object with
+# attributes +totals+, +execTimeMs+ accessible via getters:
+# * +totals+
+# * +execTimeMs+
+# * +exec_time_ms+
+#
+# Examples:
+#
+#  response = SummaryResponse.new("totals" => 20, "execTimeMs" => 100)
+#  response.totals       # => 20
+#  response.execTimeMs   # => 100
+#  response.exec_time_ms # => 100
+#
+class SummaryResponse < Struct.new(:totals, :execTimeMs) do
+    def exec_time_ms
+      execTimeMs
+    end
+  end
+end

data/lib/dto/status/get_status_response.rb

@@ -0,0 +1,43 @@
+# Class GetStatusResponse represents server response on +get_status+ Status API
+# request. Server response is sent to +from_array+ method which creates objects
+# attributes +exists+, +externalID+, +source+, +history+ accessible via getters:
+# * +exists+
+# * +externalID+
+# * +source+
+# * +history+
+#
+# Example:
+#
+#  response = GetStatusResponse.from_array(...)    # => Array
+#
+class GetStatusResponse < Struct.new(:exists, :externalID, :source, :history)
+  # Class Status represents elements of server response on +get_status+ Status API
+  # request. Server response is sent to initializer which creates object
+  # with attributes +field+, +attrs+ accessible via getters:
+  #
+  #  status = Status.new(...)
+  #  status.field     # => Array
+  #  status.attrs     # => Array of Attr
+  #
+  class Status < Struct.new(:field, :attrs)
+  end
+  # Class Attr represents elements of server response on +get_status+ Status API
+  # request. Server response is sent to initializer which creates object
+  # with attributes +timestamp+, +errors+, +attributes+ accessible via getters:
+  #
+  #  attr = Attr.new(...)
+  #
+  class Attr < Struct.new(:timestamp, :errors, :attributes)
+  end
+  # Method +from_array+ creates GetStatusResponse object
+  def self.from_array(json)
+     json.each do |hash|
+      hash.each do |key, value|
+        self.new("#{key}=".to_sym, key == 'history' ?  value.collect {
+          |key, items| Status.new(:field => key, :attrs => items.collect {|item| 
+           Attr.new(:timestamp => item["timestamp"], :errors => item["errors"], :attributes => item["attributes"]) }
+          )} : value )
+      end
+    end
+  end
+end

data/lib/dto/status/status_update_request.rb

@@ -0,0 +1,27 @@
+# Class StatusUpdateRequest returns the correct string for request 3taps
+# 
+class StatusUpdateRequest < Struct.new(:event, :timestump, :attributes, :errors)  
+  #
+  # Method +to_params+ creates the correct string for request 3taps.
+  #
+  def to_params
+    data =  "status:'#{event}'"
+    data <<  ", timestump:'#{((timestump).utc.to_s(:db)).gsub(/\s/,"+")}'" if timestump
+    data <<  ", attributes:{#{attributes_for_params}}" unless attributes.empty?
+    data <<  ", errors:[#{errors_for_params}]" unless errors.empty?
+    data
+  end
+  #
+  # Method +attributes_for_params+ creates array attributes for params.
+  #
+  def attributes_for_params
+    attributes.collect{ |key, value| "#{key}:'#{CGI.escape value}'"  }.join(", ")
+  end
+  #
+  # Method +errors_for_params+ array errors for params.
+  #
+  def errors_for_params
+    errors.collect{ |error| "{code:#{error.code}, message:'#{CGI.escape error.message}'}" }.join(", ")
+  end
+
+end

data/lib/models/annotations/annotation.rb

@@ -0,0 +1,21 @@
+# Class Annotation represents structure of annotation
+#
+#  annotation = Annotation.new
+#  annotation.name            # => String
+#  annotation.annotation_type # => String
+#  annotation.options         # => Array of AnnotationOption objects
+#
+class Annotation < SuperModel::Base
+  attributes :name, :annotation_type, :options
+
+  # Class AnnotaionType represents container of constants of annotation types:
+  #  SELECT = 1
+  #  STRING = 2
+  #  NUMBER = 3
+  #
+  class AnnotaionType
+    SELECT = 1
+    STRING = 2
+    NUMBER = 3
+  end
+end

data/lib/models/annotations/annotation_option.rb

@@ -0,0 +1,9 @@
+# Class AnnotationOption represents structure of options
+#
+#  option = AnnotationOption.new
+#  option.value          # => String
+#  option.sub_annotation # => String
+#
+class AnnotationOption < SuperModel::Base
+  attributes :value, :sub_annotation
+end

data/lib/models/category.rb

@@ -0,0 +1,26 @@
+# Class Category represents structure of category:
+#
+#  category = Category.new
+#  category.code        # => String
+#  category.group       # => String
+#  category.category    # => String
+#  category.hidden      # => Boolean
+#  category.annotations # => Array of Annotation objects
+
+#  category.from_array(array) # =>  Array of Category objects
+#
+class Category < Struct.new(:group, :category, :code, :annotations, :hidden)
+
+  # Method +from_array+ returns array of categories(create from json).
+  # Takes value of array objects as json parameter array.
+  #
+  # Example:
+  #
+  #  Category.from_array([...array of JSON objects...]) # => Array of Category
+  #
+  def self.from_array(array)
+    array.collect do |element|
+      Category.new(element)
+    end
+  end
+end

data/lib/models/location.rb

@@ -0,0 +1,30 @@
+# Class Location represents structure of location:
+#
+#  location = Location.new
+#  location.countryRank # => Integer
+#  location.country     # => String
+#  location.cityRank    # => Integer
+#  location.city        # => String
+#  location.stateCode   # => String
+#  location.stateName   # => String
+#  location.code        # => String
+#  location.latitude    # => Float
+#  location.longitude   # => Float
+#
+#  location.from_array(array) # =>  Array of Location objects
+#
+class Location < Struct.new(:countryRank, :country, :cityRank, :city, :stateCode, :stateName, :code, :latitude, :longitude)
+
+  # Method +from_array+ returns array of locations(create from json).
+  # Takes value of array objects as json parameter array.
+  #
+  # Example:
+  #
+  #  Location.from_array([...array of JSON objects...]) # => Array of Location
+  #
+  def self.from_array(array)
+    array.collect do |element|
+      Location.new(element)
+    end
+  end
+end

data/lib/models/message.rb

@@ -0,0 +1,9 @@
+# Class Message represents structure of message
+#
+#  message = Message.new
+#  message.code    # => Integer
+#  message.message # => String
+#
+class Message < Struct.new(:code, :message)
+
+end

data/lib/models/posting.rb

@@ -0,0 +1,97 @@
+# Class Posting represents structure of posting:
+#
+#  posting = Posting.new
+#  posting.postKey            # => String
+#  posting.heading            # => String
+#  posting.body               # => String
+#  posting.category           # => Boolean
+#  posting.source             # => Array of Annotation objects
+#  posting.location           # => String
+#  posting.longitude          # => Float
+#  posting.latitude           # => Float
+#  posting.language           # => String
+#  posting.price              # => String
+#  posting.currency           # => String
+#  posting.images             # => Array of String objects
+#  posting.externalURL        # => String
+##  posting.externalID         # => String
+#  posting.accountName        # => String
+#  posting.accountID          # => String
+#  posting.clickCount         # => Integer
+#  posting.timestamp          # => Date
+#  posting.expiration         # => Date
+#  posting.indexed            # => Date
+#  posting.trustedAnnotations # => Array of Annotation objects
+#  posting.annotations        # => Array of Annotation objects
+#  posting.errors             # => Array of String objects
+#  posting.status             # => String
+#  posting.history            # => String
+
+#  posting.to_json                   # => Array of JSON objects
+#  posting.to_json_for_update        # => Array of JSON objects
+#  posting.to_json_for_status_client # => Array of JSON objects
+#  posting.to_json_for_status        # => Array of JSON objects
+class Posting < SuperModel::Base
+  attributes :postKey, :heading, :body, :category, :source, :location,
+             :longitude, :latitude, :language, :price, :currency, :images,
+             :externalURL, :externalID, :accountName, :accountID, :clickCount,
+             :timestamp, :expiration, :indexed, :trustedAnnotations,
+             :annotations, :errors, :status, :history
+
+  def initialize(*params)
+    super(*params)
+    @attributes[:images] ||= []
+    @attributes[:annotations] ||= {}
+    @attributes[:status] ||= StatusUpdateRequest.from_hash(:event => '', :timestump => nil, :attributes => {}, :errors => [])
+  end
+
+  def to_json
+    posting = "{"+'source:'+"'#{self.source}'" + ',category:' + "'#{self.category}'" + ',location:' + "'#{self.location}'" + ',heading:' +  "'#{CGI.escape self.heading}'"
+    posting << ",timestamp: '#{(Time.now.utc.to_s(:db)).gsub(/\s/,"+")}'"
+    posting << ',images:' + "[#{images.collect{ |image| "'#{image}'"}.join(',')}]"
+    if self.body.present?
+      posting << ',body:' + "'#{CGI.escape self.body}'"
+    end
+    if self.annotations
+      annotations = []
+      self.annotations.each{|k,v| annotations << "#{k}:" + "'#{v}'"}
+      posting << ',annotations:' + "[{#{annotations.join(',')}}]"
+    end
+    posting  +  "}"
+  end
+
+  def to_json_for_update
+    data = "['#{self.postKey}',"
+    data << "{heading:"+  "'#{CGI.escape self.heading}'"
+    data << ",images:" + "[#{images.collect{ |image| "'#{image}'"}.join(',')}]"
+    data << ",source:'#{self.source}'" unless self.source.blank?
+    data << ",category:'#{self.category}'" unless self.category.blank?
+    data << ",location:'#{self.location}'" unless self.location.blank?
+    if self.body.present?
+      data << ",body:" + "'#{CGI.escape self.body}'"
+    end
+    if self.annotations
+      annotations = []
+      self.annotations.each{|k,v| annotations << "#{k}:" + "'#{v}'"}
+      data << ",annotations:" + "[{#{annotations.join(',')}}]"
+    end
+    data << "}"
+    data << "]"
+  end
+
+  def to_json_for_status
+    # {source: 'CRAIG', externalID: 3434399120}
+    data = "{source: '"
+    data <<  self.source || " "
+    data << "', externalID: "
+    data << self.externalID || " "
+    data << "}"
+  end
+  def to_json_for_status_client
+    # source: 'CRAIG', externalID: 3434399120
+    data = "source:'#{CGI.escape self.source}', "
+    data << "externalID:#{CGI.escape self.externalID}"
+    data
+  end
+
+end

data/lib/models/posting_history.rb

@@ -0,0 +1,8 @@
+# Class PostingHistory represents structure of history
+#
+#  history = PostingHistory.new
+#  history.history # => String
+#
+class PostingHistory < Struct.new(:history)
+ #include HashedInitializer
+end

data/lib/models/source.rb

@@ -0,0 +1,27 @@
+# Class Source represents structure of source
+#
+#  source = Source.new
+#  source.name        # => String
+#  source.code        # => String
+#  source.logo_url    # => String
+#  source.logo_sm_url # => String
+#  source.hidden      # => Boolean
+#
+#  source.from_array(array) # =>  Array of Source objects
+#
+class Source < Struct.new(:name, :code, :logo_url, :logo_sm_url, :hidden)
+
+
+  # Method +from_array+ returns array of sources(create from json).
+  # Takes value of array objects as json parameter array.
+  #
+  # Example:
+  #
+  #  Source.from_array([...array of JSON objects...]) # => Array of Source
+  #
+  def self.from_array(array)
+    array.collect do |element|
+      Source.new(element)
+    end
+  end
+end

data/lib/struct.rb

@@ -0,0 +1,16 @@
+class Struct
+  
+  def self.from_hash(h)
+    o = new
+    h.each do |m, v|
+      o[m.to_sym] = v
+    end
+    o
+  end
+
+  def self.from_array(a)
+    a.collect do |b|
+    end
+  end
+
+end

data/lib/threetaps-client.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'cgi'
+require 'supermodel'
+require 'active_support'
+require 'curb'
+require 'struct'
+
+require 'client/client'
+require 'client/search_client'
+require 'client/posting_client'
+require 'client/geocoder_client'
+require 'client/reference_client'
+require 'client/search_client'
+require 'client/status_client'
+
+
+require 'dto/geocoder/geocoder_request'
+require 'dto/geocoder/geocoder_response'
+
+require 'dto/posting/create_response'
+require 'dto/posting/delete_response'
+require 'dto/posting/update_response'
+require 'dto/posting/exists_response'
+
+require 'dto/status/get_status_response'
+require 'dto/status/status_update_request'
+
+require 'dto/search/best_match_response'
+require 'dto/search/count_response'
+require 'dto/search/range_response'
+require 'dto/search/range_request'
+require 'dto/search/search_response'
+require 'dto/search/search_request'
+require 'dto/search/summary_response'
+require 'dto/search/summary_request'
+
+require 'models/category'
+require 'models/location'
+require 'models/message'
+require 'models/posting'
+require 'models/posting_history'
+require 'models/source'
+require 'models/annotations/annotation'
+require 'models/annotations/annotation_option'

data/spec/client/client_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Client do
+  before(:each) do
+    @client = Client.new
+  end
+
+  it "should decode data" do
+    data = mock "[]"
+    ActiveSupport::JSON.should_receive(:decode).with(data)
+    @client.send(:decode,data)
+  end
+
+  it "should desc" do
+    # TODO
+  end
+end
+

data/spec/client/geocoder_client_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe GeocoderClient do
+  before(:each) do
+    @geocoder_client = GeocoderClient.new
+  end
+
+  it "should send GET request and create GeocoderResponse from result" do
+    geocoder_request = mock "geocoder_request"
+    geocoder_request.should_receive(:to_params)
+    array = mock "array"
+    geocoder_response = mock "geocoder_response"
+    GeocoderResponse.should_receive(:from_array).and_return array
+
+    @geocoder_client.geocode(geocoder_request).should == array
+  end
+end
+