Initial commit.

beauby · beauby · commit aebdb55ccce2 · 2016-10-28T05:33:11.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+Gemfile.local
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,14 @@
+language: ruby
+sudo: false
+before_install:
+  - bundle update
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - 2.3.1
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec
diff --git a/README.md b/README.md
@@ -0,0 +1,30 @@
+# jsonapi-rails
+Rails integration for [jsonapi-rb](https://github.com/jsonapi-rb/jsonapi-rb).
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/jsonapi-rails.svg)](https://badge.fury.io/rb/jsonapi-rails)
+[![Build Status](https://secure.travis-ci.org/jsonapi-rb/rails.svg?branch=master)](http://travis-ci.org/jsonapi-rb/rails?branch=master)
+
+## 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
+
+## License
+
+jsonapi-rails is released under the [MIT License](http://www.opensource.org/licenses/MIT).
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec
diff --git a/VERSION b/VERSION
@@ -0,0 +1 @@
+0.1.1.beta1
diff --git a/jsonapi-rails.gemspec b/jsonapi-rails.gemspec
@@ -0,0 +1,25 @@
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jsonapi-rails'
+  spec.version       = version
+  spec.author        = ['L. Preston Sego III', 'Lucas Hosseini']
+  spec.email         = ['LPSego3+dev@gmail.com', 'lucas.hosseini@gmail.com']
+  spec.summary       = 'Rails plugin for (de)serialization of JSONAPI resources'
+  spec.description   = 'Efficiently build and consume JSONAPI documents.'
+  spec.homepage      = 'https://github.com/jsonapi-rb/rails'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['README.md', 'lib/**/*']
+  spec.require_path  = 'lib'
+
+  spec.add_dependency 'jsonapi-renderer', '0.1.1.beta2'
+  spec.add_dependency 'jsonapi-parser', '0.1.1.beta3'
+  spec.add_dependency 'jsonapi-serializable', '0.1.1.beta2'
+  spec.add_dependency 'jsonapi-deserializable', '0.1.1.beta3'
+
+  spec.add_development_dependency 'activerecord', '>=5'
+  spec.add_development_dependency 'sqlite3', '>= 1.3.12'
+  spec.add_development_dependency 'rake', '>=0.9'
+  spec.add_development_dependency 'rspec', '~>3.4'
+end
diff --git a/lib/generators/jsonapi/deserializable/USAGE b/lib/generators/jsonapi/deserializable/USAGE
@@ -0,0 +1,5 @@
+Description:
+    Generates a deserializable resource for the given model.
+
+Example:
+    `rails generate jsonapi:deserializable User`
diff --git a/lib/generators/jsonapi/deserializable/deserializable_generator.rb b/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
diff --git a/lib/generators/jsonapi/deserializable/templates/deserializable.rb.erb b/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 -%>
diff --git a/lib/generators/jsonapi/serializable/USAGE b/lib/generators/jsonapi/serializable/USAGE
@@ -0,0 +1,5 @@
+Description:
+    Generates a serializable resource for the given model.
+
+Example:
+    `rails generate jsonapi:serializable User`
diff --git a/lib/generators/jsonapi/serializable/serializable_generator.rb b/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
diff --git a/lib/generators/jsonapi/serializable/templates/serializable.rb.erb b/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 -%>
diff --git a/lib/jsonapi/rails.rb b/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'
diff --git a/lib/jsonapi/rails/deserializable/resource_extensions.rb b/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
diff --git a/lib/jsonapi/rails/parser.rb b/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
diff --git a/lib/jsonapi/rails/railtie.rb b/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
diff --git a/lib/jsonapi/rails/render.rb b/lib/jsonapi/rails/render.rb
diff --git a/lib/jsonapi/rails/serializable/model_extensions.rb b/lib/jsonapi/rails/serializable/model_extensions.rb

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+source 'https://rubygems.org'`
	`2`	`+`
	`3`	`+gemspec`