Module: Serrano
- Extended by:
- Configuration
- Defined in:
- lib/serrano.rb,
lib/serrano/cn.rb,
lib/serrano/error.rb,
lib/serrano/filters.rb,
lib/serrano/request.rb,
lib/serrano/version.rb,
lib/serrano/cnrequest.rb,
lib/serrano/filterhandler.rb,
lib/serrano/request_cursor.rb
Overview
Serrano::RequestCursor
Class to perform HTTP requests to the Crossref API
Defined Under Namespace
Modules: Filters Classes: BadGateway, BadRequest, CNRequest, ContentNegotiation, Error, GatewayTimeout, InternalServerError, NotFound, Request, RequestCursor, ServiceUnavailable
Constant Summary collapse
- VERSION =
'0.5.2'
Class Method Summary collapse
-
.citation_count(doi:, url: 'http://www.crossref.org/openurl/', key: '[email protected]', options: nil) ⇒ Object
Get a citation count with a DOI.
-
.content_negotiation(ids:, format: 'bibtex', style: 'apa', locale: 'en-US') ⇒ Hash
Get citations in various formats from CrossRef.
-
.csl_styles ⇒ Object
Get csl styles.
-
.funders(ids: nil, query: nil, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) ⇒ Array
Search the funders route.
-
.journals(ids: nil, query: nil, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) ⇒ Array
Search the journals route.
-
.licenses(query: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, options: nil, verbose: false) ⇒ Array
Search the licenses route.
-
.members(ids: nil, query: nil, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) ⇒ Array
Search the members route.
-
.prefixes(ids:, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) ⇒ Array
Search the prefixes route.
-
.random_dois(sample: 10, options: nil, verbose: false) ⇒ Array
Get a random set of DOI’s.
-
.registration_agency(ids:, options: nil, verbose: false) ⇒ Array
Determine registration agency for DOIs.
-
.types(ids: nil, offset: nil, limit: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) ⇒ Array
Search the types route.
-
.works(ids: nil, query: nil, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) ⇒ Array
Search the works route.
Methods included from Configuration
Class Method Details
.citation_count(doi:, url: 'http://www.crossref.org/openurl/', key: '[email protected]', options: nil) ⇒ Object
Get a citation count with a DOI
650 651 652 653 654 655 656 657 658 659 660 661 |
# File 'lib/serrano.rb', line 650 def self.citation_count(doi:, url: 'http://www.crossref.org/openurl/', key: '[email protected]', options: nil) args = { id: 'doi:' + doi, pid: key, noredirect: true } opts = args.delete_if { |_k, v| v.nil? } conn = Faraday.new(url: url, request: ) res = conn.get '', opts x = res.body oc = REXML::Document.new("<doc>#{x}</doc>") value = REXML::XPath.first(oc, '//query').attributes['fl_count'].to_i value end |
.content_negotiation(ids:, format: 'bibtex', style: 'apa', locale: 'en-US') ⇒ Hash
Get citations in various formats from CrossRef
630 631 632 633 |
# File 'lib/serrano.rb', line 630 def self.content_negotiation(ids:, format: 'bibtex', style: 'apa', locale: 'en-US') ids = Array(ids).map { |x| ERB::Util.url_encode(x) } CNRequest.new(ids, format, style, locale).perform end |
.csl_styles ⇒ Object
Get csl styles
669 670 671 |
# File 'lib/serrano.rb', line 669 def self.csl_styles fetch_styles end |
.funders(ids: nil, query: nil, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) ⇒ Array
Funders without IDs don’t show up on the /funders route
Search the funders route
387 388 389 390 391 392 393 394 395 |
# File 'lib/serrano.rb', line 387 def self.funders(ids: nil, query: nil, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) RequestCursor.new('funders', ids, query, filter, offset, limit, sample, sort, order, facet, select, works, nil, , verbose, cursor, cursor_max, args).perform end |
.journals(ids: nil, query: nil, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) ⇒ Array
Search the journals route
439 440 441 442 443 444 445 446 447 |
# File 'lib/serrano.rb', line 439 def self.journals(ids: nil, query: nil, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) RequestCursor.new('journals', ids, query, filter, offset, limit, sample, sort, order, facet, select, works, nil, , verbose, cursor, cursor_max, args).perform end |
.licenses(query: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, options: nil, verbose: false) ⇒ Array
Search the licenses route
523 524 525 526 527 528 529 |
# File 'lib/serrano.rb', line 523 def self.licenses(query: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, options: nil, verbose: false) Request.new('licenses', nil, query, nil, offset, limit, sample, sort, order, facet, nil, nil, nil, , verbose).perform end |
.members(ids: nil, query: nil, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) ⇒ Array
Search the members route
288 289 290 291 292 293 294 295 296 |
# File 'lib/serrano.rb', line 288 def self.members(ids: nil, query: nil, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) RequestCursor.new('members', ids, query, filter, offset, limit, sample, sort, order, facet, select, works, nil, , verbose, cursor, cursor_max, args).perform end |
.prefixes(ids:, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) ⇒ Array
Search the prefixes route
335 336 337 338 339 340 341 342 343 |
# File 'lib/serrano.rb', line 335 def self.prefixes(ids:, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) RequestCursor.new('prefixes', ids, nil, filter, offset, limit, sample, sort, order, facet, select, works, nil, , verbose, cursor, cursor_max, args).perform end |
.random_dois(sample: 10, options: nil, verbose: false) ⇒ Array
This method uses works internally, but doesn’t allow you to pass on
Get a random set of DOI’s
arguments to that method.
564 565 566 567 568 |
# File 'lib/serrano.rb', line 564 def self.random_dois(sample: 10, options: nil, verbose: false) tmp = Request.new('works', nil, nil, nil, nil, nil, sample, nil, nil, nil, nil, false, nil, , verbose).perform tmp['message']['items'].collect { |x| x['DOI'] } end |
.registration_agency(ids:, options: nil, verbose: false) ⇒ Array
Determine registration agency for DOIs
542 543 544 545 |
# File 'lib/serrano.rb', line 542 def self.registration_agency(ids:, options: nil, verbose: false) Request.new('works', ids, nil, nil, nil, nil, nil, nil, nil, nil, false, true, , verbose).perform end |
.types(ids: nil, offset: nil, limit: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) ⇒ Array
Search the types route
483 484 485 486 487 488 489 |
# File 'lib/serrano.rb', line 483 def self.types(ids: nil, offset: nil, limit: nil, select: nil, works: false, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) RequestCursor.new('types', ids, nil, nil, offset, limit, nil, nil, nil, nil, select, works, nil, , verbose, cursor, cursor_max, args).perform end |
.works(ids: nil, query: nil, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) ⇒ Array
Search the works route
232 233 234 235 236 237 238 239 240 |
# File 'lib/serrano.rb', line 232 def self.works(ids: nil, query: nil, filter: nil, offset: nil, limit: nil, sample: nil, sort: nil, order: nil, facet: nil, select: nil, options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args) RequestCursor.new('works', ids, query, filter, offset, limit, sample, sort, order, facet, select, nil, nil, , verbose, cursor, cursor_max, args).perform end |