Class: Riak::Link

Inherits:

Object

• Object
• Riak::Link

show all

Includes:

Util::Escape, Util::Translation

Defined in:

lib/riak/link.rb

Overview

Instance Attribute Summary (collapse)

• - (String) bucket

  The bucket of the related resource.

• - (String) key

  The key of the related resource.

• - (String) tag (also: #rel)

  The relationship tag (or “rel”) of the other resource to this one.

Class Method Summary (collapse)

• + (Array<Link>) parse(header_string)

  An array of Riak::Link structs parsed from the header.

Instance Method Summary (collapse)

• - (Object) ==(other)
• - (Boolean) eql?(other)
• - (Object) hash
• - (Link) initialize(*args) constructor

  A new instance of Link.

• - (Object) inspect
• - (Object) to_s(new_scheme = false)
• - (Object) to_walk_spec
• - (String) url(new_scheme = false)

  The URL (relative or absolute) of the related resource.

• - (Object) url=(value)

Methods included from Util::Escape

#escape, #maybe_escape, #maybe_unescape, #unescape

Methods included from Util::Translation

#i18n_scope, #t

45
46
47
48
49
50
51
52

# File 'lib/riak/link.rb', line 45

def initialize(*args)
  raise ArgumentError unless (2..3).include?(args.size)
  if args.size == 2
    self.url, @tag = args
  else
    @bucket, @key, @tag = args
  end
end

18
19
20

# File 'lib/riak/link.rb', line 18

def bucket
  @bucket
end

21
22
23

# File 'lib/riak/link.rb', line 21

def key
  @key
end

13
14
15

# File 'lib/riak/link.rb', line 13

def tag
  @tag
end

32
33
34
35
36

# File 'lib/riak/link.rb', line 32

def self.parse(header_string)
  header_string.scan(%r{<([^>]+)>\s*;\s*(?:rel|riaktag)=\"([^\"]+)\"}).map do |match|
    new(match[0], match[1])
  end
end

87
88
89

# File 'lib/riak/link.rb', line 87

def ==(other)
  other.is_a?(Link) && url == other.url && tag == other.tag
end

83
84
85

# File 'lib/riak/link.rb', line 83

def eql?(other)
  self == other
end

79
80
81

# File 'lib/riak/link.rb', line 79

def hash
  self.to_s.hash
end

73

# File 'lib/riak/link.rb', line 73

def inspect; to_s; end

75
76
77

# File 'lib/riak/link.rb', line 75

def to_s(new_scheme=false)
  %Q[<#{url(new_scheme)}>; riaktag="#{tag}"]
end

91
92
93
94

# File 'lib/riak/link.rb', line 91

def to_walk_spec
  raise t("bucket_link_conversion") if tag == "up" || key.nil?
  WalkSpec.new(:bucket => bucket, :tag => tag)
end

55
56
57
58
59
60
61
62
63
64
65

# File 'lib/riak/link.rb', line 55

def url(new_scheme=false)
  if @bucket
    if new_scheme
      "/buckets/#{escape(bucket)}" + (key.blank? ? "" : "/keys/#{escape(key)}")
    else
      "/riak/#{escape(bucket)}" + (key.blank? ? "" : "/#{escape(key)}")
    end
  else
    @url
  end
end

67
68
69
70
71

# File 'lib/riak/link.rb', line 67

def url=(value)
  @url = value
  @bucket = unescape($1) if value =~ %r{^/buckets/([^/]+)/?} || value =~ %r{^/[^/]+/([^/]+)/?}
  @key = unescape($1) if value =~ %r{^/buckets/[^/]+/keys/([^/]+)/?} || value =~ %r{^/[^/]+/[^/]+/([^/]+)/?}
end