Ruby wrapper for the runescape api.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
runescape.gemspec

README.md

Runescape-API

The runescape api is rather clunky to use on its own. As part of another project I'm working on, making this api wrapper saved a lot of headaches.

All this does is json requests to the official runescape api, and parses those responses into easy to use classes / instance variables.

Currently focusing on the Grand Exchange, will expand to the Beastiary and High Scores eventually.

If you would like to collaborate with me on this, feel free to submit a pull request, or contact me on one of my social medias.

twitter: @jeremydwayne
instagram: @jeremydwayne
twitch: @jeremydwayne
youtube: @jeremydwayne

Installation

Please note: This gem is not finished, nor is it uploaded to Ruby Gems. Which means feel free to clone the repo and build the gem yourself for the moment.

Add this line to your application's Gemfile:

gem 'runescape-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install runescape-api

Usage

Directions on how to use this gem will come in the future.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/runescape. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Runescape-API project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.