fawry 1.0.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbda1f1ab11ae04767a26c8989237f7ce246a3de49aaa4032ec43504b8e5779c
-  data.tar.gz: cf4891b451a00c47d74254c1e065512572f4e5f19c94db7956b2e94dc210d538
+  metadata.gz: 67bf2df195ce85382e7bd0d9f6d6b2111e5204d59fbc4091a5d9b31b7dde9a5f
+  data.tar.gz: 8a1ebb82a2b6a4937358193ae8c843f7dfcab971ed82c757171a1387c711d9d8
 SHA512:
-  metadata.gz: 2f0571abf34444cb9343f603e0b195ccb6ce683f2d5d4d5e82515a8058e361095aa4af21df17cd15db1ed0fe16195b354d1d708a9855e9c11d9e8eea151cfaca
-  data.tar.gz: 3414b7912f9eab50220ae66ac0d5010b2ecb9b6d359d25929ed7effe671128030d19928a7d1c57107f6ed467dfc315b95b79ad0199ac8f033f4a3e817538e83c
+  metadata.gz: 61914bd40afa7f491abc7f4f65b98e4f4b5e7e384335a7359028c548ec683a88035fef1799e844084e706ca7856828534a72f8a637676d4217510f008db2dfd3
+  data.tar.gz: 16b0687a4eee80795b08f1f71697c25619318b0b1fad49ca455f55527892aa97ea87e95e3edda5d3544433cbc33647a4e2e1524256874737ec8eb1d543c248e4

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -1,8 +1,9 @@
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.6
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 Metrics/BlockLength:
-  ExcludedMethods: ['describe', 'context']
+  IgnoredMethods: ['describe', 'context']
 Style/Documentation:
-  Enabled: false
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Fawry Changelog
+
+## [v1.3.1](https://github.com/fawry-api/fawry/releases/tag/v1.3.1) (15.08.2021)
+- Add language param to charge request params
+
+## [v1.2.1](https://github.com/fawry-api/fawry/releases/tag/v1.2.1) (14.03.2021)
+- Update gem and dependencies to support Ruby 3.0

data/Gemfile.lock

@@ -1,95 +1,96 @@
 PATH
   remote: .
   specs:
-    fawry (1.0.0)
+    fawry (1.3.1)
       dry-validation (~> 1.3, >= 1.3.1)
       faraday (~> 0.17.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    byebug (11.0.1)
-    concurrent-ruby (1.1.5)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    dry-configurable (0.9.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.8)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
+      dry-core (~> 0.5, >= 0.5.0)
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+    dry-core (0.5.0)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
-    dry-initializer (3.0.2)
-    dry-logic (1.0.5)
+    dry-initializer (3.0.4)
+    dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-schema (1.4.2)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.6.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
-      dry-core (~> 0.4)
-      dry-equalizer (~> 0.2)
+      dry-core (~> 0.5, >= 0.5)
       dry-initializer (~> 3.0)
       dry-logic (~> 1.0)
-      dry-types (~> 1.2)
-    dry-types (1.2.2)
+      dry-types (~> 1.5)
+    dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.4.0)
+    dry-validation (1.6.0)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.7, >= 0.7.1)
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
       dry-initializer (~> 3.0)
-      dry-schema (~> 1.0, >= 1.3.1)
-    faraday (0.17.1)
+      dry-schema (~> 1.5, >= 1.5.2)
+    faraday (0.17.4)
       multipart-post (>= 1.2, < 3)
-    hashdiff (1.0.0)
-    jaro_winkler (1.5.4)
+    hashdiff (1.0.1)
     multipart-post (2.1.1)
-    parallel (1.18.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    public_suffix (4.0.1)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    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.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.76.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (1.13.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      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, < 1.7)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    unicode-display_width (1.6.0)
-    webmock (3.7.6)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+    webmock (3.12.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -99,13 +100,13 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
-  byebug (~> 11.0, >= 11.0.1)
+  byebug (~> 11.0)
   fawry!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rspec_junit_formatter
-  rubocop (~> 0.76.0)
-  webmock (~> 3.7, >= 3.7.6)
+  rubocop (~> 1.11)
+  webmock (~> 3.12)
 
 BUNDLED WITH
-   2.0.2
+   2.2.3

data/README-ar.md

@@ -0,0 +1,184 @@
+[![CircleCI](https://circleci.com/gh/fawry-api/fawry.svg?style=svg)](https://circleci.com/gh/fawry-api/fawry)
+
+# Fawry
+
+**تنويه:** نحن لسنا تابعين رسميًا لشركة فوري.
+
+مكتبة لتسهيل التعامل مع خدمات الدفع الخاصة بشبكة الدفع الإلكتروني فوري:
+
+_المكتبة تدعم النظام التجريبي لفوري ايضا_
+
+## لإضافة وتشغيل المكتبة
+
+أضف هذا السطر إلى ملف Gemfile الخاص بتطبيقك:
+
+```ruby
+gem 'fawry'
+```
+
+ثم نفذ:
+
+    $ bundle
+
+أو قم بتثبيته بنفسك على النحو التالي:
+
+    $ gem install fawry
+
+## تهيئة فوري للاستخدام
+
+لبرنامجك لتهيئة المكتبة `fawry.rb` أضف مهيئ
+
+```ruby
+Fawry.configure do |config|
+  config.sandbox = Rails.env.staging?
+  config.fawry_secure_key = 'fawry_secure_key'
+  config.fawry_merchant_code = 'fawry_merchant_code'
+end
+```
+
+`FAWRY_SANDBOX`, `FAWRY_SECURE_KEY`, `FAWRY_MERCHANT_CODE` _(environment variables)_ او يمكنك بدلا من ذلك، استخدام المتغيرات البيئية
+
+## طريقة الإستعمال
+
+### لإجراء عملية دفع
+
+```ruby
+params = { "merchant_code": 'merchant_code',
+           "merchant_ref_num": 'io5jxf3jp27kfh8m719arcqgw7izo7db',
+           "customer_profile_id": 'ocvsydvbu2gcp528wvl64i9z5srdalg5',
+           "customer_mobile": '012345678901',
+           "payment_method": 'PAYATFAWRY',
+           "currency_code": 'EGP',
+           "amount": 20,
+           "language": "ar-eg",
+           "fawry_secure_key": 'fawry_secure_key',
+           "description": 'the charge request description',
+           "charge_items": [{ "item_id": 'fk3fn9flk8et9a5t9w3c5h3oc684ivho',
+                              "description": 'desc', "price": 20, "quantity": 1 }] }
+
+res = Fawry.charge(params)
+#  => #<Fawry::FawryResponse:0x0000564257d0ea90 @type="ChargeResponse", @reference_number="931600239",
+#                                               @merchant_ref_number="io5jxf3jp27kfh8m719arcqgw7izo7db",
+#                                               @expiration_time=1573153206979, @status_code=200,
+#                                               @status_description="Operation done successfully">
+
+res.success? # => true
+res.reference_number # => 931600239
+```
+
+### لإجراء عملية استرداد
+
+```ruby
+params = { "merchant_code": 'merchant_code',
+           "reference_number": '931337410',
+           "refund_amount": 20,
+           "fawry_secure_key": 'fawry_secure_key' }
+
+res = Fawry.refund(params)
+#  => #<Fawry::FawryResponse:0x0000564257d0ea90 @type="ResponseDataModel", @status_code=200,
+#                                               @status_description="Operation done successfully">
+
+res.success? # => true
+```
+
+### حالة الدفع
+
+```ruby
+params = { "merchant_code": 'merchant_code',
+           "merchant_ref_number": 'ssshxb98phmyvm434es62kage3nsm2cj',
+           "fawry_secure_key": 'fawry_secure_key' }
+
+res = Fawry.payment_status(params)
+ # => #<Fawry::FawryResponse:0x0000559974056898 @type="PaymentStatusResponse", @reference_number="931922417",
+ #                                              @merchant_ref_number="ssshxb98phmyvm434es62kage3nsm2cj",
+ #                                              @expiration_time=1573297736167, @status_code=200,
+ #                                              @status_description="Operation done successfully", @payment_amount=20,
+ #                                              @payment_method="PAYATFAWRY", @payment_status="UNPAID">
+
+res.success? # => true
+res.payment_status # => UNPAID
+```
+
+### عرض رموز الكروت
+
+```ruby
+params = { "merchant_code": 'merchant_code',
+           "customer_profile_id": 'customer_profile_id',
+           "fawry_secure_key": 'fawry_secure_key' }
+
+res = Fawry.list_tokens(params)
+
+#<Fawry::FawryResponse:0x0000556cb3a31798 @fawry_api_response={"type"=>"CustomerTokensResponse", "cards"=>[{"token"=>"b5sshhdsl98df96200f254c19b2718bfc825a0678888216c28962b3e66a393084ee9aed6", "creationDate"=>1599487402318, "lastFourDigits"=>"4242", "brand"=>"Visa Card"}, {"token"=>"fb98dslsksmkdds7857ed7042ce30a2a5b777e1f1ac6ac58da1c8c0199f61df7a8bc098e96", "creationDate"=>1599489158457, "lastFourDigits"=>"0001", "brand"=>"Visa Card"}, {"token"=>"cc03fwqaacbd94e468a1b756ac1cbb285a41a2428df9f1a727457b41f9447d0058c7c", "creationDate"=>1599584834346, "lastFourDigits"=>"2346", "brand"=>"MasterCard"}, {"token"=>"f04a8bc9c973f900515f4b58e52c9ff03070baf3f534bdfdad0e97679534f60ddkjk13", "creationDate"=>1600260415739, "lastFourDigits"=>"8769", "brand"=>"Visa Card"}], "statusCode"=>200, "statusDescription"=>"Operation done successfully"}, @type="CustomerTokensResponse", @cards=[{"token"=>"b5sshhdsl98df96200f254c19b2718bfc825a0678888216c28962b3e66a393084ee9aed6", "creationDate"=>1599487402318, "lastFourDigits"=>"4242", "brand"=>"Visa Card"}, {"token"=>"fb98dslsksmkdds7857ed7042ce30a2a5b777e1f1ac6ac58da1c8c0199f61df7a8bc098e96", "creationDate"=>1599489158457, "lastFourDigits"=>"0001", "brand"=>"Visa Card"}, {"token"=>"cc03fwqaacbd94e468a1b756ac1cbb285a41a2428df9f1a727457b41f9447d0058c7c", "creationDate"=>1599584834346, "lastFourDigits"=>"2346", "brand"=>"MasterCard"}, {"token"=>"f04a8bc9c973f900515f4b58e52c9ff03070baf3f534bdfdad0e97679534f60ddkjk13", "creationDate"=>1600260415739, "lastFourDigits"=>"8769", "brand"=>"Visa Card"}], @status_code=200, @status_description="Operation done successfully">
+
+res.success? # => true
+res.cards # => cards
+```
+
+### إضافة رمز كارت
+
+```ruby
+params = { "merchant_code" : "merchant_code",
+            "customer_profile_id" : "customer_profile_id",
+            "customer_mobile" : "customer_mobile",
+            "customer_email" : "customer_email",
+            "card_number" : "card_number",
+            "expiry_year" : "expiry_year",
+            "expiry_month" : "expiry_month",
+            "cvv" : "cvv" }
+
+res = Fawry.create_card_token(params)
+#<Fawry::FawryResponse:0x0000556cb3eb0080 @fawry_api_response={"type"=>"CardTokenResponse", "card"=>{"token"=>"b598f96200f254c19b2718bfc825a063278888216c28962b3e66a393084ee9aed6", "creationDate"=>1607011562353, "lastFourDigits"=>"4242"}, "statusCode"=>200, "statusDescription"=>"Operation done successfully"}, @type="CardTokenResponse", @status_code=200, @status_description="Operation done successfully", @card={"token"=>"b598f96200f254c19b2718bfc825a063278888216c28962b3e66a393084ee9aed6", "creationDate"=>1607011562353, "lastFourDigits"=>"4242"}>
+
+res.success?
+res.card
+```
+
+### حذف رمز كارت
+
+```ruby
+params = { "merchant_code": 'merchant_code',
+           "customer_profile_id": 'customer_profile_id',
+           "card_token": 'card_token' }
+
+res = Fawry.delete_token(params)
+#<Fawry::FawryResponse:0x0000556cb57c2460 @fawry_api_response={"type"=>"CardTokenResponse", "statusCode"=>200, "statusDescription"=>"Operation done successfully"}, @type="CardTokenResponse", @status_code=200, @status_description="Operation done successfully">
+res.success?
+
+```
+
+### رد اتصال خدمة تحليل فوري v2
+
+```ruby
+# تم إرسال المعلمات من خادم فوري
+callback_params = { "requestId": 'c72827d084ea4b88949d91dd2db4996e', "fawryRefNumber": '970177',
+                    "merchantRefNumber": '9708f1cea8b5426cb57922df51b7f790',
+                    "customerMobile": '01004545545', "customerMail": 'fawry@fawry.com',
+                    "paymentAmount": 152.00, "orderAmount": 150.00, "fawryFees": 2.00,
+                    "shippingFees": '', "orderStatus": 'NEW', "paymentMethod": 'PAYATFAWRY',
+                    "messageSignature": 'b0175565323e464b01dc9407160368af5568196997fb6e379374a4f4fbbcf587',
+                    "orderExpiryDate": 1_533_554_719_314,
+                    "orderItems": [{ "itemCode": 'e6aacbd5a498487ab1a10ae71061535d', "price": 150.0, "quantity": 1 }] }
+
+fawry_callback = Fawry.parse_callback(callback_params)
+# <Fawry::FawryCallback:0x000056339ac43730 @request_id="c72827d084ea4b88949d91dd2db4996e", @fawry_ref_number="970177",
+#                                          @merchant_ref_number="9708f1cea8b5426cb57922df51b7f790", @customer_mobile="01004545545",
+#                                          @customer_mail="fawry@fawry.com", @order_status="NEW", @order_amount=150.0, @fawry_fees=2.0, ...>
+
+fawry_callback.fawry_ref_number # => 970177
+fawry_callback.order_status # => NEW
+```
+
+## الخطوات القادمة المطلوب تنفيذها:
+
+- إضافة خيار لرفع الاستثناء عند فشل الطلب
+
+## تطوير المكتبة
+
+بعد التحقق من الريبو ، قم بتشغيل `bin/setup` لتثبيت التبعيات.
+ثم نفذ الأمر `rake spec` لإجراء الاختبارات. يمكنك أيضا الجري `bin/console` للمطالبة التفاعلية التي تسمح لك بالتجربة.
+
+لتثبيت هذه المكتبة على جهازك ، قم بتشغيل `bundle exec rake install`. لإصدار إصدار جديد ، قم بتحديث رقم الإصدار بتنسيق `version.rb`, ثم نفذ الأمر `bundle exec rake release`, الذي سينشئ علامة git للإصدار ، ويدفع التزامات git والعلامات ، ويدفع ملف `.gem` يا صديق [rubygems.org](https://rubygems.org).
+
+## المساهمة
+
+يتم الترحيب بتقارير الأخطاء وطلبات السحب على GitHub في https://github.com/amrrbakry/fawry. يهدف هذا المشروع إلى أن يكون مساحة آمنة ومرحبة للتعاون ، ومن المتوقع أن يلتزم المساهمون بـ [Contributor Covenant](http://contributor-covenant.org) القواعد السلوكية.

data/README.md

@@ -2,16 +2,16 @@
 
 # Fawry
 
-A plug-and-play library that makes interfacing with Fawry's payment gateway API a breeze:
+[README - متوفر باللغة العربية](https://github.com/fawry-api/fawry/blob/master/README-ar.md)
+
+**Disclaimer:** we are _not officially affilated_ with the _Fawry_ company.
 
-- [Charge customers](https://github.com/fawry-api/fawry#charge-customers)
-- [Refund customers](https://github.com/fawry-api/fawry#refund-customers)
-- [Get payment status](https://github.com/fawry-api/fawry#get-payment-status)
-- [Parse Fawry's service callback V2](https://github.com/fawry-api/fawry#parse-fawry-service-callback-v2)
-- [Configuration keys as environment variables](https://github.com/fawry-api/fawry#configuration-keys-as-environment-variables)
+A plug-and-play library that makes interfacing with Fawry's payment gateway API a breeze:
 
 _Fawry's production and sandbox environments are supported._
 
+_This library is tested on Ruby v2.6, 2.7, 3.0_
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,6 +28,20 @@ Or install it yourself as:
 
     $ gem install fawry
 
+## Configuration
+
+Add an initializer `fawry.rb` in your application to configure the library:
+
+```ruby
+Fawry.configure do |config|
+  config.sandbox = Rails.env.staging?
+  config.fawry_secure_key = 'fawry_secure_key'
+  config.fawry_merchant_code = 'fawry_merchant_code'
+end
+```
+
+Alternatively, you could use the environment variables: `FAWRY_SANDBOX`, `FAWRY_SECURE_KEY`, and `FAWRY_MERCHANT_CODE`.
+
 ## Usage
 
 ### Charge customers
@@ -40,13 +54,13 @@ params = { "merchant_code": 'merchant_code',
            "payment_method": 'PAYATFAWRY',
            "currency_code": 'EGP',
            "amount": 20,
+           "language": "ar-eg",
            "fawry_secure_key": 'fawry_secure_key',
            "description": 'the charge request description',
            "charge_items": [{ "item_id": 'fk3fn9flk8et9a5t9w3c5h3oc684ivho',
                               "description": 'desc', "price": 20, "quantity": 1 }] }
 
-# use sandbox option to call Fawry's sandbox env
-res = Fawry.charge(params, sandbox: true)
+res = Fawry.charge(params)
 #  => #<Fawry::FawryResponse:0x0000564257d0ea90 @type="ChargeResponse", @reference_number="931600239",
 #                                               @merchant_ref_number="io5jxf3jp27kfh8m719arcqgw7izo7db",
 #                                               @expiration_time=1573153206979, @status_code=200,
@@ -56,7 +70,7 @@ res.success? # => true
 res.reference_number # => 931600239
 ```
 
-###  Refund Customers
+### Refund Customers
 
 ```ruby
 params = { "merchant_code": 'merchant_code',
@@ -64,21 +78,21 @@ params = { "merchant_code": 'merchant_code',
            "refund_amount": 20,
            "fawry_secure_key": 'fawry_secure_key' }
 
-res = Fawry.refund(params, sandbox: true)
+res = Fawry.refund(params)
 #  => #<Fawry::FawryResponse:0x0000564257d0ea90 @type="ResponseDataModel", @status_code=200,
 #                                               @status_description="Operation done successfully">
 
 res.success? # => true
 ```
 
-###  Get Payment Status
+### Get Payment Status
 
 ```ruby
 params = { "merchant_code": 'merchant_code',
            "merchant_ref_number": 'ssshxb98phmyvm434es62kage3nsm2cj',
            "fawry_secure_key": 'fawry_secure_key' }
 
-res = Fawry.payment_status(params, sandbox: true)
+res = Fawry.payment_status(params)
  # => #<Fawry::FawryResponse:0x0000559974056898 @type="PaymentStatusResponse", @reference_number="931922417",
  #                                              @merchant_ref_number="ssshxb98phmyvm434es62kage3nsm2cj",
  #                                              @expiration_time=1573297736167, @status_code=200,
@@ -89,7 +103,54 @@ res.success? # => true
 res.payment_status # => UNPAID
 ```
 
-###  Parse Fawry service callback v2
+### List Card Tokens
+
+```ruby
+params = { "merchant_code": 'merchant_code',
+           "customer_profile_id": 'customer_profile_id',
+           "fawry_secure_key": 'fawry_secure_key' }
+
+res = Fawry.list_tokens(params)
+#<Fawry::FawryResponse:0x0000556cb3a31798 @fawry_api_response={"type"=>"CustomerTokensResponse", "cards"=>[{"token"=>"b5sshhdsl98df96200f254c19b2718bfc825a0678888216c28962b3e66a393084ee9aed6", "creationDate"=>1599487402318, "lastFourDigits"=>"4242", "brand"=>"Visa Card"}, {"token"=>"fb98dslsksmkdds7857ed7042ce30a2a5b777e1f1ac6ac58da1c8c0199f61df7a8bc098e96", "creationDate"=>1599489158457, "lastFourDigits"=>"0001", "brand"=>"Visa Card"}, {"token"=>"cc03fwqaacbd94e468a1b756ac1cbb285a41a2428df9f1a727457b41f9447d0058c7c", "creationDate"=>1599584834346, "lastFourDigits"=>"2346", "brand"=>"MasterCard"}, {"token"=>"f04a8bc9c973f900515f4b58e52c9ff03070baf3f534bdfdad0e97679534f60ddkjk13", "creationDate"=>1600260415739, "lastFourDigits"=>"8769", "brand"=>"Visa Card"}], "statusCode"=>200, "statusDescription"=>"Operation done successfully"}, @type="CustomerTokensResponse", @cards=[{"token"=>"b5sshhdsl98df96200f254c19b2718bfc825a0678888216c28962b3e66a393084ee9aed6", "creationDate"=>1599487402318, "lastFourDigits"=>"4242", "brand"=>"Visa Card"}, {"token"=>"fb98dslsksmkdds7857ed7042ce30a2a5b777e1f1ac6ac58da1c8c0199f61df7a8bc098e96", "creationDate"=>1599489158457, "lastFourDigits"=>"0001", "brand"=>"Visa Card"}, {"token"=>"cc03fwqaacbd94e468a1b756ac1cbb285a41a2428df9f1a727457b41f9447d0058c7c", "creationDate"=>1599584834346, "lastFourDigits"=>"2346", "brand"=>"MasterCard"}, {"token"=>"f04a8bc9c973f900515f4b58e52c9ff03070baf3f534bdfdad0e97679534f60ddkjk13", "creationDate"=>1600260415739, "lastFourDigits"=>"8769", "brand"=>"Visa Card"}], @status_code=200, @status_description="Operation done successfully">
+
+res.success? # => true
+res.cards # => cards
+```
+
+### Create Card Token
+
+```ruby
+params = { "merchant_code" : "merchant_code",
+            "customer_profile_id" : "customer_profile_id",
+            "customer_mobile" : "customer_mobile",
+            "customer_email" : "customer_email",
+            "card_number" : "card_number",
+            "expiry_year" : "expiry_year",
+            "expiry_month" : "expiry_month",
+            "cvv" : "cvv" }
+res = Fawry.create_card_token(params)
+#<Fawry::FawryResponse:0x0000556cb3eb0080 @fawry_api_response={"type"=>"CardTokenResponse", "card"=>{"token"=>"b598f96200f254c19b2718bfc825a063278888216c28962b3e66a393084ee9aed6", "creationDate"=>1607011562353, "lastFourDigits"=>"4242"}, "statusCode"=>200, "statusDescription"=>"Operation done successfully"}, @type="CardTokenResponse", @status_code=200, @status_description="Operation done successfully", @card={"token"=>"b598f96200f254c19b2718bfc825a063278888216c28962b3e66a393084ee9aed6", "creationDate"=>1607011562353, "lastFourDigits"=>"4242"}>
+
+res.success?
+res.card
+```
+
+### Delete Card Token
+
+```ruby
+params = { "merchant_code": "merchant_code",
+           "customer_profile_id": "customer_profile_id",
+           "card_token": "card_token",
+           "fawry_secure_key": "fawry_secure_key" }
+
+res = Fawry.delete_token(params)
+#<Fawry::FawryResponse:0x0000556cb57c2460 @fawry_api_response={"type"=>"CardTokenResponse", "statusCode"=>200, "statusDescription"=>"Operation done successfully"}, @type="CardTokenResponse", @status_code=200, @status_description="Operation done successfully">
+
+res.success?
+
+```
+
+### Parse Fawry service callback v2
 
 ```ruby
 # params sent from fawry server
@@ -102,8 +163,7 @@ callback_params = { "requestId": 'c72827d084ea4b88949d91dd2db4996e', "fawryRefNu
                     "orderExpiryDate": 1_533_554_719_314,
                     "orderItems": [{ "itemCode": 'e6aacbd5a498487ab1a10ae71061535d', "price": 150.0, "quantity": 1 }] }
 
-# FAWRY_SECURE_KEY env var must be set
-fawry_callback = Fawry.parse_callback(callback_params, {})
+fawry_callback = Fawry.parse_callback(callback_params)
 # <Fawry::FawryCallback:0x000056339ac43730 @request_id="c72827d084ea4b88949d91dd2db4996e", @fawry_ref_number="970177",
 #                                          @merchant_ref_number="9708f1cea8b5426cb57922df51b7f790", @customer_mobile="01004545545",
 #                                          @customer_mail="fawry@fawry.com", @order_status="NEW", @order_amount=150.0, @fawry_fees=2.0, ...>
@@ -112,15 +172,8 @@ fawry_callback.fawry_ref_number # => 970177
 fawry_callback.order_status # => NEW
 ```
 
-### Configuration keys as environment variables
-
-Fawry configuration keys such as merchant code and secure key can be sent with the params (`merchant_code`, `fawry_secure_key` ) to the **charge**, **refund**, **payment_status** methods, _or_ they can be set as environment variables: (`FAWRY_MERCHANT_CODE`, `FAWRY_SECURE_KEY`).
-
-To **parse** fawry callback, you _must_ set the env var `FAWRY_SECURE_KEY`.
-
 ## TODO:
 
-- Add public API documentation to README
 - Add option to raise exception on request failure
 
 ## Development