Module: PowerApi::GeneratorHelper::ApiHelper

Extended by:
ActiveSupport::Concern
Included in:
PowerApi::GeneratorHelpers
Defined in:
lib/power_api/generator_helper/api_helper.rb

Instance Method Summary collapse

Instance Method Details

#api_class ⇒ Object 



44
45
46
47
48
 
# File 'lib/power_api/generator_helper/api_helper.rb', line 44

def api_class
  return version_class if versioned_api?

  internal_class
end

#api_file_path ⇒ Object 



26
27
28
29
30
 
# File 'lib/power_api/generator_helper/api_helper.rb', line 26

def api_file_path
  return version_file_path if versioned_api?

  internal_file_path
end

#exposed_class ⇒ Object 



58
59
60
 
# File 'lib/power_api/generator_helper/api_helper.rb', line 58

def exposed_class
  "Api::Exposed"
end

#exposed_file_path ⇒ Object 



40
41
42
 
# File 'lib/power_api/generator_helper/api_helper.rb', line 40

def exposed_file_path
  "api/exposed"
end

#first_version? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/power_api/generator_helper/api_helper.rb', line 18

def first_version?
  version_number.to_i == 1
end

#internal_class ⇒ Object 



54
55
56
 
# File 'lib/power_api/generator_helper/api_helper.rb', line 54

def internal_class
  "Api::Internal"
end

#internal_file_path ⇒ Object 



36
37
38
 
# File 'lib/power_api/generator_helper/api_helper.rb', line 36

def internal_file_path
  "api/internal"
end

#version_class ⇒ Object 



50
51
52
 
# File 'lib/power_api/generator_helper/api_helper.rb', line 50

def version_class
  "#{exposed_class}::V#{version_number}"
end

#version_file_path ⇒ Object 



32
33
34
 
# File 'lib/power_api/generator_helper/api_helper.rb', line 32

def version_file_path
  "#{exposed_file_path}/v#{version_number}"
end

#version_number=(value) ⇒ Object

Raises:



8
9
10
11
12
13
14
15
16
 
# File 'lib/power_api/generator_helper/api_helper.rb', line 8

def version_number=(value)
  if value.blank?
    @version_number = nil
    return
  end

  @version_number = value.to_s.to_i
  raise PowerApi::GeneratorError.new("invalid version number") if version_number < 1
end

#versioned_api? ⇒ Boolean

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/power_api/generator_helper/api_helper.rb', line 22

def versioned_api?
  !!version_number
end