Class: HaveAPI::Example

Inherits:
Object
  • Object
show all
Defined in:
lib/haveapi/example.rb

Instance Method Summary collapse

Constructor Details

#initialize(title) ⇒ Example

Returns a new instance of Example.



3
4
5
 
# File 'lib/haveapi/example.rb', line 3

def initialize(title)
  @title = title
end

Instance Method Details

#comment(str) ⇒ Object 



35
36
37
 
# File 'lib/haveapi/example.rb', line 35

def comment(str)
  @comment = str
end

#describe ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/haveapi/example.rb', line 45

def describe
  if provided?
    {
        title: @title,
        comment: @comment,
        url_params: @url_params,
        request: @request,
        response: @response,
        status: @status.nil? ? true : @status,
        message: @message,
        errors: @errors,
        http_status: @http_status || 200,
    }
  else
    {}
  end
end

#errors(errs) ⇒ Object 



27
28
29
 
# File 'lib/haveapi/example.rb', line 27

def errors(errs)
  @errors = errs
end

#http_status(code) ⇒ Object 



31
32
33
 
# File 'lib/haveapi/example.rb', line 31

def http_status(code)
  @http_status = code
end

#message(msg) ⇒ Object 



23
24
25
 
# File 'lib/haveapi/example.rb', line 23

def message(msg)
  @message = msg
end

#provided? ⇒ Boolean

Returns:



39
40
41
42
43
 
# File 'lib/haveapi/example.rb', line 39

def provided?
  instance_variables.detect do |v|
    instance_variable_get(v)
  end ? true : false
end

#request(f) ⇒ Object 



11
12
13
 
# File 'lib/haveapi/example.rb', line 11

def request(f)
  @request = f
end

#response(f) ⇒ Object 



15
16
17
 
# File 'lib/haveapi/example.rb', line 15

def response(f)
  @response = f
end

#status(status) ⇒ Object 



19
20
21
 
# File 'lib/haveapi/example.rb', line 19

def status(status)
  @status = status
end

#url_params(*params) ⇒ Object 



7
8
9
 
# File 'lib/haveapi/example.rb', line 7

def url_params(*params)
  @url_params = params
end