serrano 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00aa3283924fc74b4a2634759602caa5516b26e3
+  data.tar.gz: bd653f31833befbb3dd5be3a4fff893e22e13756
+SHA512:
+  metadata.gz: 874a4e19e0ac4439c75be43782d7da74adf00a082d4352e6d13458fdaac442d5048fda4faf7db5f747c76220821a4b5a1270477bf931d5202842604358f2bfe7
+  data.tar.gz: ffb5ebb232ef610865833c6b147be959a7313a8b3904bdd429aa2cac17548879693df195d91cb31a40009ce8d3a59bec46e16dfad0c5a16895d04bd3fcb8ae87

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+#Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+cache/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.7
+  - 2.2.3

data/CONDUCT.md

@@ -0,0 +1,25 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who 
+contribute through reporting issues, posting feature requests, updating documentation,
+submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for
+everyone, regardless of level of experience, gender, gender identity and expression,
+sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or
+imagery, derogatory comments or personal attacks, trolling, public or private harassment,
+insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments,
+commits, code, wiki edits, issues, and other contributions that are not aligned to this 
+Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed 
+from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by 
+opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the Contributor Covenant 
+(http:contributor-covenant.org), version 1.0.0, available at 
+http://contributor-covenant.org/version/1/0/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    serrano (0.0.7)
+      faraday (~> 0.9.1)
+      faraday_middleware (~> 0.10.0)
+      multi_json (~> 1.0)
+      nokogiri (~> 1.6, >= 1.6.6.2)
+      thor (~> 0.19)
+      uuidtools (~> 2.1, >= 2.1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codecov (0.1.1)
+      json
+      simplecov
+      url
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    json (1.8.3)
+    mini_portile (0.6.2)
+    multi_json (1.11.2)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    power_assert (0.2.4)
+    rake (10.4.2)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    test-unit (3.1.3)
+      power_assert
+    thor (0.19.1)
+    url (0.3.2)
+    uuidtools (2.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  codecov (~> 0.1)
+  json (~> 1.8, >= 1.8.3)
+  rake (~> 10.4)
+  serrano!
+  simplecov (~> 0.10)
+  test-unit (~> 3.1)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (C) 2015 Scott Chamberlain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/NEWS.md

@@ -0,0 +1,3 @@
+## 0.0.1 (xxxx-xx-xx)
+
+* First version to Rubygems

data/README.md

@@ -0,0 +1,128 @@
+serrano
+=========
+
+[![Build Status](https://api.travis-ci.org/sckott/serrano.png)](https://travis-ci.org/sckott/serrano)
+[![codecov.io](http://codecov.io/github/sckott/serrano/coverage.svg?branch=master)](http://codecov.io/github/sckott/serrano?branch=master)
+
+`serrano` is a low level client for Crossref APIs
+
+Docs: http://recology.info/serrano/
+
+Other Crossref API clients:
+
+- Python: [habanero](https://github.com/sckott/habanero)
+- R: [rcrossref](https://github.com/ropensci/rcrossref)
+
+## Changes
+
+For changes see the [NEWS file](NEWS.md).
+
+## API
+
+Methods in relation to [Crossref search API][crapi] routes
+
+* `/works` - `Serrano.works()`
+* `/members` - `Serrano.members()`
+* `/prefixes` - `Serrano.prefixes()`
+* `/funders` - `Serrano.funders()`
+* `/journals` - `Serrano.journals()`
+* `/licenses` - `Serrano.licenses()`
+* `/types` - `Serrano.types()`
+
+Additional methods built on top of the Crossref search API:
+
+* DOI minting agency - `Serrano.agency()`
+* Get random DOIs - `Serrano.random_dois()`
+
+Other methods:
+
+* [Conent negotiation][cn] - `Serrano.cn()`
+* [Text and data mining][tdm] - `Serrano.text()`
+
+## Install
+
+### Release version
+
+```
+gem install serrano
+```
+
+### Development version
+
+```
+git clone git@github.com:sckott/serrano.git
+cd serrano
+rake install
+```
+
+## Setup
+
+Crossref's API will likely be used by others in the future, allowing the base URL to be swapped out. You can swap out the base URL by passing named options in a block to `Serrano.configuration`. 
+
+This will also be the way to set up other user options, as needed down the road.
+
+```ruby
+Serrano.configuration do |config|
+  config.base_url = "http://api.crossref.org"
+end
+```
+
+## Examples
+
+Search works by DOI
+
+```ruby
+require 'serrano'
+Serrano.works(doi: '10.1371/journal.pone.0033693')
+```
+
+Search works by query string
+
+```ruby
+Serrano.works(query: "ecology")
+```
+
+Search journals by publisher name
+
+```ruby
+Serrano.journals(query: "peerj")
+```
+
+Search funding information by DOI
+
+```ruby
+Serrano.funders(ids: ['10.13039/100000001','10.13039/100000015'])
+```
+
+Get agency for a set of DOIs
+
+```ruby
+Serrano.agency(ids: ['10.1007/12080.1874-1746','10.1007/10452.1573-5125'])
+```
+
+Get random set of DOIs
+
+```ruby
+Serrano.random_dois(sample: 100)
+```
+
+Content negotiation
+
+```ruby
+Serrano.cn(ids: '10.1126/science.169.3946.635', format: "citeproc-json")
+```
+
+Text mining
+
+```ruby
+res = Serrano.text(url: 'http://...');
+```
+
+## Meta
+
+* Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
+* License: MIT
+
+[crapi]: https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md
+[cn]: http://www.crosscite.org/cn/
+[tdm]: http://www.crossref.org/tdm/

data/Rakefile

@@ -0,0 +1,41 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test-*.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test
+
+desc "Build serrano docs"
+task :docs do
+	system "yardoc"
+end
+
+desc "bundle install"
+task :b do
+  system "bundle install"
+end
+
+desc "bundle install"
+task :clean do
+  system "ls | grep [0-9].gem | xargs rm"
+end
+
+desc "Build serrano"
+task :build do
+	system "gem build serrano.gemspec"
+end
+
+desc "Install serrano"
+task :install => :build do
+	system "gem install serrano-#{Serrano::VERSION}.gem"
+end
+
+desc "Release to Rubygems"
+task :release => :build do
+  system "gem push serrano-#{Serrano::VERSION}.gem"
+end

data/lib/serrano.rb

@@ -0,0 +1,440 @@
+require "serrano/version"
+require "serrano/request"
+require "serrano/filterhandler"
+require "serrano/cnrequest"
+require "serrano/miner"
+require "serrano/filters"
+
+require 'rexml/document'
+require 'rexml/xpath'
+
+# @!macro serrano_params
+#   @param ids [Array] DOIs (digital object identifier) or other identifiers
+#   @param offset [Fixnum] Number of record to start at, from 1 to infinity.
+#   @param limit [Fixnum] Number of results to return. Not relavant when searching with specific dois. Default: 20. Max: 1000
+#   @param sample [Fixnum] Number of random results to return. when you use the sample parameter,
+#   the limit and offset parameters are ignored.
+#   @param sort [String] Field to sort on, one of score, relevance,
+#   updated (date of most recent change to metadata. Currently the same as deposited),
+#   deposited (time of most recent deposit), indexed (time of most recent index), or
+#   published (publication date). Note: If the API call includes a query, then the sort
+#   order will be by the relevance score. If no query is included, then the sort order
+#   will be by DOI update date.
+#   @param order [String] Sort order, one of 'asc' or 'desc'
+#   @param facet [Boolean] Include facet results. Default: false
+#   @param options [Hash] Hash of options for configuring the request, passed on to Faraday.new
+#     :timeout      - [Fixnum] open/read timeout Integer in seconds
+#     :open_timeout - [Fixnum] read timeout Integer in seconds
+#     :proxy        - [Hash] hash of proxy options
+#       :uri - [String] Proxy Server URI
+#       :user - [String] Proxy server username
+#       :password - [String] Proxy server password
+#     :params_encoder - [Hash] not sure what this is
+#     :bind           - [Hash] A hash with host and port values
+#     :boundary       - [String] of the boundary value
+#     :oauth          - [Hash] A hash with OAuth details
+#   @param verbose [Boolean] Print request headers to stdout. Default: false
+
+##
+# Serrano - The top level module for using methods
+# to access Serrano APIs
+#
+# The following methods, matching the main Crossref API routes, are available:
+# * works - Use the /works endpoint
+# * members - Use the /members endpoint
+# * prefixes - Use the /prefixes endpoint
+# * funders - Use the /funders endpoint
+# * journals - Use the /journals endpoint
+# * types - Use the /types endpoint
+# * licenses - Use the /licenses endpoint
+#
+# Additional methods
+# * agency - test the registration agency for a DOI
+#
+# All routes return an array of hashes
+# For example, if you want to inspect headers returned from the HTTP request,
+# and parse the raw result in any way you wish.
+#
+# @see https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md for
+# detailed description of the Crossref API
+module Serrano
+  extend Configuration
+
+  define_setting :access_token
+  define_setting :access_secret
+  define_setting :elsevier_key
+  define_setting :base_url, "http://api.crossref.org/"
+
+  ##
+  # Search the works route
+  #
+  # @!macro serrano_params
+  # @param query [String] A query string
+  # @param filter [Hash] Filter options. See ...
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'serrano'
+  #      # Search by DOI, one or more
+  #      Serrano.works(ids: '10.5555/515151')
+  #      Serrano.works(ids: '10.1371/journal.pone.0033693')
+  #      Serrano.works(ids: ['10.1007/12080.1874-1746','10.1007/10452.1573-5125', '10.1111/(issn)1442-9993'])
+  #      # query
+  #      Serrano.works(query: "ecology")
+  #      Serrano.works(query: "renear+-ontologies")
+  #      # Sort
+  #      Serrano.works(query: "ecology", sort: 'relevance', order: "asc")
+  #      # Filters
+  #      Serrano.works(filter: {has_full_text: true})
+  #      Serrano.works(filter: {has_funder: true, has_full_text: true})
+  #      Serrano.works(filter: {award_number: 'CBET-0756451', award_funder: '10.13039/100000001'})
+  #
+  #      # Curl options
+  #      ## set a request timeout and an open timeout
+  #      Serrano.works(ids: '10.1371/journal.pone.0033693', options: {timeout: 3, open_timeout: 2})
+  #      ## log request details - uses Faraday middleware
+  #      Serrano.works(ids: '10.1371/journal.pone.0033693', verbose: true)
+  def self.works(ids: nil, query: nil, filter: nil, offset: nil,
+    limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
+    options: nil, verbose: false)
+
+    Request.new('works', ids, query, filter, offset,
+      limit, sample, sort, order, facet, nil, nil, options, verbose).perform
+  end
+
+  ##
+  # Search the members route
+  #
+  # @!macro serrano_params
+  # @param query [String] A query string
+  # @param filter [Hash] Filter options. See ...
+  # @param works [Boolean] If true, works returned as well. Default: false
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'serrano'
+  #      # Search by DOI, one or more
+  #      Serrano.members(ids: 98)
+  #      Serrano.members(ids: 340)
+  #      Serrano.members(ids: [98, 340, 45])
+  #      # query
+  #      Serrano.members(query: "ecology")
+  #      Serrano.members(query: "hindawi")
+  #      # Sort - weird, doesn't work
+  #      Serrano.members(query: "ecology", order: "asc")
+  #      # Works
+  #      Serrano.members(ids: 98, works: true)
+  def self.members(ids: nil, query: nil, filter: nil, offset: nil,
+    limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
+    works: false, options: nil, verbose: false)
+
+    Request.new('members', ids, query, filter, offset,
+      limit, sample, sort, order, facet, works, nil, options, verbose).perform
+  end
+
+  ##
+  # Search the prefixes route
+  #
+  # @!macro serrano_params
+  # @param filter [Hash] Filter options. See ...
+  # @param works [Boolean] If true, works returned as well. Default: false
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'serrano'
+  #      # Search by DOI, one or more
+  #      Serrano.prefixes(ids: "10.1016")
+  #      Serrano.prefixes(ids: ['10.1016','10.1371','10.1023','10.4176','10.1093'])
+  #      # works
+  #      Serrano.prefixes(ids: "10.1016", works: true)
+  #      # Limit number of results
+  #      Serrano.prefixes(ids: "10.1016", works: true, limit: 3)
+  #      # Sort and order
+  #      Serrano.prefixes(ids: "10.1016", works: true, sort: 'relevance', order: "asc")
+  def self.prefixes(ids:, filter: nil, offset: nil,
+    limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
+    works: false, options: nil, verbose: false)
+
+    Request.new('prefixes', ids, nil, filter, offset,
+      limit, sample, sort, order, facet, works, nil, options, verbose).perform
+  end
+
+  ##
+  # Search the funders route
+  #
+  # @!macro serrano_params
+  # @param query [String] A query string
+  # @param filter [Hash] Filter options. See ...
+  # @param works [Boolean] If true, works returned as well. Default: false
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'serrano'
+  #      # Search by DOI, one or more
+  #      Serrano.funders(ids: '10.13039/100000001')
+  #      Serrano.funders(ids: ['10.13039/100000001','10.13039/100000015'])
+  #      # query
+  #      Serrano.funders(query: "NSF")
+  #      # works
+  #      Serrano.funders(ids: '10.13039/100000001', works: true)
+  #      # Limit number of results
+  #      Serrano.funders(ids: '10.13039/100000001', works: true, limit: 3)
+  #      # Sort and order
+  #      Serrano.funders(ids: "10.13039/100000001", works: true, sort: 'relevance', order: "asc")
+  def self.funders(ids: nil, query: nil, filter: nil, offset: nil,
+    limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
+    works: false, options: nil, verbose: false)
+
+    Request.new('funders', ids, query, filter, offset,
+      limit, sample, sort, order, facet, works, nil, options, verbose).perform
+  end
+
+  ##
+  # Search the journals route
+  #
+  # @!macro serrano_params
+  # @param query [String] A query string
+  # @param filter [Hash] Filter options. See ...
+  # @param works [Boolean] If true, works returned as well. Default: false
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'serrano'
+  #      Serrano.journals(ids: "2167-8359")
+  #      Serrano.journals()
+  #      Serrano.journals(ids: "2167-8359", works: true)
+  #      Serrano.journals(ids: ['1803-2427', '2326-4225'])
+  #      Serrano.journals(query: "ecology")
+  #      Serrano.journals(query: "peerj")
+  #      Serrano.journals(ids: "2167-8359", query: 'ecology', works: true, sort: 'score', order: "asc")
+  #      Serrano.journals(ids: "2167-8359", query: 'ecology', works: true, sort: 'score', order: "desc")
+  #      Serrano.journals(ids: "2167-8359", works: true, filter: {from_pub_date: '2014-03-03'})
+  #      Serrano.journals(ids: '1803-2427', works: true)
+  #      Serrano.journals(ids: '1803-2427', works: true)
+  #      Serrano.journals(limit: 2)
+  #      Serrano.journals(sample: 2)
+  def self.journals(ids: nil, query: nil, filter: nil, offset: nil,
+    limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
+    works: false, options: nil, verbose: false)
+
+    Request.new('journals', ids, query, filter, offset,
+      limit, sample, sort, order, facet, works, nil, options, verbose).perform
+  end
+
+  ##
+  # Search the types route
+  #
+  # @param ids [Array] DOIs (digital object identifier) or other identifiers
+  # @param works [Boolean] If true, works returned as well. Default: false
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'serrano'
+  #      Serrano.types()
+  #      Serrano.types(ids: "journal")
+  #      Serrano.types(ids: ["journal", "dissertation"])
+  #      Serrano.types(ids: "journal", works: true)
+  def self.types(ids: nil, works: false, options: nil, verbose: false)
+
+    Request.new('types', ids, nil, nil, nil,
+      nil, nil, nil, nil, nil, works, nil, options, verbose).perform
+  end
+
+  ##
+  # Search the licenses route
+  #
+  # @!macro serrano_params
+  # @param query [String] A query string
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'serrano'
+  #      Serrano.licenses(query: "creative")
+  #      Serrano.licenses()
+  #      Serrano.licenses(limit: 3)
+  def self.licenses(ids: nil, query: nil, offset: nil,
+    limit: nil, sample: nil, sort: nil, order: nil,
+    facet: nil, options: nil, verbose: false)
+
+    Request.new('licenses', ids, query, nil, offset,
+      limit, sample, sort, order, facet, nil, nil, options, verbose).perform
+  end
+
+  ##
+  # Determine registration agency for DOIs
+  #
+  # @param ids [Array] DOIs (digital object identifier) or other identifiers
+  # @return [Array] An array of hashes
+  #
+  # @example
+  #      require 'serrano'
+  #      Serrano.agency(ids: '10.1371/journal.pone.0033693')
+  #      Serrano.agency(ids: ['10.1007/12080.1874-1746','10.1007/10452.1573-5125', '10.1111/(issn)1442-9993'])
+  def self.agency(ids:, options: nil, verbose: false)
+
+    Request.new('works', ids, nil, nil, nil,
+      nil, nil, nil, nil, nil, false, true, options, verbose).perform
+  end
+
+  ##
+  # Get a random set of DOI's
+  #
+  # @param sample [Fixnum] Number of random DOIs to return
+  # @return [Array] A list of strings, each a DOI
+  # @note This method uses {Serrano.works} internally, but doesn't allow you to pass on
+  # arguments to that method.
+  #
+  # @example
+  #      require 'serrano'
+  #      Serrano.random_dois(sample: 1)
+  #      Serrano.random_dois(sample: 10)
+  #      Serrano.random_dois(sample: 100)
+  def self.random_dois(sample:, options: nil, verbose: false)
+
+    tmp = Request.new('works', nil, nil, nil, nil,
+      nil, sample, nil, nil, nil, false, nil, options, verbose).perform
+    tmp['message']['items'].collect { |x| x['DOI'] }
+  end
+
+  ##
+  # Get citations in various formats from CrossRef
+  #
+  # @param ids [String] DOIs
+  # @param format [String] Format
+  # @param style [String] Style
+  # @param locale [String] Locale
+  # @return [Hash] A hash
+  #
+  # @example
+  #     require 'serrano'
+  #     # By default, you get bibtex, apa format, in en-US locale
+  #     Serrano.cn(ids: '10.1126/science.169.3946.635')
+  #
+  #     # get citeproc-json
+  #     Serrano.cn(ids: '10.1126/science.169.3946.635', format: "citeproc-json")
+  #     Serrano.cn(ids: "10.1126/science.169.3946.635", format: "citeproc-json")
+  #     Serrano.cn(ids: "10.1126/science.169.3946.635", format: "rdf-xml")
+  #     Serrano.cn(ids: "10.1126/science.169.3946.635", format: "crossref-xml")
+  #     Serrano.cn(ids: "10.1126/science.169.3946.635", format: "text")
+  #
+  #     # return an R bibentry type
+  #     Serrano.cn(ids: "10.1126/science.169.3946.635", format: "bibentry")
+  #     Serrano.cn(ids: "10.6084/m9.figshare.97218", format: "bibentry")
+  #
+  #     # return an apa style citation
+  #     Serrano.cn(ids: "10.1126/science.169.3946.635", format: "text", style: "apa")
+  #     Serrano.cn(ids: "10.1126/science.169.3946.635", format: "text", style: "harvard3")
+  #     Serrano.cn(ids: "10.1126/science.169.3946.635", format: "text", style: "elsevier-harvard")
+  #     Serrano.cn(ids: "10.1126/science.169.3946.635", format: "text", style: "ecoscience")
+  #     Serrano.cn(ids: "10.1126/science.169.3946.635", format: "text", style: "heredity")
+  #     Serrano.cn(ids: "10.1126/science.169.3946.635", format: "text", style: "oikos")
+  #
+  #     # example with many DOIs
+  #     dois <- cr_r(2)
+  #     Serrano.cn(dois, format: "text", style: "apa")
+  #
+  #     # Using DataCite DOIs
+  #     ## some formats don't work
+  #     # Serrano.cn(ids: "10.5284/1011335", format: "text")
+  #     # Serrano.cn(ids: "10.5284/1011335", format: "crossref-xml")
+  #     # Serrano.cn(ids: "10.5284/1011335", format: "crossref-tdm")
+  #
+  #     ## But most do work
+  #     Serrano.cn(ids: "10.5284/1011335", format: "datacite-xml")
+  #     Serrano.cn(ids: "10.5284/1011335", format: "rdf-xml")
+  #     Serrano.cn(ids: "10.5284/1011335", format: "turtle")
+  #     Serrano.cn(ids: "10.5284/1011335", format: "citeproc-json")
+  #     Serrano.cn(ids: "10.5284/1011335", format: "ris")
+  #     Serrano.cn(ids: "10.5284/1011335", format: "bibtex")
+  #     Serrano.cn(ids: "10.5284/1011335", format: "bibentry")
+  #     Serrano.cn(ids: "10.5284/1011335", format: "bibtex")
+  #
+  #     # many DOIs
+  #     dois = ['10.5167/UZH-30455','10.5167/UZH-49216','10.5167/UZH-503', '10.5167/UZH-38402','10.5167/UZH-41217']
+  #     x = Serrano.cn(ids: dois)
+  #     puts x
+  def self.cn(ids:, format: "bibtex", style: 'apa', locale: "en-US")
+    CNRequest.new(ids, format, style, locale).perform
+  end
+
+  ##
+  # Get full text
+  #
+  # Should work for open access papers, but for closed, requires authentication and
+  # likely pre-authorized IP address.
+  #
+  # @param url [String] A url for full text
+  # @param type [Hash] Ignored for now. One of xml, plain, or pdf. Right now, type auto-detected from the URL
+  # @return [Mined] An object of class Mined, with methods for extracting
+  # the url requested, the file path, and parsing the plain text, XML, or extracting
+  # text from the pdf.
+  #
+  # @example
+  #   require 'serrano'
+  #   # Set authorization
+  #   Serrano.configuration do |config|
+  #     config.elsevier_key = "<your key>"
+  #   end
+  #   # Get some elsevier works
+  #   res = Serrano.members(ids: 78, works: true);
+  #   # get full text links, here doing xml
+  #   links = res[0]['message']['items'].collect { |x| x['link'].keep_if { |z| z['content-type'] == 'text/xml' } };
+  #   links = links.collect { |z| z[0].select { |k,v| k[/URL/] }.values[0] };
+  #   # Get full text for an article
+  #   res = Serrano.text(url: links[0]);
+  #   res.url
+  #   res.path
+  #   res.type
+  #   xml = res.parse()
+  #   puts xml
+  #   xml.xpath('//xocs:cover-date-text', xml.root.namespaces).text
+  #
+  #   ## plain text
+  #   # get full text links, here doing xml
+  #   links = res[0]['message']['items'].collect { |x| x['link'].keep_if { |z| z['content-type'] == 'text/plain' } };
+  #   links = links.collect { |z| z[0].select { |k,v| k[/URL/] }.values[0] };
+  #   # Get full text for an article
+  #   res = Serrano.text(url: links[0]);
+  #   res.url
+  #   res.parse
+  #
+  #   # With open access content - using Pensoft
+  #   res = Serrano.members(ids: 2258, works: true, filter: {has_full_text: true});
+  #   links = res[0]['message']['items'].collect { |x| x['link'].keep_if { |z| z['content-type'] == 'application/xml' } };
+  #   links = links.collect { |z| z[0].select { |k,v| k[/URL/] }.values[0] };
+  #   # Get full text for an article
+  #   res = Serrano.text(url: links[0]);
+  #   res.url
+  #   res.parse
+  def self.text(url:, type: 'xml')
+    Miner.new(url, type).perform
+  end
+
+  # Lookup article info via CrossRef with DOI and get a citation count
+  #
+  # @param doi [String] DOI, digital object identifier
+  # @param url [String] the API url for the function (should be left to default)
+  # @param key [String] your API key
+  #
+  # @see http://labs.crossref.org/openurl/ for more info on this Crossref API service.
+  #
+  # @example
+  #   require 'serrano'
+  #   Serrano.citation_count(doi: "10.1371/journal.pone.0042793")
+  #   Serrano.citation_count(doi: "10.1016/j.fbr.2012.01.001")
+  #   # DOI not found
+  #   Serrano.citation_count(doi: "10.1016/j.fbr.2012")
+  def self.citation_count(doi:, url: "http://www.crossref.org/openurl/",
+    key: "cboettig@ropensci.org", options: nil)
+
+    args = { id: "doi:" + doi, pid: key, noredirect: true }
+    opts = args.delete_if { |k, v| v.nil? }
+    conn = Faraday.new(:url => url, :request => options)
+    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
+    return value
+  end
+
+end