Class: LabClient::Klass

Inherits:
LabStruct
  • Object
show all
Extended by:
Docs
Includes:
CurlHelper
Defined in:
lib/labclient/klass.rb

Overview

Common Configuration for all Class Helpers

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Docs

demo, desc, doc, docs, example, json, markdown, navigation, option, result, subtitle, title

Methods included from CurlHelper

#curl

Methods inherited from LabStruct

#as_json, #inspect, #keys, #slice

Constructor Details

#initialize(hash = nil, response = nil, client = nil) ⇒ Klass

rubocop:disable Lint/MissingSuper



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/labclient/klass.rb', line 99

def initialize(hash = nil, response = nil, client = nil)
  @client = client
  @response = response

  @table = {}
  hash&.each_pair do |k, v|
    k = k.to_sym
    @table[k] = v
  end
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



7
8
9
 
# File 'lib/labclient/klass.rb', line 7

def client
  @client
end

#response ⇒ Object (readonly)

Returns the value of attribute response.



7
8
9
 
# File 'lib/labclient/klass.rb', line 7

def response
  @response
end

Class Method Details

.date_time_attrs(list) ⇒ Object

Define a list of DateTime Attributes



122
123
124
125
126
127
128
 
# File 'lib/labclient/klass.rb', line 122

def self.date_time_attrs(list)
  list.each do |kind|
    define_method(kind) do
      DateTime.parse @table[kind] if has? kind
    end
  end
end

.user_attrs(list) ⇒ Object

Define a list of LabClient::User Attributes



131
132
133
134
135
136
137
 
# File 'lib/labclient/klass.rb', line 131

def self.user_attrs(list)
  list.each do |kind|
    define_method(kind) do
      User.new(@table[kind], response, client) if has? kind
    end
  end
end

Instance Method Details

#api_methods ⇒ Object

Documented API Methods



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/labclient/klass.rb', line 43

def api_methods
  docs = LabClient::Docs.docs.dig(group_name, 'Reference')

  unless docs
    puts 'No Available Help'
    return false
  end

  LabClient::Docs.docs.dig(group_name, 'Reference').map do |doc|
    doc[:options].map do |opt|
      opt[:name]
    end
  end.flatten.sort
end

#collect_project_id(position = 1) ⇒ Object Also known as: collect_group_id, collect_user_id

TODO: Combine all of these?



63
64
65
 
# File 'lib/labclient/klass.rb', line 63

def collect_project_id(position = 1)
  response.path.split('/')[position]
end

#collect_release_id(position = 3) ⇒ Object 



70
71
72
 
# File 'lib/labclient/klass.rb', line 70

def collect_release_id(position = 3)
  response.path.split('/')[position]
end

#collect_repository_id(position = 4) ⇒ Object 



74
75
76
 
# File 'lib/labclient/klass.rb', line 74

def collect_repository_id(position = 4)
  response.path.split('/')[position]
end

#format_time?(time) ⇒ Boolean

Formatting Time Helper

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/labclient/klass.rb', line 117

def format_time?(time)
  time.respond_to?(:to_time)
end

#group_name ⇒ Object

Category and Primary Key for docs



79
80
81
 
# File 'lib/labclient/klass.rb', line 79

def group_name
  self.class.instance_variable_get('@group_name') || klass.pluralize
end

#help(help_filter = nil) ⇒ Object

API Methods here have to be explicitly documented / custom helpers Assume no methods by default rubocop:disable Metrics/AbcSize



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/labclient/klass.rb', line 18

def help(help_filter = nil)
  docs = LabClient::Docs.docs.dig(group_name, 'Reference')
  unless docs
    puts 'No Available Help'
    return false
  end

  puts klass
  docs.each do |doc|
    next unless doc[:options]

    doc[:options].each do |opt|
      next if help_filter && !(opt[:name] + opt[:text]).include?(help_filter.to_s)

      puts "  #{opt[:name]}"
      puts "    #{opt[:text]}\n"
    end
  end

  # Ignore Output
  nil
end

#klass ⇒ Object

Helper to get docs



89
90
91
 
# File 'lib/labclient/klass.rb', line 89

def klass
  self.class.name.split('::', 2).last.split(/(?=[A-Z])/).join(' ')
end

#success? ⇒ Boolean

Forward response success

Returns:

  • (Boolean) 


112
113
114
 
# File 'lib/labclient/klass.rb', line 112

def success?
  @response.success?
end

#to_json(*_args) ⇒ Object

Prevent stack level errors, but turning into has first



84
85
86
 
# File 'lib/labclient/klass.rb', line 84

def to_json(*_args)
  to_h.to_json
end

#update_self(obj) ⇒ Object 



93
94
95
96
 
# File 'lib/labclient/klass.rb', line 93

def update_self(obj)
  @table = obj.table
  self
end

#valid_group_project_levels ⇒ Object 



58
59
60
 
# File 'lib/labclient/klass.rb', line 58

def valid_group_project_levels
  %i[guest reporter developer maintainer owner]
end

#verbose ⇒ Object 



11
12
13
 
# File 'lib/labclient/klass.rb', line 11

def verbose
  ap self, ruby19_syntax: true
end