camdram

The Camdram Ruby Gem

Camdram-ruby is an API wrapper & interface for Camdram 🎭 that's made with love ❤️ and written in Ruby 💎.

Quick Start

Any of the lines inside the config block can be omitted.

require 'camdram/client'

client = Camdram::Client.new do |config|
  config.api_token = api_token
  config.user_agent = "MyApp v1.0.0"
  config.base_url = "https://www.camdram.net"
end

Documentation

Full documentation is generated from the source code by YARD and is available to view on RubyDocs.

Usage Examples

Just some of the things you can do after configuring a client object:

client.user.get_shows
client.user.get_shows[0].society
client.user.get_shows[0].venue
client.user.get_shows[0].performances
client.user.get_orgs
client.user.get_orgs[0].name
client.user.get_orgs[0].twitter_id
client.user.get_venues
client.user.get_venues[0].slug
client.user.get_venues[0].facebook_id

These public actions don't require an API key (although you are still strongly advised to use one anyway):

client.get_show(6171)
client.get_show("2018-lucky")

client.get_org(1)
client.get_org("cambridge-university-amateur-dramatic-club")

client.get_venue(29)
client.get_venue("adc-theatre")

client.get_person(13865)
client.get_person("charlie-jonas")

client.get_org("cambridge-footlights").shows
client.get_org("cambridge-footlights").news
client.get_venue("cambridge-arts-theatre").shows
client.get_venue("cambridge-arts-theatre").news

Versioning

This library aims to adhere to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, that version should be immediately yanked and/or a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions. As a result of this policy, you can (and should) specify a dependency on this gem using the Pessimistic Version Constraint with two digits of precision. For example:

spec.add_runtime_dependency 'camdram', '~> 1.2'

Copyright

Copyright (c) 2018 Charlie Jonas. See LICENSE for details.