stockpot 0.2.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2683178878bc312393087331178faa1770530da412e17fdfbf17df3a25b11d38
-  data.tar.gz: de6f99f3fb93c4679d752ea699fd5be7110caf2a9d1de5963670435f9285bd49
+  metadata.gz: 35586181cc1a1e03a7ca543171ea6d05fa572e403d8c17604619088e8642744b
+  data.tar.gz: dc6f55274b50b51586b26f822d65b562deaa6307009d5b8d53c06127ba1faf7c
 SHA512:
-  metadata.gz: 71a3938561c28cf45fc99e7a90fdb452be47660978269677f41e369b4881c06b5a1c376845a7fce24b73bf8e0e77abe3be7dc250336f305552de5b192dc7e492
-  data.tar.gz: e28cc6b970e452adf4b3a311ffa33b2a0cff9e5cf7f4183919d4b21f6620f169c73fbc85eb1d8104c7594a458290b261fb29922e9cc5b51d8860c24d914500aa
+  metadata.gz: a26a25b375412d81355095f6ce82804024b2843f5353ad66456e061b83639d4ead3327073b893a1be9c8c46094a0cd351240ef1e882ab2a37e73703cf61fc9a8
+  data.tar.gz: '098249ae8ae84a52a5067f25b2fab86b93c8db6cc6dc91e880271455b5a166fc4ee41137f962d6619b233f4fdd1d0da05e1c51a7d773ca43060428a84ffe59ad'

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

@@ -2,10 +2,8 @@
 
 require "database_cleaner"
 
-require_dependency "stockpot/application_controller"
-
 module Stockpot
-  class DatabaseCleanerController < ApplicationController
+  class DatabaseCleanerController < MainController
     # Clean database before, between, and after tests by clearing Rails
     # and REDIS caches and truncating the active record database.
     def index

data/app/controllers/stockpot/healthz_controller.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
-
-require_dependency "stockpot/application_controller"
-
 module Stockpot
-  class HealthzController < ApplicationController
+  class HealthzController < MainController
     def index
       render json: { "message": "success" }, status: :ok
     end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Stockpot
+  module Helper
+    module Errors
+      def rescue_error(error)
+        logger = Logger.new(STDERR)
+        logger.warn(error)
+
+        case error
+        when NameError
+          return_error(error.message, error.backtrace.first(5), :bad_request)
+        when PG::Error
+          return_error("Postgres error: #{error.message}", error.backtrace.first(5), :internal_server_error)
+        when ActiveRecord::RecordInvalid, ActiveRecord::Validations, ActiveRecord::RecordNotDestroyed
+          return_error("In #{error.record.class} class, #{error.message}", error.backtrace.first(5), :expectation_failed)
+        else
+          return_error(error.message, error.backtrace.first(5),:internal_server_error)
+        end
+      end
+
+      def return_error(message, backtrace, status)
+        render json: { error: { status: status, backtrace: backtrace, message: message }}, status: status
+      end
+    end
+  end
+end

data/app/controllers/stockpot/main_controller.rb

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

data/app/controllers/stockpot/records_controller.rb

@@ -1,91 +1,115 @@
 # frozen_string_literal: true
-
-require_dependency "stockpot/application_controller"
-
 require "factory_bot_rails"
+require "active_record/persistence"
 
 module Stockpot
-  class RecordsController < ApplicationController
+  class RecordsController < MainController
     include ActiveSupport::Inflector
+    include ActiveRecord::Transactions
 
-    def index
-      return_error("You need to provide at least one model name as an argument", 400) && return if params.dig(:models).blank?
+    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?
+    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(:factories).blank?
+    end
+    before_action do
+      @response_data = {}
+    end
 
-      obj = {}
+    def index
       models.each_with_index do |element, i|
-        model = element[:model].to_s
-        obj[pluralize(model).camelize(:lower)] = model.camelize.constantize.where(models[i].except(:model))
-      end
+        model = element[:model]
+        class_name = find_correct_class_name(model)
+        formatted_model = pluralize(model).camelize(:lower).gsub("::", "")
 
-      render json: obj, status: :ok
+        @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: @response_data, status: :ok
     end
 
     def create
-      return_error("You need to provide at least one factory name as an argument", 400) && return if params.dig(:factory).blank?
-
-      list = params[:list] || 1
-      list.times do |n|
-        if params[:traits].present? && params[:attributes].present?
-          FactoryBot.create(factory, *traits, attributes[n])
-        elsif params[:traits].blank? && params[:attributes].blank?
-          # rubocop:disable Rails/SaveBang
-          FactoryBot.create(factory)
-          # rubocop:enable Rails/SaveBang
-        elsif params[:attributes].blank?
-          FactoryBot.create(factory, *traits)
-        elsif params[:traits].blank?
-          FactoryBot.create(factory, attributes[n])
+      ActiveRecord::Base.transaction do
+        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.to_s.camelize.constantize.last(list)
-      render json: obj, status: :created
+      render json: @response_data, status: :accepted
     end
 
     def destroy
-      return_error("You need to provide at least one model name as an argument", 400) && return if params.dig(:models).blank?
-
-      obj = {}
-      models.each_with_index do |element, i|
-        model = element[:model].to_s
-        obj[pluralize(model).camelize(:lower)] = model.camelize.constantize.where(models[i].except(:model)).destroy_all
+      ActiveRecord::Base.transaction do
+        models.each_with_index do |element, i|
+          model = element[:model]
+          class_name = find_correct_class_name(model)
+          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
-      return_error("You need to provide at least one model name as an argument", 400) && return if params.dig(:models).blank?
-
-      obj = {}
-      models.each_with_index do |element, i|
-        model = element[:model].to_s
-        update_params = params.permit![:models][i][:update].to_h
-        obj[pluralize(model).camelize(:lower)] = model.camelize.constantize.where(models[i].except(:model, :update)).update(update_params)
+      ActiveRecord::Base.transaction do
+        models.each_with_index do |element, i|
+          model = element[:model]
+          class_name = find_correct_class_name(model)
+          update_params = params.permit![:models][i][:update].to_h
+          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
 
-    def return_error(message, status)
-      render json: { "error": { "status": status, "message": message }}.to_json, status: status
-    end
-
-    def traits
-      params[:traits].map(&:to_sym)
-    end
-
-    def factory
-      params[:factory].to_sym
-    end
-
-    def attributes
-      params.permit![:attributes].map(&:to_h)
+    def find_correct_class_name(model)
+      # 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
+      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,7 +1,6 @@
 # frozen_string_literal: true
-
 module Stockpot
-  class RedisController < ActionController::Base
+  class RedisController < MainController
     def index
       if params[:field].present?
         # Returns the value associated with :field in the hash stored at :key
@@ -25,5 +24,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.rb

@@ -2,6 +2,4 @@
 
 require "stockpot/engine"
 
-module Stockpot
-  # Your code goes here...
-end
+module Stockpot; end

data/lib/stockpot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockpot
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Jayson Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-04 00:00:00.000000000 Z
+date: 2020-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -100,61 +100,55 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.8.2
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.8.2
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: spicerack-styleguide
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 0.21.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -164,7 +158,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 0.21.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -213,9 +207,10 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
-- app/controllers/stockpot/application_controller.rb
 - app/controllers/stockpot/database_cleaner_controller.rb
 - app/controllers/stockpot/healthz_controller.rb
+- app/controllers/stockpot/helper/errors.rb
+- app/controllers/stockpot/main_controller.rb
 - app/controllers/stockpot/records_controller.rb
 - app/controllers/stockpot/redis_controller.rb
 - config/routes.rb
@@ -245,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Makes setting up test data in your Rails database from an external resource

data/app/controllers/stockpot/application_controller.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Stockpot
-  class ApplicationController < ActionController::API
-    # protect_from_forgery with: :exception
-  end
-end