active_model_serializers-jsonapi_embedded_records_deserializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a8bfc4881f0dcf252c4388ea048fd4c2cb7286b
+  data.tar.gz: 2f444ce728efd408c8d20c44e8b90d8e0b61ef09
+SHA512:
+  metadata.gz: a0de04e66ba26acb450d5f767b7b4a2aac5fb22d6af7a9f6c84b857e06e38f9a9dc8583499e3ee493593c8673e114da855425a1f1f15e346916375c2fe3dbdc2
+  data.tar.gz: 684b2ea7c26c3a05722eae795e49f40032a207a968eee44acefdf330d6486e559b603afef92fbd62751acbf34950bf11cb72559c23b0beb11f0a6c6e8d019dbf

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at paul.spieker@suitepad.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_model_serializers-jsonapi_embedded_records_deserializer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Paul Spieker
+
+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,97 @@
+# ActiveModelSerializers::JsonapiEmbeddedRecordsDeserializer
+
+In some cases it is required to embed records into a relationship when creating
+or maybe even when updating a record. The JSONAPI spec currently doesn't support
+this but since a relationship contains a `data` part containing record objects,
+it seems to be a possible way to include data there.
+
+This gem extends the deserializer of ActiveModelSerializers to deserialize
+relationships with embedded data into ActiveRecord nested attributes. The code
+is extracted from the pull request [#1614](https://github.com/rails-api/active_model_serializers/pull/1614) of
+ActiveModelSerializers.
+
+### Example
+
+The input data contains an author with embedded data.
+
+```json
+{
+  "data": {
+    "type": "photos",
+    "id": "zorglub",
+    "attributes": {
+      "title": "Ember Hamster",
+      "src": "http://example.com/images/productivity.png"
+    },
+    "relationships": {
+      "author": {
+        "data": {
+          "type": "author",
+          "attributes": {
+            "name": "John Doe"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+When using the deserializer, the relationship `author` must be marked as embedded.
+
+```ruby
+ActiveModelSerializers::Deserialization.jsonapi_parse(data, embedded: [:author])
+```
+
+The result of the deserialization contains the `author_attributes` key as
+expected by ActiveRecord containing the nested attributes.
+
+```ruby
+{
+  id: 'zorglub',
+  title: 'Ember Hamster',
+  src: 'http://example.com/images/productivity.png',
+  author_attributes: {
+    name: 'John Doe'
+  }
+}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_model_serializers-jsonapi_embedded_records_deserializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_model_serializers-jsonapi_embedded_records_deserializer
+
+## Usage
+
+To support embedded records, the relationship expecting embedded data must be
+specified in the `embedded` key of the deserialization options.
+
+```ruby
+ActiveModelSerializers::Deserialization.jsonapi_parse(data, embedded: [:author])
+```
+
+## 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/spieker/active_model_serializers-jsonapi_embedded_records_deserializer. 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](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/active_model_serializers-jsonapi_embedded_records_deserializer.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_model_serializers/jsonapi_embedded_records_deserializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_model_serializers-jsonapi_embedded_records_deserializer"
+  spec.version       = ActiveModelSerializers::JsonapiEmbeddedRecordsDeserializer::VERSION
+  spec.authors       = ["Paul Spieker"]
+  spec.email         = ["p.spieker@duenos.de"]
+
+  spec.summary       = %q{Deserializing embedded JSONAPI records into ActiveRecord nested attributes (Not part of the JSONAPI spec yet!)}
+  spec.homepage      = "https://github.com/spieker/active_model_serializers-jsonapi_embedded_records_deserializer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # This only works with "0.10.0.rc4". On the current "master" branch, the
+  # deserializer has already been moved to
+  # active_model_serializers/adapter/json_api/deserialization
+  spec.add_dependency 'active_model_serializers', '0.10.0.rc4'
+  spec.add_runtime_dependency 'railties', '>= 4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.4'
+end

data/bin/console

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

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/lib/active_model_serializers/jsonapi_embedded_records_deserializer/version.rb

@@ -0,0 +1,5 @@
+module ActiveModelSerializers
+  module JsonapiEmbeddedRecordsDeserializer
+    VERSION = "0.1.0"
+  end
+end

data/lib/active_model_serializers/jsonapi_embedded_records_deserializer.rb

@@ -0,0 +1,46 @@
+require 'active_model_serializers/jsonapi_embedded_records_deserializer/version'
+require 'active_model/serializer/adapter/json_api/deserialization'
+
+module ActiveModelSerializers
+  module JsonapiEmbeddedRecordsDeserializer
+  end
+end
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        module Deserialization
+          module_function
+
+          def parse_relationship(assoc_name, assoc_data, options)
+            prefix_key = field_key(assoc_name, options).to_s.singularize
+            hash =
+              if (options[:embedded] || []).include?(assoc_name.to_sym)
+                parse_nested_attributes(assoc_name, assoc_data, options)
+              elsif assoc_data.is_a?(Array)
+                { "#{prefix_key}_ids".to_sym => assoc_data.map { |ri| ri['id'] } }
+              else
+                { "#{prefix_key}_id".to_sym => assoc_data ? assoc_data['id'] : nil }
+              end
+
+            polymorphic = (options[:polymorphic] || []).include?(assoc_name.to_sym)
+            hash["#{prefix_key}_type".to_sym] = assoc_data['type'] if polymorphic
+
+            hash
+          end
+
+          def parse_nested_attributes(assoc_name, assoc_data, options)
+            data =
+              if assoc_data.is_a?(Array)
+                assoc_data.map { |ri| parse({ 'data' => ri }, options) }
+              else
+                parse({ 'data' => assoc_data }, options)
+              end
+            { "#{assoc_name}_attributes".to_sym => data }
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: active_model_serializers-jsonapi_embedded_records_deserializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Spieker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0.rc4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0.rc4
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email:
+- p.spieker@duenos.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_model_serializers-jsonapi_embedded_records_deserializer.gemspec
+- bin/console
+- bin/setup
+- lib/active_model_serializers/jsonapi_embedded_records_deserializer.rb
+- lib/active_model_serializers/jsonapi_embedded_records_deserializer/version.rb
+homepage: https://github.com/spieker/active_model_serializers-jsonapi_embedded_records_deserializer
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Deserializing embedded JSONAPI records into ActiveRecord nested attributes
+  (Not part of the JSONAPI spec yet!)
+test_files: []
+has_rdoc: