Contents

# apisync-ruby

This gem gives you the tools to interact with [apisync.io](apisync.io).

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'apisync'
```

## Usage

**On Rails?** Please use
[apisync-rails](https://github.com/apisync/apisync-rails) instead. It has
automatic integration with ActiveRecord.

### Vanilla Ruby

To create an inventory item:

```ruby
client = Apisync.new(api_key: token)
client.inventory_items.save({
  attributes: {
    ad_template_type: "vehicle",
    available:        true,
    brand:            "brand",
    condition:        "new",
    content_language: "pt-br",
    reference_id:     "1"

    # more attributes
  }
})
```

For details on the attributes, see the
[API Reference documentation](https://docs.apisync.io/api/).

You can also define a global API key:

```ruby
Apisync.api_key = "my-key"

# Instantiate the client now without passing a token
client = Apisync.new
```

### Responses

All HTTP calls return an
[HTTPart::Response](https://github.com/jnunemaker/httparty) instance:

```ruby
response = client.inventory_items.save(attributes)
response.success? # => true
```

In case too many requests are made simultaneously, the server will return
429 and this lib will raise the `Apisync::TooManyRequests` exception.

## Development

To run tests:

```
bundle exec rspec spec
```

To release a new version, update the version number in `version.rb`, and then
run `bundle exec rake release`, which will create a git tag for the version,
push git commits and tags, and push the `.gem` file to
[rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/apisync/apisync-ruby.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
apisync-0.1.6	README.md
apisync-0.1.5	README.md