lagotto-rb 0.2.0

data/examples/alm.rb

@@ -0,0 +1,20 @@
+require 'alm'
+require 'httparty'
+
+# Get altmetrics by DOI
+## swap out the key and instance to change provider
+Alm.alm(ids: '10.1371/journal.pone.0029797', key: ENV['CROSSREF_API_KEY'], instance: "crossref")
+Alm.alm(ids: ['10.1371/journal.pone.0029797','10.1016/j.dsr2.2010.10.029'], key: ENV['CROSSREF_API_KEY'], instance: "crossref")
+Alm.alm(ids: '10.4081/audiores.2013.e1', key: ENV['PKP_API_KEY'], instance: "pkp")
+Alm.alm(ids: '10.1371/journal.pone.0025110', key: ENV['PLOS_API_KEY'], instance: "plos")
+ids = ["10.1371/journal.pone.0029797","10.1371/journal.pone.0029798"]
+Alm.alm(ids: ids, key: ENV['PLOS_API_KEY'], instance: "plos")
+
+# Search by source
+Alm.alm(source: 'twitter', key: ENV['CROSSREF_API_KEY'], instance: "crossref")
+Alm.alm(instance: "crossref", per_page: 5, key: ENV['CROSSREF_API_KEY'])
+
+# Get data by publisher
+ids = HTTParty.get("http://api.crossref.org/members")
+ids = ids['message']['items'].collect { |p| p['id'] }
+Alm.alm(publisher: ids[0], info: "summary")

data/examples/events.rb

@@ -0,0 +1,20 @@
+require 'alm'
+require 'httparty'
+
+# Get events by DOI
+## swap out the key and instance to change provider
+Lagotto.events(ids: '10.1371/journal.pone.0029797', instance: "crossref")
+Lagotto.events(ids: ['10.1371/journal.pone.0029797','10.1016/j.dsr2.2010.10.029'], instance: "crossref")
+Lagotto.events(ids: '10.4081/audiores.2013.e1', instance: "pkp")
+Lagotto.events(ids: "10.1371/journal.pone.0029797")
+ids = ["10.1371/journal.pone.0029797","10.1371/journal.pone.0029798"]
+Lagotto.events(ids: ids)
+
+# Search by source
+Lagotto.events(source: 'twitter', instance: "crossref")
+Lagotto.events(instance: "crossref", per_page: 5)
+
+# Get data by publisher
+ids = HTTParty.get("http://api.crossref.org/members")
+ids = ids['message']['items'].collect { |p| p['id'] }
+Lagotto.events(publisher: ids[0], info: "summary")

data/examples/requests.rb

@@ -0,0 +1,5 @@
+require 'alm'
+
+Alm.requests(key: ENV['CROSSREF_API_KEY'], instance: "crossref")
+Alm.requests(key: ENV['PLOS_API_KEY'])
+Alm.requests(key: ENV['PKP_API_KEY'], instance: "pkp")

data/examples/sources.rb

@@ -0,0 +1,10 @@
+require 'alm'
+
+# a single source
+Lagotto.sources(source: 'twitter', per_page: 2)
+Lagotto.sources(source: 'mendeley', per_page: 3)
+Lagotto.sources(source: 'facebook', per_page: 1, info: "detail")
+
+# many sources
+sources = ['facebook','twitter','mendeley']
+sources.collect { |x| Lagotto.sources(source: x, per_page: 1) }

data/examples/status.rb

@@ -0,0 +1,5 @@
+require 'alm'
+
+Lagotto.status(key: ENV['CROSSREF_API_KEY'], instance: "crossref")
+Lagotto.status(key: ENV['PLOS_API_KEY'])
+Lagotto.status(key: ENV['PKP_API_KEY'], instance: "pkp")

data/ignore/alerts.rb

@@ -0,0 +1,24 @@
+  def self.alerts(source: nil, ids: nil, class_name: nil, level: nil, q: nil,
+    unresolved: nil, per_page: 50, page: 1, user: nil, pwd: nil,
+    instance: 'plos', options: {})
+
+    url = pick_url_alerts(instance)
+    # userpwd = getuserinfo(user, pwd)
+    options = {
+      query: {
+        q: q,
+        class_name: class_name,
+        source: source,
+        level: level,
+        unresolved: unresolved,
+        ids: ids,
+        rows: per_page,
+        page: page
+      },
+      basic_auth: { username: user, password: pwd }
+    }
+    options[:query] = options[:query].reject{ |i,j| j == nil }
+    res = HTTParty.get(url, options)
+    response_ok(res.code)
+    return res
+  end

data/ignore/other_methods.rb

@@ -0,0 +1,23 @@
+  ##
+  # Make a `/requests` route request
+  #
+  # @!macro lagotto_params
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example:
+  #      require 'lagotto-rb'
+  #      Lagotto.requests(key: ENV['PLOS_API_KEY'])
+  def self.requests(key: nil, instance: 'plos', options: nil, verbose: false)
+    url = pick_url(instance)
+    BasicRequest.new(url, 'api_requests', key, options, verbose).perform
+    # options = {
+    #   query: {
+    #     api_key: key
+    #   },
+    #   headers: {"Accept" => 'application/json'}
+    # }
+    # res = HTTParty.get(url+'/api_requests', options)
+    # response_ok(res.code)
+    # return res
+  end

data/lagotto-rb.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lagotto-rb/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'lagotto-rb'
+  s.version     = Lagotto::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 2.0'
+  s.date        = '2016-01-08'
+  s.summary     = "Lagotto client for Ruby"
+  s.description = "Lagotto client for Ruby - get altmetrics from any Lagotto installation."
+  s.authors     = ["Scott Chamberlain"]
+  s.email       = 'myrmecocystus@gmail.com'
+  s.homepage    = 'http://github.com/lagotto/lagotto-rb'
+  s.licenses    = 'MIT'
+
+  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 = ['lagotto']
+
+  s.add_development_dependency "bundler", "~> 1.6"
+  s.add_development_dependency "rake", '~> 0'
+  s.add_development_dependency "test-unit", '~> 3.1'
+  s.add_development_dependency "simplecov", '~> 0.10'
+  s.add_development_dependency "codecov", '~> 0.1'
+
+  s.add_runtime_dependency 'thor', '~> 0.18'
+  s.add_runtime_dependency 'launchy', '~> 2.4', '>= 2.4.2'
+  s.add_runtime_dependency 'faraday', '~> 0.9.1'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.10.0'
+  s.add_runtime_dependency 'multi_json', '~> 1.0'
+end

data/lib/lagotto-rb.rb

@@ -0,0 +1,340 @@
+require "multi_json"
+
+require "lagotto-rb/version"
+require "lagotto-rb/request"
+require "lagotto-rb/req"
+require "lagotto-rb/helpers"
+
+# @!macro lagotto_params
+#   @param ids [String] one or more work identifier
+#   @param type [String] One of doi, pmid, pmcid, or mendeley_uuid
+#   @param source [String] One source. To get many sources, make many calls.
+#   @param publisher [String] Filter articles to a given publisher, using a crossref_id.
+#   @param order [String] Results are sorted by descending event count when given the source name, e.g. `&order=wikipedia`. Otherwise (the default) results are sorted by date descending. When using `&source=x`, we can only sort by data or that source, not a different source.
+#   @param per_page [String] Items per page
+#   @param page [String] Page to retrieve
+#   @param instance [String] One of plos, crossref, pkp, elife, copernicus, pensoft
+#   @param key [String] API key
+#   @param verbose [Boolean] Print request headers to stdout. Default: false
+
+# @!macro lagotto_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
+#     :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
+
+##
+# Lagotto - The top level module for using methods
+# to access a Lagotto instance API
+#
+# The following methods, matching the main Crossref API routes, are available:
+# * `Lagotto.works` - Use the /works endpoint
+# * `Lagotto.status` - Get instance status, requires authentication
+# * `Lagotto.requests` - Search requests, requires authentication
+# * `Lagotto.alerts` - Search alerts, requires authentication
+# * `Lagotto.events` - Get events back
+# * `Lagotto.sources` - Search /works routes by source
+module Lagotto
+  ##
+  # Make a `/works` route request
+  #
+  # @!macro lagotto_params
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example
+  #      require 'lagotto-rb'
+  #      Lagotto.works(ids: 'http://doi.org/10.15468/DL.SQNY5P', instance: "crossref")
+  #      Lagotto.works(ids: ['http://doi.org/10.1371/journal.pone.0029797','http://doi.org/10.1016/j.dsr2.2010.10.029'], instance: "crossref")
+  #      Lagotto.works(ids: 'http://doi.org/10.1371/journal.pone.0025110', instance: "plos")
+  #      ids = ["http://doi.org/10.1371/journal.pone.0029797","http://doi.org/10.1371/journal.pone.0029798"]
+  #      Lagotto.works(ids: ids, instance: "plos")
+  #      Lagotto.works(ids: '10.4081/audiores.2013.e1', key: ENV['PKP_API_KEY'], instance: "pkp")
+  #
+  #      # Search by source
+  #      Lagotto.works(source: 'twitter', instance: "crossref")
+  #      Lagotto.works(instance: "crossref", per_page: 5)
+  #
+  #      # get by publisher
+  #      Lagotto.works(publisher: 311)
+  def self.works(ids: nil, type: nil, source: nil, publisher: nil,
+            order: nil, per_page: 50, page: 1, instance: 'plos', key: nil,
+            options: nil, verbose: false)
+
+    test_length(source)
+    type_check(page, Fixnum)
+    type_check(per_page, Fixnum)
+    # test_values('id_type', id_type, ['doi','pmid','pmcid','mendeley_uuid'])
+    # test_values('instance', instance, ['plos','crossref','copernicus','elife','pensoft','pkp'])
+
+    url = pick_url(instance)
+    ids = join_ids(ids)
+    Request.new(url, 'works', ids, type, source,
+      publisher, order, per_page, page, key, options, verbose).perform
+  end
+
+  ##
+  # Make a `/works` route request by source
+  #
+  # @param source [String] One source. To get many sources, make many calls.
+  # @param per_page [String] Items per page
+  # @param page [String] Page to retrieve
+  # @param instance [String] One of plos, crossref, pkp, elife, copernicus, pensoft
+  # @param key [String] API key
+  # @param verbose [Boolean] Print request headers to stdout. Default: false
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example
+  #    # a single source
+  #    Lagotto.works_sources(source: 'twitter', per_page: 2)
+  #    Lagotto.works_sources(source: 'mendeley', per_page: 3)
+  #    Lagotto.works_sources(source: 'facebook', per_page: 1)
+
+  #    # many sources
+  #    sources = ['facebook','twitter','mendeley']
+  #    sources.collect { |x| Lagotto.works_sources(source: x, per_page: 1) }
+  def self.works_sources(source: nil, per_page: 50, page: 1, instance: 'plos', key: nil,
+    options: nil, verbose: false)
+
+    url = pick_url(instance)
+    Request.new(url, 'works', nil, nil, source,
+      nil, nil, per_page, page, key, options, verbose).perform
+  end
+
+  ##
+  # Make a `/events` route request
+  #
+  # @!macro lagotto_params
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example
+  #   # Get events by DOI
+  #   ## swap out the key and instance to change provider
+  #   Lagotto.events(ids: '10.1371/journal.pone.0029797', instance: "crossref")
+  #   Lagotto.events(ids: ['10.1371/journal.pone.0029797','10.1016/j.dsr2.2010.10.029'], instance: "crossref")
+  #   Lagotto.events(ids: '10.4081/audiores.2013.e1', instance: "pkp")
+  #   Lagotto.events(ids: "10.1371/journal.pone.0029797")
+  #   ids = ["10.1371/journal.pone.0029797","10.1371/journal.pone.0029798"]
+  #   Lagotto.events(ids: ids)
+  #
+  #   # Search by source
+  #   Lagotto.events(source: 'twitter', instance: "crossref")
+  #   Lagotto.events(instance: "crossref", per_page: 5)
+  #
+  #   # Get data by publisher
+  #   ids = Faraday.new(:url => "http://api.crossref.org/members").get
+  #   json = MultiJson.load(ids.body)
+  #   ids = json['message']['items'].collect { |p| p['id'] }
+  #   Lagotto.events(publisher: ids[0])
+  def self.events(ids: nil, type: nil, source: nil, publisher: nil,
+    order: nil, per_page: 50, page: 1, instance: 'plos', key: nil,
+    options: nil, verbose: false)
+
+    test_length(source)
+    type_check(page, Fixnum)
+    type_check(per_page, Fixnum)
+    url = pick_url(instance)
+    ids = join_ids(ids)
+    Request.new(url, 'events', ids, type, source,
+      publisher, order, per_page, page, key, options, verbose).perform
+  end
+
+  ##
+  # Make a `/publishers` route request
+  #
+  # @param id [Fixnum] Publisher id
+  # @param page [String] Page to retrieve
+  # @param instance [String] One of plos, crossref, pkp, elife, copernicus, pensoft
+  # @param verbose [Boolean] Print request headers to stdout. Default: false
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example
+  #    Lagotto.publishers()
+  #    Lagotto.publishers(id: 340)
+  #    Lagotto.publishers(instance: 'crossref')
+  def self.publishers(id: nil, page: 1, instance: 'plos', options: nil, verbose: false)
+    url = pick_url(instance) + '/publishers'
+    if !id.nil?
+      url = url + '/' + id.to_s
+    end
+    BasicRequest.new(url, '', nil, options, verbose, {}).perform
+  end
+
+  ##
+  # Make a `/groups` route request
+  #
+  # @param id [Fixnum] Group id
+  # @param page [String] Page to retrieve
+  # @param instance [String] One of plos, crossref, pkp, elife, copernicus, pensoft
+  # @param verbose [Boolean] Print request headers to stdout. Default: false
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example
+  #    Lagotto.groups()
+  #    Lagotto.groups(instance: 'crossref')
+  #    Lagotto.groups(id: 'recommended', instance: 'crossref')
+  def self.groups(id: nil, page: 1, instance: 'plos', options: nil, verbose: false)
+    url = pick_url(instance) + '/groups'
+    if !id.nil?
+      url = url + '/' + id.to_s
+    end
+    BasicRequest.new(url, '', nil, options, verbose, {}).perform
+  end
+
+  ##
+  # Make a `/references` route request
+  #
+  # Returns list of references for a particular work, source and/or relation_type
+  #
+  # @param work_id [String] Work ID
+  # @param work_ids [String] Work IDs
+  # @param q [String] Query for ids
+  # @param relation_type_id [String] Relation_type ID
+  # @param source_id [String] Source ID
+  # @param page [String] Page number
+  # @param per_page [String] Results per page (0-1000), Default: 1000
+  # @param instance [String] One of plos, crossref, pkp, elife, copernicus, pensoft
+  # @param verbose [Boolean] Print request headers to stdout. Default: false
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example
+  #    Lagotto.references(per_page: 5, instance: 'crossref')
+  #    Lagotto.references(work_id: 'http://doi.org/10.6084/M9.FIGSHARE.1598061', instance: 'crossref')
+  def self.references(work_id: nil, work_ids: nil, q: nil, relation_type_id: nil,
+    source_id: nil, page: 1, per_page: 1000,
+    instance: 'plos', options: nil, verbose: false)
+
+    url = pick_url(instance)
+    args = { work_id: work_id, work_ids: work_ids, q: q,
+      relation_type_id: relation_type_id, source_id: source_id,
+      page: page, per_page: per_page }
+    BasicRequest.new(url, 'references', nil, options, verbose, args).perform
+  end
+
+  ##
+  # Make a `/work_types` route request
+  #
+  # @param instance [String] One of plos, crossref, pkp, elife, copernicus, pensoft
+  # @param verbose [Boolean] Print request headers to stdout. Default: false
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example
+  #    Lagotto.work_types()
+  #    Lagotto.work_types(instance: 'crossref')
+  def self.work_types(instance: 'plos', options: nil, verbose: false)
+    url = pick_url(instance)
+    BasicRequest.new(url, 'work_types', nil, options, verbose, {}).perform
+  end
+
+  ##
+  # Make a `/docs` route request
+  #
+  # @param id [Fixnum] Document id
+  # @param instance [String] One of plos, crossref, pkp, elife, copernicus, pensoft
+  # @param verbose [Boolean] Print request headers to stdout. Default: false
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example
+  #    Lagotto.docs()
+  #    Lagotto.docs(instance: 'crossref')
+  #    Lagotto.docs(id: 'counter', instance: 'crossref')
+  def self.docs(id: nil, instance: 'plos', options: nil, verbose: false)
+    url = pick_url(instance) + '/docs'
+    if !id.nil?
+      url = url + '/' + id.to_s
+    end
+    BasicRequest.new(url, '', nil, options, verbose, {}).perform
+  end
+
+  ##
+  # Make a `/relation_types` route request
+  #
+  # @param id [Fixnum] Relation type id
+  # @param instance [String] One of plos, crossref, pkp, elife, copernicus, pensoft
+  # @param verbose [Boolean] Print request headers to stdout. Default: false
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example
+  #    Lagotto.relation_types()
+  #    Lagotto.relation_types(instance: 'crossref')
+  #    Lagotto.relation_types(id: 'corrects', instance: 'crossref')
+  def self.relation_types(id: nil, instance: 'plos', options: nil, verbose: false)
+    url = pick_url(instance) + '/relation_types'
+    if !id.nil?
+      url = url + '/' + id.to_s
+    end
+    BasicRequest.new(url, '', nil, options, verbose, {}).perform
+  end
+
+  ##
+  # Make a `/sources` route request
+  #
+  # @param id [Fixnum] Source id
+  # @param instance [String] One of plos, crossref, pkp, elife, copernicus, pensoft
+  # @param verbose [Boolean] Print request headers to stdout. Default: false
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example
+  #    Lagotto.sources(instance: 'datacite')
+  #    Lagotto.sources(instance: 'crossref')
+  #    Lagotto.sources(id: 'reddit', instance: 'crossref')
+  def self.sources(id: nil, instance: 'plos', options: nil, verbose: false)
+    url = pick_url(instance) + '/sources'
+    if !id.nil?
+      url = url + '/' + id.to_s
+    end
+    BasicRequest.new(url, '', nil, options, verbose, {}).perform
+  end
+
+  ##
+  # Make a `/recommendations` route request
+  #
+  # @param id [Fixnum] A work id
+  # @param instance [String] One of plos, crossref, pkp, elife, copernicus, pensoft
+  # @param verbose [Boolean] Print request headers to stdout. Default: false
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example
+  #    Lagotto.recommendations(id: '10.1371/journal.ppat.1005123')
+  #    Lagotto.recommendations(id: '10.1371/journal.pgen.1005625')
+  def self.recommendations(id:, instance: 'plos', options: nil, verbose: false)
+    url = pick_url(instance) + '/works/' + id.to_s + '/recommendations'
+    BasicRequest.new(url, '', nil, options, verbose, {}).perform
+  end
+
+  ##
+  # Make a `/status` route request
+  #
+  # @param key [String] API key
+  # @param instance [String] One of plos, crossref, pkp, elife, copernicus, pensoft
+  # @param verbose [Boolean] Print request headers to stdout. Default: false
+  # @!macro lagotto_options
+  # @return [Hash] A hash
+  #
+  # @example
+  #      require 'lagotto-rb'
+  #      Lagotto.status(key: ENV['PLOS_API_KEY'])
+  #      Lagotto.status(key: ENV['PLOS_API_KEY'])
+  def self.status(key: nil, instance: 'plos', options: nil, verbose: false)
+    url = pick_url(instance)
+    BasicRequest.new(url, 'status', key, options, verbose, {}).perform
+  end
+
+end