Class: Useless::Doc::DSL::Resource

Inherits:

Object

• Object
• Useless::Doc::DSL::Resource

Includes:

Member

Defined in:

lib/useless/doc/dsl.rb

Instance Method Summary

• #connect(description = nil, &block) ⇒ Object
• #default_attributes ⇒ Object
• #delete(description = nil, &block) ⇒ Object
• #description(description) ⇒ Object
• #get(description = nil, &block) ⇒ Object
• #head(description = nil, &block) ⇒ Object
• #method(type, description, &block) ⇒ Object
• #patch(description = nil, &block) ⇒ Object
• #path(path) ⇒ Object
• #post(description = nil, &block) ⇒ Object
• #put(description = nil, &block) ⇒ Object
• #trace(description = nil, &block) ⇒ Object

Methods included from Member

#generate, included, #initialize

Instance Method Details

#connect(description = nil, &block) ⇒ Object

# File 'lib/useless/doc/dsl.rb', line 246

def connect(description = nil, &block)
  method(Doc::Core::Request::Method::CONNECT, description, &block)
end

#default_attributes ⇒ Object

# File 'lib/useless/doc/dsl.rb', line 206

def default_attributes
  { requests: [] }
end

#delete(description = nil, &block) ⇒ Object

# File 'lib/useless/doc/dsl.rb', line 238

def delete(description = nil, &block)
  method(Doc::Core::Request::Method::DELETE, description, &block)
end

#description(description) ⇒ Object

# File 'lib/useless/doc/dsl.rb', line 214

def description(description)
  @attributes[:description] = description
end

#get(description = nil, &block) ⇒ Object

# File 'lib/useless/doc/dsl.rb', line 218

def get(description = nil, &block)
  method(Doc::Core::Request::Method::GET, description, &block)
end

#head(description = nil, &block) ⇒ Object

# File 'lib/useless/doc/dsl.rb', line 222

def head(description = nil, &block)
  method(Doc::Core::Request::Method::HEAD, description, &block)
end

#method(type, description, &block) ⇒ Object

# File 'lib/useless/doc/dsl.rb', line 250

def method(type, description, &block)
  attributes = { method: type, description: description }
  @attributes[:requests] << Request.build(attributes, &block)
end

#patch(description = nil, &block) ⇒ Object

# File 'lib/useless/doc/dsl.rb', line 234

def patch(description = nil, &block)
  method(Doc::Core::Request::Method::PATCH, description, &block)
end

#path(path) ⇒ Object

# File 'lib/useless/doc/dsl.rb', line 210

def path(path)
  @attributes[:path] = path
end

#post(description = nil, &block) ⇒ Object

# File 'lib/useless/doc/dsl.rb', line 226

def post(description = nil, &block)
  method(Doc::Core::Request::Method::POST, description, &block)
end

#put(description = nil, &block) ⇒ Object

# File 'lib/useless/doc/dsl.rb', line 230

def put(description = nil, &block)
  method(Doc::Core::Request::Method::PUT, description, &block)
end

#trace(description = nil, &block) ⇒ Object

# File 'lib/useless/doc/dsl.rb', line 242

def trace(description = nil, &block)
  method(Doc::Core::Request::Method::TRACE, description, &block)
end