veritrans 2.2.0 → 2.3.0

data/api_reference.md

@@ -21,6 +21,12 @@ please use our [documentation](https://api-docs.midtrans.com/)
       <td>POST</td>
       <td>api.midtrans.com/v2/charge</td>
     </tr>
+    <tr>
+      <td><a href="#token">Veritrans.test_token(data)</a></td>
+      <td>Get Token for Card</td>
+      <td>GET</td>
+      <td>api.midtrans.com/v2/token</td>
+    </tr>
     <tr>
       <td><a href="#status">Veritrans.status(id)</a></td>
       <td>Get Last Status</td>
@@ -39,6 +45,12 @@ please use our [documentation](https://api-docs.midtrans.com/)
       <td>POST</td>
       <td>api.midtrans.com/v2/{id}/approve</td>
     </tr>
+    <tr>
+      <td><a href="#refund">Veritrans.refund(id)</a></td>
+      <td>Refund Successful Transaction</td>
+      <td>POST</td>
+      <td>api.midtrans.com/v2/{id}/refund</td>
+    </tr>
     <tr>
       <td><a href="#capture">Veritrans.capture(id)</a></td>
       <td>Capture Authorise Transaction</td>
@@ -51,6 +63,12 @@ please use our [documentation](https://api-docs.midtrans.com/)
       <td>POST</td>
       <td>api.midtrans.com/v2/{id}/expire</td>
     </tr>
+    <tr>
+      <td><a href="#deny">Veritrans.deny(id)</a></td>
+      <td>Deny Challenged Transaction</td>
+      <td>POST</td>
+      <td>api.midtrans.com/v2/{id}/deny</td>
+    </tr>
   </tbody>
 </table>
 
@@ -141,6 +159,24 @@ q.data == {
 q.success? # => true
 ```
 
+<a name="token"></a>
+### Test Token
+
+Get a token from card information for testing. **Not to be used outside of tests**
+
+```ruby
+card =
+  {
+    card_number: 4_811_111_111_111_114,
+    card_cvv: 123,
+    card_exp_month: 0o1,
+    card_exp_year: 2020
+  }
+
+q = Veritrans.test_token(card)
+
+q == '481111-1114-a901971f-2f1b-4781-802a-df326fbf0e9c'
+```
 
 <a name="status"></a>
 ### Status
@@ -219,6 +255,30 @@ q.data == {
 }
 ```
 
+<a name="refund"></a>
+### Refund
+
+To be used to refund. Can only be used on transactions that are marked as `successful` which happens automatically after
+one day after charge request. Defaults to full refund if not specified.
+
+```ruby
+q = Veritrans.refund('testing-0.2072-1415086078')
+
+q == {
+   status_code: "200",
+   status_message: "Success, refund request is approved",
+   transaction_id: "447e846a-403e-47db-a5da-d7f3f06375d6",
+   order_id: "testing-0.2072-1415086078",
+   payment_type: "credit_card",
+   transaction_time: "2015-06-15 13:36:24",
+   transaction_status: "refund",
+   gross_amount: "10000.00",
+   refund_chargeback_id: 1,
+   refund_amount: "10000.00",
+   refund_key: "reference1"
+}
+```
+
 <a name="capture"></a>
 ### Capture
 
@@ -232,15 +292,37 @@ q.success? # => true
 <a name="expire"></a>
 ### Expire
 
-You can expire pedning transactions. For examople if merchant choose to pay via ATM,
-then user change mind and want to pay with credit card.
-In this situation you better expire previous transaction, and you can use same order_id again
+To expire pending transactions. For example if a merchant chooses to pay via ATM and
+then the user changes their mind and now wants to pay with credit card.
+In this situation the previous transaction should be expired. The same order_id can be used again.
 
 ```ruby
 q = Veritrans.expire("testing-0.2072-1415086078")
 q.success? # => true
 ```
 
+<a name="deny"></a>
+### Deny
+Used to deny a card payment transaction in which `fraud_status` is `challenge`
+
+```ruby
+q = Veritrans.deny("testing-0.2072-1415086078")
+
+q == { 
+  status_code: "200",
+  status_message: "Success, transaction is denied",
+  transaction_id: "ca297170-be4c-45ed-9dc9-be5ba99d30ee",
+  masked_card: "451111-1117",
+  order_id: "testing-0.2072-1415086078",
+  payment_type: "credit_card",
+  transaction_time: "2014-10-31 14:46:44",
+  transaction_status: "deny",
+  fraud_status: "deny",
+  bank: "bni",
+  gross_amount: "30000.00"
+}
+```
+
 
 
 ### `Veritrans::Result`

data/lib/generators/templates/payments_controller.rb

@@ -60,7 +60,7 @@ class PaymentsController < ApplicationController # :nodoc:
         verified_data.body + "\n"
       )
 
-      render plain: "ok", :status => :not_found
+      render plain: "error", :status => :not_found
     end
 
   end

data/lib/generators/templates/views/_credit_card_form.erb

@@ -26,7 +26,7 @@
 
   <p>
     <%= label_tag :credit_card_expire %>
-    <%= text_field_tag :credit_card_expire, '12 / 18', placeholder: "MM / YY", name: nil %>
+    <%= text_field_tag :credit_card_expire, '12 / 20', placeholder: "MM / YY", name: nil %>
   </p>
 
   <p>

data/lib/veritrans.rb

@@ -22,8 +22,8 @@ class Veritrans
 
     def_delegators :instance, :logger, :logger=, :config, :setup, :file_logger, :file_logger=
     def_delegators :instance, :request_with_logging, :basic_auth_header, :get, :post, :delete, :make_request
-    def_delegators :instance, :charge, :cancel, :approve, :status, :capture, :expire
-    def_delegators :instance, :create_vtlink, :delete_vtlink, :inquiry_points, :create_widget_token, :create_snap_token
+    def_delegators :instance, :charge, :cancel, :approve, :status, :capture, :expire, :refund, :test_token, :deny
+    def_delegators :instance, :create_vtlink, :delete_vtlink, :inquiry_points, :create_widget_token, :create_snap_redirect_url, :create_snap_token
     def_delegators :instance, :checksum, :events
 
     # Shortcut for Veritrans::Events
@@ -182,10 +182,19 @@ class Veritrans
   # For rails apps it will write log to RAILS_ROOT/log/veritrans.log
   def file_logger
     if !@file_logger
-      if defined?(Rails) && Rails.root
-        @file_logger = Logger.new(Rails.root.join("log/veritrans.log").to_s)
-      else
-        require 'logger'
+      require 'logger'
+      begin
+        if defined?(Rails) && Rails.root
+          require 'fileutils'
+          FileUtils.mkdir_p(Rails.root.join("log"))
+          @file_logger = Logger.new(Rails.root.join("log/veritrans.log").to_s)
+        else
+          @file_logger = Logger.new("/dev/null")
+        end
+      rescue => error
+        STDERR.puts "Failed to create Midtrans.file_logger, will use /dev/null"
+        STDERR.puts "#{error.class}: #{error.message}"
+        STDERR.puts error.backtrace
         @file_logger = Logger.new("/dev/null")
       end
     end

data/lib/veritrans/api.rb

@@ -28,7 +28,7 @@ class Veritrans
       data[:payment_type] = payment_type if payment_type
 
       if data.has_key?(:payment_options)
-        data[ payment_type.to_sym ] = data.delete(:payment_options)
+        data[payment_type.to_sym] = data.delete(:payment_options)
       end
 
       # Rename keys:
@@ -37,21 +37,27 @@ class Veritrans
       # items       -> item_details
       # customer    -> customer_details
 
-      data[:transaction_details]  = data.delete(:payment)     if data[:payment]
-      data[:transaction_details]  = data.delete(:transaction) if data[:transaction]
-      data[:item_details]         = data.delete(:items)       if data[:items]
-      data[:customer_details]     = data.delete(:customer)    if data[:customer]
+      data[:transaction_details] = data.delete(:payment) if data[:payment]
+      data[:transaction_details] = data.delete(:transaction) if data[:transaction]
+      data[:item_details] = data.delete(:items) if data[:items]
+      data[:customer_details] = data.delete(:customer) if data[:customer]
 
       request_with_logging(:post, config.api_host + "/v2/charge", data)
     end
 
-    # POST https://app.sandbox.veritrans.co.id/snap/v1/transactions
+    def test_token(options = {})
+      options[:client_key] = config.client_key
+      request_with_logging(:get, config.api_host + '/v2/token', options).token_id
+    end
+
+    # POST https://app.sandbox.midtrans.com/snap/v1/transactions
     def create_snap_token(options = {})
       result = request_with_logging(:post, config.api_host.sub('//api.', '//app.') + "/snap/v1/transactions", options)
       Veritrans::SnapResult.new(result.response, result.url, result.request_options, result.time)
     end
 
     alias_method :create_widget_token, :create_snap_token
+    alias_method :create_snap_redirect_url, :create_snap_token
 
     # POST /v2/{id}/cancel
     # Docs https://api-docs.midtrans.com/#cancel-transaction
@@ -73,6 +79,16 @@ class Veritrans
       request_with_logging(:post, config.api_host + "/v2/#{URI.escape(payment_id)}/approve", options)
     end
 
+    # POST /v2/{id}/refund
+    # Docs https://api-docs.midtrans.com/#refund-transaction
+    def refund(payment_id, options = {})
+      if !payment_id || payment_id.to_s == ''
+        raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
+      end
+
+      request_with_logging(:post, config.api_host + "/v2/#{ERB::Util.url_encode(payment_id)}/refund", options)
+    end
+
     # GET /v2/{id}/status
     # Docs https://api-docs.midtrans.com/#get-status-transaction
     def status(payment_id)
@@ -93,6 +109,16 @@ class Veritrans
       post(config.api_host + "/v2/capture", options.merge(transaction_id: payment_id, gross_amount: gross_amount))
     end
 
+    # POST /v2/{id}/deny
+    # Docs https://api-docs.midtrans.com/#deny-transaction
+    def deny(payment_id, options = {})
+      if !payment_id || payment_id.to_s == ''
+        raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
+      end
+
+      request_with_logging(:post, config.api_host + "/v2/#{ERB::Util.url_encode(payment_id)}/deny", options)
+    end
+
     # POST /v2/{id}/expire
     # Docs https://api-docs.midtrans.com/#expire-transaction
     def expire(payment_id)
@@ -123,6 +149,7 @@ class Veritrans
 
       request_with_logging(:get, config.api_host + "/v2/point_inquiry/#{token_id}", {})
     end
+
     alias_method :point_inquiry, :inquiry_points
 
   end

data/lib/veritrans/client.rb

@@ -75,7 +75,7 @@ class Veritrans
 
       method = method.to_s.upcase
       logger.info "Veritrans: #{method} #{url} #{_json_encode(params)}"
-      logger.info "Veritrans: Using server key: #{config.server_key}"
+      #logger.info "Veritrans: Using server key: #{config.server_key}"
       #puts "Veritrans: #{method} #{url} #{_json_encode(params)}"
 
       default_options = config.http_options || {}

data/lib/veritrans/result.rb

@@ -151,6 +151,11 @@ class Veritrans
       @data[:token]
     end
 
+    # Acccessor for <tt>redirect_url</tt> value
+    def redirect_url
+      @data[:redirect_url]
+    end
+
     def success?
       status_code == 201
     end

data/lib/veritrans/testing.rb

@@ -8,7 +8,7 @@ require 'uri'
 #
 class Veritrans::TestingLib
 
-  def initialize(server_url = "https://api.sandbox.midtrans.com:7676")
+  def initialize(server_url = "https://simulator.sandbox.midtrans.com")
     @server_url = server_url
   end
 

data/lib/veritrans/version.rb

@@ -1,3 +1,3 @@
 class Veritrans
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

data/spec/fixtures/cancel_failed.yml

@@ -8,7 +8,7 @@ http_interactions:
       string: "{}"
     headers:
       User-Agent:
-      - Veritrans ruby gem 2.0.0beta
+      - Veritrans ruby gem 2.3.0
       Authorization:
       - Basic VlQtc2VydmVyLTlIdGItUnhYa2c3LTdoem5TQ0NqeHZvWTo=
       Accept:
@@ -18,31 +18,31 @@ http_interactions:
   response:
     status:
       code: 200
-      message: ''
+      message: OK
     headers:
-      Server:
-      - nginx/1.5.13
       Date:
-      - Tue, 04 Nov 2014 14:18:37 GMT
+      - Wed, 03 Apr 2019 18:44:32 GMT
       Content-Type:
       - application/json
       Content-Length:
-      - '87'
+      - '111'
       Connection:
       - keep-alive
-      Cache-Control:
-      - no-cache
       Pragma:
       - no-cache
-      Expires:
-      - Wed, 31 Dec 1969 17:00:00 GMT
+      Cache-Control:
+      - no-cache
+      X-Kong-Upstream-Latency:
+      - '19'
+      X-Kong-Proxy-Latency:
+      - '94'
+      Via:
+      - kong/0.14.0
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains;
     body:
-      encoding: UTF-8
-      string: |-
-        {
-          "status_code" : "404",
-          "status_message" : "The requested resource is not found"
-        }
+      encoding: ASCII-8BIT
+      string: '{"status_code":"404","status_message":"Transaction doesn''t exist.","id":"37bb81e3-341f-4730-aaa6-8e985343fbb3"}'
     http_version: 
-  recorded_at: Tue, 04 Nov 2014 14:17:06 GMT
-recorded_with: VCR 2.9.3
+  recorded_at: Wed, 03 Apr 2019 18:44:32 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/cancel_success.yml

@@ -5,10 +5,10 @@ http_interactions:
     uri: https://api.sandbox.midtrans.com/v2/charge
     body:
       encoding: UTF-8
-      string: '{"payment_type":"permata","transaction_details":{"order_id":1415110696,"gross_amount":100000}}'
+      string: '{"payment_type":"permata","transaction_details":{"order_id":1554317097,"gross_amount":100000}}'
     headers:
       User-Agent:
-      - Veritrans ruby gem 2.0.0beta
+      - Veritrans ruby gem 2.3.0
       Authorization:
       - Basic VlQtc2VydmVyLTlIdGItUnhYa2c3LTdoem5TQ0NqeHZvWTo=
       Accept:
@@ -18,49 +18,59 @@ http_interactions:
   response:
     status:
       code: 200
-      message: ''
+      message: OK
     headers:
-      Server:
-      - nginx/1.5.13
       Date:
-      - Tue, 04 Nov 2014 14:19:48 GMT
+      - Wed, 03 Apr 2019 18:44:57 GMT
       Content-Type:
       - application/json
       Content-Length:
-      - '381'
+      - '432'
       Connection:
       - keep-alive
+      Vary:
+      - Accept-Encoding
       Cache-Control:
       - no-cache
       Pragma:
       - no-cache
       Expires:
       - Wed, 31 Dec 1969 17:00:00 GMT
+      X-Kong-Upstream-Latency:
+      - '200'
+      X-Kong-Proxy-Latency:
+      - '0'
+      Via:
+      - kong/0.14.0
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains;
     body:
-      encoding: UTF-8
+      encoding: ASCII-8BIT
       string: |-
         {
           "status_code" : "201",
           "status_message" : "Success, PERMATA VA transaction is successful",
-          "transaction_id" : "d8757b8a-b97e-4881-9f55-69f6db6f4006",
-          "order_id" : "1415110696",
+          "transaction_id" : "f162dd28-c6a2-4357-a2ff-b942ba33d01e",
+          "order_id" : "1554317097",
+          "gross_amount" : "100000.00",
+          "currency" : "IDR",
           "payment_type" : "bank_transfer",
-          "transaction_time" : "2014-11-04 21:20:07",
+          "transaction_time" : "2019-04-04 01:44:57",
           "transaction_status" : "pending",
-          "permata_va_number" : "8778990000000023",
-          "gross_amount" : "100000.00"
+          "fraud_status" : "accept",
+          "permata_va_number" : "8778008906093609"
         }
     http_version: 
-  recorded_at: Tue, 04 Nov 2014 14:18:17 GMT
+  recorded_at: Wed, 03 Apr 2019 18:44:57 GMT
 - request:
     method: post
-    uri: https://api.sandbox.midtrans.com/v2/1415110696/cancel
+    uri: https://api.sandbox.midtrans.com/v2/1554317097/cancel
     body:
       encoding: UTF-8
       string: "{}"
     headers:
       User-Agent:
-      - Veritrans ruby gem 2.0.0beta
+      - Veritrans ruby gem 2.3.0
       Authorization:
       - Basic VlQtc2VydmVyLTlIdGItUnhYa2c3LTdoem5TQ0NqeHZvWTo=
       Accept:
@@ -70,37 +80,47 @@ http_interactions:
   response:
     status:
       code: 200
-      message: ''
+      message: OK
     headers:
-      Server:
-      - nginx/1.5.13
       Date:
-      - Tue, 04 Nov 2014 14:19:48 GMT
+      - Wed, 03 Apr 2019 18:44:58 GMT
       Content-Type:
       - application/json
       Content-Length:
-      - '323'
+      - '374'
       Connection:
       - keep-alive
+      Vary:
+      - Accept-Encoding
       Cache-Control:
       - no-cache
       Pragma:
       - no-cache
       Expires:
       - Wed, 31 Dec 1969 17:00:00 GMT
+      X-Kong-Upstream-Latency:
+      - '56'
+      X-Kong-Proxy-Latency:
+      - '87'
+      Via:
+      - kong/0.14.0
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains;
     body:
-      encoding: UTF-8
+      encoding: ASCII-8BIT
       string: |-
         {
           "status_code" : "200",
           "status_message" : "Success, transaction is canceled",
-          "transaction_id" : "d8757b8a-b97e-4881-9f55-69f6db6f4006",
-          "order_id" : "1415110696",
+          "transaction_id" : "f162dd28-c6a2-4357-a2ff-b942ba33d01e",
+          "order_id" : "1554317097",
+          "gross_amount" : "100000.00",
+          "currency" : "IDR",
           "payment_type" : "bank_transfer",
-          "transaction_time" : "2014-11-04 21:20:07",
+          "transaction_time" : "2019-04-04 01:44:57",
           "transaction_status" : "cancel",
-          "gross_amount" : "100000.00"
+          "fraud_status" : "accept"
         }
     http_version: 
-  recorded_at: Tue, 04 Nov 2014 14:18:17 GMT
-recorded_with: VCR 2.9.3
+  recorded_at: Wed, 03 Apr 2019 18:44:58 GMT
+recorded_with: VCR 4.0.0