Module: Api::Scheme

Defined in:
lib/api/scheme/version.rb,
lib/api/scheme.rb

Defined Under Namespace

Modules: Action

Constant Summary collapse

VERSION = 
"0.2.2"

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(klass) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/api/scheme.rb', line 5

def self.included klass
   # NOTE put default render handlers to the module to use from as if is the ancestor
   self.instance_variable_set(:@success_proc, :default_success_proc)
   self.instance_variable_set(:@error_proces, { nil => :default_error_proc })

   klass.class_eval %Q"
      class << self
         def error_map map
            @error_map ||= map
         end

         def model_error_map map
            @model_error_map ||= map
         end

         def param_map map
            @param_map ||= map
         end

         def render_success_with method = nil, &prc
            @success_proc ||= method || prc
         end

         def render_error_with method = nil, &prc
            render_error_code nil => (method || prc)
         end

         def render_error_code options = {}
            @error_proces = _getter(:@error_proces).merge(options)
         end

         def use_model name
            @model_name = name
         end

         def use_actions *list
            list.each do |action|
               Api::Scheme::Action.define_for(self, action)
            end

            Api::Scheme::Action::SCHEME.each do |method_name, cases|
               before = [ cases[:before] ].flatten.compact & list

               if before.present?
                  Api::Scheme::Action.define_for(self, method_name)
                  self.before_action(method_name, only: before)
               end
            end
         end

         def _getter var
            self.ancestors.reduce(nil) { |value, klass| value || klass.instance_variable_get(var) }
         end
      end
   "

   klass.rescue_from StandardError, with: :render_default_error
end

Instance Method Details

#_getter(var) ⇒ Object 



64
65
66
 
# File 'lib/api/scheme.rb', line 64

def _getter var
   self.class._getter(var)
end

#code_parse(code, e) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/api/scheme.rb', line 102

def code_parse code, e
   json = { message: e.message, type: e.class }

   case code
   when Range
      logger.error "#{e.class}: #{e.message}"

      [ code.first, json.merge(error_code: code.last) ]
   when NilClass
      logger.error "#{e.class}: #{e.message}\n\t#{e.backtrace[0...50].join("\n\t")}"

      [ 500, json ]
   else
      logger.error "#{e.class}: #{e.message}"

      [ code, json ]
   end
end

#default_error_proc(_, _, _, code, e) ⇒ Object 



184
185
186
187
188
 
# File 'lib/api/scheme.rb', line 184

def default_error_proc _, _, _, code, e
   status, json = code_parse(code, e)

   render data: json, status: status
end

#default_success_proc(data) ⇒ Object 



180
181
182
 
# File 'lib/api/scheme.rb', line 180

def default_success_proc data
   render data: data, status: 200
end

#error_map ⇒ Object 



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/api/scheme.rb', line 68

def error_map
   error_map = _getter(:@error_map)

   error_map ||= map
   return error_map if _getter(:@error_map_parsed)

   error_map = parse_error_map
   self.class.instance_variable_set(:@error_map_parsed, true)
   self.class.instance_variable_set(:@error_map, error_map)
end

#get_code_of_error_map(e) ⇒ Object 



129
130
131
132
133
 
# File 'lib/api/scheme.rb', line 129

def get_code_of_error_map e
   error_map.find do |errors, codes|
      errors.any? { |error| e.kind_of?(error) }
   end.try(:last)
end

#get_code_of_model_error_map(e) ⇒ Object 



121
122
123
124
125
126
127
 
# File 'lib/api/scheme.rb', line 121

def get_code_of_model_error_map e
   error_text = e.record.errors.messages.reduce(nil) {|s, (_, v)| s || v.join }

   _getter(:@model_error_map).to_a.reverse.reduce(nil) do |code, (re, new_code)|
      re =~ error_text && new_code || code
   end
end

#get_code_text(code) ⇒ Object 



149
150
151
152
153
 
# File 'lib/api/scheme.rb', line 149

def get_code_text code
   path = code.is_a?(Range) && "#{code.begin}.#{code.end}" || code.to_s

   I18n.t("action_controller.#{controller_path}.errors.#{path}")
end

#get_pure_code(code) ⇒ Object 



135
136
137
138
139
140
141
 
# File 'lib/api/scheme.rb', line 135

def get_pure_code code
   if code.is_a?(Range)
      code.begin
   else
      code
   end
end

#get_sub_code(code) ⇒ Object 



143
144
145
146
147
 
# File 'lib/api/scheme.rb', line 143

def get_sub_code code
   if code.is_a?(Range)
      code.end
   end
end

#model ⇒ Object 



190
191
192
 
# File 'lib/api/scheme.rb', line 190

def model
   @model ||= _getter(:@model_name).constantize
end

#model_instance ⇒ Object 



202
203
204
 
# File 'lib/api/scheme.rb', line 202

def model_instance
   self.instance_variable_get(:"@#{model_key}")
end

#model_instance=(value) ⇒ Object 



210
211
212
 
# File 'lib/api/scheme.rb', line 210

def model_instance= value
   self.instance_variable_set(:"@#{model_key}", value)
end

#model_instances ⇒ Object 



206
207
208
 
# File 'lib/api/scheme.rb', line 206

def model_instances
   self.instance_variable_get(:"@#{models_key}")
end

#model_instances=(value) ⇒ Object 



214
215
216
 
# File 'lib/api/scheme.rb', line 214

def model_instances= value
   self.instance_variable_set(:"@#{models_key}", value)
end

#model_key ⇒ Object 



194
195
196
 
# File 'lib/api/scheme.rb', line 194

def model_key
   model.name.tableize.singularize
end

#models_key ⇒ Object 



198
199
200
 
# File 'lib/api/scheme.rb', line 198

def models_key
   model.name.tableize
end

#parse_error_map ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/api/scheme.rb', line 79

def parse_error_map
   error_map = _getter(:@error_map)
   error_map.map do |(errors, code)|
      list = errors.map do |e|
         begin
            e.constantize
         rescue NameError
            begin
               "#{self.class}::#{e}".constantize
            rescue NameError
               begin
                  send(:class_eval, e.camelize)
               rescue NameError
                  raise InvalidErrorTypeError, e
               end
            end
         end
      end

      [ list, code ]
   end.to_h
end

#permitted_params ⇒ Object 



231
232
233
234
235
236
237
238
239
 
# File 'lib/api/scheme.rb', line 231

def permitted_params
   param_map = _getter(:@param_map)

   if param_map.is_a?(Hash)
      permitted_params_require(param_map.keys.first, param_map.values.first)
   else
      permitted_params_permit([ param_map ].flatten)
   end
end

#permitted_params_permit(keys) ⇒ Object 



222
223
224
225
226
227
228
229
 
# File 'lib/api/scheme.rb', line 222

def permitted_params_permit keys
   default = {}

   keys.reduce(default) do |h, key|
      value = /(?<name>.*)\?$/ =~ key ? params[name] : params.require(key)
      value.nil? && h || h.merge( (name || key).to_sym => value )
   end
end

#permitted_params_require(key, map) ⇒ Object 



218
219
220
 
# File 'lib/api/scheme.rb', line 218

def permitted_params_require key, map
   params.require(key).permit(*map)
end

#render_default_error(e) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/api/scheme.rb', line 163

def render_default_error e
   code =
   if e.to_s.split('::').last == 'Validations'
      get_code_of_model_error_map(e)
   else
      get_code_of_error_map(e)
   end

   error_proces = _getter(:@error_proces)
   error_proc = error_proces[code] || error_proces[nil]

   prc = error_proc.kind_of?(Proc) && error_proc || self.method(error_proc.to_s.to_sym)
   args = [get_code_text(code), get_sub_code(code), get_pure_code(code), code, e ]

   prc[*args[0...prc.arity.abs]]
end

#render_default_success(data, options = {}) ⇒ Object 



155
156
157
158
159
160
161
 
# File 'lib/api/scheme.rb', line 155

def render_default_success data, options = {}
   success_proc = _getter(:@success_proc)

   prc = success_proc.kind_of?(Proc) && success_proc || self.method(success_proc.to_s.to_sym)

   prc[data, options]
end

#validate_access_token ⇒ Object

Raises:

  • (InvalidUserError) 


241
242
243
 
# File 'lib/api/scheme.rb', line 241

def validate_access_token
   raise InvalidUserError if not current_user
end