https://github.com/kmontag42/albion-api

A Ruby API Library for Albion Online
https://github.com/kmontag42/albion-api

albion albion-online albiononline api-wrapper ruby

Last synced: about 2 months ago
JSON representation

A Ruby API Library for Albion Online

• Host: GitHub
• URL: https://github.com/kmontag42/albion-api
• Owner: KMontag42
• License: mit
• Created: 2017-10-02T14:38:13.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-05T18:07:13.000Z (about 7 years ago)
• Last Synced: 2024-03-15T03:34:41.011Z (10 months ago)
• Topics: albion, albion-online, albiononline, api-wrapper, ruby
• Language: Ruby
• Size: 30.3 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# albion-api

[![Build Status](https://travis-ci.org/KMontag42/albion-api.svg?branch=master)](https://travis-ci.org/KMontag42/albion-api)

[![Built with Spacemacs](https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg)](http://spacemacs.org)

A Ruby API Library for Albion Online

# Disclaimer

I am actively updating this gem all the time, I recommend locking your version for now unless you want the new API calls.

# Install

```ruby

# Gemfile

gem 'albion-api', '~> 0.0'

```

or, you can of course install it via your shell.

```shell

$ gem install albion-api -v '~> 0.0'

```

# Supported API calls

* UserKillboard

* UserSearch

* GuildSearch

* GuildMembers

# Not Supported API calls

A bunch still haha, I haven't scraped all of them quite yet so an exhaustive list isn't here _yet_.

# Terms

**API IDs**: The Albion API operates off of internally generated API IDs for every objects in their database. This term refers to said ID for a given object.

# Usage

The simple way to use the library is as such:

```ruby

require 'albion-api'

client = AlbionApi::UserSearch.new('USER_NAME')

response = client.find

```

> More in depth details about each call to come.

# Contributing

Create a fork, and send me a PR! I am always happy to accept contributions.

Travis will be setup soon to run tests, so make sure you add them!

> the tests aren't 100% exhaustive yet, mainly just integration tests, so don't break your back for now ;)