elong 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5af2fbccbef85118ae749fc2648e699d5deeb5f3
+  data.tar.gz: 51aec4fb8d9373ce93c26e13d4167e570b4ce37a
+SHA512:
+  metadata.gz: 4d8345090f842c032d13085f489232d154fb66b6b0d49381c554c9849e51b8ac6c6e7b466b30de6a2caff3861becf78ae41d6bb8b64d66bb352bb82c1b7923d4
+  data.tar.gz: 0f279d8fa2aeaba614f949f52391c90eab7bab9d0250c0e25fa0897cd534154516558f005b5a1b403dda6527c14a27a59e5b2b0e63779da9e69f5be6d5ded762

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://ruby.taobao.org'
+
+group :development do
+  gem 'awesome_print'
+  gem 'json_pure'
+end
+
+group :test do
+  gem 'rspec'
+end
+
+# Specify your gem's dependencies in elong.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 icyleaf
+
+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,90 @@
+# Elong
+
+艺龙(elong.com) OpenAPI for Ruby
+
+## 安装
+
+在你项目的 `Gemfile` 文件添加下行内容:
+
+    gem 'elong'
+
+保存后执行:
+
+    $ bundle
+
+或者直接执行下行命令安装:
+
+    $ gem install elong
+
+## 用法
+
+### 初始化
+
+    user      = ''
+    appKey    = ''
+    secretKey = ''
+
+    client = Elong::Client.new(user, appKey, secretKey)
+
+### API 调用
+
+#### 查看国内酒店指定时间段北京（Id：0101）地区的房源信息
+
+    respone = client.house.list(CityId: '0101',
+                                ArrivalDate: '2013-10-1',
+                                DepartureDate: '2013-10-7',
+                                PageSize: 20))
+
+#### 取消国内酒店指定 id 的订单
+
+    response = client.hotel.order.cancel(OrderId:'237864278346',
+                                         CancelCode:'对酒店相关条件不满意')
+
+
+ > 无需在意文档中某些接口必须调用 `https` 协议的接口，代码已经帮你处理好了，调用就行了！
+
+
+### API 返回
+
+#### 查看 HTTP 状态码
+
+    puts response.status
+
+#### 查看 OpenAPI 状态码
+
+    puts response.code
+
+#### 查看返回的数据内容
+
+    puts response
+    puts response.body
+    puts response.to_s
+
+以上方式均可。
+
+#### 返回 JSON 结构化数据(基于 [mutli_json](https://github.com/intridea/multi_json))
+
+    jsonData = response.to_json
+
+#### 返回 XML 解析数据格式（基于 [mutli_xml](https://github.com/sferik/multi_xml)）
+
+    xmlDom = response.to_xml
+
+支持 ox, libxml, nokogiri, rexml 解析器，比如：
+
+    xmlDom = response.to_xml(:nokogiri)
+
+
+## 测试用例
+
+使用中对代码有疑惑，请浏览源码中 spec 中的代码，里面包含了大量的代码用例。
+填写 `spec/spec_hepler.rb` 中必要的 API 设定可以爬通完整的测试用例。
+
+
+## 贡献代码
+
+1. Fork 本仓库
+2. 创建你自己的 feature 分支 (`git checkout -b my-new-feature`)
+3. 提交你的代码 (`git commit -am 'Add some feature'`)
+4. 提交你的分支 (`git push origin my-new-feature`)
+5. 创建一个新的 Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+desc "Run specs."
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/elong.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elong/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elong"
+  spec.version       = Elong::VERSION
+  spec.authors       = ["icyleaf"]
+  spec.email         = ["icyleaf.cn@gmail.com"]
+  spec.description   = %q{Elong OpenAPI wrapper}
+  spec.summary       = spec.description
+  spec.homepage      = "http://github.com/icyleaf/elong"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "rest-client"
+  spec.add_dependency 'multi_json'
+  spec.add_dependency 'multi_xml'
+end

data/lib/elong.rb

@@ -0,0 +1,9 @@
+require "elong/version"
+require "elong/response"
+require "elong/request"
+require "elong/client"
+
+require "elong/api/base"
+require "elong/api/hotel"
+require "elong/api/ghotel"
+require "elong/api/common"

data/lib/elong/api/base.rb

@@ -0,0 +1,36 @@
+module Elong
+  module API
+    # Elong API Base Class
+    class Base
+
+      # Initializes a API Base instance
+      #
+      # @params [Elong::Client] client an instance of Elong::Client
+      # @return [ELong::API::Base]
+      def initialize(client)
+        @client = client
+      end
+
+      # Start a new http request
+      #
+      # @params [String] method the method of called in the instance class
+      # @params [Hash] params the params of called api
+      # @return [Elong::Response]
+      def request(method, params)
+        @client.request.execute(self.buildAPI(method), params)
+      end
+
+      # Build api url with class & methods
+      #
+      # @params [String] method the method of called in the instance class
+      # @return [String]
+      def buildAPI(method)
+        className = self.class.name.split('::').map{|n|
+          n.downcase if ! ['elong', 'api', 'core'].include?n.downcase
+        }.compact.reject{|r| r.empty? if r.class == String}.join('.')
+        methodName = method.downcase
+        return "#{className}.#{methodName}"
+      end
+    end
+  end
+end

data/lib/elong/api/common.rb

@@ -0,0 +1,10 @@
+require "elong/api/common/core"
+require "elong/api/common/creditcard"
+
+
+module Elong
+  module API
+    module Common
+    end
+  end
+end

data/lib/elong/api/common/core.rb

@@ -0,0 +1,17 @@
+module Elong
+  module API
+    module Common
+      # Elong Common Core API Class
+      class Core < Elong::API::Base
+
+        # The Creditcard seciont
+        #
+        # @return [Elong::API::Common::Creditcard]
+        def creditcard
+          @creditcard ||= Elong::API::Common::Creditcard.new(@client)
+        end
+
+      end
+    end
+  end
+end

data/lib/elong/api/common/creditcard.rb

@@ -0,0 +1,20 @@
+module Elong
+  module API
+    module Common
+      # Elong Creditcard of Common API Class
+      class Creditcard < Elong::API::Base
+
+        # Validate creditcard if or not the CVV must be input
+        #
+        # `https` request
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def validate(params={})
+          self.request(__method__, params, https=true)
+        end
+
+      end
+    end
+  end
+end

data/lib/elong/api/ghotel.rb

@@ -0,0 +1,11 @@
+require "elong/api/ghotel/core"
+require "elong/api/ghotel/search"
+require "elong/api/ghotel/order"
+
+
+module Elong
+  module API
+    module GHotel
+    end
+  end
+end

data/lib/elong/api/ghotel/core.rb

@@ -0,0 +1,24 @@
+module Elong
+  module API
+    module GHotel
+      # Elong Global Hotel Core API Class
+      class Core < Elong::API::Base
+
+        # The Global Hotel Search section
+        #
+        # @return [Elong::API::GHotel::Search]
+        def search
+          @search ||= Elong::API::GHotel::Search.new(@client)
+        end
+
+        # The Global Hotel Order section
+        #
+        # @return [Elong::API::GHotel::Order]
+        def order
+          @order ||= Elong::API::GHotel::Order.new(@client)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module Elong
+  module API
+    module GHotel
+      # Elong Global Hotel Order API Class
+      class Order < Elong::API::Base
+
+        # The Global Hotel List Order API
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def list(params={})
+          self.request(__method__, params)
+        end
+
+        # The Hotel Order Detail API
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def detail(params={})
+          self.request(__method__, params)
+        end
+
+        # The Hotel Create Order API
+        #
+        # @todo MUST `https` request
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def create(params={})
+          self.request(__method__, params)
+        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
+        # ** Its not works in Hongkong, Macao, Taiwan **
+        #
+        # @params [Hash] params api params
+        # @return [Elong::Response]
+        def update(params={})
+          self.request(__method__, params)
+        end
+
+      end
+    end
+  end
+end

data/lib/elong/api/ghotel/search.rb

@@ -0,0 +1,31 @@
+module Elong
+  module API
+    module GHotel
+      # Elong Global Hotel Search API Class
+      class Search < Elong::API::Base
+
+        # Search and list globalehotel data
+        #
+        # @return [Elong::Response]
+        def list(params={})
+          self.request(__method__, params)
+        end
+
+        # View hotel details data
+        #
+        # @return [Elong::Response]
+        def detail(params={})
+          self.request(__method__, params)
+        end
+
+        # Check hotel room status(type, available numbers)
+        #
+        # @return [Elong::Response]
+        def room(params={})
+          self.request(__method__, params)
+        end
+
+      end
+    end
+  end
+end

data/lib/elong/api/hotel.rb

@@ -0,0 +1,12 @@
+require "elong/api/hotel/core"
+require "elong/api/hotel/data"
+require "elong/api/hotel/order"
+require "elong/api/hotel/incr"
+
+
+module Elong
+  module API
+    module Hotel
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module Elong
+  module API
+    module Hotel
+      # Elong Hotel Core API Class
+      class Core < Elong::API::Base
+
+        # List hotel data for recent 90 days data.
+        # the result will be cacahed about 10 mins
+        #
+        # @return [Elong::Response]
+        def list(params={})
+          self.request(__method__, params)
+        end
+
+        # View hotel details data
+        #
+        # @return [Elong::Response]
+        def detail(params={})
+          self.request(__method__, params)
+        end
+
+        # The Hotel Data section
+        #
+        # @return [Elong::API::Hotel::Data]
+        def data
+          @data ||= Elong::API::Hotel::Data.new(@client)
+        end
+
+        # The Hotel Order section
+        #
+        # @return [Elong::API::Hotel::Order]
+        def order
+          @order ||= Elong::API::Hotel::Order.new(@client)
+        end
+
+        # The Hotel Incr section
+        #
+        # @return [Elong::API::Hotel::Incr]
+        def incr
+          @incr ||= Elong::API::Hotel::Incr.new(@client)
+        end
+
+      end
+    end
+  end
+end