Skip to content

FerPerales/speakerdeck_api

Repository files navigation

SpeakerdeckApi

Build Status

Gem Version

Coverage Status

A gem for getting data from speakerdeck.com

Installation

Add this line to your application's Gemfile:

gem 'speakerdeck_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install speakerdeck_api

Usage

First require the gem:

require 'speakerdeck_api'

At the moment, you can get the number of talks, name and website of a speaker via the SpeakerdeckApi::Speaker class.

speaker = SpeakerdeckApi::Speaker.get 'speakerdeck.com_username'

This return an object with the number of talks, name, and website attributes:

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

  • Retrive more information about the speaker
  • Add SpeakerdeckApi::Talk class to retrieve talk details
  • 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

About

A gem for getting data from speakerdeck.com

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages