Webceo

Integrate your ruby application with this webceo gem to perform the api action using your webceo account. Take a look at the Webceo API Reference.

Getting Started

Add this line to your application's Gemfile:

gem 'webceo'

And then execute:

$ bundle

Or install it yourself as:

$ gem install webceo

Usage

# initialize an instance of the Client with your API key or
# set an Environment Variable WEBCEO_API_KEY and initialize client without passing it to the client
client = Webceo::Api::Client.new('your_api_key')

# get list of all the projects, see api reference
client.get_projects({ :id => 'my_request_id' })
# => [{:id=>'my_request_id', :data=>[{:project=>"8ady5y7e36", :domain=>"example.com", :user=>["[email protected]", "[email protected]", ... ]}, {:project=>"asg4563wef", :domain=>"example.com", :user=>["[email protected]", "[email protected]", ... ]}], :method=>"get_projects"}]

# get a single project
client.get_project({ :project => '8ady5y7e36' })
# => [{:id=>nil, :data=>{:project=>"8ady5y7e36", :domain=>"example.com", :user=>["[email protected]", "[email protected]", ... ]}, :method=>"get_projects"}]

Contributing

Open Source Helpers

Bug reports and pull requests are welcome on GitHub at https://github.com/agnel/webceo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Check out the Webceo Ruby Gem Google Group

License

Webceo is released under the MIT License.

Todo

  • [ ] Batch Operations Support
  • [ ] Specs