Paystack::genTranxRef() - Code Metrics - Inspection of "chore(paystack): Rename PaystackFacade to Paystack" - unicodeveloper/laravel-paystack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f4bf0d...a0a0f8 )

by PROSPER

created 2016-02-01 05:50 UTC

Paystack::genTranxRef() B

↳ Parent: Paystack

Complexity

Conditions	2
Paths	2

Size

Total Lines	28
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
dl	0
loc	28
rs	8.8571
c	2
b	0
f	0
cc	2
eloc	6
nc	2
nop	0

<?php

namespace Unicodeveloper\Paystack;

use GuzzleHttp\Client;
use Ramsey\Uuid\Uuid;
use Ramsey\Uuid\Exception\UnsatisfiedDependencyException;

class Paystack {

    /**
     * Transaction Verification Successful
     */
    const VS = 'Verification successful';

    /**
     *  Invalid Transaction reference
     */
    const ITF = "Invalid transaction reference";

    /**
     * Issue Secret Key from your Paystack Dashboard
     * @var mixed
     */
    protected $secretKey;

    /**
     * Instance of Client
     * @var object
     */
    protected $client;

    /**
     *  Response from requests made to Paystack
     * @var mixed
     */
    protected $response;

    /**
     * Paystack API base Url
     * @var string
     */
    protected $baseUrl;

    /**
     * Authorization Url - Paystack payment page
     * @var string
     */
    protected $authorizationUrl;

    public function __construct()
    {
        $this->setKey();
        $this->setBaseUrl();
        $this->setRequestOptions();
    }

    /**
     * Get Base Url from Paystack config file
     */
    public function setBaseUrl()
    {
        $this->baseUrl = config('paystack.paymentUrl');
    }

    /**
     * Get secret key from Paystack config file
     * @return  void
     */
    public function setKey()
    {
        $this->secretKey = config('paystack.secretKey');
    }

    /**
     * Set options for making the Client request
     * @return  void
     */
    private function setRequestOptions()
    {
        $authBearer = 'Bearer '. $this->secretKey;

        $this->client = new Client(['base_uri' => $this->baseUrl]);

        $this->client->setDefaultOption('headers', [
            'Authorization' => $authBearer,
            'Content-Type'  => 'application/json',
            'Accept'        => 'application/json'
        ]);
    }

    /**
     * Initiate a payment request to Paystack
     * @return Unicodeveloper\Paystack\Paystack
     */
    public function makePaymentRequest()
    {
        $this->setResponse('/transaction/initialize');

        return $this;
    }

    /**
     * Make the client request and get the response
     * @param string $relativeUrl
     * @return Unicodeveloper\Paystack\Paystack
     */
    public function setResponse($relativeUrl)
    {
        $data = [
            "amount" => intval(request()->amount),
            "reference" => request()->reference,
            "email" => request()->email
        ];

        $this->response = $this->client->post($this->baseUrl . $relativeUrl, [
            'body' => json_encode($data)
        ]);

        return $this;
    }

    /**
     * Get the authorization url from the callback response
     * @return Unicodeveloper\Paystack\Paystack
     */
    public function getAuthorizationUrl()
    {
        $this->makePaymentRequest();

        $this->url = $this->response->json()["data"]["authorization_url"];
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this;
    }

    /**
     * Hit Paystack Gateway to Verify that the transaction is valid
     * @return void
     */
    private function verifyTransactionAtGateway()
    {
        $transactionRef = request()->query('trxref');

        $relativeUrl = "/transaction/verify/{$transactionRef}";

        $this->response = $this->client->get($this->baseUrl . $relativeUrl, []);
    }

    /**
     * True or false condition whether the transaction is verified
     * @return boolean
     */
    public function isTransactionVerificationValid()
    {
        $this->verifyTransactionAtGateway();

        $result = $this->response->json()["message"];

        switch($result)
        {
            case self::VS:
                $validate = true;
                break;
            case self:ITF:
                $validate = false;
                break;
            default:
                $validate = false;
                break;
        }

        return $validate;
    }

    /**
     * Get Payment details if the transaction was verified successfully
     * @throws Unicodeveloper\Paystack\Exceptions\PaymentVerificationFailedException
     * @return json
     */
    public function getPaymentData()
    {
        if($this->isTransactionVerificationValid()) {
            return $this->response->json();
        } else {
            throw new PaymentVerificationFailedException("Invalid Transaction Reference");
        }
    }

    /**
     * Fluent method to redirect to Paystack Payment Page
     * @return Illuminate\Support\Redirect
     */
    public function redirectNow()
    {
        return redirect($this->url);
    }

    /**
     * Get Access code from transaction callback respose
     * @return string
     */
    public function getAccessCode()
    {
        return $this->response->json()["data"]["access_code"];
    }

    /**
     * Generate a Unique Transaction Reference
     * @return string
     */
    public function genTranxRef()
    {
        try {

                // Generate a version 1 (time-based) UUID object
                $uuid1 = Uuid::uuid1();
                echo $uuid1->toString() . "\n"; // i.e. e4eaaaf2-d142-11e1-b3e4-080027620cdd

                // // Generate a version 3 (name-based and hashed with MD5) UUID object
                // $uuid3 = Uuid::uuid3(Uuid::NAMESPACE_DNS, 'php.net');

                // echo $uuid3->toString() . "\n"; // i.e. 11a38b9a-b3da-360f-9353-a5a725514269


                // // Generate a version 4 (random) UUID object
                // $uuid4 = Uuid::uuid4();

                // echo $uuid4->toString() . "\n"; // i.e. 25769c6c-d34d-4bfe-ba98-e0ee856f3e7a


                // // Generate a version 5 (name-based and hashed with SHA1) UUID object
                // $uuid5 = Uuid::uuid5(Uuid::NAMESPACE_DNS, 'php.net');

                // echo $uuid5->toString() . "\n"; // i.e. c4a760a8-dbcf-5254-a0d9-6a4474bd1b62


        } catch (UnsatisfiedDependencyException $e) {

            // Some dependency was not met. Either the method cannot be called on a
            // 32-bit system, or it can, but it relies on Moontoast\Math to be present.
            echo 'Caught exception: ' . $e->getMessage() . "\n";

        }
    }
}

1			<?php
2
3			namespace Unicodeveloper\Paystack;
4
5			use GuzzleHttp\Client;
6			use Ramsey\Uuid\Uuid;
7			use Ramsey\Uuid\Exception\UnsatisfiedDependencyException;
8
9			class Paystack {
10
11			/**
12			* Transaction Verification Successful
13			*/
14			const VS = 'Verification successful';
15
16			/**
17			* Invalid Transaction reference
18			*/
19			const ITF = "Invalid transaction reference";
20
21			/**
22			* Issue Secret Key from your Paystack Dashboard
23			* @var mixed
24			*/
25			protected $secretKey;
26
27			/**
28			* Instance of Client
29			* @var object
30			*/
31			protected $client;
32
33			/**
34			* Response from requests made to Paystack
35			* @var mixed
36			*/
37			protected $response;
38
39			/**
40			* Paystack API base Url
41			* @var string
42			*/
43			protected $baseUrl;
44
45			/**
46			* Authorization Url - Paystack payment page
47			* @var string
48			*/
49			protected $authorizationUrl;
50
51			public function __construct()
52			{
53			$this->setKey();
54			$this->setBaseUrl();
55			$this->setRequestOptions();
56			}
57
58			/**
59			* Get Base Url from Paystack config file
60			*/
61			public function setBaseUrl()
62			{
63			$this->baseUrl = config('paystack.paymentUrl');
64			}
65
66			/**
67			* Get secret key from Paystack config file
68			* @return void
69			*/
70			public function setKey()
71			{
72			$this->secretKey = config('paystack.secretKey');
73			}
74
75			/**
76			* Set options for making the Client request
77			* @return void
78			*/
79			private function setRequestOptions()
80			{
81			$authBearer = 'Bearer '. $this->secretKey;
82
83			$this->client = new Client(['base_uri' => $this->baseUrl]);
84
85			$this->client->setDefaultOption('headers', [
86			'Authorization' => $authBearer,
87			'Content-Type' => 'application/json',
88			'Accept' => 'application/json'
89			]);
90			}
91
92			/**
93			* Initiate a payment request to Paystack
94			* @return Unicodeveloper\Paystack\Paystack
95			*/
96			public function makePaymentRequest()
97			{
98			$this->setResponse('/transaction/initialize');
99
100			return $this;
101			}
102
103			/**
104			* Make the client request and get the response
105			* @param string $relativeUrl
106			* @return Unicodeveloper\Paystack\Paystack
107			*/
108			public function setResponse($relativeUrl)
109			{
110			$data = [
111			"amount" => intval(request()->amount),
112			"reference" => request()->reference,
113			"email" => request()->email
114			];
115
116			$this->response = $this->client->post($this->baseUrl . $relativeUrl, [
117			'body' => json_encode($data)
118			]);
119
120			return $this;
121			}
122
123			/**
124			* Get the authorization url from the callback response
125			* @return Unicodeveloper\Paystack\Paystack
126			*/
127			public function getAuthorizationUrl()
128			{
129			$this->makePaymentRequest();
130
131			$this->url = $this->response->json()["data"]["authorization_url"];
			0 ignored issues – show Bug introduced 2016-01-30 20:32 UTC by Report Bug Copy Issue Report The property `url` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
132
133			return $this;
134			}
135
136			/**
137			* Hit Paystack Gateway to Verify that the transaction is valid
138			* @return void
139			*/
140			private function verifyTransactionAtGateway()
141			{
142			$transactionRef = request()->query('trxref');
143
144			$relativeUrl = "/transaction/verify/{$transactionRef}";
145
146			$this->response = $this->client->get($this->baseUrl . $relativeUrl, []);
147			}
148
149			/**
150			* True or false condition whether the transaction is verified
151			* @return boolean
152			*/
153			public function isTransactionVerificationValid()
154			{
155			$this->verifyTransactionAtGateway();
156
157			$result = $this->response->json()["message"];
158
159			switch($result)
160			{
161			case self::VS:
162			$validate = true;
163			break;
164			case self:ITF:
165			$validate = false;
166			break;
167			default:
168			$validate = false;
169			break;
170			}
171
172			return $validate;
173			}
174
175			/**
176			* Get Payment details if the transaction was verified successfully
177			* @throws Unicodeveloper\Paystack\Exceptions\PaymentVerificationFailedException
178			* @return json
179			*/
180			public function getPaymentData()
181			{
182			if($this->isTransactionVerificationValid()) {
183			return $this->response->json();
184			} else {
185			throw new PaymentVerificationFailedException("Invalid Transaction Reference");
186			}
187			}
188
189			/**
190			* Fluent method to redirect to Paystack Payment Page
191			* @return Illuminate\Support\Redirect
192			*/
193			public function redirectNow()
194			{
195			return redirect($this->url);
196			}
197
198			/**
199			* Get Access code from transaction callback respose
200			* @return string
201			*/
202			public function getAccessCode()
203			{
204			return $this->response->json()["data"]["access_code"];
205			}
206
207			/**
208			* Generate a Unique Transaction Reference
209			* @return string
210			*/
211			public function genTranxRef()
212			{
213			try {
214
215			// Generate a version 1 (time-based) UUID object
216			$uuid1 = Uuid::uuid1();
217			echo $uuid1->toString() . "\n"; // i.e. e4eaaaf2-d142-11e1-b3e4-080027620cdd
218
219			// // Generate a version 3 (name-based and hashed with MD5) UUID object
220			// $uuid3 = Uuid::uuid3(Uuid::NAMESPACE_DNS, 'php.net');
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-01 05:54 UTC by Report Bug Copy Issue Report `48%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
221			// echo $uuid3->toString() . "\n"; // i.e. 11a38b9a-b3da-360f-9353-a5a725514269
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-01 05:54 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
222
223			// // Generate a version 4 (random) UUID object
224			// $uuid4 = Uuid::uuid4();
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-01 05:54 UTC by Report Bug Copy Issue Report `46%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
225			// echo $uuid4->toString() . "\n"; // i.e. 25769c6c-d34d-4bfe-ba98-e0ee856f3e7a
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-01 05:54 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
226
227			// // Generate a version 5 (name-based and hashed with SHA1) UUID object
228			// $uuid5 = Uuid::uuid5(Uuid::NAMESPACE_DNS, 'php.net');
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-01 05:54 UTC by Report Bug Copy Issue Report `48%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
229			// echo $uuid5->toString() . "\n"; // i.e. c4a760a8-dbcf-5254-a0d9-6a4474bd1b62
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-01 05:54 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
230
231			} catch (UnsatisfiedDependencyException $e) {
232
233			// Some dependency was not met. Either the method cannot be called on a
234			// 32-bit system, or it can, but it relies on Moontoast\Math to be present.
235			echo 'Caught exception: ' . $e->getMessage() . "\n";
236
237			}
238			}
239			}

unicodeveloper / laravel-paystack

Push — master ( f4bf0d...a0a0f8 )

Paystack::genTranxRef() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like