grape_resource 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5785fa70d230cc60d30b9697296ccd0cb5a1a0ee43258345c3ba5eef5a5e9878
-  data.tar.gz: 14adaeb5c8107575411ac066e1e983f4ba1db57804268c671a9ae26a042f61f9
+  metadata.gz: 18a0f9753a02d378d8f4f1cd7ccddb48952958b56a7bfef8526b2bc8e528d337
+  data.tar.gz: a2e8531e0149e10b7864fa5aad490f10c8f399df7c13d3bf313eac6a4d7b8d85
 SHA512:
-  metadata.gz: 655a039abb684839b9ad128d75c153e3a8116141456a6aa1ae39146c40f650dd8f41eb5bb19f1c3833c0731d332661530b4c2207bf001534b7cbca785b485de1
-  data.tar.gz: caa522101776ec36d70f574c84bd7318320605c59cde01cb951bb8da39bf6997c4357c3afb022bd0a147fc7f9fbb935b02ec80e7d95ab0b29e8613a9d98a0965
+  metadata.gz: f9a52aa191ddab0b319284b0028c8f381015ec2dfed5d8c4d36070972451422882897e32eab10e9b1bbe8a6c5092148070467b29a252b077afbba3e864302738
+  data.tar.gz: 126ba5569261901342908c42066b86b89d8358fa0fb81b3e1159f20ce4baca8de3a6ac475fb315cf18a6b32ca281f926bc79e514b588c49b4dc1ddca1bc55986

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape_resource (0.1.0)
+    grape_resource (0.1.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -40,6 +40,9 @@ Modify GrapeResource configuration inside `config/initializers/grape_resource.rb
 
 1. `config.directory` will be your endpoint directory. Default to : `controllers/API/v1/`
 2. `config.class_name_prefix` will be your class name prefix for your endpoint. Default to : `API::V1`
+3. `config.entry_point_routes` will be your entry point for your routes. Default to : `# Routes entry point`
+4. `config.success_formatter` will be your success formatter. Default to : `formatter :json, ::API::SuccessFormatter`
+5. `config.error_formatter` will be your error formatter. Default to : `error_formatter :json, ::API::ErrorFormatter`
 
 ### Generator
 
@@ -47,6 +50,10 @@ To generate REST API :
 
     $ rails g grape_resource:rest class_name
 
+Example :
+
+    $ rails g grape_resource:rest article
+
 This will give you :
 
 1. GET /
@@ -57,7 +64,11 @@ This will give you :
 
 To generate namespaced API :  
     
-    $ rails g grape_resource:namespace namespace api_endpoint1 api_endpoint2:method 
+    $ rails g grape_resource:namespace namespace api_endpoint1 api_endpoint2:method
+
+Example :  
+    
+    $ rails g grape_resource:namespace article popular like:post similar:get:member trending:get:collection
 
 While method is one of :
 

data/lib/generators/grape_resource/generator_helpers.rb

@@ -0,0 +1,105 @@
+module GrapeResource
+  module GeneratorHelpers
+    attr_accessor :attributes
+
+    private
+      def check_endpoint_or_method(args)
+        @default_endpoint, custom, custom2 = [], [], []
+        args.each do |arg|
+          case arg.split(":").length
+          when 1
+            @default_endpoint << arg
+          when 2
+            custom << arg.split(":")
+          else
+            if arg.split(":")[1] == "get"
+              custom2 << arg.split(":")
+            end
+          end
+        end
+        @default_endpoint
+        @custom_endpoint, @custom_endpoint2 = custom.to_h, custom2
+        collection_or_member
+        get_endpoint_and_method_name
+      end
+
+      def collection_or_member
+        collection, member = [], []
+        @custom_endpoint2.each do |c2|
+          collection << c2.take(2) if c2.last == "collection"
+          member << c2.take(2) if c2.last == "member"
+        end
+        @collection, @member = collection.to_h, member.to_h
+      end
+
+      def get_endpoint_and_method_name
+        @put, @post, @delete = {}, {}, {}
+        @custom_endpoint.each do |k, v|
+          @put[k] = v if v == "put"
+          @post[k] = v if v == "post"
+          @delete[k] = v if v == "delete"
+        end
+      end
+
+      def generator_type class_name
+        @name_of_class = class_name == "rest" ? name.camelize.pluralize : name.camelize.singularize
+        @name_of_class
+      end
+
+      # Routes
+      def routes_exist?
+        @routes_file = Rails.root.join("app/#{GrapeResource.directory}#{name.underscore.pluralize}/routes.rb")
+        File.exist? @routes_file
+      end
+
+      def mount_code_exist?
+        string = "        mount #{GrapeResource.class_name_prefix}::#{name.camelize.pluralize}::Resources::#{@name_of_class}\n"
+        File.read(@routes_file).each_line do |line|
+          return true if line == string
+        end
+        return false
+      end
+
+      # Main
+      def mounted_routes_exist?
+        @main_file = Rails.root.join("app/#{GrapeResource.directory}main.rb")
+        string = "      mount API::V1::#{name.camelize.pluralize}::Routes\n"
+        File.read(@main_file).each_line do |line|
+          return true if line == string
+        end
+        return false
+      end
+
+      # Specs
+      def rspec_exist?
+        rspec_file = Rails.root.join("app/#{GrapeResource.directory}#{name.underscore.pluralize}/spec/#{@name_of_class.underscore}_spec.rb")
+        File.exist? rspec_file
+      end
+
+      # Entities
+      def entities_exist?
+        entity_file = Rails.root.join("app/#{GrapeResource.directory}#{name.underscore.pluralize}/entities/#{name.underscore.singularize}.rb")
+        File.exist? entity_file
+      end
+
+      def model_columns_for_attributes
+        name.classify.constantize.columns.reject do |column|
+          column.name.to_s =~ /^(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 attributes_for_params
+        @entities = {}
+        editable_attributes.map do |col|
+          @entities[col.name] = col.type.downcase == "text" || "uuid" ? "String" : col.type.capitalize
+        end
+        @entities
+      end
+  end
+end

data/lib/generators/grape_resource/install_generator.rb

@@ -5,5 +5,10 @@ module GrapeResource
     def copy_initializer
       template "initializer.rb", "config/initializers/grape_resource.rb"
     end
+
+    def insert_entry_point
+      insert_into_file "app/#{GrapeResource.directory}/main.rb", "\n\n      #{GrapeResource.entry_point_routes} -- DONT REMOVE THIS LINE", after: "      mount API::V1::Info::Routes"
+    end
+
   end
 end

data/lib/generators/grape_resource/namespace_generator.rb

@@ -0,0 +1,67 @@
+require "generators/grape_resource/generator_helpers.rb"
+
+module GrapeResource
+  class NamespaceGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../../templates", __FILE__)
+    include GrapeResource::GeneratorHelpers
+
+    def generate
+      unless Object.const_defined?(name.classify)
+        say
+        say
+        say "You need to generate model", :red
+        say
+        say "Example :"
+        say "  rails g model #{name.classify} attr1 attr2", :green
+        say
+        return
+      end
+
+      generator_type "namespace"
+      insert_resources
+      insert_into_main unless mounted_routes_exist?
+      insert_namespace_entities unless entities_exist?
+      template_rspec unless rspec_exist?
+      routes_exist? ? insert_namespace_routes : template_namespace_routes
+    end
+
+    private
+      def insert_resources
+        check_endpoint_or_method args
+        attributes_for_params
+
+        template "namespace/namespace_endpoint.rb.erb", "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/resources/#{name.underscore.singularize}.rb"
+
+        inside "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/resources/" do
+          gsub_file("#{name.underscore.singularize}.rb", /.*?remove.*\r?\n/, "")
+        end
+      end
+
+      def insert_into_main
+        insert_into_file "app/#{GrapeResource.directory}/main.rb", "      mount API::V1::#{name.camelize.pluralize}::Routes\n", before: "      #{GrapeResource.entry_point_routes} -- DONT REMOVE THIS LINE"
+      end
+
+      def insert_namespace_entities
+        attributes_for_params
+
+        template "entities.rb.erb", "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/entities/#{name.underscore.singularize}.rb"
+
+        inside "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/entities/" do
+          gsub_file("#{name.underscore.singularize}.rb", /.*?remove.*\r?\n/, "")
+        end
+      end
+
+      def template_rspec
+        template "specs.rb.erb", "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/spec/#{name.underscore.singularize}_spec.rb"
+      end
+
+      def insert_namespace_routes
+        insert_into_file "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/routes.rb", "        mount #{GrapeResource.class_name_prefix}::#{name.camelize.pluralize}::Resources::#{name.camelize.singularize}\n", before: "        #{GrapeResource.entry_point_routes} -- DONT REMOVE THIS LINE\n" unless mount_code_exist?
+      end
+      
+      def template_namespace_routes
+        template "routes.rb.erb", "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/routes.rb"
+      end
+
+  end
+end

data/lib/generators/grape_resource/rest_generator.rb

@@ -0,0 +1,66 @@
+require "generators/grape_resource/generator_helpers.rb"
+
+module GrapeResource
+  class RestGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../../templates", __FILE__)
+    include GrapeResource::GeneratorHelpers
+
+    def run_me
+      unless Object.const_defined?(name.classify)
+        say
+        say
+        say "You need to generate model", :red
+        say
+        say "Example :"
+        say "  rails g model #{name.classify} attr1 attr2", :green
+        say
+        return
+      end
+
+      generator_type "rest"
+      create_rest_endpoint
+      insert_into_main unless mounted_routes_exist?
+      insert_rest_entities unless entities_exist?
+      template_rspec unless rspec_exist?
+      routes_exist? ? insert_rest_routes : template_rest_routes
+    end
+
+    private
+      def create_rest_endpoint
+        attributes_for_params
+
+        template "rest/rest_endpoint.rb.erb", "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/resources/#{name.underscore.pluralize}.rb"
+
+        inside "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/resources/" do
+          gsub_file("#{name.underscore.pluralize}.rb", /.*?remove.*\r?\n/, "")
+        end
+      end
+
+      def insert_into_main
+        insert_into_file "app/#{GrapeResource.directory}/main.rb", "      mount API::V1::#{name.camelize.pluralize}::Routes\n", before: "      #{GrapeResource.entry_point_routes} -- DONT REMOVE THIS LINE"
+      end
+
+      def insert_rest_entities
+        attributes_for_params
+
+        template "entities.rb.erb", "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/entities/#{name.underscore.singularize}.rb"
+
+        inside "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/entities/" do
+          gsub_file("#{name.underscore.singularize}.rb", /.*?remove.*\r?\n/, "")
+        end
+      end
+
+      def template_rspec
+        template "specs.rb.erb", "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/spec/#{name.underscore.pluralize}_spec.rb"
+      end
+
+      def insert_rest_routes
+        insert_into_file "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/routes.rb", "        mount #{GrapeResource.class_name_prefix}::#{name.camelize.pluralize}::Resources::#{name.camelize.pluralize}\n", before: "        #{GrapeResource.entry_point_routes} -- DONT REMOVE THIS LINE\n" unless mount_code_exist?
+      end
+      
+      def template_rest_routes
+        template "routes.rb.erb", "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/routes.rb"
+      end
+
+  end
+end

data/lib/generators/templates/entities.rb.erb

@@ -0,0 +1,6 @@
+class <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %> < Grape::Entity
+  expose :id
+remove<% @entities.each do |k, v| %>
+  expose :<%= k %>
+remove<% end %>
+end

data/lib/generators/templates/initializer.rb

@@ -4,4 +4,11 @@ GrapeResource.setup do |config|
 
   # Class name prefix
   config.class_name_prefix = "API::V1"
-end
+
+  # Entry point routes
+  config.entry_point_routes = "# Routes entry point"
+
+  # Formatter
+  config.success_formatter = "formatter :json, ::API::SuccessFormatter"
+  config.error_formatter = "error_formatter :json, ::API::ErrorFormatter"
+end

data/lib/generators/templates/namespace/namespace_endpoint.rb.erb

@@ -0,0 +1,91 @@
+class <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Resources::<%= name.camelize.singularize %> < <%= GrapeResource.class_name_prefix %>::ApiResource
+  helpers <%= GrapeResource.class_name_prefix %>::Helpers
+
+  resource "<%= name.underscore.singularize %>" do
+
+    <% if @default_endpoint.present? %>remove
+      <% @default_endpoint.each do |endpoint_name| %>remove
+    # Default Collection method
+    desc "Get <%= endpoint_name.underscore %>"
+    paginate per_page: Pagy::VARS[:items], max_per_page: Pagy::VARS[:max_per_page]
+    get "/<%= endpoint_name %>" do
+      results = <%= name.camelize.singularize %>.all
+      resources = paginate(results)
+      present_metas resources
+      present :<%= name.camelize.singularize %>, resources, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
+    end
+
+      <% end %>remove
+    <% end %>remove
+    <% if @collection.any? %>remove
+      <% @collection.each do |k, v| %>remove
+    # Collection method
+    desc "Get <%= k.underscore %>"
+    paginate per_page: Pagy::VARS[:items], max_per_page: Pagy::VARS[:max_per_page]
+    get "/<%= k.downcase %>" do
+      results = <%= name.camelize.singularize %>.<%= k.downcase %>
+      resources = paginate(results)
+      present_metas resources
+      present :<%= name.camelize.singularize %>, resources, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
+    end
+
+      <% end %>remove
+    <% end %>remove
+    <% if @member.any? %>remove
+      <% @member.each do |k, v| %>remove
+    # Member method
+    desc "Get <%= k.underscore %>"
+    params do
+      requires :id, type: String
+    end
+    get "/:id/<%= k.downcase %>" do
+      results = <%= name.camelize.singularize %>.find(params.id)
+      present :<%= name.camelize.singularize %>, results, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
+    end
+
+      <% end %>remove
+    <% end %>remove
+    <% if @post.present? %>remove
+      <% @post.each do |k, v| %>remove
+    desc "Create"
+    params do
+      # requires :your_params, type: [eg: String, Integer, Array]
+    end
+    post "/<%= k.downcase %>" do
+      # present :<%= name.capitalize.singularize %>, results, with: <%= GrapeResource.class_name_prefix %>::<%= name.capitalize.singularize %>::Entities::<%= name.capitalize.singularize %>
+    end
+
+      <% end %>remove
+    <% end %>remove
+    <% if @put.present? %>remove
+      <% @put.each do |k, v| %>remove
+    desc "Update"
+    params do
+      requires :id, type: String
+      # requires :your_params, type: [eg: String, Integer, Array]
+    end
+    put "/:id/<%= k.downcase %>" do
+      error!("Can't find id #{params.id}", 422) unless <%= name.capitalize.singularize %>.all.pluck(:id).include?(params.id)
+      # present :<%= name.capitalize.singularize %>, results, with: <%= GrapeResource.class_name_prefix %>::<%= name.capitalize.singularize %>::Entities::<%= name.capitalize.singularize %>
+    end
+    
+      <% end %>remove
+    <% end %>remove
+    <% if @delete.present? %>remove
+      <% @delete.each do |k, v| %>remove
+    desc "Delete"
+    params do
+      requires :id, type: String
+    end
+    delete "/:id/<%= k.downcase %>" do
+      error!("Can't find id #{params.id}", 422) unless <%= name.camelize.singularize %>.all.pluck(:id).include?(params.id)
+      q = <%= name.camelize.singularize %>.find params.id
+      q.destroy!
+      success = "success deleted data with id #{params.id}"
+      present :status, success
+    end
+      <% end %>remove
+    <% end %>remove
+  end
+
+end

data/lib/generators/templates/rest/rest_endpoint.rb.erb

@@ -0,0 +1,69 @@
+class <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Resources::<%= name.camelize.pluralize %> < <%= GrapeResource.class_name_prefix %>::ApiResource
+  helpers <%= GrapeResource.class_name_prefix %>::Helpers
+
+  resource "<%= name.underscore.pluralize %>" do
+
+    desc "Get all <%= name.underscore.pluralize %>"
+    paginate per_page: Pagy::VARS[:items], max_per_page: Pagy::VARS[:max_per_page]
+    get "/" do
+      results = <%= name.camelize.singularize %>.all
+      resources = paginate(results)
+      present_metas resources
+      present :<%= name.underscore %>, resources, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
+    end
+
+    desc "Get <%= name.underscore.singularize %> by id"
+    params do
+      requires :id, type: String
+    end
+    get "/:id" do
+      results = <%= name.camelize.singularize %>.find(params.id)
+      present :<%= name.underscore %>, results, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
+    end
+
+    desc "Create"
+    params do
+      <% @entities.each do |k, v| %>remove
+      optional :<%= k %>, type: <%= v %>
+      <% end %>remove
+    end
+    post "/" do
+      p = <%= name.camelize.singularize %>.new <%= name.underscore.singularize %>_params
+      results = p.save!
+      present :status, results
+      present :<%= name.underscore %>, p, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
+    end
+
+    desc "Update"
+    params do
+      requires :id, type: String
+      <% @entities.each do |k, v| %>remove
+      optional :<%= k %>, type: <%= v %>
+      <% end %>remove
+    end
+    put "/" do
+      p = <%= name.camelize.singularize %>.find(params.id)
+      p.update <%= name.underscore.singularize %>_params
+      present :<%= name.underscore %>, p, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
+    end
+
+    desc "Delete"
+    params do
+      requires :id, type: String
+    end
+    delete "/" do
+      q = <%= name.camelize.singularize %>.find params.id
+      q.destroy!
+      success = "Success deleted data with id #{params.id}"
+      present :status, success
+    end
+
+  end
+
+  helpers do
+    def <%= name.underscore.singularize %>_params
+      ActionController::Parameters.new(params).permit(<%= @entities.keys.map { |a| a.to_sym } %>)
+    end
+  end
+
+end

data/lib/generators/templates/routes.rb.erb

@@ -0,0 +1,14 @@
+module API
+  module V1
+    module <%= name.camelize.pluralize %>
+      class Routes < Grape::API
+        # Format response
+        <%= GrapeResource.success_formatter %>
+        <%= GrapeResource.error_formatter %>
+
+        mount <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Resources::<%= @name_of_class %>
+        <%= GrapeResource.entry_point_routes %> -- DONT REMOVE THIS LINE
+      end
+    end
+  end
+end

data/lib/generators/templates/specs.rb.erb

@@ -0,0 +1,3 @@
+RSpec.describe "<%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Resource::<%= @name_of_class %>", type: :request do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/grape_resource.rb

@@ -8,4 +8,7 @@ module GrapeResource
 
   define_setting :directory, "controllers/API/v1/"
   define_setting :class_name_prefix, "API::V1"
+  define_setting :entry_point_routes, "# Routes entry point"
+  define_setting :success_formatter, "formatter :json, ::API::SuccessFormatter"
+  define_setting :error_formatter, "error_formatter :json, ::API::ErrorFormatter"
 end

data/lib/grape_resource/version.rb

@@ -1,3 +1,3 @@
 module GrapeResource
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape_resource
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Yunan Helmy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,8 +88,16 @@ files:
 - bin/console
 - bin/setup
 - grape_resource.gemspec
+- lib/generators/grape_resource/generator_helpers.rb
 - lib/generators/grape_resource/install_generator.rb
+- lib/generators/grape_resource/namespace_generator.rb
+- lib/generators/grape_resource/rest_generator.rb
+- lib/generators/templates/entities.rb.erb
 - lib/generators/templates/initializer.rb
+- lib/generators/templates/namespace/namespace_endpoint.rb.erb
+- lib/generators/templates/rest/rest_endpoint.rb.erb
+- lib/generators/templates/routes.rb.erb
+- lib/generators/templates/specs.rb.erb
 - lib/grape_resource.rb
 - lib/grape_resource/configuration.rb
 - lib/grape_resource/version.rb