json_api_normalizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9cac45030e198ecff9add95ca5a3e4b93ab01cbd54c1fbed7e8c319b724d0f2
+  data.tar.gz: 2ea65ec741a8c6d9864963f6136da9bba88ce5f6b28ea31e035540c5178da55a
+SHA512:
+  metadata.gz: 8093465de04179c4e81d2bd355b6f78102dc506b5689b4f2322190c7d50044beaff667d66ff7661bdfe8687b0effca29a430532d3de64f3d9b483b33c65077ac
+  data.tar.gz: 49efd5b11f969bf2eabab4c3ca808aa36b5206344e5bff19333e5d69ed335cd6858a1660143d40a3419bc9cdc6ae2b1d5c9da8fe621a66a2a30bfb7a72d6aa68

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Ivan Rudskikh
+
+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,77 @@
+# JsonApiNormalizer
+A simple way to convert datasets based on JSON API specification
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_api_normalizer'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install json_api_normalizer
+```
+
+## Usage
+```ruby
+require 'json'
+require 'json_api_normalizer'
+
+json = JSON.parse(File.read('articles.json'))
+data = JsonApiNormalizer.parse(json)
+puts JSON.pretty_generate(data) # =>
+```
+
+```json
+{
+  "id": "1",
+  "title": "JSON API paints my bikeshed!",
+  "author": {
+    "id": "9",
+    "first-name": "Dan",
+    "last-name": "Gebhardt",
+    "twitter": "dgeb"
+  },
+  "comments": [
+    {
+      "id": "5",
+      "body": "First!",
+      "author": {
+        "id": "2",
+        "first-name": "John",
+        "last-name": "Travolta",
+        "twitter": "johnt"
+      }
+    },
+    {
+      "id": "12",
+      "body": "I like XML better",
+      "author": {
+        "id": "9",
+        "first-name": "Dan",
+        "last-name": "Gebhardt",
+        "twitter": "dgeb"
+      }
+    }
+  ]
+}
+```
+
+
+## Contributing
+
+* Fork the project.
+* Add a breaking test for your change.
+* Make the tests pass.
+* Run `rubocop -a`
+* Push your fork.
+* Submit a pull request.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JsonApiNormalizer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/json_api_normalizer.rb

@@ -0,0 +1,7 @@
+require 'json_api_normalizer/parser'
+
+module JsonApiNormalizer
+  def self.parse(payload)
+    Parser.parse(payload)
+  end
+end

data/lib/json_api_normalizer/errors.rb

@@ -0,0 +1,4 @@
+module JsonApiNormalizer
+  BaseError = Class.new(StandardError)
+  InvalidPayloadError = Class.new(BaseError)
+end

data/lib/json_api_normalizer/parser.rb

@@ -0,0 +1,69 @@
+require 'json_api_normalizer/errors'
+
+module JsonApiNormalizer
+  class Parser
+    ROOT_KEYS = %w[data errors].freeze
+
+    attr_reader :payload
+    def initialize(payload)
+      @payload = payload
+      @models = {}
+    end
+
+    def parse
+      validate_payload
+
+      return payload if payload.key?('errors')
+
+      return normalize(payload['data']) if payload['data'].is_a?(Hash)
+
+      payload['data'].map { |json_model| normalize(json_model) }
+    end
+
+    def self.parse(payload)
+      new(payload).parse
+    end
+
+    private
+
+    def validate_payload
+      return unless (ROOT_KEYS & payload.keys).empty?
+
+      raise InvalidPayloadError, "JSON:API document must contain at least one of these objects: #{ROOT_KEYS.join(', ')}"
+    end
+
+    def fetch(model, id)
+      return @models[model][id] if @models[model] && @models[model][id]
+
+      @models[model] = {} unless @models.key?(model)
+      @models[model][id] = normalize(includes[model][id])
+    end
+
+    def includes
+      @includes ||= payload
+                    .fetch('included', [])
+                    .group_by { |model| model['type'] }
+                    .transform_values do |models|
+        models.each_with_object({}) { |model, st| st[model['id']] = model }
+      end
+    end
+
+    # rubocop: disable Metrics/MethodLength
+    def normalize(api_model)
+      model = { 'id' => api_model['id'] }.merge!(api_model.fetch('attributes', {}))
+      return model unless api_model.key?('relationships')
+
+      api_model['relationships'].each do |relation_name, relation|
+        data = relation['data']
+        model[relation_name] =
+          if data.is_a?(Hash)
+            fetch(*data.values_at('type', 'id'))
+          else
+            data.map { |r| fetch(*r.values_at('type', 'id')) }
+          end
+      end
+      model
+    end
+    # rubocop: enable Metrics/MethodLength
+  end
+end

data/lib/json_api_normalizer/version.rb

@@ -0,0 +1,3 @@
+module JsonApiNormalizer
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: json_api_normalizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Rudskikh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Simple json api normalizer
+email:
+- shredder.rull@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/json_api_normalizer.rb
+- lib/json_api_normalizer/errors.rb
+- lib/json_api_normalizer/parser.rb
+- lib/json_api_normalizer/version.rb
+homepage: https://github.com/digital-design-nyc/json_api_normalizer
+licenses:
+- MIT
+metadata: {}
+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.9
+signing_key: 
+specification_version: 4
+summary: Simple json api normalizer
+test_files: []