https://github.com/kevinjalbert/godville_kit
A gem kit to instantiate your hero's state from Godville
https://github.com/kevinjalbert/godville_kit
api godville rubygem
Last synced: about 1 year ago
JSON representation
A gem kit to instantiate your hero's state from Godville
- Host: GitHub
- URL: https://github.com/kevinjalbert/godville_kit
- Owner: kevinjalbert
- License: mit
- Created: 2014-05-06T03:29:49.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-05-16T01:18:15.000Z (about 12 years ago)
- Last Synced: 2025-03-22T14:22:07.142Z (about 1 year ago)
- Topics: api, godville, rubygem
- Language: Ruby
- Homepage:
- Size: 197 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Godville Kit
[](https://gitter.im/kevinjalbert/godville_kit)
[](http://badge.fury.io/rb/godville_kit)
[](https://travis-ci.org/kevinjalbert/godville_kit)
[](https://coveralls.io/r/kevinjalbert/godville_kit?branch=master)
[](https://codeclimate.com/github/kevinjalbert/godville_kit)
[](https://gemnasium.com/kevinjalbert/godville_kit)
## Introduction
This gem provides the functionality to query [Godville](http://godvillegame.com) for your hero's information. As [Godville](http://godvillegame.com) does not provide a public documented API, other approaches had to be explored. By observing the network activity when accessing [Godville' hero page](http://godvillegame.com/superhero), it be clear that there are HTTP API calls to acquire the hero's information.
By using these HTTP API calls it is possible to acquire a JSON response containing the hero's data. This Gem takes the JSON responses and transforms them into a cohesive object structure detailing the hero. Hopefully this provides an easier way for data collection/visualizations or whatever you wish to create.
## Example Usage
The follow shows you how to perform the authentication with [Godville's](http://godvillegame.com) servers, which then allows you to fetch your hero's data.
require 'godville_kit
# Create an API requester, which performs authentication and HTTP requests
requester = GodvilleKit::APIRequester.new('user@gmail.com', 'my_password', 'hero_guid', 'pantheons_guid')
# Fetch the current state of your hero and provides it as an object structure
hero = requester.request_hero
### Required Data
The `APIRequester` requires four pieces of information: username/email, password, hero GUID, pantheons GUID. The first two you should already know. To acquire the GUIDs are slightly more involved. From what I understand these Globally Unique Identifier (GUID) simply reference a resource as you make the API requests. These API requests are all going to the same API endpoint, and so we require the GUIDs to make requests for hero and pantheons data.
This is all speculation on how [Godville](http://godvillegame.com) servers handle identified the resources. I have noticed that the Pantheons GUID changes through sessions, although the old GUID still provide access, so I am unsure how it exactly works, or when it will expire.
#### Hero GUID
1. Open up Chrome (this work with Firefox as well, although some details will be different)
2. Open the Developer Tools view
3. Select the Network tab
4. Open/Refresh [http://godvillegame.com/superhero](http://godvillegame.com/superhero)
5. Look for an entry similar to `feed?a=hero_guid`
#### Pantheons GUID
1. Open up Chrome (this work with Firefox as well, although some details will be different)
2. Open the Developer Tools view
3. Select the Network tab
4. Open/Refresh [http://godvillegame.com/superhero](http://godvillegame.com/superhero)
5. You need to look through the multiple `feed` entries and identify the one where the Response tab shows pantheons data.
6. Using the identified `feed` entry look at the Header tab's Form Data value `a=pantheons_guid`