Top Level Namespace

Includes:

DSL::Request, DSL::Resource, DSL::Route, Http::Local::Request, Http::Local::Route, Http::Remote::Request, Http::Remote::Resource, Http::Remote::Route, Rack::Test::Methods

Defined Under Namespace

Modules: DSL, Faraday, Http, RspecApi

Instance Method Summary

• #app ⇒ Object
• #resource(name, args = {}, &block) ⇒ Object

  Just like RSpec Core’s ‘describe` method, `resource` generates a subclass of ExampleGroup and is available at the top-level namespace.

Methods included from Http::Remote::Route

#authorization, #send_request

Methods included from Http::Remote::Request

#request_params, #response

Methods included from Http::Local::Request

#request_params, #response

Methods included from Http::Local::Route

#send_request

Methods included from DSL::Request

#get_request_param_for_list, #request_params, #response, #response_body, #response_headers, #response_is_successful?, #response_status, #should_be_filtered_by, #should_be_sorted_by, #should_be_valid_json, #should_be_wrapped_by, #should_have_attributes

Methods included from DSL::Route

#send_request

Instance Method Details

#app ⇒ Object

# File 'lib/rspec-api/http/local.rb', line 5

def app
  Rails.application
end

#resource(name, args = {}, &block) ⇒ Object

Just like RSpec Core’s ‘describe` method, `resource` generates a subclass of ExampleGroup and is available at the top-level namespace. The difference is that examples declared inside a `resource` block have access to RSpec API own methods, defined in DSL::Resource, such as `has_attribute`, `accepts_filter`, `get`, `post`, and so on.

# File 'lib/rspec-api/dsl.rb', line 13

def resource(name, args = {}, &block)
  args.merge! rspec_api_dsl: :resource, rspec_api: {resource_name: name}
  describe name, args, &block
end