dvla-kaping 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09c60001616143c58b1a1023bea7cdcf653c495ea1410222d767dc8718f4507b'
-  data.tar.gz: 713da1c1de593ffc1e516aa4a0727eae53174fb6832f82a0b8c988b7bba85ff7
+  metadata.gz: 99f6221990bbf656183aec0b2880b716f67038fd43a8e4daa72a80004dc15d76
+  data.tar.gz: 20b2397b50c3c0e847b8a0b6b675b53755c90cfaf89674db85922bbb7e7a00c8
 SHA512:
-  metadata.gz: f182de8966f9e515888ccfc137322df7a1fb8a84e7949ae2a9d8d439ff2ecc3f9f464766d864de3d7ec2480d3f965541be74e80af92e9eb8fc7b4d26ded224c0
-  data.tar.gz: 25a74e3a85a3719952e7239919b53aa1e6a9294713ece79c60ee42cce20ac862fb9b4487e65ceed33661f731dad97f1fdaaacd5256b968aab9fe69fb6f3a63cf
+  metadata.gz: 71ec529b6e6dedaa7655ad86b33acf5ccf2edac1d32a6f195eba38033134be880b928796e256efd63cb4cc9dde3d191488c4a781db54f851219a04859ecfa2a2
+  data.tar.gz: 0efa699c3eba860ed2b4b03d80fe9a4452eef8dd541e7c39690cb113f6bb715036fb01688acfd1e1be14351318885fdead1a961116749f5da185980df06ab5ef

data/.ruby-version

@@ -1 +1 @@
-3.4.2
+3.4.7

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.7

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
-## [0.1.0] - 2024-11-07
+## [1.0.2] - 2024-11-07
 
 - Initial release
+
+## [1.0.3] - 2025-09-03
+
+- Moved runtime dependencies to the gemspec
+
+## [1.0.4] - 2025-11-10
+
+- Update gems and fixed issue with git actions
+

data/README.md

@@ -1,6 +1,13 @@
 # Dvla::Kaping
 
-The Kaping! gem - an idiomatic way to create DSL openSearch definitions
+The Kaping! Gem, an idiomatic way to create DSL openSearch definitions
+
+The Ka-Ping Ruby gem enables the user to build complex ElasticSearch DSL Queries for searching and filtering large data sets
+without having to worry about formatting the JSON payloads. 
+
+Using Ruby dot notation with intuitive search terms and operations, it's easier to construct human-readable search definitions 
+without needing a deep understanding of the Query DSL syntax
+
 
 ## OpenSearch Query DSL
 https://opensearch.org/docs/latest/query-dsl/
@@ -28,10 +35,10 @@ complex to construct so this gem looks to simplify the process.
 
 ## Query and filter context
 
-A filter context asks - “Does the document match the query clause?” and returns matching documents 
+A filter context asks: “Does the document match the query clause?” and returns matching documents 
 i.e it's a binary answer
 
-A query context asks - “How well does the document match the query clause?”, - also returns a relevance score
+A query context asks: “How well does the document match the query clause?”, - also returns a relevance score
 good for full-text searches
 
 # How to use
@@ -55,8 +62,8 @@ DVLA::Kaping.configure { |attr| attr.yaml_override_path = './config/kaping.yml'
 ```
 The 'index' setting will control what environment to target
 
-The 'result_size' setting determines how many records to be returned from the query, if you are doing a post query filtering 
-code side then you should pump this value up.
+The 'result_size' setting determines how many records to be returned from the query, if you are doing a post-query filtering 
+code side, then you should pump this value up.
 
 ```yml
 kaping:
@@ -73,7 +80,7 @@ Profile will just pick up the credentials save in your specified shared credenti
 
 ```yml
   aws:
-    #  to use a AWS profile config file then set to profile, otherwise environment settings will be used
+    #  to use an AWS profile config file then set to profile, otherwise environment settings will be used
     credential_type: profile
     account_id: ##########
     region: aws-region
@@ -106,7 +113,7 @@ body = DVLA::Kaping::Query.new('bool')
 ## Query building
 A query can be built up with dot notation, but there are a few rules to follow. 
 
-First get a new Kaping Query instance. If we want a new Boolean query then we set the type as bool. 
+First, get a new Kaping Query instance. If we want a new Boolean query then we set the type as bool. 
 ```ruby
 my_query = DVLA::Kaping::Query.new('bool')
 my_query.filter.term('foo.bar', 'Valid').

data/lib/dvla/kaping/aws_client.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'aws-sdk-core'
 require 'opensearch-aws-sigv4'
 require 'aws-sigv4'
+require 'aws-sdk-sts'
 
 module DVLA
   module Kaping

data/lib/dvla/kaping/version.rb

@@ -2,6 +2,6 @@
 
 module DVLA
   module Kaping
-    VERSION = '1.0.0'
+    VERSION = '1.0.4'
   end
 end

metadata

@@ -1,35 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: dvla-kaping
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - Driver and Vehicle Licensing Agency (DVLA)
 - Kevin Upstill
 bindir: exe
 cert_chain: []
-date: 2025-04-11 00:00:00.000000000 Z
+date: 2025-11-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: aws-sigv4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.18.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.18.8
+- !ruby/object:Gem::Dependency
+  name: opensearch-aws-sigv4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.7
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.7
+        version: 1.2.1
 description: Wrapper for the AWS elastic search API to create an idiomatic way to
   build complex search queries
 email:
@@ -38,10 +86,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".drone.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENCE

data/.drone.yml

@@ -1,122 +0,0 @@
----
-kind: pipeline
-name: audit, lint & test
-
-platform:
-  os: linux
-  arch: amd64
-
-trigger:
-  event:
-    - push
-
-drone_cache_image: &drone_cache_image
-  image: 448934085854.dkr.ecr.eu-west-2.amazonaws.com/ce/drone-cache
-  pull: if-not-exists
-
-drone_cache_settings: &drone_cache_settings
-  bucket: dvla-drone1-cache-448934085854
-  region: eu-west-2
-  encryption: AES256
-  endpoint: https://s3.eu-west-2.amazonaws.com
-
-gem_cache_mount: &gem_cache_mount
-  mount:
-    - vendor/bundle
-
-ruby_image: &ruby_image
-  image: 448934085854.dkr.ecr.eu-west-2.amazonaws.com/base-images/qe-ruby:3
-
-sonar_image: &sonar_image
-  image: 448934085854.dkr.ecr.eu-west-2.amazonaws.com/utilities-ci-tools/ci-drone-sonar-scanner
-  pull: if-not-exists
-
-steps:
-  - name: Restore gems from cache
-    <<: *drone_cache_image
-    settings:
-      <<: *drone_cache_settings
-      <<: *gem_cache_mount
-      restore: true
-      cache_key: '{{ checksum "./README.md" }}' # Override the README to force a rebuild
-
-  - name: Unit tests
-    <<: *ruby_image
-    depends_on:
-      - Restore gems from cache
-    commands:
-      - bundle install
-      - bundle exec rspec
-    environment:
-      BUNDLE_PATH: vendor/bundle
-
-  - name: Gem audit
-    <<: *ruby_image
-    depends_on:
-      - Restore gems from cache
-    commands:
-      - bundle install
-      - bundle exec bundle-audit
-    environment:
-      BUNDLE_PATH: vendor/bundle
-
-  - name: Lint
-    <<: *ruby_image
-    depends_on:
-      - Restore gems from cache
-    commands:
-      - bundle install
-      - bundle exec rubocop
-    environment:
-      BUNDLE_PATH: vendor/bundle
-
-  - name: SonarQube
-    <<: *sonar_image
-    depends_on:
-      - Unit tests
-
-  - name: Build and deploy (dry-run)
-    image: 448934085854.dkr.ecr.eu-west-2.amazonaws.com/utilities-ci-tools/ci-qe-deploy-gem:latest
-    commands:
-      - git fetch origin main
-      - app
-    environment:
-      DRYRUN: true
-      VERBOSE: false
-
-  - name: Rebuild gem cache
-    <<: *drone_cache_image
-    depends_on:
-      - Gem audit
-    settings:
-      <<: *drone_cache_settings
-      <<: *gem_cache_mount
-      rebuild: true
-      cache_key: '{{ checksum "./README.md" }}'
-
----
-kind: pipeline
-name: deploy
-depends_on:
-  - audit, lint & test
-
-platform:
-  os: linux
-  arch: amd64
-
-trigger:
-  event:
-    - push
-  branch:
-    - main
-
-steps:
-  - name: Build and deploy
-    image: 448934085854.dkr.ecr.eu-west-2.amazonaws.com/utilities-ci-tools/ci-qe-deploy-gem:latest
-    commands:
-      - git fetch origin main
-      - app
-    environment:
-      DRYRUN: false
-      VERBOSE: false
-