Project

blesta

0.0
No commit activity in last 3 years
No release in over 3 years
A Ruby library for working with the Blesta Resellers API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
~> 0.9.2.2
~> 2.10.0
~> 2.3.0

Runtime

~> 0.8.4
~> 1.7.3
 Project Readme

Blesta Blesta Build Status

A Ruby library for working with the Blesta Reseller API.

Blesta has been tested on MRI 1.8.7, MRI 1.9.2 and MRI 1.9.3.

Install

gem install blesta
bundle install

Configuration

require 'blesta'

Blesta.config do |c|
  c.base_uri 'https://blestaapi.com' # Root level URI for blesta API
  c.uid      'uid'                   # Blesta reseller UID
  c.password 'topsecret'             # Blesta reseller password
end

Usage

Get all licenses:

license = Blesta::License.new
license.all

Search for a specific license:

license.search "mydomain.com", :type => "domain"
license.search "1234567890AB", :type => "license"

Get the amount of credit in USD on the reseller account:

credit = Blesta::Credit.new
credit.get_amount

Get a list of all of the packages this reseller account may add:

packages = Blesta::Package.new
packages.all

Supported Methods

This gem implements the blesta reseller's API v1.0.

It includes:

  • Get Credit.
  • Get Licenses.
  • Get Packages.
  • Add License.
  • Cancel License.
  • Suspend License.
  • Unsuspend License.
  • Search Licenses.
  • Update Domain.

Tests

Blesta uses rspec for tests. To run:

bundle exec rake

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Copyright

Copyright (c) 2012 Site5.com. See LICENSE for details.