maremma

Ruby utility library for network calls

https://github.com/datacite/maremma

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 2 DOI reference(s) in README
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (7.2%) to scientific vocabulary

Last synced: 6 months ago · JSON representation ·

Repository

Ruby utility library for network calls

Basic Info

Host: GitHub
Owner: datacite
License: mit
Language: Ruby
Default Branch: master
Homepage:
Size: 617 KB

Statistics

Stars: 7
Watchers: 6
Forks: 6
Open Issues: 3
Releases: 14

Created over 10 years ago · Last pushed about 2 years ago

Metadata Files

Readme Changelog License Citation Codemeta

Maremma: a Ruby library for simplified network calls

Ruby utility library for network requests. Based on Faraday and Excon, provides a wrapper for XML/JSON parsing and error handling. All successful responses are returned as hash with key data, all errors in a JSONAPI-friendly hash with key errors.

Installation

The usual way with Bundler: add the following to your Gemfile to install the current version of the gem:

ruby gem 'maremma'

Then run bundle install to install into your environment.

You can also install the gem system-wide in the usual way:

bash gem install maremma

Usage

ruby Maremma.get 'https://dlm.datacite.org/heartbeat' => { "data" => { "services"=>{ "mysql"=>"OK", "memcached"=>"OK", "redis"=>"OK", "sidekiq"=>"OK", "postfix"=>"failed" }, "version"=>"4.3", "status"=>"failed" }} Maremma.post 'http://example.com', data: { 'foo' => 'baz' }

License

MIT

Owner

Name: DataCite
Login: datacite
Kind: organization
Email: info@datacite.org

Website: https://www.datacite.org
Twitter: DataCite
Repositories: 111
Profile: https://github.com/datacite

Connecting research, identifying knowledge

Citation (CITATION.cff)

---
cff-version: 1.2.0
message: 'If you use Maremma: a Ruby library for simplified network calls in your
  work, please cite it using the following metadata'
doi: https://doi.org/10.5438/qeg0-3gm3
repository-code: https://github.com/datacite/maremma
title: 'Maremma: a Ruby library for simplified network calls'
authors:
- given-names: Martin
  family-names: Fenner
  orcid: https://orcid.org/0000-0003-0077-4738
abstract: Ruby utility library for network requests. Based on Faraday and Excon, provides
  a wrapper for XML/JSON parsing and error handling. All successful responses are
  returned as hash with key data, all errors in a JSONAPI-friendly hash with key errors.
keywords:
- faraday
- excon
- net/http
date-released: '2017-02-24'

CodeMeta (codemeta.json)

{
  "@context": "https://raw.githubusercontent.com/codemeta/codemeta/master/codemeta.jsonld",
  "@type": "SoftwareSourceCode",
  "@id": "https://doi.org/10.5438/QEG0-3GM3",
  "agents": {
    "@id": "http://orcid.org/0000-0003-0077-4738",
    "@type": "person",
    "name": "Martin Fenner",
    "affiliation": "DataCite",
    "mustBeCited": true,
    "isMaintainer": true,
    "isRightsHolder": true
  },
  "identifier": "https://doi.org/10.5438/QEG0-3GM3",
  "codeRepository": "https://github.com/datacite/maremma",
  "controlledTem": "software",
  "dateCreated": "2015-11-28",
  "datePublished": "2017-02-24",
  "dateModified": "2017-02-24",
  "description": "Ruby utility library for network requests. Based on Faraday and Excon, provides a wrapper for XML/JSON parsing and error handling. All successful responses are returned as hash with key data, all errors in a JSONAPI-friendly hash with key errors.",
  "isAutomatedBuild": true,
  "licenseId": "MIT",
  "publisher": "DataCite",
  "tags": [
    "faraday",
    "excon",
    "net/http"
  ],
  "title": "Maremma: a Ruby library for simplified network calls",
  "programmingLanguage": {
    "name": "Ruby",
    "version": "≥ 2.3.3",
    "URL": "https://www.ruby-lang.org"
  },
  "readme": "https://github.com/datacite/maremma/blob/master/README.md"
}

GitHub Events

Total

Last Year

Committers

Last synced: almost 3 years ago

All Time

Total Commits: 180
Total Committers: 9
Avg Commits per committer: 20.0
Development Distribution Score (DDS): 0.383

Top Committers

Name	Email	Commits
Martin Fenner	m**r@d**g	111
jrhoads	j**s@d**g	29
GitHub Action	a**n@g**m	19
Martin Fenner	m**r@d**g	9
dependabot[bot]	4**]@u**m	6
kjgarza	k**a@d**g	3
Martin Fenner	m**n@f**o	1
Katrin Leinweber	9**r@u**m	1
phromo/Martin	p**o@p**e	1

Committer Domains (Top 20 + Academic)

datacite.org: 4 phromo.se: 1 front-matter.io: 1 github.com: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time

Total issues: 7
Total pull requests: 24
Average time to close issues: 3 days
Average time to close pull requests: 22 days
Total issue authors: 4
Total pull request authors: 6
Average comments per issue: 0.43
Average comments per pull request: 0.67
Merged pull requests: 14
Bot issues: 0
Bot pull requests: 12

Past Year

Issues: 0
Pull requests: 2
Average time to close issues: N/A
Average time to close pull requests: 15 days
Issue authors: 0
Pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 1

View more stats

Top Authors

Issue Authors

mfenner (4)
wendelfabianchinsamy (2)
jrhoads (1)
richardhallett (1)
orangewolf (1)

Pull Request Authors

dependabot[bot] (13)
jrhoads (7)
wendelfabianchinsamy (3)
mfenner (2)
katrinleinweber (1)
kjgarza (1)
phromo (1)

Top Labels

Issue Labels

bug (2)

Pull Request Labels

dependencies (13) feature (1)

Packages

Total packages: 1
Total downloads:
- rubygems 260,179 total
Total docker downloads: 17

Total dependent packages: 7
Total dependent repositories: 34
Total versions: 86
Total maintainers: 2

rubygems.org: maremma

Ruby utility library for network requests. Based on Faraday and Excon, provides a wrapper for XML/JSON parsing and error handling. All successful responses are returned as hash with key data, all errors in a JSONAPI-friendly hash with key errors.

Homepage: https://github.com/datacite/maremma
Documentation: http://www.rubydoc.info/gems/maremma/
License: MIT
Latest release: 5.0.0
published about 2 years ago

Versions: 86
Dependent Packages: 7
Dependent Repositories: 34
Downloads: 260,179 Total
Docker Downloads: 17

Rankings

Dependent packages count: 2.2%

Docker downloads count: 3.2%

Dependent repos count: 4.3%

Downloads: 5.3%

Average: 7.6%

Forks count: 12.1%

Stargazers count: 18.3%

Maintainers (2)

datacite mfenner

Last synced: 6 months ago

Dependencies

Gemfile.lock rubygems

activesupport 6.1.4
addressable 2.8.0
ast 2.4.2
builder 3.2.4
concurrent-ruby 1.1.9
crack 0.4.5
diff-lcs 1.4.4
docile 1.4.0
excon 0.71.1
faraday 0.17.4
faraday-encoding 0.0.5
faraday_middleware 0.14.0
hashdiff 1.0.1
i18n 1.8.10
jaro_winkler 1.5.4
maremma 4.9.5
mini_portile2 2.8.0
minitest 5.14.4
multipart-post 2.1.1
nokogiri 1.13.6
oj 3.12.1
oj_mimic_json 1.0.1
parallel 1.20.1
parser 3.0.2.0
public_suffix 4.0.6
racc 1.6.0
rack 2.2.3
rack-test 0.8.3
rainbow 3.0.0
rake 13.0.6
rexml 3.2.5
rspec 3.10.0
rspec-core 3.10.1
rspec-expectations 3.10.1
rspec-mocks 3.10.2
rspec-support 3.10.2
rubocop 0.77.0
rubocop-performance 1.6.1
ruby-progressbar 1.11.0
simplecov 0.21.2
simplecov-html 0.12.3
simplecov_json_formatter 0.1.3
tzinfo 2.0.4
unicode-display_width 1.6.1
vcr 3.0.3
webmock 3.13.0
zeitwerk 2.4.2

maremma.gemspec rubygems

bundler ~> 2.0 development
rack-test ~> 0 development
rake >= 0 development
rspec ~> 3.4 development
rubocop ~> 0.77.0 development
rubocop-performance ~> 1.5, >= 1.5.1 development
simplecov >= 0 development
vcr ~> 3.0, >= 3.0.3 development
webmock ~> 3.0, >= 3.0.1 development
activesupport >= 4.2.5
addressable >= 2.3.6
builder ~> 3.2, >= 3.2.2
excon ~> 0.71.0
faraday ~> 0.17.3
faraday-encoding ~> 0.0.4
faraday_middleware ~> 0.14.0
nokogiri >= 1.11.2, < 1.14.0
oj >= 2.8.3
oj_mimic_json ~> 1.0, >= 1.0.1

.github/workflows/changelog.yml actions

actions/checkout v3 composite
ad-m/github-push-action v0.6.0 composite
charmixer/auto-changelog-action v1.1 composite

.github/workflows/ci.yml actions

actions/checkout v3 composite
ruby/setup-ruby v1 composite

.github/workflows/release.yml actions

actions/checkout v3 composite
ruby/setup-ruby v1 composite

Gemfile rubygems