grape_resource 0.1.6 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 421577f147eded9d9bbd5d8769e8452465fe3b624a5a10c85f559cae2952cf3c
-  data.tar.gz: 9864559eb19a2c13911ce59d8af68b07456a7354038c28215e37d2e4d2ccf852
+  metadata.gz: 75ab79efc27f78c897e94a94302dfc63d92e3c029df67f7b3d595154707cdd6c
+  data.tar.gz: 45eb79d583d8a11c61406a5e318ce3073777fa06d8452b59cdff0961e40ea934
 SHA512:
-  metadata.gz: 871ae765c5e9c72239083c0ea5313eccc78fc1105b4d457e09c338e9c5cc2aaf3acaa5df75cf898458468bf183345cdcd2c0368e43bd995cefd15a9d9f74746b
-  data.tar.gz: 122872c7877d184d5bf361931b075901eb737363d771d0311ba4f5822f27ae4659e2f08ec8a262f9c0a643902f12d1c0c1deaa0178833b8ded0cc56d7045f2bb
+  metadata.gz: 89390cb279e86b7b62915e4b30d3093f80756646296aa67d3f1e0e6017c29e7bb1642752e1c1d94534a11bbe589f096b28dabb746ac6813e2e4022c0feebc85c
+  data.tar.gz: b4299558cd02dccd560495cadddbf3b5e83ef736d02a3716b5d38a972b05ce71bba951e314e151e3682f1704acf450fe3da614598d88e9ee5e8debb177d32a88

data/Gemfile.lock

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

data/lib/generators/grape_resource/generator_helpers.rb

@@ -76,6 +76,27 @@ module GrapeResource
         File.exist? rspec_file
       end
 
+      def rspec_dummy
+        @dummy = {}
+        editable_attributes.map do |col|
+          @dummy[col.name] = case col.type.underscore
+          when "string"
+            "Example of string"
+          when "text"
+            "Example of text"
+          when "uuid"
+            "e388e513-2510-44d6-9fb3-56411e7ed7f2"
+          when "integer"
+            123
+          when "boolean"
+            1
+          when "date_time"
+            "2019-07-09 04:10:55"
+          end
+        end
+        @dummy
+      end
+
       # Entities
       def entities_exist?
         entity_file = Rails.root.join("app/#{GrapeResource.directory}#{name.underscore.pluralize}/entities/#{name.underscore.singularize}.rb")
@@ -97,7 +118,7 @@ module GrapeResource
       def attributes_for_params
         @entities = {}
         editable_attributes.map do |col|
-          @entities[col.name] = col.type.downcase.in?(["text", "uuid"]) ? "String" : col.type.capitalize
+          @entities[col.name] = col.type.underscore.in?(["text", "uuid"]) ? "String" : col.type.camelize
         end
         @entities
       end

data/lib/generators/grape_resource/namespace_generator.rb

@@ -21,7 +21,7 @@ module GrapeResource
       insert_resources
       insert_into_main unless mounted_routes_exist?
       insert_namespace_entities unless entities_exist?
-      template_rspec unless rspec_exist?
+      template_rspec
       routes_exist? ? insert_namespace_routes : template_namespace_routes
     end
 
@@ -52,7 +52,12 @@ module GrapeResource
       end
 
       def template_rspec
-        template "specs.rb.erb", "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/spec/#{name.underscore.singularize}_spec.rb"
+        check_endpoint_or_method args
+        template "namespace/specs.rb.erb", "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/spec/#{name.underscore.singularize}_spec.rb"
+
+        inside "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/spec/" do
+          gsub_file("#{name.underscore.singularize}_spec.rb", /.*?remove.*\r?\n/, "")
+        end
       end
 
       def insert_namespace_routes

data/lib/generators/grape_resource/rest_generator.rb

@@ -51,7 +51,11 @@ module GrapeResource
       end
 
       def template_rspec
-        template "specs.rb.erb", "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/spec/#{name.underscore.pluralize}_spec.rb"
+        rspec_dummy
+        template "rest/specs.rb.erb", "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/spec/#{name.underscore.pluralize}_spec.rb"
+        inside "app/#{GrapeResource.directory}/#{name.underscore.pluralize}/spec/" do
+          gsub_file("#{name.underscore.pluralize}_spec.rb", /.*?remove.*\r?\n/, "")
+        end
       end
 
       def insert_rest_routes

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

@@ -12,7 +12,7 @@ class <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Re
       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 %>
+      present :<%= name.underscore.pluralize %>, resources, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
     end
 
       <% end %>remove
@@ -23,10 +23,10 @@ class <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Re
     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 %>
+      results = <%= name.camelize.singularize %>.<%= k.downcase %> # Populate this method
       resources = paginate(results)
       present_metas resources
-      present :<%= name.camelize.singularize %>, resources, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
+      present :<%= name.underscore.pluralize %>, resources, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
     end
 
       <% end %>remove
@@ -36,11 +36,11 @@ class <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Re
     # Member method
     desc "Get <%= k.underscore %>"
     params do
-      requires :id, type: String
+      requires :id, type: String, desc: "<%= name.camelize.singularize %> ID"
     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 %>
+      present :<%= name.underscore.pluralize %>, results, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
     end
 
       <% end %>remove
@@ -52,7 +52,7 @@ class <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Re
       # 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 %>
+      # present :<%= name.underscore.pluralize %>, results, with: <%= GrapeResource.class_name_prefix %>::<%= name.capitalize.singularize %>::Entities::<%= name.capitalize.singularize %>
     end
 
       <% end %>remove
@@ -66,7 +66,7 @@ class <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Re
     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 %>
+      # present :<%= name.underscore.pluralize %>, results, with: <%= GrapeResource.class_name_prefix %>::<%= name.capitalize.singularize %>::Entities::<%= name.capitalize.singularize %>
     end
     
       <% end %>remove

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

@@ -0,0 +1,133 @@
+require 'rails_helper'
+
+RSpec.describe "API::V1::<%= @name_of_class.camelize.pluralize %>::Resource::<%= @name_of_class.camelize.singularize %>", type: :request do
+  let(:<%= @name_of_class.underscore.singularize %>) {FactoryBot.create :<%= @name_of_class.underscore.singularize %>}
+
+  <% if @post.present? %>remove
+    <% @post.each do |k, v| %>remove
+  # Post method
+  describe "[POST] <%= k %>" do
+    it "success" do
+      post "/v1/<%= @name_of_class.underscore.singularize %>/<%= k %>"
+      expect(response.status).to eq(201)
+    end
+  end
+    <% end %>remove
+  <% end %>remove
+
+  <% if @put.present? %>remove
+    <% @put.each do |k, v| %>remove
+  # Put method
+  describe "[PUT] <%= k %>" do
+    it "success" do
+      obj = FactoryBot.create :<%= @name_of_class.underscore.singularize %>
+      put "/v1/<%= @name_of_class.underscore.singularize %>/#{obj.id}/<%= k %>",
+      params: {
+        id: obj.id
+      }
+      expect(response.status).to eq(200)
+    end
+  end
+    <% end %>remove
+  <% end %>remove
+
+  <% if @delete.present? %>remove
+    <% @delete.each do |k, v| %>remove
+  # Delete method
+  describe "[DELETE] <%= k %>" do
+    it "success" do
+      obj = FactoryBot.create :<%= @name_of_class.underscore.singularize %>
+      delete "/v1/<%= @name_of_class.underscore.singularize %>/#{obj.id}/<%= k %>",
+      params: {
+        id: obj.id
+      }
+      expect(response.status).to eq(200)
+    end
+  end
+    <% end %>remove
+  <% end %>remove
+  
+  <% if @collection.any? %>remove
+    <% @collection.each do |k, v| %>remove
+  # Collection method
+  describe "[GET] <%= k %>" do
+    it "success" do
+      get "/v1/<%= @name_of_class.underscore.singularize %>/<%= k %>"
+      expect(response.status).to eq(500) # Make sure your endpoint is working and you can change this status to 200
+    end
+  end
+    <% end %>remove
+  <% end %>remove
+
+  <% if @member.any? %>remove
+    <% @member.each do |k, v| %>remove
+  # Member method
+  describe "[GET] <%= k.underscore.pluralize %>" do
+    it "success" do
+      get "/v1/<%= @name_of_class.underscore.singularize %>/#{<%= @name_of_class.underscore.singularize %>.id}/<%= k %>"
+      expect(response.status).to eq(200)
+    end
+  end
+    <% end %>remove
+  <% end %>remove
+
+  <% if @default_endpoint.present? %>remove
+  <% @default_endpoint.each do |endpoint| %>remove
+  # Default method
+  describe "[GET] <%= endpoint %>" do
+    before do
+      5.times do
+        FactoryBot.create :<%= @name_of_class.underscore.singularize %>
+      end
+    end
+    it "success" do
+      get "/v1/<%= @name_of_class.underscore.singularize %>/<%= endpoint %>"
+      expect(response.status).to eq(200)
+      expect(json_response[:data][:<%= @name_of_class.underscore.pluralize %>].size).to eq(5)
+    end
+  end
+
+  describe "Pagination" do
+    before do
+      8.times do
+        FactoryBot.create :<%= @name_of_class.underscore.singularize %>
+      end
+      5.times do
+        FactoryBot.create :<%= @name_of_class.underscore.singularize %>
+      end
+    end
+    it "Paginate page 1" do
+      get "/v1/<%= @name_of_class.underscore.singularize %>/<%= endpoint %>",
+        params: {page: 1, per_page: 5}
+      expect(response.status).to eq(200)
+      expect(json_response[:data][:<%= @name_of_class.underscore.pluralize %>].size).to eq(5)
+      expect(json_response[:data][:meta][:pages][:total]).to eq(5)
+      expect(json_response[:data][:meta][:pages][:page]).to eq(1)
+      expect(json_response[:data][:meta][:pages][:per_page]).to eq(5)
+    end
+
+    it "Paginate page 2" do
+      get "/v1/<%= @name_of_class.underscore.singularize %>/<%= endpoint %>",
+        params: {page: 2, per_page: 5}
+      expect(response.status).to eq(200)
+      expect(json_response[:data][:<%= @name_of_class.underscore.pluralize %>].size).to eq(5)
+      expect(json_response[:data][:meta][:pages][:total]).to eq(5)
+      expect(json_response[:data][:meta][:pages][:page]).to eq(2)
+      expect(json_response[:data][:meta][:pages][:per_page]).to eq(5)
+    end
+
+    it "Paginate page 3" do
+      get "/v1/<%= @name_of_class.underscore.singularize %>/<%= endpoint %>",
+        params: {page: 3, per_page: 5}
+      expect(response.status).to eq(200)
+      expect(json_response[:data][:<%= @name_of_class.underscore.pluralize %>].size).to eq(3)
+      expect(json_response[:data][:meta][:pages][:total]).to eq(3)
+      expect(json_response[:data][:meta][:pages][:page]).to eq(3)
+      expect(json_response[:data][:meta][:pages][:per_page]).to eq(5)
+    end
+
+  end
+  <% end %>remove
+  <% end %>remove
+
+end

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

@@ -9,7 +9,7 @@ class <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Re
       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 %>
+      present :<%= name.underscore.pluralize %>, resources, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
     end
 
     desc "Get <%= name.underscore.singularize %> by id"
@@ -18,7 +18,7 @@ class <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Re
     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 %>
+      present :<%= name.underscore.singularize %>, results, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
     end
 
     desc "Create"
@@ -31,7 +31,7 @@ class <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Re
       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 %>
+      present :<%= name.underscore.singularize %>, p, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
     end
 
     desc "Update"
@@ -44,7 +44,7 @@ class <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Re
     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 %>
+      present :<%= name.underscore.singularize %>, p, with: <%= GrapeResource.class_name_prefix %>::<%= name.camelize.pluralize %>::Entities::<%= name.camelize.singularize %>
     end
 
     desc "Delete"

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

@@ -0,0 +1,116 @@
+require 'rails_helper'
+
+RSpec.describe "API::V1::<%= @name_of_class.camelize.pluralize %>::Resource::<%= @name_of_class.camelize.pluralize %>", type: :request do
+  
+  describe "Create" do
+    it "success" do
+      post "/v1/<%= @name_of_class.underscore.pluralize %>",
+        params: {
+        <% @dummy.each do |k, v| %>remove
+          <% if v.class.name.underscore.in?(["integer", "boolean"]) %>remove
+          <%= k %>: <%= v %>,
+          <% else %>remove
+          <%= k %>: "<%= v %>",
+          <% end %>remove
+        <% end %>remove
+        }
+      expect(response.status).to eq(201)
+    end
+  end
+
+  describe "Update" do
+    it "success" do
+      obj = FactoryBot.create :<%= @name_of_class.underscore.singularize %>
+      put "/v1/<%= @name_of_class.underscore.pluralize %>",
+        params: {
+          id: obj.id,
+        <% @dummy.each do |k, v| %>remove
+          <% if v.class.name.underscore.in?(["integer", "boolean"]) %>remove
+          <%= k %>: <%= v %>,
+          <% else %>remove
+          <%= k %>: "<%= v %>",
+          <% end %>remove
+        <% end %>remove
+        }
+      expect(response.status).to eq(200)
+    end
+  end
+
+  describe "Delete" do
+    it "success" do
+      obj = FactoryBot.create :<%= @name_of_class.underscore.singularize %>
+      delete "/v1/<%= @name_of_class.underscore.pluralize %>", 
+        params: {
+          id: obj.id
+        }
+      expect(response.status).to eq(200)
+      expect(json_response[:data][:status]).to eq("Success deleted data with id #{obj.id}")
+    end
+  end
+
+  describe "[GET] <%= @name_of_class.camelize.singularize %> by ID" do
+    it "success" do
+      obj = FactoryBot.create :<%= @name_of_class.underscore.singularize %>
+      get "/v1/<%= @name_of_class.underscore.pluralize %>/#{obj.id}",
+        params: {
+          id: obj.id
+        }
+      expect(response.status).to eq(200)
+    end
+  end
+
+  describe "[GET] All <%= @name_of_class.camelize.pluralize %>" do
+    before do
+      5.times do
+        FactoryBot.create :<%= @name_of_class.underscore.singularize %>
+      end
+    end
+    it "Get <%= @name_of_class.underscore.pluralize %>" do
+      get "/v1/<%= @name_of_class.underscore.pluralize %>"
+      expect(response.status).to eq(200)
+      expect(json_response[:data][:<%= @name_of_class.underscore.pluralize %>].size).to eq(5)
+    end
+  end
+
+  describe "Pagination" do
+    before do
+      8.times do
+        FactoryBot.create :<%= @name_of_class.underscore.singularize %>
+      end
+      5.times do
+        FactoryBot.create :<%= @name_of_class.underscore.singularize %>
+      end
+    end
+    it "Paginate page 1" do
+      get "/v1/<%= @name_of_class.underscore.pluralize %>",
+        params: {page: 1, per_page: 5}
+      expect(response.status).to eq(200)
+      expect(json_response[:data][:<%= @name_of_class.underscore.pluralize %>].size).to eq(5)
+      expect(json_response[:data][:meta][:pages][:total]).to eq(5)
+      expect(json_response[:data][:meta][:pages][:page]).to eq(1)
+      expect(json_response[:data][:meta][:pages][:per_page]).to eq(5)
+    end
+
+    it "Paginate page 2" do
+      get "/v1/<%= @name_of_class.underscore.pluralize %>",
+        params: {page: 2, per_page: 5}
+      expect(response.status).to eq(200)
+      expect(json_response[:data][:<%= @name_of_class.underscore.pluralize %>].size).to eq(5)
+      expect(json_response[:data][:meta][:pages][:total]).to eq(5)
+      expect(json_response[:data][:meta][:pages][:page]).to eq(2)
+      expect(json_response[:data][:meta][:pages][:per_page]).to eq(5)
+    end
+
+    it "Paginate page 3" do
+      get "/v1/<%= @name_of_class.underscore.pluralize %>",
+        params: {page: 3, per_page: 5}
+      expect(response.status).to eq(200)
+      expect(json_response[:data][:<%= @name_of_class.underscore.pluralize %>].size).to eq(3)
+      expect(json_response[:data][:meta][:pages][:total]).to eq(3)
+      expect(json_response[:data][:meta][:pages][:page]).to eq(3)
+      expect(json_response[:data][:meta][:pages][:per_page]).to eq(5)
+    end
+
+  end
+
+end

data/lib/grape_resource/version.rb

@@ -1,3 +1,3 @@
 module GrapeResource
-  VERSION = "0.1.6"
+  VERSION = "0.1.10"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape_resource
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.10
 platform: ruby
 authors:
 - Yunan Helmy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,9 +95,10 @@ files:
 - lib/generators/templates/entities.rb.erb
 - lib/generators/templates/initializer.rb
 - lib/generators/templates/namespace/namespace_endpoint.rb.erb
+- lib/generators/templates/namespace/specs.rb.erb
 - lib/generators/templates/rest/rest_endpoint.rb.erb
+- lib/generators/templates/rest/specs.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

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

@@ -1,3 +0,0 @@
-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