rao-api-resources_controller 0.0.13.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb541474f989fd16ee1a043a514c9320220d777eb09842e982fca79f53232a4e
+  data.tar.gz: e7d5bf935d177cd2717c8026d74eb0773efcbcfcc6bbaa7985f652edf4ef62d0
+SHA512:
+  metadata.gz: 2d0b719bc11091ddf6b891f4eab70a24949a9b1e84b09b3357016f68e46d8e5d088700ea2142848cb483a091862daf064e46c83b86b88d91f7410a64eaf00fce
+  data.tar.gz: 90f8fc326357e0899414c22a165df3511fb56e308e937a5cac774792fcf0da8748b12dd9ae06b02a809b88f66c337cff5918fe474e1a22bd91d337da2a5fd0a3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Roberto Vasquez Angel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Rao::Api:ServiceController
+Short description and motivation.
+
+## Usage
+
+### Basic example
+
+We are going to add a REST api to a basic rails model.
+
+Assume you have a Post model:
+
+```ruby
+# app/models/post.rb
+class Post < ApplicationRecord
+end
+```
+
+To add an api endpoint at /api/posts we will need routes and an api controller.
+
+First the routes:
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  namespace :api do
+    resources :posts
+  end
+end
+```
+
+Then the controller:
+
+```ruby
+# app/controllers/api/posts_controller.rb
+module Api
+  class PostsController < Rao::Api::ResourcesController::Base
+    # Here we specify the model class this controller is for.
+    def self.resource_class
+      Post
+    end
+  end
+end
+```
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rao-api-resources_controller'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rao-api-resources_controller
+```
+
+Generate the initializer:
+
+```bash
+$ rails g rao:api:resources_controller:install
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,25 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rails Add-Ons API Resources Controller'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'

data/app/concerns/rao/api/resources_controller/count_action_concern.rb

@@ -0,0 +1,32 @@
+module Rao
+  module Api
+    module ResourcesController::CountActionConcern
+      extend ActiveSupport::Concern
+
+      included do
+        if respond_to?(:before_action)
+          before_action :load_count, only: [:count]
+        else
+          before_filter :load_count, only: [:count]
+        end
+      end
+
+      def count
+        respond_to do |format|
+          format.json { render json: { count: @count } }
+        end
+      end
+
+      private
+
+      def load_count
+        scope = if respond_to?(:with_conditions_from_query, true)
+          scope = with_conditions_from_query(resource_class)
+        else
+          resource_class
+        end
+        @count = scope.count
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resources_controller/delete_all_action_concern.rb

@@ -0,0 +1,27 @@
+module Rao
+  module Api
+    module ResourcesController::DeleteAllActionConcern
+      extend ActiveSupport::Concern
+
+      included do
+        if respond_to?(:before_action)
+          before_action :delete_collection, only: [:delete_all]
+        else
+          before_filter :delete_collection, only: [:delete_all]
+        end
+      end
+
+      def delete_all
+        respond_to do |format|
+          format.json { render json: { count: @count } }
+        end
+      end
+
+      private
+
+      def delete_collection
+        @count = resource_class.delete_all
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resources_controller/destroy_all_action_concern.rb

@@ -0,0 +1,27 @@
+module Rao
+  module Api
+    module ResourcesController::DestroyAllActionConcern
+      extend ActiveSupport::Concern
+
+      included do
+        if respond_to?(:before_action)
+          before_action :load_and_destroy_collection, only: [:destroy_all]
+        else
+          before_filter :load_and_destroy_collection, only: [:destroy_all]
+        end
+      end
+
+      def destroy_all
+        respond_to do |format|
+          format.json { render json: serialize_collection(@collection) }
+        end
+      end
+
+      private
+
+      def load_and_destroy_collection
+        @collection = resource_class.destroy_all
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resources_controller/exception_handling_concern.rb

@@ -0,0 +1,42 @@
+module Rao
+  module Api
+    module ResourcesController::ExceptionHandlingConcern
+      extend ActiveSupport::Concern
+
+      included do
+        rescue_from Exception do |exception|
+          handle_exception(exception)
+        end
+
+        rescue_from ActiveRecord::RecordNotFound do |exception|
+          handle_404(exception)
+        end
+      end
+
+      private
+
+      def handle_404(exception = nil)
+        respond_to do |format|
+          format.json { render json: { error: (exception.try(:message) || 'Not found') }, status: 404 }
+        end
+      end
+
+      def handle_exception(exception)
+        if Rails.env.development? || Rails.env.test?
+          error = { message: exception.message }
+
+          error[:application_trace] = Rails.backtrace_cleaner.clean(exception.backtrace)
+          error[:full_trace] = exception.backtrace
+
+          respond_to do |format|
+            format.json { render json: error, status: 500 }
+          end
+        else
+          respond_to do |format|
+            format.json { render json: { error: 'Internal server error.' }, status: 500 }
+          end
+        end
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resources_controller/first_action_concern.rb

@@ -0,0 +1,33 @@
+module Rao
+  module Api
+    module ResourcesController::FirstActionConcern
+      extend ActiveSupport::Concern
+
+      included do
+        if respond_to?(:before_action)
+          before_action :load_first, only: [:first]
+        else
+          before_filter :load_first, only: [:first]
+        end
+      end
+
+      def first
+        respond_to do |format|
+          if @resource.nil?
+            format.json { render json: nil }
+          else
+            format.json { render json: [serialize_resource(@resource)] }
+          end
+        end
+      end
+
+      private
+
+      def load_first
+        base_scope = resource_class
+        scope = add_conditions_from_query(base_scope)
+        @resource = scope.first
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resources_controller/last_action_concern.rb

@@ -0,0 +1,33 @@
+module Rao
+  module Api
+    module ResourcesController::LastActionConcern
+      extend ActiveSupport::Concern
+
+      included do
+        if respond_to?(:before_action)
+          before_action :load_last, only: [:last]
+        else
+          before_filter :load_last, only: [:last]
+        end
+      end
+
+      def last
+        respond_to do |format|
+          if @resource.nil?
+            format.json { render json: nil }
+          else
+            format.json { render json: [serialize_resource(@resource)] }
+          end
+        end
+      end
+
+      private
+
+      def load_last
+        base_scope = resource_class
+        scope = add_conditions_from_query(base_scope)
+        @resource = scope.last
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resources_controller/resources_concern.rb

@@ -0,0 +1,11 @@
+module Rao
+  module Api
+    module ResourcesController::ResourcesConcern
+      extend ActiveSupport::Concern
+
+      def resource_class
+        self.class.resource_class
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resources_controller/rest_actions_concern.rb

@@ -0,0 +1,110 @@
+module Rao
+  module Api
+    module ResourcesController::RestActionsConcern
+      extend ActiveSupport::Concern
+
+      included do
+        include ActionController::MimeResponds
+
+        respond_to :json
+
+        if respond_to?(:before_action)
+          before_action :load_collection, only: [:index]
+          before_action :load_resource_for_show, only: [:show]
+          before_action :load_resource, only: [:update, :destroy, :delete]
+          before_action :initialize_resource_for_create, only: [:create]
+        else
+          before_filter :load_collection, only: [:index]
+          before_filter :load_resource_for_show, only: [:show]
+          before_filter :load_resource, only: [:update, :destroy, :delete]
+          before_filter :initialize_resource_for_create, only: [:create]
+        end
+      end
+
+      def index
+        respond_to do |format|
+          format.json { render json: serialize_collection(@collection) }
+        end
+      end
+
+      def show
+        respond_to do |format|
+          if @resource.nil?
+            format.json { render json: { error: "Couldn't find #{resource_class} with ID=#{params[:id]}" }, status: :not_found }
+          else
+            format.json { render json: serialize_resource(@resource), status: :ok }
+          end
+        end
+      end
+
+      def create
+        respond_to do |format|
+          if @resource.save
+            format.json { render json: serialize_resource(@resource), status: :created }
+          else
+            format.json { render json: { errors: serialize_errors(@resource.errors) }, status: 422 }
+          end
+        end
+      end
+
+      def update
+        respond_to do |format|
+          if @resource.update_attributes(permitted_params)
+            format.json { render json: serialize_resource(@resource) }
+          else
+            format.json { render json: { errors: serialize_errors(@resource.errors) }, status: 422 }
+          end
+        end
+      end
+
+      def destroy
+        @resource.destroy
+        respond_to do |format|
+          format.json { render json: serialize_resource(@resource) }
+        end
+      end
+
+      def delete
+        @resource.delete
+        respond_to do |format|
+          format.json { render json: serialize_resource(@resource) }
+        end
+      end
+
+      private
+
+      def load_collection
+        scope = if respond_to?(:with_conditions_from_query, true)
+          scope = with_conditions_from_query(resource_class)
+        else
+          resource_class
+        end
+        @collection = scope.all
+      end
+
+      def load_resource
+        @resource = resource_class.find(params[:id])
+      end
+
+      def load_resource_for_show
+        begin
+          @resource = resource_class.find(params[:id])
+        rescue ActiveRecord::RecordNotFound
+          @resource = nil
+        end
+      end
+
+      def initialize_resource
+        @resource = resource_class.new
+      end
+
+      def initialize_resource_for_create
+        @resource = resource_class.new(permitted_params)
+      end
+
+      def permitted_params
+        raise "not implemented"
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resources_controller/serialization_concern.rb

@@ -0,0 +1,25 @@
+module Rao
+  module Api
+    module ResourcesController::SerializationConcern
+      extend ActiveSupport::Concern
+
+      private
+
+      def serialize_collection(collection)
+        collection.collect do |resource|
+          serialize_resource(resource)
+        end
+      end
+
+      def serialize_resource(resource)
+        json = resource.as_json
+        json[:errors] = serialize_errors(resource.errors) if resource.errors.any?
+        json
+      end
+
+      def serialize_errors(errors)
+        errors.as_json(full_messages: true)
+      end
+    end
+  end
+end

data/app/controllers/rao/api/resources_controller/base.rb

@@ -0,0 +1,17 @@
+module Rao
+  module Api
+    module ResourcesController
+      class Base < Rao::Api::ResourcesController::Configuration.resources_controller_base_class_name.constantize
+        include RestActionsConcern
+        include ResourcesConcern
+        include SerializationConcern
+        include CountActionConcern
+        include DestroyAllActionConcern
+        include DeleteAllActionConcern
+        include FirstActionConcern
+        include LastActionConcern
+        include ExceptionHandlingConcern
+      end
+    end
+  end
+end

data/config/locales/de.yml

@@ -0,0 +1 @@
+de:

data/config/locales/en.yml

@@ -0,0 +1 @@
+en:

data/lib/generators/rao/api/service_controller/install_generator.rb

@@ -0,0 +1,17 @@
+module Rao
+  module Api
+    module ResourcesController
+      module Generators
+        class InstallGenerator < Rails::Generators::Base
+          desc 'Generates the initializer'
+
+          source_root File.expand_path('../templates', __FILE__)
+
+          def generate_initializer
+            template 'initializer.rb', 'config/initializers/rao-api-resources_controller.rb'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/rao/api/service_controller/templates/initializer.rb

@@ -0,0 +1,7 @@
+Rao::Api::ResourcesController.configure do |config|
+  # Set the base controller for resources controllers.
+  #
+  # default: config.resources_controller_base_class_name = '::ApplicationController'
+  #
+  config.resources_controller_base_class_name = '::ApplicationController'
+end

data/lib/rao/api/resources_controller/configuration.rb

@@ -0,0 +1,13 @@
+module Rao
+  module Api
+    module ResourcesController
+      module Configuration
+        def configure
+          yield self
+        end
+
+        mattr_accessor(:resources_controller_base_class_name) { '::ApplicationController' }
+      end
+    end
+  end
+end

data/lib/rao/api/resources_controller/engine.rb

@@ -0,0 +1,9 @@
+module Rao
+  module Api
+    module ResourcesController
+      class Engine < ::Rails::Engine
+        isolate_namespace Rao::Api::ResourcesController
+      end
+    end
+  end
+end

data/lib/rao/api/resources_controller/version.rb

@@ -0,0 +1,9 @@
+require 'rao/version'
+
+module Rao
+  module Api
+    module ResourcesController
+      VERSION = ::Rao::VERSION
+    end
+  end
+end

data/lib/rao/api/resources_controller.rb

@@ -0,0 +1,13 @@
+require "rao/api/resources_controller/configuration"
+require "rao/api/resources_controller/version"
+require "rao/api/resources_controller/engine"
+
+module Rao
+  module Api
+    module ResourcesController
+      extend Configuration
+    end
+  end
+end
+
+Rao.configure { |c| c.register_configuration(:api_resources_controller, Rao::Api::ResourcesController) }

data/lib/rao/api.rb

@@ -0,0 +1,4 @@
+module Rao
+  module Api
+  end
+end

data/lib/rao-api-resources_controller.rb

@@ -0,0 +1,3 @@
+require 'rao'
+require "rao/api"
+require "rao/api/resources_controller"

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: rao-api-resources_controller
+version: !ruby/object:Gem::Version
+  version: 0.0.13.pre
+platform: ruby
+authors:
+- Roberto Vasquez Angel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rao
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: rspec-rails
+  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: simplecov
+  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: guard-rspec
+  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: guard-bundler
+  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-rails
+  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:
+- roberto@vasquez-angel.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/concerns/rao/api/resources_controller/count_action_concern.rb
+- app/concerns/rao/api/resources_controller/delete_all_action_concern.rb
+- app/concerns/rao/api/resources_controller/destroy_all_action_concern.rb
+- app/concerns/rao/api/resources_controller/exception_handling_concern.rb
+- app/concerns/rao/api/resources_controller/first_action_concern.rb
+- app/concerns/rao/api/resources_controller/last_action_concern.rb
+- app/concerns/rao/api/resources_controller/resources_concern.rb
+- app/concerns/rao/api/resources_controller/rest_actions_concern.rb
+- app/concerns/rao/api/resources_controller/serialization_concern.rb
+- app/controllers/rao/api/resources_controller/base.rb
+- config/locales/de.yml
+- config/locales/en.yml
+- lib/generators/rao/api/service_controller/install_generator.rb
+- lib/generators/rao/api/service_controller/templates/initializer.rb
+- lib/rao-api-resources_controller.rb
+- lib/rao/api.rb
+- lib/rao/api/resources_controller.rb
+- lib/rao/api/resources_controller/configuration.rb
+- lib/rao/api/resources_controller/engine.rb
+- lib/rao/api/resources_controller/version.rb
+homepage: https://github.com/rao
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: API Resources Controller for Ruby on Rails.
+test_files: []