Class: Mushikago::Http::Response

Inherits:
Object
  • Object
show all
Defined in:
lib/mushikago/http/response.rb

Overview

Mushikagoサービスのレスポンスを扱うクラス Mushikagoサービスのレスポンスは以下のような構造になっている

{
  meta : {
    status : 200,
    message : 'OK'
  },
  response : {
    // 

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Response) initialize(options = {})

A new instance of Response

Parameters:

  • options (Hash) (defaults to: {})

    オプション

Options Hash (options):

  • :meta (Object)

    レスポンスのメタ情報

  • :response (Object)

    レスポンスの本体



24
# File 'lib/mushikago/http/response.rb', line 24

def initialize options={}

Instance Attribute Details

- (Object) meta (readonly)

レスポンスのメタ情報

Returns:

  • (Object)

    レスポンスのメタ情報



17
18
19
# File 'lib/mushikago/http/response.rb', line 17

def meta
  @meta
end

- (Object) response (readonly)

レスポンスの本体

Returns:

  • (Object)

    レスポンスの本体



19
20
21
# File 'lib/mushikago/http/response.rb', line 19

def response
  @response
end

Instance Method Details

- (Object) [](key)

レスポンスの各要素にアクセスする

Parameters:

  • key (Symbol)

    レスポンスの各要素へのキー

Returns:

  • (Object)

    レスポンスの要素



44
45
46
# File 'lib/mushikago/http/response.rb', line 44

def [] key
  response[key]
end

- (String) message

メタ情報中のmessageを返す

Returns:

  • (String)

    メッセージ



37
38
39
# File 'lib/mushikago/http/response.rb', line 37

def message
  meta[:message]
end

- (Integer) status

メタ情報中のstatusを返す

Returns:

  • (Integer)

    ステータス



31
32
33
# File 'lib/mushikago/http/response.rb', line 31

def status
  meta[:status].to_i
end