simple-json-api-serializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70a2dc4601aee95d0b8ca23f13996aa12f55d697
+  data.tar.gz: d9b52897b675d77b5b353195eea2f1bd1c610c33
+SHA512:
+  metadata.gz: 01e2a4136d074192f60bb7c54b0f159bec76ae83be357ff97cd2505a6385dec091b6cce68ce23b7a88ab376360d94a70b6fa5b797759e25439edfbb900fd6646
+  data.tar.gz: 983f533a18b6c30f28bf4ddc353e3ffc899d389582f60010610bcf610adcc2f1820470811e5f48dad70d376f878fb93e71d5b691db048487059a9434094c8c20

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple-json-api-serializer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    simple-json-api-serializer (0.1.0)
+      activesupport (~> 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simple-json-api-serializer!
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Marten Schilstra
+
+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,39 @@
+# Simple JsonApi::Serializer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/simple/json/api/serializer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple-json-api-serializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple-json-api-serializer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/martndemus/simple-json-api-serializer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple/json/api/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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/json_api/object_serializer_definition.rb

@@ -0,0 +1,50 @@
+require 'json_api/serializer'
+
+module JSONApi
+  class ObjectSerializerDefinition
+    class << self
+      def serialize(object)
+        Serializer.new.to_json(object, {
+          id_attribute:  id_attribute,
+          attributes:    attributes,
+          relationships: relationships
+        })
+      end
+
+      def inherited(specialization)
+        specialization.attributes(*attributes)
+        specialization.relationships(*relationships)
+        specialization.id_attribute(id_attribute)
+      end
+
+      def attributes(*attrs)
+        @attributes ||= []
+        @attributes |= attrs
+      end
+
+      def id_attribute(attr = @id_attribute)
+        @id_attribute = attr
+      end
+
+      def relationship(name, **config)
+        config[:name] = name
+        relationships(config)
+      end
+
+      def relationships(*configs)
+        @relationships ||= []
+        @relationships |= configs
+      end
+
+      def has_one(name, **config)
+        config[:to] = :one
+        relationship(name, config)
+      end
+
+      def has_many(name, **config)
+        config[:to] = :many
+        relationship(name, config)
+      end
+    end
+  end
+end

data/lib/json_api/relationship_serializer.rb

@@ -0,0 +1,66 @@
+require 'json_api/utils'
+
+module JSONApi
+  class RelationshipSerializer
+    def as_json(object, **options)
+      data =
+        if options[:to] == :many
+          ToManySerializer.new.data_for(object, options)
+        else
+          ToOneSerializer.new.data_for(object, options)
+        end
+
+      if data.nil? || data == []
+        nil
+      else
+        { data: data }
+      end
+    end
+
+    protected
+
+    def type_for(options)
+      options[:type] || options[:name]
+    end
+
+    def key_for(options)
+      options[:name].to_s.singularize
+    end
+
+    def relationship_for(object, **options)
+      object.send(options[:key] || key_for(options))
+    end
+
+    def resource_identifier_for(type_name, id)
+      return nil if id.nil? || id == ""
+
+      {
+        type: Utils.canonicalize_type_name(type_name),
+        id:   Utils.canonicalize_id(id)
+      }
+    end
+
+    class ToManySerializer < RelationshipSerializer
+      def key_for(**options)
+        "#{super}_ids"
+      end
+
+      def data_for(object, options)
+        ids = relationship_for(object, options)
+        ids.map { |id| resource_identifier_for(type_for(options), id) }
+           .compact
+      end
+    end
+
+    class ToOneSerializer < RelationshipSerializer
+      def key_for(**options)
+        "#{super}_id"
+      end
+
+      def data_for(object, options)
+        id = relationship_for(object, options)
+        resource_identifier_for(type_for(options), id)
+      end
+    end
+  end
+end

data/lib/json_api/serializer.rb

@@ -0,0 +1,76 @@
+require 'active_support/json'
+require 'json_api/utils'
+require 'json_api/relationship_serializer'
+
+
+module JSONApi
+  class Serializer
+    def to_json(object, **options)
+      ActiveSupport::JSON.encode({ data: data_for(object, **options) })
+    end
+
+    private
+
+    def data_for(object, **options)
+      if object.is_a? Array
+        object.map { |o| resource_object_for(o, options) }
+      else
+        resource_object_for(object, options)
+      end
+    end
+
+    def resource_object_for(object, **options)
+      result = resource_identifier_for(object, options)
+
+      if options[:attributes] && options[:attributes].any?
+        result[:attributes] = attributes_for(object, options)
+      end
+
+      if options[:relationships] && options[:relationships].any?
+        result[:relationships] = relationships_for(object, options)
+      end
+
+      result
+    end
+
+    def resource_identifier_for(object, **options)
+      {
+        type: type_for(object),
+        id:   id_for(object, options)
+      }
+    end
+
+    def relationships_for(object, options)
+      relationship_serializer = RelationshipSerializer.new
+      options[:relationships].each_with_object({}) do |relationship, hash|
+        relationship_key = Utils.canonicalize_attribute_name(relationship[:name])
+        data = relationship_serializer.as_json(object, relationship)
+        hash[relationship_key] = data unless data.nil?
+      end
+    end
+
+    def attributes_for(object, **options)
+      options[:attributes].each_with_object({}) do |attribute, hash|
+        attribute_key = Utils.canonicalize_attribute_name(attribute)
+        hash[attribute_key] = object.send(attribute)
+      end
+    end
+
+    def id_for(object, **options)
+      id_attribute = options[:id_attribute] || :id
+      canonicalize_id(object.send(id_attribute))
+    end
+
+    def type_for(object)
+      canonicalize_type_name(object.class.name)
+    end
+
+    def canonicalize_id(id)
+      Utils.canonicalize_id(id)
+    end
+
+    def canonicalize_type_name(type_name)
+      Utils.canonicalize_type_name(type_name)
+    end
+  end
+end

data/lib/json_api/utils.rb

@@ -0,0 +1,24 @@
+require 'active_support/all'
+
+module JSONApi
+  module Utils
+    class << self
+      def canonicalize_id(id)
+        id.nil? ? '' : id.to_s
+      end
+
+      def canonicalize_type_name(type_name)
+        type_name.to_s
+          .demodulize
+          .underscore
+          .pluralize
+          .dasherize
+      end
+
+      def canonicalize_attribute_name(attribute_name)
+        attribute_name.to_s
+          .dasherize
+      end
+    end
+  end
+end

data/lib/simple/json/api/serializer/version.rb

@@ -0,0 +1,9 @@
+module Simple
+  module Json
+    module Api
+      module Serializer
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/lib/simple/json/api/serializer.rb

@@ -0,0 +1,11 @@
+require "simple/json/api/serializer/version"
+
+module Simple
+  module Json
+    module Api
+      module Serializer
+        # Your code goes here...
+      end
+    end
+  end
+end

data/simple-json-api-serializer.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple-json-api-serializer"
+  spec.version       = JSONApi::VERSION
+  spec.authors       = ["Marten Schilstra"]
+  spec.email         = ["mail@martenschilstra.nl"]
+
+  spec.summary       = %q{An extremely simple JSON Api serializer}
+  spec.description   = %q{
+    It supports just plain Ruby objects. This serializer does not target any
+    specific framework like ActiveRecord or anything like that.
+
+    Does not (yet) have support for links and sideloading.
+  }
+  spec.homepage      = "https://github.com/martndemus/simple-json-api-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 "activesupport", "~> 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: simple-json-api-serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marten Schilstra
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-18 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: "\n    It supports just plain Ruby objects. This serializer does not
+  target any\n    specific framework like ActiveRecord or anything like that.\n\n
+  \   Does not (yet) have support for links and sideloading.\n  "
+email:
+- mail@martenschilstra.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/json_api/object_serializer_definition.rb
+- lib/json_api/relationship_serializer.rb
+- lib/json_api/serializer.rb
+- lib/json_api/utils.rb
+- lib/simple/json/api/serializer.rb
+- lib/simple/json/api/serializer/version.rb
+- simple-json-api-serializer.gemspec
+homepage: https://github.com/martndemus/simple-json-api-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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: An extremely simple JSON Api serializer
+test_files: []