Repository is archived
No commit activity in last 3 years
No release in over 3 years
Simple rack app the allows for a local catcher clickatell environment.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.11
~> 10.0
~> 3.0
~> 0.46.0

Runtime

>= 1.3.0, ~> 1.0
< 3.0, >= 1.1.0
 Project Readme

Clickatell::Catcher::Rack

Build Status

Simple Lightweight rack app the allows for a local sandbox clickatell enviroment. This Rack app emulates some of the Clickatells api

Installation

Add this line to your application's Gemfile:

group :development do
    gem 'clickatell-catcher-rack'
end

And then execute:

$ bundle

Or install it yourself as:

$ gem install clickatell-catcher-rack

Usage

using in rails add a initializers file with the following:

  if Rails.env.development?
      require 'clickatell/catcher/rack'
      Rails.application.configure do
        config.middleware.use Clickatell::Catcher::Rack::Middleware, logger: Rails.logger
      end
  end

or for other rack apps add the following to your config.ru

  require 'clickatell/catcher/rack'
  use Clickatell::Catcher::Rack::Middleware

Now in development mode you can point you clickatell sms code at http://localhost:3000/rest/message and visit http://localhost:3000/rest/message to see the messages. Suggested a config to be able to switch between https://api.clickatell.com/rest/message and http://localhost:3000/rest/message

Plans

  • Standalone Version
  • Support for some of the Error codes

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/grantspeelman/clickatell-catcher-rack.

License

The gem is available as open source under the terms of the MIT License.