https://github.com/ianmitchell/buddy_api
A Ruby Wrapper for the Buddy Platform
https://github.com/ianmitchell/buddy_api
Last synced: 9 months ago
JSON representation
A Ruby Wrapper for the Buddy Platform
- Host: GitHub
- URL: https://github.com/ianmitchell/buddy_api
- Owner: IanMitchell
- License: mit
- Created: 2014-06-25T23:35:00.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2015-03-16T22:20:49.000Z (over 11 years ago)
- Last Synced: 2025-02-01T15:45:02.351Z (over 1 year ago)
- Language: Ruby
- Size: 348 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Buddy API
**Note:** _This Gem is currently in development and unreleased at this time. I'm still working on it, but development has hit a bit of a standstill until I need it for a project I'm working on._
Most of the Buddy API codebase is in, it just hasn't been tested yet. There also is currently significant code reuse. Both problems are being worked on over time!
### Fully Tested and Documented
1. Core (used internally)
2. Device
### Tested and Undocumented
1. N/A
### Partially Tested and Undocumented
1. User (Create, Login)
### Untested and Undocumented
1. Album
2. Album Item
3. Blob
4. Checkin
5. Game
6. Identity
7. Location
8. Message
9. Metadata
10. Metric
11. Picture
12. Player
13. Push
14. Score
15. Scoreboard
16. Session
17. User List
18. Video
----
## Installation
_Since this gem is currently unreleased, the below is not true._
Add this line to your application's Gemfile:
gem 'buddy_api'
And then execute:
$ bundle
Or install it yourself as:
$ gem install buddy_api
## Configuraton
Before you can make calls, you must configure the gem as such:
BuddyAPI.configure do |config|
config.app_id = 'AppID Here'
config.app_key = 'AppKey Here'
# Must be one of [:free, :pro, :enterprise]. Defaults to :free
config.tier = :free
end
#### Testing
To test this gem, you'll need to register a test application on Buddy. Make a new file `test/config.yml` with the following contents:
appID: Your ID Here
appKey: Your Key Here
After that, you should be able to run `rake test` effectively.
## Changelog
**Version 1.0.0**: _July X, 2014_
* Implemented