Getstat Client

The Ruby Interface to the Getstat API.

Installation

Add this line to your application's Gemfile:

gem "getstat", github: "abunashir/getstat"

And then execute:

$ bundle install

Configure

We need to setup Getstat API configuration before we can perform any request throughout this client

First, obtain an API key for your account, and once you have it then you can configure the client by adding an initializer with the following code:

Getstat.configure do |config|
  config.api_host = "www.getstat.com"
  config.api_key = "YourSecretAPIKey"
end

Usage

List Keywords

Getstat::Keyword.list(site_id: 1234, **other_params)

Development

We are following Sandi Metz's Rules for this gem, you can read the description of the rules here All new code should follow these rules. If you make changes in a pre-existing file that violates these rules you should fix the violations as part of your contribution.

Setup

Clone the repository.

git clone https://github.com/abunashir/getstat

Setup your environment.

bin/setup

Run the test suite

bin/rspec

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/abunashir/getstat.

License

The gem is available as open source under the terms of the MIT License.

abunashir / getstat