jsonapi_mapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '039bcb95b5c5b71d03c25ead00660671ad9a2db2'
+  data.tar.gz: bc0abb1fe5a9dd7b119367e5b91a0c1480e4e2ca
+SHA512:
+  metadata.gz: 55ccb1660bcd748ddea0cb153e1b3342be87fbdee5b3a0e793b1e3a50b85e548c69f81bcedd8a893710fdb3342ef938782d46e8266b0cb9ce9255c8c1f74c917
+  data.tar.gz: a84cf5543ad7f79b3b02e8361139f263b1f7ea949971fb75c4bea93a14bf345fed0b0b997e2ea6ee46db3a4310769245dccbaf082be1ec891db9987109eb1a74

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*.swo

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 nubis
+
+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,152 @@
+# JsonapiMapper
+
+Sanitizes a jsonapi Document and maps it to ActiveRecord, creating or updating as needed.
+- Prevents assiginging unexpected attributes on your records.
+- Prevents unscoped queries when creating/updating records.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi_mapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonapi_mapper
+
+## Usage
+
+See the specs directory for more examples.
+
+```ruby
+      class Person < ActiveRecord::Base
+        belongs_to :parent, class_name: 'Person'
+        has_many :children, class_name: 'Person', foreign_key: 'parent_id'
+        belongs_to :pet, class_name: 'PetDog'
+      end
+
+      class PetDog < ActiveRecord::Base
+        has_one :person, foreign_key: 'pet_id'
+      end
+
+      # This document should create a person and several associations.
+      # Notice how these not-persisted resources can be referenced using
+      # an internal id, which starts with @
+      # The local @ ids shall be replaced with proper server assigned ids
+      # once the resources are persisted.
+      document = {
+        data: {
+          type: 'people',
+          attributes: { name: 'ian', admin: true },
+          relationships: {
+            pet: { data: { type: 'pet_dogs', id: '@1' }},
+            parent: { data: { type: 'people', id: '@1' }},
+            children: { data: [
+              { type: 'people', id: '@2' },
+              { type: 'people', id: '@3' },
+            ]},
+          }
+        },
+        included: [
+          { type: 'people', id: '@1', attributes: { name: 'ana', admin: true } },
+          { type: 'people', id: '@2', attributes: { name: 'bob', admin: true } },
+          { type: 'people', id: '@3', attributes: { name: 'zoe', admin: true } },
+          { type: 'pet_dogs', id: '@1', attributes: { name: 'ace', age: 11 } }
+        ]
+      }
+
+      # The mapper whitelists which types should be expected from the
+      # jsonapi document. It also whitelists attributes and relationship names.
+      # The last item of the attributes list is a Hash to be used as 'scope'
+      # when attempting to fetch and/or modify any resource.
+      mapper = JsonapiMapper.doc(document,
+        people: [:name, :pet, :parent, :children, country: 'argentina'],
+        pet_dogs: [:name, country: 'argentina']
+      )
+
+      person = mapper.data # This is the main document data as a new object
+      others = mapper.included # These are all the other resources.
+      mapper.save_all # Attempts to save both data and included.
+      
+      # Four people have been created
+      Person.count.should == 4
+
+      # All of them from 'argentina' according to the provided scope.
+      Person.where(country: 'argentina').count.should == Person.count
+
+      # The 'admin' field was not set, because it wasn't in the mapper list.
+      Person.where(admin: true).count.should == 0
+      
+      # This other document tries to update a bob's name and parent.
+      # And it also creates a new dow and assigns it as pet for 'bob' and 'ana'
+      other_document = {
+        data: {
+          type: 'people',
+          id: '1',
+          attributes: { name: 'rob' },
+          relationships: {
+            pet: { data: { type: 'pet_dogs', id: '@1' }},
+            parent: { data: { type: 'people', id: '2' }},
+          }
+        },
+        included: [
+          { 
+            type: 'people',
+            id: ana.id,
+            relationships: {
+              pet: { data: { type: 'pet_dogs', id: '@1' }},
+            }
+          },
+          { type: 'pet_dogs', id: '@1', attributes: { name: 'ace' } }
+        ]
+      }
+
+      mapper = JsonapiMapper.doc other_document,
+        people: [:name, :pet, :parent, country: 'uruguay'],
+        pet_dogs: [:name, country: 'uruguay']
+
+      mapper.save_all
+
+      # Is dangerous to use unscoped queries
+      # For those rare occassions where you don't need them they can be disabled.
+      # The JsonapiMapper.doc_unsafe! method receives an argument with the names
+      # of all the types for which a scope is not required.
+      JsonapiMapper.doc_unsafe! document,
+        [:pet_dogs],
+        people: [:name, :pet, :parent, country: 'uruguay'],
+        pet_dogs: [:name]
+
+      # If you're needing to 'translate' between your jsonapi document names
+      # and your ActiveRecord class and column names, you can do it like so:
+      # Notice how the second hash has translations for type and attribute names.
+      mapper = JsonapiMapper.doc(document, {
+        persons: [:handle, :dog, :parental_figure, country: 'uruguay'],
+        pets: [:nickname, country: 'uruguay']
+      },
+      { types: { persons: Person, pets: PetDog },
+        attributes: {
+          persons: {handle: :name, dog: :pet, parental_figure: :parent},
+          pets: {nickname: :name},
+        }  
+      }).save_all
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/jsonapi_mapper.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jsonapi_mapper"
+
+# 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/jsonapi_mapper.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jsonapi_mapper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonapi_mapper"
+  spec.version       = JsonapiMapper::VERSION
+  spec.authors       = ["nubis"]
+  spec.email         = ["nb@bitex.la"]
+
+  spec.summary       = %q{Sanitize and Map jsonapi documents straight into activemodels}
+  spec.description   = %q{
+    Sanitizes a jsonapi Document and maps it to ActiveRecord,
+    creating or updating as needed.
+    Prevents mistakes when assigingng attributes or referring to 
+    unscoped relationships.
+  }
+  spec.homepage      = "https://github.com/bitex-la/jsonapi-mapper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency "activesupport", '~> 4.2', '>= 4.2.0'
+  spec.add_dependency "activemodel",'~> 4.2', '>= 4.2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activerecord", '~> 4.2', '>= 4.2.0'
+  spec.add_development_dependency "sqlite3", "~> 1.0", ">= 1.0.0"
+  spec.add_development_dependency "byebug", "~> 6.0", ">= 6.0.0"
+end

data/lib/jsonapi_mapper.rb

@@ -0,0 +1,166 @@
+require "jsonapi_mapper/version"
+
+module JsonapiMapper
+  def self.doc(document, rules, renames = {})
+    DocumentMapper.new(document, [], rules, renames)
+  end
+
+  def self.doc_unsafe!(document, unscoped, rules, renames = {})
+    DocumentMapper.new(document, unscoped, rules, renames)
+  end
+
+  class RulesError < StandardError; end;
+
+  Id = Struct.new(:type, :raw)
+  Type = Struct.new(:name, :class, :rule)
+  Resource = Struct.new(:object, :relationships, :id)
+  Rule = Struct.new(:attributes, :scope)
+
+  class DocumentMapper
+    attr_accessor :document, :unscoped, :types, :renames, :resources,
+      :data, :included
+
+    def initialize(document, unscoped, rules, renames)
+      self.document = document.deep_symbolize_keys
+      self.renames = renames.deep_symbolize_keys
+      self.unscoped = unscoped.map(&:to_sym)
+      self.resources = {}
+
+      setup_types(rules)
+
+      main = if data = document[:data]
+        if data.is_a?(Array)
+          data.map{|r| build_resource(r) }.compact
+        else
+          build_resource(data)
+        end
+      end
+
+      rest = if included = document[:included]
+        included.map{|r| build_resource(r) }.compact
+      end
+
+      resources.each{|_,r| assign_relationships(r) }
+
+      self.data = main.is_a?(Array) ? main.map(&:object) : main.try(:object)
+      self.included = rest.try(:map, &:object)
+    end
+
+    def setup_types(rules)
+      self.types = {}
+      rules.each do |type_name, ruleset|
+        type_name = type_name.to_sym
+
+        attrs, scope = if ruleset.last.is_a?(Hash)
+          [ruleset[0..-2], ruleset.last]
+        else
+          unless unscoped.map(&:to_sym).include?(type_name)
+            raise RulesError.new("Missing Scope for #{type_name}")
+          end
+          [ruleset, {}]
+        end
+
+        unless attrs.all?{|v| v.is_a?(Symbol) || v.is_a?(String) } 
+          raise RulesError.new('Attributes must be Strings or Symbols')
+        end
+
+        attrs = attrs.map(&:to_sym)
+        scope.symbolize_keys!
+
+        danger = scope.keys.to_set & attrs.map{|a| renamed(type_name, a) }.to_set
+        if danger.count > 0
+          raise RulesError.new("Don't let user set the scope: #{danger.to_a}")
+        end
+
+        cls = renames.fetch(:types, {})[type_name] ||
+          type_name.to_s.singularize.camelize.constantize
+
+        attrs.map{|a| renamed(type_name, a) }.each do |attr|
+          unless cls.new.respond_to?(attr)
+            raise NoMethodError.new("undefined method #{attr} for #{cls}")
+          end
+        end
+
+        types[type_name] = Type.new(type_name, cls, Rule.new(attrs, scope))
+      end
+    end
+
+    def build_resource(json)
+      return unless json.is_a? Hash
+      return unless json.fetch(:relationships, {}).is_a?(Hash)
+      return unless json.fetch(:attributes, {}).is_a?(Hash)
+      return unless type = types[json[:type].try(:to_sym)]
+
+      object = if json[:id].nil? || json[:id].to_s.starts_with?("@")
+        type.class.new.tap do |o|
+          type.rule.scope.each do |k,v|
+            o.send("#{k}=", v)
+          end
+        end
+      else
+        type.class.where(type.rule.scope).find(json[:id])
+      end
+
+      relationships = {}
+      json.fetch(:relationships, {}).each do |name, value|
+        next unless type.rule.attributes.include?(name)
+        relationships[renamed(type.name, name)] = if value[:data].is_a?(Array)
+          value[:data].map{|v| build_id(v) }
+        else
+          build_id(value[:data])
+        end
+      end
+
+      if attributes_to_be_set = json[:attributes]
+        type.rule.attributes.each do |name|
+          if value = attributes_to_be_set[name]
+            object.send("#{renamed(type.name, name)}=", value) 
+          end
+        end
+      end
+
+      resource = Resource.new(object, relationships, build_id(json))
+      resources[resource.id] = resource
+    end
+
+    def build_id(json)
+      Id.new(json[:type].to_sym, json[:id])
+    end
+
+    def assign_relationships(resource)
+      resource.relationships.each do |name, ids|
+        if ids.is_a?(Array)
+          ids.each do |id|
+            next unless other = find_resource_object(id)
+            resource.object.send(name).push(other)
+          end
+        else
+          next unless other = find_resource_object(ids)
+          resource.object.send("#{name}=", other)
+        end
+      end
+    end
+
+    def find_resource_object(id)
+      return unless type = types[id.type]
+
+      resources[id].try(:object) ||
+        type.class.where(type.rule.scope).find(id.raw) or
+        raise ActiveRecord::RecordNotFound
+          .new("Couldn't find #{id.type} with id=#{id.raw}")
+    end
+
+    def renamed(type, attr)
+      renames.fetch(:attributes, {}).fetch(type, {}).fetch(attr, attr)
+    end
+
+    def save_all
+      data.is_a?(Array) ? data.each(&:save) : data.try(:save)
+      included.try(:each, &:save)
+    end
+
+    def collection?
+      data.is_a?(Array)
+    end
+  end
+end

data/lib/jsonapi_mapper/version.rb

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

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi_mapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nubis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: "\n    Sanitizes a jsonapi Document and maps it to ActiveRecord,\n    creating
+  or updating as needed.\n    Prevents mistakes when assigingng attributes or referring
+  to \n    unscoped relationships.\n  "
+email:
+- nb@bitex.la
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsonapi_mapper.gemspec
+- lib/jsonapi_mapper.rb
+- lib/jsonapi_mapper/version.rb
+homepage: https://github.com/bitex-la/jsonapi-mapper
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Sanitize and Map jsonapi documents straight into activemodels
+test_files: []