active_model_serializers-jsonapi_embedded_records_deserializer 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 5a8bfc4881f0dcf252c4388ea048fd4c2cb7286b
4
+ data.tar.gz: 2f444ce728efd408c8d20c44e8b90d8e0b61ef09
5
+ SHA512:
6
+ metadata.gz: a0de04e66ba26acb450d5f767b7b4a2aac5fb22d6af7a9f6c84b857e06e38f9a9dc8583499e3ee493593c8673e114da855425a1f1f15e346916375c2fe3dbdc2
7
+ data.tar.gz: 684b2ea7c26c3a05722eae795e49f40032a207a968eee44acefdf330d6486e559b603afef92fbd62751acbf34950bf11cb72559c23b0beb11f0a6c6e8d019dbf
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.1
4
+ before_install: gem install bundler -v 1.11.2
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at paul.spieker@suitepad.de. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in active_model_serializers-jsonapi_embedded_records_deserializer.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Paul Spieker
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,97 @@
1
+ # ActiveModelSerializers::JsonapiEmbeddedRecordsDeserializer
2
+
3
+ In some cases it is required to embed records into a relationship when creating
4
+ or maybe even when updating a record. The JSONAPI spec currently doesn't support
5
+ this but since a relationship contains a `data` part containing record objects,
6
+ it seems to be a possible way to include data there.
7
+
8
+ This gem extends the deserializer of ActiveModelSerializers to deserialize
9
+ relationships with embedded data into ActiveRecord nested attributes. The code
10
+ is extracted from the pull request [#1614](https://github.com/rails-api/active_model_serializers/pull/1614) of
11
+ ActiveModelSerializers.
12
+
13
+ ### Example
14
+
15
+ The input data contains an author with embedded data.
16
+
17
+ ```json
18
+ {
19
+ "data": {
20
+ "type": "photos",
21
+ "id": "zorglub",
22
+ "attributes": {
23
+ "title": "Ember Hamster",
24
+ "src": "http://example.com/images/productivity.png"
25
+ },
26
+ "relationships": {
27
+ "author": {
28
+ "data": {
29
+ "type": "author",
30
+ "attributes": {
31
+ "name": "John Doe"
32
+ }
33
+ }
34
+ }
35
+ }
36
+ }
37
+ }
38
+ ```
39
+
40
+ When using the deserializer, the relationship `author` must be marked as embedded.
41
+
42
+ ```ruby
43
+ ActiveModelSerializers::Deserialization.jsonapi_parse(data, embedded: [:author])
44
+ ```
45
+
46
+ The result of the deserialization contains the `author_attributes` key as
47
+ expected by ActiveRecord containing the nested attributes.
48
+
49
+ ```ruby
50
+ {
51
+ id: 'zorglub',
52
+ title: 'Ember Hamster',
53
+ src: 'http://example.com/images/productivity.png',
54
+ author_attributes: {
55
+ name: 'John Doe'
56
+ }
57
+ }
58
+ ```
59
+
60
+ ## Installation
61
+
62
+ Add this line to your application's Gemfile:
63
+
64
+ ```ruby
65
+ gem 'active_model_serializers-jsonapi_embedded_records_deserializer'
66
+ ```
67
+
68
+ And then execute:
69
+
70
+ $ bundle
71
+
72
+ Or install it yourself as:
73
+
74
+ $ gem install active_model_serializers-jsonapi_embedded_records_deserializer
75
+
76
+ ## Usage
77
+
78
+ To support embedded records, the relationship expecting embedded data must be
79
+ specified in the `embedded` key of the deserialization options.
80
+
81
+ ```ruby
82
+ ActiveModelSerializers::Deserialization.jsonapi_parse(data, embedded: [:author])
83
+ ```
84
+
85
+ ## Development
86
+
87
+ 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.
88
+
89
+ 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).
90
+
91
+ ## Contributing
92
+
93
+ 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.
94
+
95
+ ## License
96
+
97
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,31 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'active_model_serializers/jsonapi_embedded_records_deserializer/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "active_model_serializers-jsonapi_embedded_records_deserializer"
8
+ spec.version = ActiveModelSerializers::JsonapiEmbeddedRecordsDeserializer::VERSION
9
+ spec.authors = ["Paul Spieker"]
10
+ spec.email = ["p.spieker@duenos.de"]
11
+
12
+ spec.summary = %q{Deserializing embedded JSONAPI records into ActiveRecord nested attributes (Not part of the JSONAPI spec yet!)}
13
+ spec.homepage = "https://github.com/spieker/active_model_serializers-jsonapi_embedded_records_deserializer"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.bindir = "exe"
18
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.require_paths = ["lib"]
20
+
21
+ # This only works with "0.10.0.rc4". On the current "master" branch, the
22
+ # deserializer has already been moved to
23
+ # active_model_serializers/adapter/json_api/deserialization
24
+ spec.add_dependency 'active_model_serializers', '0.10.0.rc4'
25
+ spec.add_runtime_dependency 'railties', '>= 4.0'
26
+
27
+ spec.add_development_dependency 'bundler', '~> 1.11'
28
+ spec.add_development_dependency 'rake', '~> 10.0'
29
+ spec.add_development_dependency 'rspec', '~> 3.0'
30
+ spec.add_development_dependency 'rspec-rails', '~> 3.4'
31
+ end
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "active_model_serializers/jsonapi_embedded_records_deserializer"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,5 @@
1
+ module ActiveModelSerializers
2
+ module JsonapiEmbeddedRecordsDeserializer
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,46 @@
1
+ require 'active_model_serializers/jsonapi_embedded_records_deserializer/version'
2
+ require 'active_model/serializer/adapter/json_api/deserialization'
3
+
4
+ module ActiveModelSerializers
5
+ module JsonapiEmbeddedRecordsDeserializer
6
+ end
7
+ end
8
+
9
+ module ActiveModel
10
+ class Serializer
11
+ module Adapter
12
+ class JsonApi
13
+ module Deserialization
14
+ module_function
15
+
16
+ def parse_relationship(assoc_name, assoc_data, options)
17
+ prefix_key = field_key(assoc_name, options).to_s.singularize
18
+ hash =
19
+ if (options[:embedded] || []).include?(assoc_name.to_sym)
20
+ parse_nested_attributes(assoc_name, assoc_data, options)
21
+ elsif assoc_data.is_a?(Array)
22
+ { "#{prefix_key}_ids".to_sym => assoc_data.map { |ri| ri['id'] } }
23
+ else
24
+ { "#{prefix_key}_id".to_sym => assoc_data ? assoc_data['id'] : nil }
25
+ end
26
+
27
+ polymorphic = (options[:polymorphic] || []).include?(assoc_name.to_sym)
28
+ hash["#{prefix_key}_type".to_sym] = assoc_data['type'] if polymorphic
29
+
30
+ hash
31
+ end
32
+
33
+ def parse_nested_attributes(assoc_name, assoc_data, options)
34
+ data =
35
+ if assoc_data.is_a?(Array)
36
+ assoc_data.map { |ri| parse({ 'data' => ri }, options) }
37
+ else
38
+ parse({ 'data' => assoc_data }, options)
39
+ end
40
+ { "#{assoc_name}_attributes".to_sym => data }
41
+ end
42
+ end
43
+ end
44
+ end
45
+ end
46
+ end
metadata ADDED
@@ -0,0 +1,143 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: active_model_serializers-jsonapi_embedded_records_deserializer
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Paul Spieker
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-03-29 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: active_model_serializers
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - '='
18
+ - !ruby/object:Gem::Version
19
+ version: 0.10.0.rc4
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - '='
25
+ - !ruby/object:Gem::Version
26
+ version: 0.10.0.rc4
27
+ - !ruby/object:Gem::Dependency
28
+ name: railties
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '4.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '4.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.11'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.11'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '3.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '3.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec-rails
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.4'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.4'
97
+ description:
98
+ email:
99
+ - p.spieker@duenos.de
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".gitignore"
105
+ - ".rspec"
106
+ - ".travis.yml"
107
+ - CODE_OF_CONDUCT.md
108
+ - Gemfile
109
+ - LICENSE.txt
110
+ - README.md
111
+ - Rakefile
112
+ - active_model_serializers-jsonapi_embedded_records_deserializer.gemspec
113
+ - bin/console
114
+ - bin/setup
115
+ - lib/active_model_serializers/jsonapi_embedded_records_deserializer.rb
116
+ - lib/active_model_serializers/jsonapi_embedded_records_deserializer/version.rb
117
+ homepage: https://github.com/spieker/active_model_serializers-jsonapi_embedded_records_deserializer
118
+ licenses:
119
+ - MIT
120
+ metadata: {}
121
+ post_install_message:
122
+ rdoc_options: []
123
+ require_paths:
124
+ - lib
125
+ required_ruby_version: !ruby/object:Gem::Requirement
126
+ requirements:
127
+ - - ">="
128
+ - !ruby/object:Gem::Version
129
+ version: '0'
130
+ required_rubygems_version: !ruby/object:Gem::Requirement
131
+ requirements:
132
+ - - ">="
133
+ - !ruby/object:Gem::Version
134
+ version: '0'
135
+ requirements: []
136
+ rubyforge_project:
137
+ rubygems_version: 2.4.8
138
+ signing_key:
139
+ specification_version: 4
140
+ summary: Deserializing embedded JSONAPI records into ActiveRecord nested attributes
141
+ (Not part of the JSONAPI spec yet!)
142
+ test_files: []
143
+ has_rdoc: