globalticket 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfca2239def9438df1a128c46bb4f2b33bd99b60
+  data.tar.gz: 09fe99bfb9d0adea7e49281b7f27f76aa781566e
+SHA512:
+  metadata.gz: 8b3c27a89b4cfc0675d622585e264a392ea4348bb14efd1f8f16652d106b1432b2472aefd5d68020b0302cf2075b888637666cb9c0ee7c9f7d3c860c99d57439
+  data.tar.gz: 5b3dd2eebc3150c2b6c70e030b7978c1585f6129f86477c35c311b76d9145921108892b686cd640955136275e6fad04342dc43030135a1daeafaf3f06891cfb5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Henk Meijer
+
+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,83 @@
+# Globalticket
+[![Build Status](https://secure.travis-ci.org/henkm/globalticket.png)](http://travis-ci.org/henkm/globalticket)
+[![Gem Version](https://badge.fury.io/rb/globalticket.svg)](http://badge.fury.io/rb/globalticket)
+[![Dependency Status](https://gemnasium.com/henkm/globalticket.svg)](https://gemnasium.com/henkm/globalticket)
+[![Code Climate](https://codeclimate.com/github/henkm/globalticket/badges/gpa.svg)](https://codeclimate.com/github/henkm/globalticket)
+
+This gem works as a simple Ruby wrapper for the Global Ticket Resller API. It implements all the API functions are implemented. Please refer to the awesome [Global Ticket Resller documentation](https://globalreseller.nl/documentation/) to see how the API works.
+
+
+All this gem does, is make it a little bit simpler to use the API:
+- You don't need to sort the attributes
+- You don't need to calculate the HMAC Key
+- You don't need to send your API key or environment with every request
+- You don't need to figure out how to make the POST requests
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'globalticket'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install globalticket
+
+## Configuration
+
+First, obtain an API key and shared secret from Global Ticket. Set it up like this:
+```ruby
+Globalticket::Config.api_key      = "MY-API-KEY"
+Globalticket::Config.api_secret   = "MY-API-SHARED-SECRET"
+Globalticket::Config.environment  = "test" # or 'production'
+```
+
+To use this gem in a Rails project:
+```ruby
+# config/development.rb
+config.globalticket.api_key      = "MY-API-KEY"
+config.globalticket.api_secret   = "MY-API-SHARED-SECRET"
+config.globalticket.environment  = "test" # or 'production'
+```
+
+## Usage
+
+### Get available users
+```ruby
+@global_ticket_users = Globalticket::API.get_available_users
+# => {"success"=>true, "users"=>[{"userId"=>"xx", "userName"=>"Name of the museum", etc..}, {"userId"=>"yy", "userName"=>"Name of the museum", etc..}]}
+```
+
+### Get ticket types
+```ruby
+@ticket_types = Globalticket::API.get_ticket_types(userId: xx)
+# => {"success"=>true, "ticketTypes"=>[{"ticketTypeId"=>xx, "ticketTypeName"=>"Dagticket", "ticketTypePrice"=>"10.00"}, ...]}
+```
+
+### Etcetera
+
+All the other functions work exactly in the same fashion. Checkout the globalticket_spec.rb file to see some more examples.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/henkm/globalticket.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+This gem is made with love by the smart people at [Eskes Media B.V.](http://www.eskesmedia.nl) and [dagjewegtickets.nl](https://www.dagjewegtickets.nl)
+Global Ticket is not involved with this project and has no affiliation with Eskes Media B.V.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "globalticket"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/globalticket.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'globalticket/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "globalticket"
+  spec.version       = Globalticket::VERSION
+  spec.authors       = ["Henk Meijer"]
+  spec.email         = ["hmeijer@eskesmedia.nl"]
+
+  spec.summary       = %q{Ruby implementation of the Global Ticket Reseller API}
+  spec.description   = %q{Ruby implementation of the Global Ticket Reseller API}
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  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 "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/globalticket.rb

@@ -0,0 +1,17 @@
+require "globalticket/version"
+require "globalticket/config"
+require "globalticket/engine" if defined?(Rails) && Rails::VERSION::MAJOR.to_i >= 3
+require "globalticket/api"
+
+module Globalticket
+  # Your code goes here...
+
+  # 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
+    Config.api_key = ENV["GLOBAL_TICKET_API_KEY"]
+    Config.api_secret = ENV["GLOBAL_TICKET_API_SECRET"]
+
+  end
+end

data/lib/globalticket/api.rb

@@ -0,0 +1,115 @@
+module Globalticket
+
+  # The communication layer implements all the methods available in the Globalticket API
+  # https://globalreseller.nl/documentation/
+  class API
+    require 'httparty'
+    require 'date'
+
+    ENDPOINT_PREFIX = "https://globalreseller.nl/webservices"
+
+    # returns a list of available users
+    def self.get_available_users
+      self.make_api_call(endpoint: "getAvailableUsers", data: {})
+    end
+
+    # return a list of ticket types for given userId
+    # Original documentation: https://globalreseller.nl/documentation/api/getTicketTypes
+    def self.get_ticket_types(userId: nil, language: nil)
+      self.make_api_call(endpoint: "getTicketTypes", data: {userId: userId.to_s, language: language})
+    end
+
+    # Fetch available periods and time slots
+    # https://globalreseller.nl/documentation/api/getAvailability
+    def self.get_availability(userId: nil, start_date: nil, end_date: nil)
+      # set default dates if none are given
+      start_date = Time.now if start_date.nil?
+      end_date = start_date.to_time + ((3600 * 24) * 30) if end_date.nil? # add 31 days, max allowed
+
+      # convert dates to required string
+      start_date = self.convert_date_object_to_format(date: start_date, format: "%Y-%m-%d")
+      end_date   = self.convert_date_object_to_format(date: end_date, format: "%Y-%m-%d")
+
+      self.make_api_call(endpoint: "getAvailability", data: {userId: userId.to_s, startDate: start_date, endDate: end_date})
+    end
+
+    # Create a reservation
+    # https://globalreseller.nl/documentation/api/createReservation
+    def self.create_reservation(userId: nil, tickets: [], ticketDate: nil, ticketTime: nil)
+
+      # convert dates to required string
+      ticketDate = self.convert_date_object_to_format(date: ticketDate, format: "%Y-%m-%d") unless ticketDate.nil?
+      ticketTime   = self.convert_date_object_to_format(date: ticketTime, format: "%H:%M") unless ticketTime.nil?
+
+      self.make_api_call(endpoint: "createReservation", data: {userId: userId.to_s, tickets: tickets, ticketDate: ticketDate, ticketTime: ticketTime})
+    end
+
+    # Add a contact to a reservation
+    # https://globalreseller.nl/documentation/api/addContact
+    def self.add_contact(data = {})
+      self.make_api_call(endpoint: "addContact", data: data)
+    end
+
+    # Complete a reservation
+    # https://globalreseller.nl/documentation/api/completeReservation
+    def self.complete_reservation(userId: nil, reservationId: nil)
+      self.make_api_call(endpoint: "completeReservation", data: {userId: userId.to_s, reservationId: reservationId.to_s})
+    end
+
+    # Complete a reservation
+    # https://globalreseller.nl/documentation/api/cancelReservation
+    def self.cancel_reservation(userId: nil, reservationId: nil)
+      self.make_api_call(endpoint: "cancelReservation", data: {userId: userId.to_s, reservationId: reservationId.to_s})
+    end
+
+    def self.convert_date_object_to_format(date: nil, format: "%Y-%m-%d")
+      if date.is_a?(String)
+        d = Date.parse(date)
+      elsif date.is_a?(Date)
+        d = date
+      elsif date.is_a?(Time)
+        d = date
+      else
+        raise "Invalid date. Should be of type Date, Time or String."
+      end
+      return d.strftime(format)
+    end
+
+    # return the request data as needed for the API
+    # - sorted alphabetically
+    # - ending with HMAC calculation
+    def self.request_data(data)
+      # delet data wit nil values
+      data = data.select {|k, v| !v.nil? }
+
+      # merge data with api-key and env
+      unsorted_data = { apiKey: Config.api_key, environment: Config.environment }.merge(data)
+
+      # sort alphabetically
+      sorted_data = Hash[unsorted_data.sort_by{|k,v| k}]
+
+      # calculate HMAC value
+      calculated_hmac = Base64.encode64(OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), Config.api_secret, sorted_data.to_json.strip)).strip.gsub("\n", "")
+
+      request_data = sorted_data.merge({"HMACKey" => calculated_hmac})
+      # puts request_data.to_json
+      return request_data
+    end
+
+    # communicate with the API via POST requests and return the return
+    # message in a ruby-esque manor.
+    def self.make_api_call(endpoint: '', data: {})
+      url = "#{ENDPOINT_PREFIX}/#{endpoint}"
+      # puts "posting to URL: #{url}:\n#{self.request_data(data)}"
+      result = JSON.parse(HTTParty.post(url,
+                body: self.request_data(data).to_json,
+                headers: { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }).body)
+      if result["success"] == false
+        raise result["errorMessage"]
+      else
+        # puts result
+        return result
+      end
+    end
+  end
+end

data/lib/globalticket/config.rb

@@ -0,0 +1,37 @@
+#
+# Configuration object for storing some parameters required for making transactions
+#
+module Globalticket::Config
+  class << self
+    attr_accessor :api_key
+    attr_accessor :api_secret
+    attr_accessor :environment
+
+
+    # Set's the default value's to nil and false
+    # @return [Hash] configuration options
+    def init!
+      @defaults = {
+        :@api_key   => nil,
+        :@api_secret => nil,
+        :@environment => 'test'
+      }
+    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/globalticket/engine.rb

@@ -0,0 +1,13 @@
+module Globalticket
+  #
+  # 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.globalticket.api_key  = "12343465sdfgsadr324"
+  #
+  class Engine < Rails::Engine
+    config.globalticket = Globalticket::Config
+  end
+end

data/lib/globalticket/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: globalticket
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henk Meijer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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 Global Ticket Reseller 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
+- globalticket.gemspec
+- lib/globalticket.rb
+- lib/globalticket/api.rb
+- lib/globalticket/config.rb
+- lib/globalticket/engine.rb
+- lib/globalticket/version.rb
+homepage: 
+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 Global Ticket Reseller API
+test_files: []