syconium 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55d5d0115c8a5b83c91d51e09ea051f030cc0c26acc9cbe0b45eaeed492cafae
+  data.tar.gz: 210e6d69febf61996f3c813fed1adf58dbd5e0a438a4c2c2d0db5581c49718a7
+SHA512:
+  metadata.gz: 658058035ed5195bf3850aa56afbd80447455518619ccc5fa8365fbf6fd661d852f28850c230ab12677440391fea6a27d13f36f49393d6cf8bcd3a499e883a41
+  data.tar.gz: 9b6a9eab86b5429ef3805434ab4154e5e50097e3fafccfd93e05d91da8d4b633482c0504b097ea4d8595625dae6c37c0d88aa5d3bd15fa9002248b342989adc3

data/.github/workflows/main.yml

@@ -0,0 +1,19 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.3.4
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake
+      env:
+        USER: ${{ vars.USER }}
+        PASSWORD: ${{ secrets.PASSWORD }}

data/.gitignore

@@ -0,0 +1,10 @@
+.byebug_history
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - 2025-07-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at diapriid@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in syconium.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,10 @@
+The MIT License (MIT)
+
+Copyright © 2025 Species File Group
+
+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,421 @@
+# Syconium
+
+Syconium is a Ruby wrapper on the [OpenAlex](https://openalex.org) API. Code follow the spirit/approach of the Gem [serrano](https://github.com/sckott/serrano), and indeed much of the wrapping utility is copied 1:1 from that repo, thanks [@sckott](https://github.com/sckott).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'syconium'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install syconium
+
+## Usage
+
+To use the OpenAlex API via the Syconium Ruby gem, you must supply either your email address or your api_key. Providing your email helps OpenAlex get in touch with your if there is a problem with your software.
+
+### Pagination
+
+For pagination, you can browse up to 10,000 results with the page and per_page parameters:
+```ruby
+Syconium.works(email: "your_email@example.com", page: 5, per_page:25) #  => Hash
+```
+
+Beyond 10,000 results it is strongly recommended to use the [data snapshot](https://docs.openalex.org/download-all-data/openalex-snapshot) instead of the API, but you can also use a cursor, which you can request with a *:
+```ruby
+Syconium.works(email: "your_email@example.com", per_page:1, cursor="*") #  => Hash
+```
+The metadata will contain the next_cursor to browse the next page:
+```ruby
+Syconium.works(email: "your_email@example.com", per_page:1, cursor="IlsxMDAuMCwgNTM2NCwgJ2h0dHBzOi8vb3BlbmFsZXgub3JnL1czMDEwNDQxNzMyJ10i")
+```
+
+
+### Endpoints
+
+All of the endpoints (authors, funders, keywords, institutions, publishers, sources, topics, works) are wrapped and function similarly.
+
+#### [Authors](https://docs.openalex.org/api-entities/authors)
+
+List authors:
+```ruby
+Syconium.authors() #  => Hash
+```
+
+Search authors:
+```ruby
+Syconium.authors(email: "your_email@example.com", search: "Smith") #  => Hash
+```
+
+For autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:
+```ruby
+Syconium.authors(email: "your_email@example.com", autocomplete: true, q: "Smi") #  => Hash
+Syconium.authors(email: "your_email@example.com", autocomplete: true, q: "Smi", search: "John") #  => Hash
+```
+
+Filter authors by [attributes](https://docs.openalex.org/api-entities/authors/filter-authors):
+```ruby
+Syconium.authors(email: "your_email@example.com", filter: 'has_orcid:true') #  => Hash
+```
+
+Group results by [attributes](https://docs.openalex.org/api-entities/authors/group-authors):
+```ruby
+Syconium.authors(email: "your_email@example.com", group_by: 'has_orcid') #  => Hash
+```
+
+Get an author by ID:
+```ruby
+Syconium.authors(email: "your_email@example.com", id: 'A1234567') #  => Hash
+Syconium.authors(email: "your_email@example.com", id: 'orcid:0000-0000-0000-0000') #  => Hash
+```
+
+Get a random author:
+```ruby
+Syconium.authors(email: "your_email@example.com", random: true) #  => Hash
+```
+
+Get a random sample of 25 authors:
+```ruby
+Syconium.authors(email: "your_email@example.com", sample: 25) #  => Hash
+```
+
+#### [Concepts](https://docs.openalex.org/api-entities/concepts)
+The concepts endpoints should work, but they are depreciated/unmaintained so it is recommended to use Topics instead.
+
+
+#### [Funders](https://docs.openalex.org/api-entities/funders)
+
+List funders:
+```ruby
+Syconium.funders() #  => Hash
+```
+
+Search funders:
+```ruby
+Syconium.funders(email: "your_email@example.com", search: "Smith") #  => Hash
+```
+
+For autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:
+```ruby
+Syconium.funders(email: "your_email@example.com", autocomplete: true, q: "Nationa") #  => Hash
+Syconium.funders(email: "your_email@example.com", autocomplete: true, q: "Nationa", search: "Biodiversity") #  => Hash
+```
+
+Filter funders by [attributes](https://docs.openalex.org/api-entities/funders/filter-funders):
+```ruby
+Syconium.funders(email: "your_email@example.com", filter: 'country_code:ca') #  => Hash
+```
+
+Group results by [attributes](https://docs.openalex.org/api-entities/funders/group-funders):
+```ruby
+Syconium.funders(email: "your_email@example.com", group_by: 'country_code') #  => Hash
+```
+
+Get a funder by ID:
+```ruby
+Syconium.funders(email: "your_email@example.com", id: 'F4320306076') #  => Hash
+Syconium.funders(email: "your_email@example.com", id: 'ror:021nxhr62') #  => Hash
+```
+
+Get a random funders:
+```ruby
+Syconium.funders(email: "your_email@example.com", random: true) #  => Hash
+```
+
+Get a random sample of 25 funders:
+```ruby
+Syconium.funders(email: "your_email@example.com", sample: 25) #  => Hash
+```
+
+
+#### [Institutions](https://docs.openalex.org/api-entities/institutions)
+
+List institutions:
+```ruby
+Syconium.institutions() #  => Hash
+```
+
+Search institutions:
+```ruby
+Syconium.institutions(email: "your_email@example.com", search: "biodiversity") #  => Hash
+```
+
+For autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:
+```ruby
+Syconium.institutions(email: "your_email@example.com", autocomplete: true, q: "biodiv") #  => Hash
+Syconium.institutions(email: "your_email@example.com", autocomplete: true, q: "greenhou", search: "frogs") #  => Hash
+```
+
+Filter institutions by [attributes](https://docs.openalex.org/api-entities/institutions/filter-institutions):
+```ruby
+Syconium.institutions(email: "your_email@example.com", filter: 'is_oa:true') #  => Hash
+```
+
+Group results by [attributes](https://docs.openalex.org/api-entities/institutions/group-institutions):
+```ruby
+Syconium.institutions(email: "your_email@example.com", group_by: 'oa_status') #  => Hash
+```
+
+Get an institution by ID:
+```ruby
+Syconium.institutions(email: "your_email@example.com", id: 'I157725225') #  => Hash
+Syconium.institutions(email: "your_email@example.com", id: 'ror:047426m28') #  => Hash
+```
+
+Get a random institution:
+```ruby
+Syconium.institutions(email: "your_email@example.com", random: true) #  => Hash
+```
+
+Get a random sample of 25 institutions:
+```ruby
+Syconium.institutions(email: "your_email@example.com", sample: 25) #  => Hash
+```
+
+#### [Keywords](https://docs.openalex.org/api-entities/keywords)
+
+List keywords:
+```ruby
+Syconium.keywords() #  => Hash
+```
+
+Search keywords:
+```ruby
+Syconium.keywords(email: "your_email@example.com", search: "biodiversity") #  => Hash
+```
+
+For autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:
+```ruby
+Syconium.keywords(email: "your_email@example.com", autocomplete: true, q: "biodiv") #  => Hash
+Syconium.keywords(email: "your_email@example.com", autocomplete: true, q: "ani", search: "evolution")) #  => Hash
+```
+
+Filter keywords by [attributes](https://docs.openalex.org/api-entities/keywords):
+```ruby
+Syconium.keywords(email: "your_email@example.com", filter: 'works_count:1') #  => Hash
+```
+
+Group results by [attributes](https://docs.openalex.org/api-entities/keywords):
+```ruby
+Syconium.keywords(email: "your_email@example.com", group_by: 'cited_by_count') #  => Hash
+```
+
+Get a keywords by ID:
+```ruby
+Syconium.keywords(email: "your_email@example.com", id: 'biodiversity-conservation') #  => Hash
+```
+
+Get a random sample of 5 keywords:
+```ruby
+Syconium.keywords(email: "your_email@example.com", sample: 25) #  => Hash
+```
+
+
+#### [Publishers](https://docs.openalex.org/api-entities/publishers)
+
+List publishers:
+```ruby
+Syconium.publishers() #  => Hash
+```
+
+Search publishers:
+```ruby
+Syconium.publishers(email: "your_email@example.com", search: "biodiversity") #  => Hash
+```
+
+For autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:
+```ruby
+Syconium.publishers(email: "your_email@example.com", autocomplete: true, q: "biodiv") #  => Hash
+Syconium.publishers(email: "your_email@example.com", autocomplete: true, q: "greenhou", search: "frogs") #  => Hash
+```
+
+Filter publishers by [attributes](https://docs.openalex.org/api-entities/publishers/filter-publishers):
+```ruby
+Syconium.publishers(email: "your_email@example.com", filter: 'hierarchy_level:0') #  => Hash
+```
+
+Group results by [attributes](https://docs.openalex.org/api-entities/publishers/group-publishers):
+```ruby
+Syconium.publishers(email: "your_email@example.com", group_by: 'country_codes') #  => Hash
+```
+
+Get a publishers by ID:
+```ruby
+Syconium.publishers(email: "your_email@example.com", id: 'P4310315930') #  => Hash
+Syconium.publishers(email: "your_email@example.com", id: 'ror:047426m28') #  => Hash
+```
+
+Get a random publishers:
+```ruby
+Syconium.publishers(email: "your_email@example.com", random: true) #  => Hash
+```
+
+Get a random sample of 25 publishers:
+```ruby
+Syconium.publishers(email: "your_email@example.com", sample: 25) #  => Hash
+```
+
+
+#### [Sources](https://docs.openalex.org/api-entities/sources)
+Sources are where works are hosted and include several types: conferences, journals, preprint repositories, institutional repositories, etc.
+
+List sources:
+```ruby
+Syconium.sources() #  => Hash
+```
+
+Search sources:
+```ruby
+Syconium.sources(email: "your_email@example.com", search: "biodiversity") #  => Hash
+```
+
+For autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:
+```ruby
+Syconium.sources(email: "your_email@example.com", autocomplete: true, q: "eco") #  => Hash
+Syconium.sources(email: "your_email@example.com", autocomplete: true, q: "eco", search: "biodiversity") #  => Hash
+```
+
+Filter sources by [attributes](https://docs.openalex.org/api-entities/sources/filter-sources):
+```sources
+Syconium.sources(email: "your_email@example.com", filter: 'is_oa:true') #  => Hash
+```
+
+Group results by [attributes](https://docs.openalex.org/api-entities/sources/group-sources):
+```ruby
+Syconium.sources(email: "your_email@example.com", group_by: 'oa_status') #  => Hash
+```
+
+Get a sources by ID:
+```ruby
+Syconium.sources(email: "your_email@example.com", id: 'S4306402618') #  => Hash
+Syconium.sources(email: "your_email@example.com", id: 'issn:1314-2828') #  => Hash
+```
+
+Get a random source:
+```ruby
+Syconium.sources(email: "your_email@example.com", random: true) #  => Hash
+```
+
+Get a random sample of 25 sources:
+```ruby
+Syconium.sources(email: "your_email@example.com", sample: 25) #  => Hash
+```
+
+
+#### [Topics](https://docs.openalex.org/api-entities/topics)
+
+List topics:
+```ruby
+Syconium.topics() #  => Hash
+```
+
+Search topics:
+```ruby
+Syconium.topics(email: "your_email@example.com", search: "biodiversity") #  => Hash
+```
+
+For autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:
+```ruby
+Syconium.topics(email: "your_email@example.com", autocomplete: true, q: "biodiv") #  => Hash
+Syconium.topics(email: "your_email@example.com", autocomplete: true, q: "greenhou", search: "frogs") #  => Hash
+```
+
+Filter topics by [attributes](https://docs.openalex.org/api-entities/topics/filter-topics):
+```ruby
+Syconium.topics(email: "your_email@example.com", filter: 'subfield.id:1311') #  => Hash
+```
+
+Group results by [attributes](https://docs.openalex.org/api-entities/topics/group-topics):
+```ruby
+Syconium.topics(email: "your_email@example.com", group_by: 'subfield.id') #  => Hash
+```
+
+Get a topics by ID:
+```ruby
+Syconium.topics(email: "your_email@example.com", id: 'T10319') #  => Hash
+```
+
+Get a random topics:
+```ruby
+Syconium.topics(email: "your_email@example.com", random: true) #  => Hash
+```
+
+Get a random sample of 25 works:
+```ruby
+Syconium.topics(email: "your_email@example.com", sample: 25) #  => Hash
+```
+
+
+#### [Works](https://docs.openalex.org/api-entities/works)
+
+List works:
+```ruby
+Syconium.works() #  => Hash
+```
+
+Search works:
+```ruby
+Syconium.works(email: "your_email@example.com", search: "biodiversity") #  => Hash
+```
+
+For autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:
+```ruby
+Syconium.works(email: "your_email@example.com", autocomplete: true, q: "biodiv") #  => Hash
+Syconium.works(email: "your_email@example.com", autocomplete: true, q: "greenhou", search: "frogs") #  => Hash
+```
+
+Filter works by [attributes](https://docs.openalex.org/api-entities/works/filter-works):
+```ruby
+Syconium.works(email: "your_email@example.com", filter: 'is_oa:true') #  => Hash
+```
+
+Group results by [attributes](https://docs.openalex.org/api-entities/works/group-works):
+```ruby
+Syconium.works(email: "your_email@example.com", group_by: 'oa_status') #  => Hash
+```
+
+Get a work by ID:
+```ruby
+Syconium.works(email: "your_email@example.com", id: 'pmid:33982150') #  => Hash
+Syconium.works(email: "your_email@example.com", id: 'doi:10.48550/arXiv.2205.01833') #  => Hash
+Syconium.works(email: "your_email@example.com", id: 'https://doi.org/10.48550/arXiv.2205.01833') #  => Hash
+```
+
+Get a random work:
+```ruby
+Syconium.works(email: "your_email@example.com", random: true) #  => Hash
+```
+
+Get a random sample of 25 works:
+```ruby
+Syconium.works(email: "your_email@example.com", sample: 25) #  => Hash
+```
+
+
+---
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, update the `CHANGELOG.md`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SpeciesFileGroup/syconium. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/SpeciesFileGroup/syconium/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT license](https://github.com/SpeciesFileGroup/syconium/blob/main/LICENSE.txt). You can learn more about the MIT license on [Wikipedia](https://en.wikipedia.org/wiki/MIT_License) and compare it with other open source licenses at the [Open Source Initiative](https://opensource.org/license/mit/).
+
+## Code of Conduct
+
+Everyone interacting in the Syconium project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SpeciesFileGroup/syconium/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc "Run tests"
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "syconium"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/syconium/error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Syconium
+  # Custom error class for rescuing from all Syconium errors
+  class Error < StandardError; end
+
+  # Raised when OpenAlex returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when OpenAlex returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when OpenAlex returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when OpenAlex returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when OpenAlex returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when OpenAlex returns the HTTP status code 504
+  class GatewayTimeout < Error; end
+end

data/lib/syconium/faraday.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "multi_json"
+
+# @private
+module Faraday
+  module SyconiumErrors
+    # @private
+    class Middleware < Faraday::Middleware
+      def call(env)
+        @app.call(env).on_complete do |response|
+          case response[:status].to_i
+          when 400
+            raise Syconium::BadRequest, error_message_400(response)
+          when 404
+            raise Syconium::NotFound, error_message_400(response)
+          when 500
+            raise Syconium::InternalServerError, error_message_500(response, "Something is technically wrong.")
+          when 502
+            raise Syconium::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
+          when 503
+            raise Syconium::ServiceUnavailable, error_message_500(response, "Crossref is rate limiting your requests.")
+          when 504
+            raise Syconium::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
+          end
+        end
+      end
+
+      def initialize(app)
+        super app
+        @parser = nil
+      end
+
+      private
+
+      def error_message_400(response)
+        "\n   #{response[:method].to_s.upcase} #{response[:url]}\n   Status #{response[:status]}#{error_body(response[:body])}"
+      end
+
+      def error_body(body)
+        if !body.nil? && !body.empty? && body.is_a?(String)
+          if json?(body)
+            body = ::MultiJson.load(body)
+            if body["message"].nil?
+              body = nil
+            else
+              body = body["message"]
+            end
+          end
+        end
+
+        if body.nil?
+          nil
+        else
+          ": #{body}"
+        end
+      end
+
+      def error_message_500(response, body = nil)
+        "#{response[:method].to_s.upcase} #{response[:url]}: #{[response[:status].to_s + ":", body].compact.join(" ")}"
+      end
+
+      def json?(string)
+        MultiJson.load(string)
+        true
+      rescue MultiJson::ParseError
+        false
+      end
+    end
+  end
+end
+

data/lib/syconium/helpers/configuration.rb

@@ -0,0 +1,26 @@
+# taken from https://raw.githubusercontent.com/sckott/serrano/main/lib/serrano/helpers/configuration.rb
+# taken from: https://viget.com/extend/easy-gem-configuration-variables-with-defaults
+module Configuration
+  def configuration
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+
+  private
+
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+end
+

data/lib/syconium/request.rb

@@ -0,0 +1,57 @@
+require_relative "faraday" # !! Potential ruby 3.0 difference in module loading? relative differs from Serrano
+require "faraday/follow_redirects"
+require_relative "utils"
+
+module Syconium
+
+  class Request
+    attr_accessor :endpoint
+    attr_accessor :q
+    attr_accessor :verbose
+
+    attr_accessor :options
+
+    def initialize(**args)
+      @endpoint = args[:endpoint]
+      @email = args[:email]
+      @verbose = args[:verbose]
+      @params = args[:params]
+      @options = args[:options] # TODO: not added at syconium.rb
+    end
+
+    def perform
+
+      opts = @params&.compact || {}
+
+      Faraday::Utils.default_space_encoding = "+"
+
+      conn = if verbose
+               Faraday.new(url: Syconium.base_url) do |f|
+                 f.response :logger
+                 f.use Faraday::SyconiumErrors::Middleware
+                 f.adapter Faraday.default_adapter
+               end
+             else
+               Faraday.new(url: Syconium.base_url) do |f|
+                 f.use Faraday::SyconiumErrors::Middleware
+                 f.adapter Faraday.default_adapter
+               end
+             end
+
+      conn.headers['Accept'] = 'application/json,*/*'
+      conn.headers[:user_agent] = make_user_agent
+      conn.headers["X-USER-AGENT"] = make_user_agent
+      conn.headers['Content-Type'] = 'application/json'
+
+      res = conn.get(endpoint, opts)
+
+      # The endpoints should all return JSON, but if they don't, we should still return the body
+      begin
+        MultiJson.load(res.body)
+      rescue MultiJson::ParseError
+        res.body
+      end
+      
+    end
+  end
+end

data/lib/syconium/utils.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# From https://raw.githubusercontent.com/sckott/serrano/main/lib/serrano/utils.rb
+
+def make_user_agent
+  requa = "Faraday/v" + Faraday::VERSION
+  habua = "Syconium/v" + Syconium::VERSION
+  ua = requa + " " + habua
+  if Syconium.mailto
+    ua += " (mailto:%s)" % Syconium.mailto
+  end
+  # ua += format(' (mailto:%s)', Syconium.mailto) if Syconium.mailto
+  ua
+end
+
+def field_query_handler(x)
+  tmp = x.keep_if { |z| z.match(/query_/) }
+  rename_query_filters(tmp)
+end
+
+def rename_query_filters(foo)
+  foo = foo.tostrings
+  foo = foo.map { |x, y| [x.to_s.sub("container_title", "container-title"), y] }.to_h
+  foo.map { |x, y| [x.to_s.sub("query_", "query."), y] }.to_h
+end
+
+class Hash
+  def tostrings
+    map { |(k, v)| [k.to_s, v] }.to_h
+  end
+end
+
+class Hash
+  def tosymbols
+    map { |(k, v)| [k.to_sym, v] }.to_h
+  end
+end
+

data/lib/syconium/version.rb

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

data/lib/syconium.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+require "erb"
+require_relative "syconium/error"
+require_relative "syconium/version"
+require_relative "syconium/request"
+require "syconium/helpers/configuration"
+
+# The Syconium module provides a Ruby interface to the BHL Names API
+module Syconium
+  extend Configuration
+
+  define_setting :base_url, "https://api.openalex.org/"
+  define_setting :mailto, ENV["SYCONIUM_API_EMAIL"]
+
+  # Gets a resource from OpenAlex
+  # @param autocomplete [Boolean] If true, suggests resources based on the search string
+  # @param id [String] A resource ID (e.g., "W123456789", "doi:10.1234/abcd")
+  # @param filter [String] A string of filters to apply to the request
+  # @param group_by [String] If set will return a count of resources grouped by the specified field
+  # @param q [String] The autocomplete query string (use the search parameter instead for searching resources)
+  # @param random [Boolean] If true, returns a random resource
+  # @param sample [Integer] If set, returns a random sample of resources
+  # @param search [String] A search string to filter resources by (use the q parameter instead for autocomplete)
+  # @param select [String] A string of fields to select in the response
+  # @param sort [String] A string of fields to sort the results by (e.g., publication_year:desc,relevance_score:desc)
+  # @param cursor [String] A cursor for pagination
+  # @param page [Integer] The results list page number to retrieve
+  # @param per_page [Integer] The number of results to return per page
+  # @param verbose [Boolean] Print headers to STDOUT
+  #
+  # @return [Hash] A result hash
+  ENDPOINTS = %w[
+    authors concepts funders institutions keywords publishers sources topics works  
+  ]
+
+  ENDPOINTS.each do |endpoint_name|
+    define_singleton_method(endpoint_name) do |email: nil, api_key: nil, autocomplete: false, q: nil, id: nil, search: nil, filter: nil, group_by: nil, random: false, sample: nil, select: nil, sort: nil, cursor: nil, page: 1, per_page: 25, verbose: false|
+      raise ArgumentError, "You must provide an email or API key to use the OpenAlex API" if email.nil? && api_key.nil? 
+      params = {
+        api_key: api_key,
+        mailto: email,
+        filter: filter,
+        group_by: group_by,
+        q: q,
+        sample: sample,
+        search: search,
+        select: select,
+        sort: sort,
+        cursor: cursor,
+        page: page,
+        per_page: per_page,
+      }.compact
+      endpoint = endpoint_name
+      if random
+        endpoint += "/random"
+        params = {}
+      elsif id
+        endpoint += "/#{id}"
+        params = {}
+      elsif autocomplete
+        params = { q: q, filter: filter, search: search }.compact
+        endpoint = "/autocomplete/#{endpoint_name}"
+      end
+      Request.new(endpoint: endpoint, params: params, verbose: verbose).perform
+    end
+  end
+end

data/syconium.gemspec

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "lib/syconium/version"
+
+Gem::Specification.new do |s|
+  s.name          = "syconium"
+  s.version       = Syconium::VERSION
+  s.authors       = ["Geoff Ower, Matt Yoder"]
+  s.email         = ["gdower@illinois.edu"]
+
+  s.summary       = "OpenAlex Client"
+  s.description   = "Syconium is a low-level wrapper around the OpenAlex API."
+  s.homepage      = "https://github.com/SpeciesFileGroup/syconium"
+  s.license       = "MIT"
+  s.required_ruby_version = ">= 2.5.0"
+
+ # s.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
+
+  s.metadata["homepage_uri"] = s.homepage
+  s.metadata["source_code_uri"] = "https://github.com/SpeciesFileGroup/syconium"
+  s.metadata["changelog_uri"] = "https://github.com/SpeciesFileGroup/syconium/releases/tag/v#{s.version}"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|s|features)/}) }
+  end
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # s.add_dependency "example-gem", "~> 1.0"
+
+  s.add_development_dependency "bundler", "~> 2.1", ">= 2.1.4"
+  # s.add_development_dependency "codecov", "~> 0.5.0"
+  # s.add_development_dependency "json", "~> 2.3", ">= 2.3.1"
+  s.add_development_dependency "rake", "~> 13.0", ">= 13.0.1"
+  # s.add_development_dependency "standard", "~> 1.0"
+  # s.add_development_dependency "simplecov", "~> 0.21.2"
+  s.add_development_dependency "test-unit", "~> 3.3", ">= 3.3.6"
+  s.add_development_dependency "vcr", "~> 6.0"
+  s.add_development_dependency "webmock", "~> 3.18"
+
+  s.add_runtime_dependency "faraday", "~> 2.2"
+  s.add_runtime_dependency "faraday-follow_redirects", ">= 0.1", "< 0.4"
+  s.add_runtime_dependency "multi_json", "~> 1.15"
+
+  # TODO: comment out
+  s.add_development_dependency "byebug"
+
+  #  s.add_runtime_dependency "thor", "~> 1.0", ">= 1.0.1"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: syconium
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Geoff Ower, Matt Yoder
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.6
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+description: Syconium is a low-level wrapper around the OpenAlex API.
+email:
+- gdower@illinois.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/syconium.rb
+- lib/syconium/error.rb
+- lib/syconium/faraday.rb
+- lib/syconium/helpers/configuration.rb
+- lib/syconium/request.rb
+- lib/syconium/utils.rb
+- lib/syconium/version.rb
+- syconium.gemspec
+homepage: https://github.com/SpeciesFileGroup/syconium
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SpeciesFileGroup/syconium
+  source_code_uri: https://github.com/SpeciesFileGroup/syconium
+  changelog_uri: https://github.com/SpeciesFileGroup/syconium/releases/tag/v0.0.1
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: OpenAlex Client
+test_files: []