barkibu-kb 0.16.1

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

@@ -0,0 +1,18 @@
+module KB
+  module Creatable
+    extend ActiveSupport::Concern
+
+    included do
+      include Queryable
+    end
+
+    module ClassMethods
+      def create(attributes)
+        api_response = kb_client.create attributes
+        attributes_from_response(api_response)
+      rescue Faraday::Error => e
+        raise KB::Error.from_faraday(e)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module KB
+  module Destroyable
+    extend ActiveSupport::Concern
+
+    included do
+      include Queryable
+    end
+
+    module ClassMethods
+      def destroy(key)
+        kb_client.destroy(key)
+      rescue Faraday::Error => e
+        raise KB::Error.from_faraday(e)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module KB
+  module FindOrCreatable
+    extend ActiveSupport::Concern
+
+    included do
+      include Queryable
+      include Listable
+      include Creatable
+    end
+
+    module ClassMethods
+      def find_or_create_by(attributes, additional_attributes)
+        all(attributes).first || new(create(additional_attributes.merge(attributes)), &:persist!)
+      rescue Faraday::Error => e
+        raise KB::Error.from_faraday(e)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module KB
+  module Findable
+    extend ActiveSupport::Concern
+
+    included do
+      include Queryable
+    end
+
+    module ClassMethods
+      def find(key, params = {})
+        from_api(kb_client.find(key, params))
+      rescue Faraday::ResourceNotFound => e
+        raise KB::ResourceNotFound.new(e.response[:status], e.response[:body], e)
+      rescue Faraday::Error => e
+        raise KB::Error.from_faraday(e)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Inspectionable
+  def inspect
+    attr_list = attributes.map do |key, value|
+      value_str = if value.is_a? ActiveModel::Model
+                    "#<#{value.class}: #{format '%<id>#018x', id: value.object_id << 1}>"
+                  else
+                    value.inspect
+                  end
+      "#{key}: #{value_str}"
+    end.join ', '
+    "#<#{self.class}: #{format '%<id>#018x', id: object_id << 1} #{attr_list}>"
+  end
+end

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

@@ -0,0 +1,21 @@
+module KB
+  module Listable
+    extend ActiveSupport::Concern
+
+    included do
+      include Queryable
+    end
+
+    module ClassMethods
+      def all(filters = {})
+        kb_client.all(filters).map do |pet_parent|
+          from_api pet_parent
+        end
+      rescue Faraday::ConnectionFailed => e
+        raise e
+      rescue Faraday::Error => e
+        raise KB::Error.from_faraday(e)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module KB
+  module Queryable
+    class KBClientNotSetException < StandardError; end
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :resolver_factory
+    end
+
+    module ClassMethods
+      def kb_client
+        if resolver_factory.blank?
+          raise KBClientNotSetException, "You probably forgot to call `kb_api ...` on the class #{name}"
+        end
+
+        @kb_client ||= ClientResolver.public_send(resolver_factory)
+      end
+
+      def from_api(attributes)
+        new(attributes_from_response(attributes), &:persist!).tap(&:clear_changes_information)
+      end
+
+      private
+
+      def kb_api(resolver_factory)
+        self.resolver_factory = resolver_factory
+      end
+
+      # @abstract Subclass is expected to implement #attributes_from_response
+      # @!method attributes_from_response
+      #    Filter and process the response to return the relevant attributes for entity initialization
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module KB
+  module Updatable
+    extend ActiveSupport::Concern
+
+    included do
+      include Queryable
+    end
+
+    module ClassMethods
+      def update(key, attributes)
+        api_response = kb_client.update(key, attributes)
+        attributes_from_response(api_response)
+      rescue Faraday::Error => e
+        raise KB::Error.from_faraday(e)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module KB
+  module Upsertable
+    extend ActiveSupport::Concern
+
+    included do
+      include Queryable
+    end
+
+    module ClassMethods
+      def upsert(attributes)
+        from_api kb_client.upsert(attributes)
+      rescue Faraday::Error => e
+        raise KB::Error.from_faraday(e)
+      end
+    end
+  end
+end

data/lib/kb/models/concerns.rb

@@ -0,0 +1,10 @@
+require 'kb/models/concerns/inspectionable'
+
+require 'kb/models/concerns/queryable'
+require 'kb/models/concerns/creatable'
+require 'kb/models/concerns/findable'
+require 'kb/models/concerns/find_or_creatable'
+require 'kb/models/concerns/upsertable'
+require 'kb/models/concerns/updatable'
+require 'kb/models/concerns/listable'
+require 'kb/models/concerns/destroyable'

data/lib/kb/models/condition.rb

@@ -0,0 +1,32 @@
+module KB
+  class Condition
+    include Inspectionable
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+    include ActiveModel::Serializers::JSON
+
+    FIELDS = %i[key name score usualness urgent information urgency].freeze
+
+    attribute :key, :string
+    attribute :name, :string
+    attribute :score, :float
+    attribute :usualness, :integer
+    attribute :urgency, :string
+
+    attribute :article, :string, default: ''
+    attribute :description_short, :string
+    attribute :diagnosis, :string
+    attribute :treatment, :string
+    attribute :prevention, :string
+    attribute :first_aid, :string
+    attribute :predisposition_factors, :string
+
+    alias_attribute :information, :article
+
+    def urgent
+      return false if urgency == 'low'
+
+      true
+    end
+  end
+end

data/lib/kb/models/hubspot_relationship.rb

@@ -0,0 +1,34 @@
+module KB
+  class HubspotRelationship < BaseModel
+    include Queryable
+
+    kb_api :hubspot
+
+    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[kb_key hubspot_id].freeze
+    DATE_FIELDS = %i[last_updated_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.find(model, model_key)
+      response = kb_client.request("#{model}/#{model_key}/relationship")
+      new(attributes_from_response(response))
+    rescue Faraday::Error => e
+      raise KB::Error.from_faraday(e)
+    end
+  end
+end

data/lib/kb/models/pet.rb

@@ -0,0 +1,68 @@
+module KB
+  class Pet < BaseModel
+    include Findable
+    include Updatable
+    include FindOrCreatable
+    include Destroyable
+    include Upsertable
+
+    kb_api :pet
+
+    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 pet_parent_key name age_category sex breed chip species].freeze
+    DATE_FIELDS = %i[birth_date deleted_at].freeze
+    BOOLEAN_FIELDS = %i[neutered mongrel].freeze
+    FIELDS = [*STRING_FIELDS, *DATE_FIELDS, *BOOLEAN_FIELDS].freeze
+
+    define_attribute_methods(*FIELDS)
+
+    STRING_FIELDS.each do |field|
+      attribute field, :string
+    end
+
+    BOOLEAN_FIELDS.each do |field|
+      attribute field, :boolean
+    end
+
+    DATE_FIELDS.each do |field|
+      attribute field, :date
+    end
+
+    def save!
+      return unless changed?
+
+      run_callbacks :save do
+        self.attributes = if @persisted
+                            self.class.update key, changes.transform_values(&:last)
+                          else
+                            self.class.create changes.transform_values(&:last)
+                          end
+
+        self
+      end
+    end
+
+    def destroyed?
+      @destroyed
+    end
+
+    def destroy!
+      return unless @persisted
+
+      self.class.destroy key
+      @destroyed = true
+      freeze
+    end
+
+    def contracts
+      self.class.kb_client.request("#{key}/contracts").map do |contract|
+        PetContract.from_api(contract)
+      end
+    end
+  end
+end

data/lib/kb/models/pet_contract.rb

@@ -0,0 +1,77 @@
+module KB
+  class PetContract < BaseModel
+    include Findable
+    include Creatable
+    include Updatable
+
+    kb_api :pet_contract
+
+    def self.find_by_contract_number(contract_number)
+      find("contractnumber/#{contract_number}")
+    end
+
+    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 plan_key product_key pet_key contract_number contract_document status
+                       source affiliate_online affiliate_offline
+                       conversion_utm_adgroup conversion_utm_campaign
+                       conversion_utm_content conversion_utm_medium
+                       conversion_utm_source conversion_utm_term
+                       conversion_utm_adgroup_id conversion_utm_campaign_id].freeze
+    DATE_FIELDS = %i[policy_start_date policy_expiration_date].freeze
+    INTEGER_FIELDS = %i[price_yearly price_monthly price_discount_yearly].freeze
+    FIELDS = [*STRING_FIELDS, *DATE_FIELDS, *INTEGER_FIELDS].freeze
+
+    IMMUTABLE_FIELDS = (FIELDS - %i[status contract_document policy_expiration_date]).freeze
+
+    define_attribute_methods(*FIELDS)
+
+    STRING_FIELDS.each do |field|
+      attribute field, :string
+    end
+
+    DATE_FIELDS.each do |field|
+      attribute field, :date
+    end
+
+    INTEGER_FIELDS.each do |field|
+      attribute field, :integer
+    end
+
+    def save!
+      return unless changed?
+
+      run_callbacks :save do
+        self.attributes = if @persisted
+                            self.class.update key, changes.transform_values(&:last)
+                          else
+                            self.class.create changes.transform_values(&:last)
+                          end
+
+        self
+      end
+    end
+
+    def plan
+      @plan ||= Plan.all.select { |plan| plan.key == plan_key }
+    end
+
+    def product
+      @product ||= Product.find product_key
+    end
+
+    def pet
+      @pet ||= Pet.find(pet_key)
+    end
+
+    def hubspot_id
+      @hubspot_id ||= KB::HubspotRelationship.find('policies', key).hubspot_id
+    rescue KB::ResourceNotFound
+      nil
+    end
+  end
+end

data/lib/kb/models/pet_parent.rb

@@ -0,0 +1,111 @@
+module KB
+  class PetParent < BaseModel
+    include Findable
+    include Updatable
+    include FindOrCreatable
+    include Upsertable
+    include Destroyable
+
+    kb_api :pet_parent
+
+    def self.all(filters = {})
+      filters[:partner_key] = ENV['KB_PARTNER_KEY']
+      super(filters)
+    end
+
+    def self.create(attributes = {})
+      attributes[:partner_key] = ENV['KB_PARTNER_KEY']
+      super(attributes)
+    end
+
+    def self.upsert(attributes)
+      attributes[:partner_key] = ENV['KB_PARTNER_KEY']
+      super(attributes)
+    end
+
+    def merge!(duplicated_pet_parent_key)
+      params = { preservable_pet_parent_key: key,
+                 erasable_pet_parent_key: duplicated_pet_parent_key }.transform_keys do |key|
+        key.to_s.camelize(:lower)
+      end
+
+      response = KB::ClientResolver.admin.request("petparents?#{params.to_query}", method: :put)
+      PetParent.from_api response
+    rescue Faraday::Error => e
+      raise KB::Error.from_faraday(e)
+    end
+
+    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 partner_name first_name last_name prefix_phone_number
+                       phone_number email country address zip_code nif affiliate_code].freeze
+    DATE_FIELDS = %i[birth_date deleted_at].freeze
+    BOOLEAN_FIELDS = %i[phone_number_verified email_verified].freeze
+    FIELDS = [*STRING_FIELDS, *DATE_FIELDS, *BOOLEAN_FIELDS].freeze
+
+    define_attribute_methods(*FIELDS)
+
+    alias phone_number_prefix prefix_phone_number
+    alias phone_number_prefix= prefix_phone_number=
+
+    STRING_FIELDS.each do |field|
+      attribute field, :string
+    end
+
+    DATE_FIELDS.each do |field|
+      attribute field, :date
+    end
+
+    BOOLEAN_FIELDS.each do |field|
+      attribute field, :boolean
+    end
+
+    attribute :first_name, :string, default: ''
+
+    def save!
+      return unless changed?
+
+      run_callbacks :save do
+        self.attributes = if @persisted
+                            self.class.update key, changes.transform_values(&:last)
+                          else
+                            self.class.create changes.transform_values(&:last)
+                          end
+
+        self
+      end
+    end
+
+    def destroyed?
+      @destroyed
+    end
+
+    def destroy!
+      return unless @persisted
+
+      self.class.destroy key
+      @destroyed = true
+      freeze
+    end
+
+    def full_phone_number
+      "#{phone_number_prefix}#{phone_number}"
+    end
+
+    def pets
+      self.class.kb_client.request("#{key}/pets").map do |pet|
+        Pet.from_api(pet)
+      end
+    end
+
+    def contracts
+      self.class.kb_client.request("#{key}/contracts").map do |contract|
+        PetContract.from_api(contract)
+      end
+    end
+  end
+end

data/lib/kb/models/plan.rb

@@ -0,0 +1,44 @@
+module KB
+  class Plan < BaseModel
+    include Listable
+
+    kb_api :plan
+
+    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 description plan_name type].freeze
+    HASH_FIELDS = %i[benefits price].freeze
+    FIELDS = [*STRING_FIELDS, *HASH_FIELDS, :plan_life_in_months, :buyable].freeze
+
+    define_attribute_methods(*FIELDS)
+
+    attribute :plan_life_in_months, :integer
+    attribute :buyable, :boolean
+
+    STRING_FIELDS.each do |field|
+      attribute field, :string
+    end
+
+    HASH_FIELDS.each do |field|
+      attribute field
+    end
+
+    def save!
+      return unless changed?
+
+      run_callbacks :save do
+        self.attributes = if @persisted
+                            self.class.update key, changes.transform_values(&:last)
+                          else
+                            self.class.create changes.transform_values(&:last)
+                          end
+
+        self
+      end
+    end
+  end
+end

data/lib/kb/models/product.rb

@@ -0,0 +1,34 @@
+module KB
+  class Product < BaseModel
+    include Listable
+    include Findable
+
+    kb_api :product
+
+    def self.by_country(country)
+      all(country: country)
+    end
+
+    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 country name type].freeze
+    STRING_ARRAY_FIELDS = %i[exclusions inclusions features claimable_by languages].freeze
+    FIELDS = [*STRING_FIELDS, *STRING_ARRAY_FIELDS, :purchasable].freeze
+
+    define_attribute_methods(*FIELDS)
+
+    attribute :purchasable, :boolean
+
+    STRING_FIELDS.each do |field|
+      attribute field, :string
+    end
+
+    STRING_ARRAY_FIELDS.each do |field|
+      attribute field, :array_of_strings
+    end
+  end
+end

data/lib/kb/models/symptom.rb

@@ -0,0 +1,25 @@
+module KB
+  class Symptom
+    include Inspectionable
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+    include ActiveModel::Serializers::JSON
+
+    attribute :key, :string
+    attribute :name, :string
+    attribute :presence, :string
+    attribute :duration, :string
+    attribute :frequency, :string
+
+    attribute :urgency, :string
+    attribute :article, :string, default: ''
+
+    alias_attribute :information, :article
+
+    def urgent
+      return false if urgency == 'low'
+
+      true
+    end
+  end
+end

data/lib/kb/models.rb

@@ -0,0 +1,15 @@
+require 'kb/models/concerns'
+require 'kb/models/base_model'
+
+require 'kb/models/condition'
+require 'kb/models/symptom'
+require 'kb/models/assessment'
+
+require 'kb/models/pet_contract'
+require 'kb/models/pet_parent'
+require 'kb/models/pet'
+require 'kb/models/product'
+require 'kb/models/plan'
+require 'kb/models/breed'
+
+require 'kb/models/hubspot_relationship'

data/lib/kb/type/array_of_conditions_type.rb

@@ -0,0 +1,13 @@
+module Type
+  class ArrayOfConditionsType < ActiveModel::Type::Value
+    CONDITION_KEYS = KB::Condition.attribute_types.keys.map(&:to_sym)
+
+    def cast(value)
+      (value || []).map do |v|
+        next v if v.is_a? KB::Condition
+
+        KB::Condition.new v.symbolize_keys.slice(*CONDITION_KEYS)
+      end
+    end
+  end
+end

data/lib/kb/type/array_of_strings_type.rb

@@ -0,0 +1,9 @@
+module Type
+  class ArrayOfStringsType < ActiveModel::Type::Value
+    def cast(values)
+      return [] if values.blank?
+
+      values.map(&:to_s)
+    end
+  end
+end

data/lib/kb/type/array_of_symptoms_type.rb

@@ -0,0 +1,13 @@
+module Type
+  class ArrayOfSymptomsType < ActiveModel::Type::Value
+    SYMPTOM_KEYS = KB::Symptom.attribute_types.keys.map(&:to_sym)
+
+    def cast(value)
+      (value || []).map do |v|
+        next v if v.is_a? KB::Symptom
+
+        KB::Symptom.new v.symbolize_keys.slice(*SYMPTOM_KEYS)
+      end
+    end
+  end
+end