json_schema_transformer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b37f568c5b37ed6c556731814fe7765af2701f47afdef91624b7318d4974cd0
+  data.tar.gz: '0908f5b019ede691430788f08c8d0bc2bbad1144262eb8b5e8afa59218140bad'
+SHA512:
+  metadata.gz: 1d1eb882a538e070f1b93f04d72827189cac593dc72d28e1121c8cfe45081a4141c260d77ac92e5c6ab81b4a5ea419e6bf90bb505a15cd43ec079eb7fcfeb7c4
+  data.tar.gz: 660a20c9f610135ae7bc610e865271b672240136f31f82daf7f29881b1a8879af525ccad26afd199ed6b276efcb9f2f9e43c658ec4d2c21170f5b4c85ff8beee

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at narendran.velmurugan@freshworks.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in json_schema.gemspec
+gemspec
+gem 'byebug'
+gem 'pry'
+ 

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    json_schema (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    coderay (1.1.2)
+    diff-lcs (1.4.4)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  json_schema!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.2)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Narendran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Narendran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Json Schema Generator
+
+Json Schema Generator is to describe the structure and validation constraints of your JSON documents. There are many json-schema validators, but only few generators. This library is intended to provide Ruby with an interface for validating JSON objects against a JSON schema conforming to JSON Draft7.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_schema'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_schema
+
+## Usage
+
+```
+input = {name: 'naren', role:[{id: 1, name: 'backend'}, {id: 2, name: 'frontend'}]} // provide JSON input
+JsonSchema.generate(input)
+
+Output:
+{"title"=>"The root schema", "description"=>"The root schema comprises the entire JSON document.", "$schema"=>"http://json-schema.org/draft-07/schema", "type"=>"object", "required"=>["name", "role"], "properties"=>{"name"=>{"type"=>"string"}, "role"=>{"type"=>"array", "items"=>{"type"=>"object", "required"=>["id", "name"], "properties"=>{"id"=>{"type"=>"integer"}, "name"=>{"type"=>"string"}}}}}}
+```
+## Optional Parameters:
+
+Array validations
+```
+Input:
+{:data=>[{:id=>"1", :type=>"type1", :attributes=>{:message=>"Message", :status=>"pending"}}, {:id=>"2", :something=>"typ2", :attributes=>{:name=>"Name1", :activity=>"None"}}]} 
+
+```
+## To return array first element Schema:
+```
+To return Array first element's Schema:
+JsonSchema.generate(input, array_validations: :first_element)
+
+Output: {"title"=>"The root schema", "description"=>"The root schema comprises the entire JSON document.", "$schema"=>"http://json-schema.org/draft-07/schema", "type"=>"object", "required"=>["data"], "properties"=>{"data"=>{"type"=>"array", "items"=>{"type"=>"object", "required"=>["id", "type", "attributes"], "properties"=>{"id"=>{"type"=>"string"}, "type"=>{"type"=>"string"}, "attributes"=>{"type"=>"object", "required"=>["message", "status"], "properties"=>{"message"=>{"type"=>"string"}, "status"=>{"type"=>"string"}}}}}}}}
+```
+## To return Entire Array Schema:
+
+```
+
+JsonSchema.generate(input, array_validations: :any_of)
+
+Output: {"title"=>"The root schema", "description"=>"The root schema comprises the entire JSON document.", "$schema"=>"http://json-schema.org/draft-07/schema", "type"=>"object", "required"=>["data"], "properties"=>{"data"=>{"type"=>"array", "items"=>{"anyOf"=>[{"type"=>"object", "required"=>["id", "type", "attributes"], "properties"=>{"id"=>{"type"=>"string"}, "type"=>{"type"=>"string"}, "attributes"=>{"type"=>"object", "required"=>["message", "status"], "properties"=>{"message"=>{"type"=>"string"}, "status"=>{"type"=>"string"}}}}}, {"type"=>"object", "required"=>["id", "something", "attributes"], "properties"=>{"id"=>{"type"=>"string"}, "something"=>{"type"=>"string"}, "attributes"=>{"type"=>"object", "required"=>["name", "activity"], "properties"=>{"name"=>{"type"=>"string"}, "activity"=>{"type"=>"string"}}}}}]}}}} 
+
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Narendranvel/json_schema. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the JsonSchema project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Narendranvel/json_schema/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_schema"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json_schema.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json_schema/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_schema_transformer"
+  spec.version       = JsonSchema::VERSION
+  spec.authors       = ["Narendran"]
+  spec.email         = ["narendranvelmurugan06@gmail.com"]
+
+  spec.summary       = 'Generate JSON schema from JSON.'
+  spec.description   = 'Generate JSON schema from JSON.'
+  spec.homepage      = 'https://github.com/Narendranvel/json_schema'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/Narendranvel/json_schema'
+    spec.metadata['changelog_uri'] = 'https://github.com/Narendranvel/json_schema'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/lib/json_schema.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'json_schema/version'
+require 'json_schema/Constants'
+require 'json_schema/draft07'
+
+module JsonSchema
+  class << self
+    include Constants
+    def generate(json_data, options = {})
+      version = options[:schema_version] || DEFAULT_VERSION
+      options[:array_validation] = options[:array_validation] || DEFAULT_ARRAY_VALIDATION
+      raise "Unsupported Schema version: #{version}" unless SUPPORTED_VERSIONS.include? version.to_s.downcase
+      # raise "Unsupported Array Validation #{options[:array_validation]}" unless options[:array_validation] && ARRAY_VALIDATIONS.include? options[:array_validation]
+      # Todo - Support draft4 & draft6
+      @version = DRAFT7 if DRAFT7_VERSION.include? version.to_s.downcase
+      @schema_class = Object.const_get(SCHEMA_CLASS[@version])
+      @schema_class.new(json_data, options).generate
+    end
+  end
+end

data/lib/json_schema/constants.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module JsonSchema
+  module Constants
+    DRAFT7 = 'draft-07'
+
+    DEFAULT_VERSION = 'draft7'
+    DRAFT7_VERSION = %w(draft7 draft-07)
+
+    SUPPORTED_VERSIONS = DRAFT7_VERSION
+
+    ARRAY_VALIDATIONS = %I(first_element any_of)
+
+    DEFAULT_ARRAY_VALIDATION = :first_element
+
+    SCHEMA_CLASS = {'draft-07' => 'JsonSchema::Draft07'}
+  end
+end

data/lib/json_schema/draft07.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+require 'json_schema/draft_constants'
+
+module JsonSchema
+  class Draft07
+    include DraftConstants
+    def initialize(raw_json, options = {})
+      @raw_json = raw_json
+      @options = options
+      @parsed_json = parse(raw_json)
+    end
+
+    def generate
+      raise StandardError, 'Invalid Input. Input should in the valid JSON format' unless parsed_json
+      { 'title' => ROOT_TITLE, 'description' => ROOT_DESCRIPTION, "$schema" => "http://json-schema.org/draft-07/schema" }.merge(schema_generate(parsed_json))
+    end
+
+    private
+
+    attr_reader :raw_json, :options, :parsed_json
+
+    def parse(json)
+      JSON.parse(json)
+    rescue StandardError
+      nil
+    end
+
+    def schema_generate(input)
+      case input
+      when Hash
+        generate_object(input)
+      when Array
+        generate_array(input)
+      else
+        {'type' => datatype(input)}
+      end
+    end
+
+    def generate_object(object)
+      params = {
+        'type' => 'object',
+        'required' => object.keys,
+        'properties' => {}
+      }
+      object.each_with_object(params) do |(key, value), hsh|
+        hsh['properties'].merge!({key => schema_generate(value)})
+      end
+    end
+
+    def generate_array(array)
+      params = {
+        'type' => 'array',
+        'items' => {},
+      }
+      case @options[:array_validation]
+      when :any_of
+        params['items']['anyOf'] = []
+        array.each_with_object(params) do |elem, hsh|
+          hsh['items']['anyOf'].push(schema_generate(elem))
+        end
+      when :first_element
+        array.values_at(0).each_with_object(params) do |elem, hsh|
+          hsh['items'].merge!(schema_generate(elem))
+        end
+      end
+    end
+
+    def datatype(value)
+      case value
+      when TrueClass, FalseClass
+        'boolean'
+      when Float
+        'number'
+      when Hash
+        'object'
+      when String, Integer, Array
+        value.class.to_s.downcase
+      when NilClass
+        'null'
+      else
+        raise Error, "Invalid type #{value.class}"
+      end
+    end
+  end
+end

data/lib/json_schema/draft_constants.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module DraftConstants
+  ROOT_TITLE = 'The root schema'
+  ROOT_DESCRIPTION = 'The root schema comprises the entire JSON document.'
+end

data/lib/json_schema/version.rb

@@ -0,0 +1,3 @@
+module JsonSchema
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: json_schema_transformer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Narendran
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Generate JSON schema from JSON.
+email:
+- narendranvelmurugan06@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_schema.gemspec
+- lib/.DS_Store
+- lib/json_schema.rb
+- lib/json_schema/.DS_Store
+- lib/json_schema/constants.rb
+- lib/json_schema/draft07.rb
+- lib/json_schema/draft_constants.rb
+- lib/json_schema/version.rb
+homepage: https://github.com/Narendranvel/json_schema
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/Narendranvel/json_schema
+  source_code_uri: https://github.com/Narendranvel/json_schema
+  changelog_uri: https://github.com/Narendranvel/json_schema
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.10
+signing_key:
+specification_version: 4
+summary: Generate JSON schema from JSON.
+test_files: []