elong 0.2.1

data/lib/elong/api/hotel/data.rb

@@ -0,0 +1,45 @@
+module Elong
+  module API
+    module Hotel
+      # Elong Hotel Data API Class
+      class Data < Elong::API::Base
+
+        # The Hotel Data RP API
+        # ** Adadvanced API Level **
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def rp(params={})
+          self.request(__method__, params)
+        end
+
+        # The Hotel Data Inventory API
+        # ** Adadvanced API Level **
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def inventory(params={})
+          self.request(__method__, params)
+        end
+
+        # The Hotel Data Rate API
+        # ** Adadvanced API Level **
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def rate(params={})
+          self.request(__method__, params)
+        end
+
+        # The Hotel Data Validate API
+        # ** Adadvanced API Level **
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def validate(params={})
+          self.request(__method__, params)
+        end
+      end
+    end
+  end
+end

data/lib/elong/api/hotel/incr.rb

@@ -0,0 +1,57 @@
+module Elong
+  module API
+    module Hotel
+      # Elong Hotel Incr API Class
+      class Incr < Elong::API::Base
+
+        # The Hotel Incr Id API
+        # ** Adadvanced API Level **
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def id(params={})
+          self.request(__method__, params)
+        end
+
+        # The Hotel Incr Inv API
+        # ** Adadvanced API Level **
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def inv(params={})
+          self.request(__method__, params)
+        end
+
+        # The Hotel Incr Rate API
+        # ** Adadvanced API Level **
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def rate(params={})
+          self.request(__method__, params)
+        end
+
+        # The Hotel Incr Order API
+        #
+        # `https` request
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def order(params={})
+          self.request(__method__, params, https=true)
+        end
+
+        # The Hotel Incr Feedback API
+        #
+        # `https` request
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def feedback(params={})
+          self.request(__method__, params, https=true)
+        end
+
+      end
+    end
+  end
+end

data/lib/elong/api/hotel/order.rb

@@ -0,0 +1,86 @@
+module Elong
+  module API
+    module Hotel
+      # Elong Hotel Order API Class
+      class Order < Elong::API::Base
+
+        # The Hotel List Order API
+        #
+        # `https` request
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def list(params={})
+          self.request(__method__, params, https=true)
+        end
+
+        # The Hotel Order Detail API
+        #
+        # `https` request
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def detail(params={})
+          self.request(__method__, params, https=true)
+        end
+
+        # The Hotel Order Instant API
+        #
+        # `https` request
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def instant(params={})
+          self.request(__method__, params, https=true)
+        end
+
+        # The Hotel Create Order API
+        #
+        # `https` request
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def create(params={})
+          self.request(__method__, params, https=true)
+        end
+
+        # The Hotel Cancel Order API
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def cancel(params={})
+          self.request(__method__, params)
+        end
+
+        # The Hotel Update Order API
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def update(params={})
+          self.request(__method__, params)
+        end
+
+        # The Hotel Related Orders API
+        #
+        # `https` request
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def related(params={})
+          self.request(__method__, params, https=true)
+        end
+
+        # The Hotel Recent Orders API
+        #
+        # `https` request
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def recent(params={})
+          self.request(__method__, params, https=true)
+        end
+
+      end
+    end
+  end
+end

data/lib/elong/client.rb

@@ -0,0 +1,44 @@
+module Elong
+  # Elong Client Class
+  class Client
+    attr_reader :request
+
+    # Instantiate a new Elong API client using the
+    # user, appKey and secretKey registered to your
+    # application
+    #
+    # @param [String] user the user value
+    # @param [String] appKey the appKey value
+    # @param [String] secretKey the secretKey value
+    # @param opts [String] :domain elong api url (default: 'http://api.elong.com/rest')
+    # @param opts [String] :version the version of elong api version (default: '1.0')
+    # @param opts [String] :local the data return language (ONLY 'en_US' and 'zn_CN', default: 'zh_CN')
+    # @param opts [String] :format the data return foramat (ONLY 'json' and 'xml', default: 'json')
+    # @return [Elong::Client]
+    def initialize(user, appKey, secretKey, opts={})
+      @request = Elong::Request.new(user, appKey, secretKey, opts)
+    end
+
+    # The Hotel section
+    #
+    # @return [Elong::API::Hotel::Core]
+    def hotel
+      @hotel ||= Elong::API::Hotel::Core.new(self)
+    end
+
+    # The Globel Hotel section
+    #
+    # @return [Elong::API::GHotel::Core]
+    def ghotel
+      @ghotel ||= Elong::API::GHotel::Core.new(self)
+    end
+
+    # The Common section
+    #
+    # @return [Elong::API::Common::Core]
+    def common
+      @common ||= Elong::API::Common::Core.new(self)
+    end
+
+  end
+end

data/lib/elong/request.rb

@@ -0,0 +1,94 @@
+require "rest-client"
+require 'multi_json'
+require 'uri'
+
+
+module Elong
+  # Elong Http Request Class
+  class Request
+    attr_reader :user, :appKey, :secretKey
+    attr_accessor :data, :timestamp, :signature, :format, :domain, :version, :local, :https
+
+    # Initializes a Request instance
+    #
+    # @param [String] user the user value
+    # @param [String] appKey the appKey value
+    # @param [String] secretKey the secretKey value
+    # @param opts [String] :domain elong api url (default: 'http://api.elong.com/rest')
+    # @param opts [String] :version the version of elong api version (default: '1.0')
+    # @param opts [String] :local the data return language (ONLY 'en_US' and 'zn_CN', default: 'zh_CN')
+    # @param opts [String] :format the data return foramat (ONLY 'json' and 'xml', default: 'json')
+    # @return [Elong::Request]
+    def initialize(user, appKey, secretKey, opts={})
+      @user = user
+      @appKey = appKey
+      @secretKey = secretKey
+
+      @https = false
+      @domain = opts[:version] ? opts[:version] : 'http://api.elong.com/rest'
+      @version = opts[:version] ? opts[:version] : '1.0'
+      @local = opts[:local] ? opts[:local] : 'zh_CN'
+      @format = opts[:format] ? opts[:format] : 'json'
+    end
+
+    # Create a http request to call api
+    #
+    # @param [String] api call section api(eg, hotel.list, hotel.detail)
+    # @param [Hash] data the data request for api
+    # @param [Boolean] https request url if https or http (default: nil)
+    # @return [Elong::Response]
+    def execute(api, data, https=nil)
+      self.generateTimestamp
+      self.buildData(data)
+      self.generateSignature
+
+      params = self.buildQueryParams(api)
+      uri = URI.parse(@domain)
+      https = @https if ![TrueClass, FalseClass].include?(https.class)
+      scheme = https ? 'https' : 'http'
+      url = "#{scheme}://#{uri.host}/#{uri.path}?#{params}"
+
+      response = Elong::Response.new(RestClient.get(url))
+    end
+
+    # Build and format query params for url request
+    #
+    # @return [String]
+    def buildQueryParams(api)
+      URI.encode_www_form([
+        ["method", api],
+        ["user", @user],
+        ["timestamp", @timestamp],
+        ["data", @data],
+        ["signature", @signature],
+        ["format", @format],
+     ]).to_s
+    end
+
+    # Build request params
+    #
+    # @return [Hash]
+    def buildData(params)
+      @data = MultiJson.dump({
+        'Version' => @version,
+        'Local'   => @local,
+        'Request' => params
+      })
+    end
+
+    # Generate a new timestamp
+    #
+    # @return [String]
+    def generateTimestamp
+      @timestamp = Time.now.to_i.to_s
+    end
+
+    # Generate a new signature
+    #
+    # @return [String]
+    def generateSignature
+      @timestamp ||= self.generateTimestamps
+      @signature = Digest::MD5.hexdigest(@timestamp + Digest::MD5.hexdigest(@data + @appKey).downcase + @secretKey).downcase
+    end
+  end
+end

data/lib/elong/response.rb

@@ -0,0 +1,74 @@
+require 'multi_json'
+require 'multi_xml'
+
+
+module Elong
+  # Elong Http Response Class
+  class Response
+    attr_reader :status, :body, :headers, :cookies, :code, :error, :dataset
+
+    # Initializes a Request instance
+    #
+    # @param [RestClient::Response]
+    # @return [Elong::Response]
+    def initialize(response)
+      @status = response.code
+      @body = response.to_str
+      @headers = response.headers
+      @cookies = response.cookies
+
+      # mark status
+      if @status == 200
+        if self.json?
+          content = self.to_json
+          @code = content['Code']
+          @dataset = content['Request']
+        elsif self.xml?
+          content = self.to_xml
+          @code = content['ApiResult']['Code']
+          @dataset = content['ApiResult']['Result']
+        end
+
+        @code, @error = @code.split('|') if @code and @code.include?'|'
+        @code = @code
+      end
+    end
+
+    # Whether or not the content is json content type
+    #
+    # @return [Boolean]
+    def json?
+      (@headers[:content_type].include?'json') ? true : false
+    end
+
+    # Whether or not the content is xml content type
+    #
+    # @return [Boolean]
+    def xml?
+      (['xml', 'html'].any? { |word| @headers[:content_type].include?(word) }) ? true : false
+    end
+
+    # Output response content
+    #
+    # @return [String]
+    def to_s
+      @body
+    end
+
+    # Convert response content to JSON format
+    #
+    # @return [Hash]
+    def to_json
+      MultiJson.load(@body)
+    end
+
+    # Convert response content to XML format
+    #
+    # @return [Hash]
+    def to_xml(parser=nil)
+      MultiXml.parser = p if parser and [:ox, :libxml, :nokogiri, :rexml].include?parser.to_sym
+      MultiXml.parse(@body)
+    end
+
+  end
+end

data/lib/elong/version.rb

@@ -0,0 +1,3 @@
+module Elong
+  VERSION = "0.2.1"
+end

data/spec/elong/api/elong_api_hotel_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+
+describe Elong::API::Hotel do
+  subject { @client.hotel }
+
+  describe 'GET #detail' do
+    it '可以获取正确的房源信息' do
+      @client.request.format = 'json'
+      res = subject.detail(HotelIds:@hotelId,
+                           ArrivalDate:@tomorrow,
+                           DepartureDate:@theDayAfterTomorrow)
+
+      res.status.should eq(200)
+      res.code.should eq('0')
+      res.error.should be_nil
+
+      res.should be_json
+      #res.to_json['Result']['']
+    end
+
+    it '允许获取的结果为空' do
+      @client.request.format = 'json'
+      res = subject.detail(HotelIds:'999999999999999999',
+                           ArrivalDate:@tomorrow,
+                           DepartureDate:@theDayAfterTomorrow)
+
+      res.status.should eq(200)
+      res.code.should eq('0')
+      res.error.should be_nil
+
+      res.should be_json
+      res.to_json['Result']['Count'].should eq(0)
+    end
+
+    it '允许获取不存在的房源信息' do
+      @client.request.format = 'json'
+      res = subject.detail(HotelIds:'ddddd',
+                           ArrivalDate:@tomorrow,
+                           DepartureDate:@theDayAfterTomorrow)
+
+      res.status.should eq(200)
+      res.code.should eq('H000008')
+      res.error.should match('Ids不符合数字逗号格式')
+    end
+
+    it '必须保证时间格式正确无误' do
+      @client.request.format = 'json'
+      res = subject.detail(HotelIds:'000000',
+                           ArrivalDate:'13-10-1',
+                           DepartureDate:'13/10/2')
+
+      res.status.should eq(200)
+      res.code.should eq('H000998')
+      res.error.should match('请求参数异常')
+    end
+  end
+
+  describe 'GET #list' do
+    it '可以设置返回的房源数量' do
+      @client.request.format = 'json'
+      pageSize = 1
+      res = subject.list(CityId: @cityId,
+                          ArrivalDate: @tomorrow,
+                          DepartureDate: @theDayAfterTomorrow,
+                          PageSize: pageSize)
+
+
+      res.status.should eq(200)
+      res.code.should eq('0')
+      res.error.should be_nil
+
+      res.should be_json
+
+      #@todo: 貌似是bug，返回总是 20 个
+      res.to_json['Result']['Hotels'].size.should eq(pageSize)
+    end
+
+    it '获取不存在的房源信息' do
+      pending
+    end
+  end
+
+  describe '#order' do
+    describe 'GET order.list' do
+      it '获取正常数据' do
+        @client.request.format = 'json'
+        res = subject.order.list(PageIndex: 1)
+
+        res.status.should eq(200)
+        res.code.should eq('0')
+        res.error.should be_nil
+
+        res.should be_json
+
+        #@todo: 貌似是bug，返回总是 20 个
+        res.to_json['Result']['Hotels'].size.should eq(pageSize)
+      end
+    end
+  end
+end