gmo 0.4.0 → 0.5.0

data/lib/gmo/errors.rb

@@ -14,14 +14,14 @@ module GMO
 
     private
 
-      def error_message(info)
-        ::GMO::Const::API_ERROR_MESSAGES[:en][info] || info
+      def error_message(info, locale)
+        ::GMO::Const::API_ERROR_MESSAGES[locale][info] || info
       end
   end
 
   module Payment
     class Error < ::GMO::GMOError
-      attr_accessor :error_info, :response_body
+      attr_accessor :error_info, :response_body, :locale, :error_messages
 
       def initialize(response_body = "", error_info = nil)
         if response_body &&  response_body.is_a?(String)
@@ -46,8 +46,9 @@ module GMO
     end
 
     class APIError < Error
-      def initialize(error_info = {})
+      def initialize(error_info = {}, locale = ::GMO::Const::DEFAULT_LOCALE)
         self.error_info = error_info
+        self.locale = locale
         self.response_body = "ErrCode=#{error_info["ErrCode"]}&ErrInfo=#{error_info["ErrInfo"]}"
         set_error_messages
         message = self.response_body
@@ -57,10 +58,9 @@ module GMO
       private
 
         def set_error_messages
-          error_messages = self.error_info['ErrInfo'].to_s.split(ERROR_INFO_SEPARATOR)
-                                                     .map { |e| error_message(e) || e }
-                                                     .join(ERROR_INFO_SEPARATOR)
-          self.response_body += "&ErrMessage=#{error_messages}"
+          self.error_messages = self.error_info['ErrInfo'].to_s.split(ERROR_INFO_SEPARATOR)
+                                                     .map { |e| error_message(e, locale) || e }
+          self.response_body += "&ErrMessage=#{self.error_messages.join(ERROR_INFO_SEPARATOR)}"
         end
     end
 

data/lib/gmo/remittance_api.rb

@@ -6,7 +6,8 @@
 # gmo = GMO::Payment::RemittanceAPI.new({
 #   shop_id:     "foo",
 #   shop_pass:   "bar",
-#   host:  "test-remittance.gmopg.jp"
+#   host:        "test-remittance.gmopg.jp",
+#   locale:      "ja"
 # })
 module GMO
   module Payment
@@ -17,11 +18,12 @@ module GMO
         @shop_id   = options[:shop_id]
         @shop_pass = options[:shop_pass]
         @host      = options[:host]
+        @locale    = options.fetch(:locale, GMO::Const::DEFAULT_LOCALE)
         unless @shop_id && @shop_pass && @host
           raise ArgumentError, "Initialize must receive a hash with :shop_id, :shop_pass and either :host! (received #{options.inspect})"
         end
       end
-      attr_reader :shop_id, :shop_pass, :host
+      attr_reader :shop_id, :shop_pass, :host, :locale
 
       #########
       # Method
@@ -318,7 +320,7 @@ module GMO
           args.merge!({ "Shop_ID" => @shop_id, "Shop_Pass" => @shop_pass })
           api(name, args, verb, options) do |response|
             if response.is_a?(Hash) && !response["ErrInfo"].nil?
-              raise APIError.new(response)
+              raise APIError.new(response, locale)
             end
           end
         end

data/lib/gmo/shop_and_site_api.rb

@@ -8,7 +8,8 @@
 #   site_pass:   "bar",
 #   shop_id:     "baz",
 #   shop_pass:   "bax",
-#   host:        "p01.mul-pay.jp"
+#   host:        "p01.mul-pay.jp",
+#   locale:      "ja"
 # })
 module GMO
   module Payment
@@ -20,11 +21,12 @@ module GMO
         @site_id   = options[:site_id]
         @site_pass = options[:site_pass]
         @host      = options[:host]
+        @locale    = options.fetch(:locale, GMO::Const::DEFAULT_LOCALE)
         unless @site_id && @site_pass && @shop_id && @shop_pass && @host
           raise ArgumentError, "Initialize must receive a hash with :site_id, :site_pass, :shop_id, :shop_pass and either :host! (received #{options.inspect})"
         end
       end
-      attr_reader :shop_id, :shop_pass, :site_id, :site_pass, :host
+      attr_reader :shop_id, :shop_pass, :site_id, :site_pass, :host, :locale
 
       # 2.17.2.1.決済後カード登録
       # 指定されたオーダーID の取引に使用したカードを登録します。
@@ -112,7 +114,7 @@ module GMO
           })
           api(name, args, verb, options) do |response|
             if response.is_a?(Hash) && !response["ErrInfo"].nil?
-              raise APIError.new(response)
+              raise APIError.new(response, locale)
             end
           end
         end

data/lib/gmo/shop_api.rb

@@ -6,7 +6,9 @@
 # gmo = GMO::Payment::ShopAPI.new({
 #   shop_id:     "foo",
 #   shop_pass:   "bar",
-#   host:  "mul-pay.com"
+#   host:        "mul-pay.com",
+#   locale:      "ja"
+
 # })
 # result = gmo.post_request("EntryTran.idPass", options)
 module GMO
@@ -18,11 +20,12 @@ module GMO
         @shop_id   = options[:shop_id]
         @shop_pass = options[:shop_pass]
         @host      = options[:host]
+        @locale    = options.fetch(:locale, GMO::Const::DEFAULT_LOCALE)
         unless @shop_id && @shop_pass && @host
           raise ArgumentError, "Initialize must receive a hash with :shop_id, :shop_pass and either :host! (received #{options.inspect})"
         end
       end
-      attr_reader :shop_id, :shop_pass, :host
+      attr_reader :shop_id, :shop_pass, :host, :locale
 
       ## 2.1.2.1.取引登録
       # これ以降の決済取引で必要となる取引 ID と取引パスワードの発行を行い、取引を開始します。
@@ -422,6 +425,16 @@ module GMO
         post_request name, options
       end
 
+      # 【コンビニ払い】
+      ## 2.2.2.1. 支払停止
+      # コンビニ決済センターとの通信を行い取引の支払停止処理を行います。
+      def cvs_cancel(options = {})
+        name = "CvsCancel.idPass"
+        required = [:access_id, :access_pass, :order_id]
+        assert_required_options(required, options)
+        post_request name, options
+      end
+
       ## 2.16.2.1.取引状態参照
       # 指定したオーダーID の取引情報を取得します。
       def search_trade(options = {})
@@ -478,7 +491,7 @@ module GMO
           args.merge!({ "ShopID" => @shop_id, "ShopPass" => @shop_pass })
           api(name, args, verb, options) do |response|
             if response.is_a?(Hash) && !response["ErrInfo"].nil?
-              raise APIError.new(response)
+              raise APIError.new(response, locale)
             end
           end
         end

data/lib/gmo/site_api.rb

@@ -6,7 +6,9 @@
 # gmo = GMO::Payment::SiteAPI.new({
 #   site_id:     "foo",
 #   site_pass:   "bar",
-#   host:  "mul-pay.com"
+#   host:        "mul-pay.com",
+#   locale:      "ja"
+
 # })
 # result = gmo.post_request("EntryTran.idPass", options)
 module GMO
@@ -18,11 +20,12 @@ module GMO
         @site_id   = options[:site_id]
         @site_pass = options[:site_pass]
         @host      = options[:host]
+        @locale    = options.fetch(:locale, GMO::Const::DEFAULT_LOCALE)
         unless @site_id && @site_pass && @host
           raise ArgumentError, "Initialize must receive a hash with :site_id, :site_pass and either :host! (received #{options.inspect})"
         end
       end
-      attr_reader :site_id, :site_pass, :host
+      attr_reader :site_id, :site_pass, :host, :locale
 
       ## 2.3.2.1.会員登録
       # 指定されたサイトに会員を登録します。
@@ -173,7 +176,7 @@ module GMO
           args.merge!({ "SiteID" => @site_id, "SitePass" => @site_pass })
           api(name, args, verb, options) do |response|
             if response.is_a?(Hash) && !response["ErrInfo"].nil?
-              raise APIError.new(response)
+              raise APIError.new(response, locale)
             end
           end
         end

data/lib/gmo/version.rb

@@ -1,3 +1,3 @@
 module GMO
-  VERSION = "0.4.0"
-end
+  VERSION = "0.5.0"
+end

data/spec/gmo/remittance_api_spec.rb

@@ -8,7 +8,9 @@ describe "GMO::Payment::RemittanceAPI" do
     @service ||= GMO::Payment::RemittanceAPI.new({
       :shop_id   => SPEC_CONF["remittance"]["shop_id"],
       :shop_pass => SPEC_CONF["remittance"]["shop_pass"],
-      :host      => SPEC_CONF["remittance"]["host"]
+      :host      => SPEC_CONF["remittance"]["host"],
+      :locale    => :ja
+
     })
   end
 

data/spec/gmo/shop_and_site_api_spec.rb

@@ -8,17 +8,23 @@ describe "GMO::Payment::ShopAndSiteAPI" do
       :shop_pass => SPEC_CONF["shop_pass"],
       :site_id   => SPEC_CONF["site_id"],
       :site_pass => SPEC_CONF["site_pass"],
-      :host      => SPEC_CONF["host"]
+      :host      => SPEC_CONF["host"],
+      :locale    => :ja
+
     })
     @shop_api ||= GMO::Payment::ShopAPI.new({
       :shop_id   => SPEC_CONF["shop_id"],
       :shop_pass => SPEC_CONF["shop_pass"],
-      :host      => SPEC_CONF["host"]
+      :host      => SPEC_CONF["host"],
+      :locale    => :ja
+
     })
     @site_api ||= GMO::Payment::SiteAPI.new({
       :site_id   => SPEC_CONF["site_id"],
       :site_pass => SPEC_CONF["site_pass"],
-      :host      => SPEC_CONF["host"]
+      :host      => SPEC_CONF["host"],
+      :locale    => :ja
+
     })
   end
 

data/spec/gmo/shop_api_spec.rb

@@ -14,12 +14,14 @@ describe "GMO::Payment::ShopAPI" do
       :site_pass => SPEC_CONF["site_pass"],
       :shop_id   => SPEC_CONF["shop_id"],
       :shop_pass => SPEC_CONF["shop_pass"],
-      :host      => SPEC_CONF["host"]
+      :host      => SPEC_CONF["host"],
+      :locale    => :ja
     })
     @service ||= GMO::Payment::ShopAPI.new({
       :shop_id   => SPEC_CONF["shop_id"],
       :shop_pass => SPEC_CONF["shop_pass"],
-      :host      => SPEC_CONF["host"]
+      :host      => SPEC_CONF["host"],
+      :locale    => :ja
     })
   end
 
@@ -692,6 +694,32 @@ describe "GMO::Payment::ShopAPI" do
     end
   end
 
+  describe "#cvs_cancel" do
+    it "gets data about a transaction", :vcr do
+      order_id = generate_id
+      result = @service.entry_tran_cvs({
+        :order_id => order_id,
+        :amount => 100
+      })
+      access_id = result["AccessID"]
+      access_pass = result["AccessPass"]
+      result = @service.cvs_cancel({
+        :order_id => order_id,
+        :access_id => access_id,
+        :access_pass => access_pass,
+      })
+
+      result["OrderID"].nil?.should_not be_truthy
+      result["Status"].nil?.should_not be_truthy
+    end
+
+    it "got error if missing options", :vcr do
+      lambda {
+        result = @service.cvs_cancel()
+      }.should raise_error("Required access_id, access_pass, order_id were not provided.")
+    end
+  end
+
   describe "#search_trade" do
     it "gets data about order", :vcr do
       order_id = @order_id

data/spec/gmo/site_api_spec.rb

@@ -12,12 +12,16 @@ describe "GMO::Payment::SiteAPI" do
       :site_pass => SPEC_CONF["site_pass"],
       :shop_id   => SPEC_CONF["shop_id"],
       :shop_pass => SPEC_CONF["shop_pass"],
-      :host      => SPEC_CONF["host"]
+      :host      => SPEC_CONF["host"],
+      :locale    => :ja
+
     })
     @service ||= GMO::Payment::SiteAPI.new({
       :site_id   => SPEC_CONF["site_id"],
       :site_pass => SPEC_CONF["site_pass"],
-      :host      => SPEC_CONF["host"]
+      :host      => SPEC_CONF["host"],
+      :locale    => :ja
+
     })
   end
 
@@ -283,4 +287,4 @@ describe "GMO::Payment::SiteAPI" do
       }.should raise_error('Required member_id, seq_mode, token_seq were not provided.')
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gmo
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tatsuo Kaniwa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2020-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -128,6 +128,7 @@ files:
 - fixtures/vcr_cassettes/GMO_Payment_ShopAPI/_change_tran_brandtoken_gets_data_about_order.yml
 - fixtures/vcr_cassettes/GMO_Payment_ShopAPI/_change_tran_gets_data_about_order.yml
 - fixtures/vcr_cassettes/GMO_Payment_ShopAPI/_change_tran_got_error_if_missing_options.yml
+- fixtures/vcr_cassettes/GMO_Payment_ShopAPI/_cvs_cancel_gets_data_about_a_transaction.yml
 - fixtures/vcr_cassettes/GMO_Payment_ShopAPI/_entry_tran_brandtoken_gets_data_about_a_transaction.yml
 - fixtures/vcr_cassettes/GMO_Payment_ShopAPI/_entry_tran_cvs_gets_data_about_a_transaction.yml
 - fixtures/vcr_cassettes/GMO_Payment_ShopAPI/_entry_tran_cvs_got_error_if_missing_options.yml
@@ -216,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: 'GMO Payment API client: Ruby client library for the GMO Payment Platform.'