json_reducer 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4801f3c79cc372e71577b2a3b725c446b7c39021bd985be3ed6694bce8cdc888
-  data.tar.gz: 860345a2846bb71d9da0e84b2c0caa3483236e113f16f27035d821b7fddd7fdc
+  metadata.gz: 12500570e62a718b69b1ba6fe10cfbdbca13979cc595746da329a18ea0f92894
+  data.tar.gz: 9a1e9dcecc32523bbe596f70a0582d369a06803a0233360fc9c03bd9ed644f63
 SHA512:
-  metadata.gz: d082cfb79bbd83605f626c21c4d539b40c7494d37de2d0c364997fa79aaeef9bea98bbdec9de85332b79df7049c08735de27c3e84ab173c15c90a224f66facd8
-  data.tar.gz: 605ee59e2cf8e772f6428f35b6108f6c735a16af8bfa3a9fd4daebce8a5005b7147d779836db50dccd0c7cc7bad7e62450834740fc10fc416d690e48b49b6917
+  metadata.gz: ea703da98688df194501db5ef50f1c25c6d374c21fdee4372d3cd260053fece80c911817144b892f3adb743b6c8919daeb110a38dc0c64f113cf8342dfa352c3
+  data.tar.gz: c3b12941618cbfc2f8f9ad74f7c767b03f9d3193c97ee74bc785b97172282ded21418d94de321dc2b92424e7072c2ebf42205eb18bd67547fd46b95a5d180ebe

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json_reducer (0.1.0)
+    json_reducer (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,6 @@
 # JsonReducer
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/json_reducer`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Reduces hash based on given schema. If you want to render just one part of the hash this gem will make that easy. Just create JSON schema for desired response and gem will do the rest.
 
 ## Installation
 
@@ -22,7 +20,112 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First create an initializer inside initializers folder. You can call it json_reducer but that is up to you.
+Here you can define your base_path to schemas and register them.
+
+```ruby
+JsonReducer.base_path(Rails.root.join('lib', 'schemas'))  # don't forget to create schemas folder
+
+JsonReducer.register(:example1, 'example1.json')
+JsonReducer.register(:example2, { foo: {bar: {title: 'BAR'} } }, file: false)
+JsonReducer.register(:example3, {"foo": {"bar": {"title": "BAR"}}}, file: false)
+```
+
+You can pass filename, json or hash. Just set file option to false for hash or json.
+When you want to register schema using path pass schema filename. In our example schema source is in: '/lib/schemas/example1.json'
+
+JSON schema example:
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "foo": {
+      "type": "object",
+      "properties": {
+        "bar": {"type": "object"}
+      }
+    },
+    "abc": {
+      "type": "array",
+      "properties": {
+        "id": { "type" : "string" }
+      }
+    }
+  }
+}
+```
+
+In JSON schema you are just whitelisting the properties which you want to use. If you exclude field in properties it will be excluded in response
+but if you completely omit properties in JSON schema all object fields for that property object will be parsed.
+It is important to set type correctly, especially for arrays otherwise hash won't be parsed correctly.
+
+## Example
+
+```
+payload = {
+  foo: {
+    bar: {
+      title: 'BAR',
+      body: 'Body of the BAR'
+    },
+    baz: 'BAZ'
+  },
+  abc: {
+    def: 'DEF'
+  },
+  dbc: {
+    fed: 'FED'
+  }
+}
+```
+
+```json
+schema = {
+  "type": "object",
+  "properties": {
+    "foo": {
+      "type": "object",
+      "properties": {
+        "bar": {
+          "type": "object",
+          "properties": {
+            "title": { "type": "string" }
+            /* omitting body to exclude it from response */
+          }
+        }
+      }
+    },
+    "dbc": {
+      "type": "object"  
+      /* omitting properties to parse all */
+    }
+  }
+}
+```
+
+Registering the schema and applying it on given payload.
+
+```
+JsonReducer.register(:test, schema, file: false)
+JsonReducer.new(:test).apply(payload)
+```
+
+Will result with
+
+```
+payload = {
+  'foo' => {
+    'bar' => {
+      'title' => 'BAR'
+    }
+  },
+  'dbc' => {
+    'fed' => 'FED'
+  }
+}
+
+```
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "json_reducer"
+require 'bundler/setup'
+require 'json_reducer'
 
 # 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.
@@ -10,5 +10,5 @@ require "json_reducer"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/json_reducer.gemspec

@@ -1,38 +1,38 @@
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "json_reducer/version"
+require 'json_reducer/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "json_reducer"
+  spec.name          = 'json_reducer'
   spec.version       = JsonReducer::VERSION
-  spec.authors       = ["Edis Veljacic"]
-  spec.email         = ["Veljacic@fidor.com"]
+  spec.authors       = ['Edis Veljacic']
+  spec.email         = ['Veljacic@fidor.com']
 
   spec.summary       = 'Hash reducer'
   spec.description   = 'Reduces hash based on given JSON schema.'
-  spec.homepage      = 'https://github.com/edis-veljacic'
+  spec.homepage      = 'https://github.com/veljacic/json_reducer'
   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['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    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
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/json_reducer/mask.rb

@@ -1,7 +1,7 @@
 module JsonReducer
   class Mask
-    def initialize(schema)
-      @schema = parse_record(schema)
+    def initialize(key)
+      @schema = JsonReducer::Schemas.instance.get(key)
     end
 
     def apply(payload)
@@ -16,7 +16,6 @@ module JsonReducer
     def apply!(payload, schema)
       return if schema.dig('properties').nil?
 
-      # sliced = payload.slice!(*schema['properties'].keys)
       sliced = slice!(payload, schema['properties'].keys)
       handle(schema['properties'], sliced)
     end

data/lib/json_reducer/schemas.rb

@@ -0,0 +1,24 @@
+require 'singleton'
+require 'json'
+
+module JsonReducer
+  class Schemas
+    include Singleton
+
+    attr_accessor :base_path
+
+    def initialize
+      @schemas = {}
+      @base_path = nil
+    end
+
+    def get(key)
+      @schemas[key]
+    end
+
+    def set(key, schema, file)
+      value = file ? File.read("#{@base_path}/#{schema}") : schema
+      @schemas[key] = value.is_a?(String) ? JSON.parse(value) : value
+    end
+  end
+end

data/lib/json_reducer/version.rb

@@ -1,3 +1,3 @@
 module JsonReducer
-  VERSION = "0.1.0"
+  VERSION = '1.1.0'.freeze
 end

data/lib/json_reducer.rb

@@ -1,8 +1,18 @@
 require 'json_reducer/version'
+
 require 'json_reducer/mask'
+require 'json_reducer/schemas'
 
 module JsonReducer
   def self.new(*args)
     Mask.new(*args)
   end
+
+  def self.register(key, schema, file: true)
+    JsonReducer::Schemas.instance.set(key, schema, file)
+  end
+
+  def self.base_path(path)
+    JsonReducer::Schemas.instance.base_path = path
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_reducer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Edis Veljacic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-19 00:00:00.000000000 Z
+date: 2018-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,8 +73,9 @@ files:
 - json_reducer.gemspec
 - lib/json_reducer.rb
 - lib/json_reducer/mask.rb
+- lib/json_reducer/schemas.rb
 - lib/json_reducer/version.rb
-homepage: https://github.com/edis-veljacic
+homepage: https://github.com/veljacic/json_reducer
 licenses:
 - MIT
 metadata: