barkibu-kb 0.16.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb67cd61d20540319a057c991e8d3057f7de137f34b766cd083a00f503587168
-  data.tar.gz: a8a9eede090992a9aa54b3f7eacb6e4e3840b6f3932d809a4bfa8315f38dde61
+  metadata.gz: a893e849049eb479e171c341b8cf56d22a2ade1c248083ee5a9cd66f251c7cc4
+  data.tar.gz: 2008d1d02b6ecc392c5db59d579a07659de53ad4302c97b55d08cd24b0030f0c
 SHA512:
-  metadata.gz: 9139e56115d588e201d0247761a429fab0c01fc3ea9676eb05cc211915a72ad45077ca4996c39f9b080413f81d6263636ba2a6a5fefbb815907bb47e7b8f2015
-  data.tar.gz: 6e78fed61516a203cf2e07db8c6e088fa242a4fbe083cf7380f8e6e3d8e55b660a9a5fe7395ff52197be90b5cd21002e5b32d29e886cddd5e7a90b8ea46c3826
+  metadata.gz: 904e31438bad89e6762e43031a6ae3914dd8d7d5095faed0787ee44a4cc2d945cfbbf6ebae92680db63ab3fce64553715cd496963fd365f33e87fa80dfcaacce
+  data.tar.gz: 6f84cc1cef486ecc571c22ad4e0a08db129b6d456f5b722a389679af84a34e291e4ae7ee0f63b5f3db4b68bdb93802a146dd68a5c8ac74870f41c01a41fb312f

data/.github/workflows/release.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
 
       - name: Github whoami
         run: |
@@ -19,4 +19,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
           RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
-          RELEASE_COMMAND: rake release
+          RELEASE_COMMAND: rake release

data/.gitignore

@@ -17,4 +17,5 @@
 .byebug_history
 
 # intellij
-/.idea
+/.idea
+.env

data/.rubocop.yml

@@ -21,13 +21,13 @@ RSpec/FilePath:
 Metrics/BlockLength:
   Max: 15
   Exclude:
-    - 'spec/**/*.rb'
-    - 'barkibu-kb.gemspec'
-    - 'barkibu-kb-*.gemspec'
+    - "spec/**/*.rb"
+    - "barkibu-kb.gemspec"
+    - "barkibu-kb-*.gemspec"
 
 Naming/FileName:
   Exclude:
-    - 'lib/barkibu-kb*.rb'
+    - "lib/barkibu-kb*.rb"
 
 Style/FrozenStringLiteralComment:
   Enabled: false
@@ -43,3 +43,6 @@ Metrics/MethodLength:
 
 Metrics/ModuleLength:
   Max: 110
+
+RSpec/ExampleLength:
+  CountAsOne: ["array", "heredoc", "hash"]

data/CHANGELOG.md

@@ -1,146 +1,196 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 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).
 
+## [0.17.0]
+
+- add `KB::Referral` model to create a referral on a PetParent
+- add `PetParent#referrals` to get a list of referrals
+
 ## [0.16.2]
+
 - Rename gems to barkibu-kb / barkibu-kb-fake
 
 ## [0.16.0]
+
 - Add `Hubspot` model to retrieve information from [Hubspot Relationship endpoint](https://knowledge-base-staging.herokuapp.com/swagger-ui/index.html#/Hubspot)
 - Change `husbpot_id` attribute on PetContract, now it comes from the Hubspot Relationship
 
 ## [0.15.1]
+
 - Fix Cache invalidation deleting wrong key
 
 ## [0.15.0]
+
 - Add `husbpot_id` attribute on PetContract
 
 ## [0.14.2]
+
 - Fix Merged Pet Parent instanciation
 
 ## [0.14.1]
+
 - Convert API exception into KB::Error for admin `merge!` endpoint
 
 ## [0.14.0]
+
 - Add admin `merge!` method on PetParent
 
 ## [0.13.0]
-- Add `affiliate_code`  attribute on PetParent
+
+- Add `affiliate_code` attribute on PetParent
 
 ## [0.12.0]
+
 - Add `phone_number_verified` and `email_verified` attributes on PetParent
 
 ## [0.11.0]
+
 - Expose product_key on PetContract
 
 ## [0.10.0]
+
 - Add KB::Product Entity
 
 ## [0.9.0]
+
 - Add conversion_utm_adgroup_id and conversion_utm_campaign_id to PetContract
 
 ## [0.8.0]
-- Add conversion_utm_\* attributes to PetContract
+
+- Add conversion*utm*\* attributes to PetContract
 
 ## [0.7.2]
+
 - Fix kb-fake pet parent upsert with partial identification
 
 ## [0.7.1]
+
 - Fix dsl-configurable positional arg deprecated warning
 
 ## [0.7.0]
+
 - Add new Error classes
 - Emulate the same behavior on Pet Parent Upsert
 
 ## [0.6.0]
+
 - Add price_discount_yearly PetContract attribute
 
 ## [0.5.0]
+
 - Switch to consume petfamily based consultation endpoint
 
 ## [0.4.10]
+
 - Add affiliate PetContract attributes
 
 ## [0.4.9]
+
 - Fix ActiveModel dirty implementation
 
 ## [0.4.8]
+
 - Fix KB::Error not accepting nil body
 
 ## [0.4.7]
+
 - Breed - Add external_id field
 
 ## [0.4.6]
+
 - PetParent - Add more KB fields
 
 ## [0.4.5]
+
 - Breeds - Add server endpoint for tests on fake gem
 
 ## [0.4.4]
+
 - Breeds - Adjust fields definition to petfamily domain ones
 
 ## [0.4.3]
+
 - Breeds - Change client resolver template to use petfamily domain
 
 ## [0.4.2]
+
 - Assessment - Parse time from date
 
 ## [0.4.1]
+
 - Add Pet Upsert method
 
 ## [0.4.0]
+
 - Add Upsert Endpoint
 
 ## [0.3.6]
+
 - Add cache to client request method
 
 ## [0.3.5]
+
 - Add Dry gem and setup config
 - Add cache as gem config settings
 - Add log level as gem config settings
 - Improve KB Exceptions definitions
 
 ## [0.3.4]
+
 - Fix planName attributes wrongly named on Plan
 
 ## [0.3.3]
+
 - Fix buyable and planLifeInMonths attributes wrongly named on Plan
 
 ## [0.3.2]
+
 - Exposes `KB::PetContract` entity
 - Add `contracts` method to `KB::Pet` and `KB::PetParent`
 
 ## [0.3.1]
+
 - Fix Fake Consultation wrong endpoint version
 
 ## [0.3.0]
+
 - Extracted `kb-fake` gem for client test purposes
 
 ## [0.2.7]
+
 - Fix missing deleted_at accessors on PetParent and Pet entities
 
 ## [0.2.6]
+
 - Exposes `Destroyable` concerns on PetParent and Pet entities
 
 ## [0.2.5]
+
 - Exposes `FindOrCreatable` concerns on PetParent and Pet entities
 
 ## [0.2.4]
+
 - Fix Assessment not properly localized
 
 ## [0.2.3]
+
 - Fix missing ActiveSupport dependency loading
 
 ## [0.2.2]
+
 - Fix custom array types returning single element
 - Test dependency extracted
 
 ## [0.2.1]
+
 - Fix gem loading order for tests
 
 ## [0.2.0]
+
 - Provide FakeApi for client implementation testing
 - Add Pet entity
 - Add `AsKBWrapper` concern for easy activerecord wrapping
@@ -148,9 +198,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `AsKBWrapper` - add `skip_callback` option
 
 ## [0.1.1] - 2020-01-12
+
 - Init Version: Breeds and limited PetParents/Consultations
 
-[Unreleased]: https://github.com/barkibu/kb-ruby/compare/v0.10.0...HEAD
+[unreleased]: https://github.com/barkibu/kb-ruby/compare/v0.10.0...HEAD
 [0.10.0]: https://github.com/barkibu/kb-ruby/compare/v0.9.0...0.10.0
 [0.9.0]: https://github.com/barkibu/kb-ruby/compare/v0.8.0...0.9.0
 [0.8.0]: https://github.com/barkibu/kb-ruby/compare/v0.7.2...0.8.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    barkibu-kb (0.16.2)
+    barkibu-kb (0.17.0)
       activemodel (>= 4.0.2)
       activerecord
       activesupport (>= 3.0.0)
@@ -10,8 +10,8 @@ PATH
       faraday-http
       faraday_middleware
       i18n
-    barkibu-kb-fake (0.16.2)
-      barkibu-kb (= 0.16.2)
+    barkibu-kb-fake (0.17.0)
+      barkibu-kb (= 0.17.0)
       countries
       sinatra
       webmock
@@ -81,7 +81,7 @@ GEM
       ffi (>= 1.0.0)
       rake
     hashdiff (1.0.1)
-    http (5.0.4)
+    http (5.1.0)
       addressable (~> 2.8)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
@@ -96,7 +96,7 @@ GEM
     llhttp-ffi (0.4.0)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
-    minitest (5.15.0)
+    minitest (5.16.1)
     multipart-post (2.2.3)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
@@ -177,6 +177,7 @@ DEPENDENCIES
   rubocop
   rubocop-rspec
   simplecov
+  webmock
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -70,6 +70,8 @@ KB.config.log_level = :debugger # :info by default
   - throws a `KB::Error` exception if something went wrong
 - `contracts`
   - returns all the KB::PetContract associated with this pet parent
+- `referrals`
+  - returns all the KB::Referral associated with this pet parent
 
 #### Assessment 📄
 
@@ -162,6 +164,14 @@ KB.config.log_level = :debugger # :info by default
   - arg: `filters` hash of filters
   - returns: and array of Cat Breed instances matching the filters
 
+#### Referral
+`KB::Referral` represets a referral resource
+
+- `create`
+  - arg: `pet_parent_key`, `attributes` to initialize the entity
+  - returns: the raw attributes of the Referral instance
+  - throws an `KB::Error` exception if something went wrong
+
 ### Make an ActiveRecord wrap a KB entity
 
 The `KB::Concerns::AsKBWrapper` concern has been created in order to easily make an ActiveRecord model wrap a KB model.

data/barkibu-kb.gemspec

@@ -44,6 +44,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
   spec.add_runtime_dependency 'activemodel', '>= 4.0.2'
   spec.add_runtime_dependency 'activerecord'
   spec.add_runtime_dependency 'activesupport', '>= 3.0.0'

data/lib/kb/client.rb

@@ -8,7 +8,7 @@ module KB
     end
 
     def request(sub_path, filters: nil, method: :get)
-      return connection.public_send(method, sub_path, filters).body if method != :get
+      return connection.public_send(method, sub_path, attributes_to_json(filters)).body if method != :get
 
       cache_key = "#{@base_url}/#{sub_path}/#{(filters || {}).sort.to_h}"
       KB::Cache.fetch(cache_key) do

data/lib/kb/fake/api.rb

@@ -8,11 +8,12 @@ require 'kb/fake/bounded_context/pet_family/hubspot_relationship'
 module KB
   module Fake
     class ApiState
-      attr_accessor :petparents, :pets, :consultations, :petcontracts, :plans, :breeds, :products, :hubspot_relationship
+      attr_accessor :petparents, :pets, :consultations, :petcontracts, :plans, :breeds, :products,
+                    :hubspot_relationship, :referrals
 
       # rubocop:disable Metrics/ParameterLists
       def initialize(petparents: [], pets: [], consultations: [], petcontracts: [], plans: [], breeds: [],
-                     products: [], hubspot_relationship: [])
+                     products: [], hubspot_relationship: [], referrals: [])
         @petparents = petparents
         @pets = pets
         @consultations = consultations
@@ -21,6 +22,7 @@ module KB
         @breeds = breeds
         @products = products
         @hubspot_relationship = hubspot_relationship
+        @referrals = referrals
       end
       # rubocop:enable Metrics/ParameterLists
 
@@ -33,7 +35,8 @@ module KB
           plans: @plans.clone,
           breeds: @breeds.clone,
           products: @products.clone,
-          hubspot_relationship: @hubspot_relationship.clone
+          hubspot_relationship: @hubspot_relationship.clone,
+          referrals: @referrals.clone
         }
       end
     end

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

@@ -26,6 +26,18 @@ module BoundedContext
           json_response 200, contracts
         end
 
+        get '/v1/petparents/:key/referrals' do
+          json_response 200, referrals_by_pet_parent_key(params['key'])
+        end
+
+        post '/v1/petparents/:key/referrals' do
+          resource = JSON.parse(request.body.read)
+          resource = resource.merge 'key' => SecureRandom.uuid
+          resource = resource.merge 'referralKey' => params['key']
+          resource_state(:referrals) << resource
+          json_response 201, resource
+        end
+
         put '/v1/petparents' do
           params = JSON.parse(request.body.read)
           existing_pet_parent = pet_parent_by_key(params) || pet_parent_by_email(params) || pet_parent_by_phone(params)
@@ -78,6 +90,10 @@ module BoundedContext
           resource_state(:pets).select { |pet| pet['petParentKey'] == key }
         end
 
+        def referrals_by_pet_parent_key(key)
+          resource_state(:referrals).select { |resource| resource['referralKey'] == key }
+        end
+
         def same_email_but_different_phone_number?(previous, new)
           (previous['email'] == new['email']) &&
             ((previous['phoneNumber'] != new['phoneNumber']) ||

data/lib/kb/models/pet_parent.rb

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

data/lib/kb/models/referral.rb

@@ -0,0 +1,34 @@
+module KB
+  class Referral < BaseModel
+    include Queryable
+
+    kb_api :pet_parent
+
+    def self.attributes_from_response(response)
+      response.transform_keys(&:underscore).transform_keys(&:to_sym).slice(*FIELDS)
+    end
+
+    private_class_method :attributes_from_response
+
+    STRING_FIELDS = %i[key referral_key referred_key type].freeze
+    DATE_FIELDS = %i[joined_at].freeze
+    FIELDS = [*STRING_FIELDS, *DATE_FIELDS].freeze
+
+    define_attribute_methods(*FIELDS)
+
+    STRING_FIELDS.each do |field|
+      attribute field, :string
+    end
+
+    DATE_FIELDS.each do |field|
+      attribute field, :date
+    end
+
+    def self.create(pet_parent_key, attributes)
+      response = kb_client.request("#{pet_parent_key}/referrals", filters: attributes, method: :post)
+      attributes_from_response(response)
+    rescue Faraday::Error => e
+      raise KB::Error.from_faraday(e)
+    end
+  end
+end

data/lib/kb/models.rb

@@ -13,3 +13,4 @@ require 'kb/models/plan'
 require 'kb/models/breed'
 
 require 'kb/models/hubspot_relationship'
+require 'kb/models/referral'

data/lib/kb/version.rb

@@ -1,3 +1,3 @@
 module KB
-  VERSION = '0.16.2'.freeze
+  VERSION = '0.17.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barkibu-kb
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.17.0
 platform: ruby
 authors:
 - Léo Figea
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-13 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -291,6 +305,7 @@ files:
 - lib/kb/models/pet_parent.rb
 - lib/kb/models/plan.rb
 - lib/kb/models/product.rb
+- lib/kb/models/referral.rb
 - lib/kb/models/symptom.rb
 - lib/kb/type/array_of_conditions_type.rb
 - lib/kb/type/array_of_strings_type.rb
@@ -319,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Barkibu's Knowledge Base API sdk