t2_airtime 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d31b97a41f77c8dc0699a4f2f53f5ab3e8089ba
-  data.tar.gz: b72a93f7d90b3a0aa703409e574e587473856983
+  metadata.gz: ae197e105fc7596c31630070d8030e85757b0701
+  data.tar.gz: f73403091b4c8cd4b0d6977edf60e27f5cdbdc75
 SHA512:
-  metadata.gz: 97d448a27a38c76b1f822f412156f2e553b03f6f02b336285d998d5d1960384e8163e0dff494d208ff9848183a618493c5c7143ea355784159e3e251c476f78a
-  data.tar.gz: bc760cdd4c03e34f22e77a9821d2622f75a9ef7b10468c46c7a4a8f807813d713107c70d20fe92013aca84c5fb07f2389d7698e0dee801d83a7512bb647bb71c
+  metadata.gz: c280efca6a355e39cf15fac08767ebdc9d371d15d5baa59d04d56031e0a765d82284d017a712227d22e2b0e41dc0610477f88834ab079e81f85967f0d1e16b6a
+  data.tar.gz: 0bcffd703b9791a30ecb138ff819ae5b4250c20f49dd867ecfc3b57457a78e686623030abaeda4146ea010dd071c729fb95c2727f3a4549c08edc13e7a99658e

data/README.md

@@ -1,69 +1,69 @@
 # TransferTo Airtime API
 
-TransferTo helps businesses offer airtime top-ups, goods and services, and mobile money around the world in real time.
-This API enables developers to integrate TransferTo Top-up service into their system. If you are building 
-application that leverages international recharge services, then this is the API for you. 
+[TransferTo](https://www.transfer-to.com/home) helps businesses offer airtime top-ups, goods and services, and mobile money around the world in real time.
+TransferTo Airtime API enables developers to integrate TransferTo Top-up service into their system.
 
-## Installation
+This gem is a convenience wrapper around the Airtime API. Requirements:
+
+    Two Factor Authentication (2FA) enabled in your [TransferTo Shop](https://shop.transferto.com) Security Center section.
+
+
+## Usage
+
+rails new $APPNAME \
+    --skip-active-record \
+    -d postgresql \
+    --skip-yarn \
+    --skip-action-cable \
+    --skip-sprockets \
+    --skip-spring \
+    --skip-coffee \
+    --skip-javascript \
+    --skip-turbolinks \
+    --api 
 
 Add this line to your application's Gemfile:
 
 ```ruby
 gem 't2_airtime'
-```
+```   
 
 And then execute:
 
-    $ bundle
+    $ bundle 
 
-Or install it yourself as:
+Create a `.env` file with the required information:
 
-    $ gem install t2_airtime
+    T2_SHOP_USER=
+    T2_AIRTIME_KEY=
+    T2_CURRENCY=
 
-## Usage
+Start the server: `bundle exec puma -C config/puma.rb`
+
+### Routes
+
+The following routes are mada available to your application when you mount the API engine in `config/routes.rb`:
 
-### Retrieve your API Token
-Once  you  have  received  your  account  credentials  (login,  password)  to  access  the  TransferTo  web 
-interface, you must log in and retrieve your API token to be used with the TransferTo API.
-To activate access  to your API account, enable Two Factor Authentication  (2FA). 
-
-    TSHOP_USER=
-    TSHOP_SECRET=
-
-## Test
-
-Execute:
-
-    $ rspec
-
-    T2Airtime
-    has a version number
-    has the correct API URL
-    has 7 test numbers
-    responds to ping
-    checks wallet
-    checks number information
-    reserves a transaction id
-    returns a countries list
-    returns a country operators
-    returns an operator products
-    returns error code 0 for PIN based Top-up (successful transaction)
-    returns error code 0 for PIN less Top-up (successful transaction)
-    returns error code 204 (destination number is not a valid prepaid phone number) (FAILED - 1)
-    returns error code 301 (input value out of range or invalid product) (FAILED - 2)
-    returns error code 214 (transaction refused by the operator) (FAILED - 3)
-    returns error code 998 (system not available, please retry later) (FAILED - 4)
-    returns error code 999 (unknown error, please contact support) (FAILED - 5)
-    returns a transaction list    
-
-    Failed examples:
-
-    rspec ./spec/t2_airtime_spec.rb:99 # T2Airtime returns error code 204 (destination number is not a valid prepaid phone number)
-    rspec ./spec/t2_airtime_spec.rb:108 # T2Airtime returns error code 301 (input value out of range or invalid product)
-    rspec ./spec/t2_airtime_spec.rb:117 # T2Airtime returns error code 214 (transaction refused by the operator)
-    rspec ./spec/t2_airtime_spec.rb:126 # T2Airtime returns error code 998 (system not available, please retry later)
-    rspec ./spec/t2_airtime_spec.rb:135 # T2Airtime returns error code 999 (unknown error, please contact support)
+```ruby
+mount T2Airtime::Engine => '/airtime'
+```
+
+    http://localhost:3000/airtime/transactions
+    http://localhost:3000/airtime/transactions/<id>
+    http://localhost:3000/airtime/countries
+    http://localhost:3000/airtime/<country_id>/operators
+    http://localhost:3000/airtime/<operator_id>/products
     
+### Helpers
+
+Main API helper:
+
+```ruby
+api = T2Airtime::API.api
+```
+
+[TBC]   
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/t2_airtime/util.rb

@@ -17,7 +17,7 @@ module T2Airtime
       num > 0 && num < 8 ? numbers[num-1] : numbers
     end 
 
-    def self.format_price(price, currency=ENV['T2_CURRENCY'])
+    def self.format_price(price, currency=(ENV['T2_CURRENCY'] || "USD"))
       Money.new(Float(price)*100, currency).format
     end  
 

data/lib/t2_airtime/version.rb

@@ -1,3 +1,3 @@
 module T2Airtime
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: t2_airtime
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - matteolc