Class: Reach::REST::Version

Inherits:
Object
  • Object
show all
Defined in:
lib/reach-ruby/framework/rest/version.rb

Direct Known Subclasses

Api::Authentix, Api::Messaging

Defined Under Namespace

Classes: RecordStream

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain) ⇒ Version

Returns a new instance of Version.



36
37
38
39
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 36

def initialize(domain)
  @domain = domain
  @version = nil
end

Instance Attribute Details

#domain ⇒ Object

Returns the value of attribute domain.



6
7
8
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 6

def domain
  @domain
end

Instance Method Details

#absolute_url(uri) ⇒ Object 



41
42
43
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 41

def absolute_url(uri)
  @domain.absolute_url(relative_uri(uri))
end

#check(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil) ⇒ Object 



229
230
231
232
233
234
235
236
237
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 229

def check(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
  response = request(method, uri, params, data, headers, auth, timeout)

  if response.status_code < 200 || response.status_code >= 300
    raise exception(response, 'Unable to check record')
  end

  response.body
end

#create(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil) ⇒ Object 



199
200
201
202
203
204
205
206
207
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 199

def create(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
  response = request(method, uri, params, data, headers, auth, timeout)

  if response.status_code < 200 || response.status_code >= 300
    raise exception(response, 'Unable to create record')
  end

  response.body
end

#delete(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 154

def delete(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
  response = request(
    method,
    uri,
    params,
    data,
    headers,
    auth,
    timeout
  )

  if response.status_code < 200 || response.status_code >= 300
    raise exception(response, 'Unable to delete record')
  end

  response.status_code == 204
end

#dispatch(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil) ⇒ Object 



209
210
211
212
213
214
215
216
217
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 209

def dispatch(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
  response = request(method, uri, params, data, headers, auth, timeout)

  if response.status_code < 200 || response.status_code >= 300
    raise exception(response, 'Unable to dispatch record')
  end

  response.body
end

#exception(response, header) ⇒ Object 



95
96
97
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 95

def exception(response, header)
  Reach::REST::RestError.new(header, response)
end

#fetch(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 99

def fetch(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
  response = request(
    method,
    uri,
    params,
    data,
    headers,
    auth,
    timeout
  )

  # Note that 3XX response codes are allowed for fetches.
  if response.status_code < 200 || response.status_code >= 400
    raise exception(response, 'Unable to fetch record')
  end

  response.body
end

#page(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil) ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 183

def page(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
  request(
    method,
    uri,
    params,
    data,
    headers,
    auth,
    timeout
  )
end

#read_limits(limit = nil, page_size = nil) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 172

def read_limits(limit = nil, page_size = nil)
  unless limit.nil? || page_size
    page_size = limit
  end

  {
    limit: limit || nil,
    page_size: page_size || nil
  }
end

#relative_uri(uri) ⇒ Object 



84
85
86
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 84

def relative_uri(uri)
  "#{@version.chomp('/').gsub(/^\//, '')}/#{uri.chomp('/').gsub(/^\//, '')}"
end

#request(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil) ⇒ Object 



88
89
90
91
92
93
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 88

def request(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
  url = relative_uri(uri)
  params = params.delete_if { |_k, v| v.nil? }
  data = data
  @domain.request(method, url, params, data, headers, auth, timeout)
end

#start(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil) ⇒ Object 



219
220
221
222
223
224
225
226
227
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 219

def start(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
  response = request(method, uri, params, data, headers, auth, timeout)

  if response.status_code < 200 || response.status_code >= 300
    raise exception(response, 'Unable to start record')
  end

  response.body
end

#stream(page, limit: nil, page_limit: nil) ⇒ Object 



195
196
197
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 195

def stream(page, limit: nil, page_limit: nil)
  RecordStream.new(page, limit: limit, page_limit: page_limit)
end

#unschedule(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 136

def unschedule(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
  response = request(
    method,
    uri,
    params,
    data,
    headers,
    auth,
    timeout
  )

  if response.status_code < 200 || response.status_code >= 300
    raise exception(response, 'Unable to unschedule record')
  end

  response.body
end

#update(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 118

def update(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
  response = request(
    method,
    uri,
    params,
    data,
    headers,
    auth,
    timeout
  )

  if response.status_code < 200 || response.status_code >= 300
    raise exception(response, 'Unable to update record')
  end

  response.body
end

#url_without_pagination_info(url, params = {}) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/reach-ruby/framework/rest/version.rb', line 45

def url_without_pagination_info(url, params = {})
  uri = URI.parse(url)
  clo = params.clone
  clo = clo.delete_if { |_k, v| v.nil? }
  query = clo.map{|k, v| "#{k}=#{v}"}.join("&")
  if (!(uri.query == nil || uri.query.length == 0))
    sep = ""
    if (query.length>0)
      sep = "&"
    end
    query = uri.query + sep + query;
  end
  if (query.length ==0)
    return url
  end
  queryParams = query.split("&")
  idx = 0;
  q = ["page", "pageSize"];
  while (idx < q.length)
    par = q[idx]
    prefix = par + "="
    i = 0
    while (i < queryParams.length)
      if (queryParams[i].start_with?(prefix))
          queryParams.delete_at(i)
      else
          i = i + 1
      end
    end
    idx = idx + 1
  end
  query = ""
  if (queryParams.length > 0)
    query = queryParams.join("&")
  end
  uri.query = query
  return uri.to_s
end