t2_airtime 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 380883694d9e2012b6a23f88879f44a05005efad
-  data.tar.gz: 3ed077121a1271feb7f0966d3d519315277c072d
+  metadata.gz: 38e4e557218b14ad7121726d230ab461c023086c
+  data.tar.gz: a28342602169af97f687efe81c7a21c69b55ff5e
 SHA512:
-  metadata.gz: ebb27cede9bea986e496a2e0dcd05a3f46fff44bf33b3e020e20f723a44c6d53c9fe7c7038d9c1974ba6ffe3936b5079897a6a42447e9f1948d080152b1ded2b
-  data.tar.gz: a08ded72071d2d07c2dd85960051602ba70fb67f5c480b43b9e9372ffe27343778a6f3cea7249d341251071accbd2018aa3afc745c4e5daf533d1754a4afd7ac
+  metadata.gz: 89da1d5f2631d4b9444516ca44ea0d5a9dbd9b3055fbacf3b5d0a3a11c5a5850ae052a95489d6f0948d34020f1ce84d40425113d499b73fdbc60cd965d38b635
+  data.tar.gz: c847a4b2391449383ef123fb6aa367fd3b7df770ade4842244c6269d038de7478245fe05c83c28a0518293bf2afaaaf4861f4211b363d15a316e2811fdb29906

data/app/controllers/t2_airtime/airtime_controller.rb

@@ -1,81 +1,96 @@
 module T2Airtime
   class AirtimeController < ActionController::API
 
+    def account
+       reply = T2Airtime::API.api.account_info
+       if reply.success?
+          render_data T2Airtime::Account.serialize reply.data, 
+                                                   reply.headers[:date]
+       else
+          render_error T2Airtime::Error.new reply.error_code, 
+                                            reply.error_message
+       end       
+    end
+
+
     def countries
        reply = T2Airtime::API.api.country_list
        if reply.success?
-          data = T2Airtime::Country.serialize(reply.data)
-          render json: {
-                links: {
-                    self: request.path
-                },              
-                data: data,
-                status: :ok
-          }
+          render_data T2Airtime::Country.serialize reply.data, 
+                                                   reply.headers[:date]
        else
-          render_error(T2Airtime::Error.new(reply.error_code, reply.error_message))
+          render_error T2Airtime::Error.new reply.error_code, 
+                                            reply.error_message
        end
     end
 
     def operators
-       reply = T2Airtime::API.api.operator_list(params[:country_aid])
+       reply = T2Airtime::API.api.operator_list(params[:id])
        if reply.success?
-          data = T2Airtime::Operator.serialize(reply.data)
-          render json: {
-              operators: data,
-              status: :ok
-          }
+          render_data T2Airtime::Operator.serialize reply.data, 
+                                                    reply.headers[:date]
        else
-          render_error(T2Airtime::Error.new(reply.error_code, reply.error_message))
+          render_error T2Airtime::Error.new reply.error_code, 
+                                            reply.error_message
        end
     end    
 
     def products
-       reply = T2Airtime::API.api.product_list(params[:operator_aid])
+       reply = T2Airtime::API.api.product_list(params[:id])
        if reply.success?
-          data = T2Airtime::Product.serialize(reply.data)
-          render json: {              
-              products: data,
-              status: :ok
-          }
+          render_data T2Airtime::Product.serialize reply.data,
+                                                   reply.headers[:date]
        else
-          render_error(T2Airtime::Error.new(reply.error_code, reply.error_message))
+          render_error T2Airtime::Error.new reply.error_code, 
+                                            reply.error_message
        end
     end 
     
     def transactions
-       reply = T2Airtime::API.api.trans_list(params[:start], params[:stop], params[:msisdn], params[:destination], params[:code])
+       reply = T2Airtime::API.api.transaction_list parse_time_param(params[:start]), 
+                                                   parse_time_param(params[:stop]), 
+                                                   params[:msisdn], 
+                                                   params[:destination], 
+                                                   params[:code]
        if reply.success?
-          data = T2Airtime::Transaction.serialize(reply.data)
-          render json: {              
-              transactions: data,
-              status: :ok
-          }
+          render_data T2Airtime::Transaction.serialize reply.data
        else
-          render_error(T2Airtime::Error.new(reply.error_code, reply.error_message))
+          render_error T2Airtime::Error.new reply.error_code, 
+                                            reply.error_message
        end
     end 
 
     def transaction
-       reply = T2Airtime::API.api.trans_info(params[:id])
+       reply = T2Airtime::API.api.transaction_info(params[:id])
        if reply.success?
-          data = T2Airtime::Transaction.serialize_one(reply.data)
-          render json: {              
-              transaction: data,
-              status: :ok
-          }
+          render_data T2Airtime::Transaction.serialize_one reply.data,
+                                                           reply.headers[:date]
        else
-          render_error(T2Airtime::Error.new(reply.error_code, reply.error_message))
+          render_error T2Airtime::Error.new reply.error_code, 
+                                            reply.error_message
        end
     end     
     
     protected
 
+    def parse_time_param(timestr)
+      Time.zone.parse(timestr)
+    end
+
+
+    def render_data(data)
+          render json: {              
+              data: data,
+              status: :ok
+          }
+    end    
+
     def render_error(error)
           render json: {
               errors: [{
                 code: error.code,
-                detail: error.message
+                detail: error.message,
+                title: "Error!"
               }],
               status: :bad_request
           }

data/lib/t2_airtime/api.rb

@@ -8,7 +8,7 @@ module T2Airtime
 
     # Returns the balance in your TransferTo account. 
     # This method shall not be used more than 24 times per day.     
-    def check_wallet
+    def account_info
       run_action :check_wallet
     end    
 
@@ -196,7 +196,7 @@ module T2Airtime
     # stop_date
     # ---------
     # Defines the end date of the search (included). Format must be YYYY-MM-DD.
-    def trans_list(start=(Time.now-24.hours), stop=Time.now, msisdn=nil, destination=nil, code=nil)
+    def transaction_list(start=(Time.now-24.hours), stop=Time.now, msisdn=nil, destination=nil, code=nil)
       @params[:code]               = code unless code
       @params[:msisdn]             = msisdn unless msisdn
       @params[:stop_date]          = to_yyyymmdd(stop)
@@ -209,7 +209,7 @@ module T2Airtime
     # “debit_amount_validated” are rounded to 2 digits after the comma but are
     # the same as the values returned in the fields “input_value” and
     # “validated_input_value” of the “topup” method response.        
-    def trans_info(id)
+    def transaction_info(id)
       @params = { transactionid: id }
       run_action :trans_info
     end    

data/lib/t2_airtime/base.rb

@@ -1,6 +1,11 @@
 module T2Airtime
   class Base
 
+    attr_reader :user,
+                :password,
+                :url,
+                :params
+
     def initialize(user, password, url)      
       @user, @password, @url, @params = user, password, url, {}
     end

data/lib/t2_airtime/serializer.rb

@@ -3,20 +3,25 @@ module T2Airtime
   class Account
 
     def self.info
-        reply = T2Airtime::API.api.check_wallet
-        reply.success? ? serialize(reply.data) : {}
+        reply = T2Airtime::API.api.account_info
+        reply.success? ? serialize(reply.data, reply.headers[:date]) : []
     end
 
-    def self.serialize(data)
+    def self.serialize(data, ts="#{Time.zone.now}")
       {
-        type: data[:type],
-        name: data[:name],
-        currency: data[:currency],
-        balance: Float(data[:balance]),
-        wallet: Float(data[:wallet]),
-        balance_display: T2Airtime::Util.format_price(data[:balance], data[:currency]),
-        wallet_display: T2Airtime::Util.format_price(data[:wallet], data[:currency]),
-      }
+        type: "accounts",
+        id: T2Airtime::API.api.user,
+        attributes: {
+          type: data[:type],
+          name: data[:name],
+          currency: data[:currency],
+          balance: Float(data[:balance]),
+          wallet: Float(data[:wallet]),
+          "balance-display": T2Airtime::Util.format_price(data[:balance], data[:currency]),          
+          "wallet-display": T2Airtime::Util.format_price(data[:wallet], data[:currency]),
+          "fetched-at": T2Airtime::Util.format_time(ts)
+        }
+      }.as_json
     end
 
   end  
@@ -25,11 +30,11 @@ module T2Airtime
 
     def self.take(qty=5)
         reply = T2Airtime::API.api.country_list
-        reply.success? ? serialize(reply.data, qty, reply.headers[:date]) : []
+        reply.success? ? serialize(reply.data, reply.headers[:date], qty) : []
     end
 
-    def self.serialize(data, qty=nil, ts=nil)
-        ts = ts.nil? ? Time.now : ts
+    def self.serialize(data, ts="#{Time.zone.now}", qty=nil)
+        return [] if data[:countryid].nil?
         names = data[:country].split(",") 
         ids = data[:countryid].split(",")
         ids.take(qty.nil? ? ids.count : qty).each_with_index.map{|id, n| {
@@ -39,8 +44,15 @@ module T2Airtime
             "name": names[n], 
             "alpha3": alpha3(names[n]),
             "fetched-at": T2Airtime::Util.format_time(ts)
+          },
+          relationships: {
+            operators: {
+              links: {
+                related: "/countries/#{id}/operators"
+              }
+            }
           }
-        }}
+        }}.as_json
     end
 
     def self.normalize(name)
@@ -81,23 +93,50 @@ module T2Airtime
         countries = T2Airtime::Country.take(country_qty).shuffle
         unless countries.empty?
           countries.flat_map{|country| (
-            reply = T2Airtime::API.api.operator_list(country[:aid])
-            reply.success? ? serialize(reply.data, qty) : []
+            reply = T2Airtime::API.api.operator_list(country["id"])
+            reply.success? ? serialize(reply.data, reply.headers[:date], qty) : []
           )}        
         end
     end    
 
-    def self.serialize(data, qty=nil)
+    def self.serialize(data, ts="#{Time.zone.now}", qty=nil)
+         return [] if data[:operator].nil?
          names = data[:operator].split(",") 
          ids = data[:operatorid].split(",")
          ids.take(qty.nil? ? ids.count : qty).each_with_index.map{|id, n| {
-           country: data[:country], 
-           country_aid: Integer(data[:countryid]),
-           alpha3: T2Airtime::Country.alpha3(data[:country]),
-           name: names[n], 
-           logo_url: T2Airtime::Util.operator_logo_url(id),
-           aid: Integer(id)
-         }}
+            type: "operators",
+            id: Integer(id),
+            attributes: {
+              "name": names[n], 
+              "fetched-at": T2Airtime::Util.format_time(ts)
+            },
+            links: {
+              logo: T2Airtime::Util.operator_logo_url(id)
+            },
+            relationships: {
+              country: {
+                data: { 
+                  type: "countries",
+                  id: Integer(data[:countryid])
+                }
+              },
+              products: {
+                links: {
+                  related: "/countries/#{data[:countryid]}/operators/#{id}/products"
+                }
+              }              
+            },
+            included: [
+              {
+                  type: "countries",
+                  id: Integer(data[:countryid]),
+                  attributes: {
+                    "name": data[:country],
+                    "alpha3": T2Airtime::Country.alpha3(data[:country])
+                  }                
+              }
+            ]            
+         }}.as_json
     end
     
   end
@@ -108,95 +147,174 @@ module T2Airtime
         operators = T2Airtime::Operator.take(operator_qty).shuffle
         unless operators.empty?
           operators.flat_map{|operator| (
-            reply = T2Airtime::API.api.product_list(operator[:aid])
-            reply.success? ? serialize(reply.data, qty) : []
+            reply = T2Airtime::API.api.product_list(operator["id"])
+            reply.success? ? serialize(reply.data, reply.headers[:date], qty) : []
           )}        
         end         
     end
 
-    def self.serialize(data, qty=nil)
+    def self.serialize(data, ts="#{Time.zone.now}", qty=nil)
+         return [] if data[:product_list].nil?
          currency = data[:destination_currency]
          retail_prices = data[:retail_price_list].split(",") 
          wholesale_prices = data[:wholesale_price_list].split(",")
          ids = data[:product_list].split(",")
          ids.take(qty.nil? ? ids.count : qty).each_with_index.map{|id, n| {
-           country: data[:country], 
-           country_aid: Integer(data[:countryid]),
-           alpha3: T2Airtime::Country.alpha3(data[:country]),
-           operator: data[:operator], 
-           operator_aid: Integer(data[:operatorid]),  
-           operator_logo_url: T2Airtime::Util.operator_logo_url(data[:operatorid]),         
-           name: "#{id}#{currency}", 
-           currency: currency,
-           local_price: Float(id),
-           retail_price: Float(retail_prices[n]),
-           wholesale_price: Float(wholesale_prices[n]),           
-           local_price_display: T2Airtime::Util.format_price(id, currency),
-           retail_price_display: T2Airtime::Util.format_price(retail_prices[n]),
-           wholesale_price_display: T2Airtime::Util.format_price(wholesale_prices[n]),
-           aid: Integer(id)
-         }}
+           type: "products",
+           id: Integer(id), 
+           attributes: {
+            "name": "#{id}#{currency}", 
+            "currency": currency,
+            "local-price": Float(id),
+            "retail-price": Float(retail_prices[n]),
+            "wholesale-price": Float(wholesale_prices[n]),           
+            "local-price-display": T2Airtime::Util.format_price(id, currency),
+            "retail-price-display": T2Airtime::Util.format_price(retail_prices[n]),
+            "wholesale-price-display": T2Airtime::Util.format_price(wholesale_prices[n]),
+            "fetched-at": T2Airtime::Util.format_time(ts)
+           },
+            relationships: {
+              country: {
+                data: { 
+                  type: "countries",
+                  id: Integer(data[:countryid])
+                }
+              },
+              operator: {
+                data: { 
+                  type: "operators",
+                  id: Integer(data[:operatorid])
+                }
+              }
+            },
+            included: [
+              {
+                  type: "countries",
+                  id: Integer(data[:countryid]),
+                  attributes: {
+                    "name": data[:country],
+                    "alpha3": T2Airtime::Country.alpha3(data[:country])
+                  }                
+              },
+              {
+                  type: "operators",
+                  id: Integer(data[:operatorid]),
+                  attributes: {
+                    "name": data[:operator]
+                  },
+                  links: {
+                    logo: T2Airtime::Util.operator_logo_url(data[:operatorid])
+                  }              
+              }
+            ]
+         }}.as_json
     end
 
   end  
 
   class Transaction
 
-    def self.take(start, stop, msisdn=nil, destination=nil, code=nil, qty=5)
-        reply = T2Airtime::API.api.trans_list(start, stop, msisdn, destination, code)
+    def self.take(start=(Time.now-24.hours), stop=Time.now, msisdn=nil, destination=nil, code=nil, qty=5)
+        reply = T2Airtime::API.api.transaction_list(start, stop, msisdn, destination, code)
         reply.success? ? serialize(reply.data, qty) : []
     end
       
     def self.serialize(data, qty=nil)
+      return [] if data[:transaction_list].nil?
       ids = data[:transaction_list].split(",")
-      ids.empty? ? {} : ids.take(qty.nil? ? ids.count : qty).each.map{ |id| show(id) }
+      ids.take(qty.nil? ? ids.count : qty).each.map{ |id| show(id) }
     end
 
 
     def self.show(id)
-        reply = T2Airtime::API.api.trans_info(id)
-        reply.success? ? serialize_one(reply.data) : {}
+        reply = T2Airtime::API.api.transaction_info(id)
+        reply.success? ? serialize_one(reply.data, reply.headers[:date]) : {}
     end
 
-    def self.serialize_one(t)
+    def self.serialize_one(data, ts="#{Time.zone.now}")
       {
-        id: Integer(t[:transactionid]),
-        msisdn: t[:msisdn],
-        destination_msisdn: t[:destination_msisdn],
-        transaction_authentication_key: t[:transaction_authentication_key],
-        transaction_error_code: Integer(t[:transaction_error_code]),
-        transaction_error_txt: t[:transaction_error_txt],
-        country: t[:country],
-        country_aid: Integer(t[:countryid]),
-        alpha3: T2Airtime::Country.alpha3(t[:country]),
-        operator: t[:operator],
-        operator_aid: Integer(t[:operatorid]),
-        operator_logo_url: T2Airtime::Util.operator_logo_url(t[:operatorid]),  
-        reference_operator: t[:reference_operator],
-        product_requested: t[:product_requested],
-        product_requested_display: T2Airtime::Util.format_price(t[:product_requested], t[:destination_currency]),
-        actual_product_sent: t[:actual_product_sent],
-        actual_product_sent_display: T2Airtime::Util.format_price(t[:actual_product_sent], t[:destination_currency]),
-        wholesale_price: t[:wholesale_price],
-        wholesale_price_display: T2Airtime::Util.format_price(t[:wholesale_price], t[:originating_currency]),
-        retail_price: t[:retail_price],
-        retail_price_display: T2Airtime::Util.format_price(t[:retail_price], t[:originating_currency]),
-        sms: t[:sms],
-        cid1: t[:cid1],
-        cid2: t[:cid2],
-        cid3: t[:cid3],
-        date: t[:date],
-        originating_currency: t[:originating_currency],
-        destination_currency: t[:destination_currency],
-        pin_based: t[:pin_based],
-        local_info_amount: t[:local_info_amount],
-        local_info_amount_display: T2Airtime::Util.format_price(t[:local_info_amount], t[:local_info_currency]),
-        local_info_currency: t[:local_info_currency],
-        local_info_value: t[:local_info_value],
-        local_info_value_display: T2Airtime::Util.format_price(t[:local_info_value], t[:local_info_currency]),
-        error_code: t[:error_code],
-        error_txt: t[:error_txt]
-      }
+        type: "transactions",
+        id: Integer(data[:transactionid]),
+        attributes: {
+          "msisdn": data[:msisdn],
+          "destination-msisdn": data[:destination_msisdn],
+          "transaction-authentication-key": data[:transaction_authentication_key],
+          "transaction-error-code": Integer(data[:transaction_error_code]),
+          "transaction-error-txt": data[:transaction_error_txt],
+          "reference-operator": data[:reference_operator],
+          "product-requested-display": T2Airtime::Util.format_price(data[:product_requested], data[:destination_currency]),
+          "actual-product-sent": data[:actual_product_sent],
+          "actual-product-sent-display": T2Airtime::Util.format_price(data[:actual_product_sent], data[:destination_currency]),          
+          "sms": data[:sms],
+          "cid1": data[:cid1],
+          "cid2": data[:cid2],
+          "cid3": data[:cid3],
+          "date": data[:date],
+          "originating-currency": data[:originating_currency],
+          "destination-currency": data[:destination_currency],
+          "pin-based": data[:pin_based],
+          "local-info-amount": data[:local_info_amount],
+          "local-info-amount-display": T2Airtime::Util.format_price(data[:local_info_amount], data[:local_info_currency]),
+          "local-info-currency": data[:local_info_currency],
+          "error-code": data[:error_code],
+          "error-txt": data[:error_txt],
+          "fetched-at": T2Airtime::Util.format_time(ts)
+        },
+        relationships: {
+          country: {
+            data: { 
+              type: "countries",
+              id: Integer(data[:countryid])
+            }
+          },
+          operator: {
+            data: { 
+              type: "operators",
+              id: Integer(data[:operatorid])
+            }
+          },
+          product: {
+            data: { 
+              type: "products",
+              id: Integer(data[:product_requested])
+            }
+          }
+        },
+        included: [
+          {
+              type: "countries",
+              id: Integer(data[:countryid]),
+              attributes: {
+                "name": data[:country],
+                "alpha3": T2Airtime::Country.alpha3(data[:country])
+              }                
+          },
+          {
+              type: "operators",
+              id: Integer(data[:operatorid]),
+              attributes: {
+                "name": data[:operator]
+              },
+              links: {
+                logo: T2Airtime::Util.operator_logo_url(data[:operatorid])
+              }               
+          },
+          {
+              type: "products",
+              id: Integer(data[:product_requested]),
+              attributes: {
+                "name": "#{data[:product_requested]}#{data[:destination_currency]}",
+                "currency": data[:destination_currency],
+                "wholesale-price": data[:wholesale_price],
+                "wholesale-price-display": T2Airtime::Util.format_price(data[:wholesale_price], data[:originating_currency]),
+                "retail-price": data[:retail_price],
+                "retail-price-display": T2Airtime::Util.format_price(data[:retail_price], data[:originating_currency]),
+                "local-price": data[:local_info_value],
+                "local-price-display": T2Airtime::Util.format_price(data[:local_info_value], data[:local_info_currency])
+              }              
+          }
+        ]
+      }.as_json
     end
 
 

data/lib/t2_airtime/version.rb

@@ -1,3 +1,3 @@
 module T2Airtime
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/release

@@ -4,3 +4,4 @@ set -e
 git add .
 git commit -am "Bump to v${0}"
 git push origin master
+gem release

data/t2_airtime.gemspec

@@ -25,7 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
-  spec.add_runtime_dependency 'dotenv-rails', '~> 2.2', '>= 2.2.1'
+  spec.add_dependency 'rails', '~> 5.1.3'
+  spec.add_runtime_dependency 'dotenv-rails', '~> 2.2', '>= 2.2.1'  
   spec.add_dependency "faraday", "0.9.1"
   spec.add_dependency "countries", "2.1.2"
   spec.add_dependency "money", "6.9.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: t2_airtime
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - matteolc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2017-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
 - !ruby/object:Gem::Dependency
   name: dotenv-rails
   requirement: !ruby/object:Gem::Requirement