capitan 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012, The Pittsburgh Cultural Trust
+
+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

@@ -0,0 +1,60 @@
+Capitan
+=======
+
+Capitan is a Ruby plugin built to serve as a connector to Culturaldistrict.org through its API. cAPI provides read-only access to show listings and details, as well a as a monthly calendar feed. All responses are returned as JSON. Capitan handles the connection to cAPI, and serializes all JSON responses for use in your site.
+
+An API key is required. To receive on, contact us at helpdesk@cuturaldistrict.org
+
+Once received, the API key must be placed in your config.yml file as:
+
+capitan:
+  api_key: API_KEY
+
+
+Shows
+======
+
+Capitan divides shows into three types:
+- Productions (Shows with that are ticketed.)
+- Non-Ticketed Events (Shows that are not ticketed.)
+- Exhibitions (Installations and galleries that are open long-term.)
+
+Each of these show types can be searched through the Show object, and a type can be passed to restrict what's returned.
+Available types: ("all", "productions", "events", "exhibitions")
+
+Shows can also be searched based on a variety of criteria.
+
+Search parameters:
+min_date
+max_date
+product_line
+genre
+title
+venue
+description
+organization_id
+
+Example
+======
+
+For all shows:
+shows = Capitan::Shows.all()
+
+For all Non-Ticketed Events:
+shows = Capitan::Shows.all('events')
+
+For all Productions Before December 31, 2013 in the Jazz genre:
+ shows = Capitan::Shows.find('productions', {max_date="12/31/2013", genre="Jazz"})
+
+
+Calendar
+=======
+
+Events returned as a structured calendar can also be returned.
+
+Example
+=======
+month = Capitan::Calendar::Monthly.new(year, month)
+
+
+Copyright (c) 2012 The Pittsburgh Cultural Trust, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the capitan plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the capitan plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Capitan'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/capitan.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "capitan"
+
+Gem::Specification.new do |s|
+  s.name        = "capitan"
+  s.version     = '1.0.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Eric Sipple"]
+  s.email       = ["sipple@trustarts.org"]
+  s.homepage    = "https://github.com/pgharts/capitan/"
+  s.summary     = %q{Interface for culturaldistrict.org's read-only API}
+  s.description = %q{Culturaldistrict.org provides access to all events through cAPI, and capitan can get that data for you.}
+
+  s.add_dependency 'rest-client'
+
+  ignores = if File.exist?('.gitignore')
+              File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }
+            else
+              []
+            end
+  s.files         = Dir['**/*'] - ignores
+  s.test_files    = Dir['test/**/*','spec/**/*','features/**/*'] - ignores
+  # s.executables   = Dir['bin/*'] - ignores
+  s.require_paths = ["lib"]
+end

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here'
+require 'capitan'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/capitan.rb

@@ -0,0 +1,4 @@
+module Capitan
+
+
+end

data/lib/capitan/calendar/calendar_show.rb

@@ -0,0 +1,25 @@
+module Capitan
+  module Calendar
+    class CalendarShow
+      include Capitan::ObjectInitializer
+
+      attr_accessor :presenter_name, :capi_show_detail_url, :show_detail_url, :title, :venue,
+                    :date, :show_type, :calendar_text, :buy_tickets_url
+
+      def show_type_class
+        klass = nil
+        klass = Capitan::Production if show_type == 'Production'
+        klass = Capitan::NonTicketedEvent if show_type == 'Non-Ticketed Event'
+        klass = Capitan::Exhibition if show_type == 'Exhibition'
+        klass
+      end
+
+      def get_detail
+        connection = Capitan::Connection.new
+        response = connection.invoke_with_full_url(capi_show_detail_url)
+        show_type_class.new(response)
+      end
+
+    end
+  end
+end

data/lib/capitan/calendar/day.rb

@@ -0,0 +1,24 @@
+module Capitan
+  module Calendar
+    class Day
+
+      attr_accessor :day, :shows
+
+      def initialize(day_hash)
+        @day = Date.parse(day_hash['day'])
+        @shows = process_shows(day_hash['shows'])
+      end
+
+      private
+
+      def process_shows(shows_hash)
+        shows = []
+        shows_hash.each do |show|
+          shows << Capitan::Calendar::CalendarShow.new(show)
+        end
+        shows
+      end
+
+    end
+  end
+end

data/lib/capitan/calendar/monthly.rb

@@ -0,0 +1,33 @@
+module Capitan
+  module Calendar
+
+    class Monthly
+
+      attr_reader :month, :year, :weeks
+
+      def initialize(year, month)
+        url = "calendar/monthly/#{year}/#{month}"
+        connection = Capitan::Connection.new
+        response = connection.invoke_with_path(url)
+        process_response(response)
+      end
+
+      private
+
+      def process_response(response)
+        @month = response['month']
+        @year = response['year']
+        @weeks = process_weeks(response['weeks'])
+      end
+
+      def process_weeks(weeks_hash)
+        weeks = []
+        weeks_hash.each do |week|
+          weeks << Capitan::Calendar::Week.new(week)
+        end
+        weeks
+      end
+
+    end
+  end
+end

data/lib/capitan/calendar/week.rb

@@ -0,0 +1,25 @@
+module Capitan
+  module Calendar
+    class Week
+
+      attr_reader :week, :days
+
+      def initialize(week_hash)
+        @week = week_hash['week']
+        @days = process_days(week_hash['days'])
+      end
+
+
+      private
+
+      def process_days(days_hash)
+        days = []
+        days_hash.each do |day|
+          days << Capitan::Calendar::Day.new(day)
+        end
+        days
+      end
+
+    end
+  end
+end

data/lib/capitan/connection.rb

@@ -0,0 +1,54 @@
+class Capitan::Connection
+  require 'rest_client'
+  require 'json'
+
+  def initialize
+    @config = load_config_file
+  end
+
+  def invoke_with_path(url, params = {})
+    params[:api_key] = api_key
+    response = get_response("#{base_url}/#{url}?#{hash_to_querystring(params)}")
+    JSON.parse(response)
+  end
+
+  def invoke_with_full_url(url, params = {})
+    params[:api_key] = api_key
+    response = get_response("#{url}?#{hash_to_querystring(params)}")
+    JSON.parse(response)
+  end
+
+  private
+
+  def get_response(url)
+
+    Rails.cache.fetch(url) do
+      RestClient.get(url)
+    end
+
+  rescue RestClient::Unauthorized, SocketError => error
+    capitan_error = Capitan::Exceptions::ConnectionError.new(error)
+    capitan_error.set_backtrace(error.backtrace)
+    raise capitan_error
+  end
+
+  def base_url
+    @config["capitan"]["base_url"]
+  end
+
+  def api_key
+    @config["capitan"]["api_key"]
+  end
+
+  def load_config_file
+    YAML.load_file("#{Rails.root}/config/config.yml")[Rails.env]
+  end
+
+  def hash_to_querystring(hash)
+    hash.keys.inject('') do |query_string, key|
+      query_string << '&' unless key == hash.keys.first
+      query_string << "#{URI.encode(key.to_s)}=#{URI.encode(hash[key])}"
+    end
+  end
+
+end

data/lib/capitan/exceptions/connection_error.rb

@@ -0,0 +1,20 @@
+class Capitan::Exceptions::ConnectionError < StandardError
+
+  def initialize(error)
+    message = error.message
+    message = socket_error_message if error.class == SocketError
+    message = unauthorized_message if error.class == RestClient::Unauthorized
+    super(message)
+  end
+
+  private
+
+  def socket_error_message
+    "Unable to connect to CAPI. Be sure that you have the correct base_url set in config.yml."
+  end
+
+  def unauthorized_message
+    "Invalid API key. Make sure a valid key is set for api_key in config.yml."
+  end
+
+end

data/lib/capitan/exhibition.rb

@@ -0,0 +1,20 @@
+class Capitan::Exhibition
+
+include Capitan::ObjectInitializer
+include Capitan::ShowMethods
+
+  attr_accessor :title, :production_name, :presenter_name, :presenter_phone,
+              :production_id, :slug, :genre, :keywords, :display_on_district_calendar,
+              :display_on_org_calendar, :status_id, :ticket_prices,
+              :organization_id, :updated_at, :error, :show_detail_url, :buy_tickets_url,
+              :group_sales_url, :season, :calendar_text, :description, :start_date,
+              :end_date, :show_type, :thumbnail_image_url, :main_image_url, :capi_show_detail_url
+
+
+  def self.get(id)
+    connection = Capitan::Connection.new
+    response = connection.invoke_with_path("exhibition/#{id}")
+    Capitan::Exhibition.new(response)
+  end
+
+end

data/lib/capitan/non_ticketed_event.rb

@@ -0,0 +1,20 @@
+class Capitan::NonTicketedEvent
+
+include Capitan::ObjectInitializer
+include Capitan::ShowMethods
+
+  attr_accessor :title, :production_name, :presenter_name, :presenter_phone,
+              :production_id, :slug, :genre, :keywords, :display_on_district_calendar,
+              :display_on_org_calendar, :status_id, :ticket_prices,
+              :organization_id, :updated_at, :error, :show_detail_url, :buy_tickets_url,
+              :group_sales_url, :season, :calendar_text, :description, :start_date,
+              :end_date, :show_type, :thumbnail_image_url, :main_image_url, :capi_show_detail_url
+
+
+  def self.get(id)
+    connection = Capitan::Connection.new
+    response = connection.invoke_with_path("event/#{id}")
+    Capitan::NonTicketedEvent.new(response)
+  end
+
+end

data/lib/capitan/object_initializer.rb

@@ -0,0 +1,15 @@
+module Capitan
+  module ObjectInitializer
+    def initialize(hash = {})
+      @errors = []
+      hash.each do |key, value|
+        begin
+          send("#{key}=", value)
+        # If something passed in the API isn't defined for our model, log it and move on.
+        rescue NoMethodError => error
+          next
+        end
+      end
+    end
+  end
+end

data/lib/capitan/performance.rb

@@ -0,0 +1,10 @@
+class Capitan::Performance
+  include Capitan::ObjectInitializer
+  include Capitan::ShowMethods
+
+  attr_accessor :start_date, :end_date, :created_at, :updated_at, :notes, :restaurant_performance_id,
+                :parking_performance_id, :venue_id, :date, :id, :production_page_id,
+                :mode_of_sale, :on_sale, :non_ticketed_event_page_id
+
+
+end

data/lib/capitan/production.rb

@@ -0,0 +1,21 @@
+class Capitan::Production
+
+  include Capitan::ObjectInitializer
+  include Capitan::ShowMethods
+
+  attr_accessor :title, :production_name, :presenter_name, :presenter_phone,
+              :production_id, :slug, :genre, :keywords, :display_on_district_calendar,
+              :display_on_org_calendar, :status_id, :ticket_prices,
+              :organization_id, :updated_at, :error, :show_detail_url, :buy_tickets_url,
+              :group_sales_url, :season, :calendar_text, :description, :start_date,
+              :end_date, :show_type, :thumbnail_image_url, :main_image_url,
+              :capi_show_detail_url
+
+
+  def self.get(id)
+    connection = Capitan::Connection.new
+    response = connection.invoke_with_path("production/#{id}")
+    Capitan::Production.new(response)
+  end
+
+end

data/lib/capitan/show_methods.rb

@@ -0,0 +1,29 @@
+module Capitan
+  module ShowMethods
+    def performances
+      @production_performances || []
+    end
+
+    def venue
+      @production_venue
+    end
+
+    def performances=(performances_json)
+      perfs = []
+      performances_json.each do |performance_json|
+        perfs << Capitan::Performance.new(performance_json)
+      end
+      @production_performances = perfs
+    end
+
+    def venue=(venue_hash)
+      @production_venue = Capitan::Venue.new(venue_hash)
+    end
+
+    def alphabetical_title
+      return "#{@title.gsub(/^The /, '')}, The" if @title.match(/^The /)
+      @title
+    end
+
+  end
+end

data/lib/capitan/shows.rb

@@ -0,0 +1,48 @@
+class Capitan::Shows
+
+  def self.all(type = 'all')
+    connection = Capitan::Connection.new
+    response = connection.invoke_with_path("shows/#{type}")
+    process_response(response)
+  end
+
+  def self.find(type, params)
+    connection = Capitan::Connection.new
+    response = connection.invoke_with_path("shows/search/#{search_type(type)}", params)
+    process_response(response)
+  end
+
+  def self.types
+    {
+      :all => 'all',
+      :productions => 'productions',
+      :non_ticketed_events => 'events',
+      :exhibitions => 'exhibitions'
+    }
+
+  end
+
+  private
+
+  def self.search_type(type)
+    return "" if type == "all"
+    type
+  end
+
+  def self.process_response(response_hash)
+    shows = []
+    response_hash.each do |show|
+      shows << process_show(show)
+    end
+    shows
+  end
+
+  def self.process_show(show_hash)
+    show = nil
+    show = Capitan::Production.new(show_hash) if show_hash['show_type'] == "Production"
+    show = Capitan::NonTicketedEvent.new(show_hash) if show_hash['show_type'] == "Non-Ticketed Event"
+    show = Capitan::Exhibition.new(show_hash) if show_hash['show_type'] == "Exhibition"
+    show
+  end
+
+end

data/lib/capitan/venue.rb

@@ -0,0 +1,7 @@
+class Capitan::Venue
+  include Capitan::ObjectInitializer
+
+  attr_accessor :title, :slug, :facility_phone, :street_address, :city, :state, :zip_code,
+                :google_map_url, :short_description, :venue_id, :short_description, :facility_days_open
+
+end

data/test/capitan_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class CapitanTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: capitan
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Eric Sipple
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Culturaldistrict.org provides access to all events through cAPI, and
+  capitan can get that data for you.
+email:
+- sipple@trustarts.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- capitan.gemspec
+- init.rb
+- install.rb
+- lib/capitan/calendar/calendar_show.rb
+- lib/capitan/calendar/day.rb
+- lib/capitan/calendar/monthly.rb
+- lib/capitan/calendar/week.rb
+- lib/capitan/connection.rb
+- lib/capitan/exceptions/connection_error.rb
+- lib/capitan/exhibition.rb
+- lib/capitan/non_ticketed_event.rb
+- lib/capitan/object_initializer.rb
+- lib/capitan/performance.rb
+- lib/capitan/production.rb
+- lib/capitan/show_methods.rb
+- lib/capitan/shows.rb
+- lib/capitan/venue.rb
+- lib/capitan.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- test/capitan_test.rb
+- test/test_helper.rb
+- uninstall.rb
+homepage: https://github.com/pgharts/capitan/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.29
+signing_key: 
+specification_version: 3
+summary: Interface for culturaldistrict.org's read-only API
+test_files:
+- test/capitan_test.rb
+- test/test_helper.rb