zumata_v3 0.0.1

data/spec/zumata_spec.rb

@@ -0,0 +1,228 @@
+require 'json'
+require 'spec_helper'
+require './lib/zumata_v3'
+
+describe "ZumataV3::HotelClient configuration" do
+
+  it 'will raise an error if api & url are not provided' do
+
+    expect{
+      ZumataV3.configure do |config|
+        config.api_url = nil
+        config.api_key = nil
+      end
+      ZumataV3::HotelClient.new
+      }.to raise_error(ZumataV3::ClientConfigError)
+
+    expect{
+      ZumataV3.configure do |config|
+        config.api_url = ENV["ZUMATA_API_URL"]
+        config.api_key = nil
+      end
+      ZumataV3::HotelClient.new
+      }.to raise_error(ZumataV3::ClientConfigError)
+
+    expect{
+      ZumataV3.configure do |config|
+        config.api_url = nil
+        config.api_key = ENV["ZUMATA_API_KEY"]
+      end
+      ZumataV3::HotelClient.new
+      }.to raise_error(ZumataV3::ClientConfigError)
+
+  end
+
+end
+
+describe "ZumataV3::HotelClient endpoints" do
+
+  $vcr_recorded_check_in_date = "2015-07-24"
+  $vcr_recorded_check_out_date = "2015-07-25"
+
+  before(:each) do
+
+    raise "Tests require environment variable 'ZUMATA_API_KEY' to be configured" unless ENV["ZUMATA_API_KEY"]
+
+    ZumataV3.configure do |config|
+      config.api_url = ENV["ZUMATA_API_URL"]
+      config.api_key = ENV["ZUMATA_API_KEY"]
+    end
+
+    @client = ZumataV3::HotelClient.new
+  end
+
+  describe "search_by_destination_id" do
+
+    it 'returns a successful response if the query is valid', :vcr => { :cassette_name => "#{$vcr_recorded_check_in_date}/search_by_destination_id_done", :record => :new_episodes } do
+      # note - when recording the cassette this requires a cached search w/ results to exist
+      destination_id = "f75a8cff-c26e-4603-7b45-1b0f8a5aa100" # Singapore
+      results = @client.search_by_destination_id destination_id, {check_in_date: $vcr_recorded_check_in_date, check_out_date: $vcr_recorded_check_out_date}
+    	data = JSON.parse(results.body)
+      expect(data).to_not be(nil)
+      expect(data["search"]).to_not be(nil)
+      expect(data["results"]).to_not be(nil)
+    end
+
+    it 'raises an error if invalid inputs are provided', :vcr => { :cassette_name => "#{$vcr_recorded_check_in_date}/search_by_destination_id_fail", :record => :new_episodes } do
+      destination_id = "invalid"
+      expect{
+        @client.search_by_destination_id destination_id, {check_in_date: $vcr_recorded_check_in_date, check_out_date: $vcr_recorded_check_out_date}
+      }.to raise_error(ZumataV3::BadRequestError)
+    end
+
+  end
+
+  describe "pre_book" do
+
+    def sample_search destination_id="f75a8cff-c26e-4603-7b45-1b0f8a5aa100"
+      return {
+        :destination_id => destination_id,
+        :check_in_date => $vcr_recorded_check_in_date,
+        :check_out_date => $vcr_recorded_check_out_date,
+        :room_count => 1,
+        :adult_count => 2
+      }
+    end
+
+    def sample_package
+      return {
+        :hotel_id => "00d7ed72-2325-4225-5e95-02d340e48fe5",
+        :room_details => {
+          :description => "Superior",
+          :food => 0,
+          :room_type => "Superior",
+          :room_view => "",
+          :beds => {
+            :single => 2
+          }
+        },
+        :booking_key => "39c90b48",
+        :room_rate => 144.92,
+        :room_rate_currency => "USD",
+        :chargeable_rate => 15,
+        :chargeable_rate_currency => "USD"
+      }
+    end
+
+    def sample_config
+      return {
+        :pricing => {
+          :fixed_tolerance => 1
+        },
+        :matching => {
+          :flexible_room_view => true,
+          :flexible_beds => true
+        }
+      }
+    end
+
+    it 'pre-books a package returned from the search request and return booking information' , :vcr => { :cassette_name => "#{$vcr_recorded_check_in_date}/prebook_done", :record => :new_episodes } do
+      results = @client.pre_book sample_search, sample_package, sample_config
+    	data = JSON.parse(results.body)
+      expect(data).to_not be(nil)
+      expect(data["pre_book_id"]).to_not be(nil)
+      expect(data["cancellation_policy"]["remarks"]).to_not be(nil)
+      expect(data["cancellation_policy"]["cancellation_policies"]).to_not be(nil)
+    end
+
+    it 'raises an error if invalid inputs are provided', :vcr => { :cassette_name => "#{$vcr_recorded_check_in_date}/prebook_fail", :record => :new_episodes } do
+      expect{
+        @client.pre_book sample_search("invalid_destination_id"), sample_package, sample_config
+      }.to raise_error(ZumataV3::BadRequestError)
+    end
+
+  end
+
+  describe "pre_book_details" do
+
+    it 'returns a successful response if the query is valid', :vcr => { :cassette_name => "#{$vcr_recorded_check_in_date}/get_prebook_done", :record => :new_episodes } do
+      pre_book_id = "2b076a9d-9051-4ab5-57f7-59aaf9d8ce2d"
+      results = @client.pre_book_details pre_book_id
+    	data = JSON.parse(results.body)
+      expect(data).to_not be(nil)
+      expect(data["pre_book_id"]).to_not be(nil)
+    end
+
+    it 'raises an error if pre-book id provided is invalid', :vcr => { :cassette_name => "#{$vcr_recorded_check_in_date}/get_prebook_fail", :record => :new_episodes } do
+      pre_book_id = "invalid"
+      expect{
+        results = @client.pre_book_details pre_book_id
+      }.to raise_error(ZumataV3::NotFoundError)
+    end
+
+  end
+
+  describe "book_by_credit" do
+
+    def sample_guest
+      return {
+        :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",
+      }
+    end
+
+    it 'books a package after a pre-booking request has been made (by credit) and return client reference', :vcr => { :cassette_name => "#{$vcr_recorded_check_in_date}/book_done", :record => :new_episodes } do
+      pre_book_id = "2b076a9d-9051-4ab5-57f7-59aaf9d8ce2d"
+      results = @client.book_by_credit sample_guest, pre_book_id, {affiliate_key: ""}
+    	data = JSON.parse(results.body)
+      expect(data).to_not be(nil)
+      expect(data["reference"]).not_to eq(nil)
+    end
+
+  end
+
+  describe "booking_status" do
+
+    it 'returns a successful response if the reference id is valid', :vcr => { :cassette_name => "#{$vcr_recorded_check_in_date}/get_book_done", :record => :new_episodes } do
+      reference = "cc7aa5e9-4cf4-436d-619d-29b7fd992c27"
+      results = @client.booking_status reference
+    	data = JSON.parse(results.body)
+      expect(data).to_not be(nil)
+      expect(data["client_reference"]).not_to eq(nil)
+    end
+
+    it 'raises an error if reference id provided is invalid', :vcr => { :cassette_name => "#{$vcr_recorded_check_in_date}/get_book_fail", :record => :new_episodes } do
+      reference = "invalid"
+      expect{
+        results = @client.booking_status reference
+      }.to raise_error(ZumataV3::NotFoundError)
+    end
+
+  end
+
+  describe "cancel" do
+
+    it "returns a successful response if the reference id is valid", :vcr => { :cassette_name => "#{$vcr_recorded_check_in_date}/cancel_done", :record => :new_episodes } do
+      reference = "cc7aa5e9-4cf4-436d-619d-29b7fd992c27"
+      results = @client.cancel reference
+      data = JSON.parse(results.body)
+      expect(data).to_not be(nil)
+    end
+
+    it "raise an error if reference id provided is already cancelled", :vcr => { :cassette_name => "#{$vcr_recorded_check_in_date}/cancel_cancelled", :record => :new_episodes } do
+      reference = "cc7aa5e9-4cf4-436d-619d-29b7fd992c27"
+      expect{
+        results = @client.cancel reference
+      }.to raise_error(ZumataV3::UnprocessableEntityError)
+    end
+
+    it "raise an error if reference id provided is invalid", :vcr => { :cassette_name => "#{$vcr_recorded_check_in_date}/cancel_fail", :record => :new_episodes } do
+      reference = "invalid"
+      expect{
+        results = @client.cancel reference
+      }.to raise_error(ZumataV3::NotFoundError)
+    end
+
+  end
+
+end

data/zumata_v3.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zumata_v3/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zumata_v3"
+  spec.version       = ZumataV3::VERSION
+  spec.authors       = ["Jonathan Gomez", "Martin Koh"]
+  spec.email         = ["enquiry@zumata.com"]
+  spec.summary       = %q{Client for the Zumata API 3.0}
+  spec.description   = %q{Power a hotel website - search hotels, create and manage bookings.}
+  spec.homepage      = "https://github.com/Zumata/v3-ruby-client"
+  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", "~> 10.0"
+  spec.add_development_dependency "rspec", "3.1.0"
+  spec.add_development_dependency "awesome_print", "1.2.0"
+  spec.add_development_dependency "vcr", "2.9.3"
+  spec.add_development_dependency "webmock", "1.18.0"
+
+  spec.add_runtime_dependency 'httparty', '~> 0.13', '>= 0.13.1'
+
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: zumata_v3
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Gomez
+- Martin Koh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-28 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: '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.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+description: Power a hotel website - search hotels, create and manage bookings.
+email:
+- enquiry@zumata.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/example.rb
+- lib/zumata_v3.rb
+- lib/zumata_v3/client.rb
+- lib/zumata_v3/config.rb
+- lib/zumata_v3/errors.rb
+- lib/zumata_v3/responses.rb
+- lib/zumata_v3/version.rb
+- spec/cassettes/2015-07-24/book_done.yml
+- spec/cassettes/2015-07-24/cancel_cancelled.yml
+- spec/cassettes/2015-07-24/cancel_done.yml
+- spec/cassettes/2015-07-24/cancel_fail.yml
+- spec/cassettes/2015-07-24/get_book_done.yml
+- spec/cassettes/2015-07-24/get_book_fail.yml
+- spec/cassettes/2015-07-24/get_prebook_done.yml
+- spec/cassettes/2015-07-24/get_prebook_fail.yml
+- spec/cassettes/2015-07-24/prebook_done.yml
+- spec/cassettes/2015-07-24/prebook_fail.yml
+- spec/cassettes/2015-07-24/search_by_destination_id_done.yml
+- spec/cassettes/2015-07-24/search_by_destination_id_fail.yml
+- spec/spec_helper.rb
+- spec/zumata_spec.rb
+- zumata_v3.gemspec
+homepage: https://github.com/Zumata/v3-ruby-client
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Client for the Zumata API 3.0
+test_files:
+- spec/cassettes/2015-07-24/book_done.yml
+- spec/cassettes/2015-07-24/cancel_cancelled.yml
+- spec/cassettes/2015-07-24/cancel_done.yml
+- spec/cassettes/2015-07-24/cancel_fail.yml
+- spec/cassettes/2015-07-24/get_book_done.yml
+- spec/cassettes/2015-07-24/get_book_fail.yml
+- spec/cassettes/2015-07-24/get_prebook_done.yml
+- spec/cassettes/2015-07-24/get_prebook_fail.yml
+- spec/cassettes/2015-07-24/prebook_done.yml
+- spec/cassettes/2015-07-24/prebook_fail.yml
+- spec/cassettes/2015-07-24/search_by_destination_id_done.yml
+- spec/cassettes/2015-07-24/search_by_destination_id_fail.yml
+- spec/spec_helper.rb
+- spec/zumata_spec.rb