serrano 0.0.7 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00aa3283924fc74b4a2634759602caa5516b26e3
-  data.tar.gz: bd653f31833befbb3dd5be3a4fff893e22e13756
+  metadata.gz: 7fa7f1bc525d14c6f53869ed4288b8579158ce73
+  data.tar.gz: ab896db087318532f052e43a930ba1e1be3f3943
 SHA512:
-  metadata.gz: 874a4e19e0ac4439c75be43782d7da74adf00a082d4352e6d13458fdaac442d5048fda4faf7db5f747c76220821a4b5a1270477bf931d5202842604358f2bfe7
-  data.tar.gz: ffb5ebb232ef610865833c6b147be959a7313a8b3904bdd429aa2cac17548879693df195d91cb31a40009ce8d3a59bec46e16dfad0c5a16895d04bd3fcb8ae87
+  metadata.gz: 934c68640bfabef4df7e91898406a0948a395c1ef3f0cf1c5d04aa8e32108836a909e90427d2e93ff0a75767fcade878f4119c1f6ee8d15012473664a6aa85bb
+  data.tar.gz: 45437444480642e2b48cb6b11a33b9dbc60277f62eb50cfc48aab90a5847aa21dc1fdb4e71a8fac870ca4fc9b541d0a118406fb30a3d033d784537dd63af9a92

data/.gitignore

@@ -33,4 +33,6 @@ build/
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
-cache/
+cache/
+
+lib/serrano/response.rb

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.1.0 (2015-11-17)
+
+* Improved documentation
+* `licenses()` loses `ids` param as it doesn't accept IDs
+* `agency()` method changed to `registration_agency()`
+* `cn()` method changed to `content_negotiation()`
+* `random_dois()` gains default value of `sample = 10`
+* New method `get_styles()` to get CSL styles
+
+## 0.0.7 (2015-11-04)
+
+* First version to Rubygems

data/CONDUCT.md

@@ -1,6 +1,6 @@
 # Contributor Code of Conduct
 
-As contributors and maintainers of this project, we pledge to respect all people who 
+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.
 
@@ -13,13 +13,13 @@ imagery, derogatory comments or personal attacks, trolling, public or private ha
 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 
+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 
+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 
+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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    serrano (0.0.7)
+    serrano (0.1.1)
       faraday (~> 0.9.1)
       faraday_middleware (~> 0.10.0)
       multi_json (~> 1.0)

data/README.md

@@ -1,12 +1,13 @@
 serrano
 =========
 
+[![gem version](https://img.shields.io/gem/v/serrano.svg)](https://rubygems.org/gems/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/
+Docs: http://www.rubydoc.info/gems/serrano
 
 Other Crossref API clients:
 
@@ -15,7 +16,7 @@ Other Crossref API clients:
 
 ## Changes
 
-For changes see the [NEWS file](NEWS.md).
+For changes see the [Changelog](CHANGELOG.md)
 
 ## API
 
@@ -31,13 +32,15 @@ Methods in relation to [Crossref search API][crapi] routes
 
 Additional methods built on top of the Crossref search API:
 
-* DOI minting agency - `Serrano.agency()`
+* DOI minting agency - `Serrano.registration_agency()`
 * Get random DOIs - `Serrano.random_dois()`
 
 Other methods:
 
-* [Conent negotiation][cn] - `Serrano.cn()`
+* [Conent negotiation][cn] - `Serrano.content_negotiation()`
 * [Text and data mining][tdm] - `Serrano.text()`
+* [Citation count][ccount] - `Serrano.citation_count()`
+* [get CSL styles][csl] -  `Serrano.csl_styles()`
 
 ## Install
 
@@ -97,7 +100,7 @@ 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'])
+Serrano.registration_agency(ids: ['10.1007/12080.1874-1746','10.1007/10452.1573-5125'])
 ```
 
 Get random set of DOIs
@@ -126,3 +129,5 @@ res = Serrano.text(url: 'http://...');
 [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/
+[ccount]: http://labs.crossref.org/openurl/
+[csl]: https://github.com/citation-style-language/styles

data/Rakefile

@@ -20,7 +20,7 @@ task :b do
   system "bundle install"
 end
 
-desc "bundle install"
+desc "clean out builds"
 task :clean do
   system "ls | grep [0-9].gem | xargs rm"
 end

data/bin/serrano

@@ -0,0 +1,444 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require "serrano"
+require "multi_json"
+
+class Sr < Thor
+  include Thor::Actions
+  # class_option :json, :type => :boolean, :default => false
+
+  desc "works [DOIs]", "Get works by DOIs"
+  long_desc <<-LONGDESC
+    `serrano works` accepts one or more DOIs to search for works
+
+    Toggle `json` to get simplified (summary) or complete output (JSON)
+
+    # A single DOI
+    \x5$ serrano works 10.1371/journal.pone.0033693
+
+    DOI: 10.1371/journal.pone.0033693
+    \x5type: journal-article
+    \x5title: Methylphenidate Exposure Induces Dopamine Neuron Loss and Activation of Microglia in the Basal Ganglia of Mice
+
+    # Many DOIs
+    \x5$ serrano works "10.1007/12080.1874-1746,10.1007/10452.1573-5125"
+
+    DOI: 10.1007/12080.1874-1746
+    \x5type: journal
+    \x5title: Theoretical Ecology
+
+    DOI: 10.1007/10452.1573-5125
+    \x5type: journal
+    \x5title: Aquatic Ecology
+
+    # Verbose output gives JSON, pipe onwards, e.g., parse with jq
+    \x5$ serrano works "10.1371/journal.pone.0033693,10.1007/12080.1874-1746,10.1007/10452.1573-5125" --json=true | jq .[].message.member
+
+    "http://id.crossref.org/member/340"
+    \x5"http://id.crossref.org/member/297"
+    \x5"http://id.crossref.org/member/297"
+  LONGDESC
+  option :json, :type => :boolean, :default => false
+  def works(*dois)
+    out = Serrano.works(ids: dois)
+    if !options[:json]
+      out = out.collect { |x| x['message'].select { |k,v| k[/DOI|type|title/] } }
+      out.each do |x|
+        puts 'DOI: ' + x['DOI'].to_s
+        puts 'type: ' + x['type']
+        puts 'title: ' + x['title'][0]
+        puts
+      end
+    else
+      puts MultiJson.encode(out)
+    end
+  end
+
+  desc "members [member IDs]", "Get members by id"
+  long_desc <<-LONGDESC
+    `serrano members` accepts one or more Crossref member IDs
+
+    Toggle `json` to get simplified (summary) or complete output (JSON)
+
+    $ serrano members 98
+
+    id: 98
+    \x5title: Hindawi Publishing Corporation
+
+    $ serrano members "98,340"
+
+    id: 98
+    \x5title: Hindawi Publishing Corporation
+
+    id: 340
+    \x5title: Public Library of Science (PLoS)
+
+    $ serrano members "98,340,45,311,78" --json=true | jq .[].message.coverage.\"resource-links-current\"
+
+    1 0 0 0.8311812281608582 0.985091507434845
+
+    $ serrano members 98 --works=true --json=true | jq .[].message.items[].\"reference-count\"
+
+    24 7 45 31 22 67 72 17 53 75 0 68 12 16 50 79 40 18 40 195
+  LONGDESC
+  option :json, :type => :boolean, :default => false
+  option :query, :type => :string, :default => nil
+  option :limit, :type => :numeric, :default => nil
+  option :works, :type => :boolean, :default => false
+  def members(ids=nil)
+    if ids.nil?
+      out = Serrano.members(query: options[:query], limit: options[:limit],
+        works: options[:works])
+    else
+      out = Serrano.members(ids: ids.split(","), query: options[:query], limit: options[:limit],
+        works: options[:works])
+    end
+
+    if !options[:json]
+      if !options[:works]
+        if out.class == Hash
+          out = out['message']['items']
+        else
+          out = out.collect { |x| x['message'] }
+        end
+
+        # out = out.collect { |x| x['message'].select { |k,v| k[/id|primary-name/] } }
+        out.each do |x|
+          puts 'id: ' + x['id'].to_s
+          puts 'title: ' + x['primary-name']
+          puts
+        end
+      else
+        print_works(out)
+      end
+    else
+      puts MultiJson.encode(out)
+    end
+  end
+
+
+  desc "prefixes [DOI prefixes]", "Search for prefixes by DOI prefix"
+  long_desc <<-LONGDESC
+    `serrano prefixes` accepts one or more Crossref member IDs
+
+    Toggle `json` to get simplified (summary) or complete output (JSON)
+
+    $ serrano prefixes 10.1016
+
+    member: http://id.crossref.org/member/78
+    \x5name: Elsevier BV
+    \x5prefix: http://id.crossref.org/prefix/10.1016
+
+    $ serrano prefixes "10.1016,10.1371"
+
+    member: http://id.crossref.org/member/78
+    \x5name: Elsevier BV
+    \x5prefix: http://id.crossref.org/prefix/10.1016
+
+    member: http://id.crossref.org/member/340
+    \x5name: Public Library of Science (PLoS)
+    \x5prefix: http://id.crossref.org/prefix/10.1371
+
+    $ serrano prefixes "10.1016,10.1371,10.1023,10.4176,10.1093" --json=true | jq .[].message.name
+
+    "Elsevier BV"
+    \x5"Public Library of Science (PLoS)"
+    \x5"Springer Science + Business Media"
+    \x5"Co-Action Publishing"
+    \x5"Oxford University Press (OUP)"
+  LONGDESC
+  option :json, :type => :boolean, :default => false
+  option :limit, :type => :numeric, :default => nil
+  option :works, :type => :boolean, :default => false
+  def prefixes(ids=nil)
+    if ids.nil?
+      out = Serrano.prefixes(limit: options[:limit], works: options[:works])
+    else
+      out = Serrano.prefixes(ids: ids.split(","), limit: options[:limit],
+        works: options[:works])
+    end
+
+    if !options[:json]
+      if !options[:works]
+        if out.class == Hash
+          out = out['message']['items']
+        else
+          out = out.collect { |x| x['message'] }
+        end
+
+        out.each do |x|
+          puts 'member: ' + x['member']
+          puts 'name: ' + x['name']
+          puts 'prefix: ' + x['prefix']
+          puts
+        end
+      else
+        print_works(out)
+      end
+    else
+      puts MultiJson.encode(out)
+    end
+  end
+
+  desc "funders [funder IDs]", "Search for funders by DOI prefix"
+  long_desc <<-LONGDESC
+    `serrano funders` accepts one or more Crossref funder IDs
+
+    Toggle `json` to get simplified (summary) or complete output (JSON)
+
+    $ serrano funders 100004410
+
+    id: 100004410
+    \x5name: European Molecular Biology Organization
+    \x5location: Germany
+
+    $ serrano funders "10.13039/100000001,10.13039/100000015"
+
+    id: 100000001
+    \x5name: National Science Foundation
+    \x5location: United States
+
+    id: 100000015
+    \x5name: U.S. Department of Energy
+    \x5location: United States
+
+    $ serrano funders "10.13039/100000001,10.13039/100000015" --json=true | jq .[].message.name
+
+    "National Science Foundation"
+    \x5"U.S. Department of Energy"
+
+    $ serrano funders --query=NSF --limit=2
+
+    $ serrano funders 10.13039/100000001 --works=true --limit=2
+  LONGDESC
+  option :json, :type => :boolean, :default => false
+  option :query, :type => :string, :default => nil
+  option :limit, :type => :numeric, :default => nil
+  option :works, :type => :boolean, :default => false
+  def funders(ids=nil)
+    if ids.nil?
+      out = Serrano.funders(query: options[:query], limit: options[:limit],
+        works: options[:works])
+    else
+      out = Serrano.funders(ids: ids.split(","), query: options[:query], limit: options[:limit],
+        works: options[:works])
+    end
+
+    if !options[:json]
+      if !options[:works]
+        if out.class == Hash
+          out = out['message']['items']
+        else
+          out = out.collect { |x| x['message'] }
+        end
+
+        out.each do |x|
+          puts 'id: ' + x['id']
+          puts 'name: ' + x['name']
+          puts 'location: ' + x['location']
+          puts
+        end
+      else
+        print_works(out)
+      end
+    else
+      puts MultiJson.encode(out)
+    end
+  end
+
+
+  desc "journals [journal ISSNs]", "Search for journals by ISSNs"
+  long_desc <<-LONGDESC
+    `serrano journals` accepts one or more journal ISSNs
+
+    Toggle `json` to get simplified (summary) or complete output (JSON)
+
+    $ serrano journals 2167-8359
+
+    id: 100004410
+    \x5name: European Molecular Biology Organization
+    \x5location: Germany
+
+    $ serrano journals "1803-2427,2326-4225"
+
+    id: 100000001
+    \x5name: National Science Foundation
+    \x5location: United States
+
+    id: 100000015
+    \x5name: U.S. Department of Energy
+    \x5location: United States
+
+    $ serrano journals "1803-2427,2326-4225" --json=true | jq .[].message.title
+
+    "National Science Foundation"
+    \x5"U.S. Department of Energy"
+
+    $ serrano journals --query=ecology --limit=2
+
+    $ serrano journals 2167-8359 --query=ecology --works=true --limit=2
+  LONGDESC
+  option :json, :type => :boolean, :default => false
+  option :query, :type => :string, :default => nil
+  option :limit, :type => :numeric, :default => nil
+  option :works, :type => :boolean, :default => false
+  def journals(ids=nil)
+    if ids.nil?
+      out = Serrano.journals(query: options[:query], limit: options[:limit],
+        works: options[:works])
+    else
+      out = Serrano.journals(ids: ids.split(","), query: options[:query], limit: options[:limit],
+        works: options[:works])
+    end
+
+    if !options[:json]
+      if !options[:works]
+        if out.class == Hash
+          out = out['message']['items']
+        else
+          out = out.collect { |x| x['message'] }
+        end
+
+        out.each do |x|
+          puts 'ISSN: ' + x['ISSN'][0]
+          puts 'title: ' + x['title']
+          puts 'publisher: ' + x['publisher']
+          puts
+        end
+      else
+        print_works(out)
+      end
+    else
+      puts MultiJson.encode(out)
+    end
+  end
+
+  desc "types [type name]", "Search for types by name"
+  long_desc <<-LONGDESC
+    `serrano types` accepts one or more type names
+
+    Toggle `json` to get simplified (summary) or complete output (JSON)
+
+    $ serrano types journal
+
+    id: 100004410
+    \x5name: European Molecular Biology Organization
+    \x5location: Germany
+
+    $ serrano types journal dissertation
+
+    id: 100000001
+    \x5name: National Science Foundation
+    \x5location: United States
+
+    id: 100000015
+    \x5name: U.S. Department of Energy
+    \x5location: United States
+
+    $ serrano types journal dissertation --json=true | jq .[].message
+
+    "National Science Foundation"
+    \x5"U.S. Department of Energy"
+
+    $ serrano types dissertation --works
+
+    $ serrano types dissertation --works --limit=2
+  LONGDESC
+  option :json, :type => :boolean, :default => false
+  option :works, :type => :boolean, :default => false
+  option :limit, :type => :numeric, :default => nil
+  def types(*ids)
+    out = Serrano.types(ids: ids, limit: options[:limit],
+      works: options[:works])
+
+    if !options[:json]
+      if !options[:works]
+        if out.class == Hash
+          out = out['message']['items']
+        else
+          out = out.collect { |x| x['message'] }
+        end
+
+        out.each do |x|
+          puts 'id: ' + x['id']
+          puts 'label: ' + x['label']
+          puts
+        end
+      else
+        print_works(out)
+      end
+    else
+      puts MultiJson.encode(out)
+    end
+  end
+
+  desc "licenses", "Search for licenses by name"
+  long_desc <<-LONGDESC
+    `serrano licenses` accepts one or more type names
+
+    Toggle `json` to get simplified (summary) or complete output (JSON)
+
+    $ serrano licenses
+
+    url: http://avs.org
+    \x5work-count: 1
+
+    url: http://creativecommons.org/LICENSEs/by/3.0/
+    \x5work-count: 14
+
+    $ serrano licenses --query=creative
+
+    id: 100000001
+    \x5name: National Science Foundation
+    \x5location: United States
+
+    id: 100000015
+    \x5name: U.S. Department of Energy
+    \x5location: United States
+
+    $ serrano licenses --json=true | jq .[].message.items.work-count
+
+    "National Science Foundation"
+    \x5"U.S. Department of Energy"
+  LONGDESC
+  option :json, :type => :boolean, :default => false
+  option :query, :type => :string, :default => nil
+  def licenses
+    out = Serrano.licenses(query: options[:query])
+    if !options[:json]
+      out = out['message']['items']
+      out.each do |x|
+        puts 'url: ' + x['URL']
+        puts 'work-count: ' + x['work-count'].to_s
+        puts
+      end
+    else
+      puts MultiJson.encode(out)
+    end
+  end
+
+  desc "version", "Get serrano version"
+  def version
+    puts Serrano::VERSION
+  end
+
+  private
+
+  def print_works(data)
+    if data.is_a? Array
+      data = data[0]['message']['items']
+    else
+      data = data.collect { |x| x['message'].select { |k,v| k[/DOI|type|title/] } }
+    end
+    data.each do |x|
+      puts 'DOI: ' + x['DOI']
+      puts 'type: ' + x['type']
+      puts 'title: ' + x['title'][0]
+      puts
+    end
+  end
+
+end
+
+Sr.start(ARGV)

data/lib/serrano.rb

@@ -9,7 +9,6 @@ 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,
@@ -22,6 +21,9 @@ require 'rexml/xpath'
 #   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 verbose [Boolean] Print request headers to stdout. Default: false
+
+# @!macro serrano_options
 #   @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
@@ -33,23 +35,26 @@ require 'rexml/xpath'
 #     :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
+# * `Serrano.works` - Use the /works endpoint
+# * `Serrano.members` - Use the /members endpoint
+# * `Serrano.prefixes` - Use the /prefixes endpoint
+# * `Serrano.funders` - Use the /funders endpoint
+# * `Serrano.journals` - Use the /journals endpoint
+# * `Serrano.types` - Use the /types endpoint
+# * `Serrano.licenses` - Use the /licenses endpoint
 #
 # Additional methods
-# * agency - test the registration agency for a DOI
+# * `Serrano.agency` - test the registration agency for a DOI
+# * `Serrano.content_negotiation` - Conent negotiation
+# * `Serrano.text` - Text and data mining
+# * `Serrano.citation_count` - Citation count
+# * `Serrano.csl_styles` - get CSL styles
 #
 # All routes return an array of hashes
 # For example, if you want to inspect headers returned from the HTTP request,
@@ -69,6 +74,8 @@ module Serrano
   # Search the works route
   #
   # @!macro serrano_params
+  # @!macro serrano_options
+  # @param ids [Array] DOIs (digital object identifier) or other identifiers
   # @param query [String] A query string
   # @param filter [Hash] Filter options. See ...
   # @return [Array] An array of hashes
@@ -106,6 +113,8 @@ module Serrano
   # Search the members route
   #
   # @!macro serrano_params
+  # @!macro serrano_options
+  # @param ids [Array] DOIs (digital object identifier) or other identifiers
   # @param query [String] A query string
   # @param filter [Hash] Filter options. See ...
   # @param works [Boolean] If true, works returned as well. Default: false
@@ -136,6 +145,8 @@ module Serrano
   # Search the prefixes route
   #
   # @!macro serrano_params
+  # @!macro serrano_options
+  # @param ids [Array] DOIs (digital object identifier) or other identifiers
   # @param filter [Hash] Filter options. See ...
   # @param works [Boolean] If true, works returned as well. Default: false
   # @return [Array] An array of hashes
@@ -163,6 +174,8 @@ module Serrano
   # Search the funders route
   #
   # @!macro serrano_params
+  # @!macro serrano_options
+  # @param ids [Array] DOIs (digital object identifier) or other identifiers
   # @param query [String] A query string
   # @param filter [Hash] Filter options. See ...
   # @param works [Boolean] If true, works returned as well. Default: false
@@ -171,7 +184,7 @@ module Serrano
   # @example
   #      require 'serrano'
   #      # Search by DOI, one or more
-  #      Serrano.funders(ids: '10.13039/100000001')
+  #      Serrano.funders(ids: 100004410)
   #      Serrano.funders(ids: ['10.13039/100000001','10.13039/100000015'])
   #      # query
   #      Serrano.funders(query: "NSF")
@@ -193,6 +206,8 @@ module Serrano
   # Search the journals route
   #
   # @!macro serrano_params
+  # @!macro serrano_options
+  # @param ids [Array] DOIs (digital object identifier) or other identifiers
   # @param query [String] A query string
   # @param filter [Hash] Filter options. See ...
   # @param works [Boolean] If true, works returned as well. Default: false
@@ -224,6 +239,7 @@ module Serrano
   ##
   # Search the types route
   #
+  # @!macro serrano_options
   # @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
@@ -234,16 +250,18 @@ module Serrano
   #      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)
+  def self.types(ids: nil, offset: nil,
+    limit: nil, works: false, options: nil, verbose: false)
 
-    Request.new('types', ids, nil, nil, nil,
-      nil, nil, nil, nil, nil, works, nil, options, verbose).perform
+    Request.new('types', ids, nil, nil, offset,
+      limit, nil, nil, nil, nil, works, nil, options, verbose).perform
   end
 
   ##
   # Search the licenses route
   #
   # @!macro serrano_params
+  # @!macro serrano_options
   # @param query [String] A query string
   # @return [Array] An array of hashes
   #
@@ -252,25 +270,26 @@ module Serrano
   #      Serrano.licenses(query: "creative")
   #      Serrano.licenses()
   #      Serrano.licenses(limit: 3)
-  def self.licenses(ids: nil, query: nil, offset: nil,
+  def self.licenses(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,
+    Request.new('licenses', nil, query, nil, offset,
       limit, sample, sort, order, facet, nil, nil, options, verbose).perform
   end
 
   ##
   # Determine registration agency for DOIs
   #
+  # @!macro serrano_options
   # @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)
+  #      Serrano.registration_agency(ids: '10.1371/journal.pone.0033693')
+  #      Serrano.registration_agency(ids: ['10.1007/12080.1874-1746','10.1007/10452.1573-5125', '10.1111/(issn)1442-9993'])
+  def self.registration_agency(ids:, options: nil, verbose: false)
 
     Request.new('works', ids, nil, nil, nil,
       nil, nil, nil, nil, nil, false, true, options, verbose).perform
@@ -279,17 +298,21 @@ module Serrano
   ##
   # Get a random set of DOI's
   #
+  # @!macro serrano_options
   # @param sample [Fixnum] Number of random DOIs to return
+  # @param verbose [Boolean] Print request headers to stdout. Default: false
   # @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'
+  #      # by default, gives 10
+  #      Serrano.random_dois()
   #      Serrano.random_dois(sample: 1)
   #      Serrano.random_dois(sample: 10)
   #      Serrano.random_dois(sample: 100)
-  def self.random_dois(sample:, options: nil, verbose: false)
+  def self.random_dois(sample: 10, options: nil, verbose: false)
 
     tmp = Request.new('works', nil, nil, nil, nil,
       nil, sample, nil, nil, nil, false, nil, options, verbose).perform
@@ -308,52 +331,54 @@ module Serrano
   # @example
   #     require 'serrano'
   #     # By default, you get bibtex, apa format, in en-US locale
-  #     Serrano.cn(ids: '10.1126/science.169.3946.635')
+  #     Serrano.content_negotiation(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")
+  #     Serrano.content_negotiation(ids: '10.1126/science.169.3946.635', format: "citeproc-json")
+  #     Serrano.content_negotiation(ids: "10.1126/science.169.3946.635", format: "citeproc-json")
+  #
+  #     # some other formats
+  #     Serrano.content_negotiation(ids: "10.1126/science.169.3946.635", format: "rdf-xml")
+  #     Serrano.content_negotiation(ids: "10.1126/science.169.3946.635", format: "crossref-xml")
+  #     Serrano.content_negotiation(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")
+  #     Serrano.content_negotiation(ids: "10.1126/science.169.3946.635", format: "bibentry")
+  #     Serrano.content_negotiation(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")
+  #     Serrano.content_negotiation(ids: "10.1126/science.169.3946.635", format: "text", style: "apa")
+  #     Serrano.content_negotiation(ids: "10.1126/science.169.3946.635", format: "text", style: "harvard3")
+  #     Serrano.content_negotiation(ids: "10.1126/science.169.3946.635", format: "text", style: "elsevier-harvard")
+  #     Serrano.content_negotiation(ids: "10.1126/science.169.3946.635", format: "text", style: "ecoscience")
+  #     Serrano.content_negotiation(ids: "10.1126/science.169.3946.635", format: "text", style: "heredity")
+  #     Serrano.content_negotiation(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")
+  #     dois = cr_r(2)
+  #     Serrano.content_negotiation(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")
+  #     # Serrano.content_negotiation(ids: "10.5284/1011335", format: "text")
+  #     # Serrano.content_negotiation(ids: "10.5284/1011335", format: "crossref-xml")
+  #     # Serrano.content_negotiation(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")
+  #     Serrano.content_negotiation(ids: "10.5284/1011335", format: "datacite-xml")
+  #     Serrano.content_negotiation(ids: "10.5284/1011335", format: "rdf-xml")
+  #     Serrano.content_negotiation(ids: "10.5284/1011335", format: "turtle")
+  #     Serrano.content_negotiation(ids: "10.5284/1011335", format: "citeproc-json")
+  #     Serrano.content_negotiation(ids: "10.5284/1011335", format: "ris")
+  #     Serrano.content_negotiation(ids: "10.5284/1011335", format: "bibtex")
+  #     Serrano.content_negotiation(ids: "10.5284/1011335", format: "bibentry")
+  #     Serrano.content_negotiation(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)
+  #     x = Serrano.content_negotiation(ids: dois)
   #     puts x
-  def self.cn(ids:, format: "bibtex", style: 'apa', locale: "en-US")
+  def self.content_negotiation(ids:, format: "bibtex", style: 'apa', locale: "en-US")
     CNRequest.new(ids, format, style, locale).perform
   end
 
@@ -410,8 +435,9 @@ module Serrano
     Miner.new(url, type).perform
   end
 
-  # Lookup article info via CrossRef with DOI and get a citation count
+  # Get a citation count with a DOI
   #
+  # @!macro serrano_options
   # @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
@@ -437,4 +463,14 @@ module Serrano
     return value
   end
 
+  # Get csl styles
+  #
+  # @see https://github.com/citation-style-language/styles
+  #
+  # @example
+  #   Serrano.csl_styles
+  def self.csl_styles
+    get_styles()
+  end
+
 end

data/lib/serrano/version.rb

@@ -1,3 +1,3 @@
 module Serrano
-  VERSION = "0.0.7"
+  VERSION = "0.1.1"
 end

data/serrano.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.version     = Serrano::VERSION
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 2.0'
-  s.date        = '2015-11-04'
+  s.date        = '2015-11-17'
   s.summary     = "Crossref Client"
   s.description = "Low Level Ruby Client for the Crossref Search API"
   s.authors     = "Scott Chamberlain"
@@ -19,6 +19,9 @@ Gem::Specification.new do |s|
   s.files = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
   s.require_paths = ["lib"]
 
+  s.bindir      = 'bin'
+  s.executables = ['serrano']
+
   s.add_development_dependency "bundler", '~> 1.6'
   s.add_development_dependency "rake", '~> 10.4'
   s.add_development_dependency "test-unit", '~> 3.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serrano
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.1
 platform: ruby
 authors:
 - Scott Chamberlain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -198,19 +198,21 @@ dependencies:
         version: 2.1.5
 description: Low Level Ruby Client for the Crossref Search API
 email: myrmecocystus@gmail.com
-executables: []
+executables:
+- serrano
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- NEWS.md
 - README.md
 - Rakefile
+- bin/serrano
 - lib/serrano.rb
 - lib/serrano/cn.rb
 - lib/serrano/cnrequest.rb

data/NEWS.md

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