jsonapi-rails 0.1.1.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 149fb06216ef18af6baa06e71acca5d6fa7cbeda
+  data.tar.gz: b83bbdc7d9d5739a7361eb294b28b1b1ff53a8d2
+SHA512:
+  metadata.gz: 785524db1f37f2b08fb6f2c96d1811f8ba5364dfc7ae92a3d1b47c211a44f88fc4ab85575e70bbc2fd0c56a640f8a1fa199adea2debff6a07b591370df1078df
+  data.tar.gz: 4672480284c03e809ecbb527aa8cad84593ef358e936182a1c3ae17aaea19ddad0ad27ed5f6ba817b6d52791cb11099d4523ff8cb37bca3621cd2657fd4b80d4

data/README.md

@@ -0,0 +1,37 @@
+# jsonapi-rails
+Rails plugin for building/consuming [JSON API](http://jsonapi.org) documents.
+
+## Installation
+
+Add the following to your application's Gemfile:
+```ruby
+gem 'jsonapi-rails'
+```
+And then execute:
+```
+$ bundle
+```
+Or install it manually as:
+```
+$ gem install jsonapi-rails
+```
+
+## Usage
+
+TODO
+
+## Contributing
+
+1. Fork the [official repository](https://github.com/beauby/jsonapi-rails).
+2. Make your changes in a topic branch.
+3. Send a pull request.
+
+Notes:
+
+* Contributions without tests won't be accepted.
+* Please don't update the Gem version.
+
+## License
+
+It is free software, and may be redistributed under the terms specified in the
+[LICENSE](LICENSE) file.

data/lib/generators/jsonapi/deserializable/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Generates a deserializable resource for the given model.
+
+Example:
+    `rails generate jsonapi:deserializable User`

data/lib/generators/jsonapi/deserializable/deserializable_generator.rb

@@ -0,0 +1,55 @@
+module Jsonapi
+  class DeserializableGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    # TODO(beauby): Implement generator-level whitelisting.
+    # TODO(beauby): Implement versioning.
+
+    def copy_deserializable_file
+      template 'deserializable.rb.erb',
+               File.join('app/deserializable', class_path,
+                         "deserializable_#{file_name}.rb")
+    end
+
+    private
+
+    def model_klass
+      # TODO(beauby): Ensure the model class exists.
+      class_name.safe_constantize
+    end
+
+    def attr_names
+      attrs = model_klass.new.attribute_names - %w(id created_at updated_at)
+      fk_attrs = model_klass.reflect_on_all_associations(:belongs_to)
+                            .map(&:foreign_key)
+      attrs - fk_attrs
+    end
+
+    def has_one_rels
+      has_one = model_klass.reflect_on_all_associations(:has_one)
+      belongs_to = model_klass.reflect_on_all_associations(:belongs_to)
+
+      has_one + belongs_to
+    end
+
+    def has_one_id_field_name(rel_name)
+      "#{rel_name}_id"
+    end
+
+    def has_one_type_field_name(rel_name)
+      "#{rel_name}_type"
+    end
+
+    def has_many_rels
+      model_klass.reflect_on_all_associations(:has_many)
+    end
+
+    def has_many_id_field_name(rel_name)
+      "#{rel_name.to_s.singularize}_ids"
+    end
+
+    def has_many_type_field_name(rel_name)
+      "#{rel_name.to_s.singularize}_types"
+    end
+  end
+end

data/lib/generators/jsonapi/deserializable/templates/deserializable.rb.erb

@@ -0,0 +1,34 @@
+<% module_namespacing do -%>
+class Deserializable<%= class_name %> < JSONAPI::Deserializable::Resource
+  id
+
+<% attr_names.each do |attr| -%>
+  attribute :<%= attr %>
+<% end -%>
+
+<% has_one_rels.each do |reflection| -%>
+  has_one :<%= reflection.name %> do
+    field :<%= has_one_id_field_name(reflection.name) %> do |rel|
+      rel['data'] && rel['data']['id']
+    end
+<% if reflection.polymorphic? -%>
+    field :<%= has_one_type_field_name(reflection.name) %> do
+      rel['data'] && rel['data']['type']
+    end
+<% end -%>
+  end
+<% end -%>
+<% has_many_rels.each do |reflection| -%>
+  has_many :<%= reflection.name %> do
+    field :<%= has_many_id_field_name(reflection.name) %> do |rel|
+      rel['data'].map { |ri| ri['id'] }
+    end
+<% if reflection.polymorphic? -%>
+    field :<%= has_one_type_field_name(reflection.name) %> do
+      rel['data'].map { |ri| ri['type'] }
+    end
+<% end -%>
+  end
+<% end -%>
+end
+<% end -%>

data/lib/generators/jsonapi/deserializable/templates/serializable.rb

@@ -0,0 +1 @@
+# Blah blah

data/lib/generators/jsonapi/deserializable/templates/serializable.rb.erb

@@ -0,0 +1,34 @@
+<% module_namespacing do -%>
+class Deserializable<%= class_name %> < JSONAPI::Deserializable::Model
+  id
+
+<% attr_names.each do |attr| -%>
+  attribute :<%= attr %>
+<% end -%>
+
+<% has_one_rel_names.each do |name, reflection| -%>
+  has_one :<%= name %> do
+    field :<%= has_one_id_field_name(name) %> do |rel|
+      rel['data'] && rel['data']['id']
+    end
+<% if reflection.polymorphic? -%>
+    field :<%= has_one_type_field_name(name) %> do
+      rel['data'] && rel['data']['type']
+    end
+<% end -%>
+  end
+<% end -%>
+<% has_many_rel_names.each do |rel| -%>
+  has_many :<%= rel %> do
+    field :<%= has_many_id_field_name(name) %> do |rel|
+      rel['data'].map { |ri| ri['id'] }
+    end
+<% if reflection.polymorphic? -%>
+    field :<%= has_one_type_field_name(name) %> do
+      rel['data'].map { |ri| ri['type'] }
+    end
+<% end -%>
+  end
+<% end -%>
+end
+<% end -%>

data/lib/generators/jsonapi/serializable/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Generates a serializable resource for the given model.
+
+Example:
+    `rails generate jsonapi:serializable User`

data/lib/generators/jsonapi/serializable/serializable_generator.rb

@@ -0,0 +1,41 @@
+module Jsonapi
+  class SerializableGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    # TODO(beauby): Implement generator-level whitelisting.
+    # TODO(beauby): Implement versioning.
+
+    def copy_serializable_file
+      template 'serializable.rb.erb',
+               File.join('app/serializable', class_path,
+                         "serializable_#{file_name}.rb")
+    end
+
+    private
+
+    def model_klass
+      # TODO(beauby): Ensure the model class exists.
+      class_name.safe_constantize
+    end
+
+    def type
+      model_klass.name.underscore.pluralize
+    end
+
+    def attr_names
+      attrs = model_klass.new.attribute_names - ['id']
+      fk_attrs = model_klass.reflect_on_all_associations(:belongs_to)
+                 .map(&:foreign_key)
+      attrs - fk_attrs
+    end
+
+    def has_one_rel_names
+      model_klass.reflect_on_all_associations(:has_one).map(&:name) +
+        model_klass.reflect_on_all_associations(:belongs_to).map(&:name)
+    end
+
+    def has_many_rel_names
+      model_klass.reflect_on_all_associations(:has_many).map(&:name)
+    end
+  end
+end

data/lib/generators/jsonapi/serializable/templates/serializable.rb

@@ -0,0 +1,3 @@
+<% module_namespacing do -%>
+                           <%
+# Blah blah

data/lib/generators/jsonapi/serializable/templates/serializable.rb.erb

@@ -0,0 +1,16 @@
+<% module_namespacing do -%>
+class Serializable<%= class_name %> < JSONAPI::Serializable::Model
+  type '<%= type %>'
+
+<% attr_names.each do |attr| -%>
+  attribute :<%= attr %>
+<% end -%>
+
+<% has_one_rel_names.each do |rel| -%>
+  has_one :<%= rel %>
+<% end -%>
+<% has_many_rel_names.each do |rel| -%>
+  has_many :<%= rel %>
+<% end -%>
+end
+<% end -%>

data/lib/generators/serializable_generator.rb

@@ -0,0 +1,5 @@
+class SerializableGenerator < Rails::Generator::Base
+  def create_serializable_file
+    create_file
+  end
+end

data/lib/jsonapi/rails.rb

@@ -0,0 +1,10 @@
+require 'jsonapi/parser'
+require 'jsonapi/renderer'
+
+require 'jsonapi/deserializable'
+require 'jsonapi/serializable'
+
+require 'jsonapi/rails/serializable/model_extensions'
+require 'jsonapi/rails/deserializable/resource_extensions'
+
+require 'jsonapi/rails/railtie'

data/lib/jsonapi/rails/deserializable/model_extensions.rb

@@ -0,0 +1,20 @@
+require 'jsonapi/deserializable/model'
+
+module JSONAPI
+  module Rails
+    module Deserializable
+      module ModelExtensions
+        def initialize(params = {})
+          params[:url_helper] ||= ::Rails.application.routes.url_helpers
+          super(params)
+        end
+      end
+    end
+  end
+
+  module Serializable
+    class Model
+      prepend JSONAPI::Rails::Serializable::ModelExtensions
+    end
+  end
+end

data/lib/jsonapi/rails/deserializable/resource_extensions.rb

@@ -0,0 +1,27 @@
+require 'jsonapi/deserializable/resource'
+
+module JSONAPI
+  module Rails
+    module Deserializable
+      module ResourceExtensions
+        def deserialize_has_one_rel!(rel, &block)
+          id = rel['data'] && rel['data']['id']
+          type = rel['data'] && rel['data']['type'].singularize.camelize
+          instance_exec(rel, id, type, &block)
+        end
+
+        def deserialize_has_many_rel!(rel, &block)
+          ids = rel['data'].map { |ri| ri['id'] }
+          types = rel['data'].map { |ri| ri['type'].singularize.camelize }
+          instance_exec(rel, ids, types, &block)
+        end
+      end
+    end
+  end
+
+  module Deserializable
+    class Resource
+      prepend JSONAPI::Rails::Deserializable::ResourceExtensions
+    end
+  end
+end

data/lib/jsonapi/rails/parser.rb

@@ -0,0 +1,16 @@
+require 'jsonapi/parser'
+
+module JSONAPI
+  module Rails
+    module_function
+
+    def parser
+      lambda do |body|
+        data = JSON.parse(body)
+        JSONAPI.parse_resource!(body)
+        data = { _json: data } unless data.is_a?(Hash)
+        data.with_indifferent_access
+      end
+    end
+  end
+end

data/lib/jsonapi/rails/railtie.rb

@@ -0,0 +1,38 @@
+require 'rails/railtie'
+require 'action_controller'
+require 'action_controller/railtie'
+
+require 'jsonapi/rails/parser'
+require 'jsonapi/rails/render'
+
+module JSONAPI
+  module Rails
+    class Railtie < ::Rails::Railtie
+      MEDIA_TYPE = 'application/vnd.api+json'.freeze
+      HEADERS = {
+        response: { 'CONTENT_TYPE'.freeze => MEDIA_TYPE },
+        request:  { 'ACCEPT'.freeze => MEDIA_TYPE }
+      }.freeze
+      PARSER = JSONAPI::Rails.parser
+
+      initializer 'JSONAPI::Rails.initialize' do
+        Mime::Type.register MEDIA_TYPE, :jsonapi
+        if ::Rails::VERSION::MAJOR >= 5
+          ActionDispatch::Request.parameter_parsers[:jsonapi] = PARSER
+        else
+          ActionDispatch::ParamsParser::DEFAULT_PARSERS[Mime[:jsonapi]] = PARSER
+        end
+        ActionController::Renderers.add :jsonapi do |json, options|
+          unless json.is_a?(String)
+            json = JSONAPI::Rails.render(json, options)
+                                 .to_json(options)
+          end
+          self.content_type ||= Mime[:jsonapi]
+          self.response_body = json
+        end
+
+        # TODO(beauby): Add renderer for `jsonapi_errors`.
+      end
+    end
+  end
+end

data/lib/jsonapi/rails/render.rb

@@ -0,0 +1,33 @@
+require 'jsonapi/renderer'
+require 'jsonapi/serializable/model'
+
+module JSONAPI
+  module Rails
+    module_function
+
+    def render(resources, options)
+      unless resources.respond_to?(:jsonapi_type)
+        resources = serializable_resources_for(resources)
+      end
+      JSONAPI::Renderer.new(resources, options).as_json
+    end
+
+    def serializable_resources_for(resources)
+      if resources.respond_to?(:each)
+        resources.map { |r| serializable_model_for(r) }
+      else
+        serializable_model_for(resources)
+      end
+    end
+
+    def serializable_model_for(model)
+      serializable_klass_for(model).new(model: model)
+    end
+
+    def serializable_klass_for(model)
+      # TODO(beauby): Move resource inference on class level in
+      #   jsonapi-serializable.
+      JSONAPI::Serializable::Model.new.resource_klass_for(model.class)
+    end
+  end
+end

data/lib/jsonapi/rails/serializable/model_extensions.rb

@@ -0,0 +1,20 @@
+require 'jsonapi/serializable/model'
+
+module JSONAPI
+  module Rails
+    module Serializable
+      module ModelExtensions
+        def initialize(params = {})
+          params[:url_helpers] ||= ::Rails.application.routes.url_helpers
+          super(params)
+        end
+      end
+    end
+  end
+
+  module Serializable
+    class Model
+      prepend JSONAPI::Rails::Serializable::ModelExtensions
+    end
+  end
+end

data/lib/jsonapi/rails/version.rb

@@ -0,0 +1,5 @@
+module JSONAPI
+  module Rails
+    VERSION = '0.1.0'
+  end
+end

data/lib/tasks/jsonapi/rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :jsonapi_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.1.beta1
+platform: ruby
+authors:
+- L. Preston Sego III
+- Lucas Hosseini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonapi-renderer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta2
+- !ruby/object:Gem::Dependency
+  name: jsonapi-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta3
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta2
+- !ruby/object:Gem::Dependency
+  name: jsonapi-deserializable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta3
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.12
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Efficiently build and consume JSONAPI documents.
+email:
+- LPSego3+dev@gmail.com
+- lucas.hosseini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/generators/jsonapi/deserializable/USAGE
+- lib/generators/jsonapi/deserializable/deserializable_generator.rb
+- lib/generators/jsonapi/deserializable/serializable_generator.rb
+- lib/generators/jsonapi/deserializable/templates/deserializable.rb.erb
+- lib/generators/jsonapi/deserializable/templates/serializable.rb
+- lib/generators/jsonapi/deserializable/templates/serializable.rb.erb
+- lib/generators/jsonapi/serializable/USAGE
+- lib/generators/jsonapi/serializable/serializable_generator.rb
+- lib/generators/jsonapi/serializable/templates/serializable.rb
+- lib/generators/jsonapi/serializable/templates/serializable.rb.erb
+- lib/generators/serializable_generator.rb
+- lib/jsonapi/rails.rb
+- lib/jsonapi/rails/deserializable/model_extensions.rb
+- lib/jsonapi/rails/deserializable/resource_extensions.rb
+- lib/jsonapi/rails/parser.rb
+- lib/jsonapi/rails/railtie.rb
+- lib/jsonapi/rails/render.rb
+- lib/jsonapi/rails/serializable/model_extensions.rb
+- lib/jsonapi/rails/version.rb
+- lib/tasks/jsonapi/rails_tasks.rake
+homepage: https://github.com/beauby/jsonapi-rails
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rails plugin for (de)serialization of JSONAPI resources
+test_files: []