Module: ContextIO::API::Resource

Included in:

ContextIO::Account, ConnectToken, Contact, File, Message, OAuthProvider, Source, Thread, Webhook

Defined in:

lib/contextio/api/resource.rb

Overview

When included into a class, this module provides some helper methods for various things a singular resource will need or find useful.

Defined Under Namespace

Modules: DeclarativeClassSyntax

Instance Attribute Summary

• #api_attributes ⇒ {String => Numeric, String, Hash, Array, Boolean} readonly

  The attributes returned from the API as a Hash.

• #primary_key ⇒ String, Symbol readonly

  The name of the key used to build the resource URL.

• #resource_url ⇒ String readonly

  The URL that will fetch attributes from the API.

Instance Method Summary

• #delete ⇒ Boolean

  Deletes the resource.

Instance Attribute Details

#api_attributes ⇒ {String => Numeric, String, Hash, Array, Boolean} (readonly)

# File 'lib/contextio/api/resource.rb', line 60

def api_attributes
  @api_attributes ||= fetch_attributes
end

#primary_key ⇒ String, Symbol (readonly)

# File 'lib/contextio/api/resource.rb', line 67

def primary_key
  self.class.primary_key
end

#resource_url ⇒ String (readonly)

# File 'lib/contextio/api/resource.rb', line 45

def resource_url
  @resource_url ||= api.url_for(self)
end

Instance Method Details

#delete ⇒ Boolean

Deletes the resource.

# File 'lib/contextio/api/resource.rb', line 52

def delete
  api.request(:delete, resource_url)['success']
end