zumata 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d78ff8033bb65e030d681e5fa615bddac28c5eb3
+  data.tar.gz: afaf5d0ad9ca769b3f895c23d4c74a2bda98a5c6
+SHA512:
+  metadata.gz: f0474a4eb7dda8af7f083e17b6f63b108d3f8e560e3347560b407c288ff534aca2c43c9cf8cb6a20125789373c7857551ad1103e5f687a5dc50a2d5e226d4dcc
+  data.tar.gz: 9d17d7d5822d84c5ea2c7f3b0de0cd8de0ad18cb6a82b6156787537463c0f2547bd80e5e82f6f17dfd2c1e15df3e1ecd8ce3c248b8b12875843113bfbff951f3

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) 2014 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,12 @@
+# Zumata
+
+For interaction with the Zumata API 2.0
+http://developer.zumata.com/doc/zumata-api-2-0-documentation
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/zumata/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/lib/zumata.rb

@@ -0,0 +1,7 @@
+require "zumata/version"
+require "zumata/responses"
+require "zumata/errors"
+require "zumata/client"
+
+module Zumata
+end

data/lib/zumata/client.rb

@@ -0,0 +1,78 @@
+require 'httparty'
+require 'time'
+require 'awesome_print'
+require 'json'
+
+VALID_STATUS_CODES = [200, 500]
+
+module Zumata
+  class Client
+  	include HTTParty
+
+    raise Zumata::ClientConfigError unless ENV["ZUMATA_API_URL"]
+    base_uri ENV["ZUMATA_API_URL"]
+
+    def initialize api_key
+      @api_key = api_key
+      @timeout = 600
+    end
+
+
+    # GET /search
+  	def search_by_destination destination, opts={}
+
+      q = { api_key: opts[:api_key] || @api_key,
+            destination: destination,
+            rooms: opts[:rooms] || 1,
+            adults: opts[:adults] || 2,
+            gzip: true,
+            currency: opts[:currency] || "USD" }
+
+      # smart defaults    
+      q[:checkin]  = opts[:checkin] || (Time.now + 60*60*60*24).strftime("%m/%d/%Y")
+      q[:checkout] = opts[:checkout] || (Time.now + 61*60*60*24).strftime("%m/%d/%Y")
+
+      # optional
+      q[:lang]     = opts[:lang] if opts[:lang]
+      q[:timeout]  = opts[:timeout] if opts[:timeout]
+      
+      res = self.class.get("/search", query: q).response
+
+      # todo - handle errors from search
+      Zumata::GenericResponse.new(context: q, code: res.code.to_i, body: res.body)
+    end
+
+
+    # POST /book_property
+    # internal: /book
+    def book booking_key, guest, payment, opts={}
+
+      # raise InvalidRequestError unless valid_guest_params?(guest)
+      # raise InvalidRequestError unless valid_payment_params?(payment)
+      
+      body_params = { api_key: opts[:api_key] || @api_key,
+                      booking_key: booking_key,
+                      guest: guest,
+                      payment: payment }
+      
+      res = self.class.post("/book", body: body_params.to_json, headers: { 'Content-Type' => 'application/json' }, timeout: @timeout)
+
+      status_code = res.code.to_i
+      raise Zumata::GeneralError, res.body unless VALID_STATUS_CODES.include?(status_code)
+
+      case status_code
+      when 200
+        return Zumata::GenericResponse.new(context: body_params, code: status_code, body: res.body)
+      when 500
+        begin
+          parsed_json = JSON.parse(res.body)
+          error_msg = parsed_json["status"][0]["error"]
+        rescue JSON::ParserError, NoMethodError
+          raise Zumata::GeneralError, res.body
+        end
+        Zumata::ErrorHelper.handle_type(error_msg)
+      end
+            
+    end
+  end
+end

data/lib/zumata/errors.rb

@@ -0,0 +1,29 @@
+module Zumata
+
+  class ZumataError < StandardError; end
+
+  class TestConfigError < ZumataError; end
+  class ClientConfigError < ZumataError; end
+  
+  # Messages for non-200 responses
+  class GeneralError < ZumataError; end
+  class InvalidApiKeyError < ZumataError; end
+  class InvalidBookingKeyError < ZumataError; end
+  class TransactionError < ZumataError; end
+
+  module ErrorHelper
+    def self.handle_type message
+      case message
+      when "Invalid Api Key."
+        raise InvalidApiKeyError, message
+      when "Invalid/Expired Booking key"
+        raise InvalidBookingKeyError, message
+      when "Payment & Booking Transactions are not successful. Please contact us for more details."
+        raise TransactionError, message
+      else
+        raise GeneralError, message
+      end
+    end
+  end
+
+end

data/lib/zumata/responses.rb

@@ -0,0 +1,13 @@
+module Zumata
+
+  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/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'vcr'
+require 'webmock/rspec'
+require 'Zumata'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.allow_http_connections_when_no_cassette = true
+end
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter = :documentation
+  config.failure_color = :magenta
+end

data/spec/zumata_spec.rb

@@ -0,0 +1,177 @@
+require 'json'
+require 'spec_helper'
+require './lib/zumata'
+
+describe "Zumata::Client" do
+
+  raise Zumata::TestConfigError unless ENV["ZUMATA_API_KEY"]
+  sample_api_key = ENV["ZUMATA_API_KEY"]
+
+  before(:each) do
+    @client = Zumata::Client.new(sample_api_key)
+  end
+
+  describe "search_by_destination" do
+
+    it 'returns a response with search completed status if the query is valid', :vcr => { :cassette_name => "search_by_destination_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 destination_id
+    	data = JSON.parse(results.body)
+      expect(data["searchCompleted"]).to_not be(nil)
+      expect(data["content"]["hotels"].length).to be > 0
+    end
+
+  end
+
+  describe "book (via stripe payment)" do
+
+      def sample_guest
+        return {
+          :salutation => "Mr",
+          :first_name => "Phantom",
+          :last_name => "Assassin",
+          :email => "jonathanbgomez@gmail.com",
+          :street => "1 Random St",
+          :city => "Melbourne",
+          :state => "VIC",
+          :postal_code => "3000",
+          :country => "Australia",
+          :room_remarks => "Room with a view, please.",
+          :nationality => "Australia"
+        }
+      end
+
+      def sample_payment stripe_token, usd_amount
+        amount = ('%.2f' % usd_amount.to_f).to_f
+        return {
+          :type => "stripe",
+          :contact => {
+            :first_name => "Phantom",
+            :last_name => "Assassin",
+            :email => "jonathanbgomez@gmail.com",
+            :street => "1 Random St",
+            :city => "Melbourne",
+            :state => "VIC",
+            :postal_code => "3000",
+            :country => "Australia"
+          },
+          :details => {
+            :stripe_token => stripe_token,
+            :amount => amount,
+            :currency => "USD"
+          },
+          :conversion => {
+            :converted_amount => amount,
+            :converted_currency => 'USD',
+            :exchange_rate => 1.00
+          }
+        }
+      end
+
+      def select_cheapest_package hotels
+        cheapest_package_rate = nil
+        cheapest_package_key = nil
+        hotels.each do |hotel|
+          hotel["rates"]["packages"].each do |package|
+            if cheapest_package_rate.nil? || package["roomRate"] < cheapest_package_rate
+              cheapest_package_rate = package["roomRate"]
+              cheapest_package_key = package["key"]
+            end
+          end
+        end
+        raise "Error finding cheap package" if cheapest_package_key.nil?
+        return cheapest_package_key, cheapest_package_rate
+      end
+
+    it 'books the hotel and returns booking information' do
+      
+      destination_id = "53d32e78-c548-42af-5236-fb89e0977722" # Barcelona
+      results = VCR.use_cassette('search_by_destination_done_2', :record => :new_episodes) do
+        @client.search_by_destination destination_id
+      end
+      
+      data = JSON.parse(results.body)
+      expect(data["searchCompleted"]).to_not be(nil)
+        
+      cheapest_key, cheapest_rate = select_cheapest_package(data["content"]["hotels"])
+      guest_params = sample_guest
+      payment_params = sample_payment("tok_14dEyI4Zpcn7UAbK7HFGKKqG", cheapest_rate)
+
+      VCR.use_cassette('book_success', :record => :new_episodes) do
+        booking = @client.book cheapest_key, guest_params, payment_params, { api_key: ENV['ZUMATA_API_KEY_BOOK_SUCCESS'] }
+        res_body = JSON.parse(booking.body)
+        expect(res_body["status"]).to eq(nil)
+        expect(res_body["content"]["booking_id"]).not_to eq(nil)
+      end
+
+    end
+
+    it 'responds with an error when provided with an invalid api key' do
+
+      destination_id = "f75a8cff-c26e-4603-7b45-1b0f8a5aa100" # Singapore
+      results = VCR.use_cassette('search_by_destination_done', :record => :new_episodes) do
+        @client.search_by_destination(destination_id)
+      end
+      
+      data = JSON.parse(results.body)
+      expect(data["searchCompleted"]).to_not be(nil)
+        
+      cheapest_key, cheapest_rate = select_cheapest_package(data["content"]["hotels"])
+      guest_params = sample_guest
+      payment_params = sample_payment("tok_14bquA4Zpcn7UAbKnRf8XRNg", cheapest_rate)
+
+      VCR.use_cassette('book_invalid_api_key', :record => :new_episodes) do
+        expect{ @client.book cheapest_key, guest_params, payment_params, { api_key: ENV['ZUMATA_API_KEY_FAKE'] } }.to raise_error(Zumata::InvalidApiKeyError)
+      end
+
+    end
+   
+    it 'responds with an error when the booking key is invalid' do
+
+      # note - create a cached search, then let it expire
+      
+      destination_id = "f75a8cff-c26e-4603-7b45-1b0f8a5aa100" # Singapore
+      results = VCR.use_cassette('search_by_destination_done', :record => :new_episodes) do
+        @client.search_by_destination destination_id
+      end
+      
+      data = JSON.parse(results.body)
+      expect(data["searchCompleted"]).to_not be(nil)
+        
+      cheapest_key, cheapest_rate = select_cheapest_package(data["content"]["hotels"])
+      guest_params = sample_guest
+      payment_params = sample_payment("tok_14bquA4Zpcn7UAbKnRf8XRNg", cheapest_rate)
+
+      VCR.use_cassette('book_invalid_booking_key', :record => :new_episodes) do
+        expect{ @client.book cheapest_key, guest_params, payment_params, { api_key: ENV['ZUMATA_API_KEY_BOOK_SUCCESS'] } }.to raise_error(Zumata::InvalidBookingKeyError)
+      end
+
+    end
+
+    it 'responds with an error when the booking fails (e.g. stripe is not setup on payment provider)' do
+      
+      destination_id = "53d32e78-c548-42af-5236-fb89e0977722" # Barcelona
+      results = VCR.use_cassette('search_by_destination_done_2', :record => :new_episodes) do
+        @client.search_by_destination destination_id
+      end
+      
+      data = JSON.parse(results.body)
+      expect(data["searchCompleted"]).to_not be(nil)
+        
+      cheapest_key, cheapest_rate = select_cheapest_package(data["content"]["hotels"])
+      guest_params = sample_guest
+      payment_params = sample_payment("tok_14bquA4Zpcn7UAbKnRf8XRNg", cheapest_rate)
+
+      VCR.use_cassette('book_invalid_stripe_setup', :record => :new_episodes) do
+        expect{ @client.book cheapest_key, guest_params, payment_params, { api_key: ENV['ZUMATA_API_KEY_NO_STRIPE'] } }.to raise_error(Zumata::TransactionError)
+      end
+
+    end
+
+    xit 'responds with an error when the payment is rejected' do
+    end
+
+  end
+end

data/zumata.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/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zumata"
+  spec.version       = Zumata::VERSION
+  spec.authors       = ["Jonathan Gomez"]
+  spec.email         = ["jonathanbgomez@gmail.com"]
+  spec.summary       = %q{Client for the Zumata API 2.0}
+  spec.description   = %q{Power a hotel website - search hotels, create and manage bookings.}
+  spec.homepage      = "https://github.com/Zumata/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,163 @@
+--- !ruby/object:Gem::Specification
+name: zumata
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Gomez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-16 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:
+- jonathanbgomez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zumata.rb
+- lib/zumata/client.rb
+- lib/zumata/errors.rb
+- lib/zumata/responses.rb
+- lib/zumata/version.rb
+- spec/spec_helper.rb
+- spec/zumata_spec.rb
+- zumata.gemspec
+homepage: https://github.com/Zumata/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.2.2
+signing_key: 
+specification_version: 4
+summary: Client for the Zumata API 2.0
+test_files:
+- spec/spec_helper.rb
+- spec/zumata_spec.rb