barkibu-kb 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60c13170a8bc9ef25645fcdef01fc91f75210c4c37b91a6625c6556f836b85b8
-  data.tar.gz: cff3103e0dd410df52443d5133899a7d0af5208e7122b2c55dd75526c464f842
+  metadata.gz: aa7e82e12cf78117dbe83ba60f544050a2f46b0c24a9dacd88ff6aac23061863
+  data.tar.gz: 9c5541c4cf7f89a55ae003fc75c3520e95fc798fe6d780242895da5797f7abf5
 SHA512:
-  metadata.gz: fc81ede8d03708a18439bf9ff7c154e274cd61d37136788ad10a3361b089a8b6eb64d6b852e2e76778560133ef4f3e15c646779c9cf8cb15903521e4163abf19
-  data.tar.gz: 03dca28d0b6b9fab0c1c7b3d66e53746dd6368db4baf7f183a1e394072d3c7b31cdd949096c05c4019f2caac67a11b3ac1b9a8e2a5ced5c573635787529c96f5
+  metadata.gz: f79f76c3209b161230e60e6e05522d1de24d9bc8e63c381cca6f33199b7c74ddd21dcbc3d311d866816a46abb7ba5327841919f85b820361a9e36553cea7824b
+  data.tar.gz: 4b58d329d5271f89649153d417838ab93f30c4e0f991060522b08d21f3e716c0333eb529723866db443776411a64336b2ec909b310e092d49980d517032145f4

data/CHANGELOG.md

@@ -6,7 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [unreleased]
-- See diff: https://github.com/barkibu/kb-ruby/compare/v0.22.0...HEAD
+- See diff: https://github.com/barkibu/kb-ruby/compare/v0.23.0...HEAD
+
+# [0.23.0]
+- Add support for `.search` method on `PetContract`
 
 # [0.22.0]
 - Fix error parsing if HTTP client returns no response

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    barkibu-kb (0.22.0)
+    barkibu-kb (0.23.0)
       activemodel (>= 4.0.2)
       activerecord
       activesupport (>= 3.0.0)
@@ -10,8 +10,8 @@ PATH
       faraday-http
       faraday_middleware
       i18n
-    barkibu-kb-fake (0.22.0)
-      barkibu-kb (= 0.22.0)
+    barkibu-kb-fake (0.23.0)
+      barkibu-kb (= 0.23.0)
       countries
       sinatra
       webmock
@@ -178,4 +178,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.4.12
+   2.4.19

data/README.md

@@ -117,7 +117,7 @@ KB.config.log_level = :debugger # :info by default
   - returns all the KB::PetContract associated with this pet
 - `upsert`
   - updates KB:Pet if exists a Pet with same name for its PetParent
-  - creates a new KB:Pet if not exists a Pet with same name for its PetParent 
+  - creates a new KB:Pet if not exists a Pet with same name for its PetParent
 
 #### PetContract 📝
 
@@ -138,6 +138,15 @@ KB.config.log_level = :debugger # :info by default
 - `save!`
   - persists (create or update) the entity to the Knowledge Base
   - throws an `KB::Error` exception if something went wrong
+- `search`
+  - arg: `filters` hash. Currently, KB API supports these keys:
+    - `page`: results page number. Default 0.
+    - `size`: amount of results per page. Default 10.
+    - `chip`: searches contracts by insured pet chip
+  - returns: a hash including:
+    - `total`: total amount of contracts found
+    - `page`: current page number
+    - `elements`: array of PetContract instances matching the filters
 
 #### Plan 🗺
 
@@ -234,12 +243,18 @@ You should be able to use the API seemlessly and the calls to the API will be in
 ## Development & Testing
 
 ```bash
-    docker run -it --rm -v $(pwd):/app --workdir=/app ruby:2.6.5 bash
-
-    > bundle install
-    > rspec
+docker run -it --rm -v $(pwd):/app --workdir=/app ruby:2.7.2 bash
+> bundle install
+> rspec
 ```
 
+You can also start an interactive console if needed:
+```bash
+KB_API_URL_TEMPLATE=https://example.com/%{version}/%{entity} \
+KB_API_KEY=YourKbApiKey \
+KB_PARTNER_KEY=YourKbPartnerKey \
+bin/console
+```
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/kb/fake/bounded_context/paginable.rb

@@ -0,0 +1,18 @@
+module BoundedContext
+  module Paginable
+    extend ActiveSupport::Concern
+
+    included do
+      def paginate(list)
+        list = list.to_a
+        page = params.fetch('page', 1).to_i
+        page_size = params.fetch('size', 10).to_i
+        offset = (page - 1) * page_size
+
+        { total: list.size,
+          page: page,
+          elements: list[offset, page_size] }
+      end
+    end
+  end
+end

data/lib/kb/fake/bounded_context/pet_family/pet_contracts.rb

@@ -1,12 +1,15 @@
 require 'kb/fake/bounded_context/rest_resource'
+require 'kb/fake/bounded_context/paginable'
 
 module BoundedContext
   module PetFamily
     module PetContracts
       extend ActiveSupport::Concern
 
+      # rubocop:disable Metrics/BlockLength
       included do
         include RestResource
+        include Paginable
 
         get '/v1/petcontracts/contractnumber/:contract_number' do
           resource = resource_state(:petcontracts).detect do |contract|
@@ -17,8 +20,24 @@ module BoundedContext
           json_response 200, resource
         end
 
+        get '/v1/petcontracts/search' do
+          return json_response 400, {} unless params['chip']
+
+          pet_by_chip = resource_state(:pets).detect do |pet|
+            pet['chip'] == params['chip']
+          end
+          return json_response 200, paginate([]) if pet_by_chip.nil?
+
+          contracts = resource_state(:petcontracts).select do |contract|
+            contract['petKey'] == pet_by_chip['key']
+          end
+
+          json_response 200, paginate(contracts)
+        end
+
         resource :petcontracts, except: %i[index destroy]
       end
+      # rubocop:enable Metrics/BlockLength
     end
   end
 end

data/lib/kb/models/concerns/searchable.rb

@@ -0,0 +1,19 @@
+module KB
+  module Searchable
+    extend ActiveSupport::Concern
+
+    included do
+      include Queryable
+    end
+
+    module ClassMethods
+      def search(filters)
+        response = kb_client.request('search', filters: filters).symbolize_keys
+        elements = response[:elements].map { |contract| from_api(contract) }
+        KB::SearchResult.new(**response.merge(elements: elements))
+      rescue Faraday::Error => e
+        raise KB::Error.from_faraday(e)
+      end
+    end
+  end
+end

data/lib/kb/models/concerns.rb

@@ -8,3 +8,4 @@ require 'kb/models/concerns/upsertable'
 require 'kb/models/concerns/updatable'
 require 'kb/models/concerns/listable'
 require 'kb/models/concerns/destroyable'
+require 'kb/models/concerns/searchable'

data/lib/kb/models/pet_contract.rb

@@ -3,6 +3,7 @@ module KB
     include Findable
     include Creatable
     include Updatable
+    include Searchable
 
     kb_api :pet_contract
 

data/lib/kb/models/search_result.rb

@@ -0,0 +1,11 @@
+module KB
+  class SearchResult
+    attr_reader :elements, :total, :page
+
+    def initialize(elements:, total:, page:)
+      @elements = elements
+      @total = total
+      @page = page
+    end
+  end
+end

data/lib/kb/models.rb

@@ -14,3 +14,4 @@ require 'kb/models/breed'
 
 require 'kb/models/hubspot_relationship'
 require 'kb/models/referral'
+require 'kb/models/search_result'

data/lib/kb/version.rb

@@ -1,3 +1,3 @@
 module KB
-  VERSION = '0.22.0'.freeze
+  VERSION = '0.23.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barkibu-kb
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Léo Figea
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -276,6 +276,7 @@ files:
 - lib/kb/errors/unprocessable_entity_error.rb
 - lib/kb/fake.rb
 - lib/kb/fake/api.rb
+- lib/kb/fake/bounded_context/paginable.rb
 - lib/kb/fake/bounded_context/pet_family/breeds.rb
 - lib/kb/fake/bounded_context/pet_family/hubspot_relationship.rb
 - lib/kb/fake/bounded_context/pet_family/pet_contracts.rb
@@ -296,6 +297,7 @@ files:
 - lib/kb/models/concerns/inspectionable.rb
 - lib/kb/models/concerns/listable.rb
 - lib/kb/models/concerns/queryable.rb
+- lib/kb/models/concerns/searchable.rb
 - lib/kb/models/concerns/updatable.rb
 - lib/kb/models/concerns/upsertable.rb
 - lib/kb/models/condition.rb
@@ -306,6 +308,7 @@ files:
 - lib/kb/models/plan.rb
 - lib/kb/models/product.rb
 - lib/kb/models/referral.rb
+- lib/kb/models/search_result.rb
 - lib/kb/models/symptom.rb
 - lib/kb/type/array_of_conditions_type.rb
 - lib/kb/type/array_of_strings_type.rb