spektrix 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75142429ee35e702751b0232e999e40c4b74eaa9
+  data.tar.gz: 65db3438fe53e2d16d1faac76d479aec8c2a697c
+SHA512:
+  metadata.gz: 02ab04c7ed14fc993da1e51a1818d071113e239d31e3e767a65793f90a1450fb05f7e96d25c0e901e7c505605380ab416045fad888c4d775229596fdfec0d270
+  data.tar.gz: 28a70513c8d31ce64fd4714cfdcdc262a1fb338992881ae9c5a5107b42b84b5df765e3d4ca6aadca53fee91900e6c41cd2e24f7865c3881ab607ca1f9bc09c82

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/CONDUCT.md

@@ -0,0 +1,2 @@
+This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.
+[code-of-conduct]: http://todogroup.org/opencodeofconduct/#Error Agency Open Source/help@error.agency

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spektrix.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ed Jones
+
+MIT License
+
+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,84 @@
+# Spektrix client library for Ruby
+This is a client library for the [Spektrix ticketing platform](https://www.spektrix.com/). You'll need a user account / client name, a private/public keypair and an API ID.
+
+This library covers most of the stuff you might need to do to pull events and prices from the database to include on your own website. It doesn't write back to the API, and doesn't include other endpoints (although feel free to add these and send us a PR!).
+
+# Setup
+
+## Installation
+
+You can either install using [bundler](http://bundler.io) or just from the command line.
+
+### Bundler
+Include this in your gemfile
+
+`gem 'spektrix'`
+
+That's it! this is in active development so you might prefer:
+
+`gem 'spektrix', github: "errorstudio/spektrix"`
+ 
+### Using Gem
+As simple as:
+
+`gem install spektrix`
+
+## Configuration
+You need to configure spektrix with a block, like this:
+
+```
+Spektrix.configure do |config|
+  config.client_name = "yourclientname"
+  config.client_key_path = File.join(Rails.root,"config","certs","your.private.key") # don't commit this into version control.
+  config.client_cert_path = File.join(Rails.root,"config","certs","your.signed.cert.crt") #the cert you get back from the Spektrix team
+  config.api_key = "your API key from the spektrix interface"
+  # config.proxy = "https://localhost:9998" #a proxy if you want to use it.  Proxies don't usually forward client certs so YMMV.
+  # config.base_url = "http://localhost:8000" #if you don't want to hit the Spektrix API for some reason - e.g. locally hosted XML for testing.
+  # config.api_path = "" # defaults to /api/v2 - only here for testing really.
+end
+```
+
+# Use
+
+## Events, instances and prices
+Events have instances, which in turn have seating plans and a price list. Seating plans aren't catered for, but bands and ticket types are.
+
+```
+include Spektrix #You don't have to do this, just prefix all the calls with `Spektrix::` otherwise
+Events::Event.first #get the first event in the list
+e = Events::Event.find(123) #or get a specific event by ID
+instances = e.instances # A list of Spektrix::Event::Instance objects
+i = instance.first
+i.prices #a list of Spektrix::Ticket::Price objects
+p = i.prices.first #a Price object
+p.band #a Spektrix::Tickets::Band object - this just has a name
+p.ticket_type #a Spektrix::Tickets::Type object - this just has a name
+p.price #a string representation of the price
+```
+
+### Getting a list of lower-level objects directly
+Because the API doesn't follow REST, we actually make a bunch of HTTP calls in the example above. That has an advantage that you can call a collection of lower-level entities without having to get the 'parent'.
+
+```
+Spektrix::Tickets::Band.all #a collection of bands
+Spektrix::Tickets::PriceList.where(event_id: 123) #the prices for event 123, without calling the Event itself.
+```
+
+# Contributing
+We'd love to have your input if you're making use of this:
+
+1. Fork the repo
+2. Make any changes in a branch
+3. Squash your changes into sensible commits
+4. Make a PR on your fork
+
+# Licence
+Licensed under MIT - see LICENCE.txt. Have fun!
+
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/models/events/event.rb

@@ -0,0 +1,16 @@
+module Spektrix
+  module Events
+    # An event. This hits the events endpoint on Spektrix and returns a collection.
+    class Event
+      include Spektrix::Base
+      collection_path "events"
+
+      after_find -> (r) { r.duration = r.duration.to_i.minutes }
+
+      def instances
+        Instance.where(event_id: self.id).to_a
+      end
+
+    end
+  end
+end

data/lib/models/events/instance.rb

@@ -0,0 +1,38 @@
+module Spektrix
+  module Events
+    # An event instance.
+    class Instance
+      include Spektrix::Base
+      collection_path "instances"
+
+      after_find ->(r) do
+        [:start,
+         :start_utc,
+         :start_selling_at,
+         :start_selling_at_utc,
+         :stop_selling_at,
+         :stop_selling_at_utc
+        ].each do |field|
+          if r.respond_to?(field)
+            time = Time.parse(r.send(field))
+            if field.to_s =~ /_utc$/
+              time = time.in_time_zone('UTC')
+            else
+              time = time.in_time_zone('London')
+            end
+
+            r.send(:"#{field}=",time)
+          end
+        end
+      end
+
+      def status
+        InstanceStatus.where(instance_id: self.id).first
+      end
+
+      def prices
+        Tickets::PriceList.where(instance_id: self.id).first.prices
+      end
+    end
+  end
+end

data/lib/models/events/instance_status.rb

@@ -0,0 +1,8 @@
+module Spektrix
+  module Events
+    class InstanceStatus
+      include Spektrix::Base
+      collection_path "instance-status"
+    end
+  end
+end

data/lib/models/seating/plan.rb

@@ -0,0 +1,10 @@
+module Spektrix
+  module Seating
+    class Plan
+      include Spektrix::Base
+      collection_path "plans"
+
+
+    end
+  end
+end

data/lib/models/tickets/band.rb

@@ -0,0 +1,12 @@
+module Spektrix
+  module Tickets
+    class Band
+      include Spektrix::Base
+      collection_path "bands"
+
+      def to_s
+        self.name
+      end
+    end
+  end
+end

data/lib/models/tickets/price.rb

@@ -0,0 +1,7 @@
+module Spektrix
+  module Tickets
+    class Price < OpenStruct
+
+    end
+  end
+end

data/lib/models/tickets/price_list.rb

@@ -0,0 +1,20 @@
+module Spektrix
+  module Tickets
+    class PriceList
+      include Spektrix::Base
+      collection_path "price-lists"
+
+      after_find ->(r) do
+        bands = Band.all.to_a
+        ticket_types = Type.all.to_a
+        if r.respond_to?(:price)
+          r.prices = r.price.collect do |price|
+            price[:band] = bands.find {|b| b.id == price[:band][:id]}
+            price[:ticket_type] = ticket_types.find {|t| t.id == price[:ticket_type][:id]}
+            Price.new(price)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/models/tickets/type.rb

@@ -0,0 +1,8 @@
+module Spektrix
+  module Tickets
+    class Type
+      include Spektrix::Base
+      collection_path "ticket-types"
+    end
+  end
+end

data/lib/spektrix.rb

@@ -0,0 +1,79 @@
+require 'her'
+require 'nokogiri'
+require 'require_all'
+require_rel "spektrix/deep_symbolize"
+require_rel '.'
+class Hash; include DeepSymbolizable; end
+module Spektrix
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+    self.configuration.configure_connection
+  end
+
+  class Configuration
+    attr_accessor :client_name,
+                  :client_key_path, #your private RSA key
+                  :client_cert_path, # the cert signed by Spektrix
+                  :api_key, #the key you get from the spektrix interface.
+                  :proxy, #note that proxying requests with a client cert might break some stuff.
+                  :base_url,
+                  :api_path
+
+    attr_reader :connection,
+                :ssl_options
+
+    def initialize
+      @connection ||= Her::API.new
+      @user_agent = "Spektrix Ruby client #{Spektrix::VERSION} (http://github.com/errorstudio/spektrix-ruby)",
+      @base_url = "https://api.system.spektrix.com"
+      @api_path = "api/v2"
+    end
+
+    def user_agent=(agent)
+      @user_agent = agent || @user_agent
+    end
+
+    # Return the Configuration object as a hash, with symbols as keys.
+    # @return [Hash]
+    def to_hash
+      Hash[instance_variables.map { |name| [name.to_s.gsub("@","").to_sym, instance_variable_get(name)] } ]
+    end
+
+    def configure_connection
+      if @client_name.nil? || @client_key_path.nil? || @client_cert_path.nil? || @api_key.nil?
+        raise ArgumentError, "You need to configure the Spektrix gem with a client name, private and public keys before making a call to Spektrix"
+      end
+
+      @connection_path = "#{@base_url}/#{@client_name}/#{@api_path}"
+      # @connection_path = "http://localhost:8000"
+      @ssl_options = {
+        :client_cert => OpenSSL::X509::Certificate.new(File.read(@client_cert_path)),
+        :client_key => OpenSSL::PKey::RSA.new(File.read(@client_key_path)),
+        :verify => false
+      }
+
+
+      @connection.setup url: @connection_path, ssl: @ssl_options, proxy: @proxy do |c|
+
+        #Api Auth
+        c.params[:api_key] = @api_key
+
+        # Request
+        c.use Faraday::Request::UrlEncoded
+
+        # Response
+        # c.use Spektrix::DebugMiddleware
+        c.use Spektrix::ResponseParser
+
+
+        # Adapter
+        c.use Faraday::Adapter::NetHttp
+      end
+    end
+  end
+end

data/lib/spektrix/base.rb

@@ -0,0 +1,44 @@
+module Spektrix
+  # This is a mixin which allows any class to get data from a Spektrix endpoint
+  module Base
+    def self.included(base)
+      # Include Her::Model. Her does most of the heavy lifting.
+      base.include Her::Model
+
+      # Extend class methods (below)
+      base.extend ClassMethods
+
+      # Use the connection we set up in the configuration.
+      base.send(:use_api,->{Spektrix.configuration.connection})
+    end
+
+    # Define method_missing here to allow us to inspect the custom attributes on the object and return as normal attributes.
+    def method_missing(method, *args, &block)
+      if attributes.has_key?(:custom_attributes) && custom_attributes.has_key?(method.to_sym)
+        custom_attributes[method.to_sym]
+      else
+        super
+      end
+    end
+
+    module ClassMethods
+      # Spektrix expects the ID for an entity to be passed as a querystring parameter, as opposed to an instance being on its own url
+      # @param id [Integer] the ID you want to find
+      # @return [Object] the entity
+      def find(id)
+        where("#{entity_name}_id" => id).first
+      end
+
+      # Get the entity name; used in other places (like find())
+      # @return [String] the entity name
+      def entity_name
+        self.to_s.demodulize.underscore
+      end
+
+      def first
+        all.first
+      end
+    end
+
+  end
+end

data/lib/spektrix/deep_symbolize.rb

@@ -0,0 +1,82 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2015 Oleg Ivanov http://github.com/morhekil
+#
+# 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.
+
+# Symbolizes all of hash's keys and subkeys.
+# Also allows for custom pre-processing of keys (e.g. downcasing, etc)
+# if the block is given:
+#
+# somehash.deep_symbolize { |key| key.downcase }
+#
+# Usage: either include it into global Hash class to make it available to
+#        to all hashes, or extend only your own hash objects with this
+#        module.
+#        E.g.:
+#        1) class Hash; include DeepSymbolizable; end
+#        2) myhash.extend DeepSymbolizable
+
+module DeepSymbolizable
+  def deep_symbolize(&block)
+    method = self.class.to_s.downcase.to_sym
+    syms = DeepSymbolizable::Symbolizers
+    syms.respond_to?(method) ? syms.send(method, self, &block) : self
+  end
+
+  module Symbolizers
+    extend self
+
+    # the primary method - symbolizes keys of the given hash,
+    # preprocessing them with a block if one was given, and recursively
+    # going into all nested enumerables
+    def hash(hash, &block)
+      hash.inject({}) do |result, (key, value)|
+        # Recursively deep-symbolize subhashes
+        value = _recurse_(value, &block)
+
+        # Pre-process the key with a block if it was given
+        key = yield key if block_given?
+        # Symbolize the key string if it responds to to_sym
+        sym_key = key.to_sym rescue key
+
+        # write it back into the result and return the updated hash
+        result[sym_key] = value
+        result
+      end
+    end
+
+    # walking over arrays and symbolizing all nested elements
+    def array(ary, &block)
+      ary.map { |v| _recurse_(v, &block) }
+    end
+
+    # handling recursion - any Enumerable elements (except String)
+    # is being extended with the module, and then symbolized
+    def _recurse_(value, &block)
+      if value.is_a?(Enumerable) && !value.is_a?(String)
+        # support for a use case without extended core Hash
+        value.extend DeepSymbolizable unless value.class.include?(DeepSymbolizable)
+        value = value.deep_symbolize(&block)
+      end
+      value
+    end
+  end
+
+end

data/lib/spektrix/response_parser.rb

@@ -0,0 +1,46 @@
+module Spektrix
+  # A custom response parser to handle the XML format returned by Spektrix.
+  # We clean up the XML to remove namespaces, then get the collection itself. The XML includes an attribute called 'attribute' which explodes Ruby, so we reassign this to 'custom_attributes', and clean up the key/value pairs so the attribute name is the key and the value is the value.
+  class ResponseParser < ::Faraday::Response::Middleware
+    def on_complete(env)
+
+      # Parse the XML
+      doc = Nokogiri::XML(env[:body])
+      doc.remove_namespaces!
+
+      # Hash has DeepSymbolizable mixed in, which goes through the hash fixing up the CamelCase.
+      data = Hash.from_xml(doc.to_s).deep_symbolize {|k| k.underscore.to_sym}
+
+      begin
+        # Get the array inside the XML. TODO: this is a bit hacky. Should use xpath.
+        data = data.values.first.values.flatten
+      rescue
+        # Rescue with an empty array, for now.
+        data = []
+      end
+
+      # Traverse the array, fixing up any attributes called 'attribute'
+      data.each do |item|
+        if item.has_key?(:attribute)
+          item[:custom_attributes] = {}
+          item[:attribute].each do |attribute_pair|
+            next unless attribute_pair.is_a?(Hash)
+            key = attribute_pair.values.first.underscore.downcase.parameterize("_").to_sym
+            value = attribute_pair.values.last
+            value = false if value == "0"
+            value = true if value == "1"
+            item[:custom_attributes][key] = value
+          end
+
+          #Remove the 'attribute' attribute because, y'know.
+          item.delete(:attribute)
+        end
+      end
+
+      # Set up the hash as Her expects.
+      env[:body] = {
+        data: data
+      }
+    end
+  end
+end

data/lib/spektrix/version.rb

@@ -0,0 +1,3 @@
+module Spektrix
+  VERSION = "0.0.1"
+end

data/spektrix.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spektrix/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spektrix"
+  spec.version       = Spektrix::VERSION
+  spec.authors       = ["Ed Jones", "Paul Hendrick"]
+  spec.email         = ["hosting@error.agency"]
+  spec.summary       = %q{A client library for the Spektrix ticketing system}
+  spec.description   = %q{A client library for the Spektrix ticketing system. Requires a Spektrix user account.}
+  spec.homepage      = "https://github.com/errorstudio/spektrix-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "her", "~> 0.8"
+  spec.add_dependency "require_all", "~> 1.3"
+  # spec.add_dependency "multi_xml", "~> 0.5"
+  # spec.add_dependency "faraday_middleware", "~> 0.10"
+  spec.add_dependency "nokogiri"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: spektrix
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ed Jones
+- Paul Hendrick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: her
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A client library for the Spektrix ticketing system. Requires a Spektrix
+  user account.
+email:
+- hosting@error.agency
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/models/events/event.rb
+- lib/models/events/instance.rb
+- lib/models/events/instance_status.rb
+- lib/models/seating/plan.rb
+- lib/models/tickets/band.rb
+- lib/models/tickets/price.rb
+- lib/models/tickets/price_list.rb
+- lib/models/tickets/type.rb
+- lib/spektrix.rb
+- lib/spektrix/base.rb
+- lib/spektrix/deep_symbolize.rb
+- lib/spektrix/response_parser.rb
+- lib/spektrix/version.rb
+- spektrix.gemspec
+homepage: https://github.com/errorstudio/spektrix-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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A client library for the Spektrix ticketing system
+test_files: []