camdram 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c2b1b9f4b4a02b60dc3750550b00d07a16a455444e1bfc74fcef028e62349449
+  data.tar.gz: '082194f0d673dbb8d66cd5ad526a351ba95797b51e233d470a78514e2213b30a'
+SHA512:
+  metadata.gz: 71020471188f7f710e26bb33b7cc1fbe302425dfb44d0c4c205d8d2bd0cf757021a5a4b024c50b8057ede2f09ad23d40e03656260d484912697c97ffd8bd3230
+  data.tar.gz: 0fea40b931b49d84e7cd70d00bae9ec693084ff592f0eb915942756e88a05408b922374720eebc3812b76cb9b58565fe3022f1d6dd4872697390d722866ba0ca

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--protected
+--markup markdown
+-
+LICENSE
+README

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Charlie Jonas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# The Camdram Ruby Gem
+
+Camdram-ruby is an API wrapper & interface for [Camdram](https://www.camdram.net) 🎭 that's made with love ❤️ and written in Ruby 💎.
+
+## Quick Start
+Any of the lines inside the config block can be omitted.
+```ruby
+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](https://yardoc.org) and is available to view on
+[RubyDocs](https://www.rubydoc.info/github/CHTJonas/camdram-ruby).
+
+## Usage Examples
+Just some of the things you can do after configuring a `client` object:
+```ruby
+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[0].name
+client.user.get_orgs[0].twitter_id
+```
+
+These public actions don't require an API key (although you are still strongly advised to use one anyway):
+```ruby
+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](http://semver.org/).
+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](http://guides.rubygems.org/patterns/#pessimistic-version-constraint) with two digits of precision.
+For example:
+```ruby
+spec.add_runtime_dependency 'camdram', '~> 1.0'
+```
+
+## Copyright
+Copyright (c) 2018 Charlie Jonas.
+See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,20 @@
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Unit test tasks
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = Dir.glob("test/*_tests.rb").sort
+  t.verbose = false
+  t.warning = false
+end
+
+# RubyGems tasks
+require 'camdram/version'
+task :build do
+  system "gem build camdram-ruby"
+end
+task :release => :build do
+  system "gem push camdram-#{Camdram::VERSION}.gem"
+end

data/camdram-ruby.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'camdram/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'camdram'
+  s.version       = Camdram::VERSION
+  s.license       = 'MIT'
+  s.summary       = 'A lovely API wrapper for Camdram written in Ruby'
+  s.description   = 'This gem acts as a convenient wrapper around the public API provided by a Camdram installation. See GitHub for a brief overview of available functionality and RubyDocs for more complete documentation.'
+  s.authors       = ['Charlie Jonas']
+  s.email         = ['devel@charliejonas.co.uk']
+  s.homepage      = 'https://github.com/CHTJonas/camdram-ruby'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'json', '~> 2.1'
+  s.add_dependency 'minitest', '~> 5.11'
+  s.add_development_dependency 'bundler', '~> 1.5'
+  s.add_development_dependency 'rake', '~> 12.3'
+end

data/lib/camdram.rb

@@ -0,0 +1 @@
+require 'camdram/client'

data/lib/camdram/api.rb

@@ -0,0 +1,63 @@
+require 'json'
+require 'camdram/http'
+
+module Camdram
+  module API
+    attr_accessor :http
+
+    # Instantiate a new object
+    #
+    # @param options [Hash] A single JSON hash with symbolized keys.
+    # @param http [Camdram:HTTP] The HTTP class to which requests are sent.
+    # @return [Object] The newly instantiated object.
+    def initialize(options = {}, http = nil)
+      super(options)
+      @http = http
+    end
+
+    # Update the object
+    #
+    # @return [Object] The object the method is called on.
+    # @note The object this method is called on is updated 'in place'.
+    def update!
+      json = get(self.url_slug)
+      self.send(:initialize, json, @http)
+      return self
+    end
+
+    private
+
+    # Send a HTTP get request and parse the returned JSON
+    #
+    # @param url_slug [String] The URL slug to send the HTTP get request to.
+    # @return [Hash] A hash parsed from the JSON response with symbolized keys.
+    def get(url_slug)
+      response = @http.get(url_slug, 3)
+      JSON.parse(response, symbolize_names: true)
+    end
+
+    # Return an array of objects of the given class
+    #
+    # @param slug [String] The URL slug to send the HTTP get request to.
+    # @param object [Object] The class to instantiate.
+    # @return [Array] An array of objects of the specified class.
+    def get_array(url_slug, object)
+      json = get(url_slug)
+      split_object(json, object)
+    end
+
+    # Split a JSON array into a Ruby array of object of the specified class
+    #
+    # @param json [Array] The JSON array to itterate through.
+    # @param object [Object] The class to instantiate.
+    # @return [Array] An array of objects of the specified class.
+    def split_object(json, object)
+      objects = Array.new
+      json.each do |obj|
+        objects << object.new( obj, @http )
+      end
+      return objects
+    end
+
+  end
+end

data/lib/camdram/base.rb

@@ -0,0 +1,28 @@
+require 'camdram/http'
+
+module Camdram
+  class Base
+    attr_reader :id
+
+    # Instantiate a new object from a JSON hash
+    #
+    # @param options [Hash] A single JSON hash with symbolized keys.
+    # @return [Object] The new object.
+    def initialize(options = {})
+      set_from_hash(options)
+    end
+
+    private
+
+    # Sets the object's instance variables from a JSON hash
+    #
+    # @param options [Hash] A single JSON hash with symbolized keys.
+    def set_from_hash(options)
+      options.each do |key, value|
+        # Only set the instance variable if the class or sub-class
+        # has an associated attr_accessor for that variable
+        instance_variable_set("@#{key}", value) if self.respond_to?(key)
+      end
+    end
+  end
+end

data/lib/camdram/client.rb

@@ -0,0 +1,230 @@
+require 'camdram/api'
+require 'camdram/error'
+require 'camdram/version'
+require 'camdram/user'
+require 'camdram/show'
+require 'camdram/organisation'
+require 'camdram/venue'
+require 'camdram/person'
+require 'camdram/role'
+require 'camdram/search'
+
+module Camdram
+  class Client
+    include API
+    attr_reader :api_token
+
+    # Initializes a new Client object using a block
+    #
+    # @return [Camdram::Client] The top-level Camdram client.
+    def initialize
+      if !block_given?
+        warn 'Camdram::Client instantiated without config block - did you mean to add an API key?'
+      else
+        yield(self)
+      end
+    end
+
+    # Returns true if the API access token is set
+    #
+    # @return [Boolean] Whether the API token is set or not.
+    def api_token?
+      !@api_token.nil? && !(blank?(@api_token))
+    end
+
+    # Sets the API access token
+    #
+    # @param token [String] The access token used to authenticate API calls.
+    # @return [String] The token itself.
+    def api_token=(token)
+      @http.api_token = token if !@http.nil?
+      @api_token = token
+    end
+
+    # Returns the API URL that each HTTP request is sent to
+    #
+    # @return [String] The API hostname to send requests to.
+    def base_url
+      @base_url ||= Camdram::BASE_URL
+    end
+
+    # Sets the API URL that each HTTP request is sent to
+    #
+    # @param url [String] The API hostname to send requests to.
+    # @return [String] The url itself.
+    def base_url=(url)
+      @http.base_url = url if !@http.nil?
+      @base_url = url
+    end
+
+    # Returns the user agent header sent in each HTTP request
+    #
+    # @return [String] The user agent header to send with HTTP requests.
+    def user_agent
+      @user_agent ||= "Camdram Ruby v#{Camdram::VERSION}"
+    end
+
+    # Sets the user agent header sent in each HTTP request
+    #
+    # @param agent [String] The user agent header to send with HTTP requests.
+    # @return [String] The agent string itself.
+    def user_agent=(agent)
+      @http.user_agent = agent if !@http.nil?
+      @user_agent = agent
+    end
+
+    # Returns the user associated with the API token if set, otherwise raises an exception
+    #
+    # @raise [StandardError] Error raised when the API token is not set.
+    # @return [Camdram::User] The associated User object.
+    def user
+      http_construct
+      slug = "/auth/account.json"
+      response = get(slug)
+      User.new(response, @http)
+    end
+
+    # Lookup a show by its ID or slug
+    #
+    # @param id [Integer] The numeric ID of the show.
+    # @param id [String] The slug of the show.
+    # @raise [ArgumentError] Error raised when an integer or string is not provided.
+    # @return [Camdram::Show] The show with the provided ID or slug.
+    def get_show(id)
+      http_construct(false)
+      url = nil
+      if id.is_a? Integer
+        url = "#{Show.url}/by-id/#{id}.json"
+      elsif id.is_a? String
+        url = "#{Show.url}/#{id}.json"
+      else
+        raise ArgumentError.new 'id must be an integer, or slug must be a string'
+      end
+      response = get(url)
+      return Show.new(response, @http)
+    end
+
+    # Lookup an organisation by its ID or slug
+    #
+    # @param id [Integer] The numeric ID of the organisation.
+    # @param id [String] The slug of the organisation.
+    # @raise [ArgumentError] Error raised when an integer or string is not provided.
+    # @return [Camdram::Organisation] The organisation with the provided ID or slug.
+    def get_org(id)
+      http_construct(false)
+      url = nil
+      if id.is_a? Integer
+        url = "#{Organisation.url}/by-id/#{id}.json"
+      elsif id.is_a? String
+        url = "#{Organisation.url}/#{id}.json"
+      else
+        raise ArgumentError.new 'id must be an integer, or slug must be a string'
+      end
+      response = get(url)
+      Organisation.new(response, @http)
+    end
+
+    # Lookup a venue by its ID or slug
+    #
+    # @param id [Integer] The numeric ID of the venue.
+    # @param id [String] The slug of the venue.
+    # @raise [ArgumentError] Error raised when an integer or string is not provided.
+    # @return [Camdram::Venue] The venue with the provided ID or slug.
+    def get_venue(id)
+      http_construct(false)
+      url = nil
+      if id.is_a? Integer
+        url = "#{Venue.url}/by-id/#{id}.json"
+      elsif id.is_a? String
+        url = "#{Venue.url}/#{id}.json"
+      else
+        raise ArgumentError.new 'id must be an integer, or slug must be a string'
+      end
+      response = get(url)
+      Venue.new(response, @http)
+    end
+
+    # Lookup a person by their ID or slug
+    #
+    # @param id [Integer] The numeric ID of the person.
+    # @param id [String] The person's slug.
+    # @raise [ArgumentError] Error raised when an integer or string is not provided.
+    # @return [Camdram::Person] The person  with the provided ID or slug.
+    def get_person(id)
+      http_construct(false)
+      url = nil
+      if id.is_a? Integer
+        url = "#{Person.url}/by-id/#{id}.json"
+      elsif id.is_a? String
+        url = "#{Person.url}/#{id}.json"
+      else
+        raise ArgumentError.new 'id must be an integer, or slug must be a string'
+      end
+      response = get(url)
+      Person.new(response, @http)
+    end
+
+    # Returns an array of all registered organisations
+    #
+    # @return [Array] An array of Organisation objects.
+    def get_orgs
+      http_construct(false)
+      url = "#{Organisation.url}.json"
+      response = get(url)
+      split_object( response, Organisation )
+    end
+
+    # Returns an array of all registered venues
+    #
+    # @return [Array] An array of Venue objects.
+    def get_venues
+      http_construct(false)
+      url = "#{Venue.url}.json"
+      response = get(url)
+      split_object( response, Venue )
+    end
+
+    # Returns an array containing a sample of people taking part in shows this week
+    #
+    # @return [Array] An array of Role objects.
+    def get_people
+      http_construct(false)
+      url = "#{Person.url}.json"
+      response = get(url)
+      split_object( response, Role )
+    end
+
+    # Return an array of search entity results based on a search string
+    #
+    # @param query [String] The query string to search with.
+    # @return [Array] An array of Search objects.
+    def search(query, limit=10, page=1)
+      http_construct(false)
+      url = "/search.json?q=#{query}&limit=#{limit}&page=#{page}"
+      response = get(url)
+      split_object( response, Search )
+    end
+
+  private
+
+    # Construct a class to handle HTTP requests if necessary
+    #
+    # @raise [StandardError] Error raised when the API token is not set.
+    def http_construct(check_for_token = true)
+      if !check_for_token || api_token?
+        # Create a new HTTP object if one doesn't already exist
+        @http ||= HTTP.new(@api_token, base_url, user_agent)
+      else
+        raise Camdram::Error::NoApiKey.new 'api_token is not set'
+      end
+    end
+
+    # Returns true if a given string is blank
+    #
+    # @param string [String] The string to test.
+    # @return [Boolean] True if blank, false otherwise.
+    def blank?(string)
+      string.respond_to?(:empty?) ? string.empty? : false
+    end
+  end
+end

data/lib/camdram/error.rb

@@ -0,0 +1,78 @@
+require 'json'
+
+module Camdram
+  module Error
+
+    # Error class raised when an API call is attempted but no API key is set
+    class NoApiKey < RuntimeError; end
+
+    # Error class for Camdram API calls
+    class CamdramError < StandardError
+      attr_reader :http_status_code, :http_headers, :response_body
+      attr_reader :error, :error_description
+
+      def initialize(code, body, headers)
+        @http_status_code = code
+        @response_body = body
+        @http_headers = headers
+
+        # Camdram doesn't always return errors in JSON format
+        # and when it does, the format is sometimes inconsistent
+        begin
+          error_hash = JSON.parse(@response_body)
+          @error = error_hash['error']
+          @error_description = error_hash['error_description']
+        rescue JSON::ParserError => e
+          # FIXME come up with a better solution for this
+          @error = http_status_code
+          @error_description = response_body
+        end
+        message = "#{error}: #{error_description}"
+        super(message)
+        raise self
+      end
+    end
+
+    # 3xx level errors
+    class RedirectError < CamdramError; end
+    # 4xx level errors
+    class ClientError < CamdramError; end
+    # 5xx level errors
+    class ServerError < CamdramError; end
+    # 400
+    class BadRequest < ClientError; end
+    # 403
+    class Forbidden < ClientError; end
+    # 404
+    class NotFound < ClientError; end
+    # 401
+    class Unauthorized < ClientError; end
+    # 429
+    class RateLimit < ClientError; end
+
+    # This is called by the HTTP class when a request
+    # is not successful and is not a redirect
+    def self.for(response)
+      code = response.code.to_i
+      error_class = case code
+                    when 300..399
+                      RedirectError
+                    when 400
+                      BadRequest
+                    when 403
+                      Forbidden
+                    when 404
+                      NotFound
+                    when 401
+                      Unauthorized
+                    when 429
+                      RateLimit
+                    when 400..499
+                      ClientError
+                    else
+                      CamdramError
+                    end
+      error_class.new(code, response.body, response.header)
+    end
+  end
+end

data/lib/camdram/http.rb

@@ -0,0 +1,64 @@
+require 'net/http'
+require 'camdram/error'
+
+module Camdram
+  class HTTP
+    attr_writer :api_token, :base_url, :user_agent
+
+    # Initializes a new HTTP object
+    #
+    # @param api_token [String] The API token to use to authenticate requests.
+    # @param base_url [String] The API hostname to use when sending API requests.
+    # @param user_agent [String] The User-Agent header to send to the server.
+    # @return [Camdram::HTTP]
+    def initialize(api_token, base_url, user_agent)
+      @api_token = api_token
+      @base_url = base_url
+      @user_agent = user_agent
+    end
+
+    # Sends a HTTP-get request to the Camdram API
+    #
+    # @param url_slug [String] The URL slug to send the request to.
+    # @param max_redirects [Integer] The maximum number of redirects.
+    # @raise [Camdram::Error::RedirectError] Error raised when too many redirects occur.
+    # @return [String]
+    def get(url_slug, max_redirects = 10)
+      url = @base_url + url_slug
+      uri = URI(url)
+      inner_get(uri, max_redirects)
+    end
+
+    private
+      def inner_get(uri, max_redirects)
+        # Raise an exception if we enter a redirect loop
+        if max_redirects == 0
+          new Error::RedirectError(310, 'Too many redirects', nil)
+        end
+
+        response = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => true) {|http|
+          request = Net::HTTP::Get.new(uri)
+          request['Authorization'] = "Bearer #{@api_token}" if !@api_token.nil?
+          request['User-Agent'] = @user_agent if !@user_agent.nil?
+          http.request(request)
+        }
+
+        case response
+        when Net::HTTPSuccess then
+          response.body
+        when Net::HTTPRedirection then
+          location = response['location']
+          warn "redirected to #{location}"
+          if location.start_with?('http')
+            # Handles full URL and external redirects
+            inner_get(URI(location), max_redirects - 1)
+          else
+            # Handles slug-based redirects
+            get(location, max_redirects - 1)
+          end
+        else
+          Error.for(response)
+        end
+      end
+  end
+end

data/lib/camdram/image.rb

@@ -0,0 +1,31 @@
+require 'camdram/base'
+require 'camdram/api'
+
+module Camdram
+  class Image < Base
+    include API
+    attr_accessor :filename, :created_at, :width, :height, :extension, :type
+
+    # Return a hash of the image's attributes
+    #
+    # @return [Hash] Hash with symbolized keys.
+    def info
+      {
+        id: id,
+        filename: filename,
+        created_at: created_at,
+        width: width,
+        height: height,
+        extension: extension,
+        type: type,
+      }
+    end
+
+    # Return the image URL
+    #
+    # @return [String] The image URL.
+    def url
+      "/media/cache/preview/#{filename}"
+    end
+  end
+end

data/lib/camdram/news.rb

@@ -0,0 +1,39 @@
+require 'camdram/base'
+require 'camdram/api'
+require 'camdram/organisation'
+require 'camdram/venue'
+
+module Camdram
+  class News < Base
+    include API
+    attr_accessor :entity, :remote_id, :source, :picture, :body, :posted_at, :created_at
+
+    # Instantiate a new News object from a JSON hash
+    #
+    # @param options [Hash] A single JSON hash with symbolized keys.
+    # @return [Camdram::News] The new News object.
+    def initialize(options = {}, http = nil)
+      super(options, http)
+      @entity = case @entity[:_type]
+        when "society" then Organisation.new( @entity, @http )
+        when "venue" then Venue.new( @entity, @http )
+      end if !@entity.nil?
+    end
+
+    # Return a hash of the news item's attributes
+    #
+    # @return [Hash] Hash with symbolized keys.
+    def info
+      {
+        id: id,
+        entity: entity,
+        remote_id: remote_id,
+        source: source,
+        picture: picture,
+        body: body,
+        posted_at: posted_at,
+        created_at: created_at,
+      }
+    end
+  end
+end

data/lib/camdram/organisation.rb

@@ -0,0 +1,68 @@
+require 'camdram/base'
+require 'camdram/api'
+require 'camdram/image'
+require 'camdram/news'
+require 'camdram/show'
+
+module Camdram
+  class Organisation < Base
+    include API
+    attr_accessor :name, :description, :image, :facebook_id, :twitter_id, :short_name, :slug
+
+    # Instantiate a new Organisation object from a JSON hash
+    #
+    # @param options [Hash] A single JSON hash with symbolized keys.
+    # @return [Camdram::Organisation] The new Organisation object.
+    def initialize(options = {}, http = nil)
+      super(options, http)
+      @image = Image.new( @image, @http ) if !@image.nil?
+    end
+
+    # Return a hash of the organisation's attributes
+    #
+    # @return [Hash] Hash with symbolized keys.
+    def info
+      {
+        id: id,
+        name: name,
+        description: description,
+        facebook_id: facebook_id,
+        twitter_id: twitter_id,
+        short_name: short_name,
+        slug: slug,
+      }
+    end
+
+    # Gets an array of the organisation's news items
+    #
+    # @return [Array] An array of News objects.
+    def news
+      news_url = "#{self.class.url}/#{slug}/news.json"
+      response = get(news_url)
+      split_object( response, News )
+    end
+
+    # Gets an array of the organisation's upcoming shows
+    #
+    # @return [Array] An array of Show objects.
+    def shows
+      shows_url = "#{self.class.url}/#{slug}/shows.json"
+      response = get(shows_url)
+      split_object( response, Show )
+    end
+
+    # Returns the URL+slug of the organisation
+    #
+    # @return [String] The full URL and slug.
+    def url_slug
+      "#{self.class.url}/#{slug}.json"
+    end
+
+    # Returns the URL stub assocaited with all organisations
+    #
+    # @return [String] The URL stub.
+    def self.url
+      '/societies'
+    end
+  end
+end

data/lib/camdram/performance.rb

@@ -0,0 +1,31 @@
+require 'camdram/base'
+require 'camdram/api'
+require 'camdram/venue'
+
+module Camdram
+  class Performance < Base
+    include API
+    attr_accessor :start_date, :end_date, :time, :venue, :other_venue
+
+    # Instantiate a new Performance object from a JSON hash
+    #
+    # @param options [Hash] A single JSON hash with symbolized keys.
+    # @return [Camdram::Performance] The new Performance object.
+    def initialize(options = {}, http = nil)
+      super(options, http)
+      @venue = Venue.new( @venue, @http ) if !@venue.nil?
+    end
+
+    # Return a hash of the performance's attributes
+    #
+    # @return [Hash] Hash with symbolized keys.
+    def info
+      {
+        start_date: start_date,
+        end_date: end_date,
+        time: time,
+        other_venue: other_venue,
+      }
+    end
+  end
+end

data/lib/camdram/person.rb

@@ -0,0 +1,34 @@
+require 'camdram/base'
+require 'camdram/api'
+
+module Camdram
+  class Person < Base
+    include API
+    attr_accessor :name, :slug
+
+    # Return a hash of the person's attributes
+    #
+    # @return [Hash] Hash with symbolized keys.
+    def info
+      {
+        id: id,
+        name: name,
+        slug: slug,
+      }
+    end
+
+    # Returns the URL+slug of the person
+    #
+    # @return [String] The full URL and slug.
+    def url_slug
+      "#{self.class.url}/#{slug}.json"
+    end
+
+    # Returns the URL stub assocaited with all people
+    #
+    # @return [String] The URL stub.
+    def self.url
+      '/people'
+    end
+  end
+end

data/lib/camdram/role.rb

@@ -0,0 +1,36 @@
+require 'camdram/base'
+require 'camdram/api'
+require 'camdram/show'
+require 'camdram/person'
+
+module Camdram
+  class Role < Base
+    attr_accessor :person_name, :person_slug, :type, :role, :order, :show, :person
+
+    # Instantiate a new Role object from a JSON hash
+    #
+    # @param options [Hash] A single JSON hash with symbolized keys.
+    # @return [Camdram::Role] The new Role object.
+    def initialize(options = {}, http = nil)
+      super(options)
+      @show = Show.new( @show, http ) if !@show.nil?
+      @person = Person.new( @person, http ) if !@person.nil?
+    end
+
+    # Return a hash of the roles's attributes
+    #
+    # @return [Hash] Hash with symbolized keys.
+    def info
+      {
+        person_name: person_name,
+        person_slug: person_slug,
+        id: id,
+        type: type,
+        role: role,
+        order: order,
+        show: show,
+        person: person,
+      }
+    end
+  end
+end

data/lib/camdram/search.rb

@@ -0,0 +1,43 @@
+require 'camdram/base'
+require 'camdram/api'
+require 'camdram/show'
+require 'camdram/organisation'
+require 'camdram/venue'
+require 'camdram/person'
+
+module Camdram
+  class Search < Base
+    include API
+    attr_accessor :name, :slug, :start_at, :rank, :entity_type
+
+    # Return the correct Ruby object referenced by the search entity
+    #
+    # @return [Object] The Ruby object that is referenced by the search entity.
+    def entity
+      cls = nil
+      case entity_type
+        when "show" then cls = Show
+        when "society" then cls = Organisation
+        when "venue" then cls = Venue
+        when "person" then cls = Person
+      end
+      url = "#{cls.url}/#{slug}.json"
+      response = get(url)
+      return cls.new(response, @http)
+    end
+
+    # Return a hash of the search entity's attributes
+    #
+    # @return [Hash] Hash with symbolized keys.
+    def info
+      {
+        name: name,
+        slug: slug,
+        start_at: start_at,
+        rank: rank,
+        id: id,
+        entity_type: entity_type,
+      }
+    end
+  end
+end

data/lib/camdram/show.rb

@@ -0,0 +1,71 @@
+require 'camdram/base'
+require 'camdram/api'
+require 'camdram/organisation'
+require 'camdram/venue'
+require 'camdram/performance'
+require 'camdram/image'
+require 'camdram/role'
+
+module Camdram
+  class Show < Base
+    include API
+    attr_accessor :name, :description, :image, :slug, :author, :prices, :other_venue, :other_society, :category, :performances, :online_booking_url, :society, :venue
+
+    # Instantiate a new Show object from a JSON hash
+    #
+    # @param options [Hash] A single JSON hash with symbolized keys.
+    # @return [Camdram::Show] The new Show object.
+    def initialize(options = {}, http = nil)
+      super(options, http)
+      @society = Organisation.new( @society, @http ) if !@society.nil?
+      @venue = Venue.new( @venue, @http ) if !@venue.nil?
+      @performances = split_object( @performances, Performance ) if !@performances.nil?
+      @image = Image.new( @image, @http ) if !@image.nil?
+    end
+
+    # Gets an array of roles associated with the shows
+    #
+    # @return [Array] An array of Role objects.
+    def roles
+      roles_url = "#{self.class.url}/#{slug}/roles.json"
+      response = get(roles_url)
+      split_object( response, Role )
+    end
+
+    # Return a hash of the shows's attributes
+    #
+    # @return [Hash] Hash with symbolized keys.
+    def info
+      {
+        id: id,
+        name: name,
+        description: description,
+        image: image,
+        slug: slug,
+        author: author,
+        prices: prices,
+        other_venue: other_venue,
+        other_society: other_society,
+        category: category,
+        performances: performances,
+        online_booking_url: online_booking_url,
+        society: society,
+        venue: venue,
+      }
+    end
+
+    # Returns the URL+slug of the show
+    #
+    # @return [String] The full URL and slug.
+    def url_slug
+      "#{self.class.url}/#{slug}.json"
+    end
+
+    # Returns the URL stub assocaited with all shows
+    #
+    # @return [String] The URL stub.
+    def self.url
+      '/shows'
+    end
+  end
+end

data/lib/camdram/user.rb

@@ -0,0 +1,46 @@
+require 'camdram/base'
+require 'camdram/api'
+require 'camdram/show'
+require 'camdram/organisation'
+
+module Camdram
+  class User < Base
+    include API
+    attr_accessor :name, :email
+
+    # Return a hash of the user's attributes
+    #
+    # @return [Hash] Hash with symbolized keys.
+    def info
+      {
+        id: id,
+        name: name,
+        email: email,
+      }
+    end
+
+    # Return the unique Camdram URL slug of the user
+    #
+    # @return [String] The full URL slug.
+    def url_slug
+      "/auth/account.json"
+    end
+
+    # Return an array of shows the user is authorised for
+    #
+    # @return [Array] An array of Camdram::Show objects.
+    def get_shows
+      slug = "/auth/account/shows.json"
+      get_array(slug, Show)
+    end
+
+    # Return an array of societies the user is authorised for
+    #
+    # @return [Array] An array of Camdram::Organisation objects
+    def get_orgs
+      slug = "/auth/account/organisations.json"
+      get_array(slug, Organisation)
+    end
+
+  end
+end

data/lib/camdram/venue.rb

@@ -0,0 +1,62 @@
+require 'camdram/base'
+require 'camdram/api'
+require 'camdram/news'
+require 'camdram/show'
+
+module Camdram
+  class Venue < Base
+    include API
+    attr_accessor :name, :description, :facebook_id, :twitter_id, :short_name, :college, :slug, :address, :latitude, :longitude
+
+    # Return a hash of the venue's attributes
+    #
+    # @return [Hash] Hash with symbolized keys.
+    def info
+      {
+        id: id,
+        name: name,
+        description: description,
+        facebook_id: facebook_id,
+        twitter_id: twitter_id,
+        short_name: short_name,
+        college: college,
+        slug: slug,
+        address: address,
+        latitude: latitude,
+        longitude: longitude,
+      }
+    end
+
+    # Gets an array of the venue's news items
+    #
+    # @return [Array] An array of News objects.
+    def news
+      news_url = "#{self.class.url}/#{slug}/news.json"
+      response = get(news_url)
+      split_object( response, News )
+    end
+
+    # Gets an array of the venue's upcoming shows
+    #
+    # @return [Array] An array of Show objects.
+    def shows
+      shows_url = "#{self.class.url}/#{slug}/shows.json"
+      response = get(shows_url)
+      split_object( response, Show )
+    end
+
+    # Returns the URL+slug of the venue
+    #
+    # @return [String] The full URL and slug.
+    def url_slug
+      "#{self.class.url}/#{slug}.json"
+    end
+
+    # Returns the URL stub assocaited with all venues
+    #
+    # @return [String] The URL stub.
+    def self.url
+      '/venues'
+    end
+  end
+end

data/lib/camdram/version.rb

@@ -0,0 +1,4 @@
+module Camdram
+  VERSION = '1.0.0'
+  BASE_URL = 'https://www.camdram.net'
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+require 'camdram/client'
+
+raise "API test key is not set!" if !ENV["API_test_key"]
+
+class MiniTest::Unit::TestCase
+  def setup
+    @client = Camdram::Client.new do |config|
+      config.api_token = ENV["API_test_key"]
+    end
+  end
+end

data/test/user_tests.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class UserTests < MiniTest::Unit::TestCase
+  def test_user
+    user = @client.user
+    assert_equal 3807, user.id
+    assert_equal "Charlie Jonas", user.name
+    assert_equal "charlie@charliejonas.co.uk", user.email
+  end
+
+  def test_get_shows
+    user = @client.user
+    show = user.get_shows.first
+    assert_equal 6514, show.id
+    assert_equal "This show is a dummy used by Camdram for testing purposes only.", show.description
+    assert_equal "5b58b83bd534a.jpg", show.image.filename
+    assert_equal 1024, show.image.width
+    assert_equal "API Test 1", show.name
+    assert_equal "Camdram", show.other_society
+    assert_equal "ADC Theatre", show.other_venue
+    assert_equal 29, show.performances.first.venue.id
+    assert_equal "1997-api-test-1", show.slug
+    assert_equal 38, show.society.id
+    assert_equal "Camdram", show.society.name
+    assert_equal 29, show.venue.id
+    assert_equal "ADC Theatre", show.venue.name
+  end
+
+  def test_get_organisations
+    user = @client.user
+    org = user.get_orgs.first
+    assert_equal 38, org.id
+    assert_equal "Camdram", org.name
+    assert_equal "Camdram", org.short_name
+    assert_equal "camdram", org.slug
+    assert_equal "1002481303", org.twitter_id
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: camdram
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Charlie Jonas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: This gem acts as a convenient wrapper around the public API provided
+  by a Camdram installation. See GitHub for a brief overview of available functionality
+  and RubyDocs for more complete documentation.
+email:
+- devel@charliejonas.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".yardopts"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- camdram-ruby.gemspec
+- lib/camdram.rb
+- lib/camdram/api.rb
+- lib/camdram/base.rb
+- lib/camdram/client.rb
+- lib/camdram/error.rb
+- lib/camdram/http.rb
+- lib/camdram/image.rb
+- lib/camdram/news.rb
+- lib/camdram/organisation.rb
+- lib/camdram/performance.rb
+- lib/camdram/person.rb
+- lib/camdram/role.rb
+- lib/camdram/search.rb
+- lib/camdram/show.rb
+- lib/camdram/user.rb
+- lib/camdram/venue.rb
+- lib/camdram/version.rb
+- test/test_helper.rb
+- test/user_tests.rb
+homepage: https://github.com/CHTJonas/camdram-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A lovely API wrapper for Camdram written in Ruby
+test_files:
+- test/test_helper.rb
+- test/user_tests.rb