Class: Zedlocales::ContentScopes

Inherits:
Object
  • Object
show all
Defined in:
lib/zedlocales/content_scopes.rb

Defined Under Namespace

Classes: Content

Class Method Summary collapse

Class Method Details

.create(zks = {}, &block) ⇒ Object 



70
71
72
 
# File 'lib/zedlocales/content_scopes.rb', line 70

def create(zks = {}, &block)
  Zedkit::Client.crud(:create, 'content/scopes', zks, [], &block)
end

.delete(zks = {}, &block) ⇒ Object 



78
79
80
 
# File 'lib/zedlocales/content_scopes.rb', line 78

def delete(zks = {}, &block)
  Zedkit::Client.crud(:delete, "content/scopes/#{zks[:uuid]}", zks, [], &block)
end

.get(zks = {}, &block) ⇒ Object

Zedlocales Content Scopes

All Zedkit applications have optional content. You can create, read, update, or delete content scopes within sections to organize it. To perform an operation on a specific content scope you need its UUID, as available from the Zedlocales::ContentSections::ContentScopes.get method.

To get a Content Scope:

Zedlocales::ContentScopes.get(:user_key => user['user_key'], :uuid => scope['uuid'])

To update a Content Scope:

Zedlocales::ContentScopes.update(:user_key => user['user_key'],
                                 :uuid => scope['uuid'], :scope => { :key => 'whatever' })

To delete a Content Scope:

Zedlocales::ContentScopes.delete(:user_key => user['user_key'], :uuid => scope['uuid'])

To create a new Content Scope you submit the required parameters with the section UUID that you are creating the content scope for. Whatever items you send within the :scope Hash are passed through to the ZedAPI untouched. There is no client side validation within this gem.

Zedlocales::ContentScopes.create(:user_key => user['user_key'],
                                 :section => { :uuid => section['uuid'] }, :scope => { :key => 'whatever' })

From each of these requests the Zedkit::Client class will return a response hash for your reference, if needed, or as applicable to the request. If there was a HTTP 401 or 404 you will get a nil response. This indicates a security failure or that an UUID is incorrect, not attached the user’s account, or non-existent.

For each request you can also pass a block to process the response directly:

Zedlocales::ContentScopes.get(:user_key => user['user_key'], :uuid => scope['uuid']) do |result|
end



66
67
68
 
# File 'lib/zedlocales/content_scopes.rb', line 66

def get(zks = {}, &block)
  Zedkit::Client.crud(:get, "content/scopes/#{zks[:uuid]}", zks, [], &block)
end

.update(zks = {}, &block) ⇒ Object 



74
75
76
 
# File 'lib/zedlocales/content_scopes.rb', line 74

def update(zks = {}, &block)
  Zedkit::Client.crud(:update, "content/scopes/#{zks[:uuid]}", zks, [], &block)
end