jsonapi_compliable 0.11.34 → 1.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 2b577a79ded38bd4613b559334071632b188d2b78f14cc0cb882b5375a37b5a4
-  data.tar.gz: 49f8349533f4dcd5be4344b4bf54997eaef316cd279611ca830e323ee421f9e0
+SHA1:
+  metadata.gz: b893a4986018fbc20f3accdf20fe6b3ad84b6574
+  data.tar.gz: 7dc27ab003bde762c655255dec3f4800f88c144d
 SHA512:
-  metadata.gz: 5fb80bd50abadabaab56dabc4fb9f20bd2638e2da29cea7b51e5040a388d15f0ce02c2df0dbcd70d7d01b428d4de15fdfd7134a872f45da197e5a39f55776829
-  data.tar.gz: 00f3c45f9deb647c227d575d17589b6354025b415e7012c96722f3069eccebd2829cebcfd37987f4180e433826835039aaf3b1b82dabd5634bd760a20c7bafef
+  metadata.gz: cbf873e797bdd2ff35e4ae5ceed8f8c42f03829c89992cca7a62468210e0f677584d4b0080da6a99e585e47c650d9ffe5386079959117753d96bf51c84e13bb7
+  data.tar.gz: dd59e9bb8e8d5c58d8308300647aeefd6c6bb3356fd37b7ddccff3fb98eddc700fc2b92932aede85d8a73f001cc59aa9255186d465ab664c0f28ef7b159039f1

data/.ruby-version

@@ -1 +1 @@
-2.5.2
+2.3.0

data/.travis.yml

@@ -1,8 +1,7 @@
+sudo: false
 language: ruby
 rvm:
   - 2.3.3
-dist: xenial
-os: linux
 
 script: "bundle exec rake"
 

data/Rakefile

@@ -2,10 +2,14 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "appraisal"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  if ENV["APPRAISAL_INITIALIZED"]
+    t.pattern = 'spec/integration/rails'
+  end
+end
 
 if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
-  task :default => :appraisal
+  task :default => [:spec, :appraisal]
 else
-  task :default => :spec
+  task :default => [:spec]
 end

data/jsonapi_compliable.gemspec

@@ -6,8 +6,8 @@ require 'jsonapi_compliable/version'
 Gem::Specification.new do |spec|
   spec.name          = "jsonapi_compliable"
   spec.version       = JsonapiCompliable::VERSION
-  spec.authors       = ["Lee Richmond", "Venkata Pasupuleti"]
-  spec.email         = ["richmolj@gmail.com", "spasupuleti4@bloomberg.net"]
+  spec.authors       = ["Lee Richmond"]
+  spec.email         = ["richmolj@gmail.com"]
 
   spec.summary       = %q{Easily build jsonapi.org-compatible APIs}
   spec.license       = "MIT"
@@ -19,11 +19,15 @@ Gem::Specification.new do |spec|
 
   # Pinning this version until backwards-incompatibility is addressed
   spec.add_dependency 'jsonapi-serializable', '~> 0.3.0'
+  spec.add_dependency 'dry-types', '~> 0.13'
+  spec.add_dependency 'jsonapi_errorable', '~> 0.9'
 
   spec.add_development_dependency "activerecord", ['>= 4.1', '< 6']
   spec.add_development_dependency "kaminari", '~> 0.17'
-  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "activemodel", ['>= 4.1', '< 6']
+  spec.add_development_dependency "jsonapi_spec_helpers", '>= 1.0.alpha.1'
 end

data/lib/generators/jsonapi/resource_generator.rb

@@ -22,18 +22,10 @@ module Jsonapi
       end
 
       generate_controller
-      generate_serializer
       generate_application_resource unless application_resource_defined?
-      generate_spec_payload
-
-      if actions?('create', 'update')
-        generate_strong_resource
-      end
-
       generate_route
       generate_tests
       generate_resource
-      generate_swagger if docs_controller?
     end
 
     private
@@ -55,11 +47,6 @@ module Jsonapi
       template('controller.rb.erb', to)
     end
 
-    def generate_serializer
-      to = File.join('app/serializers', class_path, "serializable_#{file_name}.rb")
-      template('serializer.rb.erb', to)
-    end
-
     def generate_application_resource
       to = File.join('app/resources', class_path, "application_resource.rb")
       template('application_resource.rb.erb', to)
@@ -69,39 +56,6 @@ module Jsonapi
       'ApplicationResource'.safe_constantize.present?
     end
 
-    def docs_controller?
-      File.exists?('app/controllers/docs_controller.rb')
-    end
-
-    def generate_swagger
-      code = "  jsonapi_resource '/v1/#{type}'"
-      code << ", only: [#{actions.map { |a| ":#{a}" }.join(', ')}]" if actions.length < 5
-      code << "\n"
-      inject_into_file 'app/controllers/docs_controller.rb', before: /^end/ do
-        code
-      end
-    end
-
-    def generate_spec_payload
-      to = File.join('spec/payloads', class_path, "#{file_name}.rb")
-      template('payload.rb.erb', to)
-    end
-
-    def generate_strong_resource
-      code = "  strong_resource :#{file_name} do\n"
-      attributes.each do |a|
-        type = a.type
-        type = :string if type == :text
-        type = :number if [:float, :decimal].include?(type)
-        code << "    attribute :#{a.name}, :#{type}\n"
-      end
-      code << "  end\n"
-
-      inject_into_file 'config/initializers/strong_resources.rb', after: "StrongResources.configure do\n" do
-        code
-      end
-    end
-
     def generate_route
       code = "      resources :#{type}"
       code << ", only: [#{actions.map { |a| ":#{a}" }.join(', ')}]" if actions.length < 5
@@ -112,40 +66,11 @@ module Jsonapi
     end
 
     def generate_tests
-      if actions?('index')
-        to = File.join "spec/api/v1/#{file_name.pluralize}",
-          class_path,
-          "index_spec.rb"
-        template('index_request_spec.rb.erb', to)
-      end
-
-      if actions?('show')
-        to = File.join "spec/api/v1/#{file_name.pluralize}",
-          class_path,
-          "show_spec.rb"
-        template('show_request_spec.rb.erb', to)
-      end
+      to = File.join("spec/resources/#{file_name}", class_path, "reads_spec.rb")
+      template('resource_reads_spec.rb.erb', to)
 
-      if actions?('create')
-        to = File.join "spec/api/v1/#{file_name.pluralize}",
-          class_path,
-          "create_spec.rb"
-        template('create_request_spec.rb.erb', to)
-      end
-
-      if actions?('update')
-        to = File.join "spec/api/v1/#{file_name.pluralize}",
-          class_path,
-          "update_spec.rb"
-        template('update_request_spec.rb.erb', to)
-      end
-
-      if actions?('destroy')
-        to = File.join "spec/api/v1/#{file_name.pluralize}",
-          class_path,
-          "destroy_spec.rb"
-        template('destroy_request_spec.rb.erb', to)
-      end
+      to = File.join("spec/resources/#{file_name}", class_path, "writes_spec.rb")
+      template('resource_writes_spec.rb.erb', to)
     end
 
     def generate_resource
@@ -191,6 +116,10 @@ module Jsonapi
       class_name.safe_constantize
     end
 
+    def resource_klass
+      "#{model_klass}Resource"
+    end
+
     def type
       model_klass.name.underscore.pluralize
     end

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

@@ -10,5 +10,6 @@ class ApplicationResource < JsonapiCompliable::Resource
   # Subclasses can still override this default.
   # More on adapters: https://jsonapi-suite.github.io/jsonapi_compliable/JsonapiCompliable/Adapters/Abstract.html
   <%- end -%>
-  use_adapter JsonapiCompliable::Adapters::ActiveRecord
+  self.abstract_class = true
+  self.adapter = JsonapiCompliable::Adapters::ActiveRecord::Base.new
 end

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

@@ -1,96 +1,51 @@
 <% module_namespacing do -%>
 class <%= model_klass.name.pluralize %>Controller < ApplicationController
-  <%- unless omit_comments? -%>
-  # Mark this as a JSONAPI controller, associating with the given resource
-  <%- end -%>
-  jsonapi resource: <%= model_klass %>Resource
-
-  <%- if actions?('create', 'update') -%>
-  <%- unless omit_comments? -%>
-  # Reference a strong resource payload defined in
-  # config/initializers/strong_resources.rb
-  <%- end -%>
-  strong_resource :<%= file_name %>
-  <%- end -%>
-  <%- if actions?('create', 'update') -%>
-  <%- unless omit_comments? -%>
-  # Run strong parameter validation for these actions.
-  # Invalid keys will be dropped.
-  # Invalid value types will log or raise based on the configuration
-  # ActionController::Parameters.action_on_invalid_parameters
-  <%- end -%>
-  before_action :apply_strong_params, only: [:create, :update]
-
-  <%- end -%>
   <%- if actions?('index') -%>
-  <%- unless omit_comments? -%>
-  # Start with a base scope and pass to render_jsonapi
-  <%- end -%>
   def index
-    <%= file_name.pluralize %> = <%= model_klass %>.all
-    render_jsonapi(<%= file_name.pluralize %>)
+    <%= file_name.pluralize %> = <%= resource_klass %>.all(params)
+    respond_with(<%= file_name.pluralize %>)
   end
-
   <%- end -%>
   <%- if actions?('show') -%>
-  <%- unless omit_comments? -%>
-  # Call jsonapi_scope directly here so we can get behavior like
-  # sparse fieldsets and statistics.
-  <%- end -%>
+
   def show
-    scope = jsonapi_scope(<%= model_klass %>.where(id: params[:id]))
-    instance = scope.resolve.first
-    raise JsonapiCompliable::Errors::RecordNotFound unless instance
-    render_jsonapi(instance, scope: false)
+    <%= file_name %> = <%= resource_klass %>.find(params)
+    respond_with(<%= file_name.pluralize %>)
   end
-
   <%- end -%>
   <%- if actions?('create') -%>
-  <%- unless omit_comments? -%>
-  # jsonapi_create will use the configured Resource (and adapter) to persist.
-  # This will handle nested relationships as well.
-  # On validation errors, render correct error JSON.
-  <%- end -%>
+
   def create
-    <%= file_name %>, success = jsonapi_create.to_a
+    <%= file_name %> = <%= resource_klass %>.build(params)
 
-    if success
-      render_jsonapi(<%= file_name %>, scope: false)
+    if <%= file_name %>.save
+      respond_with(<%= file_name %>)
     else
-      render_errors_for(<%= file_name %>)
+      render jsonapi_errors: <%= file_name %>
     end
   end
-
   <%- end -%>
   <%- if actions?('update') -%>
-  <%- unless omit_comments? -%>
-  # jsonapi_update will use the configured Resource (and adapter) to persist.
-  # This will handle nested relationships as well.
-  # On validation errors, render correct error JSON.
-  <%- end -%>
+
   def update
-    <%= file_name %>, success = jsonapi_update.to_a
+    <%= file_name %> = <%= resource_klass %>.find(params)
 
-    if success
-      render_jsonapi(<%= file_name %>, scope: false)
+    if <%= file_name %>.update_attributes
+      respond_with(<%= file_name %>)
     else
-      render_errors_for(<%= file_name %>)
+      render jsonapi_errors: <%= file_name %>
     end
   end
-
   <%- end -%>
   <%- if actions?('destroy') -%>
-  <%- unless omit_comments? -%>
-  # Renders 200 OK with empty meta
-  # http://jsonapi.org/format/#crud-deleting-responses-200
-  <%- end -%>
+
   def destroy
-    <%= file_name %>, success = jsonapi_destroy.to_a
+    <%= file_name %> = <%= resource_klass %>.find(params)
 
-    if success
+    if <%= file_name %>.destroy
       render json: { meta: {} }
     else
-      render_errors_for(<%= file_name %>)
+      render jsonapi_errors: <%= file_name %>
     end
   end
   <%- end -%>

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

@@ -1,53 +1,11 @@
-<%- unless omit_comments? -%>
-# Define how to query and persist a given model.
-# Further Resource documentation: https://jsonapi-suite.github.io/jsonapi_compliable/JsonapiCompliable/Resource.html
-<%- end -%>
 <% module_namespacing do -%>
 class <%= class_name %>Resource < ApplicationResource
-  <%- unless omit_comments? -%>
-  # Used for associating this resource with a given input.
-  # This should match the 'type' in the corresponding serializer.
+  <%- attributes.each do |a| -%>
+  <%- if [:created_at, :updated_at].include?(a.name.to_sym) -%>
+  attribute :<%= a.name %>, :<%= a.type %>, writable: false
+  <%- else -%>
+  attribute :<%= a.name %>, :<%= a.type %>
   <%- end -%>
-  type :<%= type %>
-  <%- unless omit_comments? -%>
-  # Associate to a Model object so we know how to persist.
-  <%- end -%>
-  model <%= model_klass %>
-  <%- unless omit_comments? -%>
-  # Customize your resource here. Some common examples:
-  #
-  # === Allow ?filter[name] query parameter ===
-  # allow_filter :name
-  #
-  # === Enable total count, when requested ===
-  # allow_stat total: [:count]
-  #
-  # === Allow sideloading/sideposting of relationships ===
-  # belongs_to :foo,
-  #   foreign_key: :foo_id,
-  #   resource: FooResource,
-  #   scope: -> { Foo.all }
-  #
-  # === Custom sorting logic ===
-  # sort do |scope, att, dir|
-  #   ... code ...
-  # end
-  #
-  # === Change default sort ===
-  # default_sort([{ title: :asc }])
-  #
-  # === Custom pagination logic ===
-  # paginate do |scope, current_page, per_page|
-  #   ... code ...
-  # end
-  #
-  # === Change default page size ===
-  # default_page_size(10)
-  #
-  # === Change how we resolve the scope ===
-  # def resolve(scope)
-  #   ... code ...
-  # end
   <%- end -%>
 end
 <% end -%>

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

@@ -0,0 +1,62 @@
+require 'rails_helper'
+
+RSpec.describe <%= resource_klass %>, type: :resource do
+  describe 'serialization' do
+    let!(:<%= file_name %>) { create(:<%= file_name %>) }
+
+    it 'works' do
+      render
+      data = jsonapi_data[0]
+      expect(data.id).to eq(<%= file_name %>.id)
+      expect(data.jsonapi_type).to eq('<%= file_name.pluralize %>')
+      <%- attributes.each do |a| -%>
+      <%- if [:created_at, :updated_at].include?(a.name.to_sym) -%>
+      expect(data.<%= a.name %>).to eq(datetime(<%= file_name %>.<%= a.name %>))
+      <%- else -%>
+      expect(data.<%= a.name %>).to eq(<%= file_name %>.<%= a.name %>)
+      <%- end -%>
+      <%- end -%>
+    end
+  end
+  <%- if actions?('index') -%>
+
+  describe 'filtering' do
+    let!(:<%= file_name %>1) { create(:<%= file_name %>) }
+    let!(:<%= file_name %>2) { create(:<%= file_name %>) }
+
+    context 'by id' do
+      before do
+        params[:filter] = { id: { eq: <%= file_name %>2.id } }
+      end
+
+      it 'works' do
+        render
+        expect(d.map(&:id)).to eq([<%= file_name %>2.id])
+      end
+    end
+  end
+
+  describe 'sorting' do
+    context 'by id descending' do
+      let!(:<%= file_name %>1) { create(:<%= file_name %>) }
+      let!(:<%= file_name %>2) { create(:<%= file_name %>) }
+
+      before do
+        params[:sort] = '-id'
+      end
+
+      it 'works' do
+        render
+        expect(d.map(&:id)).to eq([
+          <%= file_name %>2.id,
+          <%= file_name %>1.id
+        ])
+      end
+    end
+  end
+  <%- end -%>
+
+  describe 'sideloading' do
+    # ... your tests ...
+  end
+end