barkibu-kb-fake 0.16.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da9fca49080eddaf77bbbb0f676b223922be9952c7cc8a4e715a43067fdd1f9e
+  data.tar.gz: 326523f469b2f65bfa8d3f2f2ee76746a0f6fffdb0dc261a5adbd18b820bddce
+SHA512:
+  metadata.gz: bc9ee65490cfd754a6007d9bc30f911e7ae98f0fb8e487eb3bb3573ccc577b5cce6e26016fddbe05251bc6719a5c7d871c18f9264539c18c311bdf9dd617fc1c
+  data.tar.gz: 162af6023fc0f58f9571b81e562b9c1d501e90a1d7c00dde79d746b41ba6f64473dc2d183a235250e3de4fb863f88557c07ffacd12865d5e86f376db4389530c

data/lib/barkibu-kb-fake.rb

@@ -0,0 +1 @@
+require 'kb/fake'

data/lib/kb/fake/api.rb

@@ -0,0 +1,72 @@
+require 'kb/fake/bounded_context/pet_family/breeds'
+require 'kb/fake/bounded_context/pet_family/pet_parents'
+require 'kb/fake/bounded_context/pet_family/pets'
+require 'kb/fake/bounded_context/pet_family/products'
+require 'kb/fake/bounded_context/pet_family/pet_contracts'
+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
+
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(petparents: [], pets: [], consultations: [], petcontracts: [], plans: [], breeds: [],
+                     products: [], hubspot_relationship: [])
+        @petparents = petparents
+        @pets = pets
+        @consultations = consultations
+        @petcontracts = petcontracts
+        @plans = plans
+        @breeds = breeds
+        @products = products
+        @hubspot_relationship = hubspot_relationship
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def to_snapshot
+        {
+          pets: @pets.clone,
+          petparents: @petparents.clone,
+          consultations: @consultations.clone,
+          petcontracts: @petcontracts.clone,
+          plans: @plans.clone,
+          breeds: @breeds.clone,
+          products: @products.clone,
+          hubspot_relationship: @hubspot_relationship.clone
+        }
+      end
+    end
+
+    class Api < Sinatra::Base
+      include BoundedContext::PetFamily::Breeds
+      include BoundedContext::PetFamily::Pets
+      include BoundedContext::PetFamily::PetParents
+      include BoundedContext::PetFamily::PetContracts
+      include BoundedContext::PetFamily::Products
+      include BoundedContext::PetFamily::HubspotRelationship
+
+      set :state, ApiState.new
+
+      def self.snapshot
+        Api.state.to_snapshot
+      end
+
+      def self.restore(snapshot)
+        set :state, ApiState.new(**snapshot)
+      end
+
+      def resource_state(name)
+        Api.state.send(name)
+      end
+
+      def set_resource_state(name, value)
+        Api.state.send("#{name}=", value)
+      end
+
+      resource :consultations, except: %i[create update destroy]
+
+      resource :plans, except: %i[show create update destroy]
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require 'kb/fake/bounded_context/rest_resource'
+
+module BoundedContext
+  module PetFamily
+    module Breeds
+      extend ActiveSupport::Concern
+
+      included do
+        include RestResource
+
+        listen_on_index :breeds, :v1
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'kb/fake/bounded_context/rest_resource'
+
+module BoundedContext
+  module PetFamily
+    module HubspotRelationship
+      extend ActiveSupport::Concern
+
+      included do
+        include RestResource
+
+        get '/v1/hubspot/:model/:key/relationship' do
+          resource_by_key(:hubspot_relationship, params['key'])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require 'kb/fake/bounded_context/rest_resource'
+
+module BoundedContext
+  module PetFamily
+    module PetContracts
+      extend ActiveSupport::Concern
+
+      included do
+        include RestResource
+
+        get '/v1/petcontracts/contractnumber/:contract_number' do
+          resource = resource_state(:petcontracts).detect do |contract|
+            contract['contractNumber'] == params['contract_number']
+          end
+          return json_response 404, {} if resource.nil?
+
+          json_response 200, resource
+        end
+
+        resource :petcontracts, except: %i[index destroy]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+require 'kb/fake/bounded_context/rest_resource'
+# rubocop:disable Metrics/BlockLength
+
+module BoundedContext
+  module PetFamily
+    module PetParents
+      extend ActiveSupport::Concern
+
+      included do
+        include RestResource
+
+        resource :petparents
+
+        def petparents_filterable_attributes
+          KB::PetParent::FIELDS.map { |k| k.to_s.camelize(:lower) }
+        end
+
+        get '/v1/petparents/:key/pets' do
+          json_response 200, pets_by_pet_parent_key(params['key'])
+        end
+
+        get '/v1/petparents/:key/contracts' do
+          pet_keys = pets_by_pet_parent_key(params['key']).map { |pet| pet['key'] }
+          contracts = resource_state(:petcontracts).select { |contract| pet_keys.include? contract['petKey'] }
+
+          json_response 200, contracts
+        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)
+          resource = (existing_pet_parent || { 'key' => SecureRandom.uuid }).merge params
+
+          if existing_pet_parent.present?
+            if same_phone_number_but_different_email?(existing_pet_parent, params)
+              return json_response 422, { error: 'Unprocessable Entity', message: 'Email can not be overridden' }
+            end
+
+            if same_email_but_different_phone_number?(existing_pet_parent, params)
+              previous_pet_parent_by_phone = pet_parent_by_phone(params)
+              if previous_pet_parent_by_phone.present?
+                return json_response 409,
+                                     { error: 'ConflictError',
+                                       message: 'Duplicated pet parent: same partner, phoneNumber \
+                                                and phoneNumberPrefix' }
+              end
+            end
+
+            update_resource_state(:petparents, resource)
+          else
+            resource_state(:petparents) << resource
+          end
+
+          json_response 200, resource
+        end
+
+        private
+
+        def pet_parent_by_key(params)
+          find_resource(:petparents, params['key']) if params['key']
+        end
+
+        def pet_parent_by_phone(params)
+          matches_by_phone = (if params['phoneNumber']
+                                filter_resources(:petparents,
+                                                 params.slice('phoneNumber',
+                                                              'prefixPhoneNumber'))
+                              end)
+          matches_by_phone.first if matches_by_phone&.count == 1
+        end
+
+        def pet_parent_by_email(params)
+          matches_by_email = (filter_resources(:petparents, params.slice('email')) if params['email'])
+          matches_by_email.first if matches_by_email&.count == 1
+        end
+
+        def pets_by_pet_parent_key(key)
+          resource_state(:pets).select { |pet| pet['petParentKey'] == key }
+        end
+
+        def same_email_but_different_phone_number?(previous, new)
+          (previous['email'] == new['email']) &&
+            ((previous['phoneNumber'] != new['phoneNumber']) ||
+             (previous['prefixPhoneNumber'] != new['prefixPhoneNumber']))
+        end
+
+        def same_phone_number_but_different_email?(previous, new_resource)
+          return false unless new_resource.key?('email')
+
+          (previous['phoneNumber'] == new_resource['phoneNumber']) &&
+            (previous['prefixPhoneNumber'] == new_resource['prefixPhoneNumber']) &&
+            (previous['email'] != new_resource['email'])
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength

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

@@ -0,0 +1,84 @@
+require 'kb/fake/bounded_context/rest_resource'
+require 'date'
+# rubocop:disable Metrics/BlockLength
+
+module BoundedContext
+  module PetFamily
+    module Pets
+      extend ActiveSupport::Concern
+      include RestResource
+
+      included do
+        include RestResource
+
+        resource :pets
+
+        def pets_filterable_attributes
+          KB::Pet::FIELDS.map { |k| k.to_s.camelize(:lower) }
+        end
+
+        def on_pets_create(_version)
+          resource = JSON.parse(request.body.read)
+          resource['ageCategory'] = stage(resource['birthDate'], resource['species'])
+          resource = resource.merge 'key' => SecureRandom.uuid
+          resource_state(:pets) << resource
+          json_response 201, resource
+        end
+
+        def on_pets_update(_version)
+          resource_to_update = find_resource :pets, params['key']
+
+          return json_response 404, {} if resource_to_update.nil?
+
+          partial_resource = JSON.parse(request.body.read)
+          partial_resource['ageCategory'] = stage(partial_resource['birthDate'], resource_to_update['species'])
+          updated_resource = resource_to_update.merge partial_resource
+
+          update_resource_state(:pets, updated_resource)
+
+          json_response 200, updated_resource
+        end
+
+        get '/v1/pets/:key/contracts' do
+          contracts = resource_state(:petcontracts).select { |contract| contract['petKey'] == params['key'] }
+
+          json_response 200, contracts
+        end
+
+        put '/v1/pets' do
+          params = JSON.parse(request.body.read)
+          pet_parent = find_resource(:petparents, params['petParentKey'])
+
+          return json_response 422, {} if pet_parent.nil?
+
+          potential_matches = filter_resources(:pets, params.slice('name', 'petParentKey'))
+          existing_pet = (potential_matches.first if potential_matches.count == 1)
+
+          resource = (existing_pet || { 'key' => SecureRandom.uuid }).merge params
+
+          if existing_pet.present?
+            update_resource_state(:pets, resource)
+          else
+            resource_state(:pets) << resource
+          end
+
+          json_response 200, resource
+        end
+      end
+
+      def stage(birthdate, species)
+        return nil if birthdate.nil?
+
+        case ((Time.zone.now - Time.zone.parse(birthdate)) / 1.month).to_i
+        when 0..11
+          species == 'cat' ? 'kitten' : 'puppy'
+        when 12..99
+          'adult'
+        else
+          'senior'
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength

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

@@ -0,0 +1,28 @@
+require 'kb/fake/bounded_context/rest_resource'
+
+module BoundedContext
+  module PetFamily
+    module Products
+      extend ActiveSupport::Concern
+      include RestResource
+
+      included do
+        include RestResource
+
+        resource :products, except: %i[create update destroy]
+
+        def products_filterable_attributes
+          [:country]
+        end
+
+        def on_products_index(_version)
+          return json_response 400, {} if params['country'].nil?
+
+          return json_response 422, {} if ISO3166::Country.search(params['country']).nil?
+
+          json_response 200, filter_resources(:products, params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,134 @@
+# rubocop:disable Metrics/BlockLength
+module BoundedContext
+  module RestResource
+    extend ActiveSupport::Concern
+
+    included do
+      def resource_by_key(resource, key)
+        entity = find_resource(resource, key)
+        return json_response 404, {} if entity.nil?
+
+        json_response 200, entity
+      end
+
+      def json_response(response_code, body_content)
+        content_type :json
+        status response_code
+        body body_content.to_json
+      end
+
+      def on_index_action(name, version)
+        return send("on_#{name}_index", version) if respond_to? "on_#{name}_index"
+
+        json_response 200, filter_resources(name, params)
+      end
+
+      def filter_resources(name, filters)
+        resource_state(name).select do |item|
+          item[:deleted_at].blank? && filters.slice(*filterable_attributes(name)).reduce(true) do |sum, (key, value)|
+            sum && (value.blank? \
+                    || (item.fetch(key, '') || '').downcase.include?(value.downcase))
+          end
+        end
+      end
+
+      def filterable_attributes(name)
+        try("#{name}_filterable_attributes") || []
+      end
+
+      def on_show_action(name, version)
+        return send("on_#{name}_show", version) if respond_to? "on_#{name}_show"
+
+        resource_by_key name, params['key']
+      end
+
+      def on_create_action(name, version)
+        return send("on_#{name}_create", version) if respond_to? "on_#{name}_create"
+
+        resource = JSON.parse(request.body.read)
+        resource = resource.merge 'key' => SecureRandom.uuid
+        resource_state(name) << resource
+        json_response 201, resource
+      end
+
+      def on_update_action(name, version)
+        return send("on_#{name}_update", version) if respond_to? "on_#{name}_update"
+
+        resource_to_update = find_resource name, params['key']
+
+        return json_response 404, {} if resource_to_update.nil?
+
+        partial_resource = JSON.parse(request.body.read)
+        updated_resource = resource_to_update.merge partial_resource
+
+        update_resource_state(name, updated_resource)
+
+        json_response 200, updated_resource
+      end
+
+      def on_destroy_action(name, version)
+        return send("on_#{name}_destroy", version) if respond_to? "on_#{name}_destroy"
+
+        resource_to_delete = find_resource name, params['key']
+        resource_to_delete[:deleted_at] = DateTime.now
+
+        update_resource_state(name, resource_to_delete)
+
+        json_response 204, nil
+      end
+
+      private
+
+      def find_resource(name, key)
+        resource_state(name).detect { |resource| resource['key'] == key }
+      end
+
+      def update_resource_state(name, updated_resource)
+        updated_resources = resource_state(name).map do |resource|
+          resource['key'] == updated_resource['key'] ? updated_resource : resource
+        end
+
+        set_resource_state(name, updated_resources)
+      end
+    end
+
+    class_methods do
+      def listen_on_index(name, version)
+        get "/#{version}/#{name}" do
+          on_index_action(name, version)
+        end
+      end
+
+      def listen_on_show(name, version)
+        get "/#{version}/#{name}/:key" do
+          on_show_action(name, version)
+        end
+      end
+
+      def listen_on_create(name, version)
+        post "/#{version}/#{name}" do
+          on_create_action(name, version)
+        end
+      end
+
+      def listen_on_update(name, version)
+        patch "/#{version}/#{name}/:key" do
+          on_update_action(name, version)
+        end
+      end
+
+      def listen_on_destroy(name, version)
+        delete "/#{version}/#{name}/:key" do
+          on_destroy_action(name, version)
+        end
+      end
+
+      def resource(name, version: 'v1', except: [])
+        %i[index show create update destroy].each do |action|
+          send("listen_on_#{action}", name, version) unless except.include?(action)
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength

data/lib/kb/fake.rb

@@ -0,0 +1,6 @@
+require 'active_support'
+require 'countries'
+require 'sinatra'
+require 'webmock'
+
+require 'kb/fake/api'

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: barkibu-kb-fake
+version: !ruby/object:Gem::Version
+  version: 0.16.1
+platform: ruby
+authors:
+- Léo Figea
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: countries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: barkibu-kb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A fake API of Barkibu's Knowledge Base destined to be used in tests for
+  application using the kb-ruby gem.
+email:
+- leo@barkibu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/barkibu-kb-fake.rb
+- lib/kb/fake.rb
+- lib/kb/fake/api.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
+- lib/kb/fake/bounded_context/pet_family/pet_parents.rb
+- lib/kb/fake/bounded_context/pet_family/pets.rb
+- lib/kb/fake/bounded_context/pet_family/products.rb
+- lib/kb/fake/bounded_context/rest_resource.rb
+homepage: https://app.barkibu.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://app.barkibu.com
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Barkibu's Knowledge Base Fake API
+test_files: []