#Rest interface for Responsys API

Rails application that provides a rest based interface for the Responsys SOAP API. Based on the responsys-api gem by dandemeyere.

Documentation

The documentation is included as part of the application. We have a demo version deployed to Heroku, none of the calls will work as the Responsys credentials are invalid. https://responsys-rest.herokuapp.com/. If you have any questions or if you want to report a bug please create an issue.

Installation

You can checkout the repository and run as a normal Rails app, or install the application using a deb from releases.

The deb has been created using pkgr.

Installation From Source

git clone [email protected]:TheBookPeople/responsys-rest.git
cd responsys-rest
git checkout [TAG_VERSION]
bundle install
export RESPONSYS_USER=user
export RESPONSYS_PASSWORD=password
bundle exec rails s -b0.0.0.0

Installation From Deb

Download deb file from releases

sudo apt-get install mysql-common
sudo dpkg -i responsys-rest_[VERSION]_amd64.deb
sudo vi /etc/responsys-rest/conf.d/other

Set Enviroment Variables

sudo vi /etc/responsys-rest/conf.d/other

export RESPONSYS_USER=user
export RESPONSYS_PASSWORD=password
export PORT=8081

Set Number of Web processes

sudo responsys-rest scale web=1

Check logs

sudo responsys-rest logs -f

Running Tests

We use VCR to capture and replay calls to the Responsys SOAP API.

export RESPONSYS_USER=user
export RESPONSYS_PASSWORD=password
bundle exec rspec

Contributing

We use gitflow to manage our git workflow.

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