Skip to content

Commit

Permalink
Release 25.1 V4 (#85)
Browse files Browse the repository at this point in the history
* Generate code for new v4.0 version

Code and tests fixed

Updated code after spec change

Fixed tests

Fixed tests

Generate form content type changed to multipart

Removed code for form-encoded content

Regenerate after spec changed

Fixed fetch token exception

Bug fix

Added snippets for set source and manual fetch token

Recognition snippets added

Added pom.xml snippet for documentation

Added examples for generate doc pages

Switch to common credentials template

Added scripts for snippets testing

Snippets changed

Code updated after operationId addition

*Request models renames to *RequestWrapper
Fixed tests and snippets

Update year and version

* Added snippets test to ci

Added token auth to snippets

* Migrate to okhttp3

Bug fix

* Update setup version

* Java version updated

* Some updates

Added debug command

* Changed test ci pipeline

* Disable cache

* DEBUG

* Copy dependencies to output dir

* Fixed lint errors

* README updated

* Don't print on success in ExceptionMessageParsed tests

* Enable cache

---------

Co-authored-by: Denis Averin <denis.averin@aspose.com>
  • Loading branch information
ivankamkin and Denis-Averin authored Jan 28, 2025
1 parent c75b702 commit 7b8168e
Show file tree
Hide file tree
Showing 275 changed files with 5,558 additions and 18,445 deletions.
11 changes: 7 additions & 4 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ jobs:

steps:
- uses: actions/checkout@v4
- name: Set up JDK 1.8
uses: actions/setup-java@v3
- name: Set up JDK 11
uses: actions/setup-java@v4
with:
# Use same in Dockerfile
distribution: 'corretto'
java-version: 8
java-version: 11
cache: 'maven'

- name: Maven Compile
Expand All @@ -30,7 +30,10 @@ jobs:
- name: Test with Maven
env:
TEST_CONFIGURATION_ACCESS_TOKEN: ${{ secrets.TEST_CONFIGURATION_ACCESS_TOKEN }}
run: mvn test
run: |
chmod +x scripts/*
make build
make test
# TODO: Move to pack.yml
# - name: Build the Docker image
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ aspose-barcode-cloud.iml
.idea

**/configuration*.json
snippets_test/

2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM maven:3-amazoncorretto-8-debian
FROM maven:3-amazoncorretto-11-debian
RUN apt-get update \
&& apt-get install -y make \
&& rm -rf /var/lib/apt/lists/*
Expand Down
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ lint:
.PHONY: build
build:
mvn compile -Dmaven.test.skip=true
mvn dependency:copy-dependencies -DoutputDirectory=target/lib/

.PHONY: test
test:
mvn test
./scripts/run_snippets.sh

.PHONY: display-updates
display-updates:
Expand Down
164 changes: 47 additions & 117 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@
[![Java CI with Maven](https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-java/actions/workflows/maven.yml/badge.svg?branch=main)](https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-java/actions/workflows/maven.yml)
[![Maven metadata URL](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Freleases.aspose.cloud%2Fjava%2Frepo%2Fcom%2Faspose%2Faspose-barcode-cloud%2Fmaven-metadata.xml)](https://releases.aspose.cloud/java/repo/com/aspose/aspose-barcode-cloud/)

- API version: 3.0
- SDK version: 24.12.0
- API version: 4.0
- SDK version: 25.1.0

## SDK and API Version Compatibility:

- SDK Version 25.1 and Later: Starting from SDK version 25.1, all subsequent versions are compatible with API Version v4.0.
- SDK Version 24.12 and Earlier: These versions are compatible with API Version v3.0.

## Demo applications

Expand Down Expand Up @@ -68,7 +73,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>com.aspose</groupId>
<artifactId>aspose-barcode-cloud</artifactId>
<version>24.12.0</version>
<version>25.1.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -83,7 +88,7 @@ mvn clean package

Then manually install the following JARs:

- `target/aspose-barcode-cloud-24.12.0.jar`
- `target/aspose-barcode-cloud-25.1.0.jar`
- `target/lib/*.jar`

## Getting Started
Expand All @@ -95,33 +100,33 @@ package com.aspose.barcode.cloud.examples;

import com.aspose.barcode.cloud.ApiClient;
import com.aspose.barcode.cloud.ApiException;
import com.aspose.barcode.cloud.api.BarcodeApi;
import com.aspose.barcode.cloud.api.GenerateApi;
import com.aspose.barcode.cloud.api.ScanApi;
import com.aspose.barcode.cloud.model.BarcodeImageFormat;
import com.aspose.barcode.cloud.model.BarcodeResponseList;
import com.aspose.barcode.cloud.model.DecodeBarcodeType;
import com.aspose.barcode.cloud.model.EncodeBarcodeType;
import com.aspose.barcode.cloud.requests.GetBarcodeGenerateRequest;
import com.aspose.barcode.cloud.requests.ScanBarcodeRequest;
import com.aspose.barcode.cloud.requests.GenerateRequestWrapper;
import com.aspose.barcode.cloud.requests.ScanMultipartRequestWrapper;

import java.io.File;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient client =
new ApiClient(
"Client Id from https://dashboard.aspose.cloud/applications",
"Client Secret from https://dashboard.aspose.cloud/applications");
client.setReadTimeout(5 * 60 * 1000);

BarcodeApi api = new BarcodeApi(client);
GenerateApi genApi = new GenerateApi(client);
ScanApi scanApi = new ScanApi(client);

try {
System.out.println("Generating barcode...");
File barcodeImage = generateBarcode(api);
File barcodeImage = generateBarcode(genApi);
System.out.println("Barcode image saved to file " + barcodeImage.getAbsolutePath());

System.out.println("Recognizing barcode on image...");
BarcodeResponseList recognized = scanBarcode(api, barcodeImage);
BarcodeResponseList recognized = scanBarcode(scanApi, barcodeImage);
System.out.print("Barcode on image:");
System.out.println(recognized.toString());
} catch (ApiException e) {
Expand All @@ -130,21 +135,20 @@ public class Example {
}
}

private static File generateBarcode(BarcodeApi api) throws ApiException {
String type = EncodeBarcodeType.QR.toString();
private static File generateBarcode(GenerateApi api) throws ApiException {
EncodeBarcodeType type = EncodeBarcodeType.QR;
String text = "Aspose.BarCode for Cloud Sample";
GetBarcodeGenerateRequest request = new GetBarcodeGenerateRequest(type, text);
request.textLocation = "None";
GenerateRequestWrapper request = new GenerateRequestWrapper(type, text);
request.imageFormat = BarcodeImageFormat.JPEG;

return api.getBarcodeGenerate(request);
return api.generate(request);
}

private static BarcodeResponseList scanBarcode(BarcodeApi api, File barcodeImage)
private static BarcodeResponseList scanBarcode(ScanApi api, File barcodeImage)
throws ApiException {
ScanBarcodeRequest request = new ScanBarcodeRequest(barcodeImage);
request.decodeTypes = Collections.singletonList(DecodeBarcodeType.QR);
ScanMultipartRequestWrapper request = new ScanMultipartRequestWrapper(barcodeImage);

return api.scanBarcode(request);
return api.scanMultipart(request);
}
}

Expand All @@ -165,114 +169,40 @@ All Aspose.BarCode for Cloud SDKs, helper scripts and templates are licensed und

## Documentation for API Endpoints

All URIs are relative to *<https://api.aspose.cloud/v3.0>*
All URIs are relative to *<https://api.aspose.cloud/v4.0>*

Class | Method | HTTP request | Description
----- | ------ | ------------ | -----------
*BarcodeApi* | [**getBarcodeGenerate**](docs/BarcodeApi.md#getBarcodeGenerate) | **GET** /barcode/generate | Generate barcode.
*BarcodeApi* | [**getBarcodeRecognize**](docs/BarcodeApi.md#getBarcodeRecognize) | **GET** /barcode/{name}/recognize | Recognize barcode from a file on server.
*BarcodeApi* | [**postBarcodeRecognizeFromUrlOrContent**](docs/BarcodeApi.md#postBarcodeRecognizeFromUrlOrContent) | **POST** /barcode/recognize | Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image with content-type \&quot;application/octet-stream\&quot;. An image can also be passed as a form field.
*BarcodeApi* | [**postGenerateMultiple**](docs/BarcodeApi.md#postGenerateMultiple) | **POST** /barcode/generateMultiple | Generate multiple barcodes and return in response stream
*BarcodeApi* | [**putBarcodeGenerateFile**](docs/BarcodeApi.md#putBarcodeGenerateFile) | **PUT** /barcode/{name}/generate | Generate barcode and save on server (from query params or from file with json or xml content)
*BarcodeApi* | [**putBarcodeRecognizeFromBody**](docs/BarcodeApi.md#putBarcodeRecognizeFromBody) | **PUT** /barcode/{name}/recognize | Recognition of a barcode from file on server with parameters in body.
*BarcodeApi* | [**putGenerateMultiple**](docs/BarcodeApi.md#putGenerateMultiple) | **PUT** /barcode/{name}/generateMultiple | Generate image with multiple barcodes and put new file on server
*BarcodeApi* | [**scanBarcode**](docs/BarcodeApi.md#scanBarcode) | **POST** /barcode/scan | Quickly scan a barcode from an image.
*FileApi* | [**copyFile**](docs/FileApi.md#copyFile) | **PUT** /barcode/storage/file/copy/{srcPath} | Copy file
*FileApi* | [**deleteFile**](docs/FileApi.md#deleteFile) | **DELETE** /barcode/storage/file/{path} | Delete file
*FileApi* | [**downloadFile**](docs/FileApi.md#downloadFile) | **GET** /barcode/storage/file/{path} | Download file
*FileApi* | [**moveFile**](docs/FileApi.md#moveFile) | **PUT** /barcode/storage/file/move/{srcPath} | Move file
*FileApi* | [**uploadFile**](docs/FileApi.md#uploadFile) | **PUT** /barcode/storage/file/{path} | Upload file
*FolderApi* | [**copyFolder**](docs/FolderApi.md#copyFolder) | **PUT** /barcode/storage/folder/copy/{srcPath} | Copy folder
*FolderApi* | [**createFolder**](docs/FolderApi.md#createFolder) | **PUT** /barcode/storage/folder/{path} | Create the folder
*FolderApi* | [**deleteFolder**](docs/FolderApi.md#deleteFolder) | **DELETE** /barcode/storage/folder/{path} | Delete folder
*FolderApi* | [**getFilesList**](docs/FolderApi.md#getFilesList) | **GET** /barcode/storage/folder/{path} | Get all files and folders within a folder
*FolderApi* | [**moveFolder**](docs/FolderApi.md#moveFolder) | **PUT** /barcode/storage/folder/move/{srcPath} | Move folder
*StorageApi* | [**getDiscUsage**](docs/StorageApi.md#getDiscUsage) | **GET** /barcode/storage/disc | Get disc usage
*StorageApi* | [**getFileVersions**](docs/StorageApi.md#getFileVersions) | **GET** /barcode/storage/version/{path} | Get file versions
*StorageApi* | [**objectExists**](docs/StorageApi.md#objectExists) | **GET** /barcode/storage/exist/{path} | Check if file or folder exists
*StorageApi* | [**storageExists**](docs/StorageApi.md#storageExists) | **GET** /barcode/storage/{storageName}/exist | Check if storage exists
*GenerateApi* | [**generate**](docs/GenerateApi.md#generate) | **GET** /barcode/generate/{barcodeType} | Generate barcode using GET request with parameters in route and query string.
*GenerateApi* | [**generateBody**](docs/GenerateApi.md#generateBody) | **POST** /barcode/generate-body | Generate barcode using POST request with parameters in body in json or xml format.
*GenerateApi* | [**generateMultipart**](docs/GenerateApi.md#generateMultipart) | **POST** /barcode/generate-multipart | Generate barcode using POST request with parameters in multipart form.
*RecognizeApi* | [**recognize**](docs/RecognizeApi.md#recognize) | **GET** /barcode/recognize | Recognize barcode from file on server using GET requests with parameters in route and query string.
*RecognizeApi* | [**recognizeBase64**](docs/RecognizeApi.md#recognizeBase64) | **POST** /barcode/recognize-body | Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
*RecognizeApi* | [**recognizeMultipart**](docs/RecognizeApi.md#recognizeMultipart) | **POST** /barcode/recognize-multipart | Recognize barcode from file in request body using POST requests with parameters in multipart form.
*ScanApi* | [**scan**](docs/ScanApi.md#scan) | **GET** /barcode/scan | Scan barcode from file on server using GET requests with parameter in query string.
*ScanApi* | [**scanBase64**](docs/ScanApi.md#scanBase64) | **POST** /barcode/scan-body | Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
*ScanApi* | [**scanMultipart**](docs/ScanApi.md#scanMultipart) | **POST** /barcode/scan-multipart | Scan barcode from file in request body using POST requests with parameter in multipart form.

## Documentation for Models

- [ApiError](docs/ApiError.md)
- [ApiErrorResponse](docs/ApiErrorResponse.md)
- [AustralianPostParams](docs/AustralianPostParams.md)
- [AutoSizeMode](docs/AutoSizeMode.md)
- [AvailableGraphicsUnit](docs/AvailableGraphicsUnit.md)
- [AztecEncodeMode](docs/AztecEncodeMode.md)
- [AztecParams](docs/AztecParams.md)
- [AztecSymbolMode](docs/AztecSymbolMode.md)
- [BarcodeImageFormat](docs/BarcodeImageFormat.md)
- [BarcodeImageParams](docs/BarcodeImageParams.md)
- [BarcodeResponse](docs/BarcodeResponse.md)
- [BarcodeResponseList](docs/BarcodeResponseList.md)
- [BorderDashStyle](docs/BorderDashStyle.md)
- [CaptionParams](docs/CaptionParams.md)
- [ChecksumValidation](docs/ChecksumValidation.md)
- [CodabarChecksumMode](docs/CodabarChecksumMode.md)
- [CodabarParams](docs/CodabarParams.md)
- [CodabarSymbol](docs/CodabarSymbol.md)
- [CodablockParams](docs/CodablockParams.md)
- [Code128Emulation](docs/Code128Emulation.md)
- [Code128EncodeMode](docs/Code128EncodeMode.md)
- [Code128Params](docs/Code128Params.md)
- [Code16KParams](docs/Code16KParams.md)
- [CodeLocation](docs/CodeLocation.md)
- [CouponParams](docs/CouponParams.md)
- [CustomerInformationInterpretingType](docs/CustomerInformationInterpretingType.md)
- [DataBarParams](docs/DataBarParams.md)
- [DataMatrixEccType](docs/DataMatrixEccType.md)
- [DataMatrixEncodeMode](docs/DataMatrixEncodeMode.md)
- [DataMatrixParams](docs/DataMatrixParams.md)
- [DataMatrixVersion](docs/DataMatrixVersion.md)
- [DecodeBarcodeType](docs/DecodeBarcodeType.md)
- [DiscUsage](docs/DiscUsage.md)
- [DotCodeEncodeMode](docs/DotCodeEncodeMode.md)
- [DotCodeParams](docs/DotCodeParams.md)
- [ECIEncodings](docs/ECIEncodings.md)
- [EnableChecksum](docs/EnableChecksum.md)
- [EncodeBarcodeType](docs/EncodeBarcodeType.md)
- [Error](docs/Error.md)
- [ErrorDetails](docs/ErrorDetails.md)
- [FileVersions](docs/FileVersions.md)
- [FilesList](docs/FilesList.md)
- [FilesUploadResult](docs/FilesUploadResult.md)
- [FontMode](docs/FontMode.md)
- [FontParams](docs/FontParams.md)
- [FontStyle](docs/FontStyle.md)
- [GeneratorParams](docs/GeneratorParams.md)
- [GeneratorParamsList](docs/GeneratorParamsList.md)
- [HanXinEncodeMode](docs/HanXinEncodeMode.md)
- [HanXinErrorLevel](docs/HanXinErrorLevel.md)
- [HanXinParams](docs/HanXinParams.md)
- [HanXinVersion](docs/HanXinVersion.md)
- [ITF14BorderType](docs/ITF14BorderType.md)
- [ITFParams](docs/ITFParams.md)
- [MacroCharacter](docs/MacroCharacter.md)
- [MaxiCodeEncodeMode](docs/MaxiCodeEncodeMode.md)
- [MaxiCodeMode](docs/MaxiCodeMode.md)
- [MaxiCodeParams](docs/MaxiCodeParams.md)
- [ObjectExist](docs/ObjectExist.md)
- [Padding](docs/Padding.md)
- [PatchCodeParams](docs/PatchCodeParams.md)
- [PatchFormat](docs/PatchFormat.md)
- [Pdf417CompactionMode](docs/Pdf417CompactionMode.md)
- [Pdf417ErrorLevel](docs/Pdf417ErrorLevel.md)
- [Pdf417MacroTerminator](docs/Pdf417MacroTerminator.md)
- [Pdf417Params](docs/Pdf417Params.md)
- [PostalParams](docs/PostalParams.md)
- [PresetType](docs/PresetType.md)
- [QREncodeMode](docs/QREncodeMode.md)
- [QREncodeType](docs/QREncodeType.md)
- [QRErrorLevel](docs/QRErrorLevel.md)
- [QRVersion](docs/QRVersion.md)
- [QrParams](docs/QrParams.md)
- [ReaderParams](docs/ReaderParams.md)
- [EncodeData](docs/EncodeData.md)
- [EncodeDataType](docs/EncodeDataType.md)
- [GenerateParams](docs/GenerateParams.md)
- [GraphicsUnit](docs/GraphicsUnit.md)
- [RecognitionImageKind](docs/RecognitionImageKind.md)
- [RecognitionMode](docs/RecognitionMode.md)
- [RecognizeBase64Request](docs/RecognizeBase64Request.md)
- [RegionPoint](docs/RegionPoint.md)
- [ResultImageInfo](docs/ResultImageInfo.md)
- [StorageExist](docs/StorageExist.md)
- [StorageFile](docs/StorageFile.md)
- [StructuredAppend](docs/StructuredAppend.md)
- [TextAlignment](docs/TextAlignment.md)
- [FileVersion](docs/FileVersion.md)
- [ScanBase64Request](docs/ScanBase64Request.md)

## Documentation for Authorization

Expand All @@ -282,7 +212,7 @@ Authentication schemes defined for the API:

- **Type**: OAuth
- **Flow**: application
- **Authorization URL**: <https://api.aspose.cloud/connect/token>
- **Authorization URL**: <https://id.aspose.cloud/connect/token>

## Recommendation

Expand Down
18 changes: 11 additions & 7 deletions docs/ApiError.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@


# ApiError

Api Error.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **String** | | [optional]
**message** | **String** | | [optional]
**description** | **String** | | [optional]
**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | | [optional]
**innerError** | [**ApiError**](ApiError.md) | | [optional]

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**code** | **String** | Gets or sets api error code. | |
|**message** | **String** | Gets or sets error message. | |
|**description** | **String** | Gets or sets error description. | [optional] |
|**dateTime** | **OffsetDateTime** | Gets or sets server datetime. | [optional] |
|**innerError** | [**ApiError**](ApiError.md) | | [optional] |



12 changes: 8 additions & 4 deletions docs/ApiErrorResponse.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@


# ApiErrorResponse

ApiError Response

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**requestId** | **String** | | [optional]
**error** | [**ApiError**](ApiError.md) | | [optional]

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**requestId** | **String** | Gets or sets request Id. | |
|**error** | [**ApiError**](ApiError.md) | | |



11 changes: 0 additions & 11 deletions docs/AustralianPostParams.md

This file was deleted.

14 changes: 0 additions & 14 deletions docs/AutoSizeMode.md

This file was deleted.

14 changes: 0 additions & 14 deletions docs/AztecEncodeMode.md

This file was deleted.

Loading

0 comments on commit 7b8168e

Please sign in to comment.