camdram 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6edbfc7097a8f95d7f0a34442d48863474cfb29114a116f2b2a23893a0c07fcf
-  data.tar.gz: 57f71a203bad215155983e349fb8b3d195fbe6ee2a6611c664de7c49fdb3a876
+  metadata.gz: 4cca1db57085086273a264020e522c5bce72095f0dbc1ffd903b90fb5596d51f
+  data.tar.gz: e16efd9e4684a2e8fd2640c9352550319edd1058298ebdd90bd312e3e7a4e8ad
 SHA512:
-  metadata.gz: 654228216deca94ca5b1638a870051be04077c4bb348e2216c6d3026e4d058437fb6f7fae50d01f4fea8edb317d0ace41c6c80b54a5b9e76e8527f690718b83f
-  data.tar.gz: 2084f7ccde4b4f62b3e9ddca41f849a12494bb113cc63ada2f7b8d6f2c0137022ae2965c04d1112a45d7a7eef6a3aa5950ae5acbdd0e88a265d242316738b31d
+  metadata.gz: 2e479b753fc8f809143340414959c4d8378a509b3c9ea8267afa8bd17dd4ae9346de1e03b9d210b4522ae871a533f2c6f525f08c834da1f454a949961ac0a846
+  data.tar.gz: d9407c4319165ce7a71218e0e6482993de99f083978af6ac0cdbea62df21e437be474ddbef21b0969323ed6a6fb268048f27d1b752ad2e7c7dec5ed163c4c857

data/README.md

@@ -25,8 +25,12 @@ 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):
@@ -59,7 +63,7 @@ As a result of this policy, you can (and should) specify a dependency on this ge
 [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'
+spec.add_runtime_dependency 'camdram', '~> 1.1'
 ```
 
 ## Copyright

data/lib/camdram/client.rb

@@ -8,6 +8,7 @@ require 'camdram/venue'
 require 'camdram/person'
 require 'camdram/role'
 require 'camdram/search'
+require 'camdram/diary'
 
 module Camdram
   class Client
@@ -193,6 +194,29 @@ module Camdram
       split_object( response, Search )
     end
 
+    # Gets a diary object which contains an array of upcoming calendar events
+    #
+    # @return [Camdram::Diary] A Diary object.
+    def diary(start_date=nil, end_date=nil)
+      url = "/diary.json"
+      if start_date && end_date
+        url = "/diary/#{start_date}.json?end=#{end_date}"
+      end
+      response = get(url)
+      Diary.new(response)
+    end
+
+    # Gets a diary object which contains an array of events occuring in the given year/term
+    #
+    # @return [Camdram::Diary] A Diary object.
+    def termly_diary(year, term=nil)
+      url = "/diary/#{year}"
+      url << "/#{term}" if term
+      url << ".json"
+      response = get(url)
+      Diary.new(response)
+    end
+
     # Returns the program version that is currently running
     #
     # @return [String] The version of camdram-ruby that is currently running.

data/lib/camdram/diary.rb

@@ -0,0 +1,28 @@
+require 'camdram/base'
+require 'camdram/api'
+require 'camdram/event'
+
+module Camdram
+  class Diary < Base
+    include API
+    attr_accessor :events
+
+    # Instantiate a new Diary object from a JSON hash
+    #
+    # @param options [Hash] A single JSON hash with symbolized keys.
+    # @return [Camdram::Event] The new Diary object.
+    def initialize(options = {})
+      super(options)
+      @events = split_object( @events, Event ) unless @events.nil?
+    end
+
+    # Return a hash of the diary's attributes
+    #
+    # @return [Hash] Hash with symbolized keys.
+    def info
+      {
+        events: events,
+      }
+    end
+  end
+end

data/lib/camdram/event.rb

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

data/lib/camdram/version.rb

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

data/test/diary_tests.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class ClientTests < MiniTest::Unit::TestCase
+
+  # There is some real magic going on here. Not really sure why
+  # some of the shows have start dates of -0001. There is a
+  # special place reserved in hell for the data returned by the
+  # Camdram API.
+
+  def test_diary
+    diary = @client.diary("2005-01-01", "2005-01-02")
+    events = diary.events
+    assert_equal 6503, events.first.id
+    assert_equal 1840, events.first.show.id
+    assert_equal "ADC Theatre", events.first.venue.name
+    assert_equal 6577, events[2].id
+    assert_equal "1970-01-01T19:30:00+00:00", events[2].time
+    assert_equal 3899, events[2].show.id
+    assert_equal 90, events[2].venue.id
+  end
+
+  def test_termly_diary
+    diary = @client.termly_diary("2001", "summer-vacation")
+    events = diary.events
+    assert_equal 6455, events[0].id
+    assert_equal "2003-12-06T00:00:00+00:00", events[0].end_date
+    assert_equal 10, events[0].show.id
+    assert_equal "Alice in Wonderland", events[0].show.name
+    assert_equal 29, events[0].venue.id
+    assert_equal "ADC Theatre", events[0].venue.name
+    assert_equal 6503, events[1].id
+    assert_equal "2008-12-06T00:00:00+00:00", events[1].end_date
+    assert_equal 1840, events[1].show.id
+    assert_equal "Theseus and the Minotaur: ADC/Footlights Panto 2008", events[1].show.name
+    assert_equal 29, events[1].venue.id
+    assert_equal "ADC Theatre", events[1].venue.name
+  end
+end

data/test/user_tests.rb

@@ -35,13 +35,14 @@ class ClientTests < MiniTest::Unit::TestCase
     assert_equal "1002481303", org.twitter_id
   end
 
-  def test_user_venues
-    venue = @client.user.get_venues.first
-    assert_equal 29, venue.id
-    assert_equal "ADC Theatre", venue.name
-    assert_equal "ADC Theatre", venue.short_name
-    assert_equal "adc-theatre", venue.slug
-    assert_equal "33348320992", venue.facebook_id
-    assert_equal "36725639", venue.twitter_id
-  end
+  # This test requires being added as an ADC venue administrator on Camdram
+  # def test_user_venues
+  #   venue = @client.user.get_venues.first
+  #   assert_equal 29, venue.id
+  #   assert_equal "ADC Theatre", venue.name
+  #   assert_equal "ADC Theatre", venue.short_name
+  #   assert_equal "adc-theatre", venue.slug
+  #   assert_equal "33348320992", venue.facebook_id
+  #   assert_equal "36725639", venue.twitter_id
+  # end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camdram
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Charlie Jonas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-21 00:00:00.000000000 Z
+date: 2018-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -86,7 +86,9 @@ files:
 - lib/camdram/api.rb
 - lib/camdram/base.rb
 - lib/camdram/client.rb
+- lib/camdram/diary.rb
 - lib/camdram/error.rb
+- lib/camdram/event.rb
 - lib/camdram/http.rb
 - lib/camdram/image.rb
 - lib/camdram/news.rb
@@ -100,6 +102,7 @@ files:
 - lib/camdram/venue.rb
 - lib/camdram/version.rb
 - test/client_tests.rb
+- test/diary_tests.rb
 - test/search_tests.rb
 - test/test_helper.rb
 - test/user_tests.rb
@@ -129,6 +132,7 @@ specification_version: 4
 summary: A lovely API wrapper for Camdram written in Ruby
 test_files:
 - test/client_tests.rb
+- test/diary_tests.rb
 - test/search_tests.rb
 - test/test_helper.rb
 - test/user_tests.rb