hotels_pro 0.2

data/spec/hotels_pro/api/methods/make_hotel_booking_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe HotelsPro::Api::Methods::MakeHotelBooking do
+  include RequestHelper
+
+  it "should build correct api params hash" do
+    method = HotelsPro::Api::Methods::MakeHotelBooking.new(
+      :process_id => "HF-56017745",
+      :agency_reference_number => "999",
+      :lead_traveller_info => HotelsPro::Api::Elements::LeadTraveller.new(
+        :pax_info => HotelsPro::Api::Elements::Pax.new(:pax_type => "Adult", :title => "Mr", :first_name => "John", :last_name => "Doe"),
+        :nationality => "US"
+      ),
+      :other_traveller_info => [
+        HotelsPro::Api::Elements::Pax.new(:pax_type => "Adult", :age => 30, :title => "Mrs", :first_name => "Amanda", :last_name => "Doe")
+      ],
+      :preferences => "nonSmoking",
+      :note => "I like french fries"
+    )
+
+    method.to_api_params.should == {
+      "processId" => "HF-56017745",
+      "agencyReferenceNumber" => "999",
+      "leadTravellerInfo" => {
+        "paxInfo" => {
+          "paxType" => "Adult",
+          "title" => "Mr",
+          "firstName" => "John",
+          "lastName" => "Doe"
+        },
+        "nationality" => "US"
+      },
+      "otherTravellerInfo" => [
+        { "paxType" => "Adult", "age" => "30", "title" => "Mrs", "firstName" => "Amanda", "lastName" => "Doe" }
+      ],
+      "preferences" => "nonSmoking",
+      "note" => "I like french fries"
+    }
+  end
+
+  it "should return result when performed" do
+    HotelsPro::Stubs.make_hotel_booking.response(fixture('make_hotel_booking'))
+
+    method = HotelsPro::Api::Methods::MakeHotelBooking.new(
+      :process_id => "HF-56017745",
+      :agency_reference_number => "999",
+      :lead_traveller_info => HotelsPro::Api::Elements::LeadTraveller.new(
+        :pax_info => HotelsPro::Api::Elements::Pax.new(:pax_type => "Adult", :title => "Mr", :first_name => "John", :last_name => "Doe"),
+        :nationality => "US"
+      ),
+      :other_traveller_info => [
+        HotelsPro::Api::Elements::Pax.new(:pax_type => "Adult", :age => 30, :title => "Mrs", :first_name => "Amanda", :last_name => "Doe")
+      ],
+      :preferences => "nonSmoking",
+      :note => "I like french fries"
+    )
+
+    result = method.perform
+
+    result.should be_instance_of HotelsPro::Api::Methods::MakeHotelBooking::Result
+    result.response_id.should == 5756635
+    result.tracking_id.should == "XI-HE-70838364"
+    result.hotel_booking_info.should be_instance_of HotelsPro::Api::Elements::BookInfo
+    result.hotel_booking_info.hotel_code.should == "US2HZR"
+  end
+end

data/spec/hotels_pro/query_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe HotelsPro::Query do
+  it "should encode hash" do
+    params = { "a" => "1", "b" => "2" }
+
+    query = HotelsPro::Query.new(params)
+    query.to_s.should include("a=1")
+    query.to_s.should include("b=2")
+  end
+
+  it "should encode hashes of hashes" do
+    params = { "a" => { "b" => "2", "c" => "3" } }
+
+    query = HotelsPro::Query.new(params)
+    query.to_s.should include("a[b]=2")
+    query.to_s.should include("a[c]=3")
+  end
+
+  it "should encode hashes of arrays" do
+    params = { "a" => ["2", "3"] }
+
+    query = HotelsPro::Query.new(params)
+    query.to_s.should include("a[0]=2")
+    query.to_s.should include("a[1]=3")
+  end
+
+  it "should encode hashes of arrays of hashes" do
+    params = { "a" => [{ "b" => "2" }, { "c" => "3" }] }
+
+    query = HotelsPro::Query.new(params)
+    query.to_s.should include("a[0][b]=2")
+    query.to_s.should include("a[1][c]=3")
+  end
+
+  it "should encode hashes of arrays of arrays of hashes" do
+    params = { "a" => [[{ "b" => "2" }, { "c" => "3" }], [{ "d" => "4" }, { "e" => "5" }]] }
+
+    query = HotelsPro::Query.new(params)
+    query.to_s.should include("a[0][0][b]=2")
+    query.to_s.should include("a[0][1][c]=3")
+    query.to_s.should include("a[1][0][d]=4")
+    query.to_s.should include("a[1][1][e]=5")
+  end
+
+  it "should escape values" do
+    params = { "a" => "foo bar" }
+
+    query = HotelsPro::Query.new(params)
+    query.to_s.should == "?a=foo%20bar"
+  end
+end

data/spec/hotels_pro/request_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe HotelsPro::Request do
+  include RequestHelper
+
+  before(:each) do
+    @request = HotelsPro::Request.new("getAvailableHotel", :param1 => "value1", :param2 => "value2")
+  end
+
+  it "should be defined with params hash" do
+    @request.params.should == { :param1 => "value1", :param2 => "value2" }
+  end
+
+  it "should build query from params, api method and api key" do
+    query = @request.query
+
+    query.should =~ /param1=value1/
+    query.should =~ /param2=value2/
+    query.should =~ /method=getAvailableHotel/
+    query.should =~ /apiKey=123/
+  end
+
+  it "should build uri from api url and query" do
+    @request.uri.should == "#{HotelsPro.configuration.api_url}#{@request.query}"
+  end
+
+  it "should return response" do
+    HotelsPro::Stubs.get_available_hotel.response(fixture("get_available_hotel"))
+
+    response = @request.perform
+    response.should be_an_instance_of HotelsPro::Response
+  end
+
+  context "when only_stubs is true" do
+    before do
+      @only_stubs = HotelsPro.configuration.only_stubs
+      HotelsPro.configure do |config|
+        config.only_stubs = true
+      end
+    end
+
+    after do
+      HotelsPro.configure do |config|
+        config.only_stubs = @only_stubs
+      end
+    end
+
+    it "should raise exception when performing unstubbed request" do
+      lambda{ @request.perform }.should raise_exception(HotelsPro::UnstubbedRequest)
+    end
+  end
+
+  context "when only_stubs is false" do
+    before do
+      @only_stubs = HotelsPro.configuration.only_stubs
+      HotelsPro.configure do |config|
+        config.only_stubs = false
+      end
+    end
+
+    after do
+      HotelsPro.configure do |config|
+        config.only_stubs = @only_stubs
+      end
+    end
+
+    it "should not raise exception when performing unstubbed request" do
+      # Stub it with Typhoeus
+      Typhoeus::Hydra.hydra.stub(:get, @request.uri).and_return(Typhoeus::Response.new(:status => 200, :body => "''", :headers => '', :time => 0.1))
+      lambda{ @request.perform }.should_not raise_exception
+    end
+  end
+end

data/spec/hotels_pro/response_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe HotelsPro::Response do
+  it "should detect response errors" do
+    response = HotelsPro::Response.new('[0, "error message"]')
+    response.error?.should be_true
+    response.error.should be_instance_of(HotelsPro::ErrorResponse)
+    response.error.message.should == "error message"
+  end
+
+  it "should detect JSON parsing errors" do
+    response = HotelsPro::Response.new('non-json')
+    response.error?.should be_true
+    response.error.should be_instance_of(HotelsPro::RemoteError)
+    response.error.message.should == "Remote API down."
+  end
+
+  it "should parse and underscore json response" do
+    response = HotelsPro::Response.new('{"paramOne": "value1"}')
+    response.error?.should be_false
+    response.error.should be_nil
+    response.data.should == { "param_one" => "value1" }
+  end
+end

data/spec/hotels_pro/stubs/stub_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe HotelsPro::Stubs::Stub do
+  it "should set response and return self (be chainable)" do
+    matcher = lambda { |request| true }
+    the_stub = HotelsPro::Stubs::Stub.new("foo", matcher)
+    the_stub.response("bar").should == the_stub
+    the_stub.response.should == "bar"
+  end
+
+  it "should not match request with different api method" do
+    matcher = lambda { |request| true }
+    the_stub = HotelsPro::Stubs::Stub.new("foo", matcher).response("response")
+    request = stub(:api_method => "bar")
+
+    the_stub.matches?(request).should be_false
+  end
+
+  it "should not match request if matcher evaluates to false" do
+    matcher = lambda { |request| false }
+    the_stub = HotelsPro::Stubs::Stub.new("foo", matcher).response("response")
+    request = stub(:api_method => "foo")
+
+    the_stub.matches?(request).should be_false
+  end
+
+  it "should match request when api method is correct and matcher evaluates to true" do
+    matcher = lambda { |request| true }
+    the_stub = HotelsPro::Stubs::Stub.new("foo", matcher).response("response")
+    request = stub(:api_method => "foo")
+
+    the_stub.matches?(request).should be_true
+  end
+
+  it "should match request when api method is correct and matcher is not set" do
+    the_stub = HotelsPro::Stubs::Stub.new("foo").response("response")
+    request = stub(:api_method => "foo")
+
+    the_stub.matches?(request).should be_true
+  end
+end

data/spec/hotels_pro/stubs_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe HotelsPro::Stubs do
+  before do
+    HotelsPro::Stubs.clear
+  end
+
+  it "should add a stub" do
+    matcher = lambda { |request| true }
+    HotelsPro::Stubs.get_available_hotel(matcher).response("response")
+
+    HotelsPro::Stubs.stubs.size.should == 1
+  end
+
+  context "with stub added" do
+    before do
+      matcher = lambda { |request| request.foo == "bar" }
+      HotelsPro::Stubs.get_available_hotel(matcher).response("response")
+      HotelsPro::Stubs.stubs.size.should == 1
+    end
+
+    it "should clear stubs" do
+      HotelsPro::Stubs.clear
+      HotelsPro::Stubs.stubs.size.should == 0
+    end
+
+    it "should return response when request matches a stub" do
+      request = stub(:api_method => 'getAvailableHotel', :foo => "bar")
+      HotelsPro::Stubs.match(request).should == "response"
+    end
+
+    it "should return nil when request does not match a stub" do
+      request = stub(:api_method => 'getAvailableHotel', :foo => "baz")
+      HotelsPro::Stubs.match(request).should be_nil
+    end
+  end
+end

data/spec/hotels_pro/underscorer_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe HotelsPro::Underscorer do
+  before do
+    @u = Object.new
+    @u.extend HotelsPro::Underscorer
+  end
+
+  it "should underscore hash keys" do
+    underscored = @u.underscore("paramOne" => "value1", "paramTwo" => "value2")
+    underscored.should == { "param_one" => "value1", "param_two" => "value2" }
+  end
+
+  it "should underscore nested hash's keys" do
+    underscored = @u.underscore("a" => { "paramTwo" => "value2" })
+    underscored.should == { "a" => { "param_two" => "value2" } }
+  end
+
+  it "should underscore keys of hashes found in arrays" do
+    underscored = @u.underscore( [{ "paramOne" => "value1" }, { "paramTwo" => "value2" }])
+    underscored.should == [{ "param_one" => "value1" }, { "param_two" => "value2" }]
+  end
+
+  it "should underscore keys of hashes found in nested arrays" do
+    underscored = @u.underscore( "a" => [{ "paramOne" => "value1" }, { "paramTwo" => "value2" }])
+    underscored.should == { "a" => [{ "param_one" => "value1" }, { "param_two" => "value2" }]}
+  end
+
+  it "should not fail on non-hashes or non-arrays" do
+    underscored = @u.underscore("foo")
+    underscored.should == "foo"
+  end
+end

data/spec/request_helper.rb

@@ -0,0 +1,6 @@
+module RequestHelper
+  def fixture(filename)
+    fixture_file = File.expand_path(File.join(File.dirname(__FILE__), "fixtures", "#{filename}.json"))
+    File.read(fixture_file)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'hotels_pro'
+
+require 'api_params_helper'
+require 'request_helper'
+
+HotelsPro.configure do |config|
+  config.api_key = "123"
+  config.only_stubs = true
+end
+
+RSpec.configure do |config|
+  config.before(:each) { HotelsPro::Stubs.clear }
+end

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: hotels_pro
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Michał Szajbe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: typhoeus
+  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: virtus
+  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: rspec
+  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: ZenTest
+  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'
+description: HotelsPro API wrapper
+email:
+- michal.szajbe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hotels_pro.gemspec
+- lib/hotels_pro.rb
+- lib/hotels_pro/api/api_method.rb
+- lib/hotels_pro/api/api_params.rb
+- lib/hotels_pro/api/elements/book_info.rb
+- lib/hotels_pro/api/elements/daily_rate.rb
+- lib/hotels_pro/api/elements/filter.rb
+- lib/hotels_pro/api/elements/hotel.rb
+- lib/hotels_pro/api/elements/lead_traveller.rb
+- lib/hotels_pro/api/elements/pax.rb
+- lib/hotels_pro/api/elements/pax_array.rb
+- lib/hotels_pro/api/elements/policy.rb
+- lib/hotels_pro/api/elements/room_response.rb
+- lib/hotels_pro/api/methods/allocate_hotel_code.rb
+- lib/hotels_pro/api/methods/amend_hotel_booking.rb
+- lib/hotels_pro/api/methods/cancel_hotel_booking.rb
+- lib/hotels_pro/api/methods/get_available_hotel.rb
+- lib/hotels_pro/api/methods/get_balance.rb
+- lib/hotels_pro/api/methods/get_hotel_booking_status.rb
+- lib/hotels_pro/api/methods/get_hotel_cancellation_policy.rb
+- lib/hotels_pro/api/methods/make_hotel_booking.rb
+- lib/hotels_pro/configuration.rb
+- lib/hotels_pro/query.rb
+- lib/hotels_pro/request.rb
+- lib/hotels_pro/response.rb
+- lib/hotels_pro/stubs.rb
+- lib/hotels_pro/stubs/stub.rb
+- lib/hotels_pro/underscorer.rb
+- lib/hotels_pro/version.rb
+- spec/api_params_helper.rb
+- spec/fixtures/allocate_hotel_code.json
+- spec/fixtures/amend_hotel_booking.json
+- spec/fixtures/cancel_hotel_booking.json
+- spec/fixtures/get_available_hotel.json
+- spec/fixtures/get_balance.json
+- spec/fixtures/get_hotel_booking_status.json
+- spec/fixtures/get_hotel_cancellation_policy.json
+- spec/fixtures/make_hotel_booking.json
+- spec/hotels_pro/api/.gitkeep
+- spec/hotels_pro/api/api_method_spec.rb
+- spec/hotels_pro/api/api_params_spec.rb
+- spec/hotels_pro/api/elements/pax_array_spec.rb
+- spec/hotels_pro/api/methods/allocate_hotel_code_spec.rb
+- spec/hotels_pro/api/methods/amend_hotel_booking_spec.rb
+- spec/hotels_pro/api/methods/cancel_hotel_booking_spec.rb
+- spec/hotels_pro/api/methods/get_available_hotel_spec.rb
+- spec/hotels_pro/api/methods/get_balance_spec.rb
+- spec/hotels_pro/api/methods/get_hotel_booking_status_spec.rb
+- spec/hotels_pro/api/methods/get_hotel_cancellation_policy_spec.rb
+- spec/hotels_pro/api/methods/make_hotel_booking_spec.rb
+- spec/hotels_pro/query_spec.rb
+- spec/hotels_pro/request_spec.rb
+- spec/hotels_pro/response_spec.rb
+- spec/hotels_pro/stubs/stub_spec.rb
+- spec/hotels_pro/stubs_spec.rb
+- spec/hotels_pro/underscorer_spec.rb
+- spec/request_helper.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.0
+signing_key: 
+specification_version: 4
+summary: HotelsPro API wrapper
+test_files:
+- spec/api_params_helper.rb
+- spec/fixtures/allocate_hotel_code.json
+- spec/fixtures/amend_hotel_booking.json
+- spec/fixtures/cancel_hotel_booking.json
+- spec/fixtures/get_available_hotel.json
+- spec/fixtures/get_balance.json
+- spec/fixtures/get_hotel_booking_status.json
+- spec/fixtures/get_hotel_cancellation_policy.json
+- spec/fixtures/make_hotel_booking.json
+- spec/hotels_pro/api/.gitkeep
+- spec/hotels_pro/api/api_method_spec.rb
+- spec/hotels_pro/api/api_params_spec.rb
+- spec/hotels_pro/api/elements/pax_array_spec.rb
+- spec/hotels_pro/api/methods/allocate_hotel_code_spec.rb
+- spec/hotels_pro/api/methods/amend_hotel_booking_spec.rb
+- spec/hotels_pro/api/methods/cancel_hotel_booking_spec.rb
+- spec/hotels_pro/api/methods/get_available_hotel_spec.rb
+- spec/hotels_pro/api/methods/get_balance_spec.rb
+- spec/hotels_pro/api/methods/get_hotel_booking_status_spec.rb
+- spec/hotels_pro/api/methods/get_hotel_cancellation_policy_spec.rb
+- spec/hotels_pro/api/methods/make_hotel_booking_spec.rb
+- spec/hotels_pro/query_spec.rb
+- spec/hotels_pro/request_spec.rb
+- spec/hotels_pro/response_spec.rb
+- spec/hotels_pro/stubs/stub_spec.rb
+- spec/hotels_pro/stubs_spec.rb
+- spec/hotels_pro/underscorer_spec.rb
+- spec/request_helper.rb
+- spec/spec_helper.rb
+has_rdoc: