hotels_pro 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af5efa021ba1f29da56382ef13436559b83a742a
+  data.tar.gz: cde28945188e118c574f53717b5f0189a170a9d2
+SHA512:
+  metadata.gz: 974eb44538ce151f543ab04e1f8ed9041af9b6118ba6ce34469665b92c4c330ed1e6c33ed218ea5068a7e7ae0cb42042080ac8fba3053fff32435ba4f0975dca
+  data.tar.gz: ce797d5446e7b5354d46bdd92247a6016ca597193d44d97d19d5d331cf4cf20882a042f42a5139dba06b72741d0effeec74e2567603a21b3fb5b6518519c0664

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+script: "bundle exec rspec ./spec/"
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michał Szajbe
+
+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,91 @@
+# HotelsPro
+
+[![Build Status](https://secure.travis-ci.org/monterail/hotels_pro.png)](http://travis-ci.org/monterail/hotels_pro)
+
+HotelsPro API wrapper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hotels_pro'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hotels_pro
+
+## Configuration
+
+    HotelsPro.configure do |config|
+      config.api_key = "your_api_key"       # required
+      config.environment = "live"           # "live" or "test"; defaults to "test"
+      config.logger = Logger.new(STDOUT)    # optional
+      config.only_stubs = false             # optional; defaults to "false"; see 'Stubbing requests' section for details
+    end
+
+## Usage
+
+Since this is a really simple wrapper for HotelsPro API it only let's you build API method calls with Ruby and returns responses as Ruby objects. It uses [virtus](https://github.com/solnic/virtus) under the hood to build objects.
+
+    method = HotelsPro::Api::Methods::GetAvailableHotel.new(
+      :destination_id => "LD6J",
+      :client_nationality => "US",
+      :currency => "EUR",
+      :check_in => Date.parse("2012-08-14"),
+      :check_out => Date.parse("2012-08-21"),
+      :rooms => [
+        HotelsPro::Api::Elements::PaxArray.new(
+          :paxes => [
+            HotelsPro::Api::Elements::Pax.new(:pax_type => "Adult"),
+            HotelsPro::Api::Elements::Pax.new(:pax_type => "Adult")
+          ]
+        ),
+        HotelsPro::Api::Elements::PaxArray.new(
+          :paxes => [
+            HotelsPro::Api::Elements::Pax.new(:pax_type => "Adult"),
+            HotelsPro::Api::Elements::Pax.new(:pax_type => "Child", :age => 10)
+          ]
+        )
+      ]
+    )
+
+    result = method.perform
+
+    result.response_id
+    # => 4322779
+
+    result.available_hotels
+    # => Array of HotelsPro::Api::Elements::Hotel objects
+
+    result.total_found
+    # => 10
+
+    result.search_id
+    # => "SZ-91588250"
+
+## Stubbing requests
+
+You can stub requests for testing or to provide fixed responses.
+
+    HotelsPro::Stubs.get_available_hotel.response(json)
+
+The above snippet will stub all requests to getAvailableHotel api method, so they return specified `json` response.
+
+If you want to stub only some requests or to return different response depending on request params, provide a `matcher`.
+
+    matcher = lambda { |request| request.destination_id == "LD6J" }
+    HotelsPro::Stubs.get_available_hotel(matcher).response(json)
+
+In testing no requests should hit the remote API. If `only_stubs` configuration option is enabled, exception will be raised anytime an unstubbed request is performed.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/hotels_pro.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hotels_pro/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michał Szajbe"]
+  gem.email         = ["michal.szajbe@gmail.com"]
+  gem.description   = %q{HotelsPro API wrapper}
+  gem.summary       = %q{HotelsPro API wrapper}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hotels_pro"
+  gem.require_paths = ["lib"]
+  gem.version       = HotelsPro::VERSION
+
+  gem.add_dependency "activesupport"
+  gem.add_dependency "json"
+  gem.add_dependency "typhoeus"
+  gem.add_dependency "virtus"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "ZenTest"
+end

data/lib/hotels_pro.rb

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'active_support'
+require 'json'
+require 'typhoeus'
+require 'virtus'
+
+require "hotels_pro/api/api_params"
+require "hotels_pro/api/api_method"
+require "hotels_pro/api/elements/book_info"
+require "hotels_pro/api/elements/daily_rate"
+require "hotels_pro/api/elements/filter"
+require "hotels_pro/api/elements/room_response"
+require "hotels_pro/api/elements/hotel"
+require "hotels_pro/api/elements/lead_traveller"
+require "hotels_pro/api/elements/pax"
+require "hotels_pro/api/elements/pax_array"
+require "hotels_pro/api/elements/policy"
+require "hotels_pro/api/methods/allocate_hotel_code"
+require "hotels_pro/api/methods/amend_hotel_booking"
+require "hotels_pro/api/methods/cancel_hotel_booking"
+require "hotels_pro/api/methods/get_available_hotel"
+require "hotels_pro/api/methods/get_balance"
+require "hotels_pro/api/methods/get_hotel_booking_status"
+require "hotels_pro/api/methods/get_hotel_cancellation_policy"
+require "hotels_pro/api/methods/make_hotel_booking"
+require "hotels_pro/configuration"
+require "hotels_pro/query"
+require "hotels_pro/request"
+require "hotels_pro/response"
+require "hotels_pro/stubs"
+require "hotels_pro/stubs/stub"
+require "hotels_pro/underscorer"
+require "hotels_pro/version"
+
+module HotelsPro
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def log(message)
+      if configuration.logger
+        configuration.logger.info("[HotelsPro] #{message}")
+      end
+    end
+
+    def get_available_hotel(options={})
+      HotelsPro::Api::Methods::GetAvailableHotel.new(options).perform
+    end
+
+    def allocate_hotel_code(options={})
+      HotelsPro::Api::Methods::AllocateHotelCode.new(options).perform
+    end
+  end
+
+  class ErrorResponse < ::StandardError
+  end
+
+  class RemoteError < ::StandardError
+  end
+
+  class UnstubbedRequest < ::StandardError
+  end
+end

data/lib/hotels_pro/api/api_method.rb

@@ -0,0 +1,29 @@
+module HotelsPro
+  module Api
+    class ApiMethod
+      include ApiParams
+      include Virtus
+
+      class Result
+        include Virtus
+      end
+
+      def perform
+        response = request.perform
+
+        if response.error?
+          raise response.error
+        else
+          "#{self.class.name}::Result".constantize.new(response.data)
+        end
+      end
+
+      private
+
+      def request
+        api_method = self.class.name.to_s.demodulize
+        Request.new(api_method, to_api_params)
+      end
+    end
+  end
+end

data/lib/hotels_pro/api/api_params.rb

@@ -0,0 +1,29 @@
+require 'active_support'
+
+module HotelsPro
+  module Api
+    module ApiParams
+      def to_api_params
+        (attributes || []).inject({}) do |params, (k, v)|
+          unless v.nil? or (v.respond_to?(:empty?) and v.empty?)
+            params[api_param_name(k)] = api_param_value(v)
+          end
+          params
+        end
+      end
+
+      def api_param_name(attribute)
+        attribute.to_s.camelize(:lower)
+      end
+
+      def api_param_value(value)
+        case value
+        when Array
+          value.map{ |element| api_param_value(element) }
+        else
+          value.respond_to?(:to_api_params) ? value.to_api_params : value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/hotels_pro/api/elements/book_info.rb

@@ -0,0 +1,27 @@
+require 'hotels_pro/api/elements/pax_array'
+require 'hotels_pro/api/elements/policy'
+
+module HotelsPro
+  module Api
+    module Elements
+      class BookInfo
+        include Virtus
+
+        attribute :booking_status, Integer
+        attribute :confirmation_number, String
+        attribute :supplier, String
+        attribute :hotel_code, String
+        attribute :check_in, Date
+        attribute :check_out, Date
+        attribute :total_price, Float
+        attribute :total_sale_price, Float
+        attribute :currency, String
+        attribute :board_type, String
+        attribute :rooms, Array[HotelsPro::Api::Elements::PaxArray], :default => []
+        attribute :cancellation_policy, Array[HotelsPro::Api::Elements::Policy], :default => []
+        attribute :agency_reference_number, String
+        attribute :comments, String
+      end
+    end
+  end
+end

data/lib/hotels_pro/api/elements/daily_rate.rb

@@ -0,0 +1,12 @@
+module HotelsPro
+  module Api
+    module Elements
+      class DailyRate
+        include Virtus
+
+        attribute :date, Date
+        attribute :amount, Float
+      end
+    end
+  end
+end

data/lib/hotels_pro/api/elements/filter.rb

@@ -0,0 +1,13 @@
+module HotelsPro
+  module Api
+    module Elements
+      class Filter
+        include ApiParams
+        include Virtus
+
+        attribute :filter_type, String
+        attribute :filter_value, String
+      end
+    end
+  end
+end

data/lib/hotels_pro/api/elements/hotel.rb

@@ -0,0 +1,22 @@
+require 'hotels_pro/api/elements/room_response'
+
+module HotelsPro
+  module Api
+    module Elements
+      class Hotel
+        include Virtus
+
+        attribute :process_id, String
+        attribute :hotel_code, String
+        attribute :availability_status, String
+        attribute :special_deal, Integer
+        attribute :total_price, Float
+        attribute :total_tax, Float, :default => 0
+        attribute :total_sale_price, Float, :default => 0
+        attribute :currency, String
+        attribute :board_type, String
+        attribute :rooms, Array[RoomResponse], :default => []
+      end
+    end
+  end
+end

data/lib/hotels_pro/api/elements/lead_traveller.rb

@@ -0,0 +1,15 @@
+require 'hotels_pro/api/elements/pax'
+
+module HotelsPro
+  module Api
+    module Elements
+      class LeadTraveller
+        include ApiParams
+        include Virtus
+
+        attribute :pax_info, HotelsPro::Api::Elements::Pax
+        attribute :nationality, String
+      end
+    end
+  end
+end

data/lib/hotels_pro/api/elements/pax.rb

@@ -0,0 +1,16 @@
+module HotelsPro
+  module Api
+    module Elements
+      class Pax
+        include ApiParams
+        include Virtus
+
+        attribute :pax_type, String
+        attribute :age, Integer
+        attribute :title, String
+        attribute :first_name, String
+        attribute :last_name, String
+      end
+    end
+  end
+end

data/lib/hotels_pro/api/elements/pax_array.rb

@@ -0,0 +1,17 @@
+require 'hotels_pro/api/elements/pax'
+
+module HotelsPro
+  module Api
+    module Elements
+      class PaxArray
+        include Virtus
+
+        attribute :paxes, Array[Pax], :default => []
+
+        def to_api_params
+          paxes.map(&:to_api_params)
+        end
+      end
+    end
+  end
+end