Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Amiando Api Ruby implementation
Ruby

This branch is 14 commits ahead, 34 commits behind xing:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
Gemfile
Guardfile
MIT-LICENSE.txt
README.md
Rakefile
amiando.gemspec

README.md

amiando Build Status

This is a gem to access the amiando REST API. You can check the original documentation here:

http://developers.amiando.com/index.php/REST_API

Installation

Simply install with:

gem install amiando

To parse the json results we use the multi_json gem. We suggest that you add at least one fast json parsing library, like json or yajl-ruby. Otherwise it will use multi_json's bundled json parser.

Basic usage

The gem has been implemented with the idea that requests can be done in parallel using Typhoeus.

You can query multiple requests and run then like this:

albert = Amiando::User.find(1234)
jorge  = Amiando::User.find(5678)

Amiando.run

Both requests will happen in parallel.

You can also do synchronous requests by prepending 'sync_' to the method name:

albert = Amiando::User.sync_find(1234)

Notation

All attributes should be used in snake_case format instead of the CamelCase used in the official documentation. For example, for a user, you should call first_name instead of firstName.

Documentation

The full amiando API isn't fully implemented yet, however you can find here the ones currently available.

Something went wrong with that request. Please try again.