lagotto-rb 0.2.0

data/lib/lagotto-rb/helpers.rb

@@ -0,0 +1,103 @@
+def response_ok(code)
+  # See CrossCite documentation http://crosscite.org/cn/
+  case code
+    when 200
+      return true
+    when 204
+      raise "The request was OK but there was no metadata available (response code: #{code})"
+    when 404
+      raise "The DOI requested doesn't exist (response code: #{code})"
+    when 406
+      raise "Can't serve any requested content type (response code: #{code})"
+    when 500...600
+      raise "ZOMG ERROR #{code}"
+    end
+end
+
+def type_check(arg, type=String)
+  raise TypeError unless arg.is_a? type
+end
+
+def test_length(input)
+    if !input.is_a? NilClass and str_length(input) > 1
+      raise TypeError('Parameter "source" must be either nil or length 1')
+    end
+end
+
+def str_length(x)
+  if x.is_a? String
+    1
+  else
+    x.length
+  end
+end
+
+# def test_values(name, input, values)
+#   if input.class == String:
+#     input = input.split(' ')
+#   if type(input) != None:
+#     if len(input) > 1: raise TypeError('Parameter "%s" must be length 1' % name)
+#     if input[0] not in values: raise TypeError('Parameter "%s" must be one of %s' % (name, values))
+# end
+
+def join_ids(x)
+  if x.class != NilClass
+    if x.class != String
+      x.join(',')
+    else
+      x
+    end
+  else
+    x
+  end
+end
+
+def pick_url(x)
+  urls = {
+    "plos" => "http://alm.plos.org/api",
+    "crossref" => "http://det.labs.crossref.org/api",
+    "datacite" => "http://dlm.datacite.org/api",
+    "datacite_profiles" => "https://profiles.labs.datacite.org/api",
+    "elife" => "http://alm.svr.elifesciences.org/api/v5",
+    "pkp" => "http://pkp-alm.lib.sfu.ca/api/v5",
+    "copernicus" => "http://metricus.copernicus.org/api/v5",
+    "pensoft" => "http://alm.pensoft.net:81//api/v5"
+  }
+  url = urls[x]
+  if url == nil
+    raise TypeError('instance must be one of plos, elife, crossref, pkp, copernicus, or pensoft')
+  else
+    return url
+  end
+end
+
+def getuserinfo(x: nil, y: nil)
+  usr = ifnot(x, ENV["PLOS_ALERTS_USER"])
+  pwd = ifnot(y, ENV["PLOS_ALERTS_PWD"])
+  return { "key" => usr, "pwd" => pwd }
+end
+
+def ifnot(x, y)
+  if x == nil
+    return y
+  else
+    return x
+  end
+end
+
+def pick_url_alerts(x)
+  urls = {
+    "plos" => "http://alm.plos.org/api/alerts",
+    "elife" => "http://lagotto.svr.elifesciences.org/api/v4/alerts",
+    "crossref" => "http://det.labs.crossref.org/api/v4/alerts",
+    "pkp" => "http://pkp-alm.lib.sfu.ca/api/v4/alerts",
+    "copernicus" => "http://metricus.copernicus.org/api/v4/alerts",
+    "pensoft" => "http://alm.pensoft.net:81//api/v4/alerts"
+  }
+  url = urls[x]
+  if url == nil
+    raise TypeError('instance must be one of plos, elife, crossref, pkp, copernicus, or pensoft')
+  else
+    return url
+  end
+end

data/lib/lagotto-rb/req.rb

@@ -0,0 +1,49 @@
+require "faraday"
+require "multi_json"
+
+##
+# Lagotto::BasicRequest
+module Lagotto
+  class BasicRequest #:nodoc:
+
+    attr_accessor :url
+    attr_accessor :path
+    attr_accessor :key
+    attr_accessor :options
+    attr_accessor :verbose
+    attr_accessor :addargs
+
+    def initialize(url, path, key, options, verbose, addargs)
+
+      self.url = url
+      self.path = path
+      self.key = key
+      self.options = options
+      self.verbose = verbose
+      self.addargs = addargs
+    end
+
+    def perform
+      args = { api_key: self.key }
+      args = args.merge(addargs)
+      opts = args.delete_if { |k, v| v.nil? }
+
+      if verbose
+        conn = Faraday.new(:url => self.url, :request => options) do |f|
+          f.response :logger
+          f.headers['Accept'] = 'application/json'
+          f.adapter  Faraday.default_adapter
+        end
+      else
+        conn = Faraday.new(:url => self.url, :request => options) do |f|
+          f.headers['Accept'] = 'application/json'
+          f.adapter  Faraday.default_adapter
+        end
+      end
+
+      res = conn.get self.path, opts
+
+      return MultiJson.load(res.body)
+    end
+  end
+end

data/lib/lagotto-rb/request.rb

@@ -0,0 +1,66 @@
+require "faraday"
+require "multi_json"
+
+##
+# Lagotto::Request
+module Lagotto
+  class Request #:nodoc:
+
+    attr_accessor :url
+    attr_accessor :path
+    attr_accessor :ids
+    attr_accessor :type
+    attr_accessor :info
+    attr_accessor :source
+    attr_accessor :publisher
+    attr_accessor :order
+    attr_accessor :per_page
+    attr_accessor :page
+    attr_accessor :key
+    attr_accessor :options
+    attr_accessor :verbose
+
+    def initialize(url, path, ids, type, source,
+      publisher, order, per_page, page, key,
+      options, verbose)
+
+      self.url = url
+      self.path = path
+      self.ids = ids
+      self.type = type
+      self.source = source
+      self.publisher = publisher
+      self.order = order
+      self.per_page = per_page
+      self.page = page
+      self.key = key
+      self.options = options
+      self.verbose = verbose
+    end
+
+    def perform
+      args = { ids: self.ids, type: self.type,
+              source: self.source, publisher: self.publisher,
+              order: self.order, per_page: self.per_page,
+              page: self.page, api_key: self.key }
+      opts = args.delete_if { |k, v| v.nil? }
+
+      if verbose
+        conn = Faraday.new(:url => self.url, :request => options) do |f|
+          f.response :logger
+          f.headers['Accept'] = 'application/json'
+          f.adapter  Faraday.default_adapter
+        end
+      else
+        conn = Faraday.new(:url => self.url, :request => options) do |f|
+          f.headers['Accept'] = 'application/json'
+          f.adapter  Faraday.default_adapter
+        end
+      end
+
+      res = conn.get self.path, opts
+
+      return MultiJson.load(res.body)
+    end
+  end
+end

data/lib/lagotto-rb/version.rb

@@ -0,0 +1,3 @@
+module Lagotto
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: lagotto-rb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Scott Chamberlain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Lagotto client for Ruby - get altmetrics from any Lagotto installation.
+email: myrmecocystus@gmail.com
+executables:
+- lagotto
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/lagotto
+- doc/index.html
+- doc/js/jquery.js
+- examples/alerts.rb
+- examples/alm.rb
+- examples/events.rb
+- examples/requests.rb
+- examples/sources.rb
+- examples/status.rb
+- ignore/alerts.rb
+- ignore/other_methods.rb
+- lagotto-rb.gemspec
+- lib/lagotto-rb.rb
+- lib/lagotto-rb/helpers.rb
+- lib/lagotto-rb/req.rb
+- lib/lagotto-rb/request.rb
+- lib/lagotto-rb/version.rb
+- pkg/lagotto-rb-0.1.1.9000.gem
+homepage: http://github.com/lagotto/lagotto-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Lagotto client for Ruby
+test_files: []
+has_rdoc: