[![Build Status](https://travis-ci.org/urbanairship/ruby-library.svg?branch=master)](https://travis-ci.org/urbanairship/ruby-library)

# Urbanairship

`urbanairship` is a Ruby library for using the [Urban Airship](www.urbanairship.com) web service API for push notifications and rich app pages.

## Requirements
As of Version 3.0, a Ruby version >= 2.0 must be used.

## Functionality

####BETA Release
Version 3.0 is a major upgrade and backwards incompatible with earlier versions. This BETA release focuses on support for the new version 3 push API. There is also a major reorganization of the codebase.

Note: the BETA release only supports UA's ```/push/``` and ```/schedules/``` endpoints. Expanded support for UA's other endpoints will be in the forthcoming release. 

####Forthcoming Release
To encourage the use of our SDK, which takes care of proper channel registration, support for device token registration will be removed. Support for v1 endpoints will also be removed and transitioned to their v3 equivalents where possible.

## Installation

If you have the ```bundler``` gem (if not you can get it with ```$ gem install bundler```) add this line to your application's Gemfile:

```ruby
gem 'urbanairship'
```

And then execute:

    $ bundle

OR install it yourself as:

    $ gem install urbanairship

## Usage

Once the gem has been installed you can start sending pushes! See http://docs.urbanairship.com/topic-guides/api-examples.html for more examples.

####Broadcast to All Devices
```ruby
require 'urbanairship'
UA = Urbanairship
airship = UA::Client.new(key:'application_key', secret:'master_secret')
p = airship.create_push
p.audience = UA.all
p.notification = UA.notification(alert: 'Hello')  
p.device_types = UA.all
p.send_push
```

####Simple Tag Push
```ruby
require 'urbanairship'
UA = Urbanairship
airship = UA::Client.new(key:'application_key', secret:'master_secret')
p = airship.create_push
p.audience = UA.tag('some_tag')
p.notification = UA.notification(alert: 'Hello')  
p.device_types = UA.all
p.send_push
```

## Questions
The best place to ask questions is our support site: http://support.urbanairship.com/

## Contributing

1. Fork it ( https://github.com/urbanairship/ruby-library )
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 a new Pull Request
6. Sign Urban Airship's [contribution agreement](http://urbanairship.com/legal/contribution-agreement) 
Note: Changes will not be approved and merged without a signed contribution agreement

## Development

After checking out the repo, ensure you have ```bundler``` installed (```$ gem install bundler```) run 
    
    $ bin/setup
     
to install dependencies. 
Then, run 
   
    $ bin/console
     
for an interactive prompt that will allow you to experiment.

OR you can build a local gem to play with:

    $ gem build urbanairship.gemspec
    $ gem install ./urbanairship-<VERSION>.gem

Having a local build will give you better logging if you are running into issues, but be careful to make sure to use our released
public gem in Production.