Class: Flipper::Api::Action

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/flipper/api/action.rb

Defined Under Namespace

Modules: FeatureNameFromRoute

Constant Summary collapse

VALID_REQUEST_METHOD_NAMES = 
Set.new([
  'get'.freeze,
  'post'.freeze,
  'put'.freeze,
  'delete'.freeze,
]).freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flipper, request) ⇒ Action

Returns a new instance of Action.



67
68
69
70
71
72
 
# File 'lib/flipper/api/action.rb', line 67

def initialize(flipper, request)
  @flipper = flipper
  @request = request
  @code = 200
  @headers = { 'Content-Type' => Api::CONTENT_TYPE }
end

Instance Attribute Details

#flipper ⇒ Object (readonly)

Public: The instance of the Flipper::DSL the middleware was initialized with.



59
60
61
 
# File 'lib/flipper/api/action.rb', line 59

def flipper
  @flipper
end

#request ⇒ Object (readonly)

Public: The Rack::Request to provide a response for.



62
63
64
 
# File 'lib/flipper/api/action.rb', line 62

def request
  @request
end

Class Method Details

.route(regex) ⇒ Object

Public: Call this in subclasses so the action knows its route.

regex - The Regexp that this action should run for.

Returns nothing.



33
34
35
 
# File 'lib/flipper/api/action.rb', line 33

def self.route(regex)
  @route_regex = regex
end

.route_match?(path) ⇒ Boolean

Internal: Does this action’s route match the path.

Returns:

  • (Boolean) 


38
39
40
 
# File 'lib/flipper/api/action.rb', line 38

def self.route_match?(path)
  path.match(route_regex)
end

.route_regex ⇒ Object

Internal: The regex that matches which routes this action will work for.



43
44
45
 
# File 'lib/flipper/api/action.rb', line 43

def self.route_regex
  @route_regex || raise("#{name}.route is not set")
end

.run(flipper, request) ⇒ Object

Internal: Initializes and runs an action for a given request.

flipper - The Flipper::DSL instance. request - The Rack::Request that was sent.

Returns result of Action#run.



53
54
55
 
# File 'lib/flipper/api/action.rb', line 53

def self.run(flipper, request)
  new(flipper, request).run
end

Instance Method Details

#halt(response) ⇒ Object

Public: Call this with a response to immediately stop the current action and respond however you want.

response - The response you would like to return.



105
106
107
 
# File 'lib/flipper/api/action.rb', line 105

def halt(response)
  throw :halt, response
end

#header(name, value) ⇒ Object

Public: Set a header.

name - The String name of the header. value - The value of the header.



143
144
145
 
# File 'lib/flipper/api/action.rb', line 143

def header(name, value)
  @headers[name] = value
end

#json_error_response(error_key) ⇒ Object

Public: Call this with an ErrorResponse::ERRORS key to respond with the serialized error object as response body

error_key - key to lookup error object



127
128
129
130
 
# File 'lib/flipper/api/action.rb', line 127

def json_error_response(error_key)
  error = ErrorResponse::ERRORS.fetch(error_key.to_sym)
  json_response(error.as_json, error.http_status)
end

#json_response(object, status = 200) ⇒ Object

Public: Call this with a json serializable object (i.e. Hash) to serialize object and respond to request

object - json serializable object status - http status code



115
116
117
118
119
120
 
# File 'lib/flipper/api/action.rb', line 115

def json_response(object, status = 200)
  header 'Content-Type', Api::CONTENT_TYPE
  status(status)
  body = JSON.dump(object)
  halt [@code, @headers, [body]]
end

#run ⇒ Object

Public: Runs the request method for the provided request.

Returns whatever the request method returns in the action.



77
78
79
80
81
82
83
84
 
# File 'lib/flipper/api/action.rb', line 77

def run
  if valid_request_method? && respond_to?(request_method_name)
    catch(:halt) { send(request_method_name) }
  else
    raise Api::RequestMethodNotSupported,
          "#{self.class} does not support request method #{request_method_name.inspect}"
  end
end

#run_other_action(action_class) ⇒ Object

Public: Runs another action from within the request method of a different action.

action_class - The class of the other action to run.

Examples

run_other_action Home
# => result of running Home action

Returns result of other action.



97
98
99
 
# File 'lib/flipper/api/action.rb', line 97

def run_other_action(action_class)
  action_class.new(flipper, request).run
end

#status(code) ⇒ Object

Public: Set the status code for the response.

code - The Integer code you would like the response to return.



135
136
137
 
# File 'lib/flipper/api/action.rb', line 135

def status(code)
  @code = code.to_i
end