Module: FatZebra::APIHelper

Included in:

APIResource

Defined in:

lib/fat_zebra/api_helper.rb

Overview

FatZebra Helper

Help for the api resource

Defined Under Namespace

Modules: ClassMethods

Class Method Summary

• .included(base) ⇒ Object

Instance Method Summary

• #request(method, resource_path, payload = {}, options = {}) ⇒ Hash

  Send a request to the API.

• #resource_name ⇒ String

  Resource name.

• #resource_path(path = nil) ⇒ String

  Resource path.

Class Method Details

.included(base) ⇒ Object

# File 'lib/fat_zebra/api_helper.rb', line 90

def self.included(base)
  base.extend(ClassMethods)
end

Instance Method Details

#request(method, resource_path, payload = {}, options = {}) ⇒ Hash

Send a request to the API

Raises:

• (FatZebra::RequestError) —

  if the request is invalid

# File 'lib/fat_zebra/api_helper.rb', line 86

def request(method, resource_path, payload = {}, options = {})
  self.class.request(method, resource_path, payload, options)
end

#resource_name ⇒ String

# File 'lib/fat_zebra/api_helper.rb', line 66

def resource_name
  self.class.resource_name
end

#resource_path(path = nil) ⇒ String

# File 'lib/fat_zebra/api_helper.rb', line 72

def resource_path(path = nil)
  self.class.resource_path(path)
end