araluce/calendlyr

✨ Ruby bindings for Calendly API.

Calendly API Rubygem

Easy and comprehensive rubygem for Calendly. Currently supports API v2.

You just need a Personal Access Token.

Dependencies

No dependencies 🎉

We understand the importance of not adding unwanted dependencies.

📚 Docs

Installation

Add this line to your application's Gemfile:

gem 'calendlyr', '0.7.5'

And then execute:

$ bundle

Or install it yourself as:

$ gem install calendlyr

Usage

To access the API, you'll need to create a Calendlyr::Client and provide your token. You can generate your Personal Access Token at https://calendly.com/integrations/api_webhooks

client = Calendlyr::Client.new(token: ENV["CALENDLY_TOKEN"])

The client then provides access to all of the resources.

Resources

The gem is designed to closely mirror the Calendly API, making it easy to convert API examples into gem code

Responses are created as objects, like Calendlyr::Event. Having types like Calendlyr::User is useful for understanding the type of object you're working with. These objects are built using OpenStruct, allowing you to access data in a Ruby-like way.

• Pagination
• Activity Log
  • Calendlyr::ActivityLog
• Availabilities
  • Calendlyr::Availabilities::Rule
  • Calendlyr::Availabilities::UserSchedule
  • Calendlyr::Availabilities::UserBusyTime
• Data Compliance
• Event Types
  • Calendlyr::EventType
  • Calendlyr::EventTypes::AvailableTime
  • Calendlyr::EventTypes::Membership
  • Calendlyr::EventTypes::Profile
• Groups
  • Calendlyr::Group
  • Calendlyr::Groups::Relationship
• Organizations
  • Calendlyr::Organization
  • Calendlyr::Organizations::Invitation
  • Calendlyr::Organizations::Membership
• Routing Forms
  • Calendlyr::RoutingForm
  • Calendlyr::RoutingForms::Submission
• Schedule Events
  • Calendlyr::Event
  • Calendlyr::Events::Cancellation
  • Calendlyr::Events::Guest
  • Calendlyr::Events::Invitee
  • Calendlyr::Events::InviteeNoShow
• Scheduled Links
• Shares
• Users
• Webhooks
  • Calendlyr::Webhooks::Subscription
  • Calendlyr::Webhooks::Payload
  • Calendlyr::Webhooks::InviteePayload

Contributing

1. Fork it ( https://github.com/araluce/calendlyr/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

When adding resources, update the list of resources in lib/calendlyr. Additionally, write a spec and include it in the list in the README

Thanks

Many thanks to@markets (our behind-the-scenes contributor) for all the comments, insights, and tips on this Ruby gem project, and for helping me grow professionally day by day 🙌

Thanks also to @excid3 and his Vultr.rb rubygem project.