barkibu-kb 0.22.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60c13170a8bc9ef25645fcdef01fc91f75210c4c37b91a6625c6556f836b85b8
-  data.tar.gz: cff3103e0dd410df52443d5133899a7d0af5208e7122b2c55dd75526c464f842
+  metadata.gz: 29792b50e3dad51825c1fb0237155a3a6983a893173d00fafe3722e406f5f771
+  data.tar.gz: 3390ea2cc76d6d6ac5489fda5e4dbacd4b1cc556ba773a1e12f3ca21645ef9ed
 SHA512:
-  metadata.gz: fc81ede8d03708a18439bf9ff7c154e274cd61d37136788ad10a3361b089a8b6eb64d6b852e2e76778560133ef4f3e15c646779c9cf8cb15903521e4163abf19
-  data.tar.gz: 03dca28d0b6b9fab0c1c7b3d66e53746dd6368db4baf7f183a1e394072d3c7b31cdd949096c05c4019f2caac67a11b3ac1b9a8e2a5ced5c573635787529c96f5
+  metadata.gz: d76b73f6fcc48fad7f3242f3278e340d258f902b9bf999a61c7fe482c50fe734f28edf2aa28a88bbe37e61dcc6b56862e4f2ef31666fe8a2398609a1a5504d56
+  data.tar.gz: 3e83ee7c1e7c357661293f2bfa750ca29a9358afa7dc4dbf94216f7fd947b7a23616c964e87e31ab0dcd6c06dba04727881d4301d68ea6bd91482d8ed59a883e

data/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+# Human understandable Feature/Bugfix Title
+
+## Why?
+
+-- 
+
+## Changes
+
+ --
+
+## Checklist
+- [ ] Tests added/updated
+- [ ] README file updated
+- [ ] Changelog updated
+- [ ] Version file `lib/kb/version.rb` updated

data/CHANGELOG.md

@@ -6,7 +6,13 @@ 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.24.0...HEAD
+
+# [0.24.0]
+- Add support for `.referrers` method on `PetParent`
+
+# [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.24.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.24.0)
+      barkibu-kb (= 0.24.0)
       countries
       sinatra
       webmock
@@ -19,29 +19,38 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activerecord (7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activesupport (7.0.4.2)
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activerecord (7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      timeout (>= 0.4.0)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
     byebug (11.1.3)
-    concurrent-ruby (1.2.2)
-    countries (5.3.1)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    countries (5.7.2)
       unaccent (~> 0.3)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
     docile (1.4.0)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
+    domain_name (0.6.20240107)
+    drb (2.2.1)
     dry-configurable (0.16.1)
       dry-core (~> 0.6)
       zeitwerk (~> 2.6)
@@ -76,35 +85,40 @@ GEM
     faraday-retry (1.0.3)
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
-    ffi (1.15.5)
+    ffi (1.16.3)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
     hashdiff (1.0.1)
-    http (5.1.1)
+    http (5.2.0)
       addressable (~> 2.8)
+      base64 (~> 0.1)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
-      llhttp-ffi (~> 0.4.0)
+      llhttp-ffi (~> 0.5.0)
     http-cookie (1.0.5)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    llhttp-ffi (0.4.0)
+    llhttp-ffi (0.5.0)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
-    minitest (5.18.0)
-    multipart-post (2.3.0)
+    minitest (5.22.2)
+    multipart-post (2.4.0)
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
+    mutex_m (0.2.0)
     parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     public_suffix (4.0.7)
-    rack (2.2.6.3)
-    rack-protection (3.0.5)
-      rack
+    rack (3.0.9.1)
+    rack-protection (4.0.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
     rainbow (3.0.0)
     rake (13.0.6)
     regexp_parser (2.1.1)
@@ -143,24 +157,23 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
-    sinatra (3.0.5)
+    sinatra (4.0.0)
       mustermann (~> 3.0)
-      rack (~> 2.2, >= 2.2.4)
-      rack-protection (= 3.0.5)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.0.0)
+      rack-session (>= 2.0.0, < 3)
       tilt (~> 2.0)
-    tilt (2.1.0)
+    tilt (2.3.0)
+    timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unaccent (0.4.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8.2)
     unicode-display_width (2.1.0)
     webmock (3.14.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.13)
 
 PLATFORMS
   ruby
@@ -168,7 +181,7 @@ PLATFORMS
 DEPENDENCIES
   barkibu-kb!
   barkibu-kb-fake!
-  bundler (~> 2.4.12)
+  bundler
   byebug
   rake (>= 12.3.3)
   rspec (~> 3.0)
@@ -178,4 +191,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.4.12
+   2.4.19

data/README.md

@@ -72,6 +72,8 @@ KB.config.log_level = :debugger # :info by default
   - returns all the KB::PetContract associated with this pet parent
 - `referrals`
   - returns all the KB::Referral associated with this pet parent
+- `referrers`
+  - returns all the KB::Referral associated with any of the pet parent's pets 
 
 #### Assessment 📄
 
@@ -117,7 +119,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 +140,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 +245,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/barkibu-kb.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.6'
 
   spec.add_dependency 'dry-configurable', '~> 0.9'
-  spec.add_development_dependency 'bundler', '~> 2.4.12'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'

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/pet_parent.rb

@@ -113,5 +113,11 @@ module KB
         Referral.from_api(referral)
       end
     end
+
+    def referrers
+      self.class.kb_client.request("#{key}/referrers").map do |referral|
+        Referral.from_api(referral)
+      end
+    end
   end
 end

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.24.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.24.0
 platform: ruby
 authors:
 - Léo Figea
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.12
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.12
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -243,6 +243,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example"
+- ".github/pull_request_template.md"
 - ".github/workflows/release.yaml"
 - ".gitignore"
 - ".rspec"
@@ -276,6 +277,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 +298,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 +309,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