Bungie Client

This gem makes possible to use Bungie API (and Destiny API too).
It can be useful, if you decide create your application for Destiny Game.

Installation

Add this line to your application's Gemfile:

gem 'bungie_client'

Or install it yourself as:

$ gem install bungie_client

Usage

This gem contains two main classes: BungieClient::Client, BungieClient::Wrappers::Default and his inherits.

BungieClient::Client

It's main class that makes possible to send any requests to Bungie.

For this You should initialize your client for the next example:

client = BungieClient::Client.new :api_key => 'YOUR_API_KEY'

• The option api_key only necessary for this class and API. For getting API key, please visit the bungie page.
• After it You can send your request to Bungie Endpoint.
• The full information about classes and modules and their methods You can find in yard-comments and rubydoc.

How it initialized:

• If You want to use private API, You must get Authorization token from Bungie Oauth2 and set token option.
• After this operations your client is done for usage.

Sending requests

Now You can send requests, e.g. for finding user information and getting his profile:

client.get "Destiny/SearchDestinyPlayer/2/RuBAN-GT"

Note

• For requests optimization You should use any caching of your requests.

BungieClient::Wrapper

If You don't like long code as for me You should use BungieClient::Wrapper. It's class can call api services with dynamically generated methods with snake case like name services. Also it can change url parameters to needed values.

The initialization of Wrapper is similar to Client: all arguments of initializer will be passed to Client which is class variable of wrapper.

wrapper = BungieClient::Wrapper.new :api_key => 'YOUR_API_KEY'

Now You can sending your requests with beautiful and effective code:

wrapper.search_destiny_player :membershipType => '2', :displayName => 'RuBAN-GT'

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/RuBAN-GT/bungie_client. 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.

Fireteam

If You want to fight with Oryx with me or create any interesting applications for Destiny, You can add me (https://www.bungie.net/en/Profile/254/12488384).