ispect_jira 4.1.0

An additional package for ISpect to create Jira tickets

A Handy Toolkit for Mobile App Debugging 🚀

ISpect is a simple yet versatile library inspired by web inspectors, tailored for mobile application development. An add-on package to use the Jira Atlassian Api to create issue tickets immediately via Feedback.
Show some ❤️ and star the repo to support the project!

Packages

ISpect can be extended using other parts of this package

Package	Version	Description
ispect		Main package of ISpect
ispect_jira		An add-on package to use the Jira Atlassian Api to create issue tickets immediately via Feedback
ispect_device		An additional package for using tools to view platform & device info.
ispectify		An additional package for logging and handling. Based on Talker.
ispectify_bloc		An additional package for logging and handling BLoC.
ispectify_dio		An additional package for logging and handling Dio.
ispectify_http		An additional package for logging and handling http.

📌 Features

• ✅ Draggable panel for route to ISpect page and manage Inspector tools You can also use it separately: https://pub.dev/packages/draggable_panel
• ✅ Localizations: kk, en, zh, ru, es, fr, de, pt, ar, ko, ja, hi. (I will add more translations in the future.)
• ✅ ISpectify logger (inspired on Talker) implementation: BLoC, Dio, http, Routing, Provider
• ✅ You can customize more options during initialization of ISpect like BLoC, Dispatcher error and etc.
• ✅ Updated ISpect page: added more options.
  • Detailed HTTP logs: request, response, error
  • Debug tools
  • Cache manager
  • Device and app info (ispect_device)
• ✅ Feedback builder from pub.dev/feedback
• ✅ Performance tracker

📜 Showcase

📌 Before you start using Inspect Jira

In order to go to the authorization page of Jira, you need to open ISpect, click on the "burger menu" (Actions) and open "Jira". The first time you will be taken to the authorization page, the next time you will be taken to the Jira card creation page.

• Next we will be greeted by the authorization page. As indicated, you will need to log in to Jira, click on your avatar and go to "Manage account".
• Go to "Settings".
• Scroll down to "API tokens" and click on "Create and manage API tokens".
• And click on "Create API token", copy and paste the token into the application.

You should end up with something like this. In the "Project domain" field enter domain like "anydevkz", then the mail you use to log in to Jira. It can be found in the settings. When you click on "Authorization" I will validate your data, if everything fits, you will have to select your active project. This can always be changed.

Then you go back and when you go to the Jira page again, you will be taken to the task creation page.

This is where you select a project, as I mentioned above, this is an intermediate mandatory step. You choose a project and move on. But you can move on to another project if needed.

Also, after authorization in Jira, you will have a "Create Jira Issue" button when describing an issue in the Feedback builder. It will immediately take you to the issue creation page with a description of the issue you described and a screenshot attachment with all your drawings.

📌 Getting Started

Follow these steps to use this package

Easy to use

Simple example of use ISpect
You can manage ISpect using ISpect.read(context). Put this code in your project at an screen and learn how it works. 😊

Instructions for use:

1. Wrap runApp with ISpect.run method and pass ISpectify instance to it.
2. Initialize ISpectJiraClient to MaterialApp and pass the necessary parameters. For example, from local storage.

ISpectJiraClient.initialize(
      projectDomain: 'domain',
      userEmail: '[e-mail]',
      apiToken: 'token',
      projectId: '10007',
      projectKey: 'GTMS4',
    );

copied to clipboard

3. In actionItems inside ISpectOptions add the Jira Action button.

actionItems: [
          ISpectifyActionItem(
            title: 'ISpect',
            icon: Icons.bug_report_outlined,
            onTap: (context) {
              if (ISpectJiraClient.isInitialized) {
                Navigator.push(
                  context,
                  MaterialPageRoute<dynamic>(
                    builder: (_) => const JiraSendIssueScreen(),
                    settings: const RouteSettings(
                      name: 'Jira Send Issue Page',
                    ),
                  ),
                );
              } else {
                Navigator.push(
                  context,
                  MaterialPageRoute<dynamic>(
                    builder: (_) => JiraAuthScreen(
                      onAuthorized: (domain, email, apiToken, projectId, projectKey) {
                        /// Save to local storage, for example `shared_preferences`
                      },
                    ),
                    settings: const RouteSettings(
                      name: 'Jira Auth Page',
                    ),
                  ),
                );
              }
            },
          ),
        ],

copied to clipboard

4. Add ISpectJiraLocalization to your localizationsDelegates in MaterialApp.

localizationsDelegates: ISpectLocalizations.localizationDelegates([
          ExampleGeneratedLocalization.delegate,
          ISpectJiraLocalization.delegate,
        ]),

copied to clipboard

5. Add ISpectBuilder widget to your material app's builder and put NavigatorObserver, JiraFeedbackBuilder.

child = ISpectBuilder(
            observer: observer,
            feedbackBuilder: (context, onSubmit, controller) => JiraFeedbackBuilder(
              onSubmit: onSubmit,
              theme: theme,
              scrollController: controller,
            ),
            initialPosition: (x: 0, y: 200),
            onPositionChanged: (x, y) {
              /// Save to local storage, for example `shared_preferences`
            },
            child: child,
          );

copied to clipboard

Please, check the example for more details.

Note

• To platform & device tools follow the instructions provided here ispect_device.

You can also check out an example of usage directly in ispect_device/example.

Thanks to all contributors of this package