potassium 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcdad6cfdd3e777734516b13ef96ea0b82fa9248
-  data.tar.gz: 175a6c80dd6d5b9b23966ae5141025d585249bd2
+  metadata.gz: 7fd59590a454f141e47a7b05b95fc2d5f65b1090
+  data.tar.gz: b11f7656978a084f13d54b9c106fd7a7505ffbf7
 SHA512:
-  metadata.gz: a19c13e40895153c58d8d8d5c9a3b80311219b9af995059d5ac98deb25167d9152acc8abaa470ffaf7fd062613a8c384b568c883939a206319a8036c47010991
-  data.tar.gz: 37644a3e7167d7e43d0f310d05dccf9705304a09d121d04880d2dd6b4f1458d76900019bbd87fade6106018ae00947dd86df210e31c5feeb4a0a8ae3bd0d8216
+  metadata.gz: 813d08a035604474ff85f3c7e5bcd927dd3f29ac5425b021c64680b1cd301bed27cd4574164ddb8895eeba79b5693ebbf548d4273a3d0203c92d7e488b6657ab
+  data.tar.gz: a821c3bd515630a6d284b5578bc3a252bb6a47830e9ed49ac3e7b9f0f8b1bb572f1214363bfd80b39a1ad4be7d1ee60f6bbcd7f3fafdc241d514dc00d45750bb

data/.editorconfig

@@ -0,0 +1,24 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.js]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

data/CHANGELOG.md

@@ -32,5 +32,17 @@ Refactor:
 
 ## 1.2.2
 
-Fix:
+Bugfixes:
   - Multiple changes to make it work correctly within rubygems.
+
+## 1.2.3
+
+Bugfixes:
+  - Fix database name to use when dashes are present.
+
+Features:
+  - Added optional API support that includes the following:
+    - A concern that offer standard responses to common errors.
+    - Versionist Support.
+    - `simple_token_authentication`, `active_model_serializers` and `responders` gem.
+    - A default responder for API common behavior.

data/lib/potassium/templates/application/assets/.rbenv-vars.example

@@ -1,4 +1,4 @@
-DB_NAME=<%= @app_name.downcase %>
+DB_NAME=<%= get(:underscorized_app_name) %>
 DB_USER=root
 DB_PASSWORD=
 DEFAULT_EMAIL_ADDRESS=

data/lib/potassium/templates/application/assets/api/api_error_concern.rb

@@ -0,0 +1,40 @@
+module ApiErrorConcern
+  extend ActiveSupport::Concern
+
+  included do
+    rescue_from "Exception" do |exc|
+      logger.error exc.message
+      logger.error exc.backtrace.join("\n")
+      api_respond_error(:internal_server_error, {
+        msg: "server_error",
+        type: exc.class.to_s,
+        detail: exc.message
+      })
+    end
+
+    rescue_from "ActiveRecord::RecordNotFound" do |exc|
+      api_respond_error(:not_found, {
+        msg: "record_not_found",
+        detail: exc.message
+      })
+    end
+
+    rescue_from "ActiveModel::ForbiddenAttributesError" do |exc|
+      api_respond_error(:bad_request, {
+        msg: "protected_attributes",
+        detail: exc.message
+      })
+    end
+
+    rescue_from "ActiveRecord::RecordInvalid" do |exc|
+      api_respond_error(:bad_request, {
+        msg: "invalid_attributes",
+        errors: exc.record.errors
+      })
+    end
+  end
+
+  def api_respond_error(_status, _error_obj = {})
+    render json: _error_obj, status: _status
+  end
+end

data/lib/potassium/templates/application/assets/api/base_controller.rb

@@ -0,0 +1,6 @@
+class Api::V1::BaseController < ApplicationController
+  include ApiErrorConcern
+  self.responder = ApiResponder
+
+  respond_to :json
+end

data/lib/potassium/templates/application/assets/api/responder.rb

@@ -0,0 +1,41 @@
+class ApiResponder < ActionController::Responder
+  def respond
+    return display_errors if has_errors?
+    return head :no_content if delete?
+
+    display resource, :status_code => status_code
+  end
+
+  private
+
+  def display(resource, given_options = {})
+    controller.render options.merge(given_options).merge({
+      :json => serializer.as_json
+    })
+  end
+
+  def serializer
+    serializer_class = ActiveModel::Serializer.serializer_for(resource)
+    if serializer_class.present?
+      serializer_class.new(resource, options)
+    else
+      resource
+    end
+  end
+
+  def status_code
+    return :created if post?
+    return :ok
+  end
+
+  def display_errors
+    controller.render({
+      :status => :unprocessable_entity,
+      :json => { msg: "invalid_attributes", errors: format_errors }
+    })
+  end
+
+  def format_errors
+    resource.errors.as_json
+  end
+end

data/lib/potassium/templates/application/recipes/api.rb

@@ -0,0 +1,22 @@
+if get(:api_support)
+  gather_gem 'versionist'
+  gather_gem 'responders'
+  gather_gem 'active_model_serializers', '~> 0.9.3'
+  gather_gem 'simple_token_authentication', '~> 1.0'
+
+  after(:gem_install) do
+    line = "Rails.application.routes.draw do\n"
+    insert_into_file "config/routes.rb", after: line do
+      <<-HERE.gsub(/^ {7}/, '')
+        scope path: '/api' do
+          api_version(:module => "Api::V1", :path => {:value => "v1"}) do
+          end
+        end
+      HERE
+    end
+
+    copy_file 'assets/api/base_controller.rb', 'app/controllers/api/v1/base_controller.rb'
+    copy_file 'assets/api/api_error_concern.rb', 'app/controllers/concerns/api_error_concern.rb'
+    copy_file 'assets/api/responder.rb', 'app/responders/api_responder.rb'
+  end
+end

data/lib/potassium/templates/application/recipes/asks/api.rb

@@ -0,0 +1,2 @@
+api_support = Ask.confirm "Do you want to enable API support?"
+set(:api_support, api_support)

data/lib/potassium/templates/application/template.rb

@@ -19,6 +19,7 @@ run_action(:asking) do
   eval_file "recipes/asks/admin.rb"
   eval_file "recipes/asks/pundit.rb"
   eval_file "recipes/asks/lang.rb"
+  eval_file "recipes/asks/api.rb"
 end
 
 run_action(:recipe_loading) do
@@ -38,6 +39,7 @@ run_action(:recipe_loading) do
   eval_file "recipes/testing.rb"
   eval_file "recipes/production.rb"
   eval_file "recipes/git.rb"
+  eval_file "recipes/api.rb"
 end
 
 say "Gathered enough information. Applying the template. Wait a minute.", :green

data/lib/potassium/version.rb

@@ -1,3 +1,3 @@
 module Potassium
-  VERSION = "1.2.2"
+  VERSION = "1.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: potassium
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - juliogarciag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .editorconfig
 - .gitignore
 - CHANGELOG.md
 - Gemfile
@@ -107,6 +108,9 @@ files:
 - lib/potassium/templates/application/assets/active_admin/active_admin.js.coffee
 - lib/potassium/templates/application/assets/active_admin/init_activeadmin_angular.rb
 - lib/potassium/templates/application/assets/active_admin/pundit_page_policy.rb
+- lib/potassium/templates/application/assets/api/api_error_concern.rb
+- lib/potassium/templates/application/assets/api/base_controller.rb
+- lib/potassium/templates/application/assets/api/responder.rb
 - lib/potassium/templates/application/assets/bower.json
 - lib/potassium/templates/application/assets/config/database_mysql.yml
 - lib/potassium/templates/application/assets/config/database_postgresql.yml
@@ -122,7 +126,9 @@ files:
 - lib/potassium/templates/application/helpers/variable-helpers.rb
 - lib/potassium/templates/application/recipes/admin.rb
 - lib/potassium/templates/application/recipes/angular_admin.rb
+- lib/potassium/templates/application/recipes/api.rb
 - lib/potassium/templates/application/recipes/asks/admin.rb
+- lib/potassium/templates/application/recipes/asks/api.rb
 - lib/potassium/templates/application/recipes/asks/database.rb
 - lib/potassium/templates/application/recipes/asks/devise.rb
 - lib/potassium/templates/application/recipes/asks/lang.rb