Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/binarymuse/battlenet

Easily consume Blizzard's Community Platform API.
https://github.com/binarymuse/battlenet

Last synced: 13 days ago
JSON representation

Easily consume Blizzard's Community Platform API.

Host: GitHub
URL: https://github.com/binarymuse/battlenet
Owner: BinaryMuse
License: mit
Created: 2011-04-14T22:42:38.000Z (over 13 years ago)
Default Branch: master
Last Pushed: 2023-01-03T16:13:58.000Z (almost 2 years ago)
Last Synced: 2024-04-09T01:05:24.300Z (7 months ago)
Language: Ruby
Homepage: http://us.battle.net/wow/en/forum/topic/2369881371#1
Size: 494 KB
Stars: 57
Watchers: 7
Forks: 15
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

                __ )          |    |    |                     |

        __ \    _` |  __|  __|  |   _ \  __ \    _ \  __|

        |   |  (   |  |    |    |   __/  |   |   __/  |

       ____/  \__,_| \__| \__| _| \___| _|  _| \___| \__|

    A Ruby library for the Battle.net Community Platform API

[![Build Status](https://secure.travis-ci.org/BinaryMuse/battlenet.png)](http://travis-ci.org/BinaryMuse/battlenet)

Battlenet is a Ruby library that exposes Blizzard's [Community Platform API](http://us.battle.net/wow/en/forum/topic/2369881371).

Installing

==========

Battlenet is available as a Ruby gem. Install it via

    [sudo] gem install battlenet

Use

===

Simply create an instance of `Battlenet`, passing in an optional region as a symbol (defaulting to US), and then optionally a public and private key (for app authorization).

Default options:

    api = Battlenet.new

Specifying a region:

    api = Battlenet.new :eu

Specifying a public and private key:

    api = Battlenet.new :us, 'public', 'private'

Battlenet is backed by the excellent [HTTParty gem](https://github.com/jnunemaker/httparty), which means you can make get requests very simply.

    api.get '/item/12784'

Battlenet also provides modules for each section of the API, providing easy access to the resources.

    api.item '12784'

    api.character 'Nazjatar', 'Cyaga', :fields => "stats,talents,quests"

Configuring

===========

Failing Silently

----------------

By default, if Battlenet receives a 4xx or 5xx response from the Battle.net API, it will throw a `Battlent::ApiException`. You can turn this behavior off via the `fail_silently` attribute:

    Battlenet.fail_silently = true

The exception will have its `code` attribute set to the HTTP status code returned from the API; if the response included a JSON response with the `reason` field set, the exception will have a `reason` attribute set to this string. You can also access the raw response via the `response` attribute.

Localization

------------

The Battle.net API supports localization via a query string parameter. Battlenet can transparently handle setting this parameter for you on every request. Just set the `locale` attribute:

    Battlenet.locale = "en_GB"

Please note that each region only supports certain locales.

Battle.net API Documentation

============================

The documentation for the Battle.net API can be found at http://blizzard.github.com/api-wow-docs/.

What's Missing

==============

The following features are planned but not yet supported:

  * Caching support via Memcached, Redis, etc.

  * If-Last-Modified header support

Contributing

============

If you would like to contribute to the project, please feel free to do so. Just fork the project, commit your changes (preferably to a new branch), and then send me a pull request via GitHub. Be sure to add tests for your feature or fix.

Please do not change the contents of the `VERSION` file, or if you do, do so in a separate commit so that I can cherry-pick around it.

Setting Up the Development Environment

--------------------------------------

The development environment is managed with Bundler.

To install just the gems you need to hack on Battlenet and run the specs, run

    bundle install --without documentation

To install all development gems, including the ones used to generate documentation, run

    bundle install

To run the specs, run

    bundle exec rake

Writing an Integration Test

---------------------------

High-level integration testing against the Community Platform API is handled via VCR. After the first time running a spec that hits the API, VCR saves the HTTP response in a fixture file and uses this file to run against in the future.

Here's an example (the character integration specs):

    it "fetches character data" do

      VCR.use_cassette('character_mortawa') do

        character = api.character 'nazjatar', 'mortawa'

        character['level'].should == 85

      end

    end

    it "fetches additional character data" do

      VCR.use_cassette('character_mortawa_titles') do

        character = api.character 'nazjatar', 'mortawa', :fields => 'titles'

        character['titles'].find { |t| t['selected'] == true }['name'].should == "Twilight Vanquisher %s"

      end

    end

    it "fetches characters with non-ASCII characters in their name" do

      VCR.use_cassette('character_nonstandard_name') do

        character = api.character 'nazjatar', 'Hikô'

        character['level'].should == 85

      end

    end

You should always wrap tests that hit the actual API in the `VCR.use_cassette` block, and the resulting fixture file should be checked in with your test.

Building the Documentation

--------------------------

If you have the necessary gems installed (defined in the `documentation` group in the Gemfile), you can easily generate the documentation via

    yard

The generated documentation can be found in `doc/`; open `doc/index.html` to view it.

License

=======

Battlenet is released under the MIT license.

    Copyright (c) 2011 Brandon Tilley

    Permission is hereby granted, free of charge, to any person

    obtaining a copy of this software and associated documentation

    files (the "Software"), to deal in the Software without

    restriction, including without limitation the rights to use,

    copy, modify, merge, publish, distribute, sublicense, and/or sell

    copies of the Software, and to permit persons to whom the

    Software is furnished to do so, subject to the following

    conditions:

    The above copyright notice and this permission notice shall be

    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

    OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

    OTHER DEALINGS IN THE SOFTWARE.