apes 1.0.0

data/spec/apes/serializers_spec.rb

@@ -0,0 +1,70 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Apes::Serializers::List do
+  describe ".load" do
+    it "split a string" do
+      expect(Apes::Serializers::List.load(", 1,2 4,,3,A , B   ")).to eq(["1", "2 4", "3", "A", "B"])
+    end
+    
+    it "always returns a array" do
+      expect(Apes::Serializers::List.load(nil)).to eq([])
+    end
+  end
+  
+  describe ".dump" do
+    it "encodes everything as an array" do
+      expect(Apes::Serializers::List.dump([])).to eq("")
+      expect(Apes::Serializers::List.dump([1, "2", 3])).to eq("1,2,3")
+      expect(Apes::Serializers::List.dump(1)).to eq("1")
+    end
+  end
+end
+
+describe Apes::Serializers::JSON do
+  describe ".load" do
+    it "load a JSON object" do
+      expect(Apes::Serializers::JSON.load("{\"1\": 2}")).to eq({"1" => 2})
+    end
+    
+    it "an Hash is returned with indifferent access" do
+      expect(Apes::Serializers::JSON.load("{\"1\": 2}")).to be_a(HashWithIndifferentAccess)
+    end
+    
+    it "fallbacks to default for invalid JSON" do
+      expect(Apes::Serializers::JSON.load("\"", false, "A")).to eq("A")
+    end
+  end
+  
+  describe ".dump" do
+    it "encodes input as JSON" do
+      expect(Apes::Serializers::JSON.dump({a: "B"})).to eq("{\"a\":\"B\"}")
+    end
+  end
+end
+
+describe Apes::Serializers::JWT do
+  describe ".load" do
+    it "load a JSON object" do
+      expect(Apes::Serializers::JWT.load("eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJkYXRhIiwic3ViIjp7IjEiOjJ9fQ.jqhJuB0xtO7Xyk_T8X_rwOKE96Q7GBxWR5NBxfW5xWE")).to eq({"1" => 2})
+    end
+    
+    it "an Hash is returned with indifferent access" do
+      expect(Apes::Serializers::JWT.load("eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJkYXRhIiwic3ViIjp7IjEiOjJ9fQ.jqhJuB0xtO7Xyk_T8X_rwOKE96Q7GBxWR5NBxfW5xWE")).to be_a(HashWithIndifferentAccess)
+    end
+    
+    it "fallbacks to default for invalid JSON" do
+      expect(Apes::Serializers::JWT.load("\"", false, "A")).to eq("A")
+    end
+  end
+  
+  describe ".dump" do
+    it "encodes input as JSON" do
+      expect(Apes::Serializers::JWT.dump({a: "B"})).to eq("eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJkYXRhIiwic3ViIjp7ImEiOiJCIn19.mWyWy9SDzOlBLJW1b4ICw4QZwoGDU836ED5EALZnjeU")
+    end
+  end
+end

data/spec/apes/urls_parser_spec.rb

@@ -0,0 +1,150 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Apes::UrlsParser do
+  describe ".instance" do
+    it "should return a singleton" do
+      first = Apes::UrlsParser.instance
+      expect(Apes::UrlsParser.instance).to be(first)
+    end
+    
+    it "should force recreation of a new singleton" do
+      original = Apes::UrlsParser.instance
+      expect(Apes::UrlsParser.instance).to be(original)
+      expect(Apes::UrlsParser.instance(true)).not_to be(original)
+    end
+  end
+  
+  describe "#url?" do
+    it "should recognize whether a text is a url" do
+      expect(Apes::UrlsParser.instance.url?("http://google.it")).to be_truthy
+      expect(Apes::UrlsParser.instance.url?("google.co")).to be_truthy
+      expect(Apes::UrlsParser.instance.url?("fab.foog.google.co")).to be_truthy
+      expect(Apes::UrlsParser.instance.url?("google.co:123/abc?query=a&utc=b#whatever")).to be_truthy
+      expect(Apes::UrlsParser.instance.url?("google.ca#123")).to be_truthy
+      expect(Apes::UrlsParser.instance.url?("google.c")).to be_falsey
+      expect(Apes::UrlsParser.instance.url?("http://google.cowtech")).to be_falsey
+      expect(Apes::UrlsParser.instance.url?("http://google.it::123")).to be_falsey
+      expect(Apes::UrlsParser.instance.url?("fab..foog.google.co")).to be_falsey
+      expect(Apes::UrlsParser.instance.url?("test@google.com")).to be_falsey
+      expect(Apes::UrlsParser.instance.url?("http://127.0.0.1")).to be_truthy
+      expect(Apes::UrlsParser.instance.url?("127.0.0.1")).to be_truthy
+      expect(Apes::UrlsParser.instance.url?("http://[1762:0:0:0:0:B03:1:AF18]")).to be_truthy
+      expect(Apes::UrlsParser.instance.url?("[1762::B03:1:AF18]")).to be_truthy
+      expect(Apes::UrlsParser.instance.url?("[::127.0.0.1]")).to be_truthy
+    end
+  end
+  
+  describe "#email?" do
+    it "should recognize whether a text is a email" do
+      expect(Apes::UrlsParser.instance.email?("abc@google.it")).to be_truthy
+      expect(Apes::UrlsParser.instance.email?("abc.cde@google.co")).to be_truthy
+      expect(Apes::UrlsParser.instance.email?("ab'c.cde@google.co")).to be_truthy
+      expect(Apes::UrlsParser.instance.email?("abc-af_123@fab.foog.google.co")).to be_truthy
+      expect(Apes::UrlsParser.instance.email?("ad$1@local.com")).to be_falsey
+    end
+  end
+  
+  describe "#domain?" do
+    it "should recognize whether a text is a domain" do
+      expect(Apes::UrlsParser.instance.domain?("google.it")).to be_truthy
+      expect(Apes::UrlsParser.instance.domain?("google.co")).to be_truthy
+      expect(Apes::UrlsParser.instance.domain?("fab.foog.google.co")).to be_truthy
+      expect(Apes::UrlsParser.instance.domain?("google.co:123/abc?query=a&utc=b#whatever")).to be_falsey
+      expect(Apes::UrlsParser.instance.domain?("google.c")).to be_falsey
+      expect(Apes::UrlsParser.instance.domain?("google.it:123")).to be_falsey
+    end
+  end
+  
+  describe "#shortened?" do
+    it "should recognize whether a URL is a shortened one" do
+      expect(Apes::UrlsParser.instance.shortened?("https://bit.ly/ABC")).to be_truthy
+      expect(Apes::UrlsParser.instance.shortened?("bit.ly/ABC")).to be_truthy
+      expect(Apes::UrlsParser.instance.shortened?("bit.ly/ACC")).to be_truthy
+      expect(Apes::UrlsParser.instance.shortened?("cow.tc/ACC")).to be_falsey
+      expect(Apes::UrlsParser.instance.shortened?("cow.tc/ACC", "cow.tc")).to be_truthy
+      expect(Apes::UrlsParser.instance.shortened?("abit.ly/ACC")).to be_falsey
+    end
+  end
+  
+  describe "#extract_urls" do
+    it "should extract URLS from a text" do
+      text = "
+        This is a pretty complex text. It has a URL without a domain which is google.it, also it contains a separator and now let's also put two
+        overlapping URLs http://cowtech.it and http://cowtech.it/en and, finally, a shortened one http://bit.ly/1000 and one using custom domain
+        http://cnn.it/1GFkZQs and email test@gmail.com. Fun, isn't it?
+      "
+      
+      expect(Apes::UrlsParser.instance.extract_urls(text)).to eq(["google.it", "http://cowtech.it", "http://cowtech.it/en", "http://bit.ly/1000", "http://cnn.it/1GFkZQs"])
+      expect(Apes::UrlsParser.instance.extract_urls(text, sort: :asc)).to eq(["google.it", "http://cowtech.it", "http://bit.ly/1000", "http://cowtech.it/en", "http://cnn.it/1GFkZQs"])
+      expect(Apes::UrlsParser.instance.extract_urls(text, sort: :desc)).to eq(["http://cnn.it/1GFkZQs", "http://cowtech.it/en", "http://bit.ly/1000", "http://cowtech.it", "google.it"])
+      expect(Apes::UrlsParser.instance.extract_urls(text, mode: :shortened)).to eq(["http://bit.ly/1000"])
+      expect(Apes::UrlsParser.instance.extract_urls(text, mode: :unshortened)).to eq(["google.it", "http://cowtech.it", "http://cowtech.it/en", "http://cnn.it/1GFkZQs"])
+      expect(Apes::UrlsParser.instance.extract_urls(text, mode: :shortened, shortened_domains: ["cnn.it"])).to eq(["http://bit.ly/1000", "http://cnn.it/1GFkZQs"])
+      expect(Apes::UrlsParser.instance.extract_urls(text, mode: :unshortened, shortened_domains: ["cnn.it"])).to eq(["google.it", "http://cowtech.it", "http://cowtech.it/en"])
+    end
+  end
+  
+  describe "#replace_urls" do
+    it "should replace URLS in a text" do
+      text = "
+        This is a pretty complex text. It has a URL without a domain which is google.it, also it contains a separator and now let's also put two
+        overlapping URLs http://cowtech.it and http://cowtech.it/en and, finally, a shortened one http://bit.ly/1000 and one using custom domain
+        http://cnn.it/1GFkZQs. Fun, isn't it?
+      "
+      
+      replacements = {
+        "http://cowtech.it" => "A",
+        "http://cowtech.it/en" => "B",
+        "http://bit.ly/1000" => "C",
+        "http://cnn.it/1GFkZQs" => "D"
+      }
+      
+      expect(Apes::UrlsParser.instance.replace_urls(text, replacements: replacements)).to eq("
+        This is a pretty complex text. It has a URL without a domain which is google.it, also it contains a separator and now let's also put two
+        overlapping URLs http://A and http://B and, finally, a shortened one http://C and one using custom domain
+        http://D. Fun, isn't it?
+      ")
+      
+      expect(Apes::UrlsParser.instance.replace_urls(text, replacements: replacements, mode: :unshortened)).to eq("
+        This is a pretty complex text. It has a URL without a domain which is google.it, also it contains a separator and now let's also put two
+        overlapping URLs http://A and http://B and, finally, a shortened one http://bit.ly/1000 and one using custom domain
+        http://D. Fun, isn't it?
+      ")
+      
+      expect(Apes::UrlsParser.instance.replace_urls(text, replacements: replacements, mode: :shortened)).to eq("
+        This is a pretty complex text. It has a URL without a domain which is google.it, also it contains a separator and now let's also put two
+        overlapping URLs http://cowtech.it and http://cowtech.it/en and, finally, a shortened one http://C and one using custom domain
+        http://cnn.it/1GFkZQs. Fun, isn't it?
+      ")
+      
+      expect(Apes::UrlsParser.instance.replace_urls(text, replacements: replacements, mode: :shortened, shortened_domains: ["cnn.it"])).to eq("
+        This is a pretty complex text. It has a URL without a domain which is google.it, also it contains a separator and now let's also put two
+        overlapping URLs http://cowtech.it and http://cowtech.it/en and, finally, a shortened one http://C and one using custom domain
+        http://D. Fun, isn't it?
+      ")
+    end
+  end
+  
+  describe "#clean" do
+    it "should remove separators after a url" do
+      expect(Apes::UrlsParser.instance.clean(" http://google.it ")).to eq("http://google.it")
+      expect(Apes::UrlsParser.instance.clean(" http://google.it,")).to eq("http://google.it")
+      expect(Apes::UrlsParser.instance.clean(" http://google.it.")).to eq("http://google.it")
+      expect(Apes::UrlsParser.instance.clean(" http://google.it:")).to eq("http://google.it")
+    end
+  end
+  
+  describe "#hashify" do
+    it "should generate a hash out of a URL" do
+      expect(Apes::UrlsParser.instance.hashify("google.it")).to eq("dae16e97dcaa41bdace5765826a28a4192b7f2ec9d96993d158ef0413fd3cab5")
+      expect(Apes::UrlsParser.instance.hashify("http://google.it")).to eq("dae16e97dcaa41bdace5765826a28a4192b7f2ec9d96993d158ef0413fd3cab5")
+      expect(Apes::UrlsParser.instance.hashify("bit.ly/1000")).to eq("1de660471e79f834336526379fd76bebbcb69057f36237bdd82f8af58d9641de")
+      expect(Apes::UrlsParser.instance.hashify("http://bit.ly/1000")).to eq("1de660471e79f834336526379fd76bebbcb69057f36237bdd82f8af58d9641de")
+    end
+  end
+end

data/spec/apes/validators_spec.rb

@@ -0,0 +1,237 @@
+#
+# This file is part of the apes gem. Copyright (C) 2016 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Apes::Validators::BaseValidator do
+  class BaseMockValidationValidator < Apes::Validators::BaseValidator
+    def check_valid?(_)
+      false
+    end
+  end
+  
+  class BaseMockModel
+    include ActiveModel::Validations
+    include Apes::Model
+    
+    attr_reader :field, :other_field
+    validates :field, "base_mock_validation" => {message: "ERROR"}
+    validates :other_field, "base_mock_validation" => {default_message: "DEFAULT", additional: true}
+  end
+  
+  describe "#validate_each" do
+    it "should correctly record messages" do
+      subject = BaseMockModel.new
+      subject.validate
+      expect(subject.errors.to_hash).to eq({field: ["ERROR"]})
+      expect(subject.additional_errors.to_hash).to eq({other_field: ["DEFAULT"]})
+    end
+  end
+end
+
+describe Apes::Validators::UuidValidator do
+  class UUIDMockModel
+    include ActiveModel::Validations
+    include Apes::Model
+    
+    attr_accessor :field
+    validates :field, "apes/validators/uuid" => true
+  end
+  
+  describe "#validate_each" do
+    it "should correctly validate fields" do
+      subject = UUIDMockModel.new
+      
+      subject.field = "d250e78f-887a-4da2-8b4f-59f61c809bed"
+      subject.validate
+      expect(subject.errors.to_hash).to eq({})
+      
+      subject.field = "100"
+      subject.validate
+      expect(subject.errors.to_hash).to eq({field: ["must be a valid UUID"]})
+    end
+  end
+end
+
+describe Apes::Validators::ReferenceValidator do
+  class ReferenceMockOtherModel
+    SECONDARY_QUERY = "name = :id"
+  end
+
+  class ReferenceMockModel
+    include ActiveModel::Validations
+    include Apes::Model
+
+    attr_accessor :field
+    validates :field, "apes/validators/reference" => {class_name: "reference_mock_other_model"}
+  end
+
+  describe "#validate_each" do
+    before(:each) do
+      allow(ReferenceMockOtherModel).to receive(:find_with_any).and_return(false)
+    end
+
+    it "should correctly validate fields" do
+      subject = ReferenceMockModel.new
+      subject.field = 100
+      subject.validate
+      expect(subject.errors.to_hash).to eq({field: ["must be a valid ReferenceMockOtherModel (cannot find a ReferenceMockOtherModel with id \"100\")"]})
+    end
+
+    it "should correctly validate fields when they are array" do
+      subject = ReferenceMockModel.new
+      subject.field = [100, 101]
+      subject.validate
+      expect(subject.errors.to_hash).to eq({field: ["must be a valid ReferenceMockOtherModel (cannot find a ReferenceMockOtherModel with id \"100\")", "must be a valid ReferenceMockOtherModel (cannot find a ReferenceMockOtherModel with id \"101\")"]})
+    end
+  end
+end
+
+describe Apes::Validators::EmailValidator do
+  class EmailMockModel
+    include ActiveModel::Validations
+    include Apes::Model
+    
+    attr_accessor :field
+    validates :field, "apes/validators/email" => true
+  end
+  
+  describe "#validate_each" do
+    it "should correctly validate fields" do
+      subject = EmailMockModel.new
+      subject.field = 100
+      subject.validate
+      expect(subject.errors.to_hash).to eq({field: ["must be a valid email"]})
+    end
+  end
+end
+
+describe Apes::Validators::BooleanValidator do
+  class BooleanMockModel
+    include ActiveModel::Validations
+    include Apes::Model
+    
+    attr_accessor :field
+    validates :field, "apes/validators/boolean" => true
+  end
+  
+  describe ".parse" do
+    it "should correctly parse a value" do
+      expect(Apes::Validators::BooleanValidator.parse("YES")).to be_truthy
+      expect(Apes::Validators::BooleanValidator.parse("OTHER")).to be_falsey
+    end
+    
+    it "should raise errors if asked to" do
+      expect(Apes::Validators::BooleanValidator.parse(nil, raise_errors: true)).to be_falsey
+      expect { Apes::Validators::BooleanValidator.parse("", raise_errors: true) }.to raise_error(ArgumentError, "Invalid boolean value \"\".")
+      expect { Apes::Validators::BooleanValidator.parse("FOO", raise_errors: true) }.to raise_error(ArgumentError, "Invalid boolean value \"FOO\".")
+    end
+  end
+  
+  describe "#validate_each" do
+    it "should correctly validate fields" do
+      subject = BooleanMockModel.new
+      subject.field = 100
+      subject.validate
+      expect(subject.errors.to_hash).to eq({field: ["must be a valid truthy/falsey value"]})
+    end
+  end
+end
+
+describe Apes::Validators::PhoneValidator do
+  class PhoneMockModel
+    include ActiveModel::Validations
+    include Apes::Model
+    
+    attr_accessor :field
+    validates :field, "apes/validators/phone" => true
+  end
+  
+  describe "#validate_each" do
+    it "should correctly validate fields" do
+      subject = PhoneMockModel.new
+      
+      subject.field = "+1 650-762-4637"
+      subject.validate
+      expect(subject.errors.to_hash).to eq({})
+      
+      subject.field = "FOO"
+      subject.validate
+      expect(subject.errors.to_hash).to eq({field: ["must be a valid phone"]})
+    end
+  end
+end
+
+describe Apes::Validators::ZipCodeValidator do
+  class ZipCodeMockModel
+    include ActiveModel::Validations
+    include Apes::Model
+    
+    attr_accessor :field
+    validates :field, "apes/validators/zip_code" => true
+  end
+  
+  describe "#validate_each" do
+    it "should correctly validate fields" do
+      subject = ZipCodeMockModel.new
+      
+      subject.field = "12345"
+      subject.validate
+      expect(subject.errors.to_hash).to eq({})
+      
+      subject.field = "12345-6789"
+      subject.validate
+      expect(subject.errors.to_hash).to eq({})
+      
+      
+      subject.field = "100"
+      subject.validate
+      expect(subject.errors.to_hash).to eq({field: ["must be a valid ZIP code"]})
+    end
+  end
+end
+
+describe Apes::Validators::TimestampValidator do
+  class TimestampMockModel
+    include ActiveModel::Validations
+    include Apes::Model
+    
+    attr_accessor :field, :other_field
+    validates :field, "apes/validators/timestamp" => true
+    validates :other_field, "apes/validators/timestamp" => {formats: ["%Y"]}
+  end
+  
+  describe ".parse" do
+    it "should parse respecting formats, using ISO-8601 formats by default" do
+      ISO8601 = "%FT%T%z".freeze
+      FULL_ISO8601 = "%FT%T.%L%z".freeze
+
+      allow(Apes::RuntimeConfiguration).to receive(:timestamp_formats).and_return({default: "%FT%T%z", full: "%FT%T.%L%z", clean: "%Y%m%dT%H%M%S.%L%z", clean_full: "%Y%m%dT%H%M%S.%L%z"})
+      expect(Apes::Validators::TimestampValidator.parse("2016-05-04T03:02:01+06:00")).to eq(DateTime.civil(2016, 5, 4, 3, 2, 1, "+6"))
+      expect(Apes::Validators::TimestampValidator.parse("2016-05-04T03:02:01.789-05:00")).to eq(DateTime.civil(2016, 5, 4, 3, 2, 1.789, "-5"))
+      expect(Apes::Validators::TimestampValidator.parse("2016-05-04")).to be_nil
+      expect(Apes::Validators::TimestampValidator.parse("2016-05-04+06:00", formats: ["%F%z"])).to eq(DateTime.civil(2016, 5, 4, 0, 0, 0, "+6"))
+    end
+    
+    it "should raise errors if asked to" do
+      expect { Apes::Validators::TimestampValidator.parse("2016-05-04", raise_errors: true) } .to raise_error(ArgumentError, "Invalid timestamp \"2016-05-04\".")
+    end
+  end
+  
+  describe "#validate_each" do
+    it "should correctly validate fields" do
+      subject = TimestampMockModel.new
+      subject.field = 2016
+      subject.other_field = "xxxx"
+      subject.validate
+      expect(subject.errors.to_hash).to eq({field: ["must be a valid ISO 8601 timestamp"], other_field: ["must be a valid ISO 8601 timestamp"]})
+      
+      subject.field = Time.now
+      subject.other_field = "2016"
+      subject.validate
+      expect(subject.errors.to_hash).to eq({})
+    end
+  end
+end