Class: Swagger::Data::Info

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-swagger/data/info.rb

Overview

github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#info-object

Constant Summary collapse

DEFAULT_TITLE = 
'My uber-duper API'
DEFAULT_DESCRIPTION = 
'My uber-duper API description'
DEFAULT_VERSION = 
'0.1'

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

attr_swagger, #bulk_set, #swagger_attributes, #to_json, #to_swagger, #to_yaml

Constructor Details

#initialize ⇒ Info

Returns a new instance of Info.



13
14
15
16
17
 
# File 'lib/ruby-swagger/data/info.rb', line 13

def initialize
  @title = DEFAULT_TITLE
  @description = DEFAULT_DESCRIPTION
  @version = DEFAULT_VERSION
end

Class Method Details

.parse(info) ⇒ Object

Raises:

  • (ArgumentError) 


19
20
21
22
23
 
# File 'lib/ruby-swagger/data/info.rb', line 19

def self.parse(info)
  raise ArgumentError.new('Swagger::Data::Info#parse - info object is nil') unless info

  Swagger::Data::Info.new.bulk_set(info)
end

Instance Method Details

#contact=(new_contact) ⇒ Object 



30
31
32
33
34
35
36
37
38
 
# File 'lib/ruby-swagger/data/info.rb', line 30

def contact=(new_contact)
  return nil unless new_contact

  unless new_contact.is_a?(Swagger::Data::Contact)
    new_contact = Swagger::Data::Contact.parse(new_contact)
  end

  @contact = new_contact
end

#license=(new_license) ⇒ Object 



40
41
42
43
44
45
46
47
48
 
# File 'lib/ruby-swagger/data/info.rb', line 40

def license=(new_license)
  return nil unless new_license

  unless new_license.is_a?(Swagger::Data::License)
    new_license = Swagger::Data::License.parse(new_license)
  end

  @license = new_license
end

#title=(new_title) ⇒ Object

Raises:

  • (ArgumentError) 


25
26
27
28
 
# File 'lib/ruby-swagger/data/info.rb', line 25

def title=(new_title)
  raise ArgumentError.new('Swagger::Data::Info#title= - title is invalid') if new_title.nil? || new_title.empty?
  @title = new_title
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/ruby-swagger/data/info.rb', line 50

def valid?
  @license.valid? && @contact.valid?
end