v1.0

Author: bolechen

.gitignore

@@ -1,9 +1,10 @@
-.idea
 *.DS_Store
-/vendor
+*.log
+.idea
+.php_cs.cache
+.phpunit.result.cache
+.subsplit
 /coverage
-sftp-config.json
+/vendor
 composer.lock
-.subsplit
-.php_cs.cache
-*.log
+sftp-config.json

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-  - 7.1
   - 7.2
   - 7.3
   - 7.4

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [v1.0.0] - 2021-01-12
+### Changed
+- v1.0 发布
+- 增加新电签接口 `getContractStatusV2` 原接口已经被官方标记为废弃
+
+### Removed
+- 代码重构，最低支持 PHP ^7.2

composer.json

@@ -1,21 +1,25 @@
 {
-    "name": "bolechen\/gongmall-php-sdk",
-    "description": "工猫（gongmall.com）sdk for php，非官方支持。基于官网文档：https:\/\/opendoc.gongmall.com 实现",
+    "name": "bolechen/gongmall-php-sdk",
+    "description": "工猫（gongmall.com）sdk for php，非官方支持。基于官网文档：https://opendoc.gongmall.com 实现",
     "license": "MIT",
     "authors": [{
         "name": "Bole Chen",
         "email": "[email protected]"
     }],
     "require": {
-        "hanson/foundation-sdk": "3.0.*|^4.0.3"
+        "php": "^7.2",
+        "hanson/foundation-sdk": "3.0.*|^4.0.3",
+        "ext-json": "*",
+        "ext-openssl": "*"
     },
     "autoload": {
         "psr-4": {
-            "Bolechen\\Gongmall\\": "src"
+            "Bolechen\\Gongmall\\": "src",
+            "Bolechen\\Gongmall\\Test\\": "tests"
         }
     },
     "require-dev": {
-        "phpunit/phpunit": "~7.0"
+        "phpunit/phpunit": "~8.0"
     },
     "scripts": {
         "test": "vendor/bin/phpunit"

src/Api.php

@@ -14,40 +14,43 @@
 
 class Api extends AbstractAPI
 {
-    const API_URL = 'https://openapi.gongmall.com';
-    const SANDBOX_API_URL = 'https://openapi-qa.gongmall.com';
+    protected $app;
+
+    public const API_URL = 'https://openapi.gongmall.com';
+    public const SANDBOX_API_URL = 'https://openapi-qa.gongmall.com';
 
     protected $apiKey;
     protected $apiSecret;
     protected $contractUrl;
-
-    private $url;
+    private $apiUrl;
 
     public function __construct(Gongmall $app)
     {
+        $this->app = $app;
         $config = $app->getConfig();
 
         $this->apiKey = $config['apiKey'];
         $this->apiSecret = $config['apiSecret'];
         $this->contractUrl = $config['contractUrl'];
 
-        //沙盒环境
+        // 沙盒环境
         $this->apiUrl = (isset($config['sandbox']) && $config['sandbox']) ? static::SANDBOX_API_URL : static::API_URL;
     }
 
     /**
-     * @param string $uri
-     * @param array  $params
+     * @param  string  $uri
+     * @param  array  $params
      *
      * @return array
+     * @throws \JsonException
      */
-    public function request($uri, $params = [])
+    public function request(string $uri, $params = []): array
     {
         $http = $this->getHttp();
 
         $params['appKey'] = $this->apiKey;
         $params['nonce'] = $this->createNonceStr();
-        $params['timestamp'] = strval(microtime(true) * 10000);
+        $params['timestamp'] = (string) (microtime(true) * 10000);
 
         $protocol = $params;
         $protocol['sign'] = $this->signature($params);
@@ -62,9 +65,11 @@ public function request($uri, $params = [])
      *
      * @see https://opendoc.gongmall.com/overview/jie-kou-gui-fan.html
      *
+     * @param  array  $paramArr
+     *
      * @return string
      */
-    protected function signature(array $paramArr)
+    protected function signature(array $paramArr): string
     {
         //去除空参数，不参与签名
         unset($paramArr['sign']);
@@ -86,9 +91,11 @@ protected function signature(array $paramArr)
      *
      * @see https://opendoc.gongmall.com/dian-qian-he-tong/jie-ru-zhi-nan.html
      *
+     * @param  array  $data
+     *
      * @return string
      */
-    protected function employeeEncrypt(array $data)
+    protected function employeeEncrypt(array $data): string
     {
         // data为AES加密数据
         $plaintext = urldecode(http_build_query($data));
@@ -109,12 +116,12 @@ protected function employeeEncrypt(array $data)
         // 加密结果
     }
 
-    private function createNonceStr($length = 16)
+    private function createNonceStr($length = 16): string
     {
         $chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
         $str = '';
         for ($i = 0; $i < $length; $i++) {
-            $str .= substr($chars, mt_rand(0, strlen($chars) - 1), 1);
+            $str .= $chars[random_int(0, strlen($chars) - 1)];
         }
 
         return $str;

src/Company.php

@@ -19,7 +19,7 @@ class Company extends Api
      *
      * @return array
      */
-    public function getBalance()
+    public function getBalance(): array
     {
         return $this->request('/api/company/getBalance');
     }

src/Employee.php

@@ -17,33 +17,55 @@ class Employee extends Api
      *
      * @see   https://opendoc.gongmall.com/dian-qian-he-tong/jie-ru-zhi-nan.html
      *
+     * @param  array  $params
+     *
      * @return string
      */
-    public function getContractUrl(array $params)
+    public function getContractUrl(array $params): string
     {
         return $this->contractUrl.'&data='.base64_encode($this->employeeEncrypt($params));
     }
 
     /**
-     * 查询电签结果.
+     * 查询电签结果（废弃）.
      *
      * @see   https://opendoc.gongmall.com/dian-qian-he-tong/cha-xun-dian-qian-jie-guo.html
      *
+     * @param  array  $params
+     *
      * @return array
+     *
+     * @deprecated  官方标记为已废弃，使用 getContractStatusV2 替代
      */
-    public function getContractStatus(array $params)
+    public function getContractStatus(array $params): array
     {
         return $this->request('/api/employee/getContractStatus', $params);
     }
 
+    /**
+     * 查询电签结果.
+     *
+     * @see   https://opendoc.gongmall.com/dian-qian-he-tong/cha-xun-dian-qian-jie-guo-v2.html
+     *
+     * @param  array  $params
+     *
+     * @return array
+     */
+    public function getContractStatusV2(array $params): array
+    {
+        return $this->request('/api/employee/getContractStatusV2', $params);
+    }
+
     /**
      * 修改员工银行卡
      *
      * @see   https://opendoc.gongmall.com/shi-shi-ti-xian/xiu-gai-yin-hang-ka.html
      *
+     * @param  array  $params
+     *
      * @return array
      */
-    public function syncBankAccount(array $params)
+    public function syncBankAccount(array $params): array
     {
         return $this->request('/api/employee/v2/syncBankAccount', $params);
     }

src/Gongmall.php

@@ -15,10 +15,10 @@
 /**
  * Class Gongmall.
  *
- * @property \Bolechen\Gongmall\Employee $employee
- * @property \Bolechen\Gongmall\Withdraw $withdraw
- * @property \Bolechen\Gongmall\Company  $company
- * @property \Bolechen\Gongmall\Push     $push
+ * @property Employee $employee
+ * @property Withdraw $withdraw
+ * @property Company $company
+ * @property Push $push
  */
 class Gongmall extends Foundation
 {
@@ -29,12 +29,12 @@ class Gongmall extends Foundation
     /**
      * API 请求
      *
-     * @param string $uri
-     * @param array  $params
+     * @param  string  $uri
+     * @param  array  $params
      *
      * @return array
      */
-    public function request($uri, $params = [])
+    public function request(string $uri, $params = []): array
     {
         return $this->api->request($uri, $params);
     }

src/GongmallServiceProvider.php

@@ -23,7 +23,7 @@ class GongmallServiceProvider implements ServiceProviderInterface
      *
      * @param Container $pimple A container instance
      */
-    public function register(Container $pimple)
+    public function register(Container $pimple): void
     {
         $pimple['employee'] = function ($pimple) {
             return new Employee($pimple);
@@ -38,11 +38,7 @@ public function register(Container $pimple)
         };
 
         $pimple['push'] = function ($pimple) {
-            return new Push(
-                $pimple->getConfig()['apiKey'],
-                $pimple->getConfig()['apiSecret'],
-                $pimple['request']
-            );
+            return new Push($pimple);
         };
     }
 }

src/Push.php

@@ -10,57 +10,43 @@
 
 namespace Bolechen\Gongmall;
 
-use Symfony\Component\HttpFoundation\Request;
+use RuntimeException;
 use Symfony\Component\HttpFoundation\Response;
 
 class Push extends Api
 {
-    /**
-     * @var Request
-     */
-    private $request;
-
-    public function __construct($apiKey, $apiSecret, Request $request)
-    {
-        $this->apiKey = $apiKey;
-        $this->apiSecret = $apiSecret;
-        $this->request = $request;
-    }
-
     /**
      * @param null|mixed $postRaw
      *
-     * @throws Exception
-     *
      * @return array|Response
      */
     public function parse($postRaw = null)
     {
         if (!$postRaw) {
-            $postRaw = $this->request->getContent();
+            $postRaw = $this->app->request->getContent();
         }
 
         parse_str($postRaw, $data);
         if (!is_array($data)) {
-            throw new \Exception('数据不正确');
+            throw new RuntimeException('数据不正确');
         }
 
         $this->checkSign($data);
 
         return $data;
     }
 
-    public function checkSign(array $data)
+    public function checkSign(array $data): void
     {
         $sign = $this->signature($data);
 
-        if (!isset($data['sign']) || $sign != $data['sign']) {
-            throw new \Exception('签名不正确');
+        if (!isset($data['sign']) || $sign !== $data['sign']) {
+            throw new RuntimeException('签名不正确');
         }
     }
 
-    public function response()
+    public function response(): Response
     {
-        return Response::create(json_encode(['code' => 0, 'msg' => 'success']));
+        return new Response(json_encode(['code' => 0, 'msg' => 'success']));
     }
 }