Class: ThreeScaleToolbox::Entities::BackendMethod

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

Constant Summary collapse

VALID_PARAMS = 
%w[friendly_name system_name description].freeze
METHOD_BLACKLIST = 
%w[id links created_at updated_at parent_id].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from CRD::BackendMethodSerializer

#to_cr

Constructor Details

#initialize(id:, backend:, attrs: nil) ⇒ BackendMethod

Returns a new instance of BackendMethod.



37
38
39
40
41
42
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 37

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

Instance Attribute Details

#backend ⇒ Object (readonly)

Returns the value of attribute backend.



35
36
37
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 35

def backend
  @backend
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



35
36
37
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 35

def id
  @id
end

#remote ⇒ Object (readonly)

Returns the value of attribute remote.



35
36
37
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 35

def remote
  @remote
end

Class Method Details

.create(backend:, attrs:) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 12

def create(backend:, attrs:)
  method = backend.remote.create_backend_method(backend.id, backend.hits.id,
                                                Helper.filter_params(VALID_PARAMS, attrs))
  if (errors = method['errors'])
    raise ThreeScaleToolbox::ThreeScaleApiError.new('Backend Method has not been created',
                                                    errors)
  end

  new(id: method.fetch('id'), backend: backend, attrs: method)
end

.find(backend:, ref:) ⇒ Object

ref can be system_name or method_id



24
25
26
27
28
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 24

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

.find_by_system_name(backend:, system_name:) ⇒ Object 



30
31
32
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 30

def find_by_system_name(backend:, system_name:)
  backend.methods.find { |m| m.system_name == system_name }
end

Instance Method Details

#attrs ⇒ Object 



44
45
46
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 44

def attrs
  @attrs ||= process_attrs(method_attrs)
end

#delete ⇒ Object 



72
73
74
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 72

def delete
  remote.delete_backend_method backend.id, hits_id, id
end

#description ⇒ Object 



56
57
58
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 56

def description
  attrs['description']
end

#enriched_key ⇒ Object

enriched_key returns a metric key that will be unique for all metrics/methods from products and backends



78
79
80
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 78

def enriched_key
  "backend.#{backend.id}.#{id}"
end

#friendly_name ⇒ Object 



52
53
54
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 52

def friendly_name
  attrs['friendly_name']
end

#system_name ⇒ Object 



48
49
50
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 48

def system_name
  attrs['system_name']
end

#to_hash ⇒ Object 



82
83
84
85
86
87
88
 
# File 'lib/3scale_toolbox/entities/backend_method.rb', line 82

def to_hash
  extra_attrs = {
    'backend_system_name' => backend.system_name
  }

  attrs.merge(extra_attrs).reject { |key, _| METHOD_BLACKLIST.include? key }
end

#update(m_attrs) ⇒ Object 



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

def update(m_attrs)
  new_attrs = remote.update_backend_method(backend.id, hits_id, id,
                                           Helper.filter_params(VALID_PARAMS, m_attrs))
  if (errors = new_attrs['errors'])
    raise ThreeScaleToolbox::ThreeScaleApiError.new('Backend Method has not been updated',
                                                    errors)
  end

  # update current attrs
  @attrs = process_attrs(new_attrs)
end