Class: Flexirest::Base

Inherits:
Object
  • Object
show all
Includes:
AttributeParsing, Caching, Configuration, Mapping, Recording, RequestFiltering, Validation
Defined in:
lib/flexirest/base.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Recording

included

Methods included from Caching

included

Methods included from Validation

#_errors, #full_error_messages, included, #valid?

Methods included from RequestFiltering

included

Methods included from Configuration

included

Methods included from Mapping

included

Constructor Details

#initialize(attrs = {}) ⇒ Base

Returns a new instance of Base.

Raises:

  • (Exception) 


20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/flexirest/base.rb', line 20

def initialize(attrs={})
  @attributes = {}
  @dirty_attributes = Set.new

  raise Exception.new("Cannot instantiate Base class") if self.class.name == "Flexirest::Base"

  attrs.each do |attribute_name, attribute_value|
    attribute_name = attribute_name.to_sym
    @attributes[attribute_name] = parse_attribute_value(attribute_value)
    @dirty_attributes << attribute_name
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/flexirest/base.rb', line 113

def method_missing(name, *args)
  if name.to_s[-1,1] == "="
    name = name.to_s.chop.to_sym
    @attributes[name] = args.first
    @dirty_attributes << name
  else
    name_sym = name.to_sym
    name = name.to_s

    if @attributes.has_key? name_sym
      @attributes[name_sym]
    else
      if name[/^lazy_/] && mapped = self.class._mapped_method(name_sym)
        raise ValidationFailedException.new unless valid?
        request = Request.new(mapped, self, args.first)
        Flexirest::LazyLoader.new(request)
      elsif mapped = self.class._mapped_method(name_sym)
        raise ValidationFailedException.new unless valid?
        request = Request.new(mapped, self, args.first)
        request.call
      elsif self.class.whiny_missing
        raise NoAttributeException.new("Missing attribute #{name_sym}")
      else
        nil
      end
    end
  end
end

Instance Attribute Details

#_etag ⇒ Object

Returns the value of attribute _etag.



12
13
14
 
# File 'lib/flexirest/base.rb', line 12

def _etag
  @_etag
end

#_headers ⇒ Object

Returns the value of attribute _headers.



13
14
15
 
# File 'lib/flexirest/base.rb', line 13

def _headers
  @_headers
end

#_status ⇒ Object

Returns the value of attribute _status.



11
12
13
 
# File 'lib/flexirest/base.rb', line 11

def _status
  @_status
end

Class Method Details

._lazy_request(request, method = :get, params = nil) ⇒ Object 



62
63
64
 
# File 'lib/flexirest/base.rb', line 62

def self._lazy_request(request, method = :get, params = nil)
  Flexirest::LazyLoader.new(prepare_direct_request(request, method), params)
end

._plain_request(request, method = :get, params = nil) ⇒ Object 



58
59
60
 
# File 'lib/flexirest/base.rb', line 58

def self._plain_request(request, method = :get, params = nil)
  prepare_direct_request(request, method, plain:true).call(params)
end

._request(request, method = :get, params = nil) ⇒ Object 



54
55
56
 
# File 'lib/flexirest/base.rb', line 54

def self._request(request, method = :get, params = nil)
  prepare_direct_request(request, method).call(params)
end

._request_for(method_name, *args) ⇒ Object 



74
75
76
77
78
79
80
81
82
 
# File 'lib/flexirest/base.rb', line 74

def self._request_for(method_name, *args)
  if mapped = self._mapped_method(method_name)
    params = (args.first.is_a?(Hash) ? args.first : nil)
    request = Request.new(mapped, self, params)
    request
  else
    nil
  end
end

.prepare_direct_request(request, method = :get, options = {}) ⇒ Object 



66
67
68
69
70
71
72
 
# File 'lib/flexirest/base.rb', line 66

def self.prepare_direct_request(request, method = :get, options={})
  unless request.is_a? Flexirest::Request
    options[:plain] ||= false
    request = Flexirest::Request.new({ url: request, method: method, options: options }, self)
  end
  request
end

Instance Method Details

#[](key) ⇒ Object 



84
85
86
 
# File 'lib/flexirest/base.rb', line 84

def [](key)
  @attributes[key.to_sym]
end

#[]=(key, value) ⇒ Object 



88
89
90
91
 
# File 'lib/flexirest/base.rb', line 88

def []=(key, value)
  @attributes[key.to_sym] = value
  @dirty_attributes << key
end

#_attributes ⇒ Object 



37
38
39
 
# File 'lib/flexirest/base.rb', line 37

def _attributes
  @attributes
end

#_clean! ⇒ Object 



33
34
35
 
# File 'lib/flexirest/base.rb', line 33

def _clean!
  @dirty_attributes = Set.new
end

#_copy_from(result) ⇒ Object 



41
42
43
44
 
# File 'lib/flexirest/base.rb', line 41

def _copy_from(result)
  @attributes =  result._attributes
  @_status = result._status
end

#dirty? ⇒ Boolean

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/flexirest/base.rb', line 46

def dirty?
  @dirty_attributes.size > 0
end

#each ⇒ Object 



93
94
95
96
97
 
# File 'lib/flexirest/base.rb', line 93

def each
  @attributes.each do |key, value|
    yield key, value
  end
end

#errors ⇒ Object 



50
51
52
 
# File 'lib/flexirest/base.rb', line 50

def errors
  @attributes[:errors] || (_errors != {} ? _errors : nil)
end

#inspect ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/flexirest/base.rb', line 99

def inspect
  inspection = if @attributes.any?
                 @attributes.collect { |key, value|
                   "#{key}: #{value_for_inspect(value)}"
                 }.compact.join(", ")
               else
                 "[uninitialized]"
               end
  inspection += "#{"," if @attributes.any?} ETag: #{@_etag}" unless @_etag.nil?
  inspection += "#{"," if @attributes.any?} Status: #{@_status}" unless @_status.nil?
  inspection += " (unsaved: #{@dirty_attributes.map(&:to_s).join(", ")})" if @dirty_attributes.any?
  "#<#{self.class} #{inspection}>"
end

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

Returns:

  • (Boolean) 


142
143
144
 
# File 'lib/flexirest/base.rb', line 142

def respond_to_missing?(method_name, include_private = false)
  @attributes.has_key? method_name.to_sym
end

#to_hash ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/flexirest/base.rb', line 146

def to_hash
  output = {}
  @attributes.each do |key, value|
    if value.is_a? Flexirest::Base
      output[key.to_s] = value.to_hash
    elsif value.is_a? Array
      output[key.to_s] = value.map(&:to_hash)
    else
      output[key.to_s] = value
    end
  end
  output
end

#to_json ⇒ Object 



160
161
162
163
 
# File 'lib/flexirest/base.rb', line 160

def to_json
  output = to_hash
  output.to_json
end