theoj 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 984f9feb0bdcfeaf7d9533aa94c09dde7877ca2381e75e60b0f05d73cb390eb7
-  data.tar.gz: 749c5b08e99824f720c5ed4e820d45b7d2b772c345f820d4332393376b215512
+  metadata.gz: 23579418555d490f75911e9894fd4c8bb8abaf3225fc6ee93eacd4d60de621fb
+  data.tar.gz: 8a05d5d50b4a6e22d5ea9dc420c11e4529f71c217727249178226fae5e14d4c1
 SHA512:
-  metadata.gz: 5fa3741bb127abcfb1c590c197fa8ea9631b510624b25b615ccfc60131cdf7ce68af2d400ab16f339cc6705a5aae1129403ac0c1d24e41e04209704bdfbcb076
-  data.tar.gz: 246621ddee2c0495eccad79723727205b724ec36b4b401b24ae60f22c1e1cb7a8ece320ab2ccefb6a5074e4423a4eabcbf401272d40e137b0eb831bf0dafd662
+  metadata.gz: faa8c6b8ada15280342a218da6485f762ed9535e3f4f9527d8378a66e852635254cbc7bae220827fa08162d1253992ccf0b25c9e8096345e37c502c7a4268bd8
+  data.tar.gz: 4ac1b3347391848f66ea6b1e3f0a648313c62ee1873d2d8d0e1d610732c860a2d656353f44ba8ce07b96ad0da08f13d3ded3f5dacee5e50a7d46a6abe6496b69

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.0 (2021-10-29)
+
+- Added Theoj::PublishedPaper object with metadata from Journal's API
+- Added custom Error class
+
 ## 1.0.0 (2021-10-20)
 
 - Added method to Journal to create paper_id from issue_id

data/lib/theoj/author.rb

@@ -62,7 +62,7 @@ module Theoj
       if validator.valid?
         return author_orcid.strip
       else
-        raise "Problem with ORCID (#{author_orcid}) for #{self.name}. #{validator.error}"
+        raise Theoj::Error, "Problem with ORCID (#{author_orcid}) for #{self.name}. #{validator.error}"
       end
     end
 
@@ -82,7 +82,7 @@ module Theoj
       # Raise if we can't parse the string, might be because of this bug :-(
       # https://bugs.ruby-lang.org/issues/12451
       affiliations.each do |a|
-        raise "Problem with affiliations for #{self.name}, perhaps the " +
+        raise Theoj::Error, "Problem with affiliations for #{self.name}, perhaps the " +
               "affiliations index need quoting?" unless affiliations_hash.has_key?(a)
 
         author_affiliations << affiliations_hash[a].strip

data/lib/theoj/paper.rb

@@ -152,7 +152,7 @@ module Theoj
 
       def failure(msg)
         cleanup
-        raise(msg)
+        raise Theoj::Error, msg
       end
   end
 end

data/lib/theoj/published_paper.rb

@@ -0,0 +1,46 @@
+require "faraday"
+require "yaml"
+require "json"
+
+module Theoj
+  class PublishedPaper
+    include Theoj::Git
+
+    attr_accessor :metadata
+
+    def initialize(doi)
+      doi_url = "https://doi.org/#{doi}"
+      doi_response = Faraday.get(doi_url)
+      if doi_response.status == 302
+        paper_url = doi_response.headers[:location]
+      else
+        raise Theoj::Error, "The DOI is invalid, url does not resolve #{doi_url}"
+      end
+
+      paper_data = Faraday.get(paper_url + ".json")
+      if paper_data.status == 200
+        @metadata = JSON.parse(paper_data.body, symbolize_names: true)
+      else
+        raise Theoj::Error, "Could not find the paper data at #{paper_url + ".json"}"
+      end
+    end
+
+    [:title, :state, :submitted_at, :doi, :published_at,
+     :volume, :issue, :year, :page, :authors, :editor,
+     :editor_name, :editor_url, :editor_orcid, :reviewers,
+     :languages, :tags, :software_repository, :paper_review,
+     :pdf_url, :software_archive].each do |method_name|
+      define_method(method_name) { metadata[method_name] }
+      define_method("#{method_name}=") {|value| @metadata[method_name] = value }
+    end
+
+    def yaml_metadata
+      metadata.to_yaml
+    end
+
+    def json_metadata
+      metadata.to_json
+    end
+
+  end
+end

data/lib/theoj/version.rb

@@ -1,3 +1,3 @@
 module Theoj
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/theoj.rb

@@ -2,6 +2,7 @@ require_relative "theoj/version"
 require_relative "theoj/git"
 require_relative "theoj/github"
 require_relative "theoj/orcid"
+require_relative "theoj/published_paper"
 require_relative "theoj/submission"
 require_relative "theoj/journal"
 require_relative "theoj/review_issue"
@@ -9,4 +10,5 @@ require_relative "theoj/paper"
 require_relative "theoj/author"
 
 module Theoj
+  class Error < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: theoj
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Juanjo Bazán
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -126,6 +126,7 @@ files:
 - lib/theoj/journals_data.rb
 - lib/theoj/orcid.rb
 - lib/theoj/paper.rb
+- lib/theoj/published_paper.rb
 - lib/theoj/review_issue.rb
 - lib/theoj/submission.rb
 - lib/theoj/version.rb