grape-utils 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79b7322f38d4726c6dda0cd99b7571c6029559f1d2e906415d15e7418dbb14ce
-  data.tar.gz: 91682d99f941d9a558170ac0a05723cf10debc0ce0c32df423e02776027b8751
+  metadata.gz: c2ab969a4f83d19b5d05812cef99c2a9142a7b9fe4237831cb651cc6c2a41085
+  data.tar.gz: 315b141c08054cd7bfdef907c7683a7708defbe91d11bc796d19dbc47c3dd5ce
 SHA512:
-  metadata.gz: 960027819b0ea29704faf2c0c96339d3c6c64e00980a258f4beccdb20037cefe9fd07726e05463bba30ac4b385aa3adcba4b6281e6f00214c18f088f7f61266f
-  data.tar.gz: af5c2f21ace9343a42d072f530fd57c8996299f58e4009dc996f26e44e336f5ee34d6526a61990eaf0c6d19c1565410c41d989e275f527e760bd75df8641b170
+  metadata.gz: 38eac86aecde93ae61a04890307e34eb03551b215422921caf21bbade61df0bc6f153c7cc1cf28f512970ae5c4a39cf9664d30d5416dae178ecf862d88a84e3e
+  data.tar.gz: 5d6378df1d33581cf201339ac2c42b5722d8bd3ca730a10049cbe3f5f69d4756c4794191b166382e3fd02b52a5ce845841a713ec05551fc80626e0943ad4b01d

data/Gemfile

@@ -7,6 +7,7 @@ gemspec
 
 gem "rake", "~> 13.0"
 
+gem "airborne"
 gem "rack-test"
 gem "rspec", "~> 3.0"
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape-utils (0.1.2)
+    grape-utils (0.2.0)
       grape
       grape-entity
       grape-kaminari
@@ -14,10 +14,18 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    airborne (0.3.7)
+      activesupport
+      rack
+      rack-test (>= 1.1.0, < 2.0)
+      rest-client (>= 2.0.2, < 3.0)
+      rspec (~> 3.8)
     ast (2.4.2)
     builder (3.2.4)
     concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
     dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
       zeitwerk (~> 2.6)
@@ -45,6 +53,9 @@ GEM
     grape-kaminari (0.4.5)
       grape (>= 1.6.1)
       kaminari-grape
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
@@ -53,12 +64,16 @@ GEM
       grape
       kaminari-core (~> 1.0)
     language_server-protocol (3.17.0.3)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
     minitest (5.20.0)
     multi_json (1.15.0)
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
     mustermann-grape (1.0.2)
       mustermann (>= 1.0.0)
+    netrc (0.11.0)
     parallel (1.23.0)
     parser (3.2.2.4)
       ast (~> 2.4.1)
@@ -72,6 +87,11 @@ GEM
     rainbow (3.1.1)
     rake (13.1.0)
     regexp_parser (2.8.2)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -103,6 +123,9 @@ GEM
     ruby2_keywords (0.0.5)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
     unicode-display_width (2.5.0)
     zeitwerk (2.6.12)
 
@@ -110,6 +133,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  airborne
   grape
   grape-entity
   grape-kaminari

data/README.md

@@ -48,7 +48,7 @@ module AwesomeAPI
     class Foo < Base
 
       resource :foos do
-        mount Grape::Utils::Templates::Index, with: { model: Foo, index: Foo.all, entity: Entities::Foo }
+        mount Grape::Utils::Templates::Index, with: { model: Foo, scope: Foo.all, entity: Entities::Foo }
         mount Grape::Utils::Templates::Show, with: { model: Foo, entity: Entities::Foo }
         mount Grape::Utils::Templates::Create, with: { model: Foo, entity: Entities::Foo}
         mount Grape::Utils::Templates::Update, with: { model: Foo.all, entity: Entities::Foo }

data/lib/grape_utils/helpers.rb

@@ -6,6 +6,11 @@ module Grape
       def permitted_params
         @permitted_params ||= declared(params, include_missing: false)
       end
+
+      def calculate_scope(scope:, model:)
+        initial_scope = scope.is_a?(Proc) ? instance_eval(&scope) : scope
+        initial_scope || model.all
+      end
     end
   end
 end

data/lib/grape_utils/templates/create.rb

@@ -14,8 +14,8 @@ module Grape
                             using: configuration[:entity].documentation
           end
           post do
-            resource = configuration[:model].create!(permitted_params)
-
+            default_params = configuration[:default_params] || {}
+            resource = configuration[:model].create!(default_params.merge(permitted_params))
             present resource, with: configuration[:entity]
           end
         end

data/lib/grape_utils/templates/crud.rb

@@ -7,22 +7,27 @@ module Grape
       class Crud < ::Grape::API
         mounted do
           mount Templates::Index, with: {  model: configuration[:model],
-                                           index: configuration[:index],
+                                           scope: configuration[:scope],
                                            entity: configuration[:entity] }
 
           mount Templates::Create, with: { model: configuration[:model],
+                                           scope: configuration[:scope],
                                            entity: configuration[:entity],
-                                           required_params: configuration[:required_params] }
+                                           required_params: configuration[:required_params],
+                                           default_params: configuration[:default_params] }
 
           mount Templates::Show, with: { model: configuration[:model],
+                                         scope: configuration[:scope],
                                          entity: configuration[:entity],
                                          column_id: configuration[:column_id] }
 
           mount Templates::Update, with: { model: configuration[:model],
+                                           scope: configuration[:scope],
                                            entity: configuration[:entity],
                                            column_id: configuration[:column_id] }
 
           mount Templates::Delete, with: { model: configuration[:model],
+                                           scope: configuration[:scope],
                                            entity: configuration[:entity],
                                            column_id: configuration[:column_id] }
         end

data/lib/grape_utils/templates/delete.rb

@@ -11,7 +11,8 @@ module Grape
           route_param :id, type: String do
             desc "Deletes an instances of #{configuration[:model].name}"
             delete do
-              resource = configuration[:model].find_by!((configuration[:column_id] || :id) => params[:id])
+              scope = calculate_scope(scope: configuration[:scope], model: configuration[:model])
+              resource = scope.find_by!((configuration[:column_id] || :id) => params[:id])
               resource.destroy!
 
               status(204)

data/lib/grape_utils/templates/index.rb

@@ -16,9 +16,7 @@ module Grape
             use :pagination, per_page: 10, max_per_page: 30
           end
           get do
-            index = configuration[:index]
-
-            list = index.is_a?(Proc) ? instance_eval(&index) : index
+            list = calculate_scope(scope: configuration[:scope], model: configuration[:model])
 
             present list, with: configuration[:entity]
           end

data/lib/grape_utils/templates/show.rb

@@ -11,7 +11,8 @@ module Grape
           route_param :id, type: String do
             desc "Details of a #{configuration[:model].name}"
             get do
-              resource = configuration[:model].find_by!((configuration[:column_id] || :id) => params[:id])
+              scope = calculate_scope(scope: configuration[:scope], model: configuration[:model])
+              resource = scope.find_by!((configuration[:column_id] || :id) => params[:id])
               present resource, with: configuration[:entity]
             end
           end

data/lib/grape_utils/templates/update.rb

@@ -14,7 +14,8 @@ module Grape
               requires :none, using: configuration[:entity].documentation
             end
             patch do
-              resource = configuration[:model].find_by!((configuration[:column_id] || :id) => params[:id])
+              scope = configuration[:scope] || configuration[:model]
+              resource = scope.find_by!((configuration[:column_id] || :id) => params[:id])
               resource.update!(permitted_params.except(:id))
 
               present resource, with: configuration[:entity]

data/lib/grape_utils/version.rb

@@ -2,6 +2,6 @@
 
 module Grape
   module Utils
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-utils
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Nix41
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-17 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - acprieto41@gmail.com
 executables: []
@@ -96,7 +96,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- grape-utils.gemspec
+- grape-utils-0.1.2.gem
 - lib/grape-utils.rb
 - lib/grape_utils.rb
 - lib/grape_utils/helpers.rb
@@ -115,7 +115,7 @@ metadata:
   homepage_uri: https://github.com/Nix41/grape-utils
   source_code_uri: https://github.com/Nix41/grape-utils
   changelog_uri: https://github.com/Nix41/grape-utils/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Grape Utils for building APIs
 test_files: []

data/grape-utils.gemspec

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift File.expand_path("lib", __dir__)
-require_relative "lib/grape_utils/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "grape-utils"
-  spec.version = Grape::Utils::VERSION
-  spec.authors = ["Nix41"]
-  spec.email = ["acprieto41@gmail.com"]
-
-  spec.summary = "Grape Utils for building APIs"
-  # spec.description = "TODO: Write a longer description or delete this line."
-  spec.homepage = "https://github.com/Nix41/grape-utils"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/Nix41/grape-utils"
-  spec.metadata["changelog_uri"] = "https://github.com/Nix41/grape-utils/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "grape"
-  spec.add_dependency "grape-entity"
-  spec.add_dependency "grape-kaminari"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end