prioticket 0.1.0

data/lib/prioticket/config.rb

@@ -0,0 +1,36 @@
+#
+# Configuration object for storing some parameters required for making transactions
+#
+module PrioTicket::Config
+  class << self
+    attr_accessor :api_key
+    attr_accessor :environment
+    attr_accessor :verbose
+
+    # Set's the default value's to nil and false
+    # @return [Hash] configuration options
+    def init!
+      @defaults = {
+        :@api_key   => nil,
+        :@environment => 'test',
+        :@verbose => false,
+      }
+    end
+
+    # Resets the value's to there previous value (instance_variable)
+    # @return [Hash] configuration options
+    def reset!
+      @defaults.each { |key, value| instance_variable_set(key, value) }
+    end
+
+    # Set's the new value's as instance variables
+    # @return [Hash] configuration options
+    def update!
+      @defaults.each do |key, value|
+        instance_variable_set(key, value) unless instance_variable_defined?(key)
+      end
+    end
+  end
+  init!
+  reset!
+end

data/lib/prioticket/engine.rb

@@ -0,0 +1,13 @@
+module PrioTicket
+  #
+  # Simpel extend on the +Rails::Engine+ to add support for a new config section within
+  # the environment configs
+  #
+  # @example default
+  #   # /config/environments/development.rb
+  # config.prioticket.api_key  = "12343465sdfgsadr324"
+  #
+  class Engine < Rails::Engine
+    config.prioticket = PrioTicket::Config
+  end
+end

data/lib/prioticket/prioticket_error.rb

@@ -0,0 +1,28 @@
+class PrioTicketError < StandardError
+  attr_accessor :error_message
+  attr_accessor :error_code
+  
+  # def initialize
+  #   # @error_message = error_message
+  #   # @error_code = error_code
+  #   # @description = 
+  # end
+
+  # def self.error_code_mapping
+  #   {    
+  #    "NO_AVAILABILITY" => { exception_name: "No Availability Exception", explanation: "The request cannot be fulfilled because there is insufficient availability.", http_status_code: "400 Bad Request"},
+  #    "INVALID_PRODUCT" => { exception_name: "Invalid Product Exception", explanation: "The specified product does not exist.", http_status_code: "400 Bad Request"},
+  #    "INVALID_RESERVATION" => { exception_name: "Invalid Reservation Exception", explanation: "The specified reservation does not exist or is not in a valid state.", http_status_code: "400 Bad Request"},
+  #    "INVALID_BOOKING" => { exception_name: "Invalid Booking Exception", explanation: "The specified booking does not exist or is not in a valid state.", http_status_code: "400 Bad Request"},
+  #    "INVALID_REQUEST" => { exception_name: "Invalid Identifier Exception", explanation: "Invalid request contents.", http_status_code: "400 x-request-identif => er header invalid"},
+  #    "AUTHORIZATION_FAILURE" => { exception_name: "Invalid Authentication Exception", explanation: "The provided credentials are not valid.", http_status_code: "401 x-request-authenticati => n header invalid."},
+  #    "VALIDATION_FAILURE" => { exception_name: "Validation Exception", explanation: "The request object contains inconsistent or invalid data or is missing data.", http_status_code: "400 Bad Request"},
+  #    "INVALID_TICKET_CLASS" => { exception_name: "Invalid TicketClass Exception", explanation: "This endpoint can only be requested for ticket_class 2/ticket_class 3 (product of managed capacity).", http_status_code: "400 Bad Request"},
+  #    "AUTHORIZATION_FAILURE" => { exception_name: "Authorization Exception", explanation: "The provided credentials are not valid.", http_status_code: "401 Unauthorized"},
+  #    "BOOKING_CANCELLED" => { exception_name: "Redeem Booking Cancelled Exception", explanation: "This booking has been cancelled.", http_status_code: "400 Bad Request"},
+  #    "INVALID_TICKET_CODE" => { exception_name: "Redeem Ticketcode Invalid Exception", explanation: "Provided ticket code is not valid.", http_status_code: "400 Bad Request"},
+  #    "DATE_MISMATCH" => { exception_name: "Redeem Date Mismatch Exception", explanation: "This ticket isn't valid for today.", http_status_code: "400 Bad Request"},
+  #    "INTERNAL_SYSTEM_FAILURE" => { exception_name: "InternalSystem Exception", explanation: "An error occurred that is unexpected and/or doesn’t fit any of the types above.", http_status_code: "500 Internal Server Error"}
+  #    }
+  # end
+end

data/lib/prioticket/reservation.rb

@@ -0,0 +1,122 @@
+module PrioTicket
+
+  # Describes a Reservation
+  # 
+  # @author [henkm]
+  # 
+  class Reservation
+
+    attr_accessor :identifier
+    attr_accessor :distributor_id
+    attr_accessor :ticket_id
+    attr_accessor :pickup_point_id
+    attr_accessor :from_date_time
+    attr_accessor :to_date_time
+    attr_accessor :booking_details
+    attr_accessor :distributor_reference
+    
+    attr_accessor :reservation_reference
+    attr_accessor :booking_status
+    attr_accessor :cancellation_date_time
+
+    def initialize(args)
+      return if args.nil?
+      args.each do |k,v|
+        PrioTicket.parse_json_value(self, k,v)
+      end
+    end
+
+    def success
+      booking_status == "Reserved"
+    end
+    for meth in [:success?, :confirmed, :confirmed?, :reserved, :reserved?]
+      alias_method meth, :success
+    end
+
+
+    # 
+    # Sends the reservation request tot the API
+    # 
+    def save
+      request_reservation
+    end
+
+    # 
+    # Cancels the current reservation
+    # 
+    # @return <Reservation>
+    def cancel
+      result = PrioTicket::API.call(cancel_request_body, identifier)
+      parse_result(result)
+    end
+
+    private
+
+    # 
+    # Sends the reservation request to the API endpoint
+    # and enriches current object with status and reference.
+    # 
+    def request_reservation
+      result = PrioTicket::API.call(request_body, identifier)
+      parse_result(result)
+    end
+
+
+    # 
+    # Parses the return value from the API
+    # `{"response_type"=>"reserve", "data"=>
+    # {"reservation_reference"=>"1522065689487477", 
+    # "distributor_reference"=>"TEST_RESERVATION", 
+    # "booking_status"=>"Reserved"}}`
+    # 
+    # @return [type] [description]
+    def parse_result(result)
+      self.booking_status         = result["data"]["booking_status"]
+      self.reservation_reference  = result["data"]["reservation_reference"]
+      if result["data"]["cancellation_date_time"]
+        PrioTicket.parse_json_value(self, :cancellation_date_time, result["data"]["cancellation_date_time"])
+      end
+    end
+
+
+    # Computes the request body to send to the API cancel_reserve endpoint
+    def cancel_request_body
+      { 
+        request_type: "cancel_reserve",
+        data: {
+          distributor_id: distributor_id,
+          reservation_reference: reservation_reference,
+          distributor_reference: distributor_reference
+        }
+      }
+    end
+
+    # 
+    # Computes the request body to send to the API endpoint
+    # @param distributor_id Integer
+    # @param ticket_id Integer
+    # @param from_date String
+    # @param until_date String
+    # 
+    # @return Hash
+    def request_body
+      booking_details_array = booking_details.to_a.map{|bd| bd.to_h}
+      body = {
+        request_type: "reserve",
+        data: {
+          distributor_id: distributor_id.to_s,
+          ticket_id: ticket_id.to_s,
+          from_date_time: PrioTicket.parsed_date(from_date_time),
+          to_date_time: PrioTicket.parsed_date(to_date_time),
+          booking_details: booking_details_array,
+          distributor_reference: distributor_reference
+        }
+      }
+      
+      # add pickuppoint to body, if present
+      body[:data][:pickup_point_id] = pickup_point_id if pickup_point_id
+      return body
+    end
+    
+  end
+end

data/lib/prioticket/ticket.rb

@@ -0,0 +1,34 @@
+module PrioTicket
+
+  # Describes a single result from the [TicketList]
+  # 
+  # @author [henkm]
+  # 
+  class Ticket
+    
+    attr_accessor :identifier
+    attr_accessor :distributor_id
+    attr_accessor :ticket_id
+    attr_accessor :ticket_title
+    attr_accessor :venue_name
+    attr_accessor :txt_language
+
+    def initialize(args)
+      return if args.nil?
+      args.each do |k,v|
+        PrioTicket.parse_json_value(self, k,v)
+      end
+    end
+
+
+    # 
+    # Queries the TicketDetail method and retruns
+    # a [TicketDetails] object.
+    # 
+    def details
+      PrioTicket::TicketDetails.find(distributor_id: distributor_id, ticket_id: ticket_id, identifier: identifier)
+    end
+
+    
+  end
+end

data/lib/prioticket/ticket_details.rb

@@ -0,0 +1,97 @@
+module PrioTicket
+
+  # 
+  # This API provides all the ticket information that is available in 
+  # the PrioTicket system for requested `ticket_id`.
+  # 
+  # @author [henkm]
+  # 
+  class TicketDetails
+
+    attr_accessor :identifier
+    attr_accessor :distributor_id
+
+    # attributes already available from ticketlist
+    attr_already_known_from_ticketlist = [:ticket_id, :ticket_title, :venue_name, :txt_language]
+    for att in attr_already_known_from_ticketlist
+      attr_accessor att
+    end
+
+    detailed_attributes = [:short_description, :long_description, :highlights, 
+      :duration, :combi_ticket, :ticket_entry_notes, :tags, :included, :company_opening_times,
+      :book_size_min, :book_size_max, :supplier_url, :ticket_class, :start_date, :end_date,
+      :booking_start_date, :images, :currency, :product_language, :pickup_points, 
+      :pickup_point_details, :ticket_type_details]
+
+    for att in detailed_attributes
+      attr_accessor att
+    end
+
+
+    def initialize(args=nil)
+      return if args.nil?
+      args.each do |k,v|
+        PrioTicket.parse_json_value(self, k,v)
+      end
+    end
+
+
+    # 
+    # Calls the request type 'details' with given
+    # 
+    # @param distributor_id Integer
+    # @return TicketDetails
+    def self.find(distributor_id: nil, ticket_id: nil, identifier: nil)
+      result = PrioTicket::API.call(request_body(ticket_id: ticket_id, distributor_id: distributor_id), identifier)
+      new_obj = self.new(result["data"])
+      new_obj.distributor_id = distributor_id
+      new_obj.identifier = identifier
+      return new_obj
+    end
+
+    # 
+    # Computes the request body to send to the API endpoint
+    # @param distributor_id Integer
+    # 
+    # @return Hash
+    def self.request_body(ticket_id: nil, distributor_id: nil)
+      {
+        request_type: "details",
+        data: {
+          distributor_id: distributor_id,
+          ticket_id: ticket_id
+        }
+      }
+    end
+
+
+    # 
+    # Finds availabilities for given dates
+    # 
+    # @param from_date: DateTime
+    # @param until_date: DateTime
+    # 
+    # @return [type] [description]
+    def availabilities(from_date: Time.now, until_date: Time.now+(60*60*24*21))
+      PrioTicket::Availabilities.find(distributor_id: distributor_id, ticket_id: ticket_id, identifier: identifier, from_date: from_date, until_date: until_date)      
+    end
+
+    def reserve_timeslot
+    # "request_type": "reserve",
+    # "data": {
+    #   "distributor_id": "501",
+    #   "ticket_id": "509",
+    #   "pickup_point_id": "Wyndham_Apollo_hotel",
+    #   "from_date_time": "2017-11-22T09:00:00+01:00",
+    #   "to_date_time": "2017-11-23T09:00:00+01:00",
+    #   "booking_details": [
+    #     {
+    #       "ticket_type": "ADULT",
+    #       "count": 1
+    #     }
+    #   ],
+    #   "distributor_reference": "ABC123456"
+    end
+
+  end
+end

data/lib/prioticket/ticket_list.rb

@@ -0,0 +1,54 @@
+module PrioTicket
+
+  # 
+  # This API provides all the tickets that are available in the PrioTicket system per distributor.
+  # 
+  # @author [henkm]
+  # 
+  class TicketList
+    
+    attr_accessor :tickets
+    attr_accessor :distributor_id
+    attr_accessor :identifier
+
+    def initialize(args, distributor_id, identifier)
+      @tickets = []
+      
+      # Add ticket details as array of TicketListItem objects
+      for ticket_hash in args["data"]["tickets"]
+        ticket = Ticket.new(ticket_hash)
+        ticket.distributor_id = distributor_id
+        ticket.identifier     = identifier
+        @tickets << ticket
+      end
+    end
+
+    # 
+    # Calls the request type 'list' with given
+    # 
+    # @param distributor_id Integer
+    # @return [TicketList]
+    def self.find(distributor_id: nil, identifier: '')
+      result = PrioTicket::API.call(request_body(distributor_id: distributor_id), identifier, false)
+      return_obj = self.new(result, distributor_id, identifier)
+      return_obj.distributor_id = distributor_id
+      return_obj.identifier     = identifier
+      return return_obj
+    end
+
+    # 
+    # Computes the request body to send to the API endpoint
+    # @param distributor_id Integer
+    # 
+    # @return Hash
+    def self.request_body(distributor_id: nil)
+      {
+        request_type: "list",
+        data: {
+          distributor_id: distributor_id
+        }
+      }
+    end
+
+  end
+end

data/lib/prioticket/version.rb

@@ -0,0 +1,3 @@
+module PrioTicket
+  VERSION = "0.1.0"
+end

data/lib/prioticket.rb

@@ -0,0 +1,109 @@
+# require dependencies
+require 'digest'
+require 'rest_client'
+require 'json'
+require 'base64'
+require 'ostruct'
+require 'date'
+
+# require gem files
+require "prioticket/version"
+require "prioticket/prioticket_error"
+require "prioticket/config"
+require "prioticket/engine" if defined?(Rails) && Rails::VERSION::MAJOR.to_i >= 3
+
+# require API parts
+require "prioticket/api"
+require "prioticket/ticket_list"
+require "prioticket/ticket"
+require "prioticket/ticket_details"
+require "prioticket/availabilities"
+require "prioticket/reservation"
+require "prioticket/booking"
+
+module PrioTicket
+
+  # For testing purpose only: set the username and password
+  # in environment variables to make the tests pass with your test
+  # credentials.
+  def self.set_credentials_from_environment
+    # puts "Setting API Key: #{ENV["PRIOTICKET_API_KEY"]}"
+    Config.api_key = ENV["PRIOTICKET_API_KEY"]
+    Config.environment = :test
+    Config.verbose = false
+  end
+
+  # 
+  # Formats time in ISO-8601
+  # Expected output: 2016-05-12T14:00:00+04:00
+  # Not expected: 2016-05-12T10:00:00+08:00 / 2016-05-12T18:00:00+00:00
+  # 
+  # @return [type] [description]
+  def self.parsed_date(date)
+    if date.is_a?(String)
+      date
+    elsif [DateTime, Time].include?(date.class)
+      date.strftime(expected_date_format)
+      # date.strftime('%Y-%m-%d')
+    end
+  end
+
+  # 
+  # Formats time in ISO-8601
+  # 
+  # @return [type] [description]
+  def self.expected_date_format
+    '%Y-%m-%dT%H:%M:%S%z'
+  end
+
+  # Converts OpenStruct back to a hash
+  def self.openstruct_to_hash(object, hash = {})
+    object.each_pair do |key, value|
+      hash[key] = value.is_a?(OpenStruct) ? openstruct_to_hash(value) : value
+    end
+    hash
+  end
+
+  # 
+  # Takes a hash and assignes it to the proper attributes.
+  # - Integers will be parsed as floats
+  # - Floats will be parsed as floats
+  # - Boolean values will bu parsed as such
+  # - Hash and Array will bet a type of 'OpenStruct'
+  # - DateTime will be a type of DateType
+  # - All other values will be used as string
+  # 
+  def self.parse_json_value(obj, k,v)
+    unless v.nil?
+      # "2018-03-24T00:00:00+01:00"
+      is_integer    = !!Integer(v) rescue false
+      is_float      = !!Float(v) rescue false
+      is_date_time  = !!DateTime.strptime(v, expected_date_format) rescue false
+      if ["true", "false"].include?(v)
+        val = (v == 'true')
+      elsif is_integer
+        val = v.to_i
+      elsif is_date_time
+        val = DateTime.strptime(v, expected_date_format)
+      elsif is_float
+        val = v.to_f
+      elsif [Hash, Array].include?(v.class)
+        val = JSON.parse(v.to_json, object_class: OpenStruct)
+      else
+        val = v
+      end
+      obj.instance_variable_set("@#{k}", val)
+    end
+  end
+
+end
+
+
+
+
+# docs:
+# WNYE9On0Jqn/fivlUVgeyeYckLubVqxJ5mryhfBOfKk=
+
+
+# real:
+# OTU3IqrnoXVn5QvUsZIoTfKIyOEzOo9BFmWFQFtZbHk=

data/prioticket.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prioticket/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "prioticket"
+  spec.version       = PrioTicket::VERSION
+  spec.authors       = ["Henk Meijer"]
+  spec.email         = ["hmeijer@eskesmedia.nl"]
+
+  spec.summary       = %q{Ruby implementation of the PrioTicket API}
+  spec.description   = %q{Ruby implementation of the PrioTicket API}
+  spec.homepage      = "https://github.com/henkm/prioticket"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "digest"
+  spec.add_dependency "rest-client"
+  spec.add_dependency "json"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: prioticket
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henk Meijer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: digest
+  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'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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'
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby implementation of the PrioTicket API
+email:
+- hmeijer@eskesmedia.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/prioticket.rb
+- lib/prioticket/api.rb
+- lib/prioticket/availabilities.rb
+- lib/prioticket/booking.rb
+- lib/prioticket/config.rb
+- lib/prioticket/engine.rb
+- lib/prioticket/prioticket_error.rb
+- lib/prioticket/reservation.rb
+- lib/prioticket/ticket.rb
+- lib/prioticket/ticket_details.rb
+- lib/prioticket/ticket_list.rb
+- lib/prioticket/version.rb
+- prioticket.gemspec
+homepage: https://github.com/henkm/prioticket
+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: Ruby implementation of the PrioTicket API
+test_files: []