barebones 1.0.0.0 → 1.0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9de26ec348e44f68db6bcb250cabe0c05a0d57e
-  data.tar.gz: 18b35bd17aa110dc60f465606d1215c692a37186
+  metadata.gz: 6730d84018a95de05e6d6a911df3375a2bfd5d15
+  data.tar.gz: 3b6359919ce2d8c0f28915bf486c057817faabf3
 SHA512:
-  metadata.gz: '01903bbe5d5ede62183242c35ae213c2a311bcd195accf0b2e21894693153cdfcac88fc17688ee6ad7661d5b2c0bba87e5c619ab91f56692fd84bac240fcf5ad'
-  data.tar.gz: d3de2c5ea3ac84b1e8631f4d8e46aea9ea24eb0c2eb9fe61d02005f41914d14c316a064b6b8410bae50bd822ec15a15dc5a6b9d619b1234bca6a430e5818312e
+  metadata.gz: 13fbdf96ed289e8fc4c642ec8cbdec3d2a39bc0fbe63242395dd8bccdcf68a50bd4e225018808a200f783ebca6d3d36b7c2115727a7051ce60e00f1f6d40e00f
+  data.tar.gz: dd3503fd99e785af18e154d4c1b31eaa8dd05505be8bfb1bab82f1c39f8491c65b54b88da66af7f3eb049295d8a14a54846eaf846d2f407113c1b343ba1e08af

data/README.md

@@ -44,7 +44,7 @@ Barebones' [Gemfile](templates/Gemfile.erb) includes various preconfigured gems
 * [Byebug](https://github.com/deivid-rodriguez/byebug) for debugging
 * [Pry Byebug](https://github.com/deivid-rodriguez/pry-byebug) for debugging background jobs
 * [Web Console](https://github.com/rails/web-console) for debugging views
-* [Awesome Print](https://github.com/michaeldv/awesome_print) for pretty printing command line objects
+* [Awesome Print](https://github.com/awesome-print/awesome_print) for pretty printing command line objects
 
 ##Testing
 * [Minitest](https://github.com/blowmage/minitest-rails) for TDD/BDD
@@ -76,4 +76,4 @@ PostgreSQL (9.4) on your local machine.
 Barebones is copyright © 2015-2016 Danny Yu.  
 It is free software, and may be redistributed under the terms specified in the [LICENSE] file.
 
-[LICENSE]: LICENSE
+[LICENSE]: LICENSE

data/barebones.gemspec

@@ -3,7 +3,7 @@ require "date"
 
 Gem::Specification.new do |s|
   s.name        = "barebones"
-  s.version     = "1.0.0.0"
+  s.version     = "1.0.0.1"
   s.date        = Date.today.to_s
   s.licenses    = ['MIT']
   s.summary     = "Rails template generator"

data/lib/barebones/builders/app_builder.rb

@@ -75,9 +75,8 @@ module Barebones
     def create_api_layouts
       empty_directory "app/views/layouts/api/v1"
       template "layout.json.jbuilder", "app/views/layouts/api/v1/application.json.jbuilder"
-      empty_directory "app/views/api/defaults"
-      create_file "app/views/api/defaults/success.json.jbuilder"
-      create_file "app/views/api/defaults/fail.json.jbuilder"
+      empty_directory "app/views/api/v1/defaults"
+      create_file "app/views/api/v1/defaults/default.json.jbuilder"
     end
 
     def customize_secrets

data/templates/Gemfile.erb

@@ -42,6 +42,7 @@ gem "carrierwave"
 gem "resque"
 gem "resque-scheduler"
 gem 'sinatra', github: 'sinatra/sinatra', branch: 'master'
+gem 'rack-protection', github: 'sinatra/rack-protection'
 <% end %>
 
 # Database

data/templates/README.md.erb

@@ -1,18 +1,48 @@
 # <%= app_name.humanize %>
 
-### Getting Started
+## Getting Started
 
-## Setting Up Postgresql
+### Setting Up Postgresql
 `psql`  
-`CREATE ROLE <%= app_name.parameterize.underscore %>_admin`  
+`CREATE ROLE <%= app_name.parameterize.underscore %>_admin;`  
 `ALTER ROLE <%= app_name.parameterize.underscore %>_admin WITH LOGIN CREATEDB REPLICATION SUPERUSER;`  
-`rake db:migrate`  
-`rake db:setup`  
+`\q`  
 
-## Setting Up The Server
+### Installing Dependencies
+
+To run this code, you must have Rails 5.0 and Ruby 2.3.1 installed. Then you just have to run: 
+
+`bundle install`
+
+### Setting Up The Server
 
 `bundle install`  
-`rake db:migrate db:setup`  
+`rake db:setup db:migrate db:seed`  
+
+### Hosts Files
+The API uses a subdomain so if you wish to run this code locally, in your `/etc/hosts` file, you should add:  
+
+```
+127.0.0.1       api.localhost.local
+127.0.0.1       devapi.localhost.local
+```
+
+### Running The Server
+Run `rails s -p [port#]` to start the server.
+
+## The API
+
+All local requests to the API should be done through the subdomain: `http://devapi.localhost.local:{PORT#}/`  
+All API requests default to using an accept header with `application/com.<%= app_name.parameterize.underscore %>_admin.v1` unless otherwise specified.
+
+### Standard Response Structure
+
+The JSON response is modeled after the [JSend](https://labs.omniti.com/labs/jsend) Standard: 
+
+```
+{
+    status : 200,
+    data : {...}
+}
 
-## Running The Server
-Run `rails s -p [port#]` to start the server.
+```

data/templates/api_defaults_concern.rb

@@ -3,25 +3,16 @@ module ApiDefaults
 
  # Default Paths
  API_VIEW_PATH = "api/v1"
- API_DEFAULT_SUCCESS_PATH = "defaults/success"
- API_DEFAULT_FAIL_PATH = "defaults/fail"
-
- # Statuses
- SUCCESS = 200
- INTERNAL_SERVER_ERROR = 500
+ API_DEFAULT_PATH = "defaults/default"
 
   included do
     layout 'api/v1/application'
 
-    def render_api_success(path=ApiDefaults::API_DEFAULT_SUCCESS_PATH)
-      @status = ApiDefaults::SUCCESS
-      return render template: "#{API_VIEW_PATH}/#{path}", status: ApiDefaults::SUCCESS
+    def render_api(status, path=ApiDefaults::API_DEFAULT_PATH)
+      @status = status
+      return render template: "#{API_VIEW_PATH}/#{path}", status: status
     end
 
-    def render_api_fail(path=ApiDefaults::API_DEFAULT_FAIL_PATH)
-      @status = ApiDefaults::INTERNAL_SERVER_ERROR
-      return render template: "#{API_VIEW_PATH}/#{path}", status: ApiDefaults::INTERNAL_SERVER_ERROR
-    end
   end
 
 end

data/templates/configs_controller.rb

@@ -1,5 +1,7 @@
 class Api::V1::ConfigsController < Api::V1::ApplicationController
+
   def ping
-    return render_api_success("configs/ping")
+    return render_api(200, "configs/ping")
   end
+  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barebones
 version: !ruby/object:Gem::Version
-  version: 1.0.0.0
+  version: 1.0.0.1
 platform: ruby
 authors:
 - Danny Yu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2016-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails