Project

statraptor

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
StatRaptor gathers all your metrics into one simple-to-use dashboard.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.0.3
~> 0.6.0
~> 0.9.2
~> 0.9.0
~> 2.8.0
~> 2.3.5
= 2.0.0.rc1
= 1.7.10

Runtime

>= 1.4.6
>= 1.6.6
 Project Readme

StatRaptor API wrapper for Ruby build status

Interact with client like so:

# Configure the library to use your
# StatRaptor platform credentials

StatRaptor.configure do |config|
  config.platform_credentials = "ABC123"
end

# Initialize a client
client = StatRaptor::Client.new

# Manage users
client.create_user(:email => "timmy@example.com", :chargify_api_key => "XYZ456")
client.find_or_create_user(:email => "timmy@example.com", :chargify_api_key => "XYZ456")
client.delete_user("akskd8328389281728918")
client.get_users

# Manage projects
client.create_project(:user_credentials => "3892839akslje",
  :project => {:name => "Zippy", :subdomain => "zippy-llc", :component => "advanced"})
client.delete_project(:user_credentials => "3892839akslje", :subdomain => "zippy-llc")

# Graphs
client.get_revenue_graph_data(:user_credentials => "3892839akslje", :subdomain => "zippy-llc")
client.get_subscribers_graph_data(:user_credentials => "3892839akslje", :subdomain => "zippy-llc")
client.get_average_lifetime_value_graph_data(:user_credentials => "3892839akslje", :subdomain => "zippy-llc")
client.get_churn_graph_data(:user_credentials => "3892839akslje", :subdomain => "zippy-llc")

Installation

You can install this library as a gem using the following command:

$ gem install statraptor

If you're using Rails, include the gem in your Gemfile:

gem 'statraptor'

Resources

The following resources exist for interacting with the StatRaptor API:

  • StatRaptor::Client::Users
  • StatRaptor::Client::Projects
  • StatRaptor::Client::Graphs