5 def self.describe_aviator
6 str = "Available providers:\n"
8 provider_names.each do |provider_name|
9 str << " #{ provider_name }\n"
16 def self.describe_provider(provider_name)
17 str = "Available services for #{ provider_name }:\n"
19 service_names(provider_name).each do |service_name|
20 str << " #{ service_name }\n"
27 def self.describe_request(provider_name, service_name, api_version, endpoint_type, request_name)
28 service = Aviator::Service.new :provider => provider_name, :service => service_name
29 request_class = "Aviator::#{ provider_name.camelize }::#{ service_name.camelize }::"\
30 "#{ api_version.camelize }::#{ endpoint_type.camelize }::#{ request_name.camelize }".constantize
32 display = ":Request => #{ request_name }\n"
35 # Build the parameters
36 params = request_class.optional_params.map{|p| [p, false]} +
37 request_class.required_params.map{|p| [p, true]}
39 aliases = request_class.param_aliases
44 headings = ['NAME', 'REQUIRED?']
46 headings << 'ALIAS' if aliases.length > 0
49 params.sort{|a,b| a[0].to_s <=> b[0].to_s }.each do |param|
50 row = [ param[0], param[1] ? 'Y' : 'N' ]
53 row << (aliases.find{|a,p| p == param[0] } || [''])[0]
60 rows.map{|row| row[0].to_s.length }.max,
61 rows.map{|row| row[1].to_s.length }.max
64 widths << rows.map{|row| row[2].to_s.length }.max if aliases.length > 0
66 table = Terminal::Table.new(:headings => headings, :rows => rows)
68 table.align_column(1, :center)
70 display << "Parameters:\n"
71 display << " " + table.to_s.split("\n").join("\n ")
76 # Build the sample code
77 display << "\nSample Code:\n"
79 display << " session.#{ service_name }_service.request(:#{ request_name })"
81 if params && params.length > 0
82 display << " do |params|\n"
84 display << " params.#{ (aliases.find{|a,p| p == pair[0] } || pair)[0] } = value\n"
93 if request_class.links && request_class.links.length > 0
94 display << "\nLinks:\n"
96 request_class.links.each do |link|
97 display << " #{ link[:rel] }:\n"
98 display << " #{ link[:href] }\n"
106 def self.describe_service(provider_name, service_name)
107 str = "Available requests for #{ provider_name } #{ service_name }_service:\n"
109 request_classes(provider_name, service_name).each do |klass|
110 str << " #{ klass.api_version } #{ klass.endpoint_type } #{ klass.name.split('::').last.underscore }\n"
121 Pathname.new(__FILE__) \
122 .join('..', '..', '..') \
124 .select{|c| c.directory? && c.basename.to_s != 'core' } \
125 .map{|c| c.basename.to_s }
129 def request_classes(provider_name, service_name)
130 service = Aviator::Service.new(:provider => provider_name, :service => service_name)
131 service.request_classes
135 def service_names(provider_name)
136 Pathname.new(__FILE__) \
137 .join('..', '..', '..', provider_name) \
139 .select{|c| c.directory? } \
140 .map{|c| c.basename.to_s }