Class: Io::Flow::V0::Models::QueryBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Overview

The query builder model is used to build a query using structured filters. The end result is a single ‘q’ string - e.g. ‘category:jewelry and brand:Flow’

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ QueryBuilder

Returns a new instance of QueryBuilder.



36028
36029
36030
36031
36032
36033
36034
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36028

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:q, :filters, :available], 'QueryBuilder')
  @q = HttpClient::Preconditions.assert_class('q', opts.delete(:q), String)
  @filters = HttpClient::Preconditions.assert_class('filters', opts.delete(:filters), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::QueryFilter) ? x : ::Io::Flow::V0::Models::QueryFilter.from_json(x)) }
  @available = HttpClient::Preconditions.assert_class('available', opts.delete(:available), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::AvailableFilter) ? x : ::Io::Flow::V0::Models::AvailableFilter.from_json(x)) }
end

Instance Attribute Details

#available ⇒ Object (readonly)

Returns the value of attribute available.



36026
36027
36028
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36026

def available
  @available
end

#filters ⇒ Object (readonly)

Returns the value of attribute filters.



36026
36027
36028
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36026

def filters
  @filters
end

#q ⇒ Object (readonly)

Returns the value of attribute q.



36026
36027
36028
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36026

def q
  @q
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



36040
36041
36042
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36040

def copy(incoming={})
  QueryBuilder.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hash ⇒ Object 



36044
36045
36046
36047
36048
36049
36050
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36044

def to_hash
  {
    :q => q,
    :filters => filters.map { |o| o.to_hash },
    :available => available.map { |o| o.to_hash }
  }
end

#to_json ⇒ Object 



36036
36037
36038
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36036

def to_json
  JSON.dump(to_hash)
end