Home > cineworld

cineworld

Cineworld is a project mainly written in Ruby, based on the MIT license.

A simple wrapper around the Cineworld API

h1. Cineworld

A very simple wrapper around the "Cineworld API":https://www.cineworld.co.uk/developer/api using "HTTParty":https://github.com/jnunemaker/httparty.

h2. Installation

gem install cineworld

h2. Examples


  # Initialise with your API key
  cineworld = Cineworld::API.new('API_KEY')

  # Get all cinemas that have programmed performances
  puts cineworld.cinemas

  # Get all films that have programmed performances
  puts cineworld.films

  # Get all dates that have programmed performances
  puts cineworld.dates

  # Get all performances that are programmed for a particular cinema, film and date
  puts cineworld.performances

h2. TODO

  • Tests

h2. Contributing to cineworld

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

h2. Copyright

Copyright (c) 2011 Damian Nicholson. See LICENSE.txt for further details.

Previous:highercats