messagebus_ruby_apn_api

= Message Bus Ruby APN API

== Installation

gem install messagebus_ruby_apn_api

== Basic Use

=== Start by requiring MessabusApi:

require 'messagebus_ruby_apn_api'

=== Then create an instance of the Messagebus class with your account information

client = MessagebusApnApi::Messagebus.new("<INSERT_YOUR_API_KEY>")

=== Sending a single notification

==== Create Required Parameters

  params = { :userName => '[e-mail]',
    :alert => 'Hello push notification world.',
    :platform => Messagebus::PLATFORM_IOS,
    :customFields => {}
  }

==== Send the message

 client.add_apn_message(params)

== Examples

The provided examples illustrate how to:
- send a single notification to a registered device
- register a device

== SSL Certificates

If you encounter SSL certificate problems, use the cacert_info() method to specify a
cacert.pem file (remember to specify the full path).

The curl site has an up to date version of the file:

http://curl.haxx.se/ca/cacert.pem

== Tests To run the tests, issue the following command from the root of the project: bundle exec rspec spec/messagebus_ruby_apn_api/client_spec.rb

== License Copyright 2012 Mail Bypass, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

== More info Contact Message Bus if you have questions or problems (https://www.messagebus.com/contact)