Download the PHP package rjvandoesburg/laravel-jira-rest-client without Composer
On this page you can find all versions of the php package rjvandoesburg/laravel-jira-rest-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-jira-rest-client
Jira API client for Laravel 5.4+
Perform various operations of Jira APIs with Laravel 5.4+
The aim of the package is to make it easier to communicate with the API. By default the response from the request is not altered in any way. By creating your own implementation or by using the simple helpers provided with the package you are able to integrate Jira the way you like.
Installation
To get the latest version of laravel-jira-rest-client
, run the following command
Do note that not all methods have been implemented yet.
Laravel 5.5 uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.
Laravel 5.4:
If you don't use auto-discovery, add the ServiceProvider to the providers array in config/app.php
Also locate the Aliases
key in your config/app.php
file and register the Facade:
Copy the package config to your local config with the publish command:
Update the .env with your proper credentials using JIRA variables from config/atlassian/jira.php
.
Usage
The core of this package is a direct reflection of the Jira API mean that all request classes don't format the response you get from the API. This desicion was made so the package is more versitile allowing users to handle the response of the requests to their own wishes.
For example, to fetch a specific issue you could do the following
All responses are an instance of \GuzzleHttp\Psr7\Response
Read more so in order to get the json response you could do the following:
Which will return a response like seen in the API
Parameters
Sending parameter with requests is possible via two ways
- Using an array
- Creating a class that implements
\Illuminate\Contracts\Support\Arrayable
When using an array you can create a request like so:
You can opt for creating a class implementing \Illuminate\Contracts\Support\Arrayable
, the toArray
method will return the parameters for the request.
Or you could extend \Atlassian\JiraRest\Requests\AbstractParameters
so you can 'fill' or 'override' the parameters set within the class.
Using a class can be usefull when doing requests in multiple places to make sure the same values are requests every time.
Authentication
So Jira allows for multiple ways of authentication. By default this is basic auth.
Basic Auth
To use basic auth, you need to add the following to your .env
Where the credentials are the same as the user you are logging in.
If you wish have each user be identified by their own credentials you need to set these in the config on runtime
Session
Another implementation is session, but that is not (yet) implemented by this package.
OAuth
To use OAuth you need to add the OAuth package for Guzzle: composer require guzzlehttp/oauth-subscriber
Lastly there is the option for OAuth, please read the Jira documentation first before continuing https://developer.atlassian.com/server/jira/platform/oauth/
After reading that you need to create an application on Jira's side (as explained on that page) and set the credentials in you .env
These credentials should be enough to talk to the api to login. In src/Http/Controllers/OAuthController.php
you can find how you can do the 'oauth' dance.
This controller can be enabled by setting JIRA_OAUTH_ROUTES=true
in the .env
file. Once enabled you are able to navigate to /atlassian/jira/oauth/access
which will redirect you to Jira to grant access.
Once that is done you will find oauth tokens in the session (flashed) which will allow you to request resources from Jira.
This allows you to decide where to store the keys e.g. database or session.
Alternatively you can catch the event \Atlassian\JiraRest\Events\OAuth\AccessTokensReceived
to handle the tokens.
You can also set those credentials in the .env
so you don't have to authenticate again in the future as tokens are valid for 5 years (according to Jira)
Helpers (deprecated)
Now because for the most part you don't want to spend time writing the requests yourself there are some useful helpers to get you communicating with the api.
To fetch a single issue you can use the following code:
Or use the facade if you prefer:
deprecating most helpers because writing helpers for all classes is too much maintenance
Middleware
To alter the Guzzle Client used for requests you can add 'middleware' to alter the options.
There are multiple ways to add middleware.
Using the config
You can set one or more middleware using the client_options
array in the config config/atlassian/jira.php
For example:
These can be named or just a value
Using the addMiddleware
method
When you have an AbstractRequest
instance you can add multiple middleware by calling addMiddlware
like so:
Impersonation
To impersonate a user through Jira requests you must set JIRA_IMPERSONATE=true
in your .env file.
Once impersonation is enabled, Laravel will use the authentificated users' name
by default.
However, it's also possible to impersonate a user manually by sending a user's name to constructor of the middleware. To do this you would need to manually register the middleware and pass the user.
JIRA Setup for Impersonation
- Follow Jira documentation to generate an RSA public/private key pair.
- Go to Jira --> Application Links (Admin)
- Create a new link with your server url
- Ignore the "No response" warning
- Enter anything in all the field and keep "Create incoming link unchecked". Jira has a weird behaviour when it comes to setting up app links. If you create your incoming link now, you won't have access to 2-Legged auth (Impersonation).
- Click continue (ignore the warning). This should have created your new app link.
- Edit that link (notice there are no Outgoing info even if you added dummy info at creation).
- You may now enter all the info for OAuth and setup impersonation (Allow 2-Legged OAuth).
TODO
- Implement missing requests
- Middleware
- Better README
- Sessions auth
- A way to alter the request before it is send out (globally for each request and possibility for specific requests)
- Tests
All versions of laravel-jira-rest-client with dependencies
laravel/framework Version *
guzzlehttp/guzzle Version ^6.0|^7.0
ext-json Version *