Project

carbon_pms

0.0
No commit activity in last 3 years
No release in over 3 years
Ruby client to send push messages to a Carbon PMS server.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.3
>= 0
>= 0

Runtime

~> 0.10
 Project Readme

CarbonPms

Code Climate

If you're not using a CarbonPMS server, then you don't need this.

Installation

Add this line to your application's Gemfile:

gem 'carbon_pms'

And then execute:

$ bundle

Or install it yourself as:

$ gem install carbon_pms

Usage

require 'carbon_pms'

client = CarbonPms::Client.new('example.com', 'auth_token', API_VERSION)
client.create_app(name: 'foo', auth_key: '123123')

You can also initialize the client with a configuration block:

# config/initializers/carbon_pms.rb (for instance)
CarbonPms.configure do |config|
  config.host = 'example.com'
  config.auth_token = 'abcdef'
  config.version = '42'
end
# elsewhere
client = CarbonPms.Client.new

Contributing

  1. Fork it
  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 new Pull Request