Class: Workarea::Api::DocumentationTest

Inherits:
IntegrationTest
  • Object
show all
Defined in:
lib/workarea/api/documentation_test.rb

Defined Under Namespace

Classes: Example, Request

Constant Summary collapse

IGNORED_HEADERS = 
%w(Host Accept X-Workarea-Segments)

Class Method Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args, &block) ⇒ Object 



128
129
130
131
132
133
134
 
# File 'lib/workarea/api/documentation_test.rb', line 128

def method_missing(method_name, *args, &block)
  if @example.respond_to?("#{method_name}=")
    @example.send("#{method_name}=", *args)
  else
    super
  end
end

Class Method Details

.build_index(engine) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/workarea/api/documentation_test.rb', line 76

def build_index(engine)
  results = { 'resources' => [] }
  root = docs_root.join(engine)

  FileUtils.mkdir_p(root)
  begin
    FileUtils.rm(root.join('index.json'))
  rescue
    nil
  end

  Dir.glob(root.join('**/*.json')) do |file|
    example = JSON.parse(File.read(file))

    existing_resource = results['resources'].detect do |resource|
      resource['name'] == example['resource']
    end

    index_example = {
      'description' => example['description'],
      'link' => file.to_s.gsub("#{docs_root}/", ''),
      'groups' => 'all',
      'route' => example['route'],
      'method' => example['http_method']
    }

    if existing_resource.present?
      existing_resource['examples'] << index_example
    else
      results['resources'] << {
        'name' => example['resource'],
        'examples' => [index_example]
      }
    end
  end

  results['resources'].sort_by! { |r| r['name'] }
  results['resources'].each { |r| r['examples'].sort_by! { |e| e['description'] } }

  File.open(root.join('index.json'), 'w') do |file|
    file.write(JSON.pretty_generate(results))
  end
end

.docs_dir ⇒ Object 



68
69
70
 
# File 'lib/workarea/api/documentation_test.rb', line 68

def docs_dir
  docs_root.join(engine, resource.systemize)
end

.docs_root ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/workarea/api/documentation_test.rb', line 56

def docs_root
  @docs_root ||= if running_in_gem?
    Workarea::Api.root.join('doc', 'api')
  else
    Rails.root.join('doc', 'api')
  end
end

.engine ⇒ Object 



72
73
74
 
# File 'lib/workarea/api/documentation_test.rb', line 72

def engine
  name.split('::')[-2].downcase
end

.resource(val = nil) ⇒ Object 



52
53
54
 
# File 'lib/workarea/api/documentation_test.rb', line 52

def resource(val = nil)
  @resource = val || @resource
end

.running_in_gem? ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/workarea/api/documentation_test.rb', line 64

def running_in_gem?
  Rails.root.to_s.include?('test/dummy')
end

Instance Method Details

#parameter(name, description) ⇒ Object 



124
125
126
 
# File 'lib/workarea/api/documentation_test.rb', line 124

def parameter(name, description)
  @example.parameters << { name: name, description: description }
end

#record_request ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/workarea/api/documentation_test.rb', line 140

def record_request
  yield

  @example.http_method = request.method.upcase if @example.http_method.blank?
  headers = env_to_headers(request.env)
  request_body = read_request_body

  doc_request = Request.new
  doc_request.request_method = request.method
  doc_request.request_path = request.fullpath
  doc_request.request_body = request_body.empty? ? nil : request_body.force_encoding('UTF-8')
  doc_request.request_headers = headers
  doc_request.request_query_parameters = request.query_parameters
  doc_request.request_content_type = headers['Content-Type']
  doc_request.response_status = response.status
  doc_request.response_status_text = response.message
  doc_request.response_body = formatted_response_body
  doc_request.response_headers = filtered_response_headers
  doc_request.response_content_type = response.content_type

  curl = Curl.new(request.method, request.fullpath, request_body, headers)
  doc_request.curl = curl.output("https://#{Workarea.config.host}")

  @example.requests << doc_request
end

#respond_to?(method_name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/workarea/api/documentation_test.rb', line 136

def respond_to?(method_name, include_private = false)
  @example.respond_to?("#{method_name}=") || super
end