Module: Useless::Doc::Router

Included in:
Default
Defined in:
lib/useless/doc/router.rb

Overview

Doc::Router determines the doc URL for an API and vice versa via the #doc_for_api and #api_for_doc methods, respectively.

Defined Under Namespace

Classes: Default

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.default ⇒ Object 



10
11
12
 
# File 'lib/useless/doc/router.rb', line 10

def self.default
  @default ||= Doc::Router::Default.new
end

.uri_for(raw_url) ⇒ Object 



14
15
16
17
18
19
20
21
22
 
# File 'lib/useless/doc/router.rb', line 14

def self.uri_for(raw_url)
  url = raw_url.dup

  unless url =~ /^https?:\/\//
    url = 'http://' + url
  end

  URI(url)
end

Instance Method Details

#api_for_doc(url) ⇒ Object 



27
28
 
# File 'lib/useless/doc/router.rb', line 27

def api_for_doc(url)
end

#doc_for_api(url) ⇒ Object 



24
25
 
# File 'lib/useless/doc/router.rb', line 24

def doc_for_api(url)
end