Class: Scopus2

Inherits:

Service

• Object
• Service
• Scopus2

Includes:

ActionView::Helpers::SanitizeHelper, MetadataHelper, UmlautHttp

Defined in:

app/service_adaptors/scopus2.rb

Overview

Service adapter plug-in.

PURPOSE: Includes "cited by", "similar articles" and "more by these authors" links from scopus.

LIMTATIONS: You must be a Scopus customer for these links generated to work for your users at all! Off-campus users should be probably 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. Abstracts are not used because it seems to violate Scopus terms of service to use them.

REGISTERING: Register for a Scopus API key at: http://www.developers.elsevier.com/action/devprojects?pageOrigin=cmsPage&zone=topNavBar Look for "Register a new site" button at the bottom right of the page.

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.

SCOPUS USEFUL URLS:

api key register: http://www.developers.elsevier.com/action/devprojects?pageOrigin=cmsPage&zone=topNavBar

'content policies' terms of use: http://www.developers.elsevier.com/cms/content-apis

API overview docs: http://www.developers.elsevier.com/cms/content-apis

Various other api docs? Confused myself as to organization here.

• http://www.developers.elsevier.com/devcms/content-api-search-request
• http://www.developers.elsevier.com/devcms/content/search-fields-overview
• http://api.elsevier.com/content/search/#d0n14606

Some API recommendations for federated search: http://www.developers.elsevier.com/cms/restful-api-federated-search

Constant Summary

Constants inherited from Service

Service::LinkOutFilterTask, Service::StandardTask

Instance Attribute Summary

• #scopus_search_base ⇒ Object

  Returns the value of attribute scopus_search_base.

Attributes inherited from Service

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

Instance Method Summary

• #check_for_hits(url) ⇒ Object

  NOT currently working.

• #cited_by_url(result) ⇒ Object
• #eid_from_hit(result) ⇒ Object
• #handle(request) ⇒ Object
• #initialize(config) ⇒ Scopus2 constructor

  A new instance of Scopus2.

• #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_query(request) ⇒ Object

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

• #scopus_url(query) ⇒ Object
• #service_types_generated ⇒ Object
• #try_add_cited_by_response(result, request) ⇒ Object

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

• #xml_namespaces ⇒ 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) ⇒ Scopus2

Returns a new instance of Scopus2.

# File 'app/service_adaptors/scopus2.rb', line 73

def initialize(config)
  #defaults
  @display_name = "Scopus"
  @registered_referer
  @scopus_search_base = 'http://api.elsevier.com/content/search/index:SCOPUS'
  
  @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 Attribute Details

#scopus_search_base ⇒ Object

Returns the value of attribute scopus_search_base.

# File 'app/service_adaptors/scopus2.rb', line 61

def scopus_search_base
  @scopus_search_base
end

Instance Method Details

#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