added rto (#251)

Author: ankitdas13

documents/order.md

@@ -275,6 +275,77 @@ Razorpay::Order.edit(orderId,para_attr)
 -------------------------------------------------------------------------------------------------------
 
 
+### View RTO/Risk Reasons
+
+```go
+orderId = "order_XXXXXXXXXXXXX1"
+
+Razorpay::Order.view_rto(orderId)
+```
+**Parameters**
+
+| Name     | Type   | Description                                                              |
+|----------|--------|-------------------------------------                                     |
+| orderId* | string | The unique identifier of an order to access the fulfillment information. |
+
+**Response:**
+```json
+{
+  "risk_tier": "high",
+  "rto_reasons": [
+    {
+      "reason": "short_shipping_address",
+      "description": "Short shipping address",
+      "bucket": "address"
+    },
+    {
+      "reason": "address_pincode_state_mismatch",
+      "description": "Incorrect pincode state entered",
+      "bucket": "address"
+    }
+  ]
+}
+```
+-------------------------------------------------------------------------------------------------------
+
+### Update the Fulfillment Details
+
+```rb
+order_id = "order_XXXXXXXXXXXXX1"
+
+para_attr = {
+  "payment_method": "upi",
+  "shipping": {
+    "waybill": "123456789",
+    "status": "rto",
+    "provider": "Bluedart"
+  }
+}
+
+Razorpay::Order.edit_fulfillment(order_id, para_attr)
+```
+**Parameters**
+
+| Name           | Type   | Description                                                                                                                                                                             |
+|----------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| orderId*       | string | The unique identifier of an order to access the fulfillment information.                                                                                                                |
+| payment_method | string | Payment Method opted by the customer to complete the payment. Possible values is `upi`, `card`, `wallet`, `netbanking`, `cod`, `emi`, `cardless_emi`, `paylater`, `recurring`, `other`. |
+| shipping       | object | Contains the shipping data. [here](https://razorpay.com/docs/payments/magic-checkout/rto-intelligence/#step-3-update-the-fulfillment-details) are supported                             |
+
+**Response:**
+```json
+{
+  "entity": "order.fulfillment",
+  "order_id": "EKwxwAgItXXXX",
+  "payment_method": "upi",
+  "shipping": {
+    "waybill": "123456789",
+    "status": "rto",
+    "provider": "Bluedart"
+  }
+}
+```
+-------------------------------------------------------------------------------------------------------
 **PN: * indicates mandatory fields**
 <br>
 <br>

lib/razorpay/order.rb

@@ -35,5 +35,13 @@ def self.fetch_transfer_order(id)
       # Docs: https://razorpay.com/docs/api/payments/route/#fetch-transfer-for-an-order
       request.get "#{id}/?expand[]=transfers&status"
     end
+
+    def self.view_rto(id)
+      request.post "#{id}/rto_review"
+    end
+    
+    def self.edit_fulfillment(id, options = {})
+      request.post "#{id}/fulfillment", options
+    end
   end
 end

test/fixtures/fake_fulfillment.json

@@ -0,0 +1,10 @@
+{
+   "entity": "order.fulfillment",
+   "order_id": "EKwxwAgItXXXX",
+   "payment_method": "upi",
+   "shipping": {
+     "waybill": "123456789",
+     "status": "rto",
+     "provider": "Bluedart"
+   }
+}

test/fixtures/fake_rto.json

@@ -0,0 +1,15 @@
+{
+    "risk_tier": "high",
+    "rto_reasons": [
+      {
+        "reason": "short_shipping_address",
+        "description": "Short shipping address",
+        "bucket": "address"
+      },
+      {
+        "reason": "address_pincode_state_mismatch",
+        "description": "Incorrect pincode state entered",
+        "bucket": "address"
+      }
+    ]
+  }

test/fixtures/order_error.json

@@ -0,0 +1,10 @@
+{
+    "error": {
+        "code": "BAD_REQUEST_ERROR",
+        "description": "The id provided does not exist",
+        "source": "business",
+        "step": "payment_initiation",
+        "reason": "input_validation_failed",
+        "metadata": {}
+    }
+}

test/razorpay/test_order.rb

@@ -66,6 +66,48 @@ def test_fetch_order_transfers
     assert_equal @order_id, order.id, 'order IDs do not match'
     refute_empty order.transfers["items"]
     assert_equal @transfer_id, order.transfers["items"][0]["id"]
-   end 
+   end
+
+   def test_view_rto
+    stub_post(%r{orders/#{@order_id}/rto_review$}, 'fake_rto', {})
+    order = Razorpay::Order.view_rto(@order_id)
+    assert !order.rto_reasons.empty?, 'orders should be more than one'
+   end
+
+   def test_view_rto_exception
+    stub_post(%r{orders/#{@order_id}/rto_review$}, 'order_error', {})
+    assert_raises(Razorpay::Error) do
+      order = Razorpay::Order.view_rto(@order_id)      
+       if order.error
+        raise Razorpay::Error.new, order.error['code']
+       end  
+     end
+   end
+
+   def test_fulfillment
+      param_attr = {
+        "payment_method": "upi",
+        "shipping": {
+          "waybill": "123456789",
+          "status": "rto",
+          "provider": "Bluedart"
+        }
+      }
+
+     stub_post(%r{orders/#{@order_id}/fulfillment$}, 'fake_fulfillment', param_attr.to_json)
+     order = Razorpay::Order.edit_fulfillment(@order_id, param_attr.to_json)
+     assert_equal "upi", order.payment_method, 'order payment method do not match'
+   end
+
+   def test_fulfillment_exception
+    para_attr = {}
+    stub_post(%r{orders/#{@order_id}/fulfillment$}, 'order_error', para_attr.to_json)
+    assert_raises(Razorpay::Error) do
+      order = Razorpay::Order.edit_fulfillment(@order_id, para_attr.to_json)
+       if order.error
+        raise Razorpay::Error.new, order.error['code']
+       end  
+     end
+   end
   end
 end