CIRC-2136 set new location on check-in response and pick slip context.

.github/workflows/k8s-deploy-latest.yml

@@ -0,0 +1,27 @@
+# Very simple workflow to deploy the *latest* published container image with the 'latest' tag. 
+# This does not post updated module descriptors to okapi, update permissions or enable 
+# new versions of a module with the tenant.  If that is needed,  it should be done manually
+# via the Okapi API. 
+
+name: k8s-deploy-latest
+
+env:
+  K8S_NAMESPACE: 'snapshot-dev'
+  K8S_DEPLOYMENT: 'mod-circulation-dev'
+
+on:
+  workflow_dispatch
+
+jobs: 
+  k8s-deploy-latest:
+
+    runs-on: ubuntu-latest
+    steps: 
+      - name: Deploy latest to K8s
+        uses: actions-hub/[email protected]
+        env: 
+          KUBE_CONFIG: ${{ secrets.SNAPSHOT_DEV_SA_KUBECONFIG }}
+        with:
+          args:
+            -n ${{ env.K8S_NAMESPACE }} rollout restart deployment ${{ env.K8S_DEPLOYMENT }}
+

.github/workflows/mvn-dev-build-deploy.yml

@@ -0,0 +1,132 @@
+name: mvn-dev-build-deploy
+
+on:
+  push:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  workflow_dispatch:
+
+env:
+  PUBLISH_BRANCH: 'deployment'
+  OKAPI_URL: 'https://snapshot-dev-okapi.folio-dev.indexdata.com'
+  OKAPI_SECRET_USER: "${{ secrets.SNAPSHOT_DEV_OKAPI_USER }}"
+  OKAPI_SECRET_PASSWORD: "${{ secrets.SNAPSHOT_DEV_OKAPI_PASSWORD }}"
+  OK_SESSION: 'session1'
+
+jobs:
+  mvn-dev-build-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+          submodules: recursive
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: 17
+          distribution: 'temurin' # Alternative distribution options are available.
+
+      - name: Prepare okclient
+        run: git clone https://github.com/indexdata/okclient
+
+      - name: Ensure OK and FOLIO login
+        # So do not proceed with other workflow steps if not available.
+        run: |
+          source okclient/ok.sh
+          OK -S ${{ env.OK_SESSION }} \
+            -h ${{ env.OKAPI_URL }} \
+            -t "supertenant" \
+            -u ${{ env.OKAPI_SECRET_USER }} \
+            -p ${{ env.OKAPI_SECRET_PASSWORD }}
+          OK -S ${{ env.OK_SESSION }} -x
+
+      - name: Gather some variables
+        run: |
+          echo "MODULE_NAME=$(mvn help:evaluate -Dexpression=project.artifactId -q -DforceStdout)" >> $GITHUB_ENV
+          echo "SHA_SHORT=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
+          echo "CURRENT_BRANCH=$(echo ${GITHUB_REF#refs/heads/})" >> $GITHUB_ENV
+
+      - name: Set module version
+        run: |
+          echo "MODULE_VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)-${SHA_SHORT}" >> $GITHUB_ENV
+
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+
+      - name: Cache Maven packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+
+      - name: Maven build
+        run: mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent install org.jacoco:jacoco-maven-plugin:report
+
+      - name: SQ analyze
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: mvn -B org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.host.url=https://sonarcloud.io -Dsonar.organization=indexdata -Dsonar.projectKey=indexdata_${{ github.event.repository.name }}
+
+      - name: Update ModuleDescriptor Id
+        run: |
+          if test -f "$MOD_DESCRIPTOR"; then
+            echo "Found $MOD_DESCRIPTOR"
+            cat <<< $(jq '.id = "${{ env.MODULE_NAME}}-${{ env.MODULE_VERSION }}"' $MOD_DESCRIPTOR) > $MOD_DESCRIPTOR
+            echo "MODULE_DESCRIPTOR=$MOD_DESCRIPTOR" >> $GITHUB_ENV
+          else
+            echo "Could not find $MOD_DESCRIPTOR"
+            exit 1
+          fi
+        env:
+          MOD_DESCRIPTOR: './target/ModuleDescriptor.json'
+
+      - name: Read ModuleDescriptor
+        id: moduleDescriptor
+        uses: juliangruber/read-file-action@v1
+        with:
+          path: ${{ env.MODULE_DESCRIPTOR }}
+
+      - name: Login to Index Data Docker Hub account
+        if: ${{ env.CURRENT_BRANCH == env.PUBLISH_BRANCH }}
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USER }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build and publish Docker image
+        if: ${{ env.CURRENT_BRANCH == env.PUBLISH_BRANCH }}
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: indexdata/${{ env.MODULE_NAME }}:${{ env.MODULE_VERSION }},indexdata/${{ env.MODULE_NAME }}:latest
+
+      - name: Publish ModuleDescriptor to Okapi
+        if: ${{ env.CURRENT_BRANCH == env.PUBLISH_BRANCH }}
+        run: |
+          source okclient/ok.sh
+          echo "Do login ..."
+          OK -S ${{ env.OK_SESSION }} \
+            -h ${{ env.OKAPI_URL }} \
+            -t "supertenant" \
+            -u ${{ env.OKAPI_SECRET_USER }} \
+            -p ${{ env.OKAPI_SECRET_PASSWORD }}
+          echo "Post the MD and report the response status ..."
+          OK -S ${{ env.OK_SESSION }} _/proxy/modules \
+            -X post -f ${{ env.MODULE_DESCRIPTOR }}
+          declare -n NAMEREF_STATUS=${{ env.OK_SESSION }}_HTTPStatus
+          echo "Response status: $NAMEREF_STATUS"
+          echo "Do logout ..."
+          OK -S ${{ env.OK_SESSION }} -x
+
+      - name: Print module version to job summary
+        run: |
+          echo "#### Module Version: ${{ env.MODULE_VERSION }}" >> $GITHUB_STEP_SUMMARY

ramls/examples/loan.json

@@ -19,7 +19,8 @@
       {
         "name": "Steve Jones"
       }
-    ]
+    ],
+    "primaryContributor" : "Steve Jones"
   },
   "loanPolicyId" : "e9af4ba4-6801-4722-be45-d7a49d13564d",
   "loanPolicy": {
@@ -37,7 +38,9 @@
     "firstName" : "FirstName",
     "lastName" : "LastName",
     "middleName" : "MiddleName",
-    "barcode" : "102322966933815"
+    "barcode" : "102322966933815",
+    "preferredFirstName" : "preferredFirstName",
+    "patronGroup" : "3684a786-6671-4268-8ed0-9db82ebca60b"
   },
   "loanDate": "2017-03-01T23:11:00.000Z",
   "dueDate": "2017-04-01T23:11:00.000Z",

ramls/loan.json

@@ -38,6 +38,16 @@
           "description": "barcode used to identify the borrower (read only, defined by the server)",
           "type": "string",
           "readonly": true
+        },
+        "preferredFirstName": {
+          "description": "preferred first name of the borrower (read only, defined by the server)",
+          "type": "string",
+          "readonly": true
+        },
+        "patronGroup": {
+          "description": "current patron group of the borrower (read only, defined by the server)",
+          "type": "string",
+          "readonly": true
         }
        },
       "additionalProperties": false
@@ -158,6 +168,11 @@
             "additionalProperties": false
           }
         },
+        "primaryContributor": {
+          "description": "primary contributor of the item",
+          "type": "string",
+          "readonly": true
+        },
         "holdingsRecordId": {
           "description": "The ID of the holdings for the item",
           "type": "string",

ramls/request.json

@@ -423,6 +423,10 @@
       "description": "Request fields used for search",
       "type": "object",
       "$ref": "request-search-index.json"
+    },
+    "itemLocationCode": {
+      "description": "Allow specifying item location when creating title-level requests",
+      "type": "string"
     }
   },
   "additionalProperties": false,

src/main/java/org/folio/circulation/domain/Campus.java

@@ -9,9 +9,10 @@ public static Campus unknown() {
   }
 
   public static Campus unknown(String id) {
-    return new Campus(id, null);
+    return new Campus(id, null, null);
   }
 
   String id;
   String name;
+  String code;
 }

src/main/java/org/folio/circulation/domain/Institution.java

@@ -9,9 +9,10 @@ public static Institution unknown() {
   }
 
   public static Institution unknown(String id) {
-    return new Institution(id, null);
+    return new Institution(id, null, null);
   }
 
   String id;
   String name;
+  String code;
 }

src/main/java/org/folio/circulation/domain/Item.java

@@ -41,6 +41,9 @@ public class Item {
   @Getter
   private final String shelvingOrder;
   @NonNull private final Location permanentLocation;
+
+  @Getter
+  private final Location floatDestinationLocation;
   private final ServicePoint inTransitDestinationServicePoint;
 
   private boolean changed;
@@ -57,7 +60,7 @@ public static Item from(JsonObject representation) {
   }
   public Item(String id, JsonObject itemRepresentation, Location effectiveLocation,
     LastCheckIn lastCheckIn, CallNumberComponents callNumberComponents,
-    String shelvingOrder, Location permanentLocation,
+    String shelvingOrder, Location permanentLocation, Location floatDestinationLocation,
     ServicePoint inTransitDestinationServicePoint, boolean changed,
     Holdings holdings, Instance instance, MaterialType materialType,
     LoanType loanType, ItemDescription description) {
@@ -69,6 +72,7 @@ public Item(String id, JsonObject itemRepresentation, Location effectiveLocation
     this.callNumberComponents = callNumberComponents;
     this.shelvingOrder = shelvingOrder;
     this.permanentLocation = permanentLocation;
+    this.floatDestinationLocation = floatDestinationLocation;
     this.inTransitDestinationServicePoint = inTransitDestinationServicePoint;
     this.changed = changed;
     this.holdings = holdings;
@@ -348,59 +352,86 @@ public String getPermanentLocationId() {
     return firstNonBlank(permanentLocation.getId(), holdings.getPermanentLocationId());
   }
 
+  public String getFloatDestinationLocationId() {
+    return floatDestinationLocation != null ? floatDestinationLocation.getId() : null;
+  }
+
+  public boolean canFloatThroughCheckInServicePoint() {
+    return getLocation() != null
+      && getLocation().isFloatingCollection()
+      && getFloatDestinationLocation() != null
+      && getFloatDestinationLocation().getId()  != null;
+  }
+
   public Item withLocation(Location newLocation) {
     return new Item(this.id, this.itemRepresentation, newLocation,
       this.lastCheckIn, this.callNumberComponents, this.shelvingOrder,
-      this.permanentLocation, this.inTransitDestinationServicePoint, this.changed,
+      this.permanentLocation, this.floatDestinationLocation,
+      this.inTransitDestinationServicePoint, this.changed,
       this.holdings, this.instance, this.materialType, this.loanType, description);
   }
 
   public Item withMaterialType(@NonNull MaterialType materialType) {
     return new Item(this.id, this.itemRepresentation, this.location,
       this.lastCheckIn, this.callNumberComponents, this.shelvingOrder,
-      this.permanentLocation, this.inTransitDestinationServicePoint, this.changed,
+      this.permanentLocation, this.floatDestinationLocation,
+      this.inTransitDestinationServicePoint, this.changed,
       this.holdings, this.instance, materialType, this.loanType, this.description);
   }
 
   public Item withHoldings(@NonNull Holdings holdings) {
     return new Item(this.id, this.itemRepresentation, this.location,
       this.lastCheckIn, this.callNumberComponents, this.shelvingOrder,
-      this.permanentLocation, this.inTransitDestinationServicePoint, this.changed,
+      this.permanentLocation, this.floatDestinationLocation,
+      this.inTransitDestinationServicePoint, this.changed,
       holdings, this.instance, this.materialType, this.loanType, this.description);
   }
 
   public Item withInstance(@NonNull Instance instance) {
     return new Item(this.id, this.itemRepresentation, this.location,
       this.lastCheckIn, this.callNumberComponents, this.shelvingOrder,
-      this.permanentLocation, this.inTransitDestinationServicePoint, this.changed,
+      this.permanentLocation, this.floatDestinationLocation,
+      this.inTransitDestinationServicePoint, this.changed,
       this.holdings, instance, this.materialType, this.loanType, this.description);
   }
 
   public Item withLoanType(@NonNull LoanType loanType) {
     return new Item(this.id, this.itemRepresentation, this.location,
       this.lastCheckIn, this.callNumberComponents, this.shelvingOrder,
-      this.permanentLocation, this.inTransitDestinationServicePoint, this.changed,
+      this.permanentLocation, this.floatDestinationLocation,
+      this.inTransitDestinationServicePoint, this.changed,
       this.holdings, this.instance, this.materialType, loanType, this.description);
   }
 
   public Item withLastCheckIn(@NonNull LastCheckIn lastCheckIn) {
     return new Item(this.id, this.itemRepresentation, this.location,
       lastCheckIn, this.callNumberComponents, this.shelvingOrder,
-      this.permanentLocation, this.inTransitDestinationServicePoint, this.changed,
+      this.permanentLocation, this.floatDestinationLocation,
+      this.inTransitDestinationServicePoint, this.changed,
       this.holdings, this.instance, this.materialType, this.loanType, this.description);
   }
 
   public Item withPermanentLocation(Location permanentLocation) {
     return new Item(this.id, this.itemRepresentation, this.location,
       this.lastCheckIn, this.callNumberComponents, this.shelvingOrder,
-      permanentLocation, this.inTransitDestinationServicePoint, this.changed,
+      permanentLocation, this.floatDestinationLocation,
+      this.inTransitDestinationServicePoint, this.changed,
+      this.holdings, this.instance, this.materialType, this.loanType, this.description);
+  }
+
+  public Item withFloatDestinationLocation(Location floatDestinationLocation) {
+    return new Item(this.id, this.itemRepresentation, this.location,
+      this.lastCheckIn, this.callNumberComponents, this.shelvingOrder,
+      this.permanentLocation, floatDestinationLocation,
+      this.inTransitDestinationServicePoint, this.changed,
       this.holdings, this.instance, this.materialType, this.loanType, this.description);
   }
 
   public Item withInTransitDestinationServicePoint(ServicePoint servicePoint) {
     return new Item(this.id, this.itemRepresentation, this.location,
       this.lastCheckIn, this.callNumberComponents, this.shelvingOrder,
-      this.permanentLocation, servicePoint, this.changed, this.holdings,
+      this.permanentLocation, this.floatDestinationLocation,
+      servicePoint, this.changed, this.holdings,
       this.instance, this.materialType, this.loanType, this.description);
   }
 

src/main/java/org/folio/circulation/domain/Library.java

@@ -9,9 +9,10 @@ public static Library unknown() {
   }
 
   public static Library unknown(String id) {
-    return new Library(id, null);
+    return new Library(id, null, null);
   }
 
   String id;
   String name;
+  String code;
 }

src/main/java/org/folio/circulation/domain/LoanRepresentation.java

@@ -177,9 +177,9 @@ private void additionalBorrowerProperties(JsonObject loanRepresentation, User bo
     borrowerSummary.put("lastName", borrower.getLastName());
     borrowerSummary.put("middleName", borrower.getMiddleName());
     borrowerSummary.put("barcode", borrower.getBarcode());
-
+    borrowerSummary.put("preferredFirstName",borrower.getPreferredFirstName());
+    borrowerSummary.put("patronGroup",borrower.getPatronGroupId());
     loanRepresentation.put(BORROWER, borrowerSummary);
-
     additionalPatronGroupProperties(loanRepresentation, borrower.getPatronGroup());
   }