Completed
Push — master ( 755bc1...aa8750 )
by Elf
03:40 queued 01:24
created

Token   A

Complexity

Total Complexity 22

Size/Duplication

Total Lines 159
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 1

Test Coverage

Coverage 0%

Importance

Changes 2
Bugs 0 Features 0
Metric Value
c 2
b 0
f 0
dl 0
loc 159
ccs 0
cts 59
cp 0
rs 10
wmc 22
lcom 1
cbo 1

11 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A getClient() 0 4 1
A setClient() 0 4 1
A verify() 0 4 4
A generate() 0 6 4
A generateForKey() 0 4 1
A generateData() 0 7 3
A generateDataForKey() 0 8 2
A generateHttpHeaders() 0 10 2
A generateQueryData() 0 10 2
A generateQueryString() 0 4 1
1
<?php
2
3
namespace ElfSundae\Laravel\Api;
4
5
class Token
6
{
7
    /**
8
     * The Client instance.
9
     *
10
     * @var \ElfSundae\Laravel\Api\Client
11
     */
12
    protected $client;
13
14
    /**
15
     * Constructor.
16
     *
17
     * @param  \ElfSundae\Laravel\Api\Client  $client
18
     */
19
    public function __construct(Client $client)
20
    {
21
        $this->client = $client;
22
    }
23
24
    /**
25
     * Get the Client instance.
26
     *
27
     * @return \ElfSundae\Laravel\Api\Client
28
     */
29
    public function getClient()
30
    {
31
        return $this->client;
32
    }
33
34
    /**
35
     * Set the Client instance.
36
     *
37
     * @param  \ElfSundae\Laravel\Api\Client  $client
38
     */
39
    public function setClient(Client $client)
40
    {
41
        $this->client = $client;
42
    }
43
44
    /**
45
     * Generate an api token.
46
     *
47
     * @param  string  $key
48
     * @param  string  $secret
49
     * @param  string|int  $time
50
     * @return string|null
51
     */
52
    public function generate($key, $secret, $time)
53
    {
54
        if ($key && $secret && $time) {
55
            return substr(md5($key.$secret.$time), 10, 20);
56
        }
57
    }
58
59
    /**
60
     * Generate an api token for the given app key.
61
     *
62
     * @param  string  $key
63
     * @param  string|int  $time
64
     * @return string|null
65
     */
66
    public function generateForKey($key, $time)
67
    {
68
        return $this->generate($key, $this->client->getAppSecretForKey($key), $time);
69
    }
70
71
    /**
72
     * Verify an api token.
73
     *
74
     * @param  string  $token
75
     * @param  string  $key
76
     * @param  string|int  $time
77
     * @return bool
78
     */
79
    public function verify($token, $key, $time)
80
    {
81
        return $token && $key && $time && $token === $this->generateForKey($key, $time);
82
    }
83
84
    /**
85
     * Generate a token data array.
86
     *
87
     * @param  string  $key
88
     * @param  string  $secret
89
     * @param  string|int|null  $time
90
     * @return array
91
     */
92
    public function generateData($key, $secret, $time = null)
93
    {
94
        $time = $time ?: time();
95
        $token = $this->generate($key, $secret, $time);
96
97
        return $token ? compact('key', 'time', 'token') : [];
98
    }
99
100
    /**
101
     * Generate a token data array.
102
     *
103
     * @param  string  $key
104
     * @param  string|int|null  $time
105
     * @return array
106
     */
107
    public function generateDataForKey($key, $time = null)
108
    {
109
        if ($secret = $this->client->getAppSecretForKey($key)) {
110
            return $this->generateData($key, $secret, $time);
111
        }
112
113
        return [];
114
    }
115
116
    /**
117
     * Generate HTTP headers with a new token.
118
     *
119
     * @param  string  $appKey
120
     * @param  string|int|null  $time
121
     * @return array
122
     */
123
    public function generateHttpHeaders($appKey, $time = null)
124
    {
125
        $headers = [];
126
127
        foreach ($this->generateDataForKey($appKey, $time) as $key => $value) {
128
            $headers['X-API-'.strtoupper($key)] = $value;
129
        }
130
131
        return $headers;
132
    }
133
134
    /**
135
     * Generate query data with a new token.
136
     *
137
     * @param  string  $appKey
138
     * @param  string|int|null  $time
139
     * @return array
140
     */
141
    public function generateQueryData($appKey, $time = null)
142
    {
143
        $query = [];
144
145
        foreach ($this->generateDataForKey($appKey, $time) as $key => $value) {
146
            $query['_'.$key] = $value;
147
        }
148
149
        return $query;
150
    }
151
152
    /**
153
     * Generate query string with a new token.
154
     *
155
     * @param  string  $appKey
156
     * @param  string|int|null  $time
157
     * @return string
158
     */
159
    public function generateQueryString($appKey, $time = null)
160
    {
161
        return http_build_query($this->generateQueryData($appKey, $time));
162
    }
163
}
164