https://github.com/jquass/swgoh-api
A gem api client wrapper for api.swgoh.help
https://github.com/jquass/swgoh-api
api-client api-wrapper rails rails-api ruby ruby-gem ruby-on-rails ruby-on-rails-api rubygem rubygems rubyonrails
Last synced: about 1 month ago
JSON representation
A gem api client wrapper for api.swgoh.help
- Host: GitHub
- URL: https://github.com/jquass/swgoh-api
- Owner: jquass
- License: mit
- Created: 2020-07-01T14:56:21.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-24T04:36:43.000Z (over 3 years ago)
- Last Synced: 2024-04-24T13:17:36.226Z (about 1 year ago)
- Topics: api-client, api-wrapper, rails, rails-api, ruby, ruby-gem, ruby-on-rails, ruby-on-rails-api, rubygem, rubygems, rubyonrails
- Language: Ruby
- Homepage:
- Size: 75.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SWGOH::API [](https://badge.fury.io/rb/SWGOH-API)
Ruby client wrapper for the API at https://api.swgoh.help .
### Installation
Gemfile:
```ruby
gem 'SWGOH-API', '~> 1.0.0'
```
Install:
```ruby
gem install SWGOH-API
```
## Usage
```ruby
# Require the gem
require 'SWGOH/API/CLIENT/client'
# Create a new client
client = CLIENT.new
# Generate a new access_token
access_token = client.authorize("username", "password")
# Or authenticate with a saved access_token
client.access_token = access_token
# Then start making requests
json = client.get_players([123456789])
```
## Development
After checking out the repo, run `bin/setup` to install dependencies.
To build your changes, run `gem build SWGOH-API.gemspec`
To install the build onto your local machine, run `gem install 'SWGOH-API'`.
### irb
```
$ irb
irb(main):001:0> require 'SWGOH/API/CLIENT/client'
=> true
irb(main):002:0> client = CLIENT.new
=> #
irb(main):003:0> client.authorized?
=> false
irb(main):004:0> client.access_token = 'myexistingtoken'
=> "myexistingtoken"
irb(main):005:0> client.authorized?
=> true
```
### Unit Tests
Run `rake test` to run the unit tests.
### Release
These are the steps to create and tag a new version, push git commits and tags, and push the new gem version to [rubygems.org](https://rubygems.org).
- Update the CHANGELOG and assign version number
- Update the version number in `version.rb`, and the README.md
- Run `gem build SWGOH-API.gemspec` to build the new gem version
- Run the release once to generate all files to commit `bundle exec rake release`
- Create a new version commit with all changes
- Release the new version `bundle exec rake release`
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jquass/SWGOH-API. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jquass/SWGOH-API/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the SWGOH::API project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jquass/SWGOH-API/blob/master/CODE_OF_CONDUCT.md).