Class: ThreeScaleToolbox::Entities::Metric

Inherits:
Object
  • Object
show all
Includes:
CRD::MetricSerializer
Defined in:
lib/3scale_toolbox/entities/metric.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from CRD::MetricSerializer

#to_cr

Constructor Details

#initialize(id:, service:, attrs: nil) ⇒ Metric

Returns a new instance of Metric.



30
31
32
33
34
35
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 30

def initialize(id:, service:, attrs: nil)
  @id = id.to_i
  @service = service
  @remote = service.remote
  @attrs = attrs
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



28
29
30
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 28

def id
  @id
end

#remote ⇒ Object (readonly)

Returns the value of attribute remote.



28
29
30
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 28

def remote
  @remote
end

#service ⇒ Object (readonly)

Returns the value of attribute service.



28
29
30
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 28

def service
  @service
end

Class Method Details

.create(service:, attrs:) ⇒ Object 



7
8
9
10
11
12
13
14
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 7

def create(service:, attrs:)
  metric = service.remote.create_metric service.id, attrs
  if (errors = metric['errors'])
    raise ThreeScaleToolbox::ThreeScaleApiError.new('Metric has not been created', errors)
  end

  new(id: metric.fetch('id'), service: service, attrs: metric)
end

.find(service:, ref:) ⇒ Object

ref can be system_name or metric_id



17
18
19
20
21
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 17

def find(service:, ref:)
  new(id: ref, service: service).tap(&:attrs)
rescue ThreeScale::API::HttpClient::NotFoundError
  find_by_system_name(service: service, system_name: ref)
end

.find_by_system_name(service:, system_name:) ⇒ Object 



23
24
25
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 23

def find_by_system_name(service:, system_name:)
  service.metrics.find { |m| m.system_name == system_name }
end

Instance Method Details

#attrs ⇒ Object 



37
38
39
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 37

def attrs
  @attrs ||= metric_attrs
end

#delete ⇒ Object 



91
92
93
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 91

def delete
  remote.delete_metric service.id, id
end

#description ⇒ Object 



53
54
55
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 53

def description
  attrs['description']
end

#disable ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 57

def disable
  # For each plan, get limits for the current metric
  # if already disabled -> NOOP
  # if non zero eternity limit exist, update
  # if non eternity limit exist, create
  service.plans.each do |plan|
    eternity_limit = plan_eternity_limit(plan)
    if eternity_limit.nil?
      plan.create_limit(id, zero_eternity_limit_attrs)
    elsif !eternity_limit.value.zero?
      eternity_limit.update(zero_eternity_limit_attrs)
    end
  end
end

#enable ⇒ Object 



72
73
74
75
76
77
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 72

def enable
  service.plans.each do |plan|
    limit = plan_zero_eternity_limit(plan)
    limit.delete unless limit.nil?
  end
end

#friendly_name ⇒ Object 



45
46
47
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 45

def friendly_name
  attrs['friendly_name']
end

#system_name ⇒ Object 



41
42
43
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 41

def system_name
  attrs['system_name']
end

#unit ⇒ Object 



49
50
51
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 49

def unit
  attrs['unit']
end

#update(new_metric_attrs) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/3scale_toolbox/entities/metric.rb', line 79

def update(new_metric_attrs)
  new_attrs = remote.update_metric(service.id, id, new_metric_attrs)
  if (errors = new_attrs['errors'])
    raise ThreeScaleToolbox::ThreeScaleApiError.new('Metric has not been updated', errors)
  end

  # update current attrs
  @attrs = new_attrs

  new_attrs
end