ytlabs_api_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f30bcad7ecac2a4ebf8c127f56f8d6da4cfa1437
+  data.tar.gz: a3fb99eb663787a7eb06ff638265766a5e613ead
+SHA512:
+  metadata.gz: c679f3ecd6b371a0eefdf26e877679b4c28a645ca35f072045dd6efcfe678e272d5b2d579646b650b2105ab09664458ff3da8b2c456d42c3b81468a863d2a5ca
+  data.tar.gz: 2e6d1c071b7d1012c333ae2d3d70ee5e752dfbcb99cf86433a9a96787da8f5998ce5e1103865aebbdee90d7d1bd118696681d8eff79484457e0b5703f29eb982

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem 'activemodel'
+gem 'httparty'
+
+group :test, :development do
+  gem 'rspec'
+  gem 'pry'
+  gem 'webmock'
+end

data/README.md

@@ -0,0 +1,203 @@
+YTLabs API Client
+===================
+
+A Ruby wrapper packaged as a Gem enabling Ruby calls to the Yello Travel Labs API which provides endpoints to search & book their inventory of Korea based rental properties. Visit Yello Travel Labs at [http://www.ytlabs.co.kr/](http://www.ytlabs.co.kr/). You will need an access token.
+
+The YTLabs API uses camelCase params, however as this is a Ruby wrapper I have followed the Ruby convention of using underscore_case parameter naming, with the exception of `client.post_reservation_confirmation`. The belows README (and also the comments above the definition of each method) documents all required and optional parameter formats.
+
+A work in progress as of July 2016, hence currently calling staging url.
+
+### Requirements:
+
+httparty [github.com/jnunemaker/httparty](http://www.github.com/jnunemaker/httparty)
+
+===================
+
+### Install:
+
+```
+gem install 'ytlabs_api_client'
+```
+
+===================
+
+### Usage:
+
+```
+client = YTLabsApi::Client.new(token, :json)
+```
+
+===================
+
+### Endpoints covered:
+
+#### GET Requests
+
+#### get_properties:     "GET /properties/"
+```
+Use this resource to get a response a list of properties in the YTLabs API.
+
+- Required => updated_at                    Date at which data starts being returned. (YYYY-MM-
+- Optional => i18n        default: "ko-KR"  Return text in other lanaguages(ko-KR, en-US, zh-CN,
+- Optional => offset      default: 0        Data offset (default 0)
+- Optional => limit       default: 30       Amount of requested properties (default 30)
+- Optional => active      default: 1        To filter by only active properties. 0 returns all. 1 returns Active o
+
+When parameter 'limit=0&updatedAt=1970-01-01' is specified in request, all of the properties' information is
+returned. It is recommended only for the first ever call made to retrieve all information.
+
+Usage: get_property(params)
+Example usage: client.get_properties(:updated_at => "1970-01-01", :limit => 3)
+```
+===================
+
+#### get_property:       "GET /properties/{propertyID}/"
+```
+Use this resource with a property_identifier (e.g. "w_w0307279") to get the property's information.
+
+- Required => property_identifier            The unique property identifier/hash (e.g. w_w0307279)
+- Optional => i18n        default: "ko-KR"   Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+
+Usage: get_property(property_identifier, params=nil)
+Example usage: client.get_property("w_w0307279", :i18n => "en-US")
+```
+===================
+
+#### get_availability:     "GET /available/{propertyID}"
+```
+Use this resource with a property_identifier (e.g. "w_w0307279") & a stay start_date to obtain rates & availability.
+
+Required => property_identifier               The unique property identifier/hash (e.g. w_w0307279)
+Required => start_date                                  YYYY-MM-DD (ex: 2016-02-01). Stay start date.
+Optional => end_date      default: (start_date + 1 day) YYYY-MM-DD (ex: 2016-02-05). Stay end date. If empty, defaults to start_date + 1 day.
+
+Usage: get_availability(property_identifier, start_date, end_date=nil)
+Example usage: client.get_availability("w_w0307279_R01", "2016-07-01", "2016-07-10")
+```
+===================
+
+#### get_provinces:        "GET /provincecode/"
+```
+Returns a list with code or name of province.
+- Optional => i18n        default: "ko-KR"    Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+
+Example usage: client.get_provinces
+```
+===================
+
+#### get_cities:       "GET /citycode/"
+```
+Returns a list with code or name of cities.
+- Optional => i18n        default: "ko-KR"    Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+
+Example usage: client.get_cities
+```
+===================
+
+#### get_extra_service_codes: "GET /extraservicecode/"
+```
+Returns a list mapping the codes and names of extra services.
+- Optional => i18n        default: "ko-KR"    Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+
+Example usage: client.get_extra_service_codes
+```
+===================
+
+#### get_theme_codes:      "GET /themecode/"
+```
+Returns a list mapping the code and name of themes.
+- Optional => i18n        default: "ko-KR"    Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+
+Example usage: client.get_theme_codes
+```
+===================
+
+#### get_reservations:     "GET /reservation/information"
+```
+1. Use this resource with a set of dates to retrieve a collection of reservations between the given dates
+2. Use this resource with a reservation identifier(hash) + the start date to retrieve a collection of one reservation.
+
+- Required => start_date              YYYY-MM-DD (ex: 2016-02-01). Search by start date.
+- Required => end_date                YYYY-MM-DD (ex: 2016-02-05). Search by end date.
+- Optional => reservation_identifier  The unique property identifier/hash (e.g. w_w03072)
+
+Example usage: client.get_reservations("2016-07-01", "2016-07-10", "w_w0307279_R01")
+```
+===================
+
+#### get_room_types:       "GET /roomtypes/"
+```
+Use this resource to obtain a list of all room types.
+- Required => updated_at                     Date at which data starts being returned. (YYYY-MM-
+- Optional => i18n        default: "ko-KR"   Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-
+- Optional => offset      default: 0         Data offset (default 0)
+- Optional => limit       default: 30        Amount of requested room type (default 30)
+- Optional => active      default: 1         To filter by only active room type. 0 returns all. 1 returns Active o
+
+Example usage: client.get_room_types(:updated_at => "1970-01-01", :limit => 1)
+```
+===================
+
+#### get_property_room_types: "GET /properties/{propertyID}/roomtypes/"
+```
+Using a specific propertyID, get all roomtypes' information of the property.
+
+- Required => property_identifier           Date at which data starts being returned. (YYYY-MM-
+- Optional => i18n        default: "ko-KR"  Return text in other lanaguages(ko-KR, en-US, zh-CN, ja
+
+Example usage: client.get_property_room_types("w_w0307279", :i81n => "en-US")
+```
+===================
+
+#### get_cancellation_charge: "GET /reservation/cancelcharge/"
+```
+Using a reservation number get the cancellation fee payable. If a reservation is cancelled within 7 days of the check in day, a cancellation fee will be charged.
+
+- Required => reservation_number      Unique reservation number
+
+Example usage: client.get_cancellation_charge("w_WP20160705145532ECD5")
+```
+
+#### POST Requests
+
+#### post_reservation_request(property_identifier, start_date, end_date):     "POST /reservation/holding/"
+```
+Before making a reservation, the room must be held - to prevent double booking.
+
+Example usage: client.post_reservation_request("w_w0814002_R01", "2016-07-01", "2016-07-10")
+```
+===================
+
+
+#### post_reservation_confirmation: "POST /reservation/confirm"
+```
+Confirm a booking.
+
+Format expected (Ruby Hash):
+
+request_body = {
+                  "reservationNo" => "w_WP20160718164753DE39",
+                  "roomtypeCode" => "w_w0814002_R01",
+                  "checkInDate" => "2016-07-01",
+                  "checkOutDate" => "2016-07-10",
+                  "guestName" => "Bob",
+                  "guestCount" => 4,
+                  "adultCount" => 2,
+                  "childrenCount" => 2,
+                  "paidPrice" => 2000.0,
+                  "sellingPrice" => 2000.0,
+                  "commissionPrice" => 200.0,
+                  "currency" => "KRW"
+                }
+
+Example usage: client.post_reservation_confirmation(request_body)
+```
+===================
+
+#### post_cancellation_request(reservation_number, paid_price, commission_price, currency)     "POST /reservation/cancel"
+
+```
+Cancel a booking.
+
+Example usage: client.post_cancellation_request("w_WP20160718164753DE39", 2000.0, 200.0, "KRW")
+```

data/lib/ytlabs_api.rb

@@ -0,0 +1,35 @@
+require 'json'
+require 'yaml'
+require 'httparty'
+require 'active_support/inflector'
+
+require_relative 'ytlabs_api/client'
+
+## Exceptions
+module YTLabsApi
+
+  #To be implemented in the Client.
+  class NetworkError < StandardError
+    def initialize(status, body)
+      super("Error. HTTP status: #{status}. Response body: #{body}")
+    end
+  end
+
+  class InvalidAccessToken < StandardError
+    def initialize
+      super("Your access token is not valid. It must be 36 characters long.")
+    end
+  end
+
+  class InvalidContentType < StandardError
+    def initialize
+      super("Your content type is invalid. 'json' or 'xml' are the 2 valid options")
+    end
+  end
+
+  class EndPointNotSupported < StandardError
+    def initialize
+      super("This endpoint is not supported: Try one of these: #{Client::END_POINTS.keys}")
+    end
+  end
+end

data/lib/ytlabs_api/availability.rb

@@ -0,0 +1,34 @@
+module YTLabsApi
+  module Availability
+
+    # GET /available/
+    # Use this resource with a property_identifier (e.g. "w_w0307279") & a stay start_date to obtain rates & availability.
+    #
+    # Parameters:
+    #
+    #     Required => property_identifier                         The unique property identifier/hash (e.g. w_w0307279)
+    #     Required => start_date                                  YYYY-MM-DD (ex: 2016-02-01). Stay start date.
+    #
+    #     Optional => end_date      default: start_date + 1 day   YYYY-MM-DD (ex: 2016-02-05). Stay end date. If empty, defaults to start_date + 1 day.
+    #
+    # Example Request: https://api.ytlabs.co.kr/stage/v1/available?roomCode=w_w0307279_R01&searchStartDate=2016-07-01&searchEndDate=2016-07-10
+    #
+    # Example usage: client.get_availability("w_w0307279_R01", "2016-12-01", "2016-12-10")
+
+    def get_availability(property_identifier, start_date, end_date=nil)
+      params = {
+                 :roomCode => "#{property_identifier}",
+                 :searchStartDate => "#{start_date}"
+               }
+
+      params.merge!(:searchEndDate  => "#{end_date}") if end_date
+
+      response = HTTParty.get(
+        "#{build_url(__method__.to_s)}?#{transform_params!(params)}",
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+  end
+end

data/lib/ytlabs_api/booking.rb

@@ -0,0 +1,107 @@
+module YTLabsApi
+  module Booking
+
+    # POST /reservation/holding/
+    # Before making a reservation, the room must be held - to prevent double booking.
+    # Other customers cannot make a reservation until the holding status has ended.
+    # If 'pending' is returned in the response, the user can request Reservation Confirm.
+
+    # Format expected (JSON content type):
+    #
+    # {
+    #   "roomCode" : "w_w0814002_R01",
+    #   "checkInDate" : "2016-09-15",
+    #   "checkOutDate" : "2016-09-16"
+    # }
+
+    def post_reservation_request(property_identifier, start_date, end_date)
+      request_body = {
+                 :roomCode     => "#{property_identifier}",
+                 :checkInDate  => "#{start_date}",
+                 :checkOutDate => "#{end_date}"
+               }.to_json
+
+      response = HTTParty.post(
+        "#{build_url(__method__.to_s)}",
+        body:    request_body,
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+
+    # _________________________________________________________________________________________ #
+
+    # POST /reservation/confirm/
+    # The user must have a valid reservation number that will have been returned by making a successful 'reservation request'.
+    #
+    # Note that this method accepts a body with keys specified in camelcase.
+
+    # Format expected (JSON content type):
+    #
+    # {
+    #  *** Required ***
+    #   "reservationNo" : "w_WP000000000000000",
+    #   "roomtypeCode" : "w_w0814002_R01",
+    #   "checkInDate" : "2016-09-15",
+    #   "checkOutDate" : "2016-09-16",
+    #   "guestName" : "Lucy",
+    #   "guestCount" : 3,
+    #   "adultCount" : 2,
+    #   "childrenCount" : 1,
+    #   "paidPrice" : 2000.0,
+    #   "sellingPrice" : 2000.0,
+    #   "commissionPrice" : 200.0,
+    #   "currency" : "KRW",
+    #
+    #  *** Optional ***
+    #   "guestPhone" : "010-0000-0000",
+    #   "guestEmail" : "aaa@mail.com",
+    #   "guestNationality" : "Korea"
+    # }
+
+    def post_reservation_confirmation(request_body={})
+      response = HTTParty.post(
+        "#{build_url(__method__.to_s)}",
+        body:    request_body.to_json,
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+
+    # _________________________________________________________________________________________ #
+
+    # GET /reservation/information
+
+    # Use this resource with a set of dates to retrieve a collection of reservations between the given dates
+    # OR
+    # Use this resource with a reservation identifier(hash) + the start date to retrieve a collection of one reservation.
+    #
+    # Parameters:
+    #
+    #     Required => start_date                                         YYYY-MM-DD (ex: 2016-02-01). Search by start date.
+    #     Required => end_date                                           YYYY-MM-DD (ex: 2016-02-05). Search by end date.
+    #     Optional => reservation_identifier                             The unique property identifier/hash (e.g. w_w0307279)
+    #
+    # Example Request: https://api.ytlabs.co.kr/stage/v1/reservation/information?searchStartDate=2016-07-01&searchEndDate=2016-07-10&reservationNo=
+    #
+    # Example usage: client.get_reservations("2016-07-01", "2016-07-10", "w_w0307279_R01")
+
+    def get_reservations(start_date, end_date, reservation_identifier=nil)
+      params = {
+                 :searchStartDate => "#{start_date}",
+                 :searchEndDate => "#{end_date}"
+               }
+
+      params.merge!( :reservationNo => "#{reservation_identifier}" ) if reservation_identifier
+
+      response = HTTParty.get(
+        "#{build_url(__method__.to_s)}?#{transform_params!(params)}",
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+  end
+end

data/lib/ytlabs_api/cancellation.rb

@@ -0,0 +1,55 @@
+module YTLabsApi
+  module Cancellation
+
+    # POST /reservation/cancel/
+    #
+    # If a reservation is canceled by the guest, the partner should request /reservation/cancel/
+    # If a real reservation is not completed within 10 minutes after ReservationHolding, Partner should also request /reservation/cancel/
+    #
+    # {
+    #   "reservationNo" : "w_WP0000000000000000",
+    #   "refundPaidPrice" : 2000.0,
+    #   "refundCommissionPrice" : 200.0,
+    #   "currency" : "KRW"
+    # }
+
+    def post_cancellation_request(reservation_number, paid_price, commission_price, currency)
+      request_body = {
+                 :reservationNo         => "#{reservation_number}",
+                 :refundPaidPrice       => "#{paid_price}",
+                 :refundCommissionPrice => "#{commission_price}",
+                 :currency              => "#{currency}"
+               }.to_json
+
+      response = HTTParty.post(
+        "#{build_url(__method__.to_s)}",
+        body:    request_body,
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+
+    # GET /reservation/cancelcharge/
+    # Using a reservation number get the cancellation fee payable.
+    #
+    # If a reservation is cancelled within 7 days of the check in day, a cancellation fee will be charged.
+
+    # Parameters:
+    #
+    #     Required => reseveration_number             Unique reservation number - provided when booking was made.
+    #
+    # Example Request: https://api.ytlabs.co.kr/stage/v1/reservation/cancelcharge?reservationNo=w_WP20160705145532ECD5
+    #
+    # Example usage: client.get_cancellation_charge("w_WP20160705145532ECD5")
+    def get_cancellation_charge(reservation_number)
+      response = HTTParty.get(
+        "#{build_url(__method__.to_s)}?reservationNo=#{reservation_number}",
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+
+  end
+end

data/lib/ytlabs_api/client.rb

@@ -0,0 +1,129 @@
+# +YTLabsApi::Client+ - entry class to the API client.
+#
+# Proposed usage:
+# => client = YTLabsApi::Client.new("your_token", :json)
+# => client.get_properties(params_hash)
+
+require_relative 'availability'
+require_relative 'booking'
+require_relative 'property'
+require_relative 'supplementary_information'
+require_relative 'cancellation'
+require_relative 'room_type'
+
+
+module YTLabsApi
+  class Client
+    include HTTParty
+
+    include YTLabsApi::Availability
+    include YTLabsApi::Booking
+    include YTLabsApi::Cancellation
+    include YTLabsApi::Property
+    include YTLabsApi::RoomType
+    include YTLabsApi::SupplementaryInformation
+
+    END_POINTS = YAML::load(File.open(File.join('lib', 'ytlabs_api', 'end_points.yml')))
+    URL = "https://api.ytlabs.co.kr/stage/v1"
+    VALID_CONTENT_TYPES = [:json, :xml].freeze
+
+    format :json
+    default_timeout 1 #Hard timeout after 1 second.
+
+    attr_reader :token, :content_type, :base_url, :errors
+
+    def initialize(token, content_type=nil)
+      @token = token
+      @content_type = "application/#{content_type.to_s}" || "application/json"
+      @base_url = URL
+      @errors = []
+
+      raise InvalidAccessToken unless valid_token?(token)
+      raise InvalidContentType unless valid_content_type?(content_type)
+    end
+
+
+    # HTTParty will raise Net::OpenTimeout if it can't connect to the server.
+    # It will raise Net::ReadTimeout if reading the response from the server times out.
+    # Handle these exceptions to return a empty hash, and set the timeout to 1 second.
+    # Wrap any calls made using HTTParty in a handle_timeouts block
+
+    #     handle_timeouts do
+    #       your HTTParty call.
+    #     end
+
+    # TODO
+    # def handle_timeouts
+    #   begin
+    #     yield
+    #   rescue Net::OpenTimeout, Net::ReadTimeout
+    #     {}
+    #   end
+    # end
+
+    # Since the only public methods this client supports are calls to the specified endpoints,
+    # which are implemented - we will raise a more specific error here.
+    def method_missing(method, *args, &block)
+      raise EndPointNotSupported
+    end
+
+    private
+
+    ## Transforms {:a => 2, :b => 2} to "a=2&b=2"
+    def transform_params!(params)
+      URI.encode_www_form(params) if params
+    end
+
+
+    ## Accepts underscored variables/params & converts them to camelCase as required by the YTLabs API.
+    ## The intention is to 'Rubify' the wrapper allowing underscore_style_variable_naming.
+    ## Example:
+    ## camelize_params_keys!({:room_code=>"123", :search_start_date=>"456"})
+    ## => {"roomCode"=>"123", "searchStartDate"=>"456"}
+    def camelize_params_keys!(params_hash)
+      return unless params_hash
+
+      params_hash.keys.each do |key|
+        value = params_hash.delete(key)
+        new_key = key.to_s.camelize(:lower)
+        params_hash[new_key] = value
+      end
+      params_hash
+    end
+
+    ## Builds endpoint URL dynamically.
+    def build_url(action, identifier=nil)
+      end_point = END_POINTS[action]
+
+      if identifier
+        url = "#{base_url}/#{end_point}/#{identifier}"
+      else
+        url = "#{base_url}/#{end_point}"
+      end
+      url
+    end
+
+    # The responses from the API are somewhat misleading. Calls that one might expect to 404 seem to return 403 Forbidden
+    # with "message"=>"Authorization header requires 'Credential' parameter. Consider how to provide more helpful messages.
+    def prepare_response(response)
+      if response.parsed_response["status"] == (200..206)
+        parse_successful_response(response)
+      else
+        # Temporary
+        JSON.parse(response.body)
+      end
+    end
+
+    def parse_successful_response(response)
+      JSON.parse(response.body)
+    end
+
+    def valid_token?(token)
+      token.size == 36
+    end
+
+    def valid_content_type?(content_type)
+      VALID_CONTENT_TYPES.include?(content_type)
+    end
+  end
+end

data/lib/ytlabs_api/end_points.yml

@@ -0,0 +1,26 @@
+# Define each endpoint here +end_points.yml+ to map a method name to
+# an endpoint that it will call on the API.
+
+# GET Requests
+get_properties: 		     "properties"
+get_property: 			     "properties"
+get_availability: 		   "available"
+
+get_provinces: 			     "provincecode"
+get_cities: 			       "citycode"
+get_extra_service_codes: "extraservicecode"
+get_theme_codes: 		     "themecode"
+
+get_reservations: 		   "reservation/information"
+
+get_room_types:			     "roomtypes"
+get_property_room_types: "properties"
+
+get_cancellation_charge: "reservation/cancelcharge"
+
+
+# POST Requests
+post_reservation_request: 		  "reservation/holding"
+post_reservation_confirmation:	"reservation/confirm"
+
+post_cancellation_request: 		  "reservation/cancel"

data/lib/ytlabs_api/property.rb

@@ -0,0 +1,61 @@
+module YTLabsApi
+  module Property
+
+    # GET /properties/
+    # Use this resource to get a response a list of properties in the YTLabs API.
+    #
+    # Parameters:
+    #
+    #     Required => updated_at                          Date at which data starts being returned. (YYYY-MM-DD).
+    #
+    #     Optional => i18n        default: "ko-KR"        Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+    #     Optional => offset      default: 0              Data offset (default 0)
+    #     Optional => limit       default: 30             Amount of requested properties (default 30)
+    #     Optional => active      default: 1              To filter by only active properties. 0 returns all. 1 returns Active only.
+    #
+    #     When parameter 'limit=0&updatedAt=1970-01-01' is specified in request, all of the properties' information is
+    #     returned. It is recommended only for the first time
+    #
+    # Example Request: https://api.ytlabs.co.kr/stage/v1/properties?i18n=en-US&offset=0&limit=30&active=1&updatedAt=2016-05-24
+    #
+    # Example usage: client.get_properties(:updated_at => "1970-01-01", :limit => 3)
+
+    def get_properties(params)
+      camelize_params_keys!(params)
+
+      response = HTTParty.get(
+        "#{build_url(__method__.to_s)}?#{transform_params!(params)}",
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+
+
+    # _________________________________________________________________________________________ #
+
+    # GET /properties/{propertyID}/
+    # Use this resource with a property_identifier (e.g. "w_w0307279") to get the property's information.
+    #
+    # Parameters:
+    #
+    #     Required => property_identifier                  The unique property identifier/hash (e.g. w_w0307279)
+    #
+    #     Optional => i18n        default: "ko-KR"        Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+    #
+    # Example Request: https://api.ytlabs.co.kr/stage/v1/properties/w_w0307279?i18n=en-US
+    #
+    # Example usage: client.get_property("w_w0307279", :i18n => "en-US")
+
+    def get_property(property_identifier, params=nil)
+      camelize_params_keys!(params)
+
+      response = HTTParty.get(
+        "#{build_url(__method__.to_s, property_identifier)}?#{transform_params!(params)}",
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+  end
+end

data/lib/ytlabs_api/room_type.rb

@@ -0,0 +1,59 @@
+module YTLabsApi
+  module RoomType
+
+    # GET /roomtypes/
+    # Obtain a list of all room types.
+
+    # Parameters:
+    #
+    #     Required => updated_at                          Date at which data starts being returned. (YYYY-MM-DD).
+    #
+    #     Optional => i18n        default: "ko-KR"        Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+    #     Optional => offset      default: 0              Data offset (default 0)
+    #     Optional => limit       default: 30             Amount of requested room type (default 30)
+    #     Optional => active      default: 1              To filter by only active room type. 0 returns all. 1 returns Active only.
+    #
+    #     When parameter 'updatedAt' is specified in request, only updated information is returned.
+    #
+    # Example Request: https://api.ytlabs.co.kr/stage/v1/roomtypes?i18n=en-US&offset=0&limit=30&active=1&updatedAt=2016-05-24
+    #
+    # Example usage: client.get_room_types(:updated_at => "1970-01-01", :limit => 1)
+
+    def get_room_types(params=nil)
+      camelize_params_keys!(params)
+
+      response = HTTParty.get(
+        "#{build_url(__method__.to_s)}?#{transform_params!(params)}",
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+
+
+    # GET /properties/{propertyID}/roomtypes/
+    # Using a specific propertyID, get all roomtypes' information of the property.
+
+    # Parameters:
+    #
+    #     Required => property_identifier                        Date at which data starts being returned. (YYYY-MM-DD).
+    #
+    #     Optional => i18n        default: "ko-KR"        Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+    #
+    # Example Request: https://api.ytlabs.co.kr/stage/v1/properties/w_w0307279/roomtypes?i18n=en-US
+    #
+    # Example usage: client.get_property_room_types("w_w0307279", :i81n => "en-US")
+
+    def get_property_room_types(property_identifier, params=nil)
+      camelize_params_keys!(params)
+
+      response = HTTParty.get(
+        "#{build_url(__method__.to_s, property_identifier)}/roomtypes?#{transform_params!(params)}",
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+
+  end
+end

data/lib/ytlabs_api/supplementary_information.rb

@@ -0,0 +1,63 @@
+module YTLabsApi
+  module SupplementaryInformation
+
+    # GET /provincecode/
+    # Returns a list with code or name of province.
+    # Optional => i18n        default: "ko-KR"        Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+
+    def get_provinces(i18n="ko-KR")
+      response = HTTParty.get(
+        "#{build_url(__method__.to_s)}?i18n=#{i18n}",
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+
+    # _________________________________________________________________________________________ #
+
+    # GET /citycode/
+    # Returns a list with code or name of cities.
+    # Optional => i18n        default: "ko-KR"        Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+
+    def get_cities(i18n="ko-KR")
+      response = HTTParty.get(
+        "#{build_url(__method__.to_s)}?i18n=#{i18n}",
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+
+    # _________________________________________________________________________________________ #
+
+    # GET /extraservicecode/
+    # Returns a list mapping the codes and names of extra services.
+    # Optional => i18n        default: "ko-KR"        Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+
+    def get_extra_service_codes(i18n="ko-KR")
+      response = HTTParty.get(
+        "#{build_url(__method__.to_s)}?i18n=#{i18n}",
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+
+    # _________________________________________________________________________________________ #
+
+    # GET /themecode/
+    # Returns a list mapping the code and name of themes.
+    # Optional => i18n        default: "ko-KR"        Return text in other lanaguages(ko-KR, en-US, zh-CN, ja-JP)
+
+    def get_theme_codes(i18n="ko-KR")
+      response = HTTParty.get(
+        "#{build_url(__method__.to_s)}?i18n=#{i18n}",
+        headers: { "Authorization" => token.to_s, "Content-Type" => "#{content_type}" }
+      )
+
+      prepare_response(response)
+    end
+
+  end
+end

data/lib/ytlabs_api/version.rb

@@ -0,0 +1,3 @@
+module YTLabsApi
+  VERSION = '0.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "ytlabs_api"
+require "webmock/rspec"
+
+# Disable all net connections except localhost.
+# Override this in a specific spec with ++WebMock.allow_net_connect!++
+WebMock.disable_net_connect!(:allow_localhost => true)

data/spec/ytlabs_api/client_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+
+describe YTLabsApi::Client do
+  ## Generates a 36 char length token.
+  let(:token) { SecureRandom.hex(18) }
+  let(:content_type) { :json }
+  let(:client) { described_class.new(token, content_type) }
+
+  describe "Client" do
+    it "instantiates a new client object" do
+      expect(client).to be_a (YTLabsApi::Client)
+    end
+
+    context "token" do
+      it "raises an error if a token is not valid" do
+        error_message = "Your access token is not valid. It must be 36 characters long."
+        bad_token = "123"
+        expect { described_class.new(bad_token) }.to raise_error (error_message)
+      end
+    end
+
+    context "content_type" do
+      it "accepts json" do
+        client = described_class.new(token, :json)
+        expect(client.content_type).to eq "application/json"
+      end
+
+      it "accepts xml" do
+        client = described_class.new(token, :xml)
+        expect(client.content_type).to eq "application/xml"
+      end
+
+      it "does not content types other than json or xml" do
+        error_message = "Your content type is invalid. 'json' or 'xml' are the 2 valid options"
+        expect { described_class.new(token, :html) }.to raise_error (error_message)
+      end
+    end
+
+    context "invalid/not implemented method/endpoint called" do
+      it "raises when invalid endpoint is called" do
+        error_message = 'This endpoint is not supported: Try one of these: ["get_properties", "get_property", "get_availability", "get_provinces", "get_cities", "get_extra_service_codes", "get_theme_codes", "get_reservations", "get_room_types", "get_property_room_types", "get_cancellation_charge", "post_reservation_request", "post_reservation_confirmation", "post_cancellation_request"]'
+        expect { client.bob }.to raise_error.with_message (error_message)
+      end
+    end
+  end
+
+  describe "base_url" do
+    it "responds with the base url" do
+      expect(client).to respond_to (:base_url)
+      expect(client.base_url).to eq ("https://api.ytlabs.co.kr/stage/v1")
+    end
+  end
+
+  context "properties" do
+    describe "#get_property" do
+      context "with an invalid access token" do
+        it "returns an Unauthorized response" do
+          WebMock.allow_net_connect!
+          expect(client.get_property("w_w0307360")).to include ( {"message"=>"Unauthorized"} )
+        end
+      end
+
+      context "with a valid access token" do
+        before do
+          response = '[{ "property": "a property for you" }]'
+          stub_request(:any, "https://api.ytlabs.co.kr/stage/v1/properties").to_return(:body => response, :status => 200, :headers => {})
+        end
+
+        it "returns a property within a parsed response" do
+          client = YTLabsApi::Client.new(token, :json)
+          response = client.get_property("w_w0307360")
+          expect(response).to eq response
+        end
+      end
+    end
+
+    describe "#get_properties" do
+      context "with an invalid access token" do
+        it "returns an Unauthorized response" do
+          WebMock.allow_net_connect!
+          expect(client.get_properties(:updated_at => "1970-01-01", :limit => 3)).to include ( {"message"=>"Unauthorized"} )
+        end
+      end
+
+      context "with a valid access token" do
+        before do
+          response = '[{ "property": "a property for you" }, { "property_2": "another property for you" }]'
+          url = "https://api.ytlabs.co.kr/stage/v1/properties?i18n=en-US&offset=0&limit=2&active=1&updatedAt=2016-05-24"
+          stub_request(:any, url).to_return(:body => response, :status => 200, :headers => {})
+        end
+
+        it "returns 2 properties within a parsed response" do
+          client = YTLabsApi::Client.new(token, :json)
+          response = client.get_properties(updated_at: Date.today)
+          expect(response).to eq response
+        end
+      end
+    end
+
+    describe "#get_room_types" do
+      before do
+        response = '[{ "room_type": "a room_type for you" }, { "room_type_2": "another room_type for you" }]'
+        url = "https://api.ytlabs.co.kr/stage/v1/roomtypes?i18n=en-US&offset=0&limit=30&active=1&updatedAt=2016-05-24"
+        stub_request(:any, url).to_return(:body => response, :status => 200, :headers => {})
+      end
+
+      it "returns 2 room_types within a parsed response" do
+        client = YTLabsApi::Client.new(token, :json)
+        response = client.get_room_types
+        expect(response).to eq response
+      end
+    end
+  end
+
+  context "supplementary_information" do
+    describe "#get_provinces" do
+      before do
+        response = '[{ "province_one": "great place", "province_two": "an ever better place" }]'
+        stub_request(:any, "https://api.ytlabs.co.kr/stage/v1/provincecode").to_return(:body => response, :status => 200, :headers => {})
+      end
+
+      it "returns a property within a parsed response" do
+        client = YTLabsApi::Client.new(token, :json)
+        response = client.get_provinces
+        expect(response).to eq response
+      end
+    end
+  end
+
+  private
+
+  describe "#build_url" do
+    context "without identifier (i.e. a room hash/id)" do
+      it "builds the endpoint URL correctly" do
+        stub_const("YTLabs::CLient::END_POINTS", { get_properties: "properties" } )
+        action = "get_properties"
+        expect(client.send(:build_url, action)).to eq "https://api.ytlabs.co.kr/stage/v1/properties"
+      end
+    end
+
+    context "with an identifier (i.e. a room hash/id)" do
+      it "builds the endpoint URL correctly" do
+        stub_const("YTLabsApi::CLient::END_POINTS", { get_properties: "properties" } )
+        action = "get_properties"
+        identifier = "123"
+        expect(client.send(:build_url, action, identifier)).to eq "https://api.ytlabs.co.kr/stage/v1/properties/123"
+      end
+    end
+  end
+
+  describe "#camelize_params_keys!(params_hash)" do
+    it "modifies a Rubified set of params keys correctly" do
+      params_hash = { :room_code => "123", :search_start_date => "456" }
+      expect(client.send(:camelize_params_keys!, params_hash)).to eq ({"roomCode"=> "123", "searchStartDate"=> "456"})
+    end
+
+    it "it does not modify keys that are already camelized" do
+      params_hash = { :roomCode => "123", :searchStartDate => "456" }
+      expect(client.send(:camelize_params_keys!, params_hash)).to eq ({"roomCode"=> "123", "searchStartDate"=> "456"})
+    end
+  end
+
+end

data/spec/ytlabs_api_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe "roomallo API" do
+  let(:ytlabs_api) { YTLabsApi }
+
+  it "is a module" do
+    expect( ytlabs_api ).to be_a( Module )
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: ytlabs_api_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Hawker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: Ruby wrapper enabling authenticated calls to the YT Labs API
+email: ben.c.hawker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/ytlabs_api.rb
+- lib/ytlabs_api/availability.rb
+- lib/ytlabs_api/booking.rb
+- lib/ytlabs_api/cancellation.rb
+- lib/ytlabs_api/client.rb
+- lib/ytlabs_api/end_points.yml
+- lib/ytlabs_api/property.rb
+- lib/ytlabs_api/room_type.rb
+- lib/ytlabs_api/supplementary_information.rb
+- lib/ytlabs_api/version.rb
+- spec/spec_helper.rb
+- spec/ytlabs_api/client_spec.rb
+- spec/ytlabs_api_spec.rb
+homepage: 
+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.4.6
+signing_key: 
+specification_version: 4
+summary: YT Labs API Ruby Client
+test_files: []