t2_airtime 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a465a10576955be1e193df5070890b80d6884d4
-  data.tar.gz: 1182a3ea5ee57f02f690ac599ce286fc2bc5af53
+  metadata.gz: 0033cb2780d4034c75f9d8b3dfa66f458921a3e1
+  data.tar.gz: 7e69c57be3e92fcea08fdc8779b12bea942ea352
 SHA512:
-  metadata.gz: b77299b057c64afb6e9a4591d89cb308b027bc89d08c79c98c24eeab8ade528cc39e37160c7efce85a5abb4ed9f6f61dd86a8a53e21a8e57c85b430a5936290d
-  data.tar.gz: 5d13a4d7bb0f2bfa5ee5daf76eed8e3f67f897b5b667d464a8c72189bd2c316377ff34913a022e7e3a8b8fc5a03ee2371eb9c3df81bac68665d7a08d303edac5
+  metadata.gz: 7a63458e982c66c080ff02c11f7aa53601245360b5e28dcf2b471d61f86599b2acbad88da2c36329acc5c295e86319189c17c6dbf6e63951c4731d39bcfa3802
+  data.tar.gz: 3f02005f4df0ead3e41b99e726c86373217e96ac6c6e33d23c658fcfd278c2bf20edb49938245e5a2e999bb778e0203d4ed0f287e22b3fac34325ac7768ffc33

data/README.md

@@ -1,518 +1,83 @@
-FORMAT: 1A
-HOST: http://polls.apiblueprint.org/
+[![Build Status](https://travis-ci.org/matteolc/t2_airtime.svg?branch=master)](https://travis-ci.org/matteolc/t2_airtime) 
+[![Gem Version](https://badge.fury.io/rb/t2_airtime.svg)](https://badge.fury.io/rb/t2_airtime)
+[![GitHub version](https://badge.fury.io/gh/matteolc%2Ft2_airtime.svg)](https://badge.fury.io/gh/matteolc%2Ft2_airtime)
+[![Dependency Status](https://gemnasium.com/badges/github.com/matteolc/t2_airtime.svg)](https://gemnasium.com/github.com/matteolc/t2_airtime)
 
-# t2-airtime
+t2-airtime
+==========
 
-T2-Airtime is a Ruby gem providing a proxy cache and a REST API to [TransferTo](https://www.transfer-to.com/home) Airtime service.
-
-## Authorization
-
-+ Two Factor Authentication (2FA) is enabled in your [TransferTo Shop](https://shop.transferto.com) Security Center section
-+ You have your Transfer-To Shop username and Airtime secret key generated by 2FA
-+ Export the secrets as environment variables `T2_SHOP_USER`, `T2_AIRTIME_KEY`
-    
-# Account
+[T2-Airtime](https://matteolc.github.io/t2_airtime/) client, `t2_airtime`.
 
-```ruby
-irb(main)> account= T2Airtime::Account.get
-irb(main)> T2Airtime::Account.serialize(account.data)
-```
+T2-Airtime is a Ruby gem providing a proxy cache and a REST API to [TransferTo](https://www.transfer-to.com/home) Airtime service.
 
-## Account Attributes
-- `id` (string) - Transfer-To TShop login name
-- `type` (string) - `Master` (main account) or `Retailer` (subaccount)
-- `name` (string) - Transfer-To TShop account name
-- `currency` (string) - Account currency (USD, GBP, EUR, etc...)
-- `balance` (float) - For `Master` account returns the account’s remaining balance. 
-For `Retailer` returns the account’s remaining limit balance of the day 
-if a daily limit is fixed. Else, returns the account remaining balance
-- `wallet` (float) - For `Master` returns the total remaining balance (sum 
-of all sub-accounts and current master). For `Retailer`: 
-        1. If balance is shared and daily limit is fixed: returns the fixed daily limit amount 
-        2. If balance is shared but daily limit is not fixed: returns "No Limit"
-        3. Else if balance is not shared: returns the remaining balance  
-- `fetchedAt` (string) - The date and time at which the information was fetched         
+## Installation
 
-# Country
+### Install as a Ruby gem
 
-```ruby
-irb(main)> countries= T2Airtime::Country.all
-irb(main)> T2Airtime::Country.serialize(countries.data)
+``` sh
+gem install t2_airtime
 ```
 
-## Country Attributes
-- `id` (integer) - Country Airtime ID
-- `name` (string) - The country name
-- `alpha3` (string) - The alpha3 code of the country
-- `callingCode` (float) - The international dialing code of the country
-- `fetchedAt` (string) - The date and time at which the information was fetched
+### Using Docker - alternative if you don't install ruby or installation not work for you
 
-# Operator
+Download image:
 
-```ruby
-irb(main)> operators= T2Airtime::Operator.all(666)
-irb(main)> T2Airtime::Operator.serialize(operators.data)
 ```
-
-## Operator Attributes
-- `id` (integer) - Operator Airtime ID
-- `name` (string) - The operator name
-- `logo` (string) - The URL to the operator logo
-- `countryId` (float) - The country Airtime ID of the operator
-- `countryName` (float) - The country name
-- `countryAlpha3` (float) - The country alpha3
-- `fetchedAt` (string) - The date and time at which the information was fetched
-
-## Operator Relationships
-- `country.id` (integer) - Country Airtime ID
-
-# Product
-
-```ruby
-irb(main)> products= T2Airtime::Product.all(2361)
-irb(main)> T2Airtime::Product.serialize(products.data)
+docker pull voxbox/t2_airtime
 ```
+Run `docker run voxbox/t2_airtime`
 
-## Product Attributes
-- `id` (integer) - Product Airtime ID
-- `name` (string) - The product name
-- `localCurrency` (string) - The currency code of the product
-- `localCurrencySymbol` (string) - The currency symbol of the product
-- `currency` (string) - The curreny of your account
-- `currencySymbol` (string) - The currency symbol of your account
-- `localPrice` (float) - The face-value of the topup
-- `retailPrice` (float) - The retail price of the product
-- `wholesalePrice` (float) - The wholesale price of the product
-- `countryId` (float) - The country Airtime ID of the product
-- `countryName` (float) - The country name
-- `countryAlpha3` (float) - The country alpha3
-- `operatorId` (string) - The operator Airtime ID of the product
-- `operatorName` (string) - The operator name
-- `operatorLogo` (string) - The URL to the operator logo
-- `fetchedAt` (string) - The date and time at which the information was fetched
+Build from source code:
 
-## Product Relationships
-- `country.id` (integer) - Country Airtime ID
-- `operator.id` (integer) - Operator Airtime ID
-
-# Transaction
-
-```ruby
-irb(main)> transactions= T2Airtime::API.api.transaction_list
-irb(main)> T2Airtime::Transaction.serialize(transactions.data)
 ```
-
-```ruby
-irb(main)> transaction= T2Airtime::Transaction.get("584171224")
-irb(main)> T2Airtime::Transaction.serialize_one(transaction.data)
+docker build -t "voxbox/t2_airtime" .
 ```
 
-## Transaction Attributes
-- `id` (integer) - Transaction Airtime ID
-- `msisdn` (string) - The international phone number or name of 
-the user (sender) requesting to credit a phone number
-- `destinationMsisdn` (string) - Destination MSISDN (usually recipient phone number)
-- `transactionAuthenticationKey` (string) - Authentication key used during the transaction
-- `transactionErrorCode` (string) - Error code for the transaction
-- `transactionErrorTxt` (string) - Description of the error code for the transaction
-- `referenceOperator` (string) - Reference of the operator (returned only if available)
-- `actualProductSent` (string) - Returns the value requested to the operator 
-(equals to product_requested in case of successful transaction). It equals to 0 when Top-up 
-failed or in a simulation.
-- `sms` (string) - The custom message appended to the default notification SMS sent 
-to the recipient
-- `cid1` (string) - Value of the customized field cid1 sent in the Top-up request
-- `cid2` (string) - Value of the customized field cid2 sent in the Top-up request
-- `cid3` (string) - Value of the customized field cid3 sent in the Top-up request
-- `date` (string) - Date of the transaction (GMT) 
-- `currency` (string) - Currency of the account from which the transaction is requested
-- `localCurrency` (string) - Currency of the destination country
-- `pinBased` (string) - Type of product returned ("Yes", default "No" if not set)
-- `localInfoAmount` (string) - Final amount received by recipient. Indicative value only
-- `localInfoCurrency` (string) - Local currency in destination
-- `localInfoValue` (string) - Value of the transaction before tax and service fee in local currency
-- `errorCode` (string) - Error code for the transaction
-- `errorTxt` (string) - Description of the error code for the transaction
-- `productName` (string) - The product name
-- `productLocalCurrency` (string) - The currency code of the product
-- `productLocalCurrencySymbol` (string) - The currency symbol of the product
-- `productCurrency` (string) - The curreny of your account
-- `productCurrencySymbol` (string) - The currency symbol of your account
-- `productLocalPrice` (float) - The face-value of the topup
-- `productRetailPrice` (float) - The retail price of the product
-- `productWholesalePrice` (float) - The wholesale price of the product
-- `countryId` (float) - The country Airtime ID of the product
-- `countryName` (float) - The country name
-- `countryAlpha3` (float) - The country alpha3
-- `operatorId` (string) - The operator Airtime ID of the product
-- `operatorName` (string) - The operator name
-- `operatorLogo` (string) - The URL to the operator logo
-- `fetchedAt` (string) - The date and time at which the information was fetched
+### Setup Transfer-To credentials
 
-## Transaction Relationships
-- `country.id` (integer) - Country Airtime ID
-- `operator.id` (integer) - Operator Airtime ID
-- `product.id` (integer) - Product Airtime ID
+1. Make sure you are a registered user of [Transfer-To](https://www.transfer-to.com/home).
+2. Enable Two Factor Authentication (2FA) in your [Transfer-To Shop](https://shop.transferto.com) Security Center section
+2. Retrieve API key (token) created by Transfer-To Shop.
+3. Export your secrets as an environment variables:
 
-# Topup
-
-```ruby
-irb(main)> topup= T2Airtime::API.api.topup params
-irb(main)> T2Airtime::Topup.serialize(topup.data)
+```sh
+export T2_SHOP_USER=<your_username>
+export T2_AIRTIME_KEY=<your_token>
 ```
 
-## Topup Attributes
-- `balance` (string) - For main account: returns the account’s remaining
-balance. For sub-account: returns the account’s remaining
-limit balance of the day if a daily limit is fixed. Else,
-returns the account remaining balance.
-- `balanceDisplay` (string) - The `balance` value formatted in the currency of your account
-- `transactionId` (integer) - Airtime ID of the transaction.
-- `msisdn` (string) - The international phone number or name of 
-the user (sender) requesting to credit a phone number
-- `destinationMsisdn` (string) - Destination MSISDN (usually recipient phone number)
-- `transactionAuthenticationKey` (string) - Authentication key used during the transaction
-- `transactionErrorCode` (string) - Error code for the transaction
-- `transactionErrorTxt` (string) - Description of the error code for the transaction
-- `referenceOperator` (string) - Reference of the operator (returned only if available)
-- `actualProductSent` (string) - Returns the value requested to the operator 
-(equals to product_requested in case of successful transaction). It equals to 0 when Top-up 
-failed or in a simulation.
-- `sms` (string) - The custom message appended to the default notification SMS sent 
-to the recipient
-- `smsSent` (string) - Defines the status of the notification SMS sent to the
-recipient. Returns `yes` only if the SMS has been successfully sent.
-- `smsText` (string) - The custom message appended to the default
-notification SMS sent to the sender.
-- `cid1` (string) - Value of the customized field cid1 sent in the Top-up request
-- `cid2` (string) - Value of the customized field cid2 sent in the Top-up request
-- `cid3` (string) - Value of the customized field cid3 sent in the Top-up request
-- `currency` (string) - Currency of the account from which the transaction is requested
-- `localCurrency` (string) - Currency of the destination country
-- `productName` (string) - The product name
-- `productLocalCurrency` (string) - The currency code of the product
-- `productLocalCurrencySymbol` (string) - The currency symbol of the product
-- `productCurrency` (string) - The curreny of your account
-- `productCurrencySymbol` (string) - The currency symbol of your account
-- `productLocalPrice` (float) - The face-value of the topup
-- `productRetailPrice` (float) - The retail price of the product
-- `productWholesalePrice` (float) - The wholesale price of the product
-- `countryId` (float) - The country Airtime ID of the product
-- `countryName` (float) - The country name
-- `countryAlpha3` (float) - The country alpha3
-- `operatorId` (string) - The operator Airtime ID of the product
-- `operatorName` (string) - The operator name
-- `operatorLogo` (string) - The URL to the operator logo
-- `executedAt` (string) - The date and time at which the information was fetched
-
-# Msisdn
-
-```ruby
-irb(main)> msisdn= T2Airtime::Msisdn.info("+628123456710")
-irb(main)> T2Airtime::Msisdn.serialize(msisdn.data)
-```
-
-## Msisdn Attributes
-- `msisdn` (string) - The international mobile number
-- `country` (string) - The country of the number
-- `countryId` (string) - Country Airtime ID
-- `operator` (string) - The operator of the number
-- `operatorId` (string) - Operator Airtime ID
-- `fetchedAt` (string) - The date and time at which the information was fetched
-
-## Accounts [/accounts]
-Cached for 1 hour.
+## Development
 
-### Show Account [GET]
-+ Response 200 (application/json)
+1.  If needed, install bundler:
 
-        {
-            "type": "accounts", 
-            "id": "my-t2-shop-account", 
-            "attributes": {
-                "type": "Master", 
-                "name": "my-t2-shop-account-name", 
-                "currency": "USD", 
-                "balance": 16.2, 
-                "wallet": 16.2, 
-                "fetchedAt": "2017-09-17T13:48:34Z"
-            }
-        }
+    ```sh
+    $ gem install bundler
+    ```
 
-## Countries [/countries]
-Cached for 1 hour.
+2.  Clone the repo:
 
-### List all Countries [GET]
+    ```sh
+    $ git clone git@github.com:matteolc/t2_airtime.git
+    $ cd t2_airtime
+    ```
 
-+ Response 200 (application/json)
+3.  Install dependencies:
 
-        [
-            {
-            "type": "countries" 
-            "id": 661
-            "attributes": {
-                "name": "Afghanistan" 
-                "alpha3": "AFG"
-                "callingCode": "93"
-                "fetchedAt": "2017-09-17T13:58:46Z"
-                }
-            }
-            ...
-        ]
+    ```sh
+    $ bundle install
+    ```
 
-## Operators [/operators]
+## Test
 
-### List all Operators [GET]
-Cached for 1 hour.
+Inside the `t2_airtime` repository directory run:
 
-+ Response 200 (application/json)
-
-        [
-            {
-            "type": "operators"
-            "id": 2361
-            "attributes": {
-                "name": "Movicel Angola USD" 
-                "logo": "https://operator-logo.transferto.com/logo-2361-1.png"
-                "countryId": 666
-                "countryName": "Angola"
-                "countryAlpha3": "AGO" 
-                "fetchedAt": "2017-09-17T16:44:08Z"
-            },
-            "relationships": {
-                "country": {
-                    "data":{
-                        "type": "countries"
-                        "id": 666
-                        }
-                    }
-                }
-            },
-            ...
-        ]
-
-## Products [/products]
-Cached for 1 hour.
-
-### List all Products [GET]
-
-+ Response 200 (application/json)
-
-        [
-            {
-            "type": "products"
-             "id": 1
-             "attributes": {
-                "name": "$1.00"
-                "localCurrency": "USD"
-                "localCurrencySymbol": "$"
-                "currency": "USD"
-                "currencySymbol": "$"
-                "localPrice": 1.0
-                "retailPrice": 1.1
-                "wholesalePrice": 1.03
-                "countryId": 666
-                "countryName": "Angola"
-                "countryAlpha3": "AGO"
-                "operatorId": 2361
-                "operatorName": "Movicel Angola USD"
-                "operatorLogo": "https://operator-logo.transferto.com/logo-2361-1.png"
-                "fetchedAt": "2017-09-17T16:48:20Z"
-             },
-             "relationships": {
-                 "country": {
-                    "data": {
-                         "type": "countries"
-                         "id": 666
-                         }
-                 },
-                 "operator": {
-                    "data": {
-                         "type": "operators"
-                         "id": 2361
-                         }
-                 }
-             },
-             ...
-            ]
-
-## Transactions [/transactions]
-
-### List all Transactions [GET]
-
-+ Response 200 (application/json)
-
-        [
-            {
-            "type": "transactions"
-            "id": 584176053
-            "attributes": {
-                "msisdn": "+393800000000"
-                "destinationMsisdn": "393800000001"
-                "transactionAuthenticationKey": "1505553036"
-                "transactionErrorCode": 0
-                "transactionErrorTxt": "Transaction successful"
-                "referenceOperator": nil
-                "actualProductSent": "5"
-                "sms": nil
-                "smsText": "Test"
-                "cid1": "Cid1"
-                "cid2": "Cid2"
-                "cid3": "Cid3"
-                "date": "2017-09-16 09:10:39"
-                "currency": "USD"
-                "localCurrency": "EUR"
-                "pinBased": "no"
-                "localInfoAmount": "5.00"
-                "localInfoCurrency": "EUR"
-                "localInfoValue": "5.00"
-                "errorCode": 0
-                "errorTxt": "Transaction successful"
-                "countryId": 772
-                "countryName": "Italy"
-                "countryAlpha3": "ITA"
-                "operatorId": 734
-                "operatorName": "Wind Italy"
-                "operatorLogo": "https://operator-logo.transferto.com/logo-734-1.png"
-                "productName": "€5.00"
-                "productLocalCurrency": "EUR"
-                "productLocalCurrencySymbol": "€"
-                "productCurrency": "USD"
-                "productCurrencySymbol": "$"
-                "productLocalPrice": 5.0
-                "productRetailPrice": 7.5
-                "productWholesalePrice": 6.9
-                "fetchedAt": "2017-09-17T16:56:29Z"
-            },
-            "relationships": {
-                "country": {
-                    "data": {
-                        "type": "countries"
-                        "id": 772
-                    }
-                },
-                "operator": {
-                    "data": {
-                        "type": "operators"
-                        "id": 734
-                    }
-                },
-                "product": {
-                    "data": {
-                        "type": "products"
-                        "id": 5
-                        }
-                    }
-                }
-            },
-            ...
-        ]
-
-### Show Transactions [GET]
-
-+ Response 200 (application/json)
-
-            {
-            "type": "transactions"
-            "id": 584176053
-            "attributes": {
-                "msisdn": "+393800000000"
-                "destinationMsisdn": "393800000001"
-                "transactionAuthenticationKey": "1505553036"
-                "transactionErrorCode": 0
-                "transactionErrorTxt": "Transaction successful"
-                "referenceOperator": nil
-                "actualProductSent": "5"
-                "sms": nil
-                "smsText": "Test"
-                "cid1": "Cid1"
-                "cid2": "Cid2"
-                "cid3": "Cid3"
-                "date": "2017-09-16 09:10:39"
-                "currency": "USD"
-                "localCurrency": "EUR"
-                "pinBased": "no"
-                "localInfoAmount": "5.00"
-                "localInfoCurrency": "EUR"
-                "localInfoValue": "5.00"
-                "errorCode": 0
-                "errorTxt": "Transaction successful"
-                "countryId": 772
-                "countryName": "Italy"
-                "countryAlpha3": "ITA"
-                "operatorId": 734
-                "operatorName": "Wind Italy"
-                "operatorLogo": "https://operator-logo.transferto.com/logo-734-1.png"
-                "productName": "€5.00"
-                "productLocalCurrency": "EUR"
-                "productLocalCurrencySymbol": "€"
-                "productCurrency": "USD"
-                "productCurrencySymbol": "$"
-                "productLocalPrice": 5.0
-                "productRetailPrice": 7.5
-                "productWholesalePrice": 6.9
-                "fetchedAt": "2017-09-17T16:56:29Z"
-            },
-            "relationships": {
-                "country": {
-                    "data": {
-                        "type": "countries"
-                        "id": 772
-                    }
-                },
-                "operator": {
-                    "data": {
-                        "type": "operators"
-                        "id": 734
-                    }
-                },
-                "product": {
-                    "data": {
-                        "type": "products"
-                        "id": 5
-                        }
-                    }
-                }
-            }
-            
-### Create (Reserve) Transaction [POST]
-
-+ Response 200 (application/json)
-
-        {
-            "type": "transactions"
-            "id": 584176053
-        }
-    
-## Number Information [/msisdn_info]
-Cached for 24 hours.
-
-### Show Number Information [GET]
-
-+ Response 200 (application/json)
-
-        {
-            "type": "msisdn"
-            "msisdn": "628123456710"
-            "country": "Indonesia"
-            "countryId": "767"
-            "operator": "AAA-TESTING Indonesia USD"
-            "operatorId": "1562"
-            "fetchedAt": "2017-09-17T17:05:08Z"
-        }
+```sh
+$ bundle exec rspec
+```
 
-## Topup [/topup]
 
-### Create Topup [POST]
+## License
 
-+ Response 200 (application/json)
+Copyright 2015-17 (c) Matteo La Cognata
 
-        {
-            "type": "msisdn"
-            "msisdn": "628123456710"
-            "country": "Indonesia"
-            "countryId": "767"
-            "operator": "AAA-TESTING Indonesia USD"
-            "operatorId": "1562"
-            "fetchedAt": "2017-09-17T17:05:08Z"
-        }
+Released under MIT license.
+See [LICENSE](https://raw.githubusercontent.com/apiaryio/apiary-client/master/LICENSE) file for further details.