stockpot 0.3.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2ed98e155357c764f537d390bdf41db905bb5231e33bb7644639c1f309fde33
-  data.tar.gz: 0cd8008bef691299dc4c2e50343ef9d98002b9857703ca4f9a1cee55f2eed556
+  metadata.gz: e055ab2e9c7448a3a876f2dd91b92abf07f85a934f58a1a06cc1b142fa9a716f
+  data.tar.gz: 7fcbed7483835ad4add9288eaf4a6aa93c608829c24b7a762d71d52ff444cd39
 SHA512:
-  metadata.gz: 00e9c0c1eea751c8f01bdb925592f904a578dea35aa0430278bd93ec7923c564cd7d787499fb8ce77feb07b7f1aad78d67a68884974640b532428ac381e4aa4b
-  data.tar.gz: e66ffa80fc4138ca3b01e86ab4012043d7909f9735e877d4cc2391f63e34a2b1de066761eb61cea0e19e134f30165584a2d845f8f65e62653479416783407b78
+  metadata.gz: f0057713be313d5d886eb72fbb211e7b1dc9b33e79299fc9c2b58330767f328beac1bac27f35f150f864f0076ca86a448a00f79ae744e16de079005c1ecc71cd
+  data.tar.gz: 32a2c201e11616b21bcf4bb9ff61a54d53a9f6bfa1724b62ff970bd97bbf3847b3e5244751623599074d8a2493b000e2b30dd7a3fcd9088044aa68afcd3b60c3

data/README.md

@@ -79,7 +79,7 @@ Query for data. Accepts a array of objects that require at least a model name, b
 
 #### POST
 
-Create new data. Accepts an object specifying a single model with additional qualifiers.
+Create new data. Accepts an an array of objects specifying a single model with additional qualifiers.
 
 * factory (required) - Specify which factory to create a record with.
 * list (optional) - Specify a count of items to create, default: 1
@@ -87,7 +87,7 @@ Create new data. Accepts an object specifying a single model with additional qua
 * attributes (optional) - An array of objects allowing for the specification of data to be used when creating records. Array position matches with list order if multiple records are desired.
 
 ```javascript
-{
+[{
   factory: "user",
   traits: ["having_address"],
   attributes: [{
@@ -96,7 +96,7 @@ Create new data. Accepts an object specifying a single model with additional qua
     first_name: "Foo",
     last_name: "Bar"
   }]
-}
+}]
 ```
 
 #### DELETE
@@ -129,7 +129,7 @@ Clears Rails & Redis caches and truncates Active Records databases. No body requ
 ### `/stockpot/redis`
 
 #### GET
-  
+
 Query for data. Accepts key or field to use to search cache for record.
 
 ```javascript
@@ -139,6 +139,10 @@ Query for data. Accepts key or field to use to search cache for record.
 }
 ```
 
+#### GET - Keys
+
+Query for all keys within data. No body or argument required.
+
 #### POST - Create new data
 
 Accepts an object specifying a key, field, and value to be inserted into Redis cache.
@@ -168,7 +172,7 @@ Cypress.Commands.add("getRecords", args => {
 ```
 
 Our tests can then call this command like this
-  
+
 ```javascript
 cy.getRecords([{ model: "user", id: user.id }])
   .then(res => {

data/app/controllers/stockpot/database_cleaner_controller.rb

@@ -1,29 +1,25 @@
 # frozen_string_literal: true
 
-require "database_cleaner"
-
 module Stockpot
   class DatabaseCleanerController < MainController
     # Clean database before, between, and after tests by clearing Rails
     # and REDIS caches and truncating the active record database.
     def index
-      clear_cache
-      clean_active_record
+      clear_cache_and_redis
+      clean_database
       render json: { status: 204 }
     end
 
     private
 
-    def clear_cache
-      DatabaseCleaner[:redis].clean_with(:truncation)
-      REDIS.flushdb
+    def clear_cache_and_redis
+      DatabaseCleaner[:redis].clean_with(:deletion)
       Rails.cache.clear
       Timecop.return
     end
 
-    def clean_active_record
+    def clean_database
       DatabaseCleaner[:active_record].clean_with(:truncation)
-      DatabaseCleaner.clean_with(:truncation)
     end
   end
 end

data/app/controllers/stockpot/healthz_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Stockpot
   class HealthzController < MainController
     def index

data/app/controllers/stockpot/helper/errors.rb

@@ -1,25 +1,29 @@
 # frozen_string_literal: true
+
+require "pg"
+require "active_record"
+
 module Stockpot
   module Helper
     module Errors
       def rescue_error(error)
-        logger = Logger.new(STDERR)
+        logger = Logger.new($stderr)
         logger.warn(error)
 
         case error
         when NameError
-          return_error(error.to_s, error.backtrace.first(5), :bad_request)
+          return_error(error.message, :bad_request, error.backtrace.first(5))
         when PG::Error
-          return_error("Postgres error: #{error}", error.backtrace.first(5), :server_error)
-        when ActiveRecord::RecordInvalid, ActiveRecord::Validations
-          return_error("ActiveRecord error: #{error}", error.backtrace.first(5), :server_error)
+          return_error("Postgres error: #{error.message}", :internal_server_error, error.backtrace.first(5))
+        when ActiveRecord::RecordInvalid, ActiveRecord::Validations, ActiveRecord::RecordNotDestroyed
+          return_error(%q(In "#{error.record.class}" class: "#{error.message}"), :expectation_failed, error.backtrace.first(5))
         else
-          return_error(error.to_s, error.backtrace.first(5),:server_error)
+          return_error(error.message, :internal_server_error, error.backtrace.first(5))
         end
       end
 
-      def return_error(message, backtrace, status)
-        { json: { error: { status: status, backtrace: backtrace, message: message }}, status: status }
+      def return_error(message, status, backtrace = "No backtrace")
+        render json: { error: { status: status, backtrace: backtrace, message: message }}, status: status
       end
     end
   end

data/app/controllers/stockpot/main_controller.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
+
 module Stockpot
   class MainController < ActionController::API
     include ActiveSupport::Rescuable
     include Helper::Errors
 
     rescue_from StandardError do |exception|
-      render rescue_error(exception)
+      rescue_error(exception)
     end
-    # protect_from_forgery with: :exception
   end
 end

data/app/controllers/stockpot/records_controller.rb

@@ -1,67 +1,96 @@
 # frozen_string_literal: true
+
 require "factory_bot_rails"
+require "active_record/transactions"
 
 module Stockpot
   class RecordsController < MainController
     include ActiveSupport::Inflector
     include ActiveRecord::Transactions
+    include Helper::Errors
 
     before_action only: %i[index destroy update] do
-      return_error("You need to provide at least one model name as an argument", 400) if params.dig(:models).blank?
+      return_error("You need to provide at least one model name as an argument", 400) if params[:models].blank?
     end
     before_action only: %i[create] do
-      return_error("You need to provide at least one factory name as an argument", 400) if params.dig(:factory).blank?
+      return_error("You need to provide at least one factory name as an argument", 400) if params[:factories].blank?
+    end
+    before_action do
+      @response_data = {}
     end
 
     def index
-      obj = {}
       models.each_with_index do |element, i|
-        model = element[:model].to_s
+        model = element[:model]
         class_name = find_correct_class_name(model)
+        formatted_model = pluralize(model).camelize(:lower).gsub("::", "")
 
-        obj[pluralize(model).camelize(:lower)] = class_name.constantize.where(models[i].except(:model))
+        @response_data[formatted_model] = [] unless @response_data.key?(formatted_model)
+        @response_data[formatted_model].concat(class_name.constantize.where(models[i].except(:model)))
+        @response_data[formatted_model].reverse!.uniq! { |obj| obj["id"] }
       end
-
-      render json: obj, status: :ok
+      render json: @response_data, status: :ok
     end
 
     def create
-      list = params[:list] || 1
       ActiveRecord::Base.transaction do
-        list.times do |n|
-          all_parameters = [ factory, *traits, attributes(n) ].compact
-          @factory = FactoryBot.create(*all_parameters)
+        factories.each do |element|
+          ids = []
+          list = element[:list] || 1
+          factory = element[:factory]
+          traits = element[:traits].map(&:to_sym) if element[:traits].present?
+
+          list.times do |n|
+            attributes = element[:attributes][n].to_h if element[:attributes].present?
+            factory_arguments = [ factory, *traits, attributes ].compact
+            @factory_instance = FactoryBot.create(*factory_arguments)
+            ids << @factory_instance.id
+          end
+
+          factory_name = pluralize(factory).camelize(:lower)
+
+          @response_data[factory_name] = [] unless @response_data.key?(factory_name)
+          @response_data[factory_name].concat(@factory_instance.class.name.constantize.where(id: ids))
         end
       end
-      obj = @factory.class.name.constantize.last(list)
-
-      render json: obj, status: :created
+      render json: @response_data, status: :accepted
     end
 
     def destroy
-      obj = {}
       ActiveRecord::Base.transaction do
         models.each_with_index do |element, i|
-          model = element[:model].to_s
+          model = element[:model]
           class_name = find_correct_class_name(model)
-          obj[pluralize(model).camelize(:lower)] = class_name.constantize.where(models[i].except(:model)).destroy_all
+          formatted_model = pluralize(model).camelize(:lower).gsub("::", "")
+
+          class_name.constantize.where(models[i].except(:model)).each do |record|
+            record.destroy!
+            @response_data[formatted_model] = [] unless @response_data.key?(formatted_model)
+            @response_data[formatted_model] << record
+          end
         end
       end
-
-      render json: obj, status: :accepted
+      render json: @response_data, status: :accepted
     end
 
     def update
-      obj = {}
       ActiveRecord::Base.transaction do
         models.each_with_index do |element, i|
-          model = element[:model].to_s
+          model = element[:model]
           class_name = find_correct_class_name(model)
           update_params = params.permit![:models][i][:update].to_h
-          obj[pluralize(model).camelize(:lower)] = class_name.constantize.where(models[i].except(:model, :update)).update(update_params)
+          attributes_to_search = models[i].except(:model, :update)
+          formatted_model = pluralize(model).camelize(:lower).gsub("::", "")
+
+          class_name.constantize.where(attributes_to_search).each do |record|
+            record.update!(update_params)
+            @response_data[formatted_model] = [] unless @response_data.key?(formatted_model)
+            @response_data[formatted_model] << class_name.constantize.find(record.id)
+            @response_data[formatted_model].reverse!.uniq! { |obj| obj["id"] }
+          end
         end
       end
-      render json: obj, status: :accepted
+      render json: @response_data, status: :accepted
     end
 
     private
@@ -70,29 +99,19 @@ module Stockpot
       # We are getting the class name from the factory or we default to whatever we send in.
       # Something to keep in mind "module/class_name".camelize will translate into "Module::ClassName"
       # which is perfect for namespaces in case there is no factory associated with a specific model
-      FactoryBot.factories.registered?(model) ? FactoryBot.build_stubbed(model).class.name : model.camelize
-    end
-
-    def traits
-      return if params[:traits].blank?
-
-      params[:traits].map(&:to_sym)
-    end
-
-    def factory
-      params[:factory].to_sym
-    end
-
-    # rubocop:disable Naming/UncommunicativeMethodParamName
-    def attributes(n)
-      # rubocop:enable Naming/UncommunicativeMethodParamName
-      return if params[:attributes].blank?
-
-      params.permit![:attributes][n].to_h
+      if FactoryBot.factories.registered?(model)
+        FactoryBot.factories.find(model).build_class.to_s
+      else
+        model.camelize
+      end
     end
 
     def models
       params.permit![:models].map(&:to_h)
     end
+
+    def factories
+      params.permit![:factories].map(&:to_h)
+    end
   end
 end

data/app/controllers/stockpot/redis_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Stockpot
   class RedisController < MainController
     def index
@@ -24,5 +25,11 @@ module Stockpot
 
       render json: { status: 201 }
     end
+
+    def keys
+      record = REDIS.keys
+
+      render json: record.to_json, status: :ok
+    end
   end
 end

data/config/routes.rb

@@ -8,8 +8,9 @@ Stockpot::Engine.routes.draw do
 
   delete "/clean_database", to: "database_cleaner#index"
 
-  get "/redis", to: "redis#index"
   post "/redis", to: "redis#create"
+  get "/redis", to: "redis#index"
+  get "/redis/keys", to: "redis#keys"
 
   get "/healthz", to: "healthz#index"
 end

data/lib/stockpot/engine.rb

@@ -4,11 +4,5 @@ module Stockpot
   class Engine < ::Rails::Engine
     isolate_namespace Stockpot
     config.generators.api_only = true
-
-    config.generators do |generators|
-      generators.test_framework :rspec
-      generators.fixture_replacement :factory_bot
-      generators.factory_bot dir: 'spec/factories'
-    end
   end
 end

data/lib/stockpot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stockpot
-  VERSION = "0.3.1"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,206 +1,220 @@
 --- !ruby/object:Gem::Specification
 name: stockpot
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Jayson Smith
+- Brian Herman
+- Derek Campbell
+- Victor Santana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: 6.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: 6.1.4
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 6.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: database_cleaner-redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.5
+        version: 4.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.5
+        version: 4.4.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.4
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: spicerack-styleguide
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.26.0.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.26.0.4
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 1.2.3
 description: 'Exposes a few end points from your app, easily enabling CRUD actions
   on your database that you can utilize from things like a standalone test suite to
   set up state. (think: Cypress, Cucumber, etc.)'
 email:
 - gh@nes.33mail.com
+- victorfrank.santanalugo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -240,8 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Makes setting up test data in your Rails database from an external resource