Class: MangoApps::Response

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/mangoapps/response.rb

Overview

Response wrapper that provides clean dot notation access to MangoApps API responses Abstracts away the ms_response wrapper and provides intuitive access patterns

Instance Method Summary collapse

Constructor Details

#initialize(data) ⇒ Response

Returns a new instance of Response.



9
10
11
12
 
# File 'lib/mangoapps/response.rb', line 9

def initialize(data)
  @data = data
  @ms_response = data["ms_response"] || data
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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

Delegate to ms_response for cleaner access



15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/mangoapps/response.rb', line 15

def method_missing(method_name, *args, &block)
  if @ms_response.respond_to?(method_name)
    @ms_response.public_send(method_name, *args, &block)
  elsif @ms_response.is_a?(Hash) && @ms_response.key?(method_name.to_s)
    value = @ms_response[method_name.to_s]
    wrap_value(value)
  elsif @ms_response.is_a?(Hash) && @ms_response.key?(method_name.to_sym)
    value = @ms_response[method_name.to_sym]
    wrap_value(value)
  else
    super
  end
end

Instance Method Details

#[](key) ⇒ Object

Array access for hash-like behavior



37
38
39
40
 
# File 'lib/mangoapps/response.rb', line 37

def [](key)
  value = @ms_response[key]
  wrap_value(value)
end

#each(&block) ⇒ Object

Enumerable support



56
57
58
 
# File 'lib/mangoapps/response.rb', line 56

def each(&block)
  @ms_response.each(&block)
end

#inspect ⇒ Object

Pretty inspection



70
71
72
 
# File 'lib/mangoapps/response.rb', line 70

def inspect
  "#<MangoApps::Response:#{object_id} @data=#{@ms_response.inspect}>"
end

#key?(key) ⇒ Boolean

Hash-like key access

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/mangoapps/response.rb', line 43

def key?(key)
  @ms_response.key?(key)
end

#keys ⇒ Object 



47
48
49
 
# File 'lib/mangoapps/response.rb', line 47

def keys
  @ms_response.keys
end

#raw_data ⇒ Object

Access to raw data if needed



75
76
77
 
# File 'lib/mangoapps/response.rb', line 75

def raw_data
  @data
end

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

Returns:

  • (Boolean) 


29
30
31
32
33
34
 
# File 'lib/mangoapps/response.rb', line 29

def respond_to_missing?(method_name, include_private = false)
  @ms_response.respond_to?(method_name, include_private) ||
    (@ms_response.is_a?(Hash) && 
     (@ms_response.key?(method_name.to_s) || @ms_response.key?(method_name.to_sym))) ||
    super
end

#to_h ⇒ Object

Convert back to hash if needed



61
62
63
 
# File 'lib/mangoapps/response.rb', line 61

def to_h
  @ms_response
end

#to_hash ⇒ Object 



65
66
67
 
# File 'lib/mangoapps/response.rb', line 65

def to_hash
  @ms_response
end

#values ⇒ Object 



51
52
53
 
# File 'lib/mangoapps/response.rb', line 51

def values
  @ms_response.values.map { |v| wrap_value(v) }
end