json_api_toolbox 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7b62d7d56b4b556bfe364354f26ee11265e758e
-  data.tar.gz: fd81a963afed0fd32034df88766dbc891d6e50e1
+  metadata.gz: 4044c6acd33567f9a618c59e603d30881e90806f
+  data.tar.gz: adf91b78f4c5fcf19f91653ecefd268f278d8d8d
 SHA512:
-  metadata.gz: 5b449e51f50142b8b45d95cc17685a044cb99a82b1c619003a6aaab855ab8396badd5aa9fc40dc24a5e0ef51d65b2db6780e9f6c02d95c1a29cb23da3330536a
-  data.tar.gz: 5ab43e8eb47ec7355c6f5ab42babc4124fa779024b1063d59d76a6ec9d0f206a1e795d0b2a92296f14083fed8614a3543d3a46f985bcade11b0275938f2f22c9
+  metadata.gz: b4f3e7ed1bb9b974bdc6489371b7e9a0a7b643a20d7db0e01d2ee0949f6ef36405c67c542ec034cb835360134cea67b73368cae54115f9ad2b7988c57b5ec4ab
+  data.tar.gz: 55d6c9ed248b0b8c57c1cefdb89e517a75c1d63275b55adcd1c3d2cfe1b84445f57baa2e7049e6b8824595f882685e526df8e109b744b922157a1acce58bb509

data/README.md

@@ -33,3 +33,116 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/abacha/json_api_toolbox.
+
+## Examples
+
+##ShareExamplesForControllers
+
+it_behaves_like 'a http method'
+  validate if your response have http status 200
+
+it_behaves_like 'a get method'
+  validate if your response have http status 200
+  validate if your response responde to body method
+
+it_behaves_like 'a json api response with included node'
+  validate if yor response.body has included node
+
+it_behaves_like 'a get with jsonapi with default value of', SomeModel
+  validate if all attributes are present on your data
+  obs:
+    1 - for enums who have '_cd' in the end of attribute name, '_cd' is removed.
+      ex: enum_cd => enum
+    2 - id attributes are removed from validation
+    3 - for attributes who have _id in the end of attribute name, they are
+    removed from validation
+
+it_behaves_like 'a json api response with all relations of', SomeModel
+  validate if all relations are included on your data
+
+## Example Tests
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe ManagersController, type: :controller do
+  let(:body) { JSON.parse(response.body) }
+  let(:data) { body['data'] }
+
+  describe 'GET' do
+    let!(:manager) { create(:manager) }
+    let(:params) { {} }
+
+    describe '#index' do
+      let(:data) { body['data'].first }
+
+      before { get :index, params: params }
+
+      it_behaves_like 'a get method'
+      it_behaves_like 'a json api response with all relations of', Manager
+      it_behaves_like 'a get with jsonapi with default value of', Manager
+
+      context 'including contacts' do
+        let(:params) { { includes: :contacts } }
+        it { expect(data['relationships']['contacts']['data'].size).to eq(1) }
+      end
+    end
+
+    describe '#show' do
+      before { get :show, params: { id: manager.id } }
+
+      it_behaves_like 'a get method'
+      it_behaves_like 'a json api response with included node'
+      it_behaves_like 'a json api response with all relations of', Manager
+      it_behaves_like 'a get with jsonapi with default value of', Manager
+    end
+  end
+
+  describe 'POST' do
+    describe '#create' do
+      let(:params) do
+        attributes_for(:manager).merge(
+          contacts: attributes_for_list(:contact, 2)
+        )
+      end
+
+      before { post :create, params: params }
+
+      it_behaves_like 'a get method'
+      it_behaves_like 'a json api response with included node'
+      it_behaves_like 'a json api response with all relations of', Manager
+      it_behaves_like 'a get with jsonapi with default value of', Manager
+
+      it { expect(data['relationships']['contacts']['data'].count).to eq(2) }
+    end
+  end
+
+  describe 'PATCH' do
+    describe '#update' do
+      let(:manager) { create(:manager) }
+      let(:new_name) { 'Manager 100' }
+      let(:params) do
+        {
+          id: manager.id,
+          name: new_name,
+          short_name: manager.short_name
+        }
+      end
+
+      before { post :update, params: params }
+
+      it_behaves_like 'a get method'
+      it_behaves_like 'a json api response with included node'
+      it_behaves_like 'a json api response with all relations of', Manager
+      it_behaves_like 'a get with jsonapi with default value of', Manager
+
+      it 'validates if values were updated' do
+        expect(data['attributes']['name']).to eq(new_name)
+      end
+    end
+  end
+end
+```

data/json_api_toolbox.gemspec

@@ -18,9 +18,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 4.0"
+  spec.add_dependency "jsonapi-rails", ">= 0.2"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "json"
+  spec.add_development_dependency "pry"
 end

data/lib/json_api_toolbox.rb

@@ -1,4 +1,6 @@
 require 'active_support/inflector'
+require_relative 'json_api_toolbox/spec_support/shared_examples_for_controllers'
+require 'renderizable'
 
 module JsonApiToolbox
   def self.build_enum(model, enum_attribute)

data/lib/json_api_toolbox/spec_support/shared_examples_for_controllers.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module JsonApiToolbox
+  module SpecSupport
+    module SharedExamplesForControllers
+      RSpec.shared_examples 'a http method' do
+        it 'returns http success' do
+          expect(response).to have_http_status(:success)
+        end
+      end
+
+      RSpec.shared_examples 'a get method' do
+        it_behaves_like 'a http method'
+
+        it 'response with JSON body' do
+          expect { response.body }.not_to raise_exception
+        end
+      end
+
+      RSpec.shared_examples 'a json api response with included node' do
+        it 'returns with included node' do
+          expect(JSON.parse(response.body)['included'].count).not_to eql(0)
+        end
+      end
+
+      RSpec.shared_examples 'a get with jsonapi with default value of' do |model|
+        let(:attributes) { data['attributes'].keys }
+        let(:model_keys) do
+          model.new.attributes.keys.map do |attr|
+            if attr.match?(/_cd$/)
+              attr.gsub(/_cd/, '')
+            elsif attr.match?(/_id$|^id$/)
+              nil
+            else
+              attr
+            end
+          end.compact
+        end
+
+        it 'returns response with default values' do
+          expect(attributes).to match_array(model_keys)
+        end
+      end
+
+      RSpec.shared_examples 'a json api response with all relations of' do |model|
+        let(:attributes) { data['relationships'].keys }
+        let(:relation_keys) { model.reflections.keys }
+
+        it 'returns response with default relationships' do
+          expect(attributes).to match_array(relation_keys)
+        end
+      end
+    end
+  end
+end

data/lib/json_api_toolbox/version.rb

@@ -1,3 +1,3 @@
 module JsonApiToolbox
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/renderizable.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require 'pry'
+
+module JsonApiToolbox
+  module Renderizable
+    def render_with_errors(object_errors)
+      errors = object_errors.details.map do |field, error_details|
+        error_details.each_with_index.map do |item, error_i|
+          build_line(item[:error], field, object_errors.messages[field][error_i])
+        end
+      end
+
+      render json: { errors: errors }
+    end
+
+    def render_object(object)
+      if object.respond_to?(:valid?) && !object.valid?
+        render_with_errors(object.errors)
+      else
+        render jsonapi: object, include: includes_params
+      end
+    end
+
+    def includes_params
+      params.fetch(:includes, {})
+    end
+
+    def permitted_params
+      parsed_params = params.permit(permitted_attributes).to_h
+      JsonApiToolbox.normalize_post(parsed_params, model_name)
+    end
+
+    def default_includes_params
+      model_relationships =
+        model_name.reflect_on_all_associations(:has_one).map(&:name)
+      model_relationships +=
+        model_name.reflect_on_all_associations(:has_many).map(&:name)
+
+      params.merge!(includes: model_relationships)
+    end
+
+    def model_name
+      controller_name.singularize.camelize.constantize
+    end
+
+    private
+
+    def build_line(title, field, message)
+      {
+        title: title,
+        source: field,
+        detail: message
+      }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Adriano Bacha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jsonapi-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - abacha@gmail.com
@@ -96,7 +138,9 @@ files:
 - Rakefile
 - json_api_toolbox.gemspec
 - lib/json_api_toolbox.rb
+- lib/json_api_toolbox/spec_support/shared_examples_for_controllers.rb
 - lib/json_api_toolbox/version.rb
+- lib/renderizable.rb
 homepage: http://bitbucket.org/guideinvestimentos/json_api_toolbox
 licenses: []
 metadata: {}