Module: MachineShop::Util

Defined in:
lib/machineshop/util.rb

Class Method Summary collapse

Class Method Details

.convert_to_machineshop_object(resp, auth_token, type = nil) ⇒ Object 



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
 
# File 'lib/machineshop/util.rb', line 18

def self.convert_to_machineshop_object(resp, auth_token, type=nil)
  types = {
    'Device' => Device,
    'DeviceInstance' => DeviceInstance,
    'Mapping' => Mapping,
    'Meter' => Meter,
    'Report' => Report,
    'Rule' => Rule,
    # 'User' => User,
    'Users' => Users,
    'Utility' => Utility,
    'Customer'=> Customer
  }
  case resp
  when Array
    resp.map { |i| convert_to_machineshop_object(i, auth_token, type) }
  when Hash
    # Try converting to a known object class.  If none available, fall back to generic APIResource
    if klass_name = type
      klass = types[klass_name]
    end
    klass ||= MachineShopObject
    klass.construct_from(resp, auth_token)
  else
    resp
  end
end

.db_connected? ⇒ Boolean

Check if db_connected

Returns:

  • (Boolean) 


123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/machineshop/util.rb', line 123

def self.db_connected?
  db_connected = true
  begin
    MachineShop::Database.new
  rescue DatabaseError =>e
    # puts e.message
    db_connected= false
  rescue SchemaError =>e
    # puts e.message
    # db_connected=true
  end

  db_connected
end

.file_readable(file) ⇒ Object 



46
47
48
49
50
51
52
53
54
 
# File 'lib/machineshop/util.rb', line 46

def self.file_readable(file)
  begin
    File.open(file) { |f| }
  rescue
    false
  else
    true
  end
end

.flatten_params(params, parent_key = nil) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/machineshop/util.rb', line 76

def self.flatten_params(params, parent_key=nil)
  result = []
  params.each do |key, value|
    calculated_key = parent_key ? "#{parent_key}[#{url_encode(key)}]" : url_encode(key)
    if value.is_a?(Hash)
      result += flatten_params(value, calculated_key)
    elsif value.is_a?(Array)
      result += flatten_params_array(value, calculated_key)
    else
      result << [calculated_key, value]
    end
  end
  result
end

.flatten_params_array(value, calculated_key) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/machineshop/util.rb', line 91

def self.flatten_params_array(value, calculated_key)
  result = []
  value.each do |elem|
    if elem.is_a?(Hash)
      result += flatten_params(elem, calculated_key)
    elsif elem.is_a?(Array)
      result += flatten_params_array(elem, calculated_key)
    else
      result << ["#{calculated_key}[]", elem]
    end
  end
  result
end

.get_klass_from_url(url) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/machineshop/util.rb', line 105

def self.get_klass_from_url(url)
  id=nil
  klass=nil
  splitted = url.split('/')
  klass = splitted[-1]
  if /[0-9]/.match(klass)
    id=splitted[-1]

    if splitted[-3]=="rule"
      klass="rule"
    else
      klass = splitted[-2]
    end
  end
  return id,klass
end

.objects_to_ids(h) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/machineshop/util.rb', line 3

def self.objects_to_ids(h)
  case h
  when APIResource
    h.id
  when Hash
    res = {}
    h.each { |k, v| res[k] = objects_to_ids(v) unless v.nil? }
    res
  when Array
    h.map { |v| objects_to_ids(v) }
  else
    h
  end
end

.symbolize_names(object) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/machineshop/util.rb', line 56

def self.symbolize_names(object)
  case object
  when Hash
    new = {}
    object.each do |key, value|
      key = (key.to_sym rescue key) || key
      new[key] = symbolize_names(value)
    end
    new
  when Array
    object.map { |value| symbolize_names(value) }
  else
    object
  end
end

.url_encode(key) ⇒ Object 



72
73
74
 
# File 'lib/machineshop/util.rb', line 72

def self.url_encode(key)
  URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
end

.valid_endpoint(name, auth_token, verb, params) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/machineshop/util.rb', line 139

def self.valid_endpoint(name,auth_token,verb,params)
  if Util.db_connected?
    endpoints_upto_date=false

    ApiRequest.cache("/gem/routes/#{MachineShop.configuration.base_version}", auth_token, MachineShop.configuration.custom_endpoints_cache_time) do
      #time not expired, cached routes are oke
      endpoints_upto_date = true
    end

    if !endpoints_upto_date
      #request the endpoints
      MachineShop::EndPoints.all(MachineShop.configuration.base_version,auth_token)

    end

    endpoint = ApiEndpoint.where(:verb=>verb).where(:auth_token=>auth_token).where("api_endpoints.endpoint LIKE :endpoint", {:endpoint => "/#{name}%"}).take(1)
    if !endpoint.empty?
      splitEndpoints = (endpoint[0].endpoint).split("/").reject{|val| val=="" }
      if splitEndpoints[0]==name
        url="/"
        key=0
        splitEndpoints.each do |v|
          if v.start_with? ":" #parameter
            if params[key]
              url+=params[key]
              key+=1
            else
              raise APIError.new("Invalid parameters, Please provide value for #{v}")
            end
          else
            url+="#{v}/"
          end
        end
      end
      return url
    else
      raise APIError.new("Invalid url request")
      return false
    end
  end
end