str_sanitizer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40adee975fa727815aab7c0c5342b29aa314141d
-  data.tar.gz: 61bf3734eb9e0498d0340c336c906279b29accc6
+  metadata.gz: a7169e8b75393511b739ab251507841b7450a151
+  data.tar.gz: 3e7db2ddbfe1be726fd98595e7888ee9e90128b6
 SHA512:
-  metadata.gz: 3ef826fb0f755c512fd636b6ba678041191517af6c6ba62f716ef17fe248022a8368ec38bf0339d06c055151930eebec476670adfd7161ccc590cbddc06f5832
-  data.tar.gz: 07efaf0dac8247d325828b0711dd4f13e8d9310a42b4818a6470e4536ee8b6e1efb286cbdf7a715d68dd69e00cd8e61bdb8b2ddfdfc6142c90abeb9ed85dabc0
+  metadata.gz: 520ef5564f072087346b5efb995cbbdf0c3f8d0cff7032ddd723f3d0b6b0c5dd0b3354c156424c52f9e04b68e819b7a376f51fdc636a5d48ce50e6d42a59edb9
+  data.tar.gz: 91425bcd578d61ffeee7a11a2264df1c2f04294655c404abf97bea5bb07b5d380d2cde793ec53287706dce0db806d2813c2751ae5095ebbde81610dc7f68b54b

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## StrSanitizer 0.3.0 (August 21, 2017) ##
+
+* Added a new `HtmlEntities` module which encodes and decodes HTML Entities.
+* A new dependency named `htmlentities`.
+
 ## StrSanitizer 0.2.0 (August 09, 2017) ##
 
 * Changed the structure of the module in `lib/str_sanitizer/quotes.rb` file. Removed the `InstanceMethods` module and `included` class method of `Quotes` module. Remove the `ClassMethods` class too from `Quotes` module. Re-structured the whole module.

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in str_sanitizer.gemspec
 gemspec
+
+gem 'htmlentities'

data/README.md

@@ -1,4 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/str_sanitizer.svg)](https://badge.fury.io/rb/str_sanitizer)
+[![Build Status](https://travis-ci.org/JakariaBlaine/str_sanitizer.svg?branch=master)](https://travis-ci.org/JakariaBlaine/str_sanitizer)
 # StrSanitizer
 
 Welcome to this gem. This gem is about String Sanitization. This gem sanitizes the string which is given.
@@ -23,30 +24,44 @@ Or install it yourself as:
 ## Usage
 
 - To escape quotes of a string
-```ruby
-require "str_sanitizer"
-
-hello = 'He said, "Hello!"'
-StrSanitizer.double_quote(hello) # => He said, \"Hello!\" 
-
-hello = "She said, 'Hello!'"
-StrSanitizer.single_quote(hello) # => She said, \'Hello!\'
-
-both_quotes = "They said, \"Don't do it!\""
-StrSanitizer.both_quotes(both_quotes) # => They said, \"Don\'t do it!\"
-```
-You can also check if the string has any quote or not
-```ruby
-no_quote = "Hello, there."
-single_quote = "It's going down."
-double_quote = "He said, \"Hello\""
-
-StrSanitizer.has_any_quote?(no_quote) # => nil
-StrSanitizer.has_both_quotes?(no_quote) # => nil
-
-StrSanitizer.has_single_quotes?(single_quote) # => true
-StrSanitizer.has_double_quotes?(double_quote) # => true
-```
+  ```ruby
+  require "str_sanitizer"
+
+  hello = 'He said, "Hello!"'
+  StrSanitizer.double_quote(hello) # => He said, \"Hello!\" 
+
+  hello = "She said, 'Hello!'"
+  StrSanitizer.single_quote(hello) # => She said, \'Hello!\'
+
+  both_quotes = "They said, \"Don't do it!\""
+  StrSanitizer.both_quotes(both_quotes) # => They said, \"Don\'t do it!\"
+  ```
+  You can also check if the string has any quote or not
+  ```ruby
+  no_quote = "Hello, there."
+  single_quote = "It's going down."
+  double_quote = "He said, \"Hello\""
+
+  StrSanitizer.has_any_quote?(no_quote) # => nil
+  StrSanitizer.has_both_quotes?(no_quote) # => nil
+
+  StrSanitizer.has_single_quotes?(single_quote) # => true
+  StrSanitizer.has_double_quotes?(double_quote) # => true
+  ```
+
+- To sanitize HTML Entities of a string
+  ```ruby
+  string = "<script>alert('Hola!!!')</script>"
+
+  StrSanitizer.html_encode(string) # => &lt;script&gt;alert('Hola!!!')&lt;script&gt;
+  ```
+  You can also decode the a string with encoded HTML entities
+  ```ruby
+  string = "&lt;script&gt;alert('Hola!!!')&lt;script&gt"
+
+  StrSanitizer.html_decode(string) # => <script>alert('Hola!!!')</script>
+  ```
+  Note: `htmlentities` was used for encoding and decoding process
 
 ## Development
 

data/lib/str_sanitizer.rb

@@ -22,7 +22,11 @@
 
 require "str_sanitizer/version"
 require "str_sanitizer/quotes"
+require "str_sanitizer/html_entities"
 
+# Author:     Jakaria (mailto: jakariablaine120@gmail.com)
+# Copyright:  Copyright (c) 2017 Jakaria
 class StrSanitizer
   extend Quotes
+  extend HtmlEntities
 end

data/lib/str_sanitizer/html_entities.rb

@@ -0,0 +1,46 @@
+require 'htmlentities'
+
+class StrSanitizer
+
+  # This modules encodes and decodes HTML Entities of a string
+  #
+  # Author:     Jakaria (mailto: jakariablaine120@gmail.com)
+  # Copyright:  Copyright (c) 2017 Jakaria
+  module HtmlEntities
+
+    # Instantiate htmlentities class to use it for encoding and decoding html entities
+    #
+    # Params:
+    # +none+
+    def initizalize
+      @coder = HTMLEntities.new
+    end
+
+    # Encodes the HTML entities of the given string
+    #
+    # Params:
+    # +str+:: A +string+ which needs to be escaped from html entities
+    # +options+:: Options for encoding. You can provide one or more than one option. 
+    #             If no option is given, :basic option will be used by default.
+    #             Options available :basic, :named, :decimal, :hexadecimal
+    #
+    # Returns:
+    # +string+:: An HTML entities escaped +string+
+    def html_encode(string, *options)
+      @coder = HTMLEntities.new
+      @coder.encode(string, *options)
+    end
+
+    # Decodes the HTML entities of the given string
+    #
+    # Params:
+    # +str+:: A +string+ which needs to be decoded to html entities
+    #
+    # Returns:
+    # +string+:: A string with decoded HTML entities +string+
+    def html_decode(string)
+      @coder = HTMLEntities.new
+      @coder.decode(string)
+    end
+  end
+end

data/lib/str_sanitizer/version.rb

@@ -1,3 +1,3 @@
 class StrSanitizer
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: str_sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jakaria Blaine
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-09 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - bin/console
 - bin/setup
 - lib/str_sanitizer.rb
+- lib/str_sanitizer/html_entities.rb
 - lib/str_sanitizer/quotes.rb
 - lib/str_sanitizer/version.rb
 - str_sanitizer.gemspec
@@ -94,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: This gem sanitizes the given string