remitano 1.5.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd1f544b9323fc82089e1541a286b96bcef386d81b13fd004b998a4033b0d07a
-  data.tar.gz: 568bfa758b7c634b3d198b50c4b1e4d50de585175ef04748691f41c547221ed2
+  metadata.gz: 24e8c36290375607bbe4756eb87a067b83aad43d65cb2a17fc9c609f786c28b1
+  data.tar.gz: 907e3d596439e7cdbc9a6532465f8cb3f0150a6aa83a12b6704e6707907d43cf
 SHA512:
-  metadata.gz: 6c5fcb59a0e5d9cae326351b197ab896c340d49f761e1e6e41ecb237ea22cb416b64d99735b02ca0fe89f5977761ae8029d4f9d3616c7ca064755f740e3bbdaf
-  data.tar.gz: a09249bd663fc9ea826c60f09672ab897fa8b79b04401f411f2ff6ab6169db05001ea940757891ead3586b281b14d557501b519407db7c26f4c6d5281073d368
+  metadata.gz: 200294dd5c029dd351a74cfaf5e008ac1eca68c2d50022a400c725dead107d7d3d4cd9322a6fabb73bf4ee2396d698aca0c9309128a93c6912a54b157faa5470
+  data.tar.gz: 229c0dcd269e2826a097ded83a8d3cb96979b46d758716ada0c705be4a38b8dfc576e369cb8f6f040ed16f99e3feccdde84724603374a7e47ddeb4323d314330

data/.gitignore

@@ -1,2 +1,4 @@
 .env
 tags
+
+.byebug_history

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    remitano (1.5.1)
+    remitano (1.7.0)
       activesupport (>= 4.2.10)
       api-auth (~> 2.1.0)
       hashie
@@ -12,94 +12,136 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (5.2.5)
+    activesupport (5.2.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     api-auth (2.1.0)
-    ast (2.4.0)
-    byebug (3.5.1)
-      columnize (~> 0.8)
-      debugger-linecache (~> 1.2)
-      slop (~> 3.6)
-    columnize (0.9.0)
-    concurrent-ruby (1.1.8)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    debugger-linecache (1.2.0)
-    diff-lcs (1.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.4.4)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    dotenv (2.0.0)
-    git (1.2.5)
-    hashdiff (0.3.7)
-    hashie (4.1.0)
+    dotenv (2.0.2)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    git (1.8.1)
+      rchardet (~> 1.8)
+    github_api (0.19.0)
+      addressable (~> 2.4)
+      descendants_tracker (~> 0.0.4)
+      faraday (>= 0.8, < 2)
+      hashie (~> 3.5, >= 3.5.2)
+      oauth2 (~> 1.0)
+    hashdiff (1.0.1)
+    hashie (3.6.0)
+    highline (2.0.3)
+    http-accept (1.7.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.1)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
       git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
       rake
       rdoc
     json (1.8.6)
-    mime-types (3.2.2)
+    jwt (2.2.3)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2018.0812)
+    mime-types-data (3.2021.0225)
+    mini_portile2 (2.4.0)
     minitest (5.14.4)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
     netrc (0.11.0)
-    parallel (1.12.1)
-    parser (2.5.3.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    public_suffix (3.0.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    oauth2 (1.4.7)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rack (2.2.3)
     rainbow (3.0.0)
-    rake (10.0.4)
+    rake (13.0.3)
+    rchardet (1.8.0)
     rdoc (3.12.2)
       json (~> 1.4)
-    rest-client (2.0.2)
+    regexp_parser (2.1.1)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
+    rexml (3.2.5)
     rotp (6.2.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.60.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.12.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
     ruby-hmac (0.4.0)
-    ruby-progressbar (1.10.0)
-    safe_yaml (1.0.4)
-    slop (3.6.0)
-    thor (0.20.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    thor (1.1.0)
     thread_safe (0.3.6)
     tzinfo (1.2.9)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
-    unicode-display_width (1.4.0)
+    unicode-display_width (2.0.0)
     vcr (4.0.0)
     webmock (3.3.0)
       addressable (>= 2.3.6)
@@ -107,13 +149,13 @@ GEM
       hashdiff
 
 PLATFORMS
-  ruby
+  x86_64-darwin-18
 
 DEPENDENCIES
   bundler
   byebug
   dotenv (~> 2.0.0)
-  jeweler (~> 1.8.4)
+  jeweler (~> 2.0.0)
   rdoc (~> 3.12)
   remitano!
   rspec
@@ -124,4 +166,4 @@ DEPENDENCIES
   webmock (~> 3.3.0)
 
 BUNDLED WITH
-   1.17.3
+   2.2.19

data/README.md

@@ -37,7 +37,7 @@ Remitano::Client.default # => the default client
 ```
 or
 ```ruby
-client = new Remitano::Client(
+client = Remitano::Client.new(
   key: YOUR_API_KEY,
   secret: YOUR_API_SECRET,
   authenticator_secret: YOUR_AUTHENTICATOR_SECRET,
@@ -47,26 +47,47 @@ client = new Remitano::Client(
 ### Payment gateway
 Visit https://developers.remitano.com/api-explorer - Merchant section for more information.
 #### Charges
-##### Get
+##### Get charge with remitano id
 ```ruby
 client.merchant_charges.get(id)
 ```
-##### Create
+##### Create charge
+1. With coin currency
+Note: For now, we only support `usdt` as the price coin currency.
 ```ruby
 client.merchant_charges.create(
   coin_currency: "usdt",
   coin_amount: 10.99,
-  cancelled_or_completed_callback_url: "https://example.com/payments/callback?id=example"
+  cancelled_or_completed_callback_url: "https://example.com/payments/callback?id=example", # optional
+  description: "Example charge" # optional
+)
+```
+2. With fiat currency
+Note: We support fiat currency of 56 countries that Remitano are supporting, i.e., `USD`, `AUD`. (You could find entire list in our [developer docs](https://developers.remitano.com/docs/getting-started/getting-started)).
+```ruby
+client.merchant_charges.create(
+  fiat_currency: "AUD",
+  fiat_amount: 10.99,
+  cancelled_or_completed_callback_url: "https://example.com/payments/callback?id=example", # optional
+  description: "Example charge" # optional
+)
+```
+
+##### Get paginated charge list
+```ruby
+client.merchant_charges.list(
+  status: "completed", # optional
+  page: 2, # optional
+  per_page: 25 # optional
 )
 ```
-Note: For now, we only support `usdt` as the price coin currency.
 
 #### Withdrawals
-##### Get
+##### Get withdrawal with remitano id
 ```ruby
 client.merchant_withdrawals.get(id)
 ```
-##### Create
+##### Create withdrawal
 1. Withdraw to external coin address
 ```ruby
 client.merchant_withdrawals.create(
@@ -74,9 +95,9 @@ client.merchant_withdrawals.create(
   coin_currency: "xrp",
   coin_amount: 10.99,
   receiver_pay_fee: true, # defines who will be charged for the withdrawal fee
-  cancelled_or_completed_callback_url: "http://sample.com/123/callback",
+  cancelled_or_completed_callback_url: "http://sample.com/123/callback", # optional
   coin_address: "rLpumSZQNJ6Cve7hfQcdkG9rJbJhkSV8AD0",
-  destination_tag: 1710676231 # include destination_tag if coin_currency is xrp, otherwise, leave it nil
+  destination_tag: 1710676231 # optional, required when coin_currency is xrp
 )
 ```
 2. Withdraw to other remitano account
@@ -91,20 +112,39 @@ client.merchant_withdrawals.create(
   remitano_phone_number: "+234 1 123 4567"
 )
 ```
-
-#### Callbacks
-When Charge or Withdrawal is changed to completed or cancelled in our system, we will send
-a POST callback request to `object.cancelled_or_completed_callback_url` with following
-request json body:
+##### Get paginated withdrawal list
 ```ruby
-{ "id" => object.id }
+client.merchant_withdrawals.list(
+  status: "completed", # optional
+  page: 2, # optional
+  per_page: 25 # optional
+)
 ```
-then you could call `client.merchant_charges.get(id)` or `client.merchant_withdrawals.get(id)`
-to get the updated information and process accordingly.
+
+#### Callbacks
+##### Charges
+Whenever a charge is changed to completed or cancelled in our system:
+- we will send a POST request to `charge.cancelled_or_completed_callback_url` with `remitano_id` param.
+- if user is still on our site, we will also redirect user to `object.cancelled_or_completed_callback_url` with `remitano_id` param (GET request).
+
+After receiving these callbacks, you could call `client.merchant_charges.get(params[:remitano_id])` to get the updated information and process accordingly.
+
+##### Withdrawals
+Whenever a withdrawal is changed to completed or cancelled in our system:
+- we will send a POST request to `withdrawal.cancelled_or_completed_callback_url` with `remitano_id` param.
+
+After receiving these callbacks, you could call `client.merchant_withdrawals.get(params[:remitano_id])` to get the updated information and process accordingly.
 
 ### Errors
 When receiving non 200-299 http code, a Remitano::Client::Request::RequestError will be raised.
 
+### Sandbox testing
+We have a Testnet at https://remidemo.com.
+
+You could register an account there, then submit a request at [this google form](https://forms.gle/jvJyWPBNwTWfowSm9) with your Remidemo username, so we could help to setup your testing account as a merchant.
+
+After that, you could start your sandbox testing by setting `ENV["REMITANO_SANDBOX"]` to `"true"`.
+
 ## Contributing
 
 1. Fork it

data/lib/remitano/client/merchant_charges.rb

@@ -12,12 +12,36 @@ module Remitano
       config.net.get("/merchant/merchant_charges/#{id}").execute
     end
 
-    def create(coin_currency:, coin_amount:, cancelled_or_completed_callback_url:)
-      config.net.post(
-        "/merchant/merchant_charges",
+    def create(
+      coin_currency: nil, coin_amount: nil,
+      fiat_currency: nil, fiat_amount: nil,
+      cancelled_or_completed_callback_url: nil, description: nil
+    )
+      params = {
         coin_currency: coin_currency,
         coin_amount: coin_amount,
-        cancelled_or_completed_callback_url: cancelled_or_completed_callback_url
+        fiat_currency: fiat_currency,
+        fiat_amount: fiat_amount,
+        cancelled_or_completed_callback_url: cancelled_or_completed_callback_url,
+        description: description
+      }
+      params.reject! { |_k, v| v.nil? }
+      config.net.post(
+        "/merchant/merchant_charges",
+        params
+      ).execute
+    end
+
+    def list(status: nil, page: nil, per_page: nil)
+      params = {
+        status: status,
+        page: page,
+        per_page: per_page
+      }
+      params.reject! { |_k, v| v.nil? }
+      config.net.get(
+        "/merchant/merchant_charges",
+        params
       ).execute
     end
   end

data/lib/remitano/client/merchant_withdrawals.rb

@@ -13,8 +13,9 @@ module Remitano
     end
 
     def create(
-      merchant_withdrawal_ref:, coin_currency:, coin_amount:, receiver_pay_fee:, cancelled_or_completed_callback_url:,
-      coin_address: nil, destination_tag: nil, remitano_username: nil, remitano_phone_number: nil
+      merchant_withdrawal_ref:, coin_currency:, coin_amount:, receiver_pay_fee:,
+      cancelled_or_completed_callback_url: nil, coin_address: nil, destination_tag: nil,
+      remitano_username: nil, remitano_phone_number: nil
     )
       withdrawal = config.net.post(
         "/merchant/merchant_withdrawals",
@@ -34,5 +35,18 @@ module Remitano
 
       withdrawal
     end
+
+    def list(status: nil, page: nil, per_page: nil)
+      params = {
+        status: status,
+        page: page,
+        per_page: per_page
+      }
+      params.reject! { |_k, v| v.nil? }
+      config.net.get(
+        "/merchant/merchant_withdrawals",
+        params
+      ).execute
+    end
   end
 end

data/lib/remitano/client/net.rb

@@ -1,4 +1,6 @@
-require 'api-auth'
+# frozen_string_literal: true
+
+require "api-auth"
 
 module Remitano
   class Client::Request
@@ -22,16 +24,20 @@ module Remitano
   class Client::Net
     attr_reader :config
 
+    REMITANO_PRODUCTION_SERVER = "https://api.remitano.com"
+    REMITANO_SANDBOX_SERVER = "https://api.remidemo.com"
+
     def initialize(config:)
       @config = config
     end
 
     def self.to_uri(path)
-      return "#{server}/api/v1#{path}"
+      "#{server}/api/v1#{path}"
     end
 
     def self.server
-      @server ||= (ENV['REMITANO_SERVER'] || "https://api.remitano.com")
+      ENV["REMITANO_SERVER"] ||
+        (ENV["REMITANO_SANDBOX"] == "true" ? REMITANO_SANDBOX_SERVER : REMITANO_PRODUCTION_SERVER)
     end
 
     def self.public_get(path, params = {})
@@ -79,8 +85,12 @@ module Remitano
 
       usec = Time.now.usec
       if method == :get
-        path += (path.include?("?") ? "&" : "?")
-        path += "usec=#{usec}"
+        uri = URI(path)
+        request_params = URI.decode_www_form(uri.query || "")
+        request_params.concat(params.to_a)
+        request_params << ["usec", usec]
+        uri.query = URI.encode_www_form(request_params)
+        path = uri.to_s
       else
         params[:usec] = usec
         options[:payload] = params.to_json