Update jsonapi-resources to 0.8.0 (#54)

* Update jsonapi-resources to 0.8.0

* Write a test case to cover the old issue with one-to-one relationships

Author: tiagopog

jsonapi-utils.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'jsonapi-resources', '~> 0.7.0'
+  spec.add_runtime_dependency 'jsonapi-resources', '~> 0.8.0'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'

lib/jsonapi/utils/request.rb

@@ -1,48 +1,87 @@
-module JSONAPI
-  module Utils
-    module Request
-      def jsonapi_request_handling
-        setup_request
-        check_request
-      end
+module JSONAPI::Utils
+  module Request
+    # Setup and check request before action gets actually evaluated.
+    #
+    # @api public
+    def jsonapi_request_handling
+      setup_request
+      check_request
+    end
 
-      def setup_request
-        @request ||=
-          JSONAPI::Request.new(
-            params.dup,
-            context: context,
-            key_formatter: key_formatter,
-            server_error_callbacks: (self.class.server_error_callbacks || [])
-          )
-      end
+    # Instantiate the request object.
+    #
+    # @return [JSONAPI::RequestParser]
+    #
+    # @api public
+    def setup_request
+      @request ||= JSONAPI::RequestParser.new(
+        params,
+        context: context,
+        key_formatter: key_formatter,
+        server_error_callbacks: (self.class.server_error_callbacks || [])
+      )
+    end
 
-      def check_request
-        @request.errors.blank? || jsonapi_render_errors(json: @request)
-      end
+    # Render an error response if the parsed request got any error.
+    #
+    # @api public
+    def check_request
+      @request.errors.blank? || jsonapi_render_errors(json: @request)
+    end
 
-      def resource_params
-        build_params_for(:resource)
-      end
+    # Override the JSONAPI::ActsAsResourceController#process_request method.
+    #
+    # It might be removed when the following line on JR is fixed:
+    # https://github.com/cerebris/jsonapi-resources/blob/release-0-8/lib/jsonapi/acts_as_resource_controller.rb#L62
+    #
+    # @return [String]
+    #
+    # @api public
+    def process_request
+      process_operations
+      render_results(@operation_results)
+    rescue => e
+      handle_exceptions(e)
+    end
 
-      def relationship_params
-        build_params_for(:relationship)
-      end
+    # Helper to get params for the main resource.
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def resource_params
+      build_params_for(:resource)
+    end
+
+    # Helper to get params for relationship params.
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def relationship_params
+      build_params_for(:relationship)
+    end
 
-      private
+    private
 
-      def build_params_for(param_type)
-        return {} if @request.operations.empty?
+    # Extract params from request and build a Hash with params
+    # for either the main resource or relationships.
+    #
+    # @return [Hash]
+    #
+    # @api private
+    def build_params_for(param_type)
+      return {} if @request.operations.empty?
 
-        keys      = %i(attributes to_one to_many)
-        operation = @request.operations.find { |e| e.data.keys & keys == keys }
+      keys = %i(attributes to_one to_many)
+      operation = @request.operations.find { |e| e.options[:data].keys & keys == keys }
 
-        if operation.nil?
-          {}
-        elsif param_type == :relationship
-          operation.data.values_at(:to_one, :to_many).compact.reduce(&:merge)
-        else
-          operation.data[:attributes]
-        end
+      if operation.nil?
+        {}
+      elsif param_type == :relationship
+        operation.options[:data].values_at(:to_one, :to_many).compact.reduce(&:merge)
+      else
+        operation.options[:data][:attributes]
       end
     end
   end

lib/jsonapi/utils/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Utils
-    VERSION = '0.4.8'
+    VERSION = '0.4.9'
   end
 end

spec/controllers/posts_controller_spec.rb

@@ -96,7 +96,7 @@
             expect(response).to have_meta_record_count(4)
 
             expect(json['links']['first']).to be_present
-            expect(json['links']['previous']).to be_present
+            expect(json['links']['prev']).to be_present
             expect(json['links']['next']).to be_present
             expect(json['links']['last']).to be_present
           end
@@ -111,7 +111,7 @@
             expect(response).to have_meta_record_count(4)
 
             expect(json['links']['first']).to be_present
-            expect(json['links']['previous']).to be_present
+            expect(json['links']['prev']).to be_present
             expect(json['links']['next']).not_to be_present
             expect(json['links']['last']).to be_present
           end

spec/controllers/users_controller_spec.rb

@@ -9,8 +9,8 @@
     JSONAPI.configuration.json_key_format = :underscored_key
   end
 
-  let(:fields)        { (UserResource.fields - %i(id posts)).map(&:to_s) }
-  let(:relationships) { %w(posts) }
+  let(:fields)        { (UserResource.fields - %i(id profile posts)).map(&:to_s) }
+  let(:relationships) { %w(profile posts) }
   let(:attributes)    { { first_name: 'Yehuda', last_name: 'Katz' } }
 
   let(:user_params) do
@@ -30,7 +30,7 @@
 
     context 'with "include"' do
       it 'returns only the required relationships in the "included" member' do
-        get :index, include: :posts
+        get :index, include: 'profile,posts'
         expect(response).to have_http_status :ok
         expect(response).to have_primary_data('users')
         expect(response).to have_data_attributes(fields)
@@ -205,7 +205,7 @@
             expect(response).to have_meta_record_count(User.count)
 
             expect(json['links']['first']).to be_present
-            expect(json['links']['previous']).to be_present
+            expect(json['links']['prev']).to be_present
             expect(json['links']['next']).to be_present
             expect(json['links']['last']).to be_present
           end
@@ -221,7 +221,7 @@
             expect(response).to have_meta_record_count(User.count)
 
             expect(json['links']['first']).to be_present
-            expect(json['links']['previous']).to be_present
+            expect(json['links']['prev']).to be_present
             expect(json['links']['last']).to be_present
           end
         end
@@ -266,7 +266,7 @@
             expect(response).to have_meta_record_count(User.count)
 
             expect(json['links']['first']).to be_present
-            expect(json['links']['previous']).to be_present
+            expect(json['links']['prev']).to be_present
             expect(json['links']['next']).to be_present
             expect(json['links']['last']).to be_present
           end
@@ -282,7 +282,7 @@
             expect(response).to have_meta_record_count(User.count)
 
             expect(json['links']['first']).to be_present
-            expect(json['links']['previous']).to be_present
+            expect(json['links']['prev']).to be_present
             expect(json['links']['last']).to be_present
           end
         end
@@ -481,4 +481,16 @@
       end
     end
   end
+
+  describe 'use of JSONAPI::Resources\' default actions' do
+    let(:user) { User.first }
+
+    describe '#show_relationship' do
+      it do
+        get :show_relationship, user_id: user.id, relationship: 'profile'
+        expect(response).to have_http_status :ok
+        expect(response).to have_primary_data('profiles')
+      end
+    end
+  end
 end

spec/spec_helper.rb

@@ -93,6 +93,7 @@ class TestApp < Rails::Application
 TestApp.routes.draw do
   jsonapi_resources :users do
     jsonapi_resources :posts, only: %i(index show)
+    jsonapi_links :profile
   end
 
   jsonapi_resources :posts, only: %i(create)

spec/support/factories.rb

@@ -14,11 +14,20 @@
     sequence(:first_name) { |n| "User##{n}" }
     sequence(:last_name) { |n| "Lastname##{n}" }
 
+    after(:create) { |user| create(:profile, user: user) }
+
     trait :with_posts do
       transient { post_count 3 }
       after(:create) do |user, e|
         create_list(:post, e.post_count, author: user)
       end
     end
   end
+
+  factory :profile, class: Profile do
+    user
+
+    sequence(:id) { |n| n }
+    sequence(:nickname) { |n| "Profile##{n}" }
+  end
 end

spec/support/models.rb

@@ -17,18 +17,30 @@
     t.boolean  :admin
     t.timestamps null: false
   end
+
+  create_table :profiles, force: true do |t|
+    t.string :nickname
+    t.references :user, index: true, foreign_key: true
+    t.timestamps null: false
+  end
 end
 
 # Models
 class User < ActiveRecord::Base
+  has_one :profile
   has_many :posts
+
   validates :first_name, :last_name, presence: true
 
   def full_name
     "#{first_name} #{last_name}"
   end
 end
 
+class Profile < ActiveRecord::Base
+  belongs_to :user
+end
+
 class Post < ActiveRecord::Base
   belongs_to :author, class_name: 'User', foreign_key: 'user_id'
   validates :title, :body, :author, presence: true

spec/support/resources.rb

@@ -10,13 +10,18 @@ class PostResource < ::PostResource; end
 class UserResource < JSONAPI::Resource
   attributes :first_name, :last_name, :full_name
 
+  has_one :profile, class_name: 'Profile'
   has_many :posts
 
   filters :first_name
-
   custom_filters :full_name
 
   def full_name
     "#{@model.first_name} #{@model.last_name}"
   end
 end
+
+class ProfileResource < JSONAPI::Resource
+  attributes :nickname
+  has_one :user, class_name: 'User', foreign_key: 'user_id'
+end