introspective_grape 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f52e3f6200f277c190a76450e09f65c582a9e56d
-  data.tar.gz: f2779c6afdfa697bc4d051d3ab461d9afcb91e6f
+  metadata.gz: 4a21e9540c7f4929e4dced1d88eb599edb4e887b
+  data.tar.gz: e97148d4dd00bba79807d6b52a79a29073fbbc9f
 SHA512:
-  metadata.gz: fc38af247ee9f040212122583701537567fc3a6551339c35034f88a0edef5acea6ed79b020fb7d5f3d16dddcc299bd12b882870d1a90826220bf00b6d8bfbb51
-  data.tar.gz: 08b47cd609c1501a9eeeb4293d5dc3dee9a97028c814aef22a9930f543ba529439358258f2b75a0f7af0d00597d5b73fb6d58ed57738683b6f7c397f384296e9
+  metadata.gz: 4236508d67aac2b65c1ed4123c4bfd63ab76851c1a4cbc17d943326bc01530ac9cc57f336954cfde83713fbb4020751a1e201dbe58a585e919aa3a7c23a7f7aa
+  data.tar.gz: d80ccf25f1db8187717fb57f6e8a8f82f2fb8889154efc0b96121bdf5a022f193de94380fc222ec8aeecc19d1041f99edbbd10234a2ba8ca50e1c4c15ee03ee1

data/CHANGELOG.md

@@ -1,4 +1,16 @@
 
+0.2.6 11/01/2016
+==============
+
+Change the Model.attribute_param_types class method lookup (for specifying custom param types attributes on a model) to "grape_param_types" to make it clearer that the method is used in the API.
+
+### Features
+
+Add support for custom validations on a model using a `self.grape_validations` hash of fields and validations to apply.
+
+Add custom validators to verify that JSON strings parse as a JSON object, an array, or a hash.
+
+
 0.2.5 10/28/2016
 ==============
 

data/README.md

@@ -110,13 +110,32 @@ type from model introspection, define a class method in the model with the param
 types for the attributes specified in a hash, e.g.:
  
 ```
-   def self.attribute_param_types
+   def self.grape_param_types
     { "<attribute name 1>" => String,
       "<attribute name 2>" => Integer,
       "<attribute name 3>" => Virtus::Attribute::Boolean }
    end
 ```
 
+To add additional validations on API inputs you can define a hash of hashes in the model in a
+class method ("grape_validations") that will be applied to that field's param declaration:
+
+```
+  def self.grape_validations
+    { field1: { values: %w(red blue green) },
+      field2: { json_array: true }, 
+      field3: { regexp: /\w+/ } 
+  end
+```
+
+IntrospectiveGrape provides the following custom grape validators:
+
+```
+json: true       # validates that the JSON string parses
+json_array: true # validates that the JSON string parses and returns an Array 
+json_hash: true  # validates that the JSON string parses and returns a Hash
+```
+
 For nested models declared in Rails' strong params both the Grape params for the
 nested params as well as nested routes will be declared, allowing for
 a good deal of flexibility for API consumers out of the box, such as implicitly

data/lib/introspective_grape/api.rb

@@ -1,5 +1,9 @@
 require 'action_controller'
 require 'grape-kaminari'
+require 'introspective_grape/validators'
+
+class IntrospectiveGrapeError < StandardError
+end
 
 module IntrospectiveGrape
   class API < Grape::API
@@ -28,7 +32,7 @@ module IntrospectiveGrape
     # type from model introspection, define a class method in the model with the param
     # types for the attributes specified in a hash:
     #
-    #  def self.attribute_param_types
+    #  def self.grape_param_types
     #   { "<attribute name>" => Virtus::Attribute::Boolean,
     #     "<attribute name>" => Integer,
     #     "<attribute name>" => String }
@@ -71,6 +75,9 @@ module IntrospectiveGrape
       #end
 
       def restful(model, strong_params=[], routes=[])
+        if model.respond_to?(:attribute_param_types)
+          raise IntrospectiveGrapeError.new("#{model.name}'s attribute_param_types class method needs to be changed to grape_param_types")
+        end
         # Recursively define endpoints for the model and any nested models.
         #
         # model: the model class for the API
@@ -337,13 +344,18 @@ module IntrospectiveGrape
             # All params are optional on an update, only require them during creation.
             # Updating a record with new child models will have to rely on ActiveRecord
             # validations:
-            dsl.requires field, type: param_type(model,field)
+            dsl.requires field, { type: param_type(model,field) }.merge( validations(model, field) )
           else
-            dsl.optional field, type: param_type(model,field)
+            #dsl.optional field, *options
+            dsl.optional field, { type: param_type(model,field) }.merge( validations(model, field) )
           end
         end
       end
 
+      def validations(model, field)
+        (model.try(:grape_validations) || {}).with_indifferent_access[field] || {}
+      end
+
       def generate_nested_params(dsl,action,model,fields)
         klass = self
         fields.each do |r,v|
@@ -391,7 +403,7 @@ module IntrospectiveGrape
         # Check if it's a file attachment, look for an override class from the model,
         # check Pg2Ruby, use the database type, or fail over to a String:
         ( is_file_attachment?(model,f) && Rack::Multipart::UploadedFile ) || 
-          (model.try(:attribute_param_types)||{})[f]                      || 
+          (model.try(:grape_param_types)||{}).with_indifferent_access[f] || 
           Pg2Ruby[db_type]                                                ||
           begin db_type.to_s.camelize.constantize rescue nil end          ||
           String

data/lib/introspective_grape/validators.rb

@@ -0,0 +1,34 @@
+require 'grape/validations'
+module Grape::Validators
+
+  class Json < Grape::Validations::Base
+    def validate_param!(field, params)
+      begin
+        JSON.parse( params[field] )
+      rescue
+        fail Grape::Exceptions::Validation, params: [@scope.full_name(field)], message: 'must be valid JSON!'
+      end
+    end
+  end
+
+  class JsonArray < Grape::Validations::Base
+    def validate_param!(field, params)
+      begin
+        raise unless JSON.parse( params[field] ).kind_of? Array 
+      rescue
+        fail Grape::Exceptions::Validation, params: [@scope.full_name(field)], message: 'must be valid JSON array!'
+      end
+    end
+  end
+
+  class JsonHash < Grape::Validations::Base
+    def validate_param!(field, params)
+      begin
+        raise unless JSON.parse( params[field] ).kind_of? Hash
+      rescue
+        fail Grape::Exceptions::Validation, params: [@scope.full_name(field)], message: 'must be valid JSON hash!'
+      end
+    end
+  end
+
+end

data/lib/introspective_grape/version.rb

@@ -1,3 +1,3 @@
 module IntrospectiveGrape
-  VERSION = "0.2.5".freeze
+  VERSION = "0.2.6".freeze
 end

data/spec/dummy/app/api/dummy/company_api.rb

@@ -1,7 +1,7 @@
 class Dummy::CompanyAPI < IntrospectiveGrape::API
   paginate
 
-  restful Company do
+  restful Company, [:id, :name, :short_name, :gizmos, :widgets, :sprockets] do
 
     desc "Test default values in an extra endpoint"
     params do

data/spec/dummy/app/models/company.rb

@@ -11,4 +11,25 @@ class Company < AbstractAdapter
 
   validates_length_of :name, maximum: 256
   validates_length_of :short_name, maximum: 10
+
+  def self.grape_validations
+    {
+      gizmos: { json: true },
+      widgets: { json_array: true },
+      sprockets: { json_hash: true }
+    }
+  end
+
+  def gizmos=(json)
+    JSON.parse(json)
+  end
+
+  def widgets=(json_array)
+    JSON.parse(json_array)
+  end
+
+  def sprockets=(json_hash)
+    JSON.parse(json_hash)
+  end
+
 end

data/spec/dummy/app/models/role.rb

@@ -3,13 +3,18 @@ class Role < AbstractAdapter
   belongs_to :ownable, polymorphic: true
 
   validates_uniqueness_of :user_id, scope: [:ownable_type,:ownable_id], unless: "user_id.nil?", message: "user has already been assigned that role"
-  validates_inclusion_of :ownable_type, in: ['SuperUser', 'Company', 'Project']
+  OWNABLE_TYPES = %w(SuperUser Company Project).freeze
+  validates_inclusion_of :ownable_type, in: OWNABLE_TYPES
 
   delegate :email, to: :user,              allow_nil: true
   def attributes
     super.merge(email: email)
   end
 
+  def self.grape_validations
+    { ownable_type: { values: OWNABLE_TYPES } }
+  end
+
   def ownable
     # return the SuperUser null object
     ownable_type == 'SuperUser' ? SuperUser.new : super

data/spec/dummy/app/models/user.rb

@@ -69,7 +69,7 @@ class User < AbstractAdapter
     avatar.try(:file).try(:url,size)
   end
 
-  def self.attribute_param_types
+  def self.grape_param_types
     { "skip_confirmation_email" => Virtus::Attribute::Boolean }
   end
 

data/spec/requests/company_api_spec.rb

@@ -86,4 +86,19 @@ describe Dummy::CompanyAPI, type: :request do
     json['error'].should == "Name: is too long (maximum is 256 characters), Short Name: is too long (maximum is 10 characters)"
   end
 
+  it "should validate json parameters" do
+    put "/api/v1/companies/#{company.id}", { gizmos: "garbage" }
+    json["error"].should eq "gizmos must be valid JSON!" 
+  end
+
+  it "should validate json array parameters" do
+    put "/api/v1/companies/#{company.id}", { widgets: "[garbage[\"A\",\"B\"]" }
+    json["error"].should eq "widgets must be valid JSON array!"
+  end
+
+  it "should validate json hash parameters" do
+    put "/api/v1/companies/#{company.id}", { sprockets: "{\"foo\":\"bar\"}garbage}" }
+    json["error"].should eq "sprockets must be valid JSON hash!"
+  end
+
 end

data/spec/requests/role_api_spec.rb

@@ -34,4 +34,9 @@ describe Dummy::RoleAPI, type: :request do
     json['error'].should =~ /user has already been assigned that role/
   end
   
+  it 'validates ownable type value specified in grape_validations' do
+    post '/api/v1/roles', { user_id: user.id, ownable_type: 'NotSuperUser' }
+    response.code.should == '400'
+    json['error'].should eq "ownable_type does not have a valid value"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: introspective_grape
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Josh Buermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2016-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -276,6 +276,7 @@ files:
 - lib/introspective_grape/formatter/camel_json.rb
 - lib/introspective_grape/helpers.rb
 - lib/introspective_grape/traversal.rb
+- lib/introspective_grape/validators.rb
 - lib/introspective_grape/version.rb
 - lib/tasks/introspective_grape_tasks.rake
 - spec/.DS_Store