iso4217-validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bec44bd4f8ca4f62c52469e6a0c325ec59a7080
+  data.tar.gz: 5244ece45f311f193d3c532f2a4ae8d0f4599e56
+SHA512:
+  metadata.gz: 7866593c40161948a24d456bda7f69092772b32673c6db6688230c51edc35c6acc4daad6a7f1b4b6180a62d64277382a88ee312cfe8632cf31827fa00434eca5
+  data.tar.gz: baccb5d028b4afbd55ac3e18aabd316661d2279d2bf262adad6f0eb322e2f016f916a05295deeea2f71f386caec2cb3d7f442df5dbde9167b2ab6b56549e8d4a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in iso4217-validator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Merlos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 merlos
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Iso4217::Validator
+
+Simple ruby on rails validator that checks if a value is a valid [ISO4217] (http://en.wikipedia.org/wiki/ISO_4217) code. 
+
+Examples of ISO4217 codes: EUR, USD, CHF, TWD, INR.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'iso4217-validator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iso4217-validator
+
+## Usage
+
+Include the validator in your model attribute this way: 
+
+```ruby
+  class TestModel < ActiveRecord::Base
+    include Iso4217::Validator
+    validates :currency_code, iso4217Code: true 
+  end
+```  
+
+currency_code attribute shall be defined as an string.
+
+If the currency_code is invalid the validator adds an :invalid message error, if you want to customize the error message you can use:
+
+```ruby
+  class TestModel < ActiveRecord::Base
+    include Iso4217::Validator
+    validates :currency_code, iso4217Code: {message: 'Oh! That's an invalid currency code.'}
+  end
+```
+
+Please bear in mind that the validator is case sensitive. So 'EUR' is a valid code but 'eur' is not.
+
+## Contributing
+
+1. Fork it ( http://github.com/merlos/iso4217-validator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature with tests'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Please add unit tests when including new features. 
+
+### Maintaining the list updated
+Source of the valid code list used: http://www.currency-iso.org/en/home/tables/table-a1.html
+The last version included in the gem: August 15, 2014.
+
+The gem source includes an script (bin/extractor.rb) that can extract the codes from the excel file and convert it into the
+ruby array which is used by the validator. You can find more instructions within the extractor.rb file.
+
+## License
+
+Copyright (c) 2014 Juan M. Merlos. Distributed under MIT License

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+# test ---
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+ end
+  
+desc "Run tests"
+task :default => :test
+# ----  

data/bin/extractor.rb

@@ -0,0 +1,86 @@
+#!/bin/ruby
+
+# Simple code list extractor
+#
+# This file gets the list of codes from a CSV file
+#
+# NOTE
+# This tool is intended to be used by the gem administrators
+# 
+# It expects a csv file in which there is a column where the 
+# currency codes of ISO4417 are defined. 
+# You can find an example here:
+# http://www.currency-iso.org/en/home/tables/table-a1.html
+#
+# The source file previously mentioned is an XLS (Excel), it has to be 
+# converted into CSV in order to be processed by this script
+#
+# In the ISO4217 table-a1 there are several currencies that are repeated.
+# basically this script just removes those duplicated.
+#
+# How to use the script:
+# 
+# 1) Change the config vars below
+# 2) Run the script:
+#      $ ruby extractor.rb
+#
+# 3) copy @output_file (def: tmp/valid_codes.rb) into lib/iso4217/validator/
+# 
+# Use tmp/ directory for the files, as it is already ignored on the git repository
+# 
+# if you get this error:
+#       invalid byte sequence in UTF-8 (ArgumentError)
+# You need to convert the file to UTF-8
+#    $ iconv -f ISO-8859-1 -t utf-8 table_a1.csv > table_a1_utf8.csv 
+
+#################################
+# Config 
+###################################
+#
+# path to the csv file with the codes
+@csv_file_path = '../tmp/table_a1.csv'
+#
+# output file path. Do not change the name "valid_codes.rb"
+@output_file = '../tmp/valid_codes.rb'
+#
+# first row with a code
+@first_row = 4 # starts in 1
+#
+# column in which the codes are
+@column = 2; # starts in 0, so this is the actual 4th row
+
+@separator = ';'
+############################################
+
+
+
+require 'csv'
+code_list = []
+current_row_num = 0
+CSV.foreach(@csv_file_path, {col_sep: @separator}) do |row|
+  current_row_num+= 1
+  if (current_row_num > @first_row)
+    if code_list.include? (row[@column]) 
+      next
+    end
+    code_list.push(row[@column]) unless row[@column].nil? 
+  end
+  
+end 
+
+# now create the output ruby file
+f = File.new(@output_file,  "w+")
+f.puts "module Iso4217"
+f.puts "  module Validator"
+f.puts "   Iso4217Codes = ["
+code_list.each_with_index do |code, index| 
+  line = "    \"#{code}\"" 
+  line = line + ',' if code != code_list.last
+  f.puts line
+end
+f.puts "   ]"
+f.puts "  end"
+f.puts "end"
+f.close
+
+

data/iso4217-validator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iso4217/validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "iso4217-validator"
+  spec.version       = Iso4217::Validator::VERSION
+  spec.authors       = ["merlos"]
+  spec.email         = ["jmmerlos@merlos.org"]
+  spec.summary       = %q{rails validator to check that a currency code is defined on the ISO4217}
+  spec.description   = %q{Ruby on Rails validator that verifies that a currency code belongs to the list defined in the ISO4217}
+  spec.homepage      = "http://github.com/merlos/iso4217-validator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "activerecord", "~> 0"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "minitest", "~> 0"
+
+end

data/lib/iso4217/validator.rb

@@ -0,0 +1,12 @@
+require "iso4217/validator/version"
+require 'iso4217/validator/valid_codes'
+module Iso4217
+  module Validator
+    
+    class Iso4217CodeValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        record.errors.add(attribute, options[:message] || :invalid) unless Iso4217Codes.include?(value) 
+    	end
+    end
+  end
+end

data/lib/iso4217/validator/valid_codes.rb

@@ -0,0 +1,185 @@
+module Iso4217
+  module Validator
+   Iso4217Codes = [
+    "AFN",
+    "EUR",
+    "ALL",
+    "DZD",
+    "USD",
+    "AOA",
+    "XCD",
+    "ARS",
+    "AMD",
+    "AWG",
+    "AUD",
+    "AZN",
+    "BSD",
+    "BHD",
+    "BDT",
+    "BBD",
+    "BYR",
+    "BZD",
+    "XOF",
+    "BMD",
+    "BTN",
+    "INR",
+    "BOB",
+    "BOV",
+    "BAM",
+    "BWP",
+    "NOK",
+    "BRL",
+    "BND",
+    "BGN",
+    "BIF",
+    "KHR",
+    "XAF",
+    "CAD",
+    "CVE",
+    "KYD",
+    "CLF",
+    "CLP",
+    "CNY",
+    "COP",
+    "COU",
+    "KMF",
+    "CDF",
+    "NZD",
+    "CRC",
+    "HRK",
+    "CUC",
+    "CUP",
+    "ANG",
+    "CZK",
+    "DKK",
+    "DJF",
+    "DOP",
+    "EGP",
+    "SVC",
+    "ERN",
+    "ETB",
+    "FKP",
+    "FJD",
+    "XPF",
+    "GMD",
+    "GEL",
+    "GHS",
+    "GIP",
+    "GTQ",
+    "GBP",
+    "GNF",
+    "GYD",
+    "HTG",
+    "HNL",
+    "HKD",
+    "HUF",
+    "ISK",
+    "IDR",
+    "XDR",
+    "IRR",
+    "IQD",
+    "ILS",
+    "JMD",
+    "JPY",
+    "JOD",
+    "KZT",
+    "KES",
+    "KPW",
+    "KRW",
+    "KWD",
+    "KGS",
+    "LAK",
+    "LBP",
+    "LSL",
+    "ZAR",
+    "LRD",
+    "LYD",
+    "CHF",
+    "LTL",
+    "MOP",
+    "MKD",
+    "MGA",
+    "MWK",
+    "MYR",
+    "MVR",
+    "MRO",
+    "MUR",
+    "XUA",
+    "MXN",
+    "MXV",
+    "MDL",
+    "MNT",
+    "MAD",
+    "MZN",
+    "MMK",
+    "NAD",
+    "NPR",
+    "NIO",
+    "NGN",
+    "OMR",
+    "PKR",
+    "PAB",
+    "PGK",
+    "PYG",
+    "PEN",
+    "PHP",
+    "PLN",
+    "QAR",
+    "RON",
+    "RUB",
+    "RWF",
+    "SHP",
+    "WST",
+    "STD",
+    "SAR",
+    "RSD",
+    "SCR",
+    "SLL",
+    "SGD",
+    "XSU",
+    "SBD",
+    "SOS",
+    "SSP",
+    "LKR",
+    "SDG",
+    "SRD",
+    "SZL",
+    "SEK",
+    "CHE",
+    "CHW",
+    "SYP",
+    "TWD",
+    "TJS",
+    "TZS",
+    "THB",
+    "TOP",
+    "TTD",
+    "TND",
+    "TRY",
+    "TMT",
+    "UGX",
+    "UAH",
+    "AED",
+    "USN",
+    "UYI",
+    "UYU",
+    "UZS",
+    "VUV",
+    "VEF",
+    "VND",
+    "YER",
+    "ZMW",
+    "ZWL",
+    "XBA",
+    "XBB",
+    "XBC",
+    "XBD",
+    "XTS",
+    "XXX",
+    "XAU",
+    "XPD",
+    "XPT",
+    "XAG"
+   ]
+  end
+end

data/lib/iso4217/validator/version.rb

@@ -0,0 +1,5 @@
+module Iso4217
+  module Validator
+    VERSION = "0.0.1"
+  end
+end

data/test/test_iso4217-validator.rb

@@ -0,0 +1,77 @@
+require 'rubygems'
+require "minitest/autorun"
+
+require 'active_record'
+require 'active_model'
+require 'iso4217/validator'
+
+module Iso4217
+  module Validator
+    
+    class SampleModel
+      include ActiveModel::Validations
+      include Iso4217::Validator
+      attr_accessor :code, :code_or_nil
+      
+      validates :code, iso4217Code: true 
+      
+      def initialize(attrs = {})
+        I18n.enforce_available_locales = false # added to avoid a deprecation message
+        attrs.each_pair { |k,v| send("#{k}=", v) }
+      end
+    end
+   
+    class SampleModelWithNil
+      include ActiveModel::Validations
+      include Iso4217::Validator
+      attr_accessor :code
+      
+      validates :code, iso4217Code: { message: "custom message"}, allow_nil: true
+      
+      def initialize(attrs = {})
+        I18n.enforce_available_locales = false # added to avoid a deprecation message
+        attrs.each_pair { |k,v| send("#{k}=", v) }
+      end
+    end
+   
+    class Iso4217ValidatorTests < Minitest::Test
+      def test_valid_code
+        m = SampleModel.new(code: 'EUR')
+        assert m.valid?
+      end
+      
+      def test_code_in_lowercase
+        m = SampleModel.new(code: 'eur')
+        assert m.invalid?
+        
+      end
+      
+      def test_invalid_code
+        m = SampleModel.new(code: 123)
+        assert m.invalid?
+      end
+      
+      def test_nil_code
+        m = SampleModel.new(code: nil)
+        assert m.invalid?
+      end
+      
+      def test_not_assigned
+        m = SampleModel.new
+        assert m.invalid?
+      end
+      
+      def test_not_assigned_in_sample_code_with_nil 
+        m = SampleModelWithNil.new
+        assert m.valid?
+      end
+      
+      def test_custom_message 
+        m = SampleModelWithNil.new(code: "invalid")
+        m.valid?
+        assert_equal 'custom message', m.errors[:code][0]
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: iso4217-validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- merlos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby on Rails validator that verifies that a currency code belongs to
+  the list defined in the ISO4217
+email:
+- jmmerlos@merlos.org
+executables:
+- extractor.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/extractor.rb
+- iso4217-validator.gemspec
+- lib/iso4217/validator.rb
+- lib/iso4217/validator/valid_codes.rb
+- lib/iso4217/validator/version.rb
+- test/test_iso4217-validator.rb
+homepage: http://github.com/merlos/iso4217-validator
+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.2.2
+signing_key: 
+specification_version: 4
+summary: rails validator to check that a currency code is defined on the ISO4217
+test_files:
+- test/test_iso4217-validator.rb
+has_rdoc: