Project

plurky

0.0
No release in over 3 years
Low commit activity in last 3 years
Yet another Plurk API wrapper
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

>= 0
~> 2.14.0.rc1

Runtime

~> 0.8.7
~> 2.0.5
~> 1.7.3
~> 0.2.0
 Project Readme

Plurky

Gem Version Build Status Dependency Status Code Climate Coverage Status Bitdeli Badge

Yet another Plurk API wrapper. Or something to play when the Plurk team is busy optimizing the site.

Installation

Add this line to your application's Gemfile:

gem 'plurky'

And then execute:

$ bundle

Or install it yourself as:

$ gem install plurky

Documentation

Examples

require 'plurky'

client = Plurky.client
client.get '/APP/Profile/getPublicProfile', :user_id => 34

Configuration

Applications that make requests on behalf of a single Plurk user can pass global configuration options as a block to the Plurky.configure method.

Plurky.configure do |config|
  config.consumer_key       = YOUR_CONSUMER_KEY
  config.consumer_secret    = YOUR_CONSUMER_SECRET
  config.oauth_token        = YOUR_OAUTH_TOKEN
  config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET
end

Alternately, you can set the following environment variables:

PLURK_CONSUMER_KEY
PLURK_CONSUMER_SECRET
PLURK_OAUTH_TOKEN
PLURK_OAUTH_TOKEN_SECRET

After configuration, requests can be made like so:

Plurky.get '/APP/Timeline/getPlurks'

Implemented APIs

  • status
  • update

Obtaining access tokens

Plurky will not support obtaining access tokens.

If you do not intend to provide service to other users, you can obtain an access token from the test console. (You may need to create a Plurk App first to get a pair of comsumer key and secret.)

TODO

  • Improve test coverage.
  • Add APIs.
  • Catch errors from Plurk.
  • APIs should return consistent data. (e.g. status & update.)

Credits

Most of the code are copy-pasted from the twitter gem.

Copyright

Copyright (c) 2012 - 2013 Chun-wei Kuo. See LICENSE for details.