Class: Swagger::Data::Contact

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

Overview

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

Constant Summary collapse

DEFAULT_NAME = 
'John Doe'
DEFAULT_EMAIL = 
'[email protected]'
DEFAULT_URL = 
'https://google.com/?q=john%20doe'

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 ⇒ Contact

Returns a new instance of Contact.



15
16
17
18
19
 
# File 'lib/ruby-swagger/data/contact.rb', line 15

def initialize
  @name = DEFAULT_NAME
  @email = DEFAULT_EMAIL
  @url = Swagger::Data::Url.new DEFAULT_URL
end

Class Method Details

.parse(contact) ⇒ Object 



21
22
23
24
25
26
27
28
 
# File 'lib/ruby-swagger/data/contact.rb', line 21

def self.parse(contact)
  return nil unless contact

  c = Swagger::Data::Contact.new.bulk_set(contact)
  c.validate_url!

  c
end

Instance Method Details

#url ⇒ Object 



36
37
38
 
# File 'lib/ruby-swagger/data/contact.rb', line 36

def url
  @url.url
end

#url=(url) ⇒ Object 



30
31
32
33
34
 
# File 'lib/ruby-swagger/data/contact.rb', line 30

def url=(url)
  return nil unless url

  @url = Swagger::Data::Url.new(url)
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/ruby-swagger/data/contact.rb', line 40

def valid?
  true
end

#validate_url! ⇒ Object 



44
45
46
 
# File 'lib/ruby-swagger/data/contact.rb', line 44

def validate_url!
  raise (ArgumentError.new("Swagger::Data::Contact - contact url is invalid")) if @url && !@url.valid?
end