rails_base_api_scaffold 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c38e6bc51f540f22efd5882a5fb4a95554da5413
+  data.tar.gz: 29e0fd7eb9891501824db16ae222ac0b5ab8ff1b
+SHA512:
+  metadata.gz: 4f2ee067976ae6d80a6a751da5a1a31fc433807356c9ce918e23960f61b34d35749cfe2de7423de888b5d034d429458d98d147a185f1857a2d36a1170b098a2b
+  data.tar.gz: 878346c6ff445be1f3ee8abe7450e6cac5e587e8c9ad273eae1bf1946540f3ea1240e6185c09f1aae32b7c5ba2a79f61b31c2bba279b17854afd4cc1efec5332

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails_base_api_scaffold.gemspec
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+# RailsBaseApiScaffold
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_base_api_scaffold`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_base_api_scaffold'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_base_api_scaffold
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_base_api_scaffold.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_base_api_scaffold"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/rails_base_api_scaffold/controller_generator.rb

@@ -0,0 +1,37 @@
+require 'generators/rails_base_api_scaffold/generator_helpers'
+
+module RailsBaseApiScaffold
+  module Generators
+    # Custom scaffolding generator
+    class ControllerGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+      include RailsBaseApiScaffold::Generators::GeneratorHelpers
+  
+      desc "Generates controller, controller_spec and views for the model with the given NAME."
+      
+      source_root File.expand_path('../templates', __FILE__)
+      
+      def copy_templates
+        template "controller.rb", File.join("app/controllers/api/v1", "#{controller_file_name}_controller.rb")
+        template "serializer.rb", File.join("app/serializers", "#{file_name}_serializer.rb")
+        template "spec.rb", File.join("spec/requests/api/v1", "#{controller_file_name}_controller_spec.rb")
+      end
+      
+      def add_routes
+        # Include tabs and line break for proper formatting
+        routes_string = "      resources :#{plural_name}\n"
+        # Inject into file following the api and v1 namespaces
+        inject_into_file 'config/routes.rb', after: "  namespace :api do\n    namespace :v1 do\n" do
+          routes_string
+        end
+      end
+
+      def add_scoped_search
+        scoped_search_string = "  scoped_search on: [ :id, :created_at, :updated_at ], only_explicit: true\n"
+        inject_into_file "app/models/#{file_name}.rb", after: "class #{class_name} < ActiveRecord::Base\n" do
+          scoped_search_string
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails_base_api_scaffold/generator_helpers.rb

@@ -0,0 +1,42 @@
+module RailsBaseApiScaffold
+  module Generators
+    # Some helpers for generating scaffolding
+    module GeneratorHelpers
+      attr_accessor :options, :attributes
+
+      private
+
+      def model_columns_for_attributes
+        class_name.constantize.columns.reject do |column|
+          column.name.to_s =~ /^(id|user_id|created_at|updated_at)$/
+        end
+      end
+
+      def editable_attributes
+        attributes ||= model_columns_for_attributes.map do |column|
+          Rails::Generators::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
+        end
+      end
+
+      def mock_editable_attribute_key
+        attribute = editable_attributes.first
+        attribute.name
+      end
+
+      def mock_editable_attribute_value
+        attribute = editable_attributes.first
+        attribute.type == 'string' ? '"Test"' :
+          attribute.type == 'text' ? '"Test"' :
+          attribute.type == 'integer' ? 1 :
+          attribute.type == 'float' ? 1.25 :
+          attribute.type == 'decimal' ? 1.50 :
+          attribute.type == 'datetime' ? '2017-12-27 00:00:00' :
+          attribute.type == 'time' ? '00:00:00' :
+          attribute.type == 'date' ? '2017-12-27' :
+          attribute.type == 'binary' ? '"Test"' :
+          attribute.type == 'boolean' ? true :
+          nil
+      end
+    end
+  end
+end

data/lib/generators/rails_base_api_scaffold/templates/controller.rb

@@ -0,0 +1,90 @@
+module Api::V1
+    class <%= controller_class_name %>Controller < ApiController
+      respond_to :json
+  
+      check_authorization
+  
+      before_action :doorkeeper_authorize!
+  
+      skip_before_filter :verify_authenticity_token
+  
+      load_and_authorize_resource
+  
+      helper_method :sort_order, :sort_column, :sort_direction
+  
+      # GET /<%= plural_name %>/
+      def index
+  
+        page_size = params[:page_size] ? params[:page_size].to_i : 20
+  
+        raise RangeError.new("invalid page_size: #{page_size}") if page_size < 1
+  
+        @<%= plural_name %> = <%= class_name %>.search_for(params[:search], order: sort_order).paginate(page: params[:page], per_page: page_size)
+  
+        page_counts = @<%= plural_name %>.total_entries.divmod(page_size)
+        page_count = page_counts[0] + ((page_counts[1] > 0) ? 1 : 0)
+  
+        render json: @<%= plural_name %>,
+               root: '<%= plural_name %>',
+               meta: { page_count: page_count, page_size: page_size }, adapter: :json
+  
+      end
+  
+      # GET /<%= plural_name %>/1
+      def show
+        render json: @<%= singular_name %>, serializer: <%= class_name %>Serializer, root: false
+      end
+  
+      # POST /<%= plural_name %>/1
+      def create
+        @<%= singular_name %> = <%= class_name %>.create(<%= singular_name %>_params)
+
+        if @<%= singular_name %>
+          render json: @<%= singular_name %>, serializer: <%= class_name %>Serializer, status: :created
+        else
+          render json: @<%= singular_name %>.errors, status: :unprocessable_entity
+        end
+      end
+  
+      # PUT /<%= plural_name %>/1
+      def update
+        if <%= singular_name %>.update(<%= singular_name %>_params)
+          render json: <%= singular_name %>, serializer: <%= class_name %>Serializer, status: :ok
+        else
+          render json: <%= singular_name %>.errors, status: :unprocessable_entity
+        end
+      end
+  
+      # DELETE /<%= plural_name %>/1
+      def destroy
+        <%= singular_name %>.destroy
+        render json: { message: '<%= human_name %> deleted' }
+      end
+  
+      private
+
+      # Use callbacks to share common setup or constraints between actions.
+      def <%= singular_name %>
+        @<%= singular_name %> ||= <%= class_name %>.find(params[:id])
+      end
+  
+      # Add index sorting by default.
+      def sort_order
+        sort_column + ' ' + sort_direction
+      end
+  
+      def sort_column
+        <%= class_name %>.column_names.include?(params[:sort]) ? params[:sort] : 'created_at'
+      end
+  
+      def sort_direction
+        %w[asc desc].include?(params[:direction]) ? params[:direction] : 'desc'
+      end
+  
+      # Only allow a trusted parameter "white list" through.
+      def <%= singular_name %>_params
+        params.require(:<%= singular_name %>).permit([<%= editable_attributes.map { |a| ":#{a.name}" }.join(', ') %>])
+      end
+    end
+  end
+  

data/lib/generators/rails_base_api_scaffold/templates/serializer.rb

@@ -0,0 +1,3 @@
+class <%= class_name %>Serializer < ActiveModel::Serializer
+  attributes :id, <%= editable_attributes.map { |a| ":#{a.name}" }.join(', ') %>
+end

data/lib/generators/rails_base_api_scaffold/templates/spec.rb

@@ -0,0 +1,120 @@
+require 'rails_helper'
+
+RSpec.describe '<%= controller_class_name %>Controller', :type => :request do
+  describe 'GET /<%= plural_name %>' do
+
+    context 'user is not created' do
+      it 'returns a 401 if user is not authenticated' do
+        response = oauth_get api_v1_<%= plural_name %>_path
+        expect(response.status).to eq 401
+      end
+    end
+
+    context 'user created' do
+      before(:each) do
+        @user = create(:admin)
+        prepare_user_oauth @user
+      end
+
+      it 'returns a list of <%= plural_name %>' do
+        <%= singular_name %> = create(:<%= singular_name %>)
+
+        response = oauth_get api_v1_<%= plural_name %>_path, { page_size: 10 }
+        expect(response.status).to eq 200
+
+        json_response = JSON.parse response.body
+
+        expect(json_response['<%= plural_name %>']).to_not be_empty
+        expect(json_response['<%= plural_name %>'].length).to eq 1
+      end
+    end
+  end
+
+  describe 'POST /<%= plural_name %>' do
+    context 'user is not created' do
+      it 'returns a 401 if user is not authenticated' do
+        posted_data = {
+          <%= mock_editable_attribute_key %>: <%= mock_editable_attribute_value %>
+        }
+        response = oauth_post api_v1_<%= plural_name %>_path, { <%= singular_name %>: posted_data }
+        expect(response.status).to eq 401
+      end
+    end
+
+    context 'user created' do
+      it 'creates a <%= singular_name %> for authenticated user' do
+        user = create(:admin)
+        prepare_user_oauth user
+
+        posted_data = {
+          <%= mock_editable_attribute_key %>: <%= mock_editable_attribute_value %>
+        }
+
+        response = oauth_post api_v1_<%= plural_name %>_path, { <%= singular_name %>: posted_data }
+        expect(response.status).to eq 201
+
+        json_response = JSON.parse response.body
+
+        expect(json_response['id']).to be_a Numeric
+        expect(json_response['<%= mock_editable_attribute_key %>']).to eq <%= mock_editable_attribute_value %>
+      end
+    end
+  end
+
+  describe 'PUT /<%= plural_name %>/:id' do
+    context 'user is not created' do
+      it 'returns a 401 if user is not authenticated' do
+        <%= singular_name %> = create(:<%= singular_name %>)
+        response = oauth_put api_v1_<%= singular_name %>_path(<%= singular_name %>)
+        expect(response.status).to eq 401
+      end
+    end
+
+    context 'user created' do
+      it 'updates a <%= singular_name %> for authenticated user' do
+        user = create(:admin)
+        <%= singular_name %> = create(:<%= singular_name %>)
+
+        prepare_user_oauth user
+
+        posted_data =  {
+          <%= mock_editable_attribute_key %>: <%= mock_editable_attribute_value %>
+        }
+
+        response = oauth_put api_v1_<%= singular_name %>_path(<%= singular_name %>), { <%= singular_name %>: posted_data }
+        expect(response.status).to eq 200
+
+        json_response = JSON.parse response.body
+
+        expect(json_response['id']).to eq <%= singular_name %>.id
+        expect(json_response['<%= mock_editable_attribute_key %>']).to eq <%= mock_editable_attribute_value %>
+      end
+    end
+  end
+
+  describe 'DELETE /<%= plural_name %>/:id' do
+    context 'user is not created' do
+      it 'returns a 401 if user is not authenticated' do
+        <%= singular_name %> = create(:<%= singular_name %>)
+        response = oauth_del api_v1_<%= singular_name %>_path(<%= singular_name %>)
+        expect(response.status).to eq 401
+      end
+    end
+
+    context 'user created' do
+      it 'updates a <%= singular_name %> for authenticated user' do
+        user = create(:admin)
+        <%= singular_name %> = create(:<%= singular_name %>)
+
+        prepare_user_oauth user
+
+        response = oauth_del api_v1_<%= singular_name %>_path(<%= singular_name %>)
+        expect(response.status).to eq 200
+
+        json_response = JSON.parse response.body
+
+        expect(json_response['message']).to eq '<%= human_name %> deleted'
+      end
+    end
+  end
+end

data/lib/rails_base_api_scaffold/version.rb

@@ -0,0 +1,3 @@
+module RailsBaseApiScaffold
+  VERSION = "0.1.0"
+end

data/lib/rails_base_api_scaffold.rb

@@ -0,0 +1,5 @@
+require "rails_base_api_scaffold/version"
+
+module RailsBaseApiScaffold
+  # Your code goes here...
+end

data/rails_base_api_scaffold.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_base_api_scaffold/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_base_api_scaffold"
+  spec.version       = RailsBaseApiScaffold::VERSION
+  spec.authors       = ["Christian McCormick"]
+  spec.email         = ["cmccormick421@gmail.com"]
+
+  spec.summary       = "Scaffold for the E7Systems Rails Base API"
+  spec.homepage      = "https://github.com/christianmccormick/rails_base_api_scaffold"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rails_base_api_scaffold
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian McCormick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- cmccormick421@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/rails_base_api_scaffold/controller_generator.rb
+- lib/generators/rails_base_api_scaffold/generator_helpers.rb
+- lib/generators/rails_base_api_scaffold/templates/controller.rb
+- lib/generators/rails_base_api_scaffold/templates/serializer.rb
+- lib/generators/rails_base_api_scaffold/templates/spec.rb
+- lib/rails_base_api_scaffold.rb
+- lib/rails_base_api_scaffold/version.rb
+- rails_base_api_scaffold.gemspec
+homepage: https://github.com/christianmccormick/rails_base_api_scaffold
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Scaffold for the E7Systems Rails Base API
+test_files: []