despecable 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3232f2f309244ea0e9e1d0385c4a585b7623b5ef
+  data.tar.gz: d294097b285d62c699515e7cd7640f5548961a0a
+SHA512:
+  metadata.gz: a71ad8719c0b18a3a86546502efd749fce8020b2efb8df0599102f6c4779b54f39928bde439d94f0ebdaabca677a9319892abbf05c488068fd336baf4b8fed19
+  data.tar.gz: d905c46e795d619e7b0d462754bcad750e3b7374b241888f466a52966d1e2b2cc7a4444aee156f72af021998c468aff0250c07aa0904ac3c2d8001f283fcb458

data/lib/despecable/action_controller.rb

@@ -0,0 +1,11 @@
+module Despecable
+  module ActionController
+    def despec(&blk)
+      Despecable::Me.new(params.deep_dup).doit(&blk)
+    end
+
+    def dspec!(&blk)
+      Despecable::Me.new(params).doit(&blk)
+    end
+  end
+end

data/lib/despecable/errors/despecable_error.rb

@@ -0,0 +1 @@
+Despecable::DespecableError = Class.new(StandardError)

data/lib/despecable/errors/incorrect_parameter_error.rb

@@ -0,0 +1 @@
+Despecable::IncorrectParameterError = Class.new(Despecable::DespecableError)

data/lib/despecable/errors/invalid_parameter_error.rb

@@ -0,0 +1 @@
+Despecable::InvalidParameterError = Class.new(Despecable::DespecableError)

data/lib/despecable/errors/missing_parameter_error.rb

@@ -0,0 +1 @@
+Despecable::MissingParameterError = Class.new(Despecable::DespecableError)

data/lib/despecable/me.rb

@@ -0,0 +1,15 @@
+module Despecable
+  class Me
+    attr_reader :params
+
+    def initialize(params)
+      @params = params
+    end
+
+    def doit(&blk)
+      spectator = Despecable::Spectator.new(@params)
+      spectator.instance_eval(&blk)
+      return spectator.params
+    end
+  end
+end

data/lib/despecable/spectacles.rb

@@ -0,0 +1,55 @@
+module Despecable
+  class Spectacles
+    attr_reader :params
+    
+    def initialize(params)
+      @params = params
+    end
+
+    def validate_param(name, options)
+      validate_param_presence(name) if options[:required]
+      validate_param_value(name, options[:in]) if options.key?(:in) && params.key?(name)
+    end
+
+    def validate_param_presence(name)
+      raise Despecable::MissingParameterError, "Missing required param: '#{name}'" if !params.key?(name)
+    end
+
+    def validate_param_value(name, allowed_values)
+      raise Despecable::IncorrectParameterError, "Incorrect value for param: '#{name}'" if !allowed_values.include?(params[name])
+    end
+
+    def integer(name)
+      int = params[name].to_i
+      raise Despecable::InvalidParameterError, "Invalid value for param: '#{name}'. Required type: integer." if int.to_s != params[name].sub(/^0+/, "")
+      return int
+    end
+
+    def string(name)
+      # This is really a no-op.
+      params[name].to_s
+    end
+
+    def boolean(name)
+      case params[name].to_s
+      when "true", "1" then true
+      when "false", "0", nil then false
+      else raise Despecable::InvalidParameterError, "Invalid value for param: '#{name}'. Require type: boolean (1/0 or true/false)"
+      end
+    end
+
+    def date(name)
+      Date.rfc3339(params[name] + "T00:00:00+00:00")
+    rescue ArgumentError
+      raise unless $!.message == "invalid date"
+      raise Despecable::InvalidParameterError, "Invalid value for param: '#{name}'. Required type: date (e.g. '2012-12-31')."
+    end
+
+    def datetime(name)
+      DateTime.rfc3339(params[name])
+    rescue ArgumentError
+      raise unless $!.message == "invalid date"
+      raise Despecable::InvalidParameterError, "Invalid value for param: '#{name}'. Required type: rfc3339 datetime (e.g. '2009-06-19T00:00:00-04:00')."
+    end
+  end
+end

data/lib/despecable/spectator.rb

@@ -0,0 +1,43 @@
+module Despecable
+  class Spectator < BasicObject
+    attr_reader :params
+
+    def initialize(params)
+      @params = params
+      @spectacles = ::Despecable::Spectacles.new(params)
+    end
+
+    def integer(name, options = {})
+      _spec(name, :integer, options)
+    end
+
+    def string(name, options = {})
+      _spec(name, :string, options)
+    end
+
+    def boolean(name, options = {})
+      _spec(name, :boolean, options)
+    end
+
+    def date(name, options = {})
+      _spec(name, :date, options)
+    end
+
+    def datetime(name, options = {})
+      _spec(name, :datetime, options)
+    end
+
+    private
+
+    def _spec(name, type, options = {})
+      if params.key?(name)
+        params[name] = @spectacles.public_send(type, name)
+      elsif options.key?(:default)
+        params[name] = options[:default]
+      end
+      @spectacles.validate_param(name, options)
+      return params[name]
+    end
+
+  end
+end

data/lib/despecable.rb

@@ -0,0 +1,11 @@
+module Despecable; end
+
+require "despecable/action_controller.rb"
+require "despecable/me.rb"
+require "despecable/spectator.rb"
+require "despecable/spectacles.rb"
+
+require "despecable/errors/despecable_error.rb"
+require "despecable/errors/missing_parameter_error.rb"
+require "despecable/errors/incorrect_parameter_error.rb"
+require "despecable/errors/invalid_parameter_error.rb"

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: despecable
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Andrew Schwartz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-10 00:00:00.000000000 Z
+dependencies: []
+description: Write self-documenting parameter validation and type-casting in your
+  API actions.
+email: ozydingo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/despecable.rb
+- lib/despecable/action_controller.rb
+- lib/despecable/errors/despecable_error.rb
+- lib/despecable/errors/incorrect_parameter_error.rb
+- lib/despecable/errors/invalid_parameter_error.rb
+- lib/despecable/errors/missing_parameter_error.rb
+- lib/despecable/me.rb
+- lib/despecable/spectacles.rb
+- lib/despecable/spectator.rb
+homepage: https://github.com/ozydingo/despecable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Easy self-documenting parameter specifications for API routes in Rails
+test_files: []