avro_turf 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfae5e5b40637dc42042fd526172b9265d7e6ffe
-  data.tar.gz: a8df9a341f18727f0617eb82b0ab4831a51c0ac8
+  metadata.gz: d083d0ed365ddbd16e9a5e35acf698d50a7bd7d5
+  data.tar.gz: a297b67a288046a64932ad1e388cd39e4e7a106d
 SHA512:
-  metadata.gz: abdaddbf56e6b7c34bce4f10118838847a09ec6ffdb850187e78efd2319b251db4016d6773ac08686ab86f7deba9070a3553f7ddd26f76c41a2a6dec8f4e0639
-  data.tar.gz: ad8734818133df66c3717a92143e3dae81eba436a1bb3095df5b46fef9f3053f79419471488707e3c4f7fe3ec6257eabf2a0aa0724de4d83970b40c3376af81c
+  metadata.gz: de5d8c415fcf16b731aa9cd4b69c5e8fc4e2243b092744a637a68a36494083330b861731f7567a4677ba0d149c60a8da6cbce38e40ee32771a84cdb9c687e843
+  data.tar.gz: 0e14a355dc76805b335d2fda8871671714a3843abe60886ef9d25ec5a4bad3270127d46386c2713e968a1eba47131753389b3cbb55531e8cafd0535ac14b2f39

data/README.md

@@ -81,8 +81,10 @@ In the example above, the `person` schema references the `address` schema, even
 // person_list.avsc
 {
   "name": "person_list",
-  "type": "array",
-  "items": "person"
+  "type": {
+    "type": "array",
+    "items": "person"
+  }
 }
 ```
 

data/circle.yml

@@ -1,3 +1,4 @@
 machine:
   ruby:
     version: 2.2.0
+    version: 2.0.0

data/lib/avro_turf.rb

@@ -9,16 +9,18 @@ class AvroTurf
   class SchemaError < Error; end
   class SchemaNotFoundError < Error; end
 
+  DEFAULT_SCHEMAS_PATH = "./schemas"
+
   # Create a new AvroTurf instance with the specified configuration.
   #
-  # schemas_path - The String path to the root directory containing Avro schemas.
+  # schemas_path - The String path to the root directory containing Avro schemas (default: "./schemas").
   # namespace    - The String namespace that should be used to qualify schema names (optional).
   # codec        - The String name of a codec that should be used to compress messages (optional).
   #
   # Currently, the only valid codec name is `deflate`.
-  def initialize(schemas_path:, namespace: nil, codec: nil)
+  def initialize(schemas_path: nil, namespace: nil, codec: nil)
     @namespace = namespace
-    @schema_store = SchemaStore.new(path: schemas_path)
+    @schema_store = SchemaStore.new(path: schemas_path || DEFAULT_SCHEMAS_PATH)
     @codec = codec
   end
 
@@ -28,7 +30,7 @@ class AvroTurf
   # schema_name - The name of a schema in the `schemas_path`.
   #
   # Returns a String containing the encoded data.
-  def encode(data, schema_name:, namespace: @namespace)
+  def encode(data, schema_name: nil, namespace: @namespace)
     stream = StringIO.new
 
     encode_to_stream(data, stream: stream, schema_name: schema_name, namespace: namespace)
@@ -44,7 +46,7 @@ class AvroTurf
   # stream      - An IO object that the encoded data should be written to (optional).
   #
   # Returns nothing.
-  def encode_to_stream(data, schema_name:, stream:, namespace: @namespace)
+  def encode_to_stream(data, schema_name: nil, stream: nil, namespace: @namespace)
     schema = @schema_store.find(schema_name, namespace)
     writer = Avro::IO::DatumWriter.new(schema)
 
@@ -81,6 +83,20 @@ class AvroTurf
     dr.first
   end
 
+  # Validates data against an Avro schema.
+  #
+  # data        - The data that should be validated.
+  # schema    - The String name of the schema that should be used to validate
+  #             the data.
+  # namespace - The namespace of the Avro schema (optional).
+  #
+  # Returns true if the data is valid, false otherwise.
+  def valid?(data, schema_name: nil, namespace: @namespace)
+    schema = schema_name && @schema_store.find(schema_name, namespace)
+
+    Avro::Schema.validate(schema, data)
+  end
+
   # Loads all schema definition files in the `schemas_dir`.
   def load_schemas!
     @schema_store.load_schemas!

data/lib/avro_turf/schema_store.rb

@@ -1,5 +1,5 @@
 class AvroTurf::SchemaStore
-  def initialize(path:)
+  def initialize(path: nil)
     @path = path or raise "Please specify a schema path"
     @schemas = Hash.new
   end

data/lib/avro_turf/version.rb

@@ -1,3 +1,3 @@
 class AvroTurf
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/spec/avro_turf_spec.rb

@@ -122,4 +122,25 @@ describe AvroTurf do
       expect(avro.decode_stream(stream)).to eq "hello"
     end
   end
+
+  describe "#valid?" do
+    before do
+      define_schema "message.avsc", <<-AVSC
+        {
+          "name": "message",
+          "type": "string"
+        }
+      AVSC
+    end
+
+    it "returns true if the datum matches the schema" do
+      datum = "hello"
+      expect(avro.valid?(datum, schema_name: "message")).to eq true
+    end
+
+    it "returns false if the datum does not match the schema" do
+      datum = 42
+      expect(avro.valid?(datum, schema_name: "message")).to eq false
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro_turf
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A library that makes it easier to use the Avro serialization format from