Class: Riak::Link

Inherits:
Object show all
Includes:
Util::Escape, Util::Translation
Defined in:
lib/riak/link.rb

Overview

Represents a link from one object to another in Riak

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from Util::Escape

#escape, #maybe_escape, #maybe_unescape, #unescape

Methods included from Util::Translation

#i18n_scope, #t

Constructor Details

- (Link) initialize(url, tag) - (Link) initialize(bucket, key, tag)

Returns a new instance of Link

Overloads:

  • - (Link) initialize(url, tag)

    Parameters:

    • url (String)

      the url of the related resource

    • tag (String)

      the tag for the related resource

  • - (Link) initialize(bucket, key, tag)

    Parameters:

    • bucket (String)

      the bucket of the related resource

    • key (String)

      the key of the related resource

    • tag (String)

      the tag for the related resource

Raises:

  • (ArgumentError)


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

Instance Attribute Details

- (String) bucket

Returns the bucket of the related resource

Returns:

  • (String)

    the bucket of the related resource



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

def bucket
  @bucket
end

- (String) key

Returns the key of the related resource

Returns:

  • (String)

    the key of the related resource



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

def key
  @key
end

- (String) tag Also known as: rel

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

Returns:

  • (String)

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



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

def tag
  @tag
end

Class Method Details

+ (Array<Link>) parse(header_string)

Returns an array of Riak::Link structs parsed from the header

Parameters:

  • header_string (String)

    the string value of the Link: HTTP header from a Riak response

Returns:

  • (Array<Link>)

    an array of Riak::Link structs parsed from the header



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

Instance Method Details

- (Object) ==(other)



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

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

- (Boolean) eql?(other)

Returns:

  • (Boolean)


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

def eql?(other)
  self == other
end

- (Object) hash



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

def hash
  self.to_s.hash
end

- (Object) inspect



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

def inspect; to_s; end

- (Object) to_s(new_scheme = false)



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

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

- (Object) to_walk_spec



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

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

- (String) url(new_scheme = false)

Returns the URL (relative or absolute) of the related resource

Returns:

  • (String)

    the URL (relative or absolute) of the related resource



55
56
57
58
59
60
61
62
63
# File 'lib/riak/link.rb', line 55

def url(new_scheme=false)
  return @url unless @bucket

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

- (Object) url=(value)



65
66
67
68
69
# File 'lib/riak/link.rb', line 65

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