Sha256: 2ef2821b8fbad969501dc826803806f0466f12aebfe9bf948b5a7efd39468ef8
Contents?: true
Size: 1.52 KB
Versions: 16
Compression:
Stored size: 1.52 KB
Contents
# nexus-invision
A client library for the Invision Community API.
## Release to rubygems
You must tag the commit to perform a release.
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add nexus-invision
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install nexus-invision
## Usage
```ruby
require "nexus/invision/client"
client = Nexus::Invision::Client.build(base_url: "https://example.com/api", api_key: "secret")
request = Nexus::Invision::Requests::CreateForumTopic.new(
forum_id: 1,
title: "Hello World",
post: "This is my first post!"
)
begin
topic = client.create_forum_topic(request)
puts topic.id # 1337
rescue Nexus::Invision::Errors::BadRequest => e
# ...
rescue Nexus::Invision::Errors::UnexpectedResponse => e
# ...
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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`, 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).
Run the test suite:
$ bundle exec rspec
## Contributing
Bug reports and pull requests are welcome on GitLab at https://gitlab.nexdev.uk/nexus-mods/public/nexus-invision
Version data entries
16 entries across 16 versions & 1 rubygems