Sha256: fc09f5a4da0f5f0e79265537bd56c5e4cec82ccd39141341854c4c663aa8fbd5

Contents?: true

Size: 1.49 KB

Versions: 1

Compression:

Stored size: 1.49 KB

Contents

# Validic

Ruby API Wrapper for [Validic](http://www.validic.com)

## Build Status
[![Codeship Status for Validic/validic](https://www.codeship.io/projects/cc4ff330-9f72-0130-3cf3-0e5a3e2104f7/status?branch=master)](https://www.codeship.io/projects/3456)

## Installation

Add this line to your application's Gemfile:

    gem 'validic'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install validic

## Usage

```ruby
    require 'validic'

    # If you're using Rails 3+
    # config/initializers/validic.rb
    Validic.configure do |config|
      config.api_url        = 'https://api.validic.com'
      config.api_version    = 'v1'
    end

    # If you're using plain RUBY
    # Create Validic::Client Object
    options = {
      api_url: 'https://api.validic.com',
      api_version: 'v1',
      access_token: 'DEMO_KEY' # Replace this with your key
    }
    client = Validic::Client.new options

    # Create a Client Object expecting you have an initializer in place
    # Validic::Client Object
    client = Validic::Client.new

    # => Get Account Fitness
    client.get_fitness

    # => Get Organization Fitness
    client.get_fitness({organization_id: "YOUR_organization_id",
                          access_token: "YOUR_ACCESS_TOKEN"})
```

## 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

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
validic-0.3.2 README.md