sideload_serializer 0.0.1.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb927cee853f64a4c4f329cd3f762a64d9e7c818
+  data.tar.gz: bfd5de20b520857e9a3d0eedf73e358ed2d99c58
+SHA512:
+  metadata.gz: 05f87ba01f4285e200ee7330092fd8116b0335a3c887516d6b1fe7dfc36f813da68cd6674142f24fdf15c930a049bf4441d00bb0d31d3595048ffd2fe20a8138
+  data.tar.gz: 570a90648054cf5a15e6dfe80184e3bb1bc066cca9d7386f9033a0e45e764a411f8aec3210d50da8499141c43011865f7a00184d72ab104dd408d6be7927bfed

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.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sideload_serializer.gemspec
+gemspec
+
+
+gem 'active_model_serializers', github: 'rails-api/active_model_serializers'
+# gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel Evans
+
+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,165 @@
+# SideloadSerializer
+
+This is an adapter for [Active Model Serializers](https://github.com/rails-api/active_model_serializers) >= 0.10 intended to give a sideload JSON style similar to AMS 0.8.* embed approach with some alterations to conform to the [Rocketmade](http://rocketmade.com) API Standard.
+
+It includes two forms of the adapter, the first serializes to the sideloaded format and the second alters all hash keys to camelCase.
+
+Sideloaded json is extremely useful for offline sync situations where data is being loaded into coredata or other local storage. It helps reduce reparsing and transfer size by ensuring that each object is represented exactly once.
+
+An authentication response from [Rockauth](https://github.com/rocketmade/rockauth) is used for the following examples.
+
+Underscore Example:
+
+```json
+{
+  "authentications": [
+    {
+      "id": 4,
+      "token": "<jwt>",
+      "token_id": "<jwt_id>",
+      "expiration": 1483647326,
+      "client_version": null,
+      "device_identifier": null,
+      "device_os": null,
+      "device_os_version": null,
+      "device_description": null,
+      "user_id": 3,
+      "provider_authentication_id": 1
+    }
+  ],
+  "users": [
+    {
+      "id": 3,
+      "email": null,
+      "first_name": null,
+      "last_name": null
+    }
+  ],
+  "provider_authentications": [
+    {
+      "id": 1,
+      "provider": "facebook",
+      "provider_user_id": "facebook_user_id"
+    }
+  ],
+  "meta": {
+    "primary_resource_collection": "authentications",
+    "primary_resource_id": 4
+  }
+}
+```
+
+Camelized Example:
+
+```json
+{
+  "authentications": [
+    {
+      "id": 8,
+      "token": "<jwt>",
+      "expiration": 1483647222,
+      "tokenId": "<jwt_id>",
+      "clientVersion": null,
+      "deviceIdentifier": null,
+      "deviceOs": null,
+      "deviceOsVersion": null,
+      "deviceDescription": null,
+      "userId": 5,
+      "providerAuthenticationId": 1
+    }
+  ],
+  "users": [
+    {
+      "id": 5,
+      "email": null,
+      "firstName": null,
+      "lastName": null
+    }
+  ],
+  "providerAuthentications": [
+    {
+      "id": 1,
+      "provider": "facebook",
+      "providerUserId": "facebook_user_id"
+    }
+  ],
+  "meta": {
+    "primaryResourceCollection": "authentications",
+    "primaryResourceId": 8
+  }
+}
+```
+
+The same response with the `json` adapter:
+
+```json
+{
+  "authentication": {
+    "id": 6,
+    "token": "<jwt>",
+    "token_id": "<jwt>",
+    "expiration": 1483647755,
+    "client_version": null,
+    "device_identifier": null,
+    "device_os": null,
+    "device_os_version": null,
+    "device_description": null,
+    "user": {
+      "id": 4,
+      "email": null,
+      "first_name": null,
+      "last_name": null
+    },
+    "provider_authentication": {
+      "id": 1,
+      "provider": "facebook",
+      "provider_user_id": "facebook_user_id"
+    }
+  }
+}
+
+```
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sideload_serializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sideload_serializer
+
+## Usage
+
+Add the following line to `$RAILS_ROOT/config/initializers/active_model_serializers`
+
+```
+ActiveModelSerializers.config.adapter = "sideload_serializer/adapter"
+```
+
+Or, to use the camelized keys form of the adapter:
+
+```
+ActiveModelSerializers.config.adapter = "sideload_serializer/camelized_adapter"
+```
+
+## 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/rocketmade/sideload_serializer.
+
+
+## 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 "sideload_serializer"
+
+# 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/sideload_serializer.rb

@@ -0,0 +1,8 @@
+require "sideload_serializer/version"
+
+module SideloadSerializer
+end
+
+# Active Model Serializers registers the adapter on subclassing, so eagerload
+require 'sideload_serializer/adapter'
+require 'sideload_serializer/camelized_adapter'

data/lib/sideload_serializer/adapter.rb

@@ -0,0 +1,110 @@
+require 'active_model_serializers'
+
+module SideloadSerializer
+  class Adapter < ActiveModel::Serializer::Adapter::Base
+    def initialize(serializer, options = {})
+      super
+      @include_tree = ActiveModel::Serializer::IncludeTree.from_include_args(options[:include] || '*')
+    end
+
+    def serializable_hash _options=nil
+      {}.tap do |document|
+        add_serializer_to_document serializer, document, Hash.new, @include_tree
+      end
+    end
+
+    def add_serializer_to_document serializer_instance, document, serialized_keys, include_tree
+      return unless serializer_instance && serializer_instance.object
+      if collection_serializer_given? serializer_instance
+        serializer_instance.each do |s|
+          add_serializer_to_document s, document, serialized_keys, include_tree
+        end
+
+      else
+        cache_key = serializer_instance.object.cache_key rescue serializer_instance.object.hash
+
+        return if serialized_keys.has_key? cache_key
+
+        attributes = cache_check serializer_instance do
+          serializer_instance.attributes
+        end
+
+        add_relationship_keys serializer_instance, attributes, include_tree
+
+        key = root serializer_instance
+
+        document[key] ||= []
+        document[key] << attributes
+
+        serialized_keys[cache_key] = true
+
+        serializer_instance.associations(include_tree).each do |association|
+          add_serializer_to_document association.serializer, document, serialized_keys, include_tree[association.key]
+        end
+      end
+
+      document
+    end
+
+    def root serializer_instance=serializer
+      serializer_instance.json_key.to_s.pluralize.to_sym
+    end
+
+    def meta
+      compiled_meta = {
+        primary_resource_collection: root
+      }
+
+      unless collection_serializer_given?
+        compiled_meta[:primary_resource_id] = resource_identifier_id
+      end
+
+      compiled_meta.merge(instance_options.fetch(:meta, Hash.new))
+    end
+
+    protected
+
+    def collection_serializer_given? serializer_instance=serializer
+      serializer_instance.respond_to? :each
+    end
+
+    def embed_key_for association
+      extension = '_id'
+      extension += 's' if collection_serializer_given? association.serializer
+      association_key = if association.options.has_key? :key
+                          association.key
+                        else
+                          association.name.to_s.singularize
+                        end
+
+      :"#{association_key}#{extension}" # this is hokey, refactor. Can we interrogate the serializer/association for this information?
+    end
+
+    def resource_identifier_id serializer_instance=serializer
+      if serializer_instance.respond_to?(:id)
+        serializer_instance.id
+      else
+        serializer_instance.object.id
+      end
+    end
+
+    def add_relationship_keys serializer_instance, attributes, include_tree
+      serializer_instance.associations(include_tree).each do |association|
+        attributes[embed_key_for(association)] = relationship_value_for association
+      end
+    end
+
+    def relationship_value_for association
+      return association.options[:virtual_value] if association.options[:virtual_value]
+      return unless association.serializer && association.serializer.object
+
+      if collection_serializer_given? association.serializer
+        association.serializer.map do |s|
+          resource_identifier_id s
+        end
+      else
+        resource_identifier_id association.serializer
+      end
+    end
+  end
+end

data/lib/sideload_serializer/camelized_adapter.rb

@@ -0,0 +1,50 @@
+require 'sideload_serializer/adapter'
+
+module SideloadSerializer
+  class CamelizedAdapter < Adapter
+    def self.deep_camelize_keys enumerable
+      if enumerable.is_a? Array
+        enumerable.each do |item|
+          deep_camelize_keys item if item.respond_to? :each
+        end
+      elsif
+        enumerable.keys.each do |key|
+          if key.is_a?(String) || key.is_a?(Symbol)
+            new_key = key.to_s.camelize(:lower)
+            new_key = new_key.to_sym if key.is_a? Symbol
+            if new_key != key
+              enumerable[new_key] = enumerable[key]
+              enumerable.delete key
+            end
+
+            if enumerable[new_key].respond_to? :each
+              deep_camelize_keys enumerable[new_key]
+            end
+          end
+        end
+      end
+
+      enumerable
+    end
+
+    def serializable_hash _options=nil
+      super.tap do |document|
+        self.class.deep_camelize_keys document
+      end
+    end
+
+    def meta
+      compiled_meta = {
+        primaryResourceCollection: root.to_s.camelize(:lower)
+      }
+
+      unless collection_serializer_given?
+        compiled_meta[:primaryResourceId] = resource_identifier_id
+      end
+
+      compiled_meta.merge!(self.class.deep_camelize_keys(instance_options.fetch(:meta, Hash.new).deep_dup))
+
+      compiled_meta
+    end
+  end
+end

data/lib/sideload_serializer/version.rb

@@ -0,0 +1,3 @@
+module SideloadSerializer
+  VERSION = "0.0.1.pre1"
+end

data/sideload_serializer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sideload_serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sideload_serializer"
+  spec.version       = SideloadSerializer::VERSION
+  spec.authors       = ["Daniel Evans"]
+  spec.email         = ["evans.daniel.n@gmail.com"]
+
+  spec.summary       = %q{A simple Sideloaded JSON Adapter for Active Model Serializers}
+  spec.homepage      = "https://github.com/rocketmade/sideload_serializer"
+  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"]
+
+  spec.add_dependency "active_model_serializers", ">= 0.10.0.rc3"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: sideload_serializer
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre1
+platform: ruby
+authors:
+- Daniel Evans
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-07 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.rc3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0.rc3
+- !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'
+description: 
+email:
+- evans.daniel.n@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sideload_serializer.rb
+- lib/sideload_serializer/adapter.rb
+- lib/sideload_serializer/camelized_adapter.rb
+- lib/sideload_serializer/version.rb
+- sideload_serializer.gemspec
+homepage: https://github.com/rocketmade/sideload_serializer
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A simple Sideloaded JSON Adapter for Active Model Serializers
+test_files: []