Merge branch 'BerryCloud:main' into main

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,94 @@
+name: Bug Report
+description: Create a bug report to help us improve
+title: "[Bug]: "
+labels: ["bug", "triage"]
+assignees:
+  - knoake
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: A clear and concise description of what the bug is.
+      placeholder: Posting a statement with an attachment fails with a 400 error
+    validations:
+      required: true
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to reproduce
+      description: |
+        Steps to reproduce the behavior.
+
+        A unit test or JDoodle (https://www.jdoodle.com/online-java-compiler) example would be very helpful.
+
+      placeholder: |
+        ```java
+        @Test
+          void whenPostingStatementWithAttachmentThenResponseStatusCodeIsOk()
+              throws InterruptedException {
+
+            // When Posting Statement With Attachment
+            var response = client.postStatement(r -> r
+                .statement(s -> s.agentActor(a -> a.name("A N Other").mbox("mailto:another@example.com"))
+
+                    .addAttachment(a -> a.content("Simple attachment").length(17).contentType("text/plain")
+                        .usageType(URI.create("http://adlnet.gov/expapi/attachments/text"))
+                        .addDisplay(Locale.ENGLISH, "text attachment"))
+
+                    .verb(Verb.ATTEMPTED)
+
+                    .activityObject(o -> o.id("https://example.com/activity/simplestatement")
+                        .definition(d -> d.addName(Locale.ENGLISH, "Simple Statement")))))
+                .block();
+
+            // Then Response Status Code Is Ok
+            assertThat(response.getStatusCode().value(), is(200));
+          }
+          ```
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+      placeholder: The statement is posted successfully with a 200 response status code
+    validations:
+      required: true
+  - type: textarea
+    id: actual-behavior
+    attributes:
+      label: Actual behavior
+      description: A clear and concise description of what actually happens.
+      placeholder: The statement fails to post with a 400 response status code
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Notes
+      description: Any additional information that might be useful
+      placeholder: |
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false
+  - type: dropdown
+    id: version
+    attributes:
+      label: Version
+      description: |
+        What version of our software are you running?
+
+        Please note that we only support the latest version of our software.
+      options:
+        - 1.x
+        - 2.x
+        - 3.x
+        - 4.x
+        - 5.x
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/enhancement-request.yml

@@ -0,0 +1,36 @@
+name: Enhancement request
+description: Suggest an enhancement for this project
+title: "[Enhancement]: "
+labels: ["enhancement", "triage"]
+assignees:
+  - knoake
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this enhancement request!
+  - type: textarea
+    id: what
+    attributes:
+      label: What
+      description: What does the enhancement do?
+      placeholder: I want to be able to...
+    validations:
+      required: true
+  - type: textarea
+    id: why
+    attributes:
+      label: Why
+      description: Why is the enhancement useful?
+      placeholder: So that I can...
+    validations:
+      required: true
+  - type: textarea
+    id: notes
+    attributes:
+      label: Notes
+      description: Any other information or screenshots about the enhancement.
+      placeholder: |
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/dependabot.yml

@@ -9,3 +9,5 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "weekly"
+    reviewers:
+      - "berrycloud/reviewers"

.github/workflows/maven_pull_request.yml

@@ -2,7 +2,7 @@
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
 
 name: Java CI with Maven on Pull Request
-  
+
 on:
   pull_request:
     branches: ["main"]
@@ -24,7 +24,7 @@ jobs:
         run: |
           if [ $FORK = false ]
           then
-            mvn org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BerryCloud_xapi-java -Dsonar.organization=berry-cloud -Dsonar.host.url=https://sonarcloud.io --file pom.xml
+            mvn org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BerryCloud_xapi-java -Dsonar.organization=berrycloud -Dsonar.host.url=https://sonarcloud.io --file pom.xml
           fi
         env:
           FORK: ${{ github.event.pull_request.head.repo.fork }}

.github/workflows/maven_push.yml

@@ -2,7 +2,7 @@
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
 
 name: Java CI with Maven on Push
-  
+
 on:
   push:
     branches: ["main"]
@@ -21,7 +21,7 @@ jobs:
       - name: Build with Maven
         run: mvn -B verify --file pom.xml
       - name: Scan with Sonar
-        run: mvn org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BerryCloud_xapi-java -Dsonar.organization=berry-cloud -Dsonar.host.url=https://sonarcloud.io --file pom.xml
+        run: mvn org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=BerryCloud_xapi-java -Dsonar.organization=berrycloud -Dsonar.host.url=https://sonarcloud.io --file pom.xml
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "java.compile.nullAnalysis.mode": "automatic",
+  "java.configuration.updateBuildConfiguration": "interactive",
+  "cSpell.words": ["István", "Rátkai", "Selindek", "Turrell", "xapi"]
+}

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2014-2023 Berry Cloud Ltd
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.