airvend 0.1.0

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/airvend.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/airvend/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "airvend"
+  spec.version       = Airvend::VERSION
+  spec.authors       = ["Uchenna Mba"]
+  spec.email         = ["hey@uche.io"]
+
+  spec.summary       = "Gem that provides access to bill payment & subscription in Nigeria."
+  spec.description   = "This gem makes it easy for businesses or individuals to implement vending of Airtime, Data, Electricity, Utilities & Television subscriptions to their application"
+  spec.homepage      = "https://github.com/urchymanny/airvend-rails"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_development_dependency 'dotenv-rails'
+  spec.add_development_dependency 'byebug'
+  spec.add_dependency 'httparty', '~> 0.18'
+  spec.add_dependency 'json', '~> 2.5'
+  spec.add_dependency 'faraday', '~> 1.4'
+  spec.add_dependency 'faraday-detailed_logger', '~> 2.3'
+  spec.add_dependency 'typhoeus', '~> 1.4'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "airvend"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "byebug"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/airvend.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+# require_relative "airvend/version"
+require "dotenv"
+require 'json'
+require 'digest'
+require 'airvend/vend.rb'
+require 'airvend/base_endpoints.rb'
+require 'airvend/errors.rb'
+require 'airvend/upper_case_string.rb'
+require 'airvend/airvend_objects/airtime.rb'
+require 'airvend/airvend_objects/internet.rb'
+require 'airvend/airvend_objects/power.rb'
+require 'airvend/airvend_objects/television.rb'
+
+Dotenv.load(File.expand_path("../.env", __FILE__))
+
+class Airvend
+  attr_accessor :username, :password, :api_key, :production, :url
+
+  def initialize(username=nil, password=nil, api_key=nil, production=false)
+
+    @username = username
+    @password = password
+    @api_key = api_key
+    @production = production
+    sandbox_url = BASE_ENDPOINTS::SANDBOX_URL
+    live_url = BASE_ENDPOINTS::LIVE_URL
+
+    if (ENV['RAILS_ENV'].nil?)
+      @production = production
+      warn "Warning: Make sure you set RAILS_ENV to production or development"
+    else
+      if ENV['RAILS_ENV'] == "production"
+        @production=true
+      else
+        @prodcution=false
+      end
+    end
+
+    # set rave url to sandbox or live if we are in production or development
+    if production == false
+        @url = sandbox_url
+    else
+        @url = live_url
+    end
+
+    # check if we set our public and secret keys to the environment variable
+    if (username.nil? && password.nil?)
+      @username = ENV['AIRVEND_USERNAME']
+      @password = ENV['AIRVEND_PASSWORD']
+    else
+      @username = username
+      @password = password
+      warn "Warning: To ensure your account credentials are safe, It is best to always set your password in the environment variable with AIRVEND_USERNAME & AIRVEND_PASSWORD"
+    end
+
+    # raise this error if no username is passed
+    unless !@username.nil?
+      raise AirvendBadUserError, "No Username supplied and couldn't find any in environment variables. Make sure to set public key as an environment variable AIRVEND_USERNAME"
+    end
+
+    # raise this error if no password is passed
+    unless !@password.nil?
+      raise AirvendBadPassError, "No password supplied and couldn't find any in environment variables. Make sure to set secret key as an environment variable AIRVEND_PASSWORD"
+    end
+
+
+    if (api_key.nil?)
+      @api_key = ENV['AIRVEND_API_KEY']
+    else
+      @api_key = api_key
+      warn "Warning: To ensure your account key is safe, It is best to always set your password in the environment variable with AIRVEND_API_KEY"
+    end
+
+    # raise this error if no username is passed
+    unless !@api_key.nil?
+      raise AirvendBadKeyError, "No Api Key supplied and couldn't find any in environment variables. Make sure to set public key as an environment variable AIRVEND_USERNAME"
+    end
+  end
+
+  # method to return the base url
+  def base_url
+    return url
+  end
+
+  def headers(hashkey)
+    return {
+    	UpperCaseString.new('Content-Type') => 'application/json',
+      UpperCaseString.new('username') => self.username,
+      UpperCaseString.new('password') => self.password,
+      UpperCaseString.new('hash') => hashkey,
+      user_agent: "Airvend-0.1.0"
+    }
+  end
+
+  def hash_req(details)
+    api_hash = details.to_json+self.api_key
+    api_hash = Digest::SHA512.hexdigest api_hash
+    return api_hash
+  end
+
+
+
+end

data/lib/airvend/airvend_objects/airtime.rb

@@ -0,0 +1,28 @@
+require "airvend/base/base.rb"
+include Vend
+
+class Vend::Airtime < Base
+
+  def buy(payload)
+		params_hash = { 'ref'=> payload[:ref], 'account'=> payload[:phone], 'networkid'=> mno_id(payload[:mno]), 'type'=> "1", 'amount'=> payload[:amount] }
+		details = {}
+		details.merge!({ 'details'=>params_hash })
+		api_hash = @airvendObj.hash_req(details)
+		response = vendAdapter(api_hash, details)
+		if response.status == 200
+      hash = rename_hash(JSON.parse(response.body, { symbolize_names: true }))
+      rename_hash(hash[:details])
+      hash
+    else
+      produce_error(response)
+    end
+	end
+
+end
+
+
+# input = [ref: "usdibisdbsidbsd", mno = "MTN", amount]
+# Dotenv.load(File.expand_path("../.env", __FILE__))
+# a = Airvend.new
+# airtime = Vend::Airtime.new(Airvend.new)
+# payload =  { ref: "YOUR-OWN-REF-HERE", account: "08138236694", mno: "mtn", amount: "200"}

data/lib/airvend/airvend_objects/internet.rb

@@ -0,0 +1,45 @@
+require "airvend/base/base.rb"
+include Vend
+
+class Vend::Internet < Base
+
+  def buy(payload)
+		params_hash = { 'ref'=> payload[:ref], 'account'=> payload[:phone], 'networkid'=> mno_id(payload[:mno]), 'type'=> "2", 'amount'=> payload[:code] }
+		details = {}
+		details.merge!({ 'details'=>params_hash })
+		api_hash = @airvendObj.hash_req(details)
+		response = vendAdapter(api_hash, details)
+		if response.status == 200
+      hash = rename_hash(JSON.parse(response.body, { symbolize_names: true }))
+      rename_hash(hash[:details])
+      hash
+    else
+      produce_error(response)
+    end
+	end
+
+  def plans(provider)
+    data = serialize_plans(get_plans(provider_id(provider), "2")[:details][:message])
+  end
+
+  def serialize_plans(plans)
+    plans.sort_by{|e| e[:amount].to_i}.each do |bundle|
+      if bundle[:validity] == nil
+         bundle[:validity] = "Unlimited"
+      elsif bundle[:validity].include? 'Day'
+        bundle[:validity].insert(0, " for ")
+        bundle[:validity]['Day'] = ' Day'
+      elsif bundle[:validity].include? 'Hours'
+        bundle[:validity].insert(0, " for ")
+        bundle[:validity]['Hours'] = ' Hours'
+      elsif bundle[:validity].include? 'Month'
+        bundle[:validity].insert(0, " for ")
+        bundle[:validity]['Month'] = ' Month'
+      elsif bundle[:validity].include? 'Year'
+        bundle[:validity].insert(0, " for ")
+        bundle[:validity]['Year'] = ' Year'
+      end
+    end
+  end
+
+end

data/lib/airvend/airvend_objects/power.rb

@@ -0,0 +1,26 @@
+require "airvend/base/base.rb"
+include Vend
+
+class Vend::Power < Base
+
+  def buy(payload)
+    params_hash = { 'ref'=> payload[:ref], 'account'=> payload[:account], 'type'=> power_id(payload[:provider], payload[:account_type]), 'amount'=> payload[:amount], 'customernumber'=> payload[:customernumber]  }
+		details = {}
+		details.merge!({ 'details'=>params_hash })
+		api_hash = @airvendObj.hash_req(details)
+		resp = vendAdapter(api_hash, details)
+		if resp.status == 200
+      hash = rename_hash(JSON.parse(response.body, { symbolize_names: true }))
+      rename_hash(hash[:details])
+      hash
+    else
+      produce_error(response)
+    end
+  end
+
+  def verify(payload)
+    product_type = power_id(payload[:provider], payload[:account_type])
+    verify_customer(product_type, payload[:account])[:details][:message]
+  end
+
+end

data/lib/airvend/airvend_objects/television.rb

@@ -0,0 +1,29 @@
+require "airvend/base/base.rb"
+include Vend
+
+class Vend::Television < Base
+
+  def buy(payload)
+    params_hash = { 'ref'=> payload[:ref], 'account'=> payload[:account], 'type'=> tv_id(payload[:provider]), 'amount'=> payload[:amount], 'customernumber'=> payload[:customernumber], 'invoicePeriod'=>"1" }
+		details = {}
+		details.merge!({ 'details'=>params_hash })
+		api_hash = @airvendObj.hash_req(details)
+		resp = vendAdapter(api_hash, details)
+		if resp.status == 200
+      hash = rename_hash(JSON.parse(response.body, { symbolize_names: true }))
+      rename_hash(hash[:details])
+      hash
+    else
+      produce_error(response)
+    end
+  end
+
+  def verify(payload)
+    verify_customer(tv_id(payload[:provider]), payload[:account])[:details][:message]
+  end
+
+  def plans(provider)
+    plans = get_plans("", tv_id(provider))[:details][:message]
+    new_plans = plans.each { |p| p.delete(:descrition); p[:description] = p.delete :name; p[:amount] = p[:amount].to_s}
+  end
+end

data/lib/airvend/base/base.rb

@@ -0,0 +1,180 @@
+require 'faraday'
+require 'faraday/detailed_logger'
+require 'typhoeus'
+class Base
+  def initialize(airvendObj)
+    @airvendObj = airvendObj
+  end
+
+  def connect(api_hash)
+    conn = Faraday.new(:url => @airvendObj.base_url, :headers => @airvendObj.headers(api_hash)) do |faraday|
+      faraday.request  :url_encoded
+      faraday.response :detailed_logger
+      faraday.adapter  :typhoeus
+    end
+    return conn
+  end
+
+
+  def produce_error(response)
+    status = response.status
+    if status == 400
+      raise AirvendBadRequestError, "There's something wrong with this request - #{response.status}"
+    elsif status == 401
+      raise AirvendUnauthorizedError, "You're not authorized to access this resource - #{response.status}"
+    elsif status == 404
+      raise AirvendNotFoundError, "The resource could not be found - #{response.status}"
+    elsif status == 409
+      raise AirvendConflictError, "The Reference you provided already exists, please use unique reference IDs for every transaction - #{response.status}"
+    elsif status == 417
+      raise AirvendIncorrectPayload, "Please confirm that your payload data is correct and standard - #{response.status}"
+    elsif (400..451).member?(status)
+      raise AirvendUnknownClientError, "Please send an email to hey@uche.io explaining how you got this error - #{response.status}"
+    elsif (500..511).member?(status)
+      raise AirvendServerError.new(response.body)
+    end
+  end
+
+  def rename_hash(hash)
+    hash.keys.each do |a|
+      hash[underscorelize(a.to_s).to_sym] = hash.delete a
+    end
+    hash
+  end
+
+  def underscorelize(text)
+    text.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+
+  def get_plans(provider, product_type)
+    params_hash = { 'networkid'=> provider, 'type'=> product_type }
+		details = {}
+		details.merge!({ 'details'=>params_hash })
+		api_hash = @airvendObj.hash_req(details)
+		begin
+			response = productAdapter(api_hash, details)
+		rescue
+			return response
+		else
+      hash = rename_hash(JSON.parse(response.body, { symbolize_names: true }))
+      details = rename_hash(hash[:details])
+      details[:message].each do |d|
+        rename_hash(d)
+      end
+      hash
+		end
+  end
+
+  def verify_customer(product_type, account_id)
+		params_hash = { 'type'=> product_type, 'account'=> account_id }
+		details = {}
+		details.merge!({ 'details'=>params_hash })
+		api_hash = @airvendObj.hash_req(details)
+		begin
+			response = verifyAdapter(api_hash, details)
+		rescue
+			return response
+		else
+			if response.status == 200
+        hash = rename_hash(JSON.parse(response.body, { symbolize_names: true }))
+        rename_hash(hash[:details])
+        hash
+      else
+        produce_error(response)
+			end
+		end
+	end
+
+  def mno_id(mno)
+    case mno.downcase
+    when "mtn"
+      2
+    when "airtel"
+      1
+    when "glo"
+      3
+    when "9mobile"
+      4
+    else
+      raise AirvendInvalidProvider, "Invalid Mobile Network Operator, mno can only be 'mtn', 'glo', 'airtel' or '9mobile'"
+    end
+  end
+
+  def provider_id(mno)
+    case mno.downcase
+    when "mtn"
+      2
+    when "airtel"
+      1
+    when "glo"
+      3
+    when "9mobile"
+      4
+    else
+      raise AirvendInvalidProvider, "Invalid Mobile Network Operator, mno can only be 'mtn', 'glo', 'airtel' or '9mobile'"
+    end
+  end
+
+  def power_id(account, account_type)
+    x = account.upcase
+    y = account_type.upcase
+    if x == "IE"
+      if y == "POSTPAID"
+        return "10"
+      elsif y == "PREPAID"
+        return "11"
+      end
+    elsif x == "EKO"
+      if y == "POSTPAID"
+        return "13"
+      elsif y == "PREPAID"
+        return "14"
+      end
+    elsif x == "PHED"
+      if y == "POSTPAID"
+        return "15"
+      elsif y == "PREPAID"
+        return "16"
+      end
+    elsif x == "EEDC"
+      if y == "POSTPAID"
+        return "22"
+      elsif y == "PREPAID"
+        return "21"
+      end
+    elsif x == "KEDCO"
+      return "20"
+    elsif x == "AEDC"
+      if y == "POSTPAID"
+        return "25"
+      elsif y == "PREPAID"
+        return "24"
+      end
+    elsif x == "IBEDC"
+      if y == "POSTPAID"
+        return "12"
+      elsif y == "PREPAID"
+        return "11"
+      end
+    else
+      raise AirvendInvalidProvider, "Invalid Power Provider, see documentation: https://github.com/urchymanny/airvend-ruby#electricity-vending"
+    end
+  end
+
+  def tv_id(provider)
+    case provider.downcase
+    when "dstv"
+      30
+    when "gotv"
+      40
+    when "startimes"
+      70
+    else
+      raise AirvendInvalidProvider, "Invalid Power Provider, see documentation: https://github.com/urchymanny/airvend-ruby#electricity-vending"
+    end
+  end
+end