zumata_v3 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57ac69048696ee15e681d791d65ecc3a8c71578f
+  data.tar.gz: f8d06cf7abb1cef0ad3d01d668316d07ae08ae0b
+SHA512:
+  metadata.gz: 5b4fc73126b7ee31f3579026413728bad33edd12b890c51110bca51d353f937a7da8879932ef7a1861801fec43cbaa429b8a94b59dc573590eb5475d101f81f2
+  data.tar.gz: 6ee6ec75e6ec9c312ec49a0d776272cb6900be51594a305762e900302e36e59c32cf37111aebc544c2fa7d6f88a407fce48b704d8b546348e7990801165bedc2

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+spec/cassettes/*.yml
+t

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Zumata
+
+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,20 @@
+# Zumata
+
+For interaction with the Zumata API 3.0
+[insert docs link]
+
+## Configuration
+```
+Zumata.configure do |config|
+  config.api_url = "http://INSERT_API_URL"
+  config.api_key = "YOUR_SECRET_API_KEY"
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/Zumata/v3-ruby-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/examples/example.rb

@@ -0,0 +1,127 @@
+require 'zumata_v3'
+
+API_KEY = "YOUR API KEY"
+API_URL = "https://test.api-v3.zumata.com"
+
+#####################
+# Initialize Client
+#####################
+
+ZumataV3.configure do |config|
+  config.api_url = API_URL
+  config.api_key = API_KEY
+end
+
+@client = ZumataV3::HotelClient.new
+
+
+#####################
+# Search package by destination id
+#####################
+
+status = "in-progress"
+
+search = {
+  :destination_id => "f75a8cff-c26e-4603-7b45-1b0f8a5aa100",
+  :check_in_date => "2015-09-09",
+  :check_out_date => "2015-09-10",
+  :room_count => 1,
+  :adult_count => 2
+}
+
+config = {
+  :pricing => {
+    :fixed_tolerance => 1
+  }
+}
+
+guest = {
+  :salutation => "Mr.",
+  :first_name => "Charlie",
+  :last_name => "Smith",
+  :email => "charlie.smith@zumata.com",
+  :city => "Montreal",
+  :state => "Quebec",
+  :street => "123 Outtamy way",
+  :postal_code => "H3H0H0",
+  :country => "Canada",
+  :room_remarks => "3 carpets please",
+  :nationality => "Canadian",
+  :contact_no => "+1 514 555-1234",
+}
+
+# Keep searching until the api returned a non-empty results
+while status == "in-progress"
+  result = @client.search_by_destination_id search[:destination_id], {
+            check_in_date: search[:check_in_date],
+            check_out_date: search[:check_out_date]}
+
+  output = JSON.parse(result.body)
+  status = "complete" if output["results"].first != nil || output["status"] == "complete"
+  sleep 10 unless status != "in-progress"
+end
+
+if output["results"].first == nil
+  puts "no results"
+  exit
+end
+
+package = output["results"].first[1][0]
+
+
+#####################
+# Pre-book a package
+#####################
+
+result = @client.pre_book search, package, config
+output = JSON.parse(result.body)
+
+
+#####################
+# Get pre-book details by pre-book id
+#####################
+
+pre_book_id = output["pre_book_id"]
+result = @client.pre_book_details pre_book_id
+output = JSON.parse(result.body)
+
+
+#####################
+# Book a package (with credit) by using pre-book id
+#####################
+
+result = @client.book_by_credit guest, pre_book_id, {affiliate_key: "testing"}
+output = JSON.parse(result.body)
+reference = output["reference"]
+
+result = @client.booking_status reference
+output = JSON.parse(result.body)
+
+puts reference
+
+
+#####################
+# Get booking information by reference
+#####################
+
+status = "IP"
+while status == "IP"
+  result = @client.booking_status reference
+  output = JSON.parse(result.body)
+  status = output["status"]
+  puts output["status"]
+  sleep 10 if status == "IP"
+end
+
+if output["status"] != "CF"
+  puts "booking not confirmed, exiting..."
+  exit
+end
+
+#####################
+# Cancel booking by reference
+#####################
+
+result = @client.cancel reference
+output = JSON.parse(result.body)
+puts output

data/lib/zumata_v3/client.rb

@@ -0,0 +1,107 @@
+require 'httparty'
+require 'time'
+require 'awesome_print'
+require 'json'
+
+module ZumataV3
+  class HotelClient
+  	include HTTParty
+
+    def initialize opts={}
+      raise ZumataV3::ClientConfigError.new("No API URL configured or API key provided") if ZumataV3.configuration.nil?
+      raise ZumataV3::ClientConfigError.new("No API URL configured") if ["",nil].include?(ZumataV3.configuration.api_url)
+      raise ZumataV3::ClientConfigError.new("No API key provided") if ["",nil].include?(ZumataV3.configuration.api_key)
+      @api_url = ZumataV3.configuration.api_url
+      @api_key = ZumataV3.configuration.api_key
+    end
+
+    # GET /search
+  	def search_by_destination_id destination_id, opts={}
+
+      q = { destination_id: destination_id,
+            room_count: opts[:room_count] || 1,
+            adult_count: opts[:adult_count] || 2,
+            currency: opts[:currency] || "USD" }
+
+      q[:child_count] = opts[:child_count] if opts[:child_count]
+      q[:source_market] = opts[:source_market] if opts[:source_market]
+
+      q[:check_in_date]  = opts[:check_in_date]
+      q[:check_out_date] = opts[:check_out_date]
+
+      headers = init_headers opts
+      res = self.class.get("#{@api_url}/search", query: q, headers: headers).response
+      ZumataV3::ErrorClassifier.handle(res.code.to_i, res.body) unless [200,201].include?(res.code.to_i)
+      ZumataV3::GenericResponse.new(context: q, code: res.code.to_i, body: res.body)
+    end
+
+    # POST /pre_book
+    def pre_book search, package, config, opts={}
+
+      req = { search: search,
+            package: package,
+            config: config }
+
+      headers = init_headers opts
+      res = self.class.post("#{@api_url}/pre_book", body: req.to_json, headers: headers).response
+      ZumataV3::ErrorClassifier.handle(res.code.to_i, res.body) unless [200,201].include?(res.code.to_i)
+      ZumataV3::GenericResponse.new(context: req, code: res.code.to_i, body: res.body)
+    end
+
+    # GET /pre_book
+    def pre_book_details pre_book_id, opts={}
+      headers = init_headers opts
+      res = self.class.get("#{@api_url}/pre_book/#{pre_book_id}", headers: headers).response
+      ZumataV3::ErrorClassifier.handle(res.code.to_i, res.body) unless [200,201].include?(res.code.to_i)
+      ZumataV3::GenericResponse.new(context: {pre_book_id: pre_book_id}, code: res.code.to_i, body: res.body)
+    end
+
+    # POST /book
+    def book_by_credit guest, pre_book_id, opts={}
+
+      req = { guest: guest,
+              payment: {
+                :type => "credit"
+              },
+              pre_book_id: pre_book_id }
+
+      req[:affiliate_key] = opts[:affiliate_key] if opts[:affiliate_key]
+
+      headers = init_headers opts
+      res = self.class.post("#{@api_url}/book", body: req.to_json, headers: headers).response
+      ZumataV3::ErrorClassifier.handle(res.code.to_i, res.body) unless [200,201].include?(res.code.to_i)
+      ZumataV3::GenericResponse.new(context: req, code: res.code.to_i, body: res.body)
+    end
+
+    # GET /book/status
+    def booking_status reference, opts={}
+      headers = init_headers opts
+      res = self.class.get("#{@api_url}/book/status/#{reference}", headers: headers).response
+      ZumataV3::ErrorClassifier.handle(res.code.to_i, res.body) unless [200,201].include?(res.code.to_i)
+      ZumataV3::GenericResponse.new(context: {reference: reference}, code: res.code.to_i, body: res.body)
+    end
+
+    # POST /cancel
+    def cancel reference, opts={}
+
+      req = {
+        reference: reference
+      }
+
+      headers = init_headers opts
+      res = self.class.post("#{@api_url}/cancel", body: req.to_json, headers: headers).response
+      ZumataV3::ErrorClassifier.handle(res.code.to_i, res.body) unless [200,201].include?(res.code.to_i)
+      ZumataV3::GenericResponse.new(context: {reference: reference}, code: res.code.to_i, body: res.body)
+    end
+
+    private
+
+    def init_headers opts={}
+      headers = {"X-Api-Key" => @api_key}
+      if opts[:headers] != nil && opts[:headers].class == Hash
+        headers = headers.merge(opts[:headers])
+      end
+    end
+
+  end
+end

data/lib/zumata_v3/config.rb

@@ -0,0 +1,20 @@
+module ZumataV3
+  class << self
+    attr_accessor :configuration
+  end
+ 
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+ 
+  class Configuration
+    attr_accessor :api_url, :api_key
+ 
+    def initialize
+      @api_url = ''
+      @api_key = nil
+    end
+  end
+end
+

data/lib/zumata_v3/errors.rb

@@ -0,0 +1,50 @@
+require 'json'
+require 'awesome_print'
+
+module ZumataV3
+
+  class ZumataError < StandardError; end
+  class ClientConfigError < ZumataError; end
+
+  class GeneralError < ZumataError; end
+  class BadRequestError < ZumataError; end
+  class InvalidApiKeyError < ZumataError; end
+  class ForbiddenError < ZumataError; end
+  class UnprocessableEntityError < ZumataError; end
+  class NotFoundError < ZumataError; end
+  class ServerError < ZumataError; end
+  class SupplierError < ZumataError; end
+
+  module ErrorClassifier
+    def self.handle status_code, body
+      json = nil
+      begin
+        json = JSON.parse(body)
+      rescue JSON::ParserError
+        raise GeneralError, body
+      end
+      classify_by_id(json)
+    end
+
+    def self.classify_by_id err
+      case err["id"]
+      when "bad_request"
+        raise BadRequestError, err["message"]
+      when "invalid_api_key"
+        raise InvalidApiKeyError, err["message"]
+      when "forbidden"
+        raise ForbiddenError, err["message"]
+      when "unprocessable_entity"
+        raise UnprocessableEntityError, err["message"]
+      when "not_found"
+        raise NotFoundError, err["message"]
+      when "server_error"
+        raise ServerError, err["message"]
+      when "supplier_error"
+        raise SupplierError, err["message"]
+      end
+    end
+
+  end
+
+end

data/lib/zumata_v3/responses.rb

@@ -0,0 +1,13 @@
+module ZumataV3
+
+  class GenericResponse
+    attr_reader :context, :code, :body
+
+    def initialize res
+      @context = res[:context]
+      @code = res[:code]
+      @body = res[:body]
+    end
+  end
+
+end

data/lib/zumata_v3/version.rb

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

data/lib/zumata_v3.rb

@@ -0,0 +1,8 @@
+require "zumata_v3/version"
+require "zumata_v3/errors"
+require "zumata_v3/config"
+require "zumata_v3/responses"
+require "zumata_v3/client"
+
+module ZumataV3
+end

data/spec/cassettes/2015-07-24/book_done.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3001/book
+    body:
+      encoding: UTF-8
+      string: '{"guest":{"salutation":"Mr.","first_name":"Charlie","last_name":"Smith","email":"charlie.smith@zumata.com","city":"Montreal","state":"Quebec","street":"123
+        Outtamy way","postal_code":"H3H0H0","country":"Canada","room_remarks":"3 carpets
+        please","nationality":"Canadian","contact_no":"+1 514 555-1234"},"payment":{"type":"credit"},"pre_book_id":"2b076a9d-9051-4ab5-57f7-59aaf9d8ce2d","affiliate_key":""}'
+    headers:
+      X-Api-Key:
+      - XXXX1234
+  response:
+    status:
+      code: 202
+      message: Accepted
+    headers:
+      Content-Type:
+      - application/json
+      Location:
+      - /book/status/9811f808-5284-45bc-4428-9e93b238855f
+      Date:
+      - Fri, 24 Jul 2015 06:59:21 GMT
+      Content-Length:
+      - '52'
+    body:
+      encoding: UTF-8
+      string: '{"reference":"9811f808-5284-45bc-4428-9e93b238855f"}'
+    http_version: 
+  recorded_at: Fri, 24 Jul 2015 06:59:21 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/2015-07-24/cancel_cancelled.yml

@@ -0,0 +1,28 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3001/cancel
+    body:
+      encoding: UTF-8
+      string: '{"reference":"cc7aa5e9-4cf4-436d-619d-29b7fd992c27"}'
+    headers:
+      X-Api-Key:
+      - XXXX1234
+  response:
+    status:
+      code: 422
+      message: status code 422
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 24 Jul 2015 06:59:21 GMT
+      Content-Length:
+      - '104'
+    body:
+      encoding: UTF-8
+      string: '{"id":"unprocessable_entity","message":"Invalid pre-condition to cancel","url":"http://docs.zumata.com"}'
+    http_version: 
+  recorded_at: Fri, 24 Jul 2015 06:59:21 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/2015-07-24/cancel_done.yml

@@ -0,0 +1,28 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3001/cancel
+    body:
+      encoding: UTF-8
+      string: '{"reference":"cc7aa5e9-4cf4-436d-619d-29b7fd992c27"}'
+    headers:
+      X-Api-Key:
+      - XXXX1234
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 24 Jul 2015 07:00:59 GMT
+      Content-Length:
+      - '11'
+    body:
+      encoding: UTF-8
+      string: '{"ok":true}'
+    http_version: 
+  recorded_at: Fri, 24 Jul 2015 07:00:59 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/2015-07-24/cancel_fail.yml

@@ -0,0 +1,28 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3001/cancel
+    body:
+      encoding: UTF-8
+      string: '{"reference":"invalid"}'
+    headers:
+      X-Api-Key:
+      - XXXX1234
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 24 Jul 2015 06:59:21 GMT
+      Content-Length:
+      - '71'
+    body:
+      encoding: UTF-8
+      string: '{"id":"not_found","message":"Not Found","url":"http://docs.zumata.com"}'
+    http_version: 
+  recorded_at: Fri, 24 Jul 2015 06:59:21 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/2015-07-24/get_book_done.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3001/book/status/cc7aa5e9-4cf4-436d-619d-29b7fd992c27
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Api-Key:
+      - XXXX1234
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 24 Jul 2015 06:59:21 GMT
+      Content-Length:
+      - '897'
+    body:
+      encoding: UTF-8
+      string: '{"client_reference":"cc7aa5e9-4cf4-436d-619d-29b7fd992c27","status":"CX","requested_at":"2015-07-24T14:41:24.778304+08:00","package":{"hotel_id":"","room_details":{"description":"","food":0,"room_type":"","room_view":"","beds":null},"check_in_date":"2015-07-25T00:00:00Z","check_out_date":"2015-07-26T00:00:00Z","adult_count":2,"room_count":1},"guest":{"salutation":"Mr.","first_name":"Charlie","last_name":"Smith","email":"charlie.smith@zumata.com","city":"Montreal","state":"Quebec","street":"123
+        Outtamy way","postal_code":"H3H0H0","country":"Canada","nationality":"Canadian","contact_no":"+1
+        514 555-1234","remarks":"3 carpets please"},"pricing":{"zumata":{"currency":"USD","value":72},"client":{"currency":"","value":0}},"cancellation_details":{"status":"C","cancelled_at":"2015-07-24T14:55:28.450709+08:00","api_penalty":{"currency":"","value":0},"client_penalty":{"currency":"","value":0}}}'
+    http_version: 
+  recorded_at: Fri, 24 Jul 2015 06:59:21 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/2015-07-24/get_book_fail.yml

@@ -0,0 +1,28 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3001/book/status/invalid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Api-Key:
+      - XXXX1234
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 24 Jul 2015 06:59:21 GMT
+      Content-Length:
+      - '71'
+    body:
+      encoding: UTF-8
+      string: '{"id":"not_found","message":"Not Found","url":"http://docs.zumata.com"}'
+    http_version: 
+  recorded_at: Fri, 24 Jul 2015 06:59:21 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/2015-07-24/get_prebook_done.yml

@@ -0,0 +1,28 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3001/pre_book/2b076a9d-9051-4ab5-57f7-59aaf9d8ce2d
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Api-Key:
+      - XXXX1234
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 24 Jul 2015 06:59:21 GMT
+      Content-Length:
+      - '802'
+    body:
+      encoding: UTF-8
+      string: '{"pre_book_id":"2b076a9d-9051-4ab5-57f7-59aaf9d8ce2d","cancellation_policy":{"remarks":"","cancellation_policies":[{"original_rate":0,"penalty_percentage":100,"date_from":"2015-07-23T00:00:00Z","date_to":"2304-07-24T14:40:16Z"}]},"request":{"search":{"destination_id":"f75a8cff-c26e-4603-7b45-1b0f8a5aa100","check_in_date":"2015-07-25","check_out_date":"2015-07-26","room_count":1,"adult_count":2},"package":{"hotel_id":"00d7ed72-2325-4225-5e95-02d340e48fe5","room_details":{"description":"Superior","food":1,"room_type":"Superior","room_view":"","beds":{"single":2}},"booking_key":"39c90b48","room_rate":144.92,"room_rate_currency":"USD","chargeable_rate":159.92,"chargeable_rate_currency":"USD"},"config":{"pricing":{"fixed_tolerance":1},"matching":{"flexible_room_view":true,"flexible_beds":true}}}}'
+    http_version: 
+  recorded_at: Fri, 24 Jul 2015 06:59:21 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/2015-07-24/get_prebook_fail.yml

@@ -0,0 +1,28 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3001/pre_book/invalid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Api-Key:
+      - XXXX1234
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Fri, 24 Jul 2015 06:59:21 GMT
+      Content-Length:
+      - '71'
+    body:
+      encoding: UTF-8
+      string: '{"id":"not_found","message":"Not Found","url":"http://docs.zumata.com"}'
+    http_version: 
+  recorded_at: Fri, 24 Jul 2015 06:59:21 GMT
+recorded_with: VCR 2.9.3