Pine Retrofit

A brick to create your retrofit service class including tests.

This brick makes use of the internal lib pine_bricks_helper to get access to the package name, so please run this brick in the root of your project where a valid pubspec.yaml file exists. Also, make sure you have previously set up your project to work with the Retrofit and the http_mock_adapter library.

How to use 🚀

mason make pine_retrofit --name "Authentication"

Variables ✨

Outputs 📦

--name "Authentication"
├── lib
│   └── services
│       └── network
│           └── authentication_service
│               └── authentication_service.dart
├── test
│   └── services
│       └── network
│           └── authentication_service
│               └── authentication_service_test.dart
└── ...

Service File

import 'package:dio/dio.dart';
import 'package:retrofit/retrofit.dart';

part 'authentication_service.g.dart';

/// Abstract class of AuthenticationService
@RestApi()
abstract class AuthenticationService {
  factory AuthenticationService(Dio dio, {String baseUrl}) = _AuthenticationService;

  //TODO: Add your methods
}

extension AuthenticationServiceExtension on BuildContext {
  /// Extension method used to get the [AuthenticationService] instance
  AuthenticationService get signInCubit => read<AuthenticationService>();
}

Test File

import 'package:dio/dio.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:http_mock_adapter/http_mock_adapter.dart';
import 'package:{{package_name}}/services/network/authentication/authentication_service.dart';

/// Test case for the class AuthenticationService
void main() {
  late Dio dio;
  late DioAdapter dioAdapter;

  late AuthenticationService service;

  setUp(() {
    dio = Dio(BaseOptions());
    dioAdapter = DioAdapter(dio: dio);

    service = AuthenticationService(dio);
  });

  //TODO: Test your methods
}

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add pine_retrofit

# Install globally
mason add -g pine_retrofit

Usage 🚀

mason make pine_retrofit

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.39 <0.1.0"

0.2.0+1

Fixed typos when generating extension methods

0.2.0

Added service extension on context

0.1.0

First release

Copyright (c) 2024 MyLittleSuite

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.