Class: Scopus

Inherits:

Service

• Object
• Service
• Scopus

Includes:

ActionView::Helpers::SanitizeHelper, MetadataHelper, UmlautHttp

Defined in:

app/service_adaptors/scopus.rb

Overview

Service adapter plug-in.

NOTE: This is based on deprecated Scopus API's, Scopus will take them away 31 December 2014. Please see scopus2.rb instead which uses new Scopus API's.

PURPOSE: Includes "cited by", "similar articles" and "more by these authors" links from scopus. Also will throw in an abstract from Scopus if found.

LIMTATIONS: You must be a Scopus customer for these links generated to work for your users at all! Off-campus users should be going through ezproxy, see the EZProxy plug-in. Must find a match in scopus, naturally. "cited by" will only be included if Scopus has non-0 "cited by" links. But there's no good way to precheck similar/more-by for this, so they are provided blind and may result in 0 hits. You can turn them off if you like, with @include_similar, and @include_more_by_authors.

REGISTERING: This plug in actually has to use two seperate Scopus APIs. For the first, the scopus 'json' search api, you must regsiter and get an api key from scopus, which you can do here: http://searchapi.scopus.com Then include as @json_api_key in service config.

For the second Scopus API, you theoretically need a Scopus "PartnerID" and corresponding "release number", in @partner_id and @scopus_release There's no real easy way to get one. Scopus says:

"To obtain a partner ID or release number, contact your nearest regional
Scopus office. A list of Scopus contacts is available at
http://www.info.scopus.com/contactus/index.shtml"

Bah! But fortunately, using the "partnerID" assigned to the Scopus Json API, 65, seems to work, and is coded here as the default. You could try going with that. When you register a partnerID, you also get a 'salt key', which is currently not used by this code, but @link_salt_key is reserved for it in case added functionality does later.

Constant Summary

Constants inherited from Service

Service::LinkOutFilterTask, Service::StandardTask

Instance Attribute Summary

Attributes inherited from Service

#group, #name, #priority, #request, #service_id, #status, #task, #url

Instance Method Summary

• #add_abstract(first_hit, request) ⇒ Object
• #add_cited_by_response(result, request) ⇒ Object

  Input is a ruby hash that came from the scopus JSON, representing a single hit.

• #check_for_hits(url) ⇒ Object

  NOT currently working.

• #cited_by_url(result) ⇒ Object
• #detail_url(hash) ⇒ Object
• #handle(request) ⇒ Object
• #initialize(config) ⇒ Scopus constructor

  A new instance of Scopus.

• #more_like_this_url(result, options = {}) ⇒ Object
• #phrase(str) ⇒ Object

  backslash escapes any double quotes, and embeds string in scopus phrase search double quotes.

• #scopus_search(request) ⇒ Object

  Comes up with a scopus advanced search query intended to find the exact known item identified by this citation.

• #service_types_generated ⇒ Object

Methods included from UmlautHttp

#http_fetch, #proxy_like_headers

Methods included from MetadataHelper

#get_doi, #get_epage, #get_gpo_item_nums, #get_identifier, #get_isbn, #get_issn, #get_lccn, #get_month, #get_oclcnum, #get_pmid, #get_search_creator, #get_search_terms, #get_search_title, #get_spage, #get_sudoc, #get_top_level_creator, #get_year, #normalize_lccn, #normalize_title, #raw_search_title, title_is_serial?

Methods included from MarcHelper

#add_856_links, #edition_statement, #get_title, #get_years, #gmd_values, #service_type_for_856, #should_skip_856_link?, #strip_gmd

Methods inherited from Service

#credits, #display_name, #handle_wrapper, #link_out_filter, #preempted_by, required_config_params, #response_url, #translate

Constructor Details

#initialize(config) ⇒ Scopus

Returns a new instance of Scopus.

# File 'app/service_adaptors/scopus.rb', line 59

def initialize(config)
  #defaults
  @display_name = "Scopus"
  @registered_referer
  @scopus_search_base = 'http://www.scopus.com/scsearchapi/search.url'
  
  @include_abstract = true
  @include_cited_by = true
  @include_similar = true
  @include_more_by_authors = true
  @more_by_authors_type = "similar"

  @inward_cited_by_url = "http://www.scopus.com/scopus/inward/citedby.url"
  #@partner_id = "E5wmcMWC"
  @partner_id = 65
  @link_salt_key = nil
  @scopus_release = "R6.0.0"

  # Scopus offers two algorithms for finding similar items.
  # This variable can be:
  # "key" => keyword based similarity 
  # "ref" => reference based similiarity (cites similar refs?) Seems to offer 0 hits quite often, so we use keyword instead. 
  # "aut" => author. More docs by same authors. Incorporated as seperate link usually. 
  @more_like_this_type = "key"
  @inward_more_like_url = "http://www.scopus.com/scopus/inward/mlt.url"
  
  @credits = {
    @display_name => "http://www.scopus.com/home.url"
  }
  
  super(config)
end

Instance Method Details

#add_abstract(first_hit, request) ⇒ Object

# File 'app/service_adaptors/scopus.rb', line 240

def add_abstract(first_hit, request)

  return if first_hit["abstract"].blank?
  
  request.add_service_response( 
    :service=>self, 
    :display_text => "Abstract from #{@display_name}", 
    :content => sanitize(first_hit["abstract"]), 
    :content_html_safe => true,
    :url => detail_url(first_hit), 
    :service_type_value => :abstract)
end

#add_cited_by_response(result, request) ⇒ Object

Input is a ruby hash that came from the scopus JSON, representing a single hit. We're going to add this as a result.

# File 'app/service_adaptors/scopus.rb', line 219

def add_cited_by_response(result, request)
  # While scopus provides an "inwardurl" in the results, this just takes
  # us to the record detail page. We actually want to go RIGHT to the
  # list of cited-by items. So we create our own, based on Scopus's
  # reversed engineered predictable URLs. 

  count = result["citedbycount"]
  label = ServiceTypeValue[:cited_by].display_name_pluralize.downcase.capitalize    
    if count && count == 1
      label = ServiceTypeValue[:cited_by].display_name.downcase.capitalize
    end
  cited_by_url = cited_by_url( result )
  
  request.add_service_response(:service=>self, 
    :display_text => "#{count} #{label}", 
    :count=> count, 
    :url => cited_by_url, 
    :service_type_value => :cited_by)

end

#check_for_hits(url) ⇒ Object

NOT currently working. Scopus doesn't make this easy. Takes a scopus direct url for which we're not sure if there will be results or not, and requests it and html screen-scrapes to get hit count. (We can conveniently find this just in the html