Project

wykop

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Provides easy way to interact with the Wykop.pl API in any kind of application
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 1.2.0, ~> 1.2.0
~> 1.5
>= 0.13.3, ~> 0.13.3
>= 1.8.1, ~> 1.8.1
>= 10.0.0, ~> 10.0
~> 2.6
 Project Readme

Gem for wykop.pl API

Gem Version Code Climate Build Status Gratipay

This is a Ruby Gem for the Wykop.pl API. It should simplify the process of consuming data from the Wykop.pl API for developers using Ruby.

Heads up

Until version 0.9+ gem will and should be considered as 'under heavy development'. Please be aware and don't bitch too much. Current gem version: Gem Version

If you'd like to contribute - I'm really happy with your pull requests so feel free!

Installation

Add following to your application Gemfile:

gem 'wykop', require: 'wykop'

And then execute:

$ bundle

Or install it on your own:

$ gem install wykop

Documentation

Usage

Basic usage

The gem uses a client model to query against the API. To create and configure client with your API keys and make requests through that add the following:

require 'wykop'
client = Wykop::Client.new( { app_user_key: WYKOP_DEV_APP_KEY, app_user_secret: WYKOP_DEV_APP_SECRET, 
                app_generated_key: WYKOP_DEV_APP_GENERATED_KEY, app_username: WYKOP_USERNAME, api_host: 'http://a.wykop.pl' })