module Exlibris::Primo::ChainGang::Base

Primo ChainGang Base Attributes

These base attributes are included in Search, Eshelf, Tags and Reviews and allow for chaining methods together.

Examples

search = Search.new.base_url!("http://primo.library.edu").
  institution!("PRIMO").ip!("127.0.0.1") 
  #=> #<Exlibris::Primo::Search @base_url="http://primo.library.edu", 
        @institution="PRIMO", @request_attributes={:base_url => "http://primo.library.edu", 
          :institution => "PRIMO", :ip => "127.0.0.1"}>

eshelf = Eshelf.new.base_url!("http://primo.library.edu").
  institution!("PRIMO").ip!("127.0.0.1")
  #=> #<Exlibris::Primo::Eshelf @base_url="http://primo.library.edu", 
        @institution="PRIMO", @request_attributes={:base_url => "http://primo.library.edu", 
          :institution => "PRIMO", :ip => "127.0.0.1"}>

reviews = Reviews.new.base_url!("http://primo.library.edu").
  institution!("PRIMO").ip!("127.0.0.1")
  #=> #<Exlibris::Primo::Reviews @base_url="http://primo.library.edu", 
        @institution="PRIMO", @request_attributes={:base_url => "http://primo.library.edu", 
          :institution => "PRIMO", :ip => "127.0.0.1"}>

tags = Tags.new.base_url!("http://primo.library.edu").
  institution!("PRIMO").ip!("127.0.0.1")
  #=> #<Exlibris::Primo::Tags @base_url="http://primo.library.edu", 
        @institution="PRIMO", @request_attributes={:base_url => "http://primo.library.edu", 
          :institution => "PRIMO", :ip => "127.0.0.1"}>

Public Instance Methods

base_url!(base_url) click to toggle source

Set base URL for the Primo request.

# File lib/exlibris/primo/chain_gang/base.rb, line 40
def base_url!(base_url)
  @base_url = base_url
  request_attributes[:base_url] = "#{base_url}"
  self
end
Also aliased as: base_url=
base_url=(base_url)
Alias for: base_url!
client_ip!(ip)
Alias for: ip!
client_ip=(ip)
Alias for: ip!
group!(group) click to toggle source

Set the group for the Primo request.

# File lib/exlibris/primo/chain_gang/base.rb, line 71
def group!(group)
  request_attributes[:group] = "#{group}"
  self
end
Also aliased as: group=
group=(group)
Alias for: group!
institution!(institution) click to toggle source

Set institution for the Primo request.

# File lib/exlibris/primo/chain_gang/base.rb, line 50
def institution!(institution)
  @institution = institution
  request_attributes[:institution] = "#{institution}"
  self
end
Also aliased as: institution=
institution=(institution)
Alias for: institution!
ip!(ip) click to toggle source

Set client IP for the Primo request.

# File lib/exlibris/primo/chain_gang/base.rb, line 60
def ip!(ip)
  request_attributes[:ip] = "#{ip}"
  self
end
Also aliased as: ip=, client_ip!, client_ip=
ip=(ip)
Alias for: ip!
logged_in() click to toggle source

Specifies that the Primo request user is logged in.

# File lib/exlibris/primo/chain_gang/base.rb, line 105
def logged_in
  request_attributes[:is_logged_in] = "true"
  self
end
logged_off()
Alias for: logged_out
logged_out() click to toggle source

Specifies that the Primo request user is logged out.

# File lib/exlibris/primo/chain_gang/base.rb, line 113
def logged_out
  request_attributes[:is_logged_in] = "false"
  self
end
Also aliased as: logged_off
off_campus() click to toggle source

Specifies that the Primo request is coming from off campus.

# File lib/exlibris/primo/chain_gang/base.rb, line 97
def off_campus
  request_attributes[:on_campus] = "false"
  self
end
on_campus() click to toggle source

Specifies that the Primo request is coming from on campus.

# File lib/exlibris/primo/chain_gang/base.rb, line 89
def on_campus
  request_attributes[:on_campus] = "true"
  self
end
pds_handle!(pds_handle) click to toggle source

Set the PDS handle for the Primo request.

# File lib/exlibris/primo/chain_gang/base.rb, line 80
def pds_handle!(pds_handle)
  request_attributes[:pds_handle] = "#{pds_handle}"
  self
end
Also aliased as: pds_handle=
pds_handle=(pds_handle)
Alias for: pds_handle!