crossrefapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0a8e0c79a1640c0924f60c8c583fc178e86911f3a7545f0dd4bfcd178cad9fe
+  data.tar.gz: e01aa77e9d3260f92d17344a4f9cf0bc5ab7483c6fb37b28f58bbae7416cff55
+SHA512:
+  metadata.gz: fc4d62d8155aca0f974339c68018aceb67b89a1b7f49bacd081c94a4d77b6d7f7bec08b4dad3312b2ee53eb063d6bedffa77005b0d50e1e80212974d6d2cfaf8
+  data.tar.gz: 4ffcef5fff1cf305197f40e228a58d0a2f737e1da4db39eb485c2128b7842d9a94eff533df69ab16c442ca6d0b0c42619b41b289c723ac59bd6e52bf5322bce9

data/lib/crossrefapi/client.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Crossrefapi
+  # Crossrefapi::Client
+  #
+  # This class serves as the main entry point for interacting with the CrossRef API.  It delegates to
+  # the Crossrefapi::Works and Crossrefapi::Prefixes classes to provide access to the various endpoints
+  # available in the CrossRef API.
+  #
+  # For detailed API documentation, visit:
+  # https://api.crossref.org/swagger-ui/index.html#/
+  #
+  # Example usage:
+  #
+  #   client = Crossrefapi::Client.new
+  #   response = client.works.by_doi('10.2305/IUCN.UK.2016-1.RLTS.T56003281A22157381.en')
+  #   pp response
+  #
+  class Client
+    API_BASE = "https://api.crossref.org/"
+
+    attr_reader :funders, :journals, :licenses, :members, :prefixes, :types, :works
+
+    def initialize
+      @connection = initialize_connection
+      @funders = Crossrefapi::Funders.new(self)
+      @journals = Crossrefapi::Journals.new(self)
+      @licenses = Crossrefapi::Licenses.new(self)
+      @members = Crossrefapi::Members.new(self)
+      @prefixes = Crossrefapi::Prefixes.new(self)
+      @types = Crossrefapi::Types.new(self)
+      @works = Crossrefapi::Works.new(self)
+    end
+
+    def get(endpoint, query = {})
+      response = @connection.get(endpoint, query)
+
+      if response.success?
+        response.body
+      else
+        "Error! Status: #{response.status} #{response.body}"
+      end
+    end
+
+    private
+
+    def initialize_connection
+      Faraday.new(url: API_BASE) do |connection|
+        connection.response :json
+      end
+    end
+  end
+end

data/lib/crossrefapi/funders.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Crossrefapi
+  # This class serves as the main entry point for interacting with the CrossRef API funders endpoints.
+  #
+  # For detailed API documentation, visit:
+  # https://api.crossref.org/swagger-ui/index.html#/Funders
+  #
+  # Example usage:
+  #
+  #   client = Crossrefapi::Client.new
+  #   query = { "query": "red+list" }
+  #   response = client.funders.all(query)
+  #   pp response
+  #
+  class Funders
+    def initialize(client)
+      @client = client
+    end
+
+    def all(query)
+      @client.get("funders", query)
+    end
+
+    def by_id(id)
+      @client.get("funders/#{id}")
+    end
+
+    def by_id_works(id, query = {})
+      @client.get("funders/#{id}/works", query)
+    end
+  end
+end

data/lib/crossrefapi/journals.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Crossrefapi
+  # This class serves as the main entry point for interacting with the CrossRef API journals endpoints.
+  #
+  # For detailed API documentation, visit:
+  # https://api.crossref.org/swagger-ui/index.html#/Journals
+  #
+  # Example usage:
+  #
+  #   client = Crossrefapi::Client.new
+  #   query = { "query": "red+list" }
+  #   response = client.journals.all(query)
+  #   pp response
+  #
+  class Journals
+    def initialize(client)
+      @client = client
+    end
+
+    def all(query)
+      @client.get("journals", query)
+    end
+
+    def by_issn(issn)
+      @client.get("journals/#{issn}")
+    end
+
+    def by_issn_works(issn, query = {})
+      @client.get("journals/#{issn}/works", query)
+    end
+  end
+end

data/lib/crossrefapi/licenses.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Crossrefapi
+  # This class serves as the main entry point for interacting with the CrossRef API licences endpoints.
+  #
+  # For detailed API documentation, visit:
+  # https://api.crossref.org/swagger-ui/index.html#/Licenses
+  #
+  # Example usage:
+  #
+  #   client = Crossrefapi::Client.new
+  #   query = { "query": "red+list" }
+  #   response = client.licenses.all(query)
+  #   pp response
+  #
+  class Licenses
+    def initialize(client)
+      @client = client
+    end
+
+    def all(query)
+      @client.get("licenses", query)
+    end
+  end
+end

data/lib/crossrefapi/members.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Crossrefapi
+  # This class serves as the main entry point for interacting with the CrossRef API members endpoints.
+  #
+  # For detailed API documentation, visit:
+  # https://api.crossref.org/swagger-ui/index.html#/Members
+  #
+  # Example usage:
+  #
+  #   client = Crossrefapi::Client.new
+  #   query = { "query": "red+list" }
+  #   response = client.members.all(query)
+  #   pp response
+  #
+  class Members
+    def initialize(client)
+      @client = client
+    end
+
+    def all(query)
+      @client.get("members", query)
+    end
+
+    def by_id(id)
+      @client.get("members/#{id}")
+    end
+
+    def by_id_works(id, query = {})
+      @client.get("members/#{id}/works", query)
+    end
+  end
+end

data/lib/crossrefapi/prefixes.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Crossrefapi
+  # This class serves as the main entry point for interacting with the CrossRef API prefixes endpoints.
+  #
+  # For detailed API documentation, visit:
+  # https://api.crossref.org/swagger-ui/index.html#/Prefixes/
+  #
+  # Example usage:
+
+  #   client = Crossrefapi::Client.new
+  #   response = client.prefixes.by_prefix('10.2305')
+  #   pp response
+  #
+  #   client = Crossrefapi::Client.new
+  #   query = { 'query.container-title' => 'IUCN Red List of Threatened Species', 'offset' => '9980' }
+  #   response = client.prefixes.by_prefix_works('10.2305', query)
+  #   pp response
+  #
+  class Prefixes
+    def initialize(client)
+      @client = client
+    end
+
+    def by_prefix(prefix)
+      @client.get("prefixes/#{prefix}")
+    end
+
+    def by_prefix_works(prefix, query = {})
+      @client.get("prefixes/#{prefix}/works", query)
+    end
+  end
+end

data/lib/crossrefapi/types.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Crossrefapi
+  # This class serves as the main entry point for interacting with the CrossRef API types endpoints.
+  #
+  # For detailed API documentation, visit:
+  # https://api.crossref.org/swagger-ui/index.html#/Types
+  #
+  # Example usage:
+  #
+  #   client = Crossrefapi::Client.new
+  #   query = { "query": "red+list" }
+  #   response = client.types.all(query)
+  #   pp response
+  #
+  class Types
+    def initialize(client)
+      @client = client
+    end
+
+    def all(query)
+      @client.get("types", query)
+    end
+
+    def by_id(id)
+      @client.get("types/#{id}")
+    end
+
+    def by_id_works(id, query = {})
+      @client.get("types/#{id}/works", query)
+    end
+  end
+end

data/lib/crossrefapi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Crossrefapi
+  VERSION = "0.1.0"
+end

data/lib/crossrefapi/works.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Crossrefapi
+  # This class serves as the main entry point for interacting with the CrossRef API prefixes endpoints.
+  #
+  # For detailed API documentation, visit:
+  # https://api.crossref.org/swagger-ui/index.html#/Works
+  #
+  # Example usage:
+  #
+  #   client = Crossrefapi::Client.new
+  #   response = client.works.by_doi('10.2305/IUCN.UK.2016-1.RLTS.T56003281A22157381.en')
+  #   pp response
+  #
+  class Works
+    def initialize(client)
+      @client = client
+    end
+
+    def all(query)
+      @client.get("works", query)
+    end
+
+    def by_doi(doi)
+      @client.get("works/#{doi}")
+    end
+
+    def by_doi_agency(doi)
+      @client.get("works/#{doi}/agency")
+    end
+  end
+end

data/lib/crossrefapi.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "faraday"
+require "json"
+
+require_relative "crossrefapi/client"
+require_relative "crossrefapi/funders"
+require_relative "crossrefapi/journals"
+require_relative "crossrefapi/licenses"
+require_relative "crossrefapi/members"
+require_relative "crossrefapi/prefixes"
+require_relative "crossrefapi/types"
+require_relative "crossrefapi/version"
+require_relative "crossrefapi/works"
+
+module Crossrefapi
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: crossrefapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Tarr
+- Miguel Torres
+- Ian Townsend
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides a simple interface to interact with the CrossRef API.
+  It allows users to search for works, retrieve metadata by DOI, and access citation
+  information, helping to integrate scholarly data into Ruby applications.
+email:
+- conservation.informatics@iucn.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/crossrefapi.rb
+- lib/crossrefapi/client.rb
+- lib/crossrefapi/funders.rb
+- lib/crossrefapi/journals.rb
+- lib/crossrefapi/licenses.rb
+- lib/crossrefapi/members.rb
+- lib/crossrefapi/prefixes.rb
+- lib/crossrefapi/types.rb
+- lib/crossrefapi/version.rb
+- lib/crossrefapi/works.rb
+homepage: https://github.com/IUCN-UK/crossrefapi
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/IUCN-UK/crossrefapi
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A Ruby Gem that wraps the CrossRef API for fetching metadata and DOI-related
+  information.
+test_files: []