# PartyBus

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/party_bus`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:

```ruby
gem "party_bus", git: "git@github.com:arid-software/party-bus-ruby.git", branch: "main"
```

And then execute:

    $ bundle install

## Usage

Generate project initializer.

    $ bin/rails generate party_bus <api key>

Add the helper to any object you would like to observe events. To add the helper to every model in your rails application.

    class ApplicationRecord < ActiveRecord::Base
      primary_abstract_class

      include Publishable
    end

Control which methods file events with the `publish_on` class method.

      publish_on [:create,  :my_method, :my_other_method]

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/party_bus. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/party_bus/blob/master/CODE_OF_CONDUCT.md).


## License

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

## Code of Conduct

Everyone interacting in the PartyBus project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/party_bus/blob/master/CODE_OF_CONDUCT.md).