hoc_utils 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37c0907c531c99595c93af77a2265257d24390b5
+  data.tar.gz: a282780241a4d3b2accffcc5446adc6cb02f7ccf
+SHA512:
+  metadata.gz: 2494e4a797cceeaf9de3f621fb362915a95a89498d5ad920b21f5823bf50bd49c8642e1bd9aa5feb1aa4928fd7bbb9642c73176db880c3d602d2ab5da2a351fc
+  data.tar.gz: 018d8ddf9283f118b16430c97512af321b0e0448b1cd45a6d1b89d1ef4ee591d0914c3d62e07392d35d4a15052ebc2440236b4686d5b9677a92adecc31b3ae60

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 hoc_utils.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Gert Lavsen
+
+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,27 @@
+# HocUtils
+
+This is a collection of utilities for a HoC API application
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hoc_utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hoc_utils
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hoc_utils.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hoc_utils"
+
+# 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/hoc_utils.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hoc_utils/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hoc_utils"
+  spec.version       = HocUtils::VERSION
+  spec.authors       = ["Gert Lavsen"]
+  spec.email         = ["gert@houseofcode.io"]
+
+  spec.summary       = "Collection of utilities for the House of Code API project"
+  spec.description   = "Collection of utilities for the House of Code API project"
+  spec.homepage      = "https://github.com/house-of-code/hoc_utils"
+  spec.license       = "MIT"
+
+  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 "rails-rspec"
+  spec.add_development_dependency "trestle"
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/generators/hoc_utils/api_scaffold/USAGE

@@ -0,0 +1,13 @@
+Description:
+    This generator can scaffold a model, api controller, admin controller and stubs for api specification in swagger format
+
+Example:
+    rails generate hoc_utils:api_scaffold NAME field[:type][:index] field[:type][:index] --api_version=v2
+
+    This will create:
+        A model: /app/models/name.rb
+        A migration for model
+        A controller: /app/controllers/api/v2/names_controller.rb
+        Routes for api_controller
+        A administration controller: /app/admin/names_admin.rb
+        Swagger documentation stubs: /spec/integration/names_spec.rb

data/lib/generators/hoc_utils/api_scaffold/api_scaffold_generator.rb

@@ -0,0 +1,99 @@
+
+require 'rails/generators/resource_helpers'
+require "rails/generators/model_helpers"
+
+module HocUtils
+  module Generators
+    class ApiScaffoldGenerator < Rails::Generators::NamedBase
+
+      include Rails::Generators::ModelHelpers
+      include Rails::Generators::ResourceHelpers
+
+      desc "Generate a model with api controller and optional administration interface and routes for api controller"
+      argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+
+      class_option :admin, type: :boolean, default: true, desc: "Generate administration interface"
+      class_option :routes, type: :boolean, default: true, desc: "Generate routes"
+      class_option :api_version, type: :string, default: "v1", desc: "Version of namespace"
+
+      source_root File.expand_path('templates', __dir__)
+
+
+      def api_version
+        options.api_version.downcase
+      end
+
+      # Generates the model and the migration. Overrides the model definition to add acts_as_api block
+      def generate_model
+        say "Generates app/models/#{singular_table_name}.rb", :bold
+        invoke :model
+        inject_into_class "app/models/#{singular_table_name}.rb", singular_table_name.camelize do
+<<-ACTS
+
+  acts_as_api
+  api_accessible :basic do |t|
+  #{attributes_names.map { |name| "\tt.add :#{name}" }.join("\n")}
+    t.add :created_at
+    t.add :updated_at
+  end
+
+ACTS
+        end
+      end
+
+      # Scaffolds the api controller
+      def generate_api_controller
+        say "Generates app/controllers/api/#{api_version}/#{plural_table_name}_controller.rb", :bold
+        template "api_controller.rb.tt", "app/controllers/api/#{api_version}/#{plural_table_name}_controller.rb"
+      end
+
+      # Generates routes in config/routes.rb. Will namespace resources to api/[api_version].
+      def generate_routes
+        return unless options.routes?
+        say "Generates routes. You may want to merge api/#{api_version} namespaces in config/routes.rb", :bold
+        generate "resource_route api/#{api_version.downcase}/#{plural_table_name}"
+      end
+
+      # Generates spec stubs for swagger.
+      def generate_specs
+        say "Generates spec/integration/#{plural_table_name}_spec.rb", :bold
+        template "spec.rb.tt", "spec/integration/#{plural_table_name}_spec.rb"
+        say "Adds definitions to spec/swagger_helper.rb", :bold
+        insert_into_file "spec/swagger_helper.rb", :after => "definitions: {\n" do
+          %{
+          # AUTO GENERATED STUB TODO: update with correct fields
+          #{singular_table_name}_input: {
+            description: 'TODO: replace with correct description',
+            type: 'object',
+            properties: {
+
+            },
+            required: [] #TODO require
+          },
+          # AUTO GENERATED STUB TODO: update with correct fields
+          #{singular_table_name}: {
+            description: 'TODO: replace with correct description',
+            type: 'object',
+            properties: {
+              id: { type: "integer"},
+              created_at: { type: "string"},
+              updated_at: { type: "string"},
+            }
+          },
+        }
+        end
+      end
+
+      # Generates admin controllers in app/admin
+      def generate_admin_controllers
+        return unless options.admin?
+        say "Generates app/admin/#{plural_table_name}_admin.rb", :bold
+        generate "trestle:resource #{singular_table_name}"
+      end
+
+      def migrate
+        rails_command 'db:migrate'
+      end
+    end
+  end
+end

data/lib/generators/hoc_utils/api_scaffold/templates/api_controller.rb.tt

@@ -0,0 +1,52 @@
+class Api::<%= api_version.upcase %>::<%= plural_table_name.camelize %>Controller < Api::<%= api_version.upcase %>::ApiController
+
+  before_action :set_<%= singular_table_name %>, only: [:show, :update, :destroy]
+
+  # GET /api/<%= api_version %><%= route_url %>
+  def index
+    @<%= plural_table_name %> = <%= class_name %>.all
+    render_result({ <%= plural_table_name %>: @<%= plural_table_name %>.as_api_response(:basic) })
+  end
+
+  # GET /api/<%= api_version %><%= route_url %>/1
+  def show
+    render_result(@<%= singular_table_name %>.as_api_response(:basic))
+  end
+
+  # POST /api/<%= api_version %><%= route_url %>
+  def create
+    @<%= "#{singular_table_name} = #{class_name}.new(#{singular_table_name}_params)" %>
+
+    if @<%= singular_table_name %>
+      render_result(@<%= singular_table_name %>.as_api_response(:basic), :created)
+    else
+      render_error(@<%= singular_table_name %>.errors.full_messages.first, :unprocessable_entity)
+    end
+  end
+
+  # PATCH/PUT /api/<%= api_version %><%= route_url %>/1
+  def update
+    if @<%= singular_table_name %>.update(<%= singular_table_name %>_params)
+      render_result(@<%= singular_table_name %>.as_api_response(:basic))
+    else
+      render_error(@<%= singular_table_name %>.errors.full_messages.first, :unprocessable_entity)
+    end
+  end
+
+  # DELETE /api/<%= api_version %><%= route_url %>/1
+  def destroy
+    @<%= singular_table_name %>.destroy
+  end
+
+  private
+
+  # Use callbacks to share common setup or constraints between actions.
+  def set_<%= singular_table_name %>
+    @<%= singular_table_name %> = <%= class_name %>.find(params[:id])
+  end
+
+  # Only allow a trusted parameter "white list" through.
+  def <%= "#{singular_table_name}_params" %>
+    params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+  end
+end

data/lib/generators/hoc_utils/api_scaffold/templates/spec.rb.tt

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+require 'swagger_helper'
+describe 'House of Code API' do
+  path '/api/<%= "#{api_version}/#{plural_table_name}" %>' do
+    get 'Get <%= plural_table_name %>' do
+      tags '<%= plural_table_name.camelize %>'
+      description 'Gets <%= plural_table_name %>'
+      produces 'application/json'
+      consumes 'application/json'
+      parameter name: :Authorization, in: :header, required: true, type: :string
+      response '200', '<%= plural_table_name.camelize %>' do
+        schema '$ref' => '#/definitions/<%= plural_table_name %>'
+        run_test!
+      end
+      response '401', 'Not authorized' do
+        schema '$ref' => '#/definitions/error'
+        run_test!
+      end
+    end
+
+    post 'creates a profile' do
+      tags '<%= singular_table_name.camelize %>'
+      description 'Creates <%= singular_table_name %> with given input'
+      produces 'application/json'
+      consumes 'application/json'
+      parameter name: :<%= singular_table_name %>, in: :body, schema: {
+        '$ref' => '#/definitions/<%= singular_table_name %>_input'
+      }
+
+      response '201', '<%= singular_table_name.camelize %> created' do
+        schema '$ref' => '#/definitions/<%= singular_table_name %>'
+        run_test!
+      end
+      response '401', 'Not authorized' do
+        schema '$ref' => '#/definitions/error'
+        run_test!
+      end
+    end
+  end
+
+  path '/api/<%= "#{api_version}/#{plural_table_name}" %>/{id}' do
+    get 'Get <%= singular_table_name %>' do
+      tags '<%= plural_table_name %>'
+      description 'Gets <%= singular_table_name %> with :id'
+      produces 'application/json'
+      consumes 'application/json'
+      parameter name: :id, in: :path, type: :integer
+      parameter name: :Authorization, in: :header, required: true, type: :string
+      response '200', '<%= singular_table_name.camelize %>' do
+        schema '$ref' => '#/definitions/<%= singular_table_name %>'
+        run_test!
+      end
+      response '401', 'Not authorized' do
+        schema '$ref' => '#/definitions/error'
+        run_test!
+      end
+    end
+
+    put 'Update <%= singular_table_name %>' do
+      tags '<%= plural_table_name %>'
+      description 'Updates <%= singular_table_name %> with :id'
+      produces 'application/json'
+      consumes 'application/json'
+      parameter name: :id, in: :path, type: :integer
+      parameter name: :Authorization, in: :header, required: true, type: :string
+      response '200', '<%= singular_table_name.camelize %>' do
+        schema '$ref' => '#/definitions/<%= singular_table_name %>_input'
+        run_test!
+      end
+      response '401', 'Not authorized' do
+        schema '$ref' => '#/definitions/error'
+        run_test!
+      end
+    end
+
+    delete 'Delete <%= singular_table_name %> with :id' do
+      tags '<%= plural_table_name %>'
+      description 'Deletes <%= singular_table_name %> with :id'
+      produces 'application/json'
+      consumes 'application/json'
+      parameter name: :Authorization, in: :header, required: true, type: :string
+      response '200', '<%= singular_table_name.camelize %> deleted' do
+        run_test!
+      end
+      response '401', 'Not authorized' do
+        schema '$ref' => '#/definitions/error'
+        run_test!
+      end
+    end
+  end
+end

data/lib/hoc_utils/version.rb

@@ -0,0 +1,3 @@
+module HocUtils
+  VERSION = "0.1.1"
+end

data/lib/hoc_utils.rb

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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: hoc_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Gert Lavsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails-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: trestle
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !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'
+description: Collection of utilities for the House of Code API project
+email:
+- gert@houseofcode.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hoc_utils.gemspec
+- lib/generators/hoc_utils/api_scaffold/USAGE
+- lib/generators/hoc_utils/api_scaffold/api_scaffold_generator.rb
+- lib/generators/hoc_utils/api_scaffold/templates/api_controller.rb.tt
+- lib/generators/hoc_utils/api_scaffold/templates/spec.rb.tt
+- lib/hoc_utils.rb
+- lib/hoc_utils/version.rb
+homepage: https://github.com/house-of-code/hoc_utils
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Collection of utilities for the House of Code API project
+test_files: []