commonmeta-ruby 3.7.2 → 3.7.3

data/docs/index.qmd

@@ -0,0 +1,83 @@
+---
+title: Guide
+---
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5785519.svg)](https://doi.org/10.5281/zenodo.5785519)
+[![Gem Version](https://badge.fury.io/rb/commonmeta-ruby.svg)](https://badge.fury.io/rb/commonmeta-ruby)
+![GitHub](https://img.shields.io/github/license/front-matter/commonmeta-ruby?logo=MIT)
+
+commonmeta-ruby is a Ruby gem and command-line utility for the conversion of scholarly metadata, including [schema.org](https://schema.org). Based on the [bolognese](https://github.com/datacite/bolognese) gem, but using [commonmeta](https://commonmeta.org) as the intermediate format, and supporting additional metadata formats. A Python version is available at [commonmeta-py](https://github.com/front-matter/commonmeta-py).
+
+## Installation
+
+Requires Ruby 3.0 or later (Ruby 2.x [has reached its end of life](https://endoflife.date/ruby) March 2023). Then add the following to your `Gemfile` to install the
+latest version:
+
+```
+gem 'commonmeta-ruby'
+```
+
+Then run `bundle install` to install into your environment.
+
+You can also install the gem system-wide in the usual way:
+
+```
+gem install commonmeta-ruby
+```
+
+## Commands
+
+Run the `commonmeta` command with either an identifier (DOI or URL) or filename:
+
+```
+commonmeta https://doi.org/10.7554/elife.01567
+```
+
+```
+commonmeta example.xml
+```
+
+commonmeta can read BibTeX files (file extension `.bib`), RIS files (file extension `.ris`), Crossref files (file extension `.xml`), DataCite files and CSL-JSON files.
+
+The input format (e.g. Crossref or BibteX) is automatically detected, but
+you can also provide the format with the `--from` or `-f` flag. The supported
+input formats are listed in the table above.
+
+The output format is determined by the `--to` or `-t` flag, and defaults to `schema_org`.
+
+Show all commands with `commonmeta help`:
+
+```
+Commands:
+  commonmeta                 # convert metadata
+  commonmeta --version, -v   # print the version
+  commonmeta help [COMMAND]  # Describe available commands or one specific command
+```
+
+## Errors
+
+Errors are returned to STDOUT.
+
+All input is validated against the commonmeta JSON schema.
+
+## Supported Metadata Formats
+
+commonmeta-ruby reads and/or writes these metadata formats:
+
+| Format | Name | Content Type | Read | Write |
+| ------ | ---- | ------------ | ---- | ----- |
+| [Commonmeta](https://commonmeta.org) | commonmeta | application/vnd.commonmeta+json | yes | yes |
+| [CrossRef Unixref XML](https://www.crossref.org/schema/documentation/unixref1.1/unixref1.1.html) | crossref | application/vnd.crossref.unixref+xml | yes | yes |
+| [Crossref](https://api.crossref.org) | crossref | application/vnd.crossref+json | yes | no |
+| [DataCite](https://api.datacite.org/) | datacite | application/vnd.datacite.datacite+json | yes | yes |
+| [Schema.org (in JSON-LD)](http://schema.org/) | schema_org | application/vnd.schemaorg.ld+json | yes | yes |
+| [RDF XML](http://www.w3.org/TR/rdf-syntax-grammar/) | rdf_xml | application/rdf+xml | no | yes |
+| [RDF Turtle](http://www.w3.org/TeamSubmission/turtle/) | turtle | text/turtle | no | yes |
+| [CSL-JSON](https://citationstyles.org/) | csl | application/vnd.citationstyles.csl+json | yes | yes |
+| [Formatted text citation](https://citationstyles.org/) | citation | text/x-bibliography | no | yes |
+| [Codemeta](https://codemeta.github.io/) | codemeta | application/vnd.codemeta.ld+json | yes | yes |
+| [Citation File Format (CFF)](https://citation-file-format.github.io/) | cff | application/vnd.cff+yaml | yes | yes |
+| [JATS](https://jats.nlm.nih.gov/) | jats | application/vnd.jats+xml | no | yes |
+| [CSV](https://en.wikipedia.org/wiki/Comma-separated_values) | csv | text/csv | no | yes |
+| [BibTex](http://en.wikipedia.org/wiki/BibTeX) | bibtex | application/x-bibtex | yes | yes |
+| [RIS](http://en.wikipedia.org/wiki/RIS_(file_format)) | ris | application/x-research-info-systems | yes | yes |

data/docs/readers/bibtex_reader.ipynb

@@ -0,0 +1,37 @@
+{
+ "cells": [
+  {
+   "cell_type": "raw",
+   "metadata": {},
+   "source": [
+    "---\n",
+    "title: BibTex Reader\n",
+    "description: |\n",
+    "  This notebook shows how to read metadata in BibTex format.\n",
+    "---"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Fetch the metadata"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Ruby 3.2.2",
+   "language": "ruby",
+   "name": "ruby"
+  },
+  "language_info": {
+   "file_extension": ".rb",
+   "mimetype": "application/x-ruby",
+   "name": "ruby",
+   "version": "3.2.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

data/docs/theme.scss

@@ -0,0 +1,7 @@
+/*-- scss:defaults --*/
+$toc-color: #38a169;
+$header-margin-bottom: 0;
+$link-color: #38a169;
+$link-hover-color: #276749;
+$link-decoration: none;
+$navbar-bg: #e5e7eb;

data/docs/utils/doi_utils.ipynb

@@ -0,0 +1,28 @@
+{
+ "cells": [
+  {
+   "cell_type": "raw",
+   "metadata": {},
+   "source": [
+    "---\n",
+    "title: doi_utils\n",
+    "---"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Ruby 3.2.2",
+   "language": "ruby",
+   "name": "ruby"
+  },
+  "language_info": {
+   "file_extension": ".rb",
+   "mimetype": "application/x-ruby",
+   "name": "ruby",
+   "version": "3.2.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

data/docs/writers/bibtex_writer.ipynb

@@ -0,0 +1,39 @@
+{
+ "cells": [
+  {
+   "cell_type": "raw",
+   "metadata": {},
+   "source": [
+    "---\n",
+    "title: BibTex Writer\n",
+    "description: |\n",
+    "  This notebook shows how to generate BibTex metadata from a scholarly resource in commonmeta format generated by commonmeta-ruby.\n",
+    "---"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Fetch the metadata\n",
+    "\n",
+    "As with all commonmeta-ruby notebooks, we start by fetching metadata, in this example a journal article via its Crossref DOI, and then convert it to the commonmeta format."
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Ruby 3.2.2",
+   "language": "ruby",
+   "name": "ruby"
+  },
+  "language_info": {
+   "file_extension": ".rb",
+   "mimetype": "application/x-ruby",
+   "name": "ruby",
+   "version": "3.2.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

data/lib/commonmeta/cli.rb

@@ -71,8 +71,8 @@ module Commonmeta
 
     desc "", "encode_by_blog"
 
-    def encode_by_blog(blog_id)
-      prefix = get_doi_prefix_by_blog_id(blog_id)
+    def encode_by_blog(blog_slug)
+      prefix = get_doi_prefix_by_blog_slug(blog_slug)
       return nil unless prefix.present?
       puts encode_doi(prefix)
     end
@@ -115,10 +115,10 @@ module Commonmeta
       puts get_json_feed_by_blog(id)
     end
 
-    desc "", "json_feed_blog_id"
+    desc "", "json_feed_blog_slug"
 
-    def json_feed_blog_id(id)
-      puts get_json_feed_blog_id(id)
+    def json_feed_blog_slug(slug)
+      puts get_json_feed_blog_slug(slug)
     end
 
     desc "", "update_ghost_post"

data/lib/commonmeta/readers/json_feed_reader.rb

@@ -212,8 +212,8 @@ module Commonmeta
         blog["items"].map { |item| item["id"] }.first
       end
 
-      def get_json_feed_blog_id(id)
-        # get JSON Feed item by id and return blog id
+      def get_json_feed_blog_slug(id)
+        # get JSON Feed item by id and return blog slug
 
         url = json_feed_item_by_id_url(id)
         response = HTTP.get(url)
@@ -223,10 +223,10 @@ module Commonmeta
         post.to_h.dig("blog", "slug")
       end
 
-      def get_doi_prefix_by_blog_id(blog_id)
+      def get_doi_prefix_by_blog_slug(blog_slug)
         # for generating a random DOI.
 
-        url = json_feed_by_blog_url(blog_id)
+        url = json_feed_by_blog_url(blog_slug)
         response = HTTP.get(url)
         return nil unless response.status.success?
 

data/lib/commonmeta/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Commonmeta
-  VERSION = '3.7.2'
+  VERSION = '3.7.3'
 end

data/spec/cli_spec.rb

@@ -379,9 +379,9 @@ describe Commonmeta::CLI do
       expect { subject.json_feed_by_blog input }.to output(/3749f8c4-1ba7-4e51-9dd6-9d9551ad451a/).to_stdout
     end
 
-    it "json_feed_blog_id" do
+    it "json_feed_blog_slug" do
       input = "01a92f9a-f8e0-442b-86e2-11530d9d5635"
-      expect { subject.json_feed_blog_id input }.to output(/eve/).to_stdout
+      expect { subject.json_feed_blog_slug input }.to output(/eve/).to_stdout
     end
   end
 end

data/spec/fixtures/vcr_cassettes/Commonmeta_CLI/json_feed/json_feed_blog_slug.yml

@@ -0,0 +1,71 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.rogue-scholar.org/posts/01a92f9a-f8e0-442b-86e2-11530d9d5635
+    body:
+      encoding: ASCII-8BIT
+      string: ''
+    headers:
+      Connection:
+      - close
+      Host:
+      - api.rogue-scholar.org
+      User-Agent:
+      - http.rb/5.1.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '3313'
+      Ratelimit-Limit:
+      - '15'
+      Ratelimit-Remaining:
+      - '14'
+      Ratelimit-Reset:
+      - '3'
+      Date:
+      - Mon, 25 Dec 2023 10:38:50 GMT
+      Server:
+      - Fly/9e37a80f (2023-12-22)
+      Via:
+      - 1.1 fly.io
+      Fly-Request-Id:
+      - 01HJG8WMFGNRM35PXT9HSQJYJH-fra
+    body:
+      encoding: UTF-8
+      string: '{"archive_url":"https://wayback.archive-it.org/22123/20231101171300/https://eve.gd/2017/05/07/an-important-note-if-you-have-a-lenovo-g580","authors":[{"name":"Martin
+        Paul Eve","url":"https://orcid.org/0000-0002-5589-8511"}],"blog":{"api":false,"archive_prefix":"https://wayback.archive-it.org/22123/20231101171300/","authors":[{"name":"Martin
+        Paul Eve","url":null}],"backlog":0,"canonical_url":null,"category":"languagesAndLiterature","created_at":1690329600,"current_feed_url":"https://eve.gd/feed/feed.atom","description":null,"favicon":"https://eve.gd/favicon.png","feed_format":"application/atom+xml","feed_url":"https://eve.gd/feed_all.xml","filter":null,"funding":null,"generator":"Jekyll","generator_raw":"Jekyll","home_page_url":"https://eve.gd","id":"z4b9d78","indexed":false,"issn":null,"language":"en","license":"https://creativecommons.org/licenses/by/4.0/legalcode","plan":"Team","prefix":"10.59348","relative_url":"blog","secure":true,"slug":"eve","status":"active","title":"Martin
+        Paul Eve","updated_at":1702425600,"use_api":null,"use_mastodon":false,"user_id":"eb3f6a26-3e38-42ad-b752-250eb2c0bf89","version":"https://jsonfeed.org/version/1.1"},"blog_name":"Martin
+        Paul Eve","blog_slug":"eve","content_text":"The Lenovo G580 comes with Windows
+        8. It is possible to permanently lock\nyourself out of the operating system
+        if you begin with a Microsoft\naccount and migrate this to a local account.
+        Further, you won''t be able\nto rescue the system since *it is impossible
+        to enter the BIOS setup in\nthe machine''s default state if you cannot login
+        to Windows*.\n\nTo fix this:\n\n1.  Disable \"fast boot\" mode in Windows
+        8. You can do this in \"Power\n    Settings\". If you don''t do this, you
+        can''t modify the Windows disk\n    partition when booting from a recovery
+        USB.\n2.  [Update your\n    BIOS](https://download.lenovo.com/consumer/mobiles/62cn97ww_64.exe).\n    Do
+        it now or you won''t be able to unless you can still login to\n    Windows
+        8.\n3.  Go into the BIOS (shutdown the machine then press the small button\n    next
+        to the power button and select \"BIOS setup\"). Then, set an\n    administrator
+        password in the BIOS settings. Then, \"disable secure\n    boot\". This will
+        allow you to boot from a recovery USB stick such as\n    Kali or Ubuntu.\n\nUrgh.
+        A Catch-22 where Microsoft Windows corrupted a login (thanks,\nMicrosoft)
+        and a hardware defect stops you booting into a recovery\nmedium (thanks, Lenovo).\n\n[An
+        important note if you have a Lenovo\nG580](https://eve.gd/2017/05/07/an-important-note-if-you-have-a-lenovo-g580/)\nwas
+        originally published by Martin Paul Eve at [Martin Paul\nEve](https://eve.gd)
+        on May 07, 2017.\n","doi":"https://doi.org/10.59348/dmq66-f5d26","guid":"https://eve.gd/2017/05/07/an-important-note-if-you-have-a-lenovo-g580","id":"01a92f9a-f8e0-442b-86e2-11530d9d5635","image":null,"indexed_at":1696162656,"language":"en","published_at":1494172558,"reference":[],"relationships":[],"summary":"The
+        Lenovo G580 comes with Windows 8. It is possible to permanently lock yourself
+        out of the operating system if you begin with a Microsoft account and migrate
+        this to a local account.\n","tags":[],"title":"An important note if you have
+        a Lenovo G580","updated_at":1494115200,"url":"https://eve.gd/2017/05/07/an-important-note-if-you-have-a-lenovo-g580"}
+
+        '
+  recorded_at: Mon, 25 Dec 2023 10:38:50 GMT
+recorded_with: VCR 6.2.0

data/spec/readers/json_feed_reader_spec.rb

@@ -528,7 +528,7 @@ describe Commonmeta::Metadata, vcr: true do
 
   context "get doi_prefix for blog", vcr: true do
     it "by blog_id" do
-      response = subject.get_doi_prefix_by_blog_id("iphylo")
+      response = subject.get_doi_prefix_by_blog_slug("iphylo")
       expect(response).to eq("10.59350")
     end
 
@@ -545,7 +545,7 @@ describe Commonmeta::Metadata, vcr: true do
 
   context "get blog_id for json_feed item id", vcr: true do
     it "by blog post id" do
-      response = subject.get_json_feed_blog_id("1898d2d7-4d87-4487-96c4-3073cf99e9a5")
+      response = subject.get_json_feed_blog_slug("1898d2d7-4d87-4487-96c4-3073cf99e9a5")
       expect(response).to eq("sfmatheson")
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commonmeta-ruby
 version: !ruby/object:Gem::Version
-  version: 3.7.2
+  version: 3.7.3
 platform: ruby
 authors:
 - Martin Fenner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-08 00:00:00.000000000 Z
+date: 2023-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -599,6 +599,7 @@ files:
 - ".github/workflows/build.yml"
 - ".github/workflows/changelog.yml"
 - ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/publish.yml"
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -615,6 +616,41 @@ files:
 - bin/commonmeta
 - commonmeta.gemspec
 - csl-data.json
+- docs/.gitignore
+- docs/_publish.yml
+- docs/_quarto.yml
+- docs/_site/favicon.ico
+- docs/_site/images/icon.png
+- docs/_site/index.html
+- docs/_site/readers/bibtex_reader.html
+- docs/_site/search.json
+- docs/_site/site_libs/bootstrap/bootstrap-dark.min.css
+- docs/_site/site_libs/bootstrap/bootstrap-icons.css
+- docs/_site/site_libs/bootstrap/bootstrap-icons.woff
+- docs/_site/site_libs/bootstrap/bootstrap.min.css
+- docs/_site/site_libs/bootstrap/bootstrap.min.js
+- docs/_site/site_libs/clipboard/clipboard.min.js
+- docs/_site/site_libs/quarto-html/anchor.min.js
+- docs/_site/site_libs/quarto-html/popper.min.js
+- docs/_site/site_libs/quarto-html/quarto-syntax-highlighting-dark.css
+- docs/_site/site_libs/quarto-html/quarto-syntax-highlighting.css
+- docs/_site/site_libs/quarto-html/quarto.js
+- docs/_site/site_libs/quarto-html/tippy.css
+- docs/_site/site_libs/quarto-html/tippy.umd.min.js
+- docs/_site/site_libs/quarto-nav/headroom.min.js
+- docs/_site/site_libs/quarto-nav/quarto-nav.js
+- docs/_site/site_libs/quarto-search/autocomplete.umd.js
+- docs/_site/site_libs/quarto-search/fuse.min.js
+- docs/_site/site_libs/quarto-search/quarto-search.js
+- docs/_site/utils/doi_utils.html
+- docs/_site/writers/bibtex_writer.html
+- docs/favicon.ico
+- docs/images/icon.png
+- docs/index.qmd
+- docs/readers/bibtex_reader.ipynb
+- docs/theme.scss
+- docs/utils/doi_utils.ipynb
+- docs/writers/bibtex_writer.ipynb
 - lib/commonmeta.rb
 - lib/commonmeta/array.rb
 - lib/commonmeta/author_utils.rb
@@ -791,6 +827,7 @@ files:
 - spec/fixtures/vcr_cassettes/Commonmeta_CLI/find_from_format_by_id/medra.yml
 - spec/fixtures/vcr_cassettes/Commonmeta_CLI/find_from_format_by_id/op.yml
 - spec/fixtures/vcr_cassettes/Commonmeta_CLI/json_feed/json_feed_blog_id.yml
+- spec/fixtures/vcr_cassettes/Commonmeta_CLI/json_feed/json_feed_blog_slug.yml
 - spec/fixtures/vcr_cassettes/Commonmeta_CLI/json_feed/json_feed_by_blog.yml
 - spec/fixtures/vcr_cassettes/Commonmeta_CLI/json_feed/json_feed_unregistered.yml
 - spec/fixtures/vcr_cassettes/Commonmeta_CLI/json_feed/json_feed_updated.yml
@@ -1053,7 +1090,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Ruby client library for conversion of scholarly metadata