SWGOH::API

Ruby client wrapper for the API at https://api.swgoh.help .

Installation

Gemfile:

gem 'SWGOH-API', '~> 1.0.0'

Install:

gem install SWGOH-API

Usage

# 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
=> #<CLIENT:0x00007fdf90087b28 @language="ENG_US", @enums=false, @structure=false, @access_token=nil>
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.

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.

License

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

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.

jquass / SWGOH-API

readme