Skip to content
/ yo-ruby Public

🌈 ✨ A super awesome Ruby wrapper of the Yo API.

License

Notifications You must be signed in to change notification settings

bih/yo-ruby

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Yo for Ruby

Yo! API for Ruby (v1.0.0)

Build Status Code Climate Coverage Status

This is a Ruby API wrapper that's fully tested. It works on Ruby 2.1 and above. This was originally written for the Yo! hackathon in New York (which I later won first place with YoAuth).

Installation

Do it through your terminal, yo.

$ gem install yo-ruby

No? Stick it in your Gemfile, yo.

gem 'yo-ruby', '~> 1.0'

Documentation

Before using the Yo! API, you need to obtain a free API key. It takes a few seconds.

Required: Now you need to include the library and set your API key.

require 'yo-ruby'

Yo::Configuration.setup do |config|
  config.api_key = "[insert api key here]"
end

# Alternatively: Yo::Configuration.api_key = "[insert api key here]"

Method: Send a yo to someone

yo = Yo.yo!("username")
yo.ok? # => true

Method: Send a yo to someone with a URL

yo = Yo.link!("username", "http://github.com/bih/yo-ruby")
yo.ok? # => true

Method: Subscriber count

Yo.subscribers

Method: Send a yo to all your subscribers

Yo.all!

Method: Send a yo to all your subscribers with a URL (New)

Yo.all!("http://github.com/bih/yo-ruby")

Lazy Documentation

require 'sinatra'
require 'yo-ruby'

Yo::Configuration.setup do |config|
  config.api_key = "[insert api key here]"
end

get '/yo/:username' do
  yo = Yo.yo!(params[:username])
  yo.ok?
end

get '/yoall' do
  yo = Yo.all!
  yo.ok?
end

get '/subscribers' do
  puts "Subscribers: #{Yo.subscribers}"
end

Testing

This gem is fully tested and you can find all the tests in the spec/yo-ruby/ folder. You can also execute them by running the rake command.

$ rake

Who made this?

Bilawal Hameed. Released freely under the MIT License.

About

🌈 ✨ A super awesome Ruby wrapper of the Yo API.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages