Project

pechkinrb

0.0
No commit activity in last 3 years
No release in over 3 years
Interface for pechkin-mail.ru service API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.6
~> 10.4
~> 3.0

Runtime

 Project Readme

PechkinRb

Code Climate Gem Version

This gem provides you with simple Ruby interface for pechkin-mail.ru mail service.

Documentation available at http://www.rubydoc.info/github/crsde/PechkinRb

Original API documentation https://pechkin-mail.ru/api/

At this moment, mainly list management features implemented, but there are common way to call any API method, using #call_method

Installation

Add this line to your application's Gemfile:

gem 'pechkinrb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pechkinrb

Usage

PechkinRb declares some classes for API objects, like List, Member, etc

require "pechkinrb"
conn = Pechkin::Connection.new('login', 'password')
conn.lists # => Array of Pechkin::List instances

Optionally you can additionally pass third parameter to Pechkin::Connection constructor, to change API url (for example if you plan to use compatible service):

conn = Pechkin::Connection.new('login', 'password', 'https://api.pechkin-mail.ru')

Also, you can use universal invocation method with #call_method

conn.call_method('lists.get_members', list_id: 1)

Contributing

  1. Fork it ( https://github.com/crsde/PechkinRb/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