parakeet 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1981e58dc296402626ec3df314f2789dcdd76f3
-  data.tar.gz: 65d7e4316c006d955ade4cbd24e4060be6e754f3
+  metadata.gz: ec7882c8e0e5b061e780ddfd41b8e0f1f864ddb9
+  data.tar.gz: 707d3e319cc66a346e34e6e33c2f856055f41969
 SHA512:
-  metadata.gz: 72109436b186fb8914955701fa5fd19fd3c8f45dc5da75073cf04f4be3cd3dd791cc81508b22c6a505fe6e86fe7bb4b3c019f0e3aae2bf06901858528f6b3e79
-  data.tar.gz: bf92acb325ef52f2e1d08b681b5879e8b79cf014e3ff1404687bf641ab8e523190ecf77233f206c696958d12f4fbe1cd8e026f0ca08f4d1041d8171ad076283b
+  metadata.gz: 20b61447864c99b376b561ce0bc59ffe57c09d22b37002bf696ebbec42a876a5bd75f9cf6272112e9b8a29aac15683393ee167b579af5446726626cc50f0c5c1
+  data.tar.gz: 99f8a299d03ca6fcf787055888d18e5d2dbabf6cc8e7e5bd873750693d8bc1962d2ac0fafa4c1432f9d7f23e0218bc08e2a12ed995dfb980b9cd4f3922603b33

data/Gemfile.lock

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

data/design_document.txt

@@ -0,0 +1,37 @@
+Summary:
+1) before_action is going to run before each of the actions in the controller
+2) Enable ability to select individual actions or all, this may just be covered
+    if the before_action has an entry in the hash for that action or not.
+3) An initializer/configuration file will be used to set the configuration of Parakeet and to pass in
+    the hash that will contain the controller, action, parameter name, and parameter type.
+4) The before_action will iterate over the expected params for this action, check
+    if they are in the params hash, and if they are, check if they are in the correct format.
+5) Return an object with errors. Probably similar to the error already returned by rails.
+    Maybe actively try to mimic the format. Give list of parameters that are
+    missing/invalid and return to the user as an instance variable.
+
+Features:
+1) Mandatory/Optional parameter checking in the param hash for both existence,
+    and format/value.
+2) Potentially try and turn parameters into the expect form. Turn a string into
+    an int if that is desired.
+3) CLI to create the configuration file.
+4) Maybe create a way for the API to automatically return an error with the error object.
+5) Perhaps enable customization of the error message/error response.
+
+Classes/Modules:
+1) Error
+2) Expected parameter (perhaps created on initialization with the configuration info, probably no reason for this anyways.)
+3) Configuration?
+4) ControllerAdditions (To handle the items mixed in to the base Controller)
+
+ToDo:
+1) Review other gems to see class/module set up.
+1b) Flesh out a bit more sophisticated class layout then this document presents to make it
+      easier to move forward.
+1c) A clearer vision will also enable me to do a bit more targeted TDD as opposed to just
+    winging it
+
+In Progress Design Doc
+https://docs.google.com/document/d/1WQjCEmi5zS6S2IsDhvgS57BlsKrz9Erc3782GcBuG9s/edit
+Last Updated: January 31st

data/lib/parakeet/controller_addons.rb

@@ -0,0 +1,27 @@
+module Parakeet
+  # TODO: Update to 2017 using ActiveSupport::Concern
+  module ControllerAddons
+    module ClassMethods
+      def verify_parameters
+        self.send(:before_action, :verify_parameters)
+      end
+
+      def guideline
+        @guideline ||= ::Guideline.new
+      end
+    end
+    module InstanceMethods
+      def check_mixin
+        puts "ClassMethod successfully mixed in 12"
+      end
+      def verify_parameters
+        logger.info ActionController::Base.guideline.controller_actions
+      end
+    end
+  end
+
+  if defined? ActionController::Base
+    ActionController::Base.extend ControllerAddons::ClassMethods
+    ActionController::Base.include ControllerAddons::InstanceMethods
+  end
+end

data/lib/parakeet/guideline.rb

@@ -0,0 +1,29 @@
+module Parakeet
+  module Guideline
+
+    # This will be included in a Guideline class that the user will
+    # generate and define the parameters/vallidations.
+    # class Guideline
+    #   include Parakeet::Guideline
+    #   def initialize
+    #     verify_params('user#create', 'first_name', :string, { exists: true, length: 'under 10' })
+    #   end
+    # end
+
+    # This seems like a super duplicative way to do this.
+    # Can pass in object that contains controller/action and ActionController
+    # and all parameters/types/validations instead. Is that just as messy?
+    # TODO: Update with a DRYer solution considering multiple parameters for a
+    # controller action
+    def verify_params(controller_action, parameter, type, validations)
+      # TODO: I'm thinking that this should create an object that represents
+      # an action. Then into that object insert the individual parameter rules.
+      # controller_actions[controller_action] = [] if controller_actions[controller_action].nil?
+      controller_actions[controller_action] << Parameter.new(parameter, type, validations)
+    end
+
+    def controller_actions
+      @controller_actions ||= Hash.new{ |hash, key| hash[key] = [] }
+    end
+  end
+end

data/lib/parakeet/parameter.rb

@@ -0,0 +1,10 @@
+module Parakeet
+  class Parameter
+    # TODO: Need to do some checking on the inputs here
+    def initialize(parameter, type, validations)
+      @name = parameter
+      @type = type
+      @validations = validations
+    end
+  end
+end

data/lib/parakeet/version.rb

@@ -1,3 +1,3 @@
 module Parakeet
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/parakeet.rb

@@ -1,19 +1,4 @@
 require "parakeet/version"
-
-module Parakeet
-  module ClassMethods
-    def check_mixin
-      puts "ClassMethod successfully mixed in"
-    end
-  end
-
-  def self.included(base)
-    base.extend ClassMethods
-  end
-end
-
-if defined? ActionController::Base
-  ActionController::Base.class_eval do
-    include Parakeet
-  end
-end
+require "parakeet/controller_addons"
+require "parakeet/parameter"
+require "parakeet/guideline"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parakeet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Colin Fike
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,7 +70,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- design_document.txt
 - lib/parakeet.rb
+- lib/parakeet/action.rb
+- lib/parakeet/controller_addons.rb
+- lib/parakeet/guideline.rb
+- lib/parakeet/parameter.rb
 - lib/parakeet/version.rb
 - parakeet.gemspec
 homepage: https://github.com/colinfike/parakeet