NCore

NCore is a Ruby gem designed to help build REST API clients. It is not an API client by itself, but provides several useful building blocks to build one.

It relies on excon for HTTP handling and activemodel.

See example/ for the beginning of an actual api client. See dnscaster-ruby for a complete client.

Installation

Add this line to your application's Gemfile:

gem 'ncore', '~> 3'

Or this to your gem's gemspec:

spec.add_dependency 'ncore', '~> 3'

Contributing

Contributions are welcomed. If unsure about the scope or reach of a potential PR, feel free to open a discussion Issue first (not required though).

Please submit human-written contributions only. No contributions containing output generated by LLMs or other non-deterministic systems are allowed.

  • Code, tests, docs, PRs: must be 100% human written.
  • Issues, security reports: must originally be 100% human written. If not originally in English, an LLM may be used to translate to English provided that this translation is disclosed.

We recognize that opinions about the use of LLMs and non-deterministic systems vary widely. Still, we respectfully ask that you honor this policy when interacting with this project.

Q: May I use LLMs apart from contributions?

All usage, training or otherwise, must respect copyrights. Beyond that, we've found that LLMs are prone to errors and misunderstandings--sometimes obvious, sometimes subtle. Please verify everything before trusting an LLM's output.

License

MIT