expedia_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee2e06abd36c267bf1ab2d0a340886915496ba49
+  data.tar.gz: 927f042a6792ad89c34532cfd9f7c2fa11227761
+SHA512:
+  metadata.gz: e0e857fe39eba7e119030defacb813f96cda740c22f726108a2324293919531b7b1111c28a9943b799f7d98cf06a0193ebce4a4b13aa75a3c05749c3c213a5f8
+  data.tar.gz: f3e64a4040786905376f2453aa41c4d1037e3d83138061a6f8fff92ce8bf6d749901541a4dbd40429a444c8651a95b64c830fb7e9eef2fea55c7c0cefebd8eaf

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Hendrik Kleinwaechter
+
+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,148 @@
+# Expedia Api
+
+This is a ruby wrapper for the official Expedia.com API. Please note that the Expedia.com API is a different than the one provided by the Expedia Affiliate Network. They are different companies. If you want to use the EAN Api please use [expedia gem](https://github.com/zaidakram/expedia).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'expedia_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install expedia_api
+
+## Usage
+
+Create an initializer that sets your API key:
+
+```
+config/initializers/expedia_api.rb
+
+````
+
+Set the API key:
+
+```
+Expedia.api_key = 'my_api_key'
+
+```
+
+Then when using the API create a new client object:
+
+```
+client = ExpediaApi::Client.new
+client.get_list({})
+
+
+```
+
+The parameters you can pass to `get_list` are the following:
+
+```
+location:
+  example:
+    40.714269,-74.005973
+  description:
+    The composition of latitude and longitude values
+    identifying the center point of a hotel search radius (circle). The
+    latitude and longitude values are joined together with a comma (,)
+    character.
+  remark:
+    When this parameter is used, the RADIUS parameter is required.
+radius:
+  example:
+    10km
+  description:
+    The size of the hotel search radius around the specified latitude
+    and longitude, along with its associated unit of measure.
+    The units default to kilometers if a value isn't provided in the composition.
+    Valid units are KM and MI.
+  remark:
+    Radius must be less than 200.0km/124.30081 miles. The radius only
+    applies to the LOCATION parameter.
+hotelids:
+  example:
+    28082, 11133
+  description:
+    Comma-separated list of Hotel IDs for which to return results.
+regionids:
+  example:
+    8816, 1234
+  description:
+    Comma-separated list of Expedia Region IDs. Searching is done for
+    all hotels in the regions.
+dates:
+  example:
+    2011-01-19,2011-01-20
+  description:
+    Comma separated list of check- in/check-out dates for hotel stay
+    in an ISO 8601 Date format [YYYY-MM-DD]. If this parameter is not
+    included, a dateless search will be conducted which returns a
+    featured offer for each of the hotels found.
+  remark:
+    Max advance search window is 330 days.
+language:
+  example:
+    en-US
+  description:
+    language is composed of language code and country code, connected by
+    "-". Must be a valid language for the Point of Sale. For example,
+    "fr-FR"/"fr- CA" is a valid language for France/Canada site, but
+    could not be "fr-US". If no language is specified, a default
+    language will be used.
+currency:
+  example:
+    USD
+  description:
+    Value should be a standard ISO. 3 letter currency code, e.g. CAD -
+    Canadian dollar, USD - US dollar
+    If not specified for dated searches, USD will be returned.
+    If not specified for dateless searches, the pos native currency
+    will be returned.
+adults:
+  example:
+    2,1
+  description:
+    Comma-separated list that specifies the number of adults staying in
+    each of the rooms to be requested.
+  remark:
+    Default value will be 2 if not specified. It indicates only one room
+    is required and there are two adults staying in the room. Up to 8
+    rooms can be requested at a time.
+    Example:
+    adults=2,2,2,2 (four rooms with two adults in each room))
+availonly:
+  example:
+    true
+  description:
+    return available hotels only. default: true
+```
+
+Please refer to the official API documentation by the Expedia.com team for more parameters.
+
+You can also setup an http proxy. Expedia whitelists IPs that are able to access their API.
+
+```
+  ExpediaApi.proxy_uri      = "http://proxy_uri.com:3128"
+  ExpediaApi.proxy_password = "foobar"
+  ExpediaApi.proxy_user     = "foobar"
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "expedia_api"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/expedia_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'expedia_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "expedia_api"
+  spec.version       = ExpediaApi::VERSION
+  spec.authors       = ["Hendrik Kleinwaechter"]
+  spec.email         = ["hendrik.kleinwaechter@gmail.com"]
+
+  spec.description       = "Expediacom is a lightweight flexible Ruby SDK for the official Expedia.com API"
+  spec.summary           = "Wrapper for the Expedia.com API"
+  spec.homepage          = "https://github.com/hendricius/expediacom"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+  spec.add_runtime_dependency(%q<faraday>,       ["~> 0.8"])
+  spec.add_runtime_dependency "faraday_middleware"
+  spec.add_runtime_dependency "activesupport"
+
+end

data/lib/expedia_api.rb

@@ -0,0 +1,15 @@
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+require 'active_support/core_ext/hash/indifferent_access'
+
+require "expedia_api/version"
+require "expedia_api/http_service"
+require "expedia_api/client"
+require "expedia_api/hotel_response_list"
+
+module ExpediaApi
+  class << self
+    attr_accessor :api_key, :proxy_uri, :proxy_password, :proxy_user
+  end
+end

data/lib/expedia_api/client.rb

@@ -0,0 +1,100 @@
+module ExpediaApi
+  # All method naming is done in correspondence with Expedia services and ruby conventions
+  class Client
+
+    # parameters:
+    # location:
+    #   example:
+    #     40.714269,-74.005973
+    #   description:
+    #     The composition of latitude and longitude values
+    #     identifying the center point of a hotel search radius (circle). The
+    #     latitude and longitude values are joined together with a comma (,)
+    #     character.
+    #   remark:
+    #     When this parameter is used, the RADIUS parameter is required.
+    # radius:
+    #   example:
+    #     10km
+    #   description:
+    #     The size of the hotel search radius around the specified latitude
+    #     and longitude, along with its associated unit of measure.
+    #     The units default to kilometers if a value isn't provided in the composition.
+    #     Valid units are KM and MI.
+    #   remark:
+    #     Radius must be less than 200.0km/124.30081 miles. The radius only
+    #     applies to the LOCATION parameter.
+    # hotelids:
+    #   example:
+    #     28082, 11133
+    #   description:
+    #     Comma-separated list of Hotel IDs for which to return results.
+    # regionids:
+    #   example:
+    #     8816, 1234
+    #   description:
+    #     Comma-separated list of Expedia Region IDs. Searching is done for
+    #     all hotels in the regions.
+    # dates:
+    #   example:
+    #     2011-01-19,2011-01-20
+    #   description:
+    #     Comma separated list of check- in/check-out dates for hotel stay
+    #     in an ISO 8601 Date format [YYYY-MM-DD]. If this parameter is not
+    #     included, a dateless search will be conducted which returns a
+    #     featured offer for each of the hotels found.
+    #   remark:
+    #     Max advance search window is 330 days.
+    # language:
+    #   example:
+    #     en-US
+    #   description:
+    #     language is composed of language code and country code, connected by
+    #     "-". Must be a valid language for the Point of Sale. For example,
+    #     "fr-FR"/"fr- CA" is a valid language for France/Canada site, but
+    #     could not be "fr-US". If no language is specified, a default
+    #     language will be used.
+    # currency:
+    #   example:
+    #     USD
+    #   description:
+    #     Value should be a standard ISO. 3 letter currency code, e.g. CAD -
+    #     Canadian dollar, USD - US dollar
+    #     If not specified for dated searches, USD will be returned.
+    #     If not specified for dateless searches, the pos native currency
+    #     will be returned.
+    # adults:
+    #   example:
+    #     2,1
+    #   description:
+    #     Comma-separated list that specifies the number of adults staying in
+    #     each of the rooms to be requested.
+    #   remark:
+    #     Default value will be 2 if not specified. It indicates only one room
+    #     is required and there are two adults staying in the room. Up to 8
+    #     rooms can be requested at a time.
+    #
+    #     Example:
+    #     adults=2,2,2,2 (four rooms with two adults in each room))
+    # availonly:
+    #   example:
+    #     true
+    #   description:
+    #     return available hotels only. default: true
+    def get_list(parameters = {})
+      data = request(parameters: parameters)
+      ExpediaApi::HotelResponseList.new(response: data)
+    rescue Faraday::ParsingError => e
+      ExpediaApi::HotelResponseList.new(exception: e)
+    rescue Faraday::ConnectionFailed => e
+      ExpediaApi::HotelResponseList.new(exception: e)
+    end
+
+    private
+
+    def request(request_options: {}, parameters: {})
+      HTTPService.perform_request(request_options: request_options, parameters: parameters)
+    end
+
+  end
+end

data/lib/expedia_api/hotel_response_list.rb

@@ -0,0 +1,65 @@
+module ExpediaApi
+  class HotelResponseList
+    include Enumerable
+    attr_reader :response, :exception
+
+    def initialize(entries: [], response: nil, exception: nil)
+      @response = response
+      self.entries = extract_entries_from_response(response)
+      @exception = exception
+    end
+
+    def each(&block)
+      @entries.each(&:block)
+    end
+
+    def map(&block)
+      @entries.map(&:block)
+    end
+
+    def entries
+      @entries
+    end
+
+    def entries=(entries)
+      @entries = entries.map {|e| e.with_indifferent_access }
+    end
+
+    def success?
+      exception.nil?
+    end
+
+    def error?
+      !!exception
+    end
+
+    def response_body
+    end
+
+    def extract_entries_from_response(response)
+      # probably an error ocurred connecting
+      if response.nil?
+        return []
+      end
+      body = nil
+      begin
+        body = JSON.parse(response.body)
+      rescue JSON::ParserError => e
+        @exception = e
+        return []
+      end
+      if !body.is_a?(Hash) || body.nil?
+        return []
+      end
+      hotel_count = body["HotelCount"].to_i
+      if hotel_count == 1
+        [body["HotelInfoList"]["HotelInfo"]]
+      elsif hotel_count > 1
+        body["HotelInfoList"]["HotelInfo"]
+      else
+        []
+      end
+    end
+
+  end
+end

data/lib/expedia_api/http_service.rb

@@ -0,0 +1,62 @@
+module ExpediaApi
+  module HTTPService
+
+    API_SERVER = 'ews.expedia.com'
+    API_PATH   = 'wsapi/rest/hotel/v1/search'
+
+    class << self
+
+
+      # The address of the appropriate Expedia server.
+      #
+      # return a complete server address with protocol
+      def server_url
+        "http://#{API_SERVER}"
+      end
+
+      def faraday_options
+        options = {
+          url: server_url
+        }
+        if use_proxy?
+          options[:proxy] = proxy_options
+        end
+        options
+      end
+
+      def perform_request(request_options: {}, parameters: {})
+        args = common_parameters.merge(parameters)
+        # figure out our options for this request
+        # set up our Faraday connection
+        connection = Faraday.new(faraday_options) do |faraday|
+          faraday.adapter  Faraday.default_adapter
+        end
+        connection.get(API_PATH, args)
+      end
+
+      def use_proxy?
+        !!(ExpediaApi.proxy_uri && ExpediaApi.proxy_user && ExpediaApi.proxy_password)
+      end
+
+      def proxy_options
+        {
+          uri: ExpediaApi.proxy_uri,
+          user: ExpediaApi.proxy_user,
+          password: ExpediaApi.proxy_password
+        }
+      end
+
+
+
+      # Common Parameters required for every Call to Expedia Server.
+      def common_parameters
+        {
+          :format       => :json,
+          :key          => ExpediaApi.api_key
+        }
+      end
+
+    end
+
+  end
+end

data/lib/expedia_api/version.rb

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

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: expedia_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hendrik Kleinwaechter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: webmock
+  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: pry
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: 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'
+description: Expediacom is a lightweight flexible Ruby SDK for the official Expedia.com
+  API
+email:
+- hendrik.kleinwaechter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- expedia_api.gemspec
+- lib/expedia_api.rb
+- lib/expedia_api/client.rb
+- lib/expedia_api/hotel_response_list.rb
+- lib/expedia_api/http_service.rb
+- lib/expedia_api/version.rb
+homepage: https://github.com/hendricius/expediacom
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Wrapper for the Expedia.com API
+test_files: []
+has_rdoc: