Class: PuzzlyApiPlugin::Api

Inherits:
Metadata show all
Defined in:
lib/puzzly_api_plugin/metadata/api.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Metadata

#id, #name, #path, #to_identity

Methods inherited from JSONable

#copy_to_hash, #to_s

Constructor Details

#initialize(document, module_id, name, description, graphQL_file, swagger_file) ⇒ Api

Returns a new instance of Api.



14
15
16
17
18
19
20
21
22
 
# File 'lib/puzzly_api_plugin/metadata/api.rb', line 14

def initialize(document, module_id, name, description, graphQL_file, swagger_file)
  super(document, name)
  self[MetadataFields::MODULE_ID] = module_id
  self[MetadataFields::DESCRIPTION] = description
  self[MetadataFields::GRAPHQL_FILE] = graphQL_file
  self[MetadataFields::SWAGGER_FILE] = swagger_file

  validate
end

Class Method Details

.create(document) ⇒ Object 



5
6
7
8
9
10
11
12
 
# File 'lib/puzzly_api_plugin/metadata/api.rb', line 5

def self.create(document)
  Api.new(document,
          document.data[YAMLFields::MODULE_ID],
          document.data[YAMLFields::API_NAME],
          document.data[YAMLFields::API_DESCRIPTION],
          document.data[YAMLFields::API_GRAPHQL_FILE],
          document.data[YAMLFields::API_SWAGGER_FILE])
end

Instance Method Details

#description ⇒ Object 



50
51
52
 
# File 'lib/puzzly_api_plugin/metadata/api.rb', line 50

def description
  self[MetadataFields::DESCRIPTION]
end

#graphQL_file ⇒ Object 



54
55
56
 
# File 'lib/puzzly_api_plugin/metadata/api.rb', line 54

def graphQL_file
  self[MetadataFields::GRAPHQL_FILE]
end

#module_id ⇒ Object 



46
47
48
 
# File 'lib/puzzly_api_plugin/metadata/api.rb', line 46

def module_id
  self[MetadataFields::MODULE_ID]
end

#swagger_file ⇒ Object 



58
59
60
 
# File 'lib/puzzly_api_plugin/metadata/api.rb', line 58

def swagger_file
  self[MetadataFields::SWAGGER_FILE]
end

#validate ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/puzzly_api_plugin/metadata/api.rb', line 24

def validate     
  if(module_id.nil?)
    warn "Please set #{YAMLFields::MODULE_ID} property"
  end

  if(name.nil?)
    warn "Please set #{YAMLFields::API_NAME} property"
  end

  if(description.nil?)
    warn "Please set #{YAMLFields::API_DESCRIPTION} property"
  end

  if(graphQL_file.nil?)
    warn "Please set #{YAMLFields::API_GRAPHQL_FILE} property"
  end

  if(swagger_file.nil?)
    warn "Please set #{YAMLFields::API_SWAGGER_FILE} property"
  end
end