Module: KayakoClient::API::ClassMethods

Defined in:
lib/kayako_client/mixins/api.rb

Instance Method Summary collapse

Instance Method Details

#all(options = {}) ⇒ Object

Raises:

  • (NotImplementedError) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/kayako_client/mixins/api.rb', line 167

def all(options = {})
    raise NotImplementedError, "method not supported" unless support?(:all)
    unless configured? || (options[:api_url] && options[:api_key] && options[:secret_key])
        raise RuntimeError, "client not configured"
    end
    response = get_request(options)
    log = options[:logger] || logger
    if response.is_a?(KayakoClient::HTTPOK)
        objects = []
        if log
            log.debug "Response:"
            log.debug response.body
        end
        payload = xml_backend.new(response.body, { :logger => log })
        payload.each do |element|
            object = new(payload.to_hash(element).merge(inherited_options(options)))
            object.loaded!
            objects << object
        end
        log.info ":get(:all) successful (#{objects.size} objects)" if log
        objects
    else
        log.error "Response: #{response.status} #{response.body}" if log
        raise StandardError, "server returned #{response.status}: #{response.body}"
    end
end

#api_key ⇒ Object 



155
156
157
 
# File 'lib/kayako_client/mixins/api.rb', line 155

def api_key
    @@api_key ||= ''
end

#api_key=(key) ⇒ Object 



151
152
153
 
# File 'lib/kayako_client/mixins/api.rb', line 151

def api_key=(key)
    @@api_key = key
end

#api_url ⇒ Object 



147
148
149
 
# File 'lib/kayako_client/mixins/api.rb', line 147

def api_url
    @@api_url ||= ''
end

#api_url=(url) ⇒ Object 



143
144
145
 
# File 'lib/kayako_client/mixins/api.rb', line 143

def api_url=(url)
    @@api_url = url
end

#delete(id, options = {}) ⇒ Object Also known as: destroy

Raises:

  • (NotImplementedError) 


255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/kayako_client/mixins/api.rb', line 255

def delete(id, options = {})
    raise NotImplementedError, "method not supported" unless support?(:delete)
    unless configured? || (options[:api_url] && options[:api_key] && options[:secret_key])
        raise RuntimeError, "client not configured"
    end
    response = delete_request(options.merge(:id => id))
    log = options[:logger] || logger
    if response.is_a?(KayakoClient::HTTPOK)
        log.info ":delete successful for object##{id}" if log
        true
    else
        log.error "Response: #{response.status} #{response.body}" if log
        raise StandardError, "server returned #{response.status}: #{response.body}"
        false
    end
end

#get(*args) ⇒ Object Also known as: find

Raises:

  • (NotImplementedError) 


194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/kayako_client/mixins/api.rb', line 194

def get(*args)
    options = args.last.is_a?(Hash) ? args.pop : {}
    id = args[0]
    id = :all unless id || options[:id]
    raise NotImplementedError, "method not supported" unless support?(:get)
    unless configured? || (options[:api_url] && options[:api_key] && options[:secret_key])
        raise RuntimeError, "client not configured"
    end
    log = options[:logger] || logger
    if id == :all
        return all(options)
    elsif id && id.to_i > 0
        id = id.to_i
    elsif options[:id]
        id = options[:id]
    else
        if id
            log.error "invalid :id - #{id}" if log
            raise ArgumentError, "invalid ID"
        else
            log.error "missing :id" if log
            raise ArgumentError, "missing ID"
        end
    end
    response = get_request(options.merge(:id => id))
    if response.is_a?(KayakoClient::HTTPOK)
        if log
            log.debug "Response:"
            log.debug response.body
        end
        payload = xml_backend.new(response.body, { :logger => log })
        params = payload.to_hash
        unless params.nil?
            object = new(params.merge(inherited_options(options)))
            object.loaded!
            log.info ":get(#{id}) successful" if log
            object
        else
            log.info ":get(#{id}) successful (not found)" if log
            nil
        end
    else
        log.error "Response: #{response.status} #{response.body}" if log
        raise StandardError, "server returned #{response.status}: #{response.body}"
    end
end

#post(options = {}) ⇒ Object Also known as: create

Raises:

  • (NotImplementedError) 


243
244
245
246
247
248
249
250
251
 
# File 'lib/kayako_client/mixins/api.rb', line 243

def post(options = {})
    raise NotImplementedError, "method not supported" unless support?(:post)
    object = new(options)
    if object.post
        object
    else
        object.has_errors? ? object.errors : nil
    end
end

#secret_key ⇒ Object 



163
164
165
 
# File 'lib/kayako_client/mixins/api.rb', line 163

def secret_key
    @@secret_key ||= ''
end

#secret_key=(secret) ⇒ Object 



159
160
161
 
# File 'lib/kayako_client/mixins/api.rb', line 159

def secret_key=(secret)
    @@secret_key = secret
end