fast_jsonapi 1.0.16

data/README.rdoc

@@ -0,0 +1,18 @@
+= fast_jsonapi
+
+Description goes here.
+
+== Contributing to fast_jsonapi
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2017 Shishir Kakaraddi. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "fast_jsonapi"
+  gem.homepage = "http://github.com/Netflix/fast_jsonapi"
+  gem.license = "Apache-2.0"
+  gem.summary = %Q{fast JSON API(jsonapi.org) serializer}
+  gem.description = %Q{JSON API(jsonapi.org) serializer that works with rails and can be used to serialize any kind of ruby objects}
+  gem.email = ""
+  gem.authors = ["Shishir Kakaraddi", "Srinivas Raghunathan", "Adam Gross"]
+
+
+  if gem.respond_to?(:metadata)
+    gem.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fast_jsonapi #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.16

data/docs/collection_serializer_output.json

@@ -0,0 +1,35 @@
+{
+  "data": [
+    {
+      "id": "232",
+      "type": "movie",
+      "attributes": {
+        "name": "test movie",
+        "year": null
+      },
+      "relationships": {
+        "actors": {
+          "data": [
+            {
+              "id": "1",
+              "type": "actor"
+            },
+            {
+              "id": "2",
+              "type": "actor"
+            }
+          ]
+        },
+        "owner": {
+          "data": {
+            "id": "3",
+            "type": "user"
+          }
+        }
+      }
+    }
+  ],
+  "meta": {
+    "total": 2
+  }
+}

data/docs/object_serializer.json

@@ -0,0 +1,30 @@
+{
+  "data": {
+    "id": "232",
+    "type": "movie",
+    "attributes": {
+      "name": "test movie",
+      "year": null
+    },
+    "relationships": {
+      "actors": {
+        "data": [
+          {
+            "id": "1",
+            "type": "actor"
+          },
+          {
+            "id": "2",
+            "type": "actor"
+          }
+        ]
+      },
+      "owner": {
+        "data": {
+          "id": "3",
+          "type": "user"
+        }
+      }
+    }
+  }
+}

data/fast_jsonapi.gemspec

@@ -0,0 +1,108 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: fast_jsonapi 1.0.16 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "fast_jsonapi"
+  s.version = "1.0.16"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.metadata = { "allowed_push_host" => "https://rubygems.org" } if s.respond_to? :metadata=
+  s.require_paths = ["lib"]
+  s.authors = ["Shishir Kakaraddi", "Srinivas Raghunathan", "Adam Gross"]
+  s.date = "2018-02-01"
+  s.description = "JSON API(jsonapi.org) serializer that works with rails and can be used to serialize any kind of ruby objects"
+  s.email = ""
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "docs/collection_serializer_output.json",
+    "docs/object_serializer.json",
+    "fast_jsonapi.gemspec",
+    "lib/extensions/has_one.rb",
+    "lib/fast_jsonapi.rb",
+    "lib/fast_jsonapi/object_serializer.rb",
+    "lib/fast_jsonapi/serialization_core.rb",
+    "spec/lib/extensions/active_record_spec.rb",
+    "spec/lib/object_serializer_caching_spec.rb",
+    "spec/lib/object_serializer_class_methods_spec.rb",
+    "spec/lib/object_serializer_hyphen_spec.rb",
+    "spec/lib/object_serializer_performance_spec.rb",
+    "spec/lib/object_serializer_spec.rb",
+    "spec/lib/object_serializer_struct_spec.rb",
+    "spec/lib/serialization_core_spec.rb",
+    "spec/shared/contexts/ams_context.rb",
+    "spec/shared/contexts/movie_context.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/Netflix/fast_jsonapi"
+  s.licenses = ["Apache-2.0"]
+  s.rubygems_version = "2.5.1"
+  s.summary = "fast JSON API(jsonapi.org) serializer"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 5.0"])
+      s.add_runtime_dependency(%q<multi_json>, ["~> 1.12"])
+      s.add_runtime_dependency(%q<oj>, ["~> 3.3"])
+      s.add_runtime_dependency(%q<skylight>, ["~> 1.3"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 5.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.5.0"])
+      s.add_development_dependency(%q<rspec-benchmark>, ["~> 0.3.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<juwelier>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<byebug>, [">= 0"])
+      s.add_development_dependency(%q<active_model_serializers>, ["~> 0.10.4"])
+      s.add_development_dependency(%q<sqlite3>, ["~> 1.3"])
+    else
+      s.add_dependency(%q<activesupport>, ["~> 5.0"])
+      s.add_dependency(%q<multi_json>, ["~> 1.12"])
+      s.add_dependency(%q<oj>, ["~> 3.3"])
+      s.add_dependency(%q<skylight>, ["~> 1.3"])
+      s.add_dependency(%q<activerecord>, ["~> 5.0"])
+      s.add_dependency(%q<rspec>, ["~> 3.5.0"])
+      s.add_dependency(%q<rspec-benchmark>, ["~> 0.3.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<juwelier>, ["~> 2.1.0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<byebug>, [">= 0"])
+      s.add_dependency(%q<active_model_serializers>, ["~> 0.10.4"])
+      s.add_dependency(%q<sqlite3>, ["~> 1.3"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["~> 5.0"])
+    s.add_dependency(%q<multi_json>, ["~> 1.12"])
+    s.add_dependency(%q<oj>, ["~> 3.3"])
+    s.add_dependency(%q<skylight>, ["~> 1.3"])
+    s.add_dependency(%q<activerecord>, ["~> 5.0"])
+    s.add_dependency(%q<rspec>, ["~> 3.5.0"])
+    s.add_dependency(%q<rspec-benchmark>, ["~> 0.3.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<juwelier>, ["~> 2.1.0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<byebug>, [">= 0"])
+    s.add_dependency(%q<active_model_serializers>, ["~> 0.10.4"])
+    s.add_dependency(%q<sqlite3>, ["~> 1.3"])
+  end
+end
+

data/lib/extensions/has_one.rb

@@ -0,0 +1,16 @@
+require 'active_record'
+
+::ActiveRecord::Associations::Builder::HasOne.class_eval do
+  # Based on
+  # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/associations/builder/collection_association.rb#L50
+  # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/associations/builder/singular_association.rb#L11
+  def self.define_accessors(mixin, reflection)
+    super
+    name = reflection.name
+    mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
+      def #{name.to_s}_id
+        association(:#{name}).reader.id
+      end
+    CODE
+  end
+end

data/lib/fast_jsonapi.rb

@@ -0,0 +1,4 @@
+module FastJsonapi
+  require 'fast_jsonapi/object_serializer'
+  require 'extensions/has_one'
+end

data/lib/fast_jsonapi/object_serializer.rb

@@ -0,0 +1,199 @@
+require 'active_support/core_ext/object'
+require 'active_support/concern'
+require 'active_support/inflector'
+require 'oj'
+require 'multi_json'
+require 'fast_jsonapi/serialization_core'
+require 'skylight'
+
+module FastJsonapi
+  module ObjectSerializer
+    extend ActiveSupport::Concern
+    include SerializationCore
+
+    # Skylight integration
+    # To remove Skylight
+    # Remove the included do block
+    # Remove the Gemfile entry
+    included do
+      include Skylight::Helpers
+
+      instrument_method :serializable_hash
+      instrument_method :to_json
+
+      # Set record_type based on the name of the serializer class
+      set_type default_record_type if default_record_type
+    end
+
+    def initialize(resource, options = {})
+      if options.present?
+        @meta_tags = options[:meta]
+        @includes = options[:include].delete_if(&:blank?) if options[:include].present?
+        self.class.has_permitted_includes(@includes) if @includes.present?
+        @known_included_objects = {} # keep track of inc objects that have already been serialized
+      end
+      # @records if enumerables like Array, ActiveRecord::Relation but if Struct just make it a @record
+      if resource.respond_to?(:each) && !resource.respond_to?(:each_pair)
+        @records = resource
+      else
+        @record = resource
+      end
+    end
+
+    def serializable_hash
+      serializable_hash = { data: nil }
+      serializable_hash[:meta] = @meta_tags if @meta_tags.present?
+      return hash_for_one_record(serializable_hash) if @record
+      return hash_for_multiple_records(serializable_hash) if @records
+      serializable_hash
+    end
+
+    def hash_for_one_record(serializable_hash)
+      serializable_hash[:data] = self.class.record_hash(@record)
+      serializable_hash[:included] = self.class.get_included_records(@record, @includes, @known_included_objects) if @includes.present?
+      serializable_hash
+    end
+
+    def hash_for_multiple_records(serializable_hash)
+      data = []
+      included = []
+      @records.each do |record|
+        data << self.class.record_hash(record)
+        included.concat self.class.get_included_records(record, @includes, @known_included_objects) if @includes.present?
+      end
+      serializable_hash[:data] = data
+      serializable_hash[:included] = included if @includes.present?
+      serializable_hash
+    end
+
+    def serialized_json
+      self.class.to_json(serializable_hash)
+    end
+
+    class_methods do
+      def use_hyphen
+        @hyphenated = true
+      end
+
+      def set_type(type_name)
+        self.record_type = type_name
+        if @hyphenated
+          self.record_type = type_name.to_s.dasherize.to_sym
+        end
+      end
+
+      def default_record_type
+        if self.name.end_with?('Serializer')
+          class_name = self.name.demodulize
+          range_end = class_name.rindex('Serializer')
+          class_name[0...range_end].underscore.to_sym
+        end
+      end
+
+      def cache_options(cache_options)
+        self.cached = cache_options[:enabled] || false
+        self.cache_length = cache_options[:cache_length] || 5.minutes
+      end
+
+      def attributes(*attributes_list)
+        attributes_list = attributes_list.first if attributes_list.first.class.is_a?(Array)
+        self.attributes_to_serialize = {} if self.attributes_to_serialize.nil?
+        attributes_list.each do |attr_name|
+          method_name = attr_name
+          key = method_name
+          if @hyphenated
+            key = attr_name.to_s.dasherize.to_sym
+          end
+          attributes_to_serialize[key] = method_name
+        end
+      end
+
+      def add_relationship(name, relationship)
+        self.relationships_to_serialize = {} if relationships_to_serialize.nil?
+        self.cachable_relationships_to_serialize = {} if cachable_relationships_to_serialize.nil?
+        self.uncachable_relationships_to_serialize = {} if uncachable_relationships_to_serialize.nil?
+
+        if !relationship[:cached]
+          self.uncachable_relationships_to_serialize[name] = relationship
+        else
+          self.cachable_relationships_to_serialize[name] = relationship
+        end
+        self.relationships_to_serialize[name] = relationship
+     end
+
+      def has_many(relationship_name, options = {})
+        singular_name = relationship_name.to_s.singularize
+        record_type = options[:record_type] || singular_name.to_sym
+        name = relationship_name.to_sym
+        key = options[:key] || name
+        if @hyphenated
+          key = options[:key] || relationship_name.to_s.dasherize.to_sym
+          record_type = options[:record_type] || singular_name.to_s.dasherize.to_sym
+        end
+        serializer_key = options[:serializer] || record_type
+        relationship = {
+          key: key,
+          name: name,
+          id_method_name: options[:id_method_name] || (singular_name + '_ids').to_sym,
+          record_type: record_type,
+          object_method_name: options[:object_method_name] || name,
+          serializer: compute_serializer_name(serializer_key),
+          relationship_type: :has_many,
+          cached: options[:cached] || false
+        }
+        add_relationship(name, relationship)
+      end
+
+      def belongs_to(relationship_name, options = {})
+        name = relationship_name.to_sym
+        key = options[:key] || name
+        record_type = options[:record_type] || name
+        serializer_key = options[:serializer] || record_type
+        if @hyphenated
+          key = options[:key] || relationship_name.to_s.dasherize.to_sym
+          record_type = options[:record_type] || relationship_name.to_s.dasherize.to_sym
+        end
+        relationship = {
+          key: key,
+          name: name,
+          id_method_name: options[:id_method_name] || (relationship_name.to_s + '_id').to_sym,
+          record_type: record_type,
+          object_method_name: options[:object_method_name] || name,
+          serializer: compute_serializer_name(serializer_key),
+          relationship_type: :belongs_to,
+          cached: options[:cached] || true
+        }
+        add_relationship(name, relationship)
+      end
+
+      def has_one(relationship_name, options = {})
+        name = relationship_name.to_sym
+        key = options[:key] || name
+        record_type = options[:record_type] || name
+        serializer_key = options[:serializer] || record_type
+        if @hyphenated
+          key = options[:key] || relationship_name.to_s.dasherize.to_sym
+          record_type = options[:record_type] || relationship_name.to_s.dasherize.to_sym
+        end
+        relationship = {
+          key: key,
+          name: name,
+          id_method_name: options[:id_method_name] || (relationship_name.to_s + '_id').to_sym,
+          record_type: record_type,
+          object_method_name: options[:object_method_name] || name,
+          serializer: compute_serializer_name(serializer_key),
+          relationship_type: :has_one,
+          cached: options[:cached] || false
+        }
+        add_relationship(name, relationship)
+      end
+
+      def compute_serializer_name(serializer_key)
+        namespace = self.name.gsub(/()?\w+Serializer$/, '')
+        serializer_name = serializer_key.to_s.classify + 'Serializer'
+        return (namespace + serializer_name).to_sym if namespace.present?
+        (serializer_key.to_s.classify + 'Serializer').to_sym
+      end
+    end
+  end
+end