suitcase 1.5.0 → 1.5.1

data/README.md

@@ -32,7 +32,7 @@ hotel = hotels[1]
 # Get the rooms for a specific date
 rooms = hotel.rooms(arrival: "7/1/2013", departure: "7/8/2013", rooms: [{ adults: 1, children_ages: [2, 3] }, { adults: 1, children_ages: [4] }])
 # Find a payment option that is compatible with USD
-payment_option = Suitcase::PaymentOption.find(currency_code: "USD")
+payment_option = Suitcase::Hotel::PaymentOption.find(currency_code: "USD")
 # Pick a specific room
 room = rooms.first
 # Set the bed type on each of the rooms to be ordered
@@ -45,6 +45,9 @@ room.reserve!(reservation_hash)
 
 You can setup a cache to store all API requests that do not contain secure information (i.e. anything but booking requests). A cache needs to be able store deeply nested Hashes and have a method called #[] to access them. An example of setting the cache is given above. Check the `examples/hash_adapter.rb` for a trivial example of the required methods. A Redis adapter is also in the examples directory.
 
+#### Using the downloadable images
+
+EAN provides a [downloadable image "database"](http://developer.ean.com/database_catalogs/relational/Image_Data) that doesn't require using the image URLs fetched by the API.For example usage of this database, check out `examples/hotel_image_db.rb`.
 
 ### Car rentals
 

data/examples/hotel_image_db.rb

@@ -0,0 +1,24 @@
+FILENAME = ENV["HOTEL_IMAGES"] || "HotelImageList.txt"
+
+IMAGES = {}
+
+def images_for(hotel)
+  IMAGES[hotel.id.to_i] ||= IO.foreach(FILENAME).map do |line|
+    split = line.split("|")
+    if hotel.id.to_i == split[0].to_i
+      Suitcase::Image.new({
+        "caption" => split[1],
+        "url" => split[2],
+        "thumbnailUrl" => split[6],
+        "width" => split[3],
+        "height" => split[4]
+      })
+    else
+      nil
+    end
+  end.compact
+end
+
+# examples
+
+images_for(Suitcase::Hotel.find(location: "Boston")[0])

data/lib/suitcase/hotel/helpers.rb

@@ -77,12 +77,44 @@ module Suitcase
         url
       end
 
-      # Internal: Parse the JSON response at the given URL.
+      # Internal: Parse the JSON response at the given URL and handle errors.
       #
       # uri - The URI to parse the JSON from.
       #
       # Returns the parsed JSON.
       def parse_response(uri)
+        response = Net::HTTP.get_response(uri)
+
+        if response.code.to_i == 403
+          if response.body.include?("Forbidden")
+            e = EANException.new("You have not been granted permission to access the requested method or object.")
+            e.type = :forbidden
+          elsif response.body.include?("Not Authorized")
+            e = EANException.new("The API key associated with your request was not recognized, or the digital signature was incorrect.")
+            e.type = :not_authorized
+          elsif response.body.include?("Developer Inactive")
+            e = EANException.new("The API key you are using to access the API has not been approved, is not correct, or has been disabled. If using SIG Authentication, your digital signature is incorrect and does not match the one generated when receiving your request.")
+            e.type = :developer_inactive
+          elsif response.body.include?("Queries Per Second Limit")
+            e = EANException.new("The API key you are using has attempted to access the API too many times in one second.")
+            e.type = :query_limit
+          elsif response.body.include?("Account Over Rate Limit")
+            e = EANException.new("The API key you are using has attempted to access the API too many times in the rate limiting period.")
+            e.type = :rate_limit
+          elsif response.body.include?("Rate Limit Exceeded")
+            e = EANException.new("The service you have requested is over capacity.")
+            e.type = :over_capacity
+          elsif response.body.include?("Authentication Failure")
+            e = EANException.new("The combination of authentication checks failed.")
+            e.type = :authentication_failure
+          else
+            e = EANException.new("An unknown error occured: #{response.body}.")
+            e.type = :unknown
+          end
+        
+          raise e
+        end
+
         JSON.parse(Net::HTTP.get_response(uri).body)
       end
 

data/lib/suitcase/version.rb

@@ -1,3 +1,3 @@
 module Suitcase
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

data/test/hotels/helpers_test.rb

@@ -29,6 +29,14 @@ describe Suitcase::Hotel::Helpers do
         Dummy.parse_response(URI.parse("http://google.com"))
       end.must_raise JSON::ParserError
     end
+
+    it "raises an error if a 403 code is received" do
+      proc do
+        response = FakeResponse.new(code: 403, body: "<h1>An error occurred.</h1>")
+        Net::HTTP.stubs(:get_response).returns(response)
+        Dummy.parse_response(URI.parse("http://fake.response.will.be.used"))
+      end.must_raise Suitcase::EANException
+    end
   end
 
   describe "#generate_signature" do

data/test/minitest_helper.rb

@@ -1,15 +1,24 @@
+# Testing frameworks
 require "turn"
 require "minitest/spec"
 require "minitest/autorun"
 require "mocha"
 
+# Debugger
 require "pry"
 
+# The gem
 $: << File.dirname(__FILE__) + "/../lib"
 $: << File.dirname(__FILE__)
 require "suitcase"
+
+# API keys
 require "keys"
 
+# Support files
+require "support/fake_response"
+
+# Turn configuration
 Turn.config do |config|
   config.format = :pretty
   # config.trace = true

data/test/support/fake_response.rb

@@ -0,0 +1,13 @@
+class FakeResponse
+  def initialize(options = {})
+    options.each { |k, v| instance_variable_set("@#{k}", v) }
+  end
+
+  def method_missing(meth, *args, &blk)
+    if args.empty?
+      instance_variable_get("@#{meth}")
+    else
+      super
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: suitcase
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-27 00:00:00.000000000 Z
+date: 2012-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -136,6 +136,7 @@ files:
 - README.md
 - Rakefile
 - examples/hash_adapter.rb
+- examples/hotel_image_db.rb
 - examples/redis_adapter.rb
 - lib/suitcase.rb
 - lib/suitcase/car_rental.rb
@@ -169,6 +170,7 @@ files:
 - test/hotels/session_test.rb
 - test/keys.rb
 - test/minitest_helper.rb
+- test/support/fake_response.rb
 homepage: http://github.com/thoughtfusion/suitcase
 licenses: []
 post_install_message: 
@@ -208,4 +210,5 @@ test_files:
 - test/hotels/session_test.rb
 - test/keys.rb
 - test/minitest_helper.rb
+- test/support/fake_response.rb
 has_rdoc: