digget 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 844819201cdd222faf30bdd0b8abf0cc2a63b24c
-  data.tar.gz: 71c0f7d24f13af6fdc051f925da254902d1a9e6f
+  metadata.gz: de08739753470f3086606f6ffeafd94653130f70
+  data.tar.gz: 44fea04690dc6eba3f91a20d9a73cc29c21fbe86
 SHA512:
-  metadata.gz: 6f88cfb2e064c08028ef62d7e72a976e905b2dbdabe509772e66778bd9626d0bb5a58be3d7b4e7e0111a41165cab365a5cd23b686db42e3f026176470681bd1d
-  data.tar.gz: 13aeb6030bc94ca3d26d58059e86ec0c209d6e79278fa5b29506360761e8c87b29cce1a788f342f7a4039891b4f3261af09ffce6c44fce310866bcf73c232b65
+  metadata.gz: ee5da6726acb144c7c9debf87fd97f5af7b822c4b22dde2a73d57d2fc4b816e6be7e177debe91532b5c8d45816ee01c034f3afd8f4131a5cfdf06605f30b2c5c
+  data.tar.gz: b2d83a9c3ad1b3e116524f1aaa09c557c65c74d892c79804a4fa6ba79d06fa5dc4913a6a047dd7ac68dfce15c30f9a93b07c5f31d12509eb9919aa50663b03fc

data/README.md

@@ -1,10 +1,55 @@
 [![codecov](https://codecov.io/gh/pielambr/digget/branch/master/graph/badge.svg)](https://codecov.io/gh/pielambr/digget)
 [![Build Status](https://travis-ci.org/pielambr/digget.svg?branch=master)](https://travis-ci.org/pielambr/digget)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2351e4afa1f24e16af9c576bc619ea40)](https://www.codacy.com/app/pielambr/digget?utm_source=github.com&utm_medium=referral&utm_content=pielambr/digget&utm_campaign=Badge_Grade)
+[![Gem Version](https://badge.fury.io/rb/digget.svg)](https://badge.fury.io/rb/digget)
 # Digget
-Short description and motivation.
+This gem aims to make for an easier search API by validating incoming parameters and filtering your model accordingly.
 
+**Note**: this gem is under _very early_ development and is not finished in any way
 ## Usage
-How to use my plugin.
+### Validating of parameters
+The only thing you have to do is extends the Validator class, so you can use the `verify` method.
+```ruby
+class YourValidator < Digget::Validator
+  def validate_id_params
+    verify :id, Integer, max: 100, min: 50
+  end
+  
+  def validate_search_params
+      verify :name, String, required: true
+      verify :size, Float, required: true, min: 15
+    end
+end
+```
+To validate the `params` you need to run the validator;
+```ruby
+validator = YourValidator.new(params)
+validator.validate_id_params
+```
+You can then see if there are any errors during validation
+```ruby
+validator.errors
+```
+You can also get a Hash with the parameters casted to the right datatype
+```ruby
+validator.casted_params
+```
+#### Supported datatypes
+- Float
+- Integer
+- String
+- Date
+- Time
+#### Supported validation options
+All of the following options can be combined
+- **required** (checks whether the parameter is present)
+- **min** (checks whether the parameter is larger than the provided value)
+- **max** (checks whether the parameter is lower than the provided value)
+- **min_length** (checks whether the parameter is longer than this)
+- **max_length** (checks whether the parameter is shorter than this)
+- **length** (checks whether the parameter has this exact length)
+- **equal** (check whether the parameter is equal to the provided value)
+- **not_equal** (checks whether the parameter is not equal to the provided value)
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -23,8 +68,5 @@ Or install it yourself as:
 $ gem install digget
 ```
 
-## Contributing
-Contribution directions go here.
-
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/digget/validator.rb

@@ -83,6 +83,12 @@ module Digget
         elsif key == :max && !param.nil?
           next unless param > value
           @errors.append(I18n.t('digget.max', name: name, value: value))
+        elsif key == :equal && !param.nil
+          next unless param != value
+          @errors.append(I18n.t('digget.equal', name: name, value: value))
+        elsif key == :not_equal && !param.nil
+          next unless param == value
+          @errors.append(I18n.t('digget.not_equal', name: name, value: value))
         elsif key == :min_length && !param.nil?
           next unless param.length < value
           @errors.append(I18n.t('digget.min_length', name: name, value: value))

data/lib/digget/version.rb

@@ -1,3 +1,3 @@
 module Digget
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/translations/digget.yml

@@ -6,4 +6,6 @@ en:
     max: "The parameter `%{name}` can be %{value} at most"
     min_length: "The parameter `%{name}` should have a length of at least %{value}"
     max_length: "The parameter `%{name}` should have a length of %{value} at most"
-    length: "The parameter `%{name}` should have a length of %{value}"
+    length: "The parameter `%{name}` should have a length of %{value}"
+    equal: "The parameter `%{name}` should have be equal to %{value}"
+    not_equal: "The parameter `%{name}` should not be equal to %{value}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digget
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Pieterjan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-21 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,7 +108,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Description of Digget.
+description: Digget makes creating search endpoints easier. It allows you to put some
+  validations on incoming parameters and use these parameters to filter models.
 email:
 - me@pielambr.be
 executables: []
@@ -123,7 +124,7 @@ files:
 - lib/digget/version.rb
 - lib/tasks/digget_tasks.rake
 - lib/translations/digget.yml
-homepage: https://www.pielambr.be
+homepage: https://github.com/pielambr/digget
 licenses:
 - MIT
 metadata: {}
@@ -146,5 +147,5 @@ rubyforge_project:
 rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: Summary of Digget.
+summary: Easy parameter validation and model filtering.
 test_files: []