Class: Modgen::API::Method

Inherits:
Object show all
Defined in:
lib/modgen/discovery/method.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, values) ⇒ Method

Returns a new instance of Method.



7
8
9
10
11
12
13
14
15
16
 
# File 'lib/modgen/discovery/method.rb', line 7

def initialize(name, values)
  @name   = name
  @values = values

  @path               = values['path']
  @url                = URI.join(Modgen.config.api.base_url, "#{Modgen::API.api.version}/", @path)
  @http_method        = values['http_method']
  @description        = values['description']
  @method_parameters  = values['parameters']
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



5
6
7
 
# File 'lib/modgen/discovery/method.rb', line 5

def description
  @description
end

#http_method ⇒ Object (readonly)

Returns the value of attribute http_method.



5
6
7
 
# File 'lib/modgen/discovery/method.rb', line 5

def http_method
  @http_method
end

#method_parameters ⇒ Object (readonly)

Returns the value of attribute method_parameters.



5
6
7
 
# File 'lib/modgen/discovery/method.rb', line 5

def method_parameters
  @method_parameters
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



5
6
7
 
# File 'lib/modgen/discovery/method.rb', line 5

def name
  @name
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



5
6
7
 
# File 'lib/modgen/discovery/method.rb', line 5

def path
  @path
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



5
6
7
 
# File 'lib/modgen/discovery/method.rb', line 5

def url
  @url
end

Instance Method Details

#build_file(path) ⇒ Object 



90
91
92
93
 
# File 'lib/modgen/discovery/method.rb', line 90

def build_file(path)
  mime = MimeMagic.by_path(path)
  Faraday::UploadIO.new(path, mime)
end

#build_request_data(params = {}) ⇒ Object

Buld request data based on discoverd API



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/modgen/discovery/method.rb', line 97

def build_request_data(params = {})
  result = {
    'path'   => {},
    'params' => {},
    'body'   => {}
  }

  params.each do |key, value|
    case @method_parameters[key]['location']
      when 'path'; result['path'][key] = value
      when 'body'; result['body'][key] = value
      else
        if @method_parameters[key]['type'] == 'file'
          result['params'][key] = build_file(value)
        else
          result['params'][key] = value
        end
    end
  end

  result
end

#call(params) ⇒ Object 



18
19
20
21
22
23
24
 
# File 'lib/modgen/discovery/method.rb', line 18

def call(params)
  # if params == nil
  #   return self
  # end

  query(params)
end

#check_type(param, value, *types) ⇒ Object

Check if value has property type(s)

Raises:



28
29
30
31
32
33
34
 
# File 'lib/modgen/discovery/method.rb', line 28

def check_type(param, value, *types)
  types.each do |type|
    return(true) if value.is_a?(type)
  end

  raise Modgen::APIRequestError, "Parameter #{param} has invalid type. Must be #{types.join(' or ')}."
end

#query(params) ⇒ Object

Create request and call response on it.



122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/modgen/discovery/method.rb', line 122

def query(params)
  request_data = {}

  if !params.is_a?(Hash)
    raise Modgen::TypeError, "Parameters must be Hash. #{params.class.name} inserted."
  end

  validate_parameters(@method_parameters, params)
  request_data = build_request_data(params)

  Modgen::API::APIRequest.new(self, request_data).response
end

#validate_parameter(param, spec, value) ⇒ Object

Check one parameter



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
63
64
65
 
# File 'lib/modgen/discovery/method.rb', line 38

def validate_parameter(param, spec, value)
  if value.nil?
    if spec['required']
      raise Modgen::APIRequestError, "Parameter #{param} is required."
    end

    return 'next'
  end

  case spec['type']
    when 'integer'; check_type(param, value, Integer)
    when 'float';   check_type(param, value, Integer, Float)
    when 'string';  check_type(param, value, String)
    when 'hash'
      check_type(param, value, Hash)
      validate_parameters(spec['attributes'], value)
    when 'file'
      if !File.file?(value)
        raise Modgen::APIRequestError, "File #{value} doesn't exists."
      end
  end

  if spec['format']
    unless value =~ /#{spec['format']}/
      raise Modgen::APIRequestError, "Parameter #{param} hasn't required format (#{spec['format']})."
    end
  end
end

#validate_parameters(attributes, params = {}) ⇒ Object

Check all parameters



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/modgen/discovery/method.rb', line 69

def validate_parameters(attributes, params = {})
  if !attributes
    return nil
  end

  params.stringify_keys!

  parameters_left = params.keys - attributes.keys
  if !parameters_left.empty?
    raise Modgen::APIRequestError, "Parameters: #{parameters_left} are unknow."
  end

  attributes.each do |param, spec|
    value = params[param]

    if validate_parameter(param, spec, value) == 'next'
      next
    end
  end
end