Module: HTTPClient::Util

Included in:
HTTPClient
Defined in:
lib/httpclient/util.rb

Overview

A module for common function.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.hash_find_value(hash, &block) ⇒ Object

Finds a value of a Hash.


78
79
80
81
# File 'lib/httpclient/util.rb', line 78

def hash_find_value(hash, &block)
  v = hash.find(&block)
  v ? v[1] : nil
end

.uri_dirname(uri) ⇒ Object

Returns parent directory URI of the given URI.


70
71
72
73
74
# File 'lib/httpclient/util.rb', line 70

def uri_dirname(uri)
  uri = uri.clone
  uri.path = uri.path.sub(/\/[^\/]*\z/, '/')
  uri
end

.uri_part_of(uri, part) ⇒ Object

Returns true if the given 2 URIs have a part_of relationship.

  • the same scheme

  • the same host String (no host resolution or IP-addr conversion)

  • the same port number

  • target URI's path starts with base URI's path.


61
62
63
64
65
66
# File 'lib/httpclient/util.rb', line 61

def uri_part_of(uri, part)
  ((uri.scheme == part.scheme) and
   (uri.host == part.host) and
   (uri.port == part.port) and
   uri.path.upcase.index(part.path.upcase) == 0)
end

Instance Method Details

#keyword_argument(args, *field) ⇒ Object

Keyword argument helper.

args

given arguments.

*field

a list of arguments to be extracted.

You can extract 3 arguments (a, b, c) with:

include Util
def my_method(*args)
  a, b, c = keyword_argument(args, :a, :b, :c)
  ...
end
my_method(1, 2, 3)
my_method(:b => 2, :a = 1)

instead of;

def my_method(a, b, c)
  ...
end

37
38
39
40
41
42
43
# File 'lib/httpclient/util.rb', line 37

def keyword_argument(args, *field)
  if args.size == 1 and args[0].is_a?(Hash)
    args[0].values_at(*field)
  else
    args
  end
end

#urify(uri) ⇒ Object

Gets an URI instance.


46
47
48
49
50
51
52
53
54
# File 'lib/httpclient/util.rb', line 46

def urify(uri)
  if uri.nil?
    nil
  elsif uri.is_a?(URI)
    uri
  else
    URI.parse(uri.to_s)
  end
end