gvive 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f150a770738b0094810f0822cdd64b28353875e
-  data.tar.gz: be2426747f4a084c0a6ade7ac646afe31f80fce6
+  metadata.gz: 2eaf74e4921bc1ab21759c460a8655c350df6e07
+  data.tar.gz: '0954b56a1456ca6452ff48933d45758a15ec803d'
 SHA512:
-  metadata.gz: 3c37d011e68a97d21970f550a71874d2b59687fc5b4d7239e214f3870a0c5cb1d3e27738fc0f4cd103f6af311ba03bfa305161a02eb381a8453303141737aa8a
-  data.tar.gz: 3003aec8f51e6f040ada1a1ccfc7cc30f9cdadd8b0132f694f24a33897629d4dccda02cd605c72bbb1f47410ec08778738f1959b99d2de636d204058c6c98466
+  metadata.gz: 94186cf9843777f5cf64659ae294b9b39ba7d29e81b7d2cdb6e904c29042436344d3998011f9b6afec6483bd646d739c9f00fd77cfb0e5632b2d293f512d32ed
+  data.tar.gz: c514974adf452accf88b8412c08f7dc2c59a0d85e3b5535856bae876c23c7f5164246c20cc4b7e7cf779955db665ac1027eee6a1b405d124bdd4e58e55fb0b9a

data/README.md

@@ -1,4 +1,5 @@
-[![Code Climate](https://codeclimate.com/github/nukturnal/gvive/badges/gpa.svg)](https://codeclimate.com/github/nukturnal/gvive) [![Build Status](https://travis-ci.org/nukturnal/gvive.svg?branch=master)](https://travis-ci.org/nukturnal/gvive)
+[![Gem Version](https://badge.fury.io/rb/gvive.svg)](https://badge.fury.io/rb/gvive) [![Code Climate](https://codeclimate.com/github/nukturnal/gvive/badges/gpa.svg)](https://codeclimate.com/github/nukturnal/gvive) [![Build Status](https://travis-ci.org/nukturnal/gvive.svg?branch=master)](https://travis-ci.org/nukturnal/gvive) [![Test Coverage](https://codeclimate.com/github/nukturnal/gvive/badges/coverage.svg)](https://codeclimate.com/github/nukturnal/gvive/coverage) [![Issue Count](https://codeclimate.com/github/nukturnal/gvive/badges/issue_count.svg)](https://codeclimate.com/github/nukturnal/gvive) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/7425ac54e6484723a5482a92fc7f35ef)](https://www.codacy.com/app/nukturnal/gvive?utm_source=github.com&utm_medium=referral&utm_content=nukturnal/gvive&utm_campaign=Badge_Grade) [![codebeat badge](https://codebeat.co/badges/33b4fac4-6c7b-4176-95e0-f6fd56f74d59)](https://codebeat.co/projects/github-com-nukturnal-gvive-master)
+
 # GVIVE Ruby SDK
 
 This gem is a wrapper around GVIVE Identity Verification API offered at https://gvivegh.com/ by Bsystems Limited Ghana. The SDK currently supports Voter ID, Passport & Driver License verifications.

data/lib/gvive/identities.rb

@@ -2,7 +2,28 @@ module GVIVE
   class Identities
     include GVIVE::Utils
 
-    attr_accessor :data, :response
+    attr_accessor :data, :response, :id, :photo, :signature
+
+    # Identity classes have 3 common requirements
+    # - ID to search
+    # - Option to return a Base64Encoded Image of the ID
+    # - Option to return a Base64Encoded Signature of the ID
+    # Optionally specify whether you want to return a Base64Encoded Photo
+    # Optionally specify whether you want to return a Base64Encoded Signature
+    # @param [String] id
+    # @param [Boolean] photo
+    # @param [Boolean] signature
+    def initialize(id, photo = false, signature = false)
+      @id = id
+      @photo = photo
+      @signature = signature
+    end
+
+    # Automatically merge photo & signature into the request
+    # We don't want to repeat this across all subclasses :)
+    def id_params(params = {})
+      params.merge(incp: @photo, incs: @signature)
+    end
 
     # Implement this method in subclass
     # Validate Identity with GVIVE Web Service

data/lib/gvive/identity/driver.rb

@@ -1,20 +1,26 @@
+require 'cgi'
+
 module GVIVE
   module Identity
     class Driver < GVIVE::Identities
-      attr_accessor :coc, :fullname
+      attr_accessor :fullname
 
       # Certificate of Competence required
       # Fullname of card holder as it appears on the card
+      # Optionally specify whether you want to return a Base64Encoded Photo
+      # Optionally specify whether you want to return a Base64Encoded signature
       # @param [String] coc
       # @param [String] fullname
-      def initialize(coc, fullname)
-        @coc = coc
+      # @param [Boolean] photo
+      # @param [Boolean] signature
+      def initialize(coc, fullname, photo = false, signature = false)
+        super(coc, photo, signature)
         @fullname = fullname
       end
 
       # Implementing valid? method signature as described in Identity Class
       def valid?
-        @response = gvive_request(driver_endpoint, { coc: @coc, fname: @fullname })
+        @response = gvive_request(driver_endpoint, id_params({ coc: @id, fname: @fullname}))
         @data = @response.to_o
         @response.success?
       end

data/lib/gvive/identity/passport.rb

@@ -1,17 +1,20 @@
 module GVIVE
   module Identity
     class Passport < GVIVE::Identities
-      attr_accessor :passport_id
 
       # Passport ID number required
+      # Optionally specify whether you want to return a Base64Encoded Photo
+      # Optionally specify whether you want to return a Base64Encoded signature
       # @param [String] passport_id
-      def initialize(passport_id)
-        @passport_id = passport_id
+      # @param [Boolean] photo
+      # @param [Boolean] signature
+      def initialize(passport_id, photo = false, signature = false)
+        super(passport_id, photo, signature)
       end
 
       # Implementing valid? method signature as described in Identity Class
       def valid?
-        @response = gvive_request(passport_endpoint, { pid: @passport_id })
+        @response = gvive_request(passport_endpoint, id_params({ pid: @id }))
         @data = @response.to_o
         @response.success?
       end

data/lib/gvive/identity/voter.rb

@@ -1,17 +1,24 @@
 module GVIVE
   module Identity
     class Voter < GVIVE::Identities
-      attr_accessor :voter_id
 
       # Voter ID number required
+      # Optionally specify whether you want to return a Base64Encoded Photo
       # @param [String] voter_id
-      def initialize(voter_id)
-        @voter_id = voter_id
+      # @param [Boolean] photo
+      def initialize(voter_id, photo = false)
+        super(voter_id, photo)
       end
 
       # Implementing valid? method signature as described in Identity Class
       def valid?
-        @response = gvive_request(voter_endpoint, { vid: @voter_id })
+        params = id_params({ vid: @id })
+        
+        # Voter ID does not include signature photo request
+        # Let's remove this from the API request call
+        params.delete(:incs)
+
+        @response = gvive_request(voter_endpoint, params)
         @data = @response.to_o
         @response.success?
       end

data/lib/gvive/version.rb

@@ -1,3 +1,3 @@
 module GVIVE
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gvive
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alfred Rowe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-28 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler