Sha256: 89a4e586550f93177dbb7e411ba8147091b77f20683fa34b0cdb2ca7b2f0818d

Contents?: true

Size: 1.42 KB

Versions: 6

Compression:

Stored size: 1.42 KB

Contents

[![Build Status](https://travis-ci.org/activenetwork/actv.png)](https://travis-ci.org/activenetwork/actv)

# ACTV

A Ruby wrapper for The ACTIVE Network 3.0 API. You can get your v2
search API key at http://developer.active.com

## Installation

Add this line to your application's Gemfile:

    gem 'actv'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install actv

## Configuration

Require the gem, then configure the endpoint and your api key:

    ACTV.configure do |config|
      config.endpoint = "http://api.amp.active.com"
      config.api_key = "YOUR_API_KEY"
    end

## Usage Examples

Search for Running

    ACTV.search('Running')

Return an Asset with Id of 12345678-9012-3456-7890-123456789012

    ACTV.asset('12345678-9012-3456-7890-123456789012')

Search for Swimming Articles

    ACTV.articles('Swimming')

Return an Article with Id of 12345678-9012-3456-7890-123456789012

    ACTV.article('12345678-9012-3456-7890-123456789012')

Certain methods require authentication. You need to instantiate a Client object with a valid acceess token

    @actv = ACTV::Client.new({
        oauth_token: session[:access_token]
    })

Get the requested current user

    @actv.me

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
actv-1.2.0 README.md
actv-1.1.23 README.md
actv-1.1.17 README.md
actv-1.1.6 README.md
actv-1.1.5 README.md
actv-1.1.3 README.md