Merge branch 'feature/cookie_login' into develop

Author: lesstif

README.md

@@ -24,18 +24,16 @@
 
 2. Next, run the Composer command to install the latest version of php jira rest client.
    ``` sh
-   php composer.phar require lesstif/php-jira-rest-client "^1.7.0"
+   php composer.phar require lesstif/php-jira-rest-client
    ```
     or add the following to your composer.json file.
    ```json
    {
        "require": {
-           "lesstif/php-jira-rest-client": "^1.7.0"
+           "lesstif/php-jira-rest-client": "^1.19"
        }
    }
    ```
-   **Note:**
-   If you are using **laravel 5.0 or 5.1**(this version dependent on phpdotenv 1.x), then use **"1.5.\*"** version instead.
 
 3. Then run Composer's install or update commands to complete installation. 
 
@@ -61,16 +59,13 @@ copy .env.example file to .env on your project root.
 ```sh
 JIRA_HOST="https://your-jira.host.com"
 JIRA_USER="jira-username"
-JIRA_PASS="jira-password"
+JIRA_PASS="jira-password-OR-api-token"
 # to enable session cookie authorization
-# COOKIE_AUTH_ENABLED=1
-```
-
-Or for OAuth authorization:
-
-```sh
-JIRA_ACCESS_TOKEN="access-token"
+# COOKIE_AUTH_ENABLED=true
 ```
+**Note:**
+As of March 15, 2018, in accordance to the [Atlassian REST API Policy](https://developer.atlassian.com/platform/marketplace/atlassian-rest-api-policy/), Basic auth with password to be deprecated.
+Instead of password, you should using [API token](https://confluence.atlassian.com/cloud/api-tokens-938839638.html).
 
 **important-note:** If you are using previous versions(a prior v1.2), you should move config.jira.json to .env and will edit it. 
 

src/Configuration/AbstractConfiguration.php

@@ -154,6 +154,6 @@ public function getOAuthAccessToken()
      */
     public function isCookieAuthorizationEnabled()
     {
-        return $this->oauthAccessToken;
+        return $this->cookieAuthEnabled;
     }
 }

src/Configuration/DotEnvConfiguration.php

@@ -33,7 +33,7 @@ public function __construct($path = '.')
         $this->jiraUser = $this->env('JIRA_USER');
         $this->jiraPassword = $this->env('JIRA_PASS');
         $this->oauthAccessToken = $this->env('OAUTH_ACCESS_TOKEN');
-        $this->cookieAuthEnabled = $this->env('COOKIE_AUTH_ENABLED');
+        $this->cookieAuthEnabled = $this->env('COOKIE_AUTH_ENABLED', false);
         $this->jiraLogFile = $this->env('JIRA_LOG_FILE', 'jira-rest-client.log');
         $this->jiraLogLevel = $this->env('JIRA_LOG_LEVEL', 'WARNING');
         $this->curlOptSslVerifyHost = $this->env('CURLOPT_SSL_VERIFYHOST', false);

src/JiraClient.php

@@ -13,11 +13,6 @@
  */
 class JiraClient
 {
-    /**
-     * @var static
-     */
-    private static $_instance;
-
     /**
      * Json Mapper.
      *
@@ -61,23 +56,11 @@ class JiraClient
     protected $configuration;
 
     /**
-     * @param ConfigurationInterface|null $configuration
-     * @param Logger|null                 $logger
-     * @param string                      $path
-     *
-     * @throws JiraException
-     * @throws \Exception
+     * cookie file name
      *
-     * @return static Service instance
+     * @var string
      */
-    public static function getInstance(ConfigurationInterface $configuration = null, Logger $logger = null, $path = './')
-    {
-        if (empty(static::$_instance)) {
-            static::$_instance = new static($configuration, $logger, $path);
-        }
-
-        return static::$_instance;
-    }
+    protected $cookie = 'jira-cookies.txt';
 
     /**
      * Constructor.
@@ -223,7 +206,7 @@ public function exec($context, $post_data = null, $custom_request = null)
         }
 
         curl_setopt($ch, CURLOPT_HTTPHEADER,
-            ['Accept: */*', 'Content-Type: application/json']);
+            ['Accept: */*', 'Content-Type: application/json', 'X-Atlassian-Token: no-check']);
 
         curl_setopt($ch, CURLOPT_VERBOSE, $this->getConfiguration()->isCurlOptVerbose());
 
@@ -449,54 +432,19 @@ protected function createUrlByContext($context)
      */
     protected function authorization($ch)
     {
-        $token = $this->getConfiguration()->getOAuthAccessToken();
-        if ($token) {
-            curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer $token"]);
+        // use cookie
+        if ($this->getConfiguration()->isCookieAuthorizationEnabled()) {
+            curl_setopt($ch, CURLOPT_COOKIEJAR, $this->cookie);
+            curl_setopt($ch, CURLOPT_COOKIEFILE, $this->cookie);
 
-            return;
+            $this->log->addDebug("Using cookie..");
         }
 
-        if ($this->cookieSessionAuthorization($ch)) {
-            return;
-        }
-
-        $username = $this->getConfiguration()->getJiraUser();
-        $password = $this->getConfiguration()->getJiraPassword();
-        curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
-    }
-
-    /**
-     * @param resource $ch
-     *
-     * @return bool
-     */
-    protected function cookieSessionAuthorization($ch)
-    {
-        $cookieAuthOn = $this->getConfiguration()->isCookieAuthorizationEnabled();
-        if (!$cookieAuthOn) {
-            return false;
-        }
-
-        try {
-            $authService = AuthService::getInstance($this->getConfiguration(), $this->log);
-            if ($authService->isAuthInProgress()) {
-                return false;
-            }
-
-            if (!$authService->isAuthorized()) {
-                $authService->authorizeWithCookie();
-            }
-
-            $name = $authService->getSessionCookieName();
-            $value = $authService->getSessionCookieValue();
-
-            curl_setopt($ch, CURLOPT_HTTPHEADER, ["Cookie: $name=$value"]);
-
-            return true;
-        } catch (\Exception $e) {
-            $this->log->addError("Cookie authorization error: {$e->getMessage()}");
-
-            return false;
+        // if cookie file not exist, using id/pwd login
+        if (! file_exists($this->cookie)) {
+            $username = $this->getConfiguration()->getJiraUser();
+            $password = $this->getConfiguration()->getJiraPassword();
+            curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
         }
     }