add_event

AddEvent Ruby API Client

(Formally known as AddThisEvent)

:construction: Work in progress, don't use me yet! :warning:

Ruby client for the AddEvent.com API :zap: :smiley:.

Makes it super easy to create AddEvent URL's from Ruby.

Installation

Add this line to your application's Gemfile:

gem 'add_event'

And then execute:

$ bundle

Or install it yourself as:

$ gem install add_event

Usage

You'll need an AddEvent premium account to use the API (sign up here: addevent.com).

Once you have a premium account, you'll need to set your client_id in an initializer (Rails), as an environment variable ADD_EVENT_CLIENT_ID or by passing it as an option each time when creating a new event URL.

# config/initializers/add_event.rb
AddEvent.configuration do |config|
  # Your Client ID (License code) is available here: https://addevent.com/account/
  config.client_id = 'your_id_goes_here'
end

Then to create an event, pass the title, starts_at, ends_at and options to AddEvent.url

party_starts = DateTime.new(2016, 10, 2, 18, 0, 0, '-7')
party_ends = DateTime.new(2016, 10, 3, 3, 0, 0, '-7')

event_options = {
  service: :google, # or 'google' works too!
  organizer: 'Mike',
  organizer_email: '[e-mail]',
  alert: 15, # set alarm for 15 minutes before the party starts
  description: "A little get together to celebrate DHH's birthday. BYORG (Bring your own ruby gems)",
  location: "Ruby Bar, San Francisco CA"
}

url = AddEvent.url(title: "DHH's Birthday Bash", starts_at: party_starts,
                       ends_at: party_ends, options: event_options)

To see the full list of available options, see the documentation here (TODO).

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec 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.

Contributing :heart:

Want to make this better? Great! :smile:

Bug reports and pull requests are welcome on GitHub at https://github.com/mscoutermarsh/AddEvent-Ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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