rao-api-service_controller 0.0.8.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca5415c541504a8cbf36a062665d300d9b0dbc6c
+  data.tar.gz: a315f682e4fd9e89450824c3a5a93fb66627e91c
+SHA512:
+  metadata.gz: be5a598b36cc0f50768376b07e0cb5426dfc4905d6f81f8b7aac0cfc92e6a62bce76493851b48baeddecb3cc5d8679690fa28dd995a969826f2c0dde1cb6edfa
+  data.tar.gz: e3c5ef454411e2e106222e71bc483012a7ed55965707f0f9ce86500dfe0304f684a72b8b62eff404098ac6c3af2ad2487d9f69ce8b38f034943598c61575fac0

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,34 @@
+# Rao::Api:ServiceController
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rao-api-service_controller'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rao-api-service_controller
+```
+
+Generate the initializer:
+
+```bash
+$ rails g rao:api:service_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 Service 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/service_controller/exception_handling_concern.rb

@@ -0,0 +1,42 @@
+module Rao
+  module Api
+    module ServiceController::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/service_controller/rest_actions_concern.rb

@@ -0,0 +1,88 @@
+module Rao
+  module Api
+    module ServiceController::RestActionsConcern
+      extend ActiveSupport::Concern
+
+      included do
+        include ActionController::MimeResponds
+
+        unless respond_to?(:respond_to)
+          raise "undefined method `respond_to' for #{self.name}: If you are running Rails > 4 you may need to add the responders gem to your Gemfile."
+        end
+
+        respond_to :json
+
+        if respond_to?(:before_action)
+          before_action :initialize_service_for_create, only: [:create]
+        else
+          before_filter :initialize_service_for_create, only: [:create]
+        end
+      end
+
+      def create
+        perform
+      end
+
+      private
+
+      def perform
+        @result = execute_service
+        respond_to do |format|
+          if @result.success?
+            before_respond_on_success if respond_to?(:before_respond_on_success, true)
+            format.json { render json: serialize_result(@result), status: :created }
+          else
+            format.json { render json: { errors: serialize_errors(@result.errors) }, status: 422 }
+          end
+        end
+      end
+
+      def execute_service
+        @service.send(execute_method)
+      end
+
+      def execute_method
+        :perform
+      end
+
+      def hashified_params
+        if permitted_params.respond_to?(:to_h)
+          permitted_params.to_h
+        else
+          permitted_params
+        end
+      end
+
+      # Override this method in your child class to manipulate your service before
+      # it performs.
+      #
+      # Example:
+      #     # app/controller/import_services_controller.rb
+      #     class ImportServices < ApplicationServicesController
+      #       #...
+      #       private
+      #
+      #       def initialize_service_for_create
+      #         super
+      #         @service.current_user_id = session['current_user_id']
+      #       end
+      #     end
+      #
+      def initialize_service_for_create
+        @service = service_class.new(hashified_params, service_options)
+      end
+
+      def service_options
+        default_options
+      end
+
+      def default_options
+        { autosave: true }
+      end
+
+      def permitted_params
+        raise "You have to implement permitted_params in #{self.class.name}."
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Rao
+  module Api
+    module ServiceController::SerializationConcern
+      extend ActiveSupport::Concern
+
+      private
+
+      def serialize_result(result)
+        result.as_json
+      end
+
+      def serialize_errors(errors)
+        errors
+      end
+    end
+  end
+end

data/app/concerns/rao/api/service_controller/service_concern.rb

@@ -0,0 +1,18 @@
+module Rao
+  module Api
+    module ServiceController::ServiceConcern
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :service_class
+      end
+
+      def service_class
+        unless self.class.respond_to?(:service_class)
+          raise "undefined method `service_class' for #{self.class.name}: Add a service_class method to your controller. Example: def self.service_class; MyAmazingService; end"
+        end
+        self.class.service_class
+      end
+    end
+  end
+end

data/app/concerns/rao/api/service_controller/service_inflections_concern.rb

@@ -0,0 +1,19 @@
+module Rao
+  module Api
+    module ServiceController::ServiceInflectionsConcern
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :inflections
+      end
+
+      private
+
+      def inflections
+        {
+          service_name: service_class.model_name.human(count: 1)
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Rao
+  module Api
+    module ServiceController
+      class Base < Rao::Api::ServiceController::Configuration.service_controller_base_class_name.constantize
+        include ServiceConcern
+        include RestActionsConcern
+        include SerializationConcern
+        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 ServiceController
+      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-service_controller.rb'
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

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

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

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

data/lib/rao/api/service_controller.rb

@@ -0,0 +1,11 @@
+require "rao/api/service_controller/configuration"
+require "rao/api/service_controller/version"
+require "rao/api/service_controller/engine"
+
+module Rao
+  module Api
+    module ServiceController
+      extend Configuration
+    end
+  end
+end

data/lib/rao-api-service_controller.rb

@@ -0,0 +1 @@
+require "rao/api/service_controller"

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rao-api-service_controller
+version: !ruby/object:Gem::Version
+  version: 0.0.8.pre
+platform: ruby
+authors:
+- Roberto Vasquez Angel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-16 00:00:00.000000000 Z
+dependencies:
+- !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: 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-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'
+description: 
+email:
+- roberto@vasquez-angel.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/concerns/rao/api/service_controller/exception_handling_concern.rb
+- app/concerns/rao/api/service_controller/rest_actions_concern.rb
+- app/concerns/rao/api/service_controller/serialization_concern.rb
+- app/concerns/rao/api/service_controller/service_concern.rb
+- app/concerns/rao/api/service_controller/service_inflections_concern.rb
+- app/controllers/rao/api/service_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-service_controller.rb
+- lib/rao/api/service_controller.rb
+- lib/rao/api/service_controller/configuration.rb
+- lib/rao/api/service_controller/engine.rb
+- lib/rao/api/service_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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: API Services Controller for Ruby on Rails.
+test_files: []