clt-sdk 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d05f85f4b20ea6b1bcc86a195e3848cf1ecc1cb
-  data.tar.gz: ef9fda455b33c44ce4dc07b1b25b0d4b860bafbb
+  metadata.gz: 6c1abca04bba99773ae3ec26193f14009553c099
+  data.tar.gz: 5acbc8ac75b3ba2a02135abb5455be647301e817
 SHA512:
-  metadata.gz: a5eca1fb2c856d7643b879dfaad53bbb59be9e1c39c700f277545dc0bfff8ae56b508c7800c494918d90f1f9b4cafb8b18614f98365520522a29948b0fbf924e
-  data.tar.gz: f3e51de53f4f24c890521cedcca89ad12762b389241d98e32246470bb7bb55e04080e064c2fb4ca9f08f346ba6dff5f2c9fe0cea3846ee8ed4176abb78aea36e
+  metadata.gz: d05873d9c4fe3eb930d430b4575f6f13e42ac5145d91d7af483c79399408d1f0457201f5b0440f5a4ab3817354ed54218b58819f280010ba615b0d84be8546e6
+  data.tar.gz: 3450de500406f4e5a1ce83769cdc2aa994e6b8ee52606f93d115d398ff6c00c9a55219b38105a7ee78ebc8548d01e05c4fc74336527dab8880eafa2fff1e09fd

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+2.0.0 Aug 8th, 2016
+* Update code according to new API document
+
 1.0.1 Jul 7th, 2016
 * Fix Net issue
 

data/README.md

@@ -3,7 +3,7 @@
 
 # Clt SDK
 
-Basic API client for President Collect Service.
+API client for President Collect Service.
 
 ## Installation
 
@@ -33,59 +33,62 @@ $ gem install clt-sdk
 require "clt-sdk"
 
 Clt.setup do |config|
-  config.cvs_cust_id = "YOUR_CVS_CUST_ID"
-  config.cvs_cust_password = "YOUR_CVS_CUST_PASSWORD"
-  config.cvs_expire_after = 1
-  config.cocs_link_id = "YOUR_COCS_LINK_ID"
-  config.cocs_hash_base = "YOUR_COCS_HASH_BASE"
+  config.cvs_cust_id = "CVS_CUST_ID"
+  config.cvs_cust_password = "CVS_CUST_PASSWORD"
+  config.cvs_default_expire_day = 1
+  config.cocs_link_id = "COCS_LINK_ID"
+  config.cocs_hash_base = "COCS_HASH_BASE"
 end
 ```
 
-`cvs_expire_after`: [**Optional**] The ibon payment code will expired after this setting day (Default: 1)
+`cvs_default_expire_day`: **Optional.** ibon code will expired after this day (Default: 1)
 
 ## Example
 
 * ibon
 
   ```ruby
-  cvs = Clt::Cvs.new
+  cvs_client = Clt::Cvs.new
   ```
 
   #### Order Create
 
   ```ruby
-  result = cvs.order_create(
+  result = cvs_client.order_create(
     service_url: "SERVICE_URL",
-    order_number: "TESTORDER000001",
-    amount: 100,
-    mobile: "0987654321",
-    email: "test@localhost.com"
+    cust_order_number: "TESTORDER000001",
+    order_amount: 100,
+    payer_mobile: "0987654321",
+    payer_email: "test@localhost.com"
   )
   ```
 
-  Optional parameters: `name`, `postcode`, `address`
+  Optional parameters: `expire_date`, `payer_name`, `payer_postcode`, `payer_address`
+
+  > `expired_date` will overwrite `cvs_default_expire_day` setting.
 
   #### Order Query
 
   ```ruby
-  result = cvs.order_query(
+  result = cvs_client.order_query(
     service_url: "SERVICE_URL",
-    update_time_begin: "2016-05-27T00:00:00+08:00"
+    process_code_update_time_begin: "2016-08-08T00:00:00+08:00",
+    process_code_update_time_end: "2016-08-08T23:59:59+08:00"
   )
   ```
 
-  Optional parameters: `update_time_end`
-
 * Credit Card
 
   ```ruby
-  credit_card = Clt::CreditCard.new
+  cocs_client = Clt::CreditCard.new
   ```
 
+  > `chk` will be automatically generated by default.
+
   #### Order Create
 
   ```ruby
-  result = credit_card.order_create(
+  result = cocs_client.order_create(
     service_url: "SERVICE_URL",
     cust_order_no: "TESTORDER000001",
     order_amount: 100,
@@ -93,24 +96,26 @@ end
   )
   ```
 
-  Optional parameters: `cust_order_no`, `limit_product_id`
+  Optional parameters: `cust_order_no`, `limit_product_id`, `chk`
 
-  > System will automatic generate `cust_order_no` if empty
+  > `cust_order_no` will be automatically generated if empty.
 
   #### Order Cancel
 
   ```ruby
-  result = credit_card.order_cancel(
+  result = cocs_client.order_cancel(
     service_url: "SERVICE_URL",
     cust_order_no: "TESTORDER000001",
     order_amount: 100
   )
   ```
 
+  Optional parameters: `chk`
+
   #### Order Refund
 
   ```ruby
-  result = credit_card.order_refund(
+  result = cocs_client.order_refund(
     service_url: "SERVICE_URL",
     cust_order_no: "TESTORDER000001",
     order_amount: 100,
@@ -118,11 +123,12 @@ end
   )
   ```
 
+  Optional parameters: `chk`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/CalvertYang/clt-sdk.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/clt-sdk.rb

@@ -1,22 +1,25 @@
-require "clt/version"
-require "clt/error_message"
-require "clt/cvs"
-require "clt/credit_card"
-
 require "nokogiri"
 require "nori"
 require "json"
+require "digest"
 require "net/http"
 require "net/https"
 
+require "clt/version"
+require "clt/error_message"
+require "clt/general_methods"
+require "clt/core_ext/hash"
+require "clt/cvs"
+require "clt/credit_card"
+
 module Clt
   class << self
-    attr_accessor :cvs_cust_id, :cvs_cust_password, :cvs_expire_after
+    attr_accessor :cvs_cust_id, :cvs_cust_password, :cvs_default_expire_day
     attr_accessor :cocs_link_id, :cocs_hash_base
   end
 
-  def self.cvs_expire_after
-    @cvs_expire_after || 1
+  def self.cvs_default_expire_day
+    @cvs_default_expire_day || 1
   end
 
   def self.setup

data/lib/clt/core_ext/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  def stringify_keys
+    result = self.class.new
+    each_key do |key|
+      result[key.to_s] = self[key]
+    end
+    result
+  end
+end

data/lib/clt/credit_card.rb

@@ -1,41 +1,49 @@
 module Clt
   class CreditCard
+    include GeneralMethods
+
     def initialize
       raise ArgumentError, "Please setup cocs_link_id first" if Clt.cocs_link_id.nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :cocs_link_id, data: "String") unless Clt.cocs_link_id.is_a? String
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :cocs_link_id, data: "String") unless Clt.cocs_link_id.is_a? String
       ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :cocs_link_id) if Clt.cocs_link_id.empty?
 
       raise ArgumentError, "Please setup cocs_hash_base first" if Clt.cocs_hash_base.nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :cocs_hash_base, data: "String") unless Clt.cocs_hash_base.is_a? String
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :cocs_hash_base, data: "String") unless Clt.cocs_hash_base.is_a? String
       ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :cocs_hash_base) if Clt.cocs_hash_base.empty?
     end
 
     # Order Create
     def order_create params = {}
-      ErrorMessage.raise_argument_error(msg: :wrong_parameter_type, type: "Hash") unless params.is_a? Hash
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: "Parameter", data: "Hash") unless params.is_a? Hash
 
       ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :service_url) if params[:service_url].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :service_url, data: "String") unless params[:service_url].is_a? String
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :service_url, data: "String") unless params[:service_url].is_a? String
       ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :service_url) if params[:service_url].empty?
 
       if params.has_key? :cust_order_no
-        ErrorMessage.raise_argument_error(msg: :wrong_data, field: :cust_order_no, data: "String") unless params[:cust_order_no].is_a? String
+        ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :cust_order_no, data: "String") unless params[:cust_order_no].is_a? String
         ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :cust_order_no) if params[:cust_order_no].empty?
         ErrorMessage.raise_argument_error(msg: :data_length_too_short, field: :cust_order_no) if params[:cust_order_no].size < 3
       end
 
       ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :order_amount) if params[:order_amount].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :order_amount, data: "Integer") unless params[:order_amount].is_a? Fixnum
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :order_amount, data: "Integer") unless params[:order_amount].is_a? Integer
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :order_amount, data: "greater than 0") if params[:order_amount] <= 0
 
       ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :order_detail) if params[:order_detail].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :order_detail, data: "String") unless params[:order_detail].is_a? String
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :order_detail, data: "String") unless params[:order_detail].is_a? String
       ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :order_detail) if params[:order_detail].empty?
 
       if params.has_key? :limit_product_id
-        ErrorMessage.raise_argument_error(msg: :wrong_data, field: :limit_product_id, data: "String") unless params[:limit_product_id].is_a? String
+        ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :limit_product_id, data: "String") unless params[:limit_product_id].is_a? String
         ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :limit_product_id) if params[:limit_product_id].empty?
       end
 
+      if params.has_key? :chk
+        raise_argument_error(msg: :parameter_should_be, field: :chk, data: "String") unless params[:chk].is_a? String
+        raise_argument_error(msg: :cannot_be_empty, field: :chk) if params[:chk].empty?
+      end
+
       service_url = params[:service_url]
       params.delete :service_url
 
@@ -46,75 +54,107 @@ module Clt
         send_time: Time.now.strftime("%F %T"),
         return_type: "json"
       }.merge(params)
-      data[:chk] = create_chk "#{Clt.cocs_hash_base}$#{params[:order_amount]}$#{data[:send_time]}"
+
+      unless params.has_key? :chk
+        data[:chk] = generate_checksum "#{Clt.cocs_hash_base}$#{params[:order_amount]}$#{data[:send_time]}"
+      end
 
       request(method: "POST", service_url: service_url, data: data)
     end
 
     # Order Cancel
     def order_cancel params = {}
-      ErrorMessage.raise_argument_error(msg: :wrong_parameter_type, type: "Hash") unless params.is_a? Hash
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: "Parameter", data: "Hash") unless params.is_a? Hash
 
       ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :service_url) if params[:service_url].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :service_url, data: "String") unless params[:service_url].is_a? String
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :service_url, data: "String") unless params[:service_url].is_a? String
       ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :service_url) if params[:service_url].empty?
 
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :cust_order_no, data: "String") unless params[:cust_order_no].is_a? String
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :cust_order_no, data: "String") unless params[:cust_order_no].is_a? String
       ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :cust_order_no) if params[:cust_order_no].empty?
 
       ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :order_amount) if params[:order_amount].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :order_amount, data: "Integer") unless params[:order_amount].is_a? Fixnum
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :order_amount, data: "Integer") unless params[:order_amount].is_a? Integer
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :order_amount, data: "greater than 0") if params[:order_amount] <= 0
+
+      if params.has_key? :chk
+        raise_argument_error(msg: :parameter_should_be, field: :chk, data: "String") unless params[:chk].is_a? String
+        raise_argument_error(msg: :cannot_be_empty, field: :chk) if params[:chk].empty?
+      end
 
       data = {
         link_id: Clt.cocs_link_id,
         send_time: Time.now.strftime("%F %T"),
         return_type: "json"
       }.merge(params)
-      data[:chk] = create_chk "#{Clt.cocs_hash_base}$#{params[:cust_order_no]}$#{params[:order_amount]}$#{data[:send_time]}"
+
+      unless params.has_key? :chk
+        data[:chk] = generate_checksum "#{Clt.cocs_hash_base}$#{params[:cust_order_no]}$#{params[:order_amount]}$#{data[:send_time]}"
+      end
 
       request(method: "POST", service_url: params[:service_url], data: data)
     end
 
     # Order Refund
     def order_refund params = {}
-      ErrorMessage.raise_argument_error(msg: :wrong_parameter_type, type: "Hash") unless params.is_a? Hash
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: "Parameter", data: "Hash") unless params.is_a? Hash
 
       ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :service_url) if params[:service_url].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :service_url, data: "String") unless params[:service_url].is_a? String
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :service_url, data: "String") unless params[:service_url].is_a? String
       ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :service_url) if params[:service_url].empty?
 
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :cust_order_no, data: "String") unless params[:cust_order_no].is_a? String
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :cust_order_no, data: "String") unless params[:cust_order_no].is_a? String
       ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :cust_order_no) if params[:cust_order_no].empty?
 
       ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :order_amount) if params[:order_amount].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :order_amount, data: "Integer") unless params[:order_amount].is_a? Fixnum
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :order_amount, data: "Integer") unless params[:order_amount].is_a? Integer
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :order_amount, data: "greater than 0") if params[:order_amount] <= 0
 
       ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :refund_amount) if params[:refund_amount].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :refund_amount, data: "Integer") unless params[:refund_amount].is_a? Fixnum
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :refund_amount, data: "Integer") unless params[:refund_amount].is_a? Integer
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :refund_amount, data: "greater than 0") if params[:refund_amount] <= 0
+
+      if params[:refund_amount] > params[:order_amount]
+        ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :refund_amount, data: "less than or equal to order_amount")
+      end
+
+      if params.has_key? :chk
+        raise_argument_error(msg: :parameter_should_be, field: :chk, data: "String") unless params[:chk].is_a? String
+        raise_argument_error(msg: :cannot_be_empty, field: :chk) if params[:chk].empty?
+      end
 
       data = {
         link_id: Clt.cocs_link_id,
         send_time: Time.now.strftime("%F %T"),
         return_type: "json"
       }.merge(params)
-      data[:chk] = create_chk "#{Clt.cocs_hash_base}$#{params[:cust_order_no]}$#{params[:order_amount]}$#{params[:refund_amount]}$#{data[:send_time]}"
+
+      unless params.has_key? :chk
+        data[:chk] = generate_checksum "#{Clt.cocs_hash_base}$#{params[:cust_order_no]}$#{params[:order_amount]}$#{params[:refund_amount]}$#{data[:send_time]}"
+      end
 
       request(method: "POST", service_url: params[:service_url], data: data)
     end
 
-    # Response data validation
-    def data_valid? params
-      chk = params["chk"]
-      generated_chk = create_chk "#{Clt.cocs_hash_base}$#{params['order_amount']}$#{params['send_time']}$#{params['ret']}$#{params['acquire_time']}$#{params['auth_code']}$#{params['card_no']}$#{params['notify_time']}$#{params['cust_order_no']}"
+    # Authorize success response validation
+    def auth_success_response_valid? params
+      params = params.stringify_keys
+      checksum = params["chk"]
+      new_checksum = generate_checksum "#{Clt.cocs_hash_base}$#{params['order_amount']}$#{params['send_time']}$#{params['ret']}$#{params['acquire_time']}$#{params['auth_code']}$#{params['card_no']}$#{params['notify_time']}$#{params['cust_order_no']}"
 
-      chk == generated_chk
+      checksum == new_checksum
     end
 
-    private
+    # Authorize fail response validation
+    def auth_fail_response_valid? params
+      params = params.stringify_keys
+      checksum = params["chk"]
+      new_checksum = generate_checksum "#{Clt.cocs_hash_base}$#{params['order_amount']}$#{params['send_time']}$#{params['ret']}$#{params['notify_time']}$#{params['cust_order_no']}"
 
-      def create_chk data
-        Digest::MD5.hexdigest data
-      end
+      checksum == new_checksum
+    end
+
+    private
 
       def request method:, service_url:, data:
         api_url = URI.parse(service_url)

data/lib/clt/cvs.rb

@@ -1,55 +1,64 @@
 module Clt
   class Cvs
+    include GeneralMethods
+
     def initialize
       raise ArgumentError, "Please setup cvs_cust_id first" if Clt.cvs_cust_id.nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :cvs_cust_id, data: "String") unless Clt.cvs_cust_id.is_a? String
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :cvs_cust_id, data: "String") unless Clt.cvs_cust_id.is_a? String
       ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :cvs_cust_id) if Clt.cvs_cust_id.empty?
 
       raise ArgumentError, "Please setup cvs_cust_password first" if Clt.cvs_cust_password.nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :cvs_cust_password, data: "String") unless Clt.cvs_cust_password.is_a? String
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :cvs_cust_password, data: "String") unless Clt.cvs_cust_password.is_a? String
       ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :cvs_cust_password) if Clt.cvs_cust_password.empty?
 
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :cvs_cust_password, data: "Integer") unless Clt.cvs_expire_after.is_a? Fixnum
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :cvs_default_expire_day, data: "Integer") unless Clt.cvs_default_expire_day.is_a? Integer
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :cvs_default_expire_day, data: "greater than 0") if Clt.cvs_default_expire_day <= 0
     end
 
     def order_create params = {}
-      ErrorMessage.raise_argument_error(msg: :wrong_parameter_type, type: "Hash") unless params.is_a? Hash
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: "Parameter", data: "Hash") unless params.is_a? Hash
 
       ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :service_url) if params[:service_url].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :service_url, data: "String") unless params[:service_url].is_a? String
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :service_url, data: "String") unless params[:service_url].is_a? String
       ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :service_url) if params[:service_url].empty?
 
-      ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :order_number) if params[:order_number].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :order_number, data: "String") unless params[:order_number].is_a? String
-      ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :order_number) if params[:order_number].empty?
+      ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :cust_order_number) if params[:cust_order_number].nil?
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :cust_order_number, data: "String") unless params[:cust_order_number].is_a? String
+      ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :cust_order_number) if params[:cust_order_number].empty?
+
+      ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :order_amount) if params[:order_amount].nil?
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :order_amount, data: "Integer") unless params[:order_amount].is_a? Integer
 
-      ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :amount) if params[:amount].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :amount, data: "Integer") unless params[:amount].is_a? Fixnum
+      if params.has_key? :expire_date
+        ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :expire_date, data: "String") unless params[:expire_date].is_a? String
+        ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :expire_date) if params[:expire_date].empty?
+        ErrorMessage.raise_argument_error(msg: :wrong_data_format, field: :expire_date) unless /\A\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\+\d{2}:\d{2}\z/.match(params[:expire_date])
+      end
 
-      if params.has_key? :name
-        ErrorMessage.raise_argument_error(msg: :wrong_data, field: :name, data: "String") unless params[:name].is_a? String
-        ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :name) if params[:name].empty?
+      if params.has_key? :payer_name
+        ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :payer_name, data: "String") unless params[:payer_name].is_a? String
+        ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :payer_name) if params[:payer_name].empty?
       end
 
-      if params.has_key? :postcode
-        ErrorMessage.raise_argument_error(msg: :wrong_data, field: :postcode, data: "String") unless params[:postcode].is_a? String
-        ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :postcode) if params[:postcode].empty?
+      if params.has_key? :payer_postcode
+        ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :payer_postcode, data: "String") unless params[:payer_postcode].is_a? String
+        ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :payer_postcode) if params[:payer_postcode].empty?
       end
 
-      if params.has_key? :address
-        ErrorMessage.raise_argument_error(msg: :wrong_data, field: :address, data: "String") unless params[:address].is_a? String
-        ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :address) if params[:address].empty?
+      if params.has_key? :payer_address
+        ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :payer_address, data: "String") unless params[:payer_address].is_a? String
+        ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :payer_address) if params[:payer_address].empty?
       end
 
-      ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :mobile) if params[:mobile].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :mobile, data: "String") unless params[:mobile].is_a? String
-      ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :mobile) if params[:mobile].empty?
+      ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :payer_mobile) if params[:payer_mobile].nil?
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :payer_mobile, data: "String") unless params[:payer_mobile].is_a? String
+      ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :payer_mobile) if params[:payer_mobile].empty?
 
-      ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :email) if params[:email].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :email, data: "String") unless params[:email].is_a? String
-      ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :email) if params[:email].empty?
+      ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :payer_email) if params[:payer_email].nil?
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :payer_email, data: "String") unless params[:payer_email].is_a? String
+      ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :payer_email) if params[:payer_email].empty?
 
-      expire_date = get_cvs_expire_date
+      expire_date = params.has_key?(:expire_date) ? params[:expire_date] : cvs_default_expire_date
 
       # build xml data
       builder = Nokogiri::XML::Builder.new(:encoding => "UTF-8") do
@@ -60,14 +69,14 @@ module Clt
             cust_password Clt.cvs_cust_password
           }
           order {
-            cust_order_number params[:order_number]
-            order_amount params[:amount]
+            cust_order_number params[:cust_order_number]
+            order_amount params[:order_amount]
             expire_date expire_date
-            payer_name params[:name] if params.has_key? :name
-            payer_postcode params[:postcode] if params.has_key? :postcode
-            payer_address params[:address] if params.has_key? :address
-            payer_mobile params[:mobile]
-            payer_email params[:email]
+            payer_name params[:payer_name] if params.has_key? :payer_name
+            payer_postcode params[:payer_postcode] if params.has_key? :payer_postcode
+            payer_address params[:payer_address] if params.has_key? :payer_address
+            payer_mobile params[:payer_mobile]
+            payer_email params[:payer_email]
           }
         }
       end
@@ -76,21 +85,21 @@ module Clt
     end
 
     def order_query params = {}
-      ErrorMessage.raise_argument_error(msg: :wrong_parameter_type, type: "Hash") unless params.is_a? Hash
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: "Parameter", data: "Hash") unless params.is_a? Hash
 
       ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :service_url) if params[:service_url].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :service_url, data: "String") unless params[:service_url].is_a? String
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :service_url, data: "String") unless params[:service_url].is_a? String
       ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :service_url) if params[:service_url].empty?
 
-      ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :update_time_begin) if params[:update_time_begin].nil?
-      ErrorMessage.raise_argument_error(msg: :wrong_data, field: :update_time_begin, data: "String") unless params[:update_time_begin].is_a? String
-      ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :update_time_begin) if params[:update_time_begin].empty?
+      ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :process_code_update_time_begin) if params[:process_code_update_time_begin].nil?
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :process_code_update_time_begin, data: "String") unless params[:process_code_update_time_begin].is_a? String
+      ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :process_code_update_time_begin) if params[:process_code_update_time_begin].empty?
+      ErrorMessage.raise_argument_error(msg: :wrong_data_format, field: :process_code_update_time_begin) unless /\A\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\+\d{2}:\d{2}\z/.match(params[:process_code_update_time_begin])
 
-      if params.has_key? :update_time_end
-        ErrorMessage.raise_argument_error(msg: :wrong_data, field: :update_time_end, data: "String") unless params[:update_time_end].is_a? String
-        ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :update_time_end) if params[:update_time_end].empty?
-        ErrorMessage.raise_argument_error(msg: :wrong_format, field: :update_time_end) unless /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\+\d{2}:\d{2}/.match(params[:update_time_end])
-      end
+      ErrorMessage.raise_argument_error(msg: :missing_parameter, field: :process_code_update_time_end) if params[:process_code_update_time_end].nil?
+      ErrorMessage.raise_argument_error(msg: :parameter_should_be, field: :process_code_update_time_end, data: "String") unless params[:process_code_update_time_end].is_a? String
+      ErrorMessage.raise_argument_error(msg: :cannot_be_empty, field: :process_code_update_time_end) if params[:process_code_update_time_end].empty?
+      ErrorMessage.raise_argument_error(msg: :wrong_data_format, field: :process_code_update_time_end) unless /\A\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\+\d{2}:\d{2}\z/.match(params[:process_code_update_time_end])
 
       builder = Nokogiri::XML::Builder.new(:encoding => "UTF-8") do
         request {
@@ -100,8 +109,8 @@ module Clt
             cust_password Clt.cvs_cust_password
           }
           query {
-            process_code_update_time_begin params[:update_time_begin]
-            process_code_update_time_end params[:update_time_end] if params.has_key? :update_time_end
+            process_code_update_time_begin params[:process_code_update_time_begin]
+            process_code_update_time_end params[:process_code_update_time_end]
           }
         }
       end
@@ -111,8 +120,9 @@ module Clt
 
     private
 
-      def get_cvs_expire_date
-        offset = 60 * 60 * 24 * Clt.cvs_expire_after
+      def get_cvs_default_expire_date
+        seconds_in_a_day = 60 * 60 * 24
+        offset = seconds_in_a_day * Clt.cvs_default_expire_day
 
         (Time.now + offset).iso8601
       end

data/lib/clt/error_message.rb

@@ -6,13 +6,11 @@ module Clt
       case params[:msg]
       when :missing_parameter
         message = "Missing required parameter: #{params[:field]}"
-      when :wrong_parameter_type
-        message = "Parameter should be #{params[:type]}"
-      when :wrong_data
+      when :parameter_should_be
         message = "#{params[:field]} should be #{params[:data]}"
       when :data_length_too_short
         message = "The length of #{params[:field]} is too short"
-      when :wrong_format
+      when :wrong_data_format
         message = "The format for #{params[:field]} is wrong"
       when :cannot_be_empty
         message = "#{params[:field]} cannot be empty"

data/lib/clt/general_methods.rb

@@ -0,0 +1,16 @@
+module Clt
+  module GeneralMethods
+    # APN(Active Payment Notification) response validation
+    def apn_response_valid? params
+      params = params.stringify_keys
+      checksum = params["checksum"]
+      new_checksum = generate_checksum "#{params['api_id']}:#{params['trans_id']}:#{params['amount']}:#{params['status']}:#{params['nonce']}"
+
+      checksum == new_checksum
+    end
+
+    def generate_checksum data
+      Digest::MD5.hexdigest data
+    end
+  end
+end

data/lib/clt/version.rb

@@ -1,3 +1,3 @@
 module Clt
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clt-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Calvert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -85,9 +85,11 @@ files:
 - bin/setup
 - clt-sdk.gemspec
 - lib/clt-sdk.rb
+- lib/clt/core_ext/hash.rb
 - lib/clt/credit_card.rb
 - lib/clt/cvs.rb
 - lib/clt/error_message.rb
+- lib/clt/general_methods.rb
 - lib/clt/version.rb
 homepage: https://github.com/CalvertYang/clt-sdk
 licenses: