open_access_reporter 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c25d9482db9a4c05de39c6026b679040dd6c1e9a2aa9153752a0808bb2132b72
+  data.tar.gz: 141b2a753f43400b3dbb1c018e45c6fa02b135958d0006dec8fd0c2af15c62a5
+SHA512:
+  metadata.gz: c85f4a1acc439653201f048a60a58127c321555413fc6587223618cb178bc36f0583959561523ce88b4b4a92334bb289e2fd522aafc561e6cf8c08d813194520
+  data.tar.gz: 50aa91f8703abe2aecafcc59e5ac51acb854eb35e638f8d18a9a6388e6524dfd8b71c1c50f4b24da0bdd9d236f5a8bfbe0144281fe8fcc85ad386a1c2d027883

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 0.2.0 - 2019-01-08
+### Added
+- Bump for documentation.
+
+## 0.1.0 - 2019-01-08
+### Added
+- Working product finds salient Open Access data and derives a classification for a research output with a DOI.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in open_access_reporter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Adrian Albin-Clark
+
+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/README.md

@@ -0,0 +1,50 @@
+# Open Access Reporter
+
+Find salient Open Access data and derive a classification for a research output with a DOI.
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/open_access_reporter.svg)](https://badge.fury.io/rb/open_access_reporter)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f05eda4aa8b19c3d232c/maintainability)](https://codeclimate.com/github/lulibrary/open_access_reporter/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open_access_reporter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_access_reporter
+
+## Usage
+
+### Configuration
+```ruby
+reporter = OpenAccessReporter::Reporter.new 'YOUR_EMAIL'  
+```
+
+### Find
+```ruby
+report = reporter.find '10.1234/foo'
+#=> #<OpenAccessReporter::Report:0x00c0ffee>
+
+report.open?
+#=> true
+
+report.classification
+#=> "gold"
+
+report.license
+#=> "cc-by"
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/open_access_reporter.rb

@@ -0,0 +1,5 @@
+require "open_access_reporter/report"
+require "open_access_reporter/reporter"
+
+module OpenAccessReporter
+end

data/lib/open_access_reporter/report.rb

@@ -0,0 +1,24 @@
+module OpenAccessReporter
+  class Report
+
+    # @return [String, nil]
+    attr_accessor :classification
+
+    # @return [String, nil]
+    attr_accessor :license
+
+    # @return [String] ISO 8601 timestamp
+    attr_accessor :modified_at
+
+    attr_writer :open
+
+    # @return [String]
+    attr_accessor :title
+
+    # @return [Boolean]
+    def open?
+      @open === true ? true : false
+    end
+
+  end
+end

data/lib/open_access_reporter/reporter.rb

@@ -0,0 +1,79 @@
+require 'http'
+require 'libdoi'
+require_relative 'report'
+
+module OpenAccessReporter
+  class Reporter
+    # @param email [String] Email for Unpaywall API
+    def initialize(email)
+      raise ArgumentError, 'Unpaywall email not set' unless email && !email.empty?
+      @email = email
+      @http_client = HTTP::Client.new
+    end
+
+    # Find open access data for a research output (makes one Unpaywall API call, see documentation for restrictions)
+    # @param doi [String] DOI e.g. 10.1234/abc, doi:10.1234/abc, https://doi.org/10.1234/abc
+    # @return [OpenAccessReporter::Report, nil]
+    def find(doi)
+      unpaywall_object = fetch(doi)
+      return nil if unpaywall_object[:error] === true
+      report = OpenAccessReporter::Report.new
+      report.classification = classification unpaywall_object
+      report.open = open? unpaywall_object
+      report.license = license unpaywall_object
+      report.modified_at = modified_at unpaywall_object
+      report.title = title unpaywall_object
+      report
+    end
+
+    private
+
+    # @return [Hash<Symbol>] Verbatim Unpaywall API JSON response
+    def fetch(doi)
+      doi = DOI.parse doi
+      encoded_doi = encode_doi doi
+      unpaywall_entry encoded_doi
+    end
+
+    def open?(unpaywall_object)
+      unpaywall_object[:is_oa]
+    end
+
+    def title(unpaywall_object)
+      unpaywall_object[:title]
+    end
+
+    def modified_at(unpaywall_object)
+      unpaywall_object[:updated]
+    end
+
+    def license(unpaywall_object)
+      if unpaywall_object[:is_oa] === true
+        if !unpaywall_object[:best_oa_location].empty?
+          unpaywall_object[:best_oa_location][:license]
+        end
+      end
+    end
+
+    def classification(unpaywall_object)
+      if unpaywall_object[:is_oa] === true
+        if unpaywall_object[:best_oa_location][:host_type] === 'repository'
+          'green'
+        elsif unpaywall_object[:best_oa_location][:host_type] === 'publisher' && unpaywall_object[:best_oa_location][:license].nil?
+          'bronze'
+        elsif unpaywall_object[:best_oa_location][:host_type] === 'publisher' && unpaywall_object[:best_oa_location][:license]
+          'gold'
+        end
+      end
+    end
+
+    def unpaywall_entry(encoded_doi)
+      unpaywall_object = @http_client.get "https://api.unpaywall.org/v2/#{encoded_doi}?email=#{@email}"
+      JSON.parse unpaywall_object, symbolize_names: true
+    end
+
+    def encode_doi(doi)
+      doi.to_uri.to_s.gsub 'https://doi.org/', ''
+    end
+  end
+end

data/lib/open_access_reporter/version.rb

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

data/open_access_reporter.gemspec

@@ -0,0 +1,23 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "open_access_reporter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_access_reporter"
+  spec.version       = OpenAccessReporter::VERSION
+  spec.authors       = ["Adrian Albin-Clark"]
+  spec.email         = ["a.albin-clark@lancaster.ac.uk"]
+  spec.summary       = %q{Find salient Open Access data and derive a classification for a research output with a DOI.}
+  spec.metadata = {
+      'source_code_uri' => 'https://github.com/lulibrary/open_access_reporter'
+  }
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency 'minitest-reporters', '~> 1.1'
+  spec.add_dependency 'http', '~> 2.0'
+  spec.add_dependency 'libdoi', '~> 1.0'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: open_access_reporter
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Adrian Albin-Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: libdoi
+  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: 
+email:
+- a.albin-clark@lancaster.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/open_access_reporter.rb
+- lib/open_access_reporter/report.rb
+- lib/open_access_reporter/reporter.rb
+- lib/open_access_reporter/version.rb
+- open_access_reporter.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/lulibrary/open_access_reporter
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Find salient Open Access data and derive a classification for a research
+  output with a DOI.
+test_files: []