Project

yikyak

0.0
No commit activity in last 3 years
No release in over 3 years
Super easy Ruby library for using YikYak's public API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 0.14.0
>= 1.5.6
 Project Readme

YikYak Ruby Library

Dependencies

  • HTTParty: gem install httparty
  • JWT: gem install jwt

Installation

You can do any of the following:

  • Run gem install yikyak in your command line.
  • Add gem 'yikyak' to your Gemfile
  • Clone the repository and build the gem:
    • git clone https://github.com/ferrerluis/yikyak.git && cd yikyak
    • gem build yikyak-0.1.0.gem
    • gem install ./yikyak-0.1.0.gem

Usage

  • Require the library: require 'yikyak'.
  • Create a YikYak instance: yak = YikYak.new user_token, app_id, secret_key.
  • Use the functions available from the yak instance.

Functions

set_status

If it goes through, the function returns true. Returns false otherwise.

if yak.set_status "JustChillin"
  p "Worked"
else
  p "Failed"
end