SDK for the Seam API written in Ruby.
TODO
Add this as a dependency to your project using Bundler with
$ bundle add seam
$ git clone https://github.com/seamapi/ruby-next.git
$ cd ruby-next
$ bundle install
Run the command below
$ bundle exec rake
Open an interactive ruby console with
$ bundle exec rake
Primary development tasks are defined as rake tasks in the Rakefile
and available via rake.
View them with
$ bundle exec rake -T
The source code is hosted on GitHub. Clone the project with
$ git clone [email protected]:seamapi/ruby-next.git
You will need Ruby with Bundler and Node.js with npm.
Be sure that all commands run under the correct Ruby version, e.g., if using rbenv, install the correct version with
$ rbenv install
$ npm install
Install the development dependencies with
$ bundle install
New versions are created with gem release.
New versions are released automatically with semantic-release as long as commits follow the Angular Commit Message Conventions.
Publish a new version by triggering a version workflow_dispatch on GitHub Actions.
The version input will be passed to the --version option of gem bump.
This may be done on the web or using the GitHub CLI with
$ gh workflow run version.yml --raw-field version=<version>
GitHub Actions should already be configured: this section is for reference only.
The following repository secrets must be set on GitHub Actions:
RUBYGEMS_API_KEY: RubyGems.org token for publishing gems.
These must be set manually.
The version, format, generate, and semantic-release GitHub actions require a user with write access to the repository. Set these additional secrets to enable the action:
GH_TOKEN: A personal access token for the user.GIT_USER_NAME: The GitHub user's real name.GIT_USER_EMAIL: The GitHub user's email.GPG_PRIVATE_KEY: The GitHub user's GPG private key.GPG_PASSPHRASE: The GitHub user's GPG passphrase.
Please submit and comment on bug reports and feature requests.
To submit a patch:
- Fork it (https://github.com/seamapi/ruby-next/fork).
- Create your feature branch (
git checkout -b my-new-feature). - Make changes.
- Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin my-new-feature). - Create a new Pull Request.
This Ruby gem is licensed under the MIT license.
This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.