dry_crud_jsonapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1490f7eb09162ab497f07102570cb567d8cc78a65cadef8355ec15035ec4ed9c
+  data.tar.gz: 8b276f30b7e1d35b7beea7b45e5b2f0a948dd840c5666856df8830b463fac9d0
+SHA512:
+  metadata.gz: 3a0fb63797bc84039904c6746beac40d3d45442c111b8315e3fc4c09db2576fb4545e8a95ff5ff9e49063dcf20617bd2d021c7404b764263a4b4789fa5fe4f0e
+  data.tar.gz: 0cfc9a0403b4f8e635b064a1d1901bd35dd009d33a2f20caab7121af86ddd38c81b5608dde3d6f819deca8651b389c65b077ac4a6ffe3b4bf5791597f8e744f7

data/README.md

@@ -0,0 +1,39 @@
+# DryCrudJsonapi
+
+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/dry_crud_jsonapi`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dry_crud_jsonapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dry_crud_jsonapi
+
+## 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/dzubi/dry_crud_jsonapi.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require "bundler/gem_tasks"

data/app/domain/dry_crud_jsonapi/pager.rb

@@ -0,0 +1,39 @@
+module DryCrudJsonapi
+  class Pager
+
+    include Rails.application.routes.url_helpers
+    attr_reader :scope, :model_class, :params
+
+    delegate :current_page, :next_page, :total_pages, to: :scope
+
+    def initialize(scope, model_class, params = {})
+      @scope = scope
+      @model_class = model_class
+      @params = params.except(:controller, :action, :format)
+    end
+
+    def render
+      [first_page, last_page, prev_page, next_page].compact.to_h
+    end
+
+    def first_page
+      [:first, path(page: 1)]
+    end
+
+    def last_page
+      [:last, path(page: total_pages)]
+    end
+
+    def next_page
+      [:next, path(page: current_page + 1)] unless current_page >= total_pages
+    end
+
+    def prev_page
+      [:prev, path(page: current_page - 1)] unless current_page <= 1
+    end
+
+    def path(params = {})
+      polymorphic_path(model_class, params.merge(params))
+    end
+  end
+end

data/app/domain/dry_crud_jsonapi/serializer.rb

@@ -0,0 +1,94 @@
+module DryCrudJsonapi
+  class Serializer
+    attr_reader :model_class, :serializer_class, :define_conditionals
+
+    def initialize(model_class)
+      @model_class = model_class.to_s.constantize
+      @serializer_class = Class.new(JSONAPI::Serializable::Resource)
+      @serializer_class.send :extend, JSONAPI::Serializable::Resource::ConditionalFields
+
+      @define_conditionals = {
+        vmware_license:  { if: -> { @current_user.license? } },
+        discoverer:      { if: -> { @object.try(:discoverer_id).present? } }
+      }
+    end
+
+    def build
+      define_type
+      define_attributes
+      define_link_to_self
+      define_has_one_relations
+      define_belongs_to_relations
+      define_has_many_relations(:through)
+      define_has_many_relations(:has_many)
+
+      serializer_class
+    end
+
+    private
+
+    def define_type
+      serializer_class.type model_class.model_name.param_key
+    end
+
+    def define_attributes
+      attribute_names.each do |name|
+        define_conditional(:attribute, name)
+      end
+    end
+
+    def define_link_to_self
+      serializer_class.link(:self) do
+        @controller.rescued_polymorphic_path(@object)
+      end
+    end
+
+    def define_has_one_relations
+      reflections(for_type(:has_one)).each do |reflection|
+        define_conditional(:has_one, reflection.name.to_s) do
+          data { @object.send(reflection.name) }
+        end
+      end
+    end
+
+    def define_belongs_to_relations
+      reflections(for_type(:belongs_to)).each do |reflection|
+        define_conditional(:belongs_to, reflection.name.to_s) do
+          data { @object.send(reflection.name) }
+        end
+      end
+    end
+
+    def define_has_many_relations(type)
+      reflections(for_type(type)).each do |reflection|
+        define_conditional(:has_many, reflection.name) do
+          link(:related) do
+            @controller.rescued_polymorphic_path([@object, reflection.name])
+          end
+        end
+      end
+    end
+
+    def define_conditional(method, name, &block)
+      condition = define_conditionals.find(->{[{}]}) { |key, _| name.to_s =~ /#{key}/ }.last
+      serializer_class.send(method, name, **condition, &block)
+    end
+
+    def attribute_names
+      model_class.column_names.reject do |column|
+        %w[passwd].include?(column)
+      end
+    end
+
+    def for_type(type)
+      "ActiveRecord::Reflection::#{type.to_s.camelcase}Reflection".constantize
+    end
+
+    def reflections(type)
+      @reflections ||= {}
+      @reflections[type] ||= model_class.reflect_on_all_associations.select do |reflection|
+        reflection.is_a?(type)
+      end
+    end
+  end
+end

data/config/initializers/mime_types.rb

@@ -0,0 +1 @@
+Mime::Type.register "application/vnd.api+json", :jsonapi

data/lib/dry_crud_jsonapi.rb

@@ -0,0 +1,75 @@
+require "dry_crud_jsonapi/engine"
+
+module DryCrudJsonapi
+  extend ActiveSupport::Concern
+
+  included do
+    delegate :model_serializer, to: 'self.class'
+    prepend Prepends
+  end
+
+  module Prepends
+    def index
+      respond_to do |format|
+        format.jsonapi { jsonapi_render(entries) }
+        format.all { super }
+      end
+    end
+
+    def show
+      respond_to do |format|
+        format.jsonapi { jsonapi_render(entry) }
+        format.all { super }
+      end
+    end
+  end
+
+  def jsonapi_pagination(resources)
+    return unless action_name == 'index' && resources.present?
+    Pager.new(resources, model_class, params).render
+  end
+
+  def jsonapi_class
+    @jsonapi_class ||= Hash.new do |hash, class_name|
+      hash[class_name] = model_serializer || Serializer.new(class_name).build
+    end
+  end
+
+  def jsonapi_expose
+    { controller: self, current_user: current_user }
+  end
+
+  def rescued_polymorphic_path(*objects)
+    polymorphic_path(*objects) rescue nil
+  end
+
+  private
+
+  def json_render_entries
+    jsonapi_render(entries)
+  end
+
+  def json_render_entry
+    jsonapi_render(entry)
+  end
+
+  def jsonapi_render(object)
+    render jsonapi: object, include: jsonapi_include, fields: jsonapi_fields, expose: jsonapi_expose
+  end
+
+  def jsonapi_include
+    params.permit(:include)[:include] || []
+  end
+
+  def jsonapi_fields
+    params.permit(fields: {}).fetch('fields', []).to_h.collect do |model, string|
+      [model, string.split(',')]
+    end.to_h
+  end
+
+  module ClassMethods
+    def model_serializer
+      @model_serializer ||= "#{model_class.name}Serializer".constantize rescue nil
+    end
+  end
+end

data/lib/dry_crud_jsonapi/engine.rb

@@ -0,0 +1,5 @@
+require "jsonapi/rails"
+
+module DryCrudJsonapi
+  class Engine < Rails::Engine; end
+end

data/lib/dry_crud_jsonapi/version.rb

@@ -0,0 +1,3 @@
+module DryCrudJsonapi
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: dry_crud_jsonapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Illi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: jsonapi-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+description: 
+email:
+- illi@puzzle.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/domain/dry_crud_jsonapi/pager.rb
+- app/domain/dry_crud_jsonapi/serializer.rb
+- config/initializers/mime_types.rb
+- lib/dry_crud_jsonapi.rb
+- lib/dry_crud_jsonapi/engine.rb
+- lib/dry_crud_jsonapi/version.rb
+homepage: https://rubygems.org/gems/dry_crud_jsonapi
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Automatic JSON:API for dry_crud applications
+test_files: []