https://github.com/ferperales/speakerdeck_api
A gem for getting data from speakerdeck.com
https://github.com/ferperales/speakerdeck_api
Last synced: about 2 months ago
JSON representation
A gem for getting data from speakerdeck.com
- Host: GitHub
- URL: https://github.com/ferperales/speakerdeck_api
- Owner: FerPerales
- License: mit
- Created: 2014-10-12T03:07:52.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-10-24T03:16:28.000Z (over 10 years ago)
- Last Synced: 2025-03-27T22:13:46.763Z (2 months ago)
- Language: Ruby
- Homepage:
- Size: 284 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# SpeakerdeckApi
[](https://travis-ci.org/FerPerales/speakerdeck_api)
[](http://badge.fury.io/rb/speakerdeck_api)
[](https://coveralls.io/r/FerPerales/speakerdeck-api?branch=master)
A gem for getting data from speakerdeck.com
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'speakerdeck_api'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install speakerdeck_api
## Usage
First require the gem:
```ruby
require 'speakerdeck_api'
```
At the moment, you can get the number of talks, name and website of a speaker via the
SpeakerdeckApi::Speaker class.
```ruby
speaker = SpeakerdeckApi::Speaker.get 'speakerdeck.com_username'
```
This return an object with the *number of talks*, *name*, and *website* attributes:
```ruby
speaker.number_of_talks
=> 8
speaker.name
=> 'Fake Guy'
speaker.website
=> 'http://fakeg.uy/'
```
You will get a SpeakerNotFound exception in case the provided speaker
name does not correspond to a speackerdeck.com user.
## Upcoming
- [x] Retrive more information about the speaker
- [ ] Add SpeakerdeckApi::Talk class to retrieve talk details
- [x] Add VCR for testing
## Contributing
1. Fork it ( https://github.com/FerPerales/speakerdeck_api/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request