easy_talk 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8455d741b05a1a65ca7ea3f7e2d529271414fb04881066cc81bbb444399e200c
-  data.tar.gz: 9814e429530dbb42da5a3cca3310175ebe98038d91d5b7deeddcd68aa90b3199
+  metadata.gz: d3b84eeed5e8d6430c3bbaf97936ec90a29554dcbd71905553ecaf2f66b82877
+  data.tar.gz: 74fa329ca8574c8d8d8ec2b3daf6dee3a8d46a3550c53fb30ceb1709487243d9
 SHA512:
-  metadata.gz: 5a85e59b3eaa7e0e9c2d57eb0283f2b4a45e6dfeb88778682738969617f751149aaf99cd93b4760c323eb84da476ac0ee8aba59eef003156d8d82aae60a940fd
-  data.tar.gz: 0c382d7989016e5a1c376439c96cd8b1d4acb7a6758a8fb2b406239551445ede641fb3a3ed64f833ce591409a75eefb0f3023a4a60cfffc92ca49ee5827bc24d
+  metadata.gz: 59be99a0311ec3c5d941e63cc2299e26d2a84c1a53ff88f6bd561dbd1b046dc3f4e5d68c8037724cd295df8d542a7a24621374cc535422920200a11ae66507e5
+  data.tar.gz: 2eabc32e703f00a68d47d1152fc1a42cc963e0f5ba05aea76b57b7ccccde670dcb4361811b8af812b85d2c78880f7b375e536d7ce7f0f12a7177dd8b80046775

data/.rubocop.yml

@@ -27,4 +27,7 @@ Layout/LineLength:
   
 RSpec/DescribeClass:
   Exclude:
-    - 'spec/easy_talk/examples/**/*'
+    - 'spec/easy_talk/examples/**/*'
+
+RSpec/MultipleExpectations:
+  Max: 4

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.2.1] - 2024-05-06
+- Run JSON Schema validations using ActiveModel's validations.
+
 ## [0.2.0] - 2024-05-01
 - Added ActiveModel::API functionality to EasyTalk::Model module. That means you get all the benefits of ActiveModel::API including attribute assignment, introspections, validations, translation (i18n) and more. See https://api.rubyonrails.org/classes/ActiveModel/API.html for more information.
 

data/README.md

@@ -1,6 +1,16 @@
 # EasyTalk
 
-EasyTalk is a Ruby library for defining and generating JSON Schema.
+EasyTalk is a Ruby library that simplifies defining and generating JSON Schema documents, and validates that JSON data conforms to these schemas.
+
+Key Features
+* Intuitive Schema Definition: Use Ruby classes and methods to define JSON Schema documents easily.
+* JSON Schema Compliance: Implements the JSON Schema specification to ensure compatibility and standards adherence.
+* LLM Function Support: Ideal for integrating with Large Language Models (LLMs) such as OpenAI's GPT-3.5-turbo and GPT-4. EasyTalk enables you to effortlessly create JSON Schema documents needed to describe the inputs and outputs of LLM function calls.
+* Validation: Validates JSON inputs and outputs against defined schemas to ensure they meet expected formats and types. Write custom validations using ActiveModel's validations.
+* Integration with ActiveModel: EasyTalk integrates with ActiveModel to provide additional functionality such as attribute assignment, introspections, validations, translation (i18n), and more.
+
+Inspiration
+Inspired by Python's Pydantic library, EasyTalk brings similar functionality to the Ruby ecosystem, providing a Ruby-friendly approach to JSON Schema operations.
 
 Example Use:
 

data/lib/easy_talk/model.rb

@@ -7,48 +7,55 @@ require 'active_support/time'
 require 'active_support/concern'
 require 'active_support/json'
 require 'active_model'
-require 'json-schema'
+require 'json_schemer'
+require_relative 'schema_errors_mapper'
 require_relative 'builders/object_builder'
 require_relative 'schema_definition'
 
 module EasyTalk
-  # The Model module can be included in a class to add JSON schema definition and generation support.
+  # The `Model` module is a mixin that provides functionality for defining and accessing the schema of a model.
+  #
+  # It includes methods for defining the schema, retrieving the schema definition,
+  # and generating the JSON schema for the model.
+  #
+  # Example usage:
+  #
+  #   class Person
+  #     include EasyTalk::Model
+  #
+  #     define_schema do
+  #       property :name, String, description: 'The person\'s name'
+  #       property :age, Integer, description: 'The person\'s age'
+  #     end
+  #   end
+  #
+  #   Person.json_schema #=> returns the JSON schema for Person
+  #   jim = Person.new(name: 'Jim', age: 30)
+  #   jim.valid? #=> returns true
+  #
+  # @see SchemaDefinition
   module Model
-    # The `Model` module is a mixin that provides functionality for defining and accessing the schema of a model.
-    #
-    # It includes methods for defining the schema, retrieving the schema definition,
-    # and generating the JSON schema for the model.
-    #
-    # Example usage:
-    #
-    #   class Person
-    #     include EasyTalk::Model
-    #
-    #     define_schema do
-    #       property :name, String, description: 'The person\'s name'
-    #       property :age, Integer, description: 'The person\'s age'
-    #     end
-    #   end
-    #
-    #   Person.json_schema #=> returns the JSON schema for Person
-    #   jim = Person.new(name: 'Jim', age: 30)
-    #   jim.valid? #=> returns true
-    #
-    # @see SchemaDefinition
-    #
     def self.included(base)
       base.include ActiveModel::API # Include ActiveModel::API in the class including EasyTalk::Model
+      base.include ActiveModel::Validations
+      base.extend ActiveModel::Callbacks
+      base.validates_with SchemaValidator
       base.extend(ClassMethods)
     end
 
-    # Checks if the model is valid.
-    #
-    # This method calls the `validate_json` class method on the current class,
-    # passing the `properties` as the argument.
-    #
-    # @return [Boolean] true if the model is valid, false otherwise.
-    def valid?
-      self.class.validate_json(properties)
+    class SchemaValidator < ActiveModel::Validator
+      def validate(record)
+        result = schema_validation(record)
+        result.errors.each do |key, error_msg|
+          record.errors.add key.to_sym, error_msg
+        end
+      end
+
+      def schema_validation(record)
+        schema = JSONSchemer.schema(record.class.json_schema)
+        errors = schema.validate(record.properties)
+        SchemaErrorsMapper.new(errors)
+      end
     end
 
     # Returns the properties of the model as a hash with symbolized keys.
@@ -94,14 +101,6 @@ module EasyTalk
         end
       end
 
-      # Validates the given JSON against the model's JSON schema.
-      #
-      # @param json [Hash] The JSON to validate.
-      # @return [Boolean] `true` if the JSON is valid, `false` otherwise.
-      def validate_json(json)
-        JSON::Validator.validate(json_schema, json)
-      end
-
       # Returns the JSON schema for the model.
       #
       # @return [Hash] The JSON schema for the model.

data/lib/easy_talk/schema_errors_mapper.rb

@@ -0,0 +1,21 @@
+module EasyTalk
+  class SchemaErrorsMapper
+    def initialize(errors)
+      @errors = errors.to_a
+    end
+
+    def errors
+      @errors.each_with_object({}) do |error, hash|
+        if error['data_pointer'].present?
+          key = error['data_pointer'].split('/').compact_blank.join('.')
+          hash[key] = error['error']
+        else
+          error['details']['missing_keys'].each do |missing_key|
+            message = "#{error['error'].split(':').first}: #{missing_key}"
+            hash[missing_key] = message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/easy_talk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EasyTalk
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_talk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sergio Bayona
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-01 00:00:00.000000000 Z
+date: 2024-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: json_schemer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -213,6 +213,7 @@ files:
 - lib/easy_talk/model.rb
 - lib/easy_talk/property.rb
 - lib/easy_talk/schema_definition.rb
+- lib/easy_talk/schema_errors_mapper.rb
 - lib/easy_talk/sorbet_extension.rb
 - lib/easy_talk/tools/function_builder.rb
 - lib/easy_talk/types/all_of.rb