coupon_code 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 135fb183f47db7cf01f192063d01aa2b215da141
+  data.tar.gz: 336135ed4bb5531220cb533fc2081c24f1815268
+SHA512:
+  metadata.gz: 4654f9a3b3b68f39509b038e5c877ca30e03c3c37fe2f38c56585c46254b725c0259ff62e2457010b4a82ad2e1d62fefe9a1358a688d29ab67d11b493fa0d036
+  data.tar.gz: bb8f29e3932e5e2c2f97cab42e4af463bda8fd4382e2d5bf996d905185cc60eb6b445dcac3fa3cf79b0995cdcfc6f757109c19c1088f733103e967cc3c8d9aee

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+script: 'bundle exec rake'
+addons:
+  code_climate:
+    repo_token: 8a7079440da500bd46bff928386a4a512cf5a3c314b4882a2ce7e6fe160b4f45

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in coupon_code.gemspec
+gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sanghyun Park
+
+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-ko.md

@@ -0,0 +1,61 @@
+# CouponCode
+
+이 루비 젬(Ruby Gem)은 쿠폰 코드를 만들고 검증하는 기능을 제공합니다.
+
+이 젬(Gem)은 [Grant][grant]가 작성한 [Algorithm::CouponCode][couponcode]를 루비(Ruby) 언어로 옮겨 구현한 것입니다.
+하지만 현 시점에는 원작이 가진 기능 중 기본적인 코드 생성/검증 기능만 구현되어 있다는 점을 주지해 주십시오. 평문을 입력해 코드를 생성하는 기능이나
+자동교정, jQuery 플러그인 등은 포함되어있지 않습니다.
+
+이 루비 젬은 [https://stripes.co.kr](https://stripes.co.kr)를 위해 개발됐습니다.
+
+## 설치
+
+애플리케이션의 Gemfile에 아래의 코드 한 줄을 추가하십시오:
+
+    gem 'coupon_code'
+
+그리고 다음 명령을 실행하십시오:
+
+    $ bundle
+
+또는 아래와 같이 직접 설치해 사용하십시오:
+
+    $ gem install coupon_code
+
+## 사용방법
+
+    >> require 'coupon_code'
+    >> code = CouponCode.generate
+    => "1K7Q-CTFM-LMTC"
+    >> CouponCode.validate(code)
+    => "1K7Q-CTFM-LMTC"
+    >> CouponCode.validate('1K7Q-CTFM-LMTO') # Invalid code
+    => nil
+
+## 테스팅
+
+```ruby
+$ bundle exec rake test
+```
+## Thanks to
+
+ - 펄로 작성된 [Grant McLean][grant]의 [Algorithm::CouponCode][couponcode]
+ - 자바스크립트로 작성된 [Andrew Chilton][chilts]의 [NodeJS implementation][node-couponcode]
+
+## 라이센스
+
+MIT. 자세한 내용은 [LICENSE][license]를 읽어주십시오.
+
+## 기여하기
+
+1. 이 저장소를 포크합니다.
+2. 새 기능을 위한 브랜치를 만듭니다. (`git checkout -b my-new-feature`)
+3. 작업한 변경 내역을 커밋합니다. (`git commit -am 'Add some feature'`)
+4. 깃헙 저장소의 브랜치에 푸시합니다. (`git push origin my-new-feature`)
+5. 풀 리퀘스트(Pull Request)를 해주십시오.
+
+[grant]: https://github.com/grantm/
+[couponcode]: https://github.com/grantm/Algorithm-CouponCode
+[chilts]: https://github.com/chilts
+[node-couponcode]: https://github.com/chilts/node-coupon-code
+[license]: https://raw.github.com/appsattic/node-coupon-code/master/LICENSE

data/README.md

@@ -0,0 +1,66 @@
+[![Build Status](https://travis-ci.org/baxang/coupon-code.svg)](https://travis-ci.org/baxang/coupon-code)
+[![Code Climate](https://codeclimate.com/github/baxang/coupon-code/badges/gpa.svg)](https://codeclimate.com/github/baxang/coupon-code)
+
+# CouponCode
+
+CouponCode gem generates and validates coupon codes.
+
+It is a Ruby implementation of [Grant][grant]'s [Algorithm::CouponCode][couponcode],
+but please note that only basic generation/validation functionality  implemented at the moment and
+some of the features the CPAN module provides such as feeding a plaintext, auto-correct, and jQuery plugin are
+not yet implemented.
+
+This gem is developed for https://stripes.co.kr
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'coupon_code'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coupon_code
+
+## Synopsis
+
+    >> require 'coupon_code'
+    >> code = CouponCode.generate
+    => "1K7Q-CTFM-LMTC"
+    >> CouponCode.validate(code)
+    => "1K7Q-CTFM-LMTC"
+    >> CouponCode.validate('1K7Q-CTFM-LMTO') # Invalid code
+    => nil
+
+## Testing
+
+```ruby
+$ bundle exec rake test
+```
+
+## Thanks to
+
+ - [Grant McLean][grant]'s [Algorithm::CouponCode][couponcode] in Perl
+ - [Andrew Chilton][chilts]'s [NodeJS implementation][node-couponcode] in JavaScript
+
+## License
+
+MIT. See [LICENSE][license] for more details.
+
+## Contributing
+
+1. Fork it ( https://github.com/baxang/coupon-code/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[grant]: https://github.com/grantm/
+[couponcode]: https://github.com/grantm/Algorithm-CouponCode
+[chilts]: https://github.com/chilts
+[node-couponcode]: https://github.com/chilts/node-coupon-code
+[license]: https://raw.github.com/appsattic/node-coupon-code/master/LICENSE

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end
+
+task :default => :test
+
+task :console do
+  exec "irb -r coupon_code -I ./lib"
+end

data/bin/coupon-code

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'coupon_code'
+
+code = CouponCode.generate
+puts code

data/coupon_code.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coupon_code/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'coupon_code'
+  spec.version       = CouponCode::VERSION
+  spec.authors       = ['Sanghyun Park']
+  spec.email         = ['sh@baxang.com']
+  spec.summary       = %q{Generate and validate coupon codes.}
+  spec.description   = %q{A Ruby implementation of Perl's Algorithm::CouponCode CPAN module.}
+  spec.homepage      = 'https://github.com/baxang/coupon-code'
+  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_development_dependency 'bundler',  '~> 1.7'
+  spec.add_development_dependency 'rake',     '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.5'
+end

data/lib/coupon_code.rb

@@ -0,0 +1,50 @@
+require "coupon_code/version"
+require 'securerandom'
+require 'digest/sha1'
+
+module CouponCode
+  SYMBOL = '0123456789ABCDEFGHJKLMNPQRTUVWXY'
+  PARTS  = 3
+  LENGTH = 4
+
+  def self.generate(options = { parts: PARTS })
+    num_parts = options.delete(:parts)
+
+    parts = []
+    (1..num_parts).each do |i|
+      part = ''
+      (1...LENGTH).each do |j|
+        part << randome_symbol
+      end
+      part << checkdigit_alg_1(part, i)
+      parts << part
+    end
+    parts.join('-')
+  end
+
+  def self.validate(orig, num_parts = PARTS)
+    code = orig.upcase
+    code.gsub!(/[^0-9A-Z]+/, '')
+    parts = code.scan(/[0-9A-Z]{#{LENGTH}}/)
+    return if parts.length != num_parts
+    parts.each_with_index do |part, i|
+      data  = part[0...(LENGTH - 1)]
+      check = part[-1]
+      return if check != checkdigit_alg_1(data, i + 1)
+    end
+    parts.join('-')
+  end
+
+  def self.checkdigit_alg_1(orig, check)
+
+    orig.split('').each_with_index do |c, i|
+      k = SYMBOL.index(c)
+      check = check * 19 + k
+    end
+    SYMBOL[ check % 31 ]
+  end
+
+  def self.randome_symbol
+    SYMBOL[ rand(SYMBOL.length) ]
+  end
+end

data/lib/coupon_code/version.rb

@@ -0,0 +1,3 @@
+module CouponCode
+  VERSION = "0.0.1"
+end

data/test/coupon_code_test.rb

@@ -0,0 +1,98 @@
+require 'test_helper'
+
+describe CouponCode do
+  describe 'Generator' do
+    def generate(*args)
+      CouponCode.generate(*args)
+    end
+
+    it 'should be loaded.' do
+      CouponCode.must_respond_to(:generate)
+    end
+
+    it 'should generate a code' do
+      generate.wont_be_empty
+    end
+
+    it 'should only contain uppercase letters, digits, and dashes.' do
+      generate.must_match(/^[0-9A-Z-]+$/)
+    end
+
+    it 'should look like XXXX-XXXX-XXXX.' do
+      generate.must_match(/^\w{4}-\w{4}-\w{4}$/)
+    end
+
+    it 'should generate different codes.' do
+      code1 = generate
+      code2 = generate
+      code1.wont_equal(code2)
+    end
+
+    it 'should generate an arbitrary number of parts.' do
+      generate(parts: 2).must_match(/^\w{4}-\w{4}$/)
+      generate(parts: 5).must_match(/^\w{4}-\w{4}-\w{4}-\w{4}-\w{4}$/)
+    end
+  end
+
+  describe 'Validator' do
+    it 'should be loaded.' do
+      CouponCode.must_respond_to(:validate)
+    end
+
+    it 'should fail to validate invalid code.' do
+      CouponCode.validate('').must_equal(nil)
+    end
+
+    it 'should accept a valid code.' do
+      CouponCode.validate('1K7Q-CTFM-LMTC').wont_be_nil
+    end
+
+    it 'should reject a short code.' do
+      CouponCode.validate('1K7Q-CTFM').must_be_nil
+    end
+
+    it 'should accept a short code with correct parts.' do
+      CouponCode.validate('1K7Q-CTFM', 2).wont_be_nil
+    end
+
+    it 'should reject a short code with wrong parts.' do
+      CouponCode.validate('CTFM-1K7Q', 2).must_be_nil
+    end
+
+    it 'should fix and validate a lowercase code.' do
+      code = '1k7q-ctfm-lmtc'
+      CouponCode.validate(code.downcase).must_equal(code.upcase)
+    end
+
+    it 'should validate alternative separators.' do
+      code = '1k7q/ctfm/lmtc'
+      CouponCode.validate(code).must_equal('1K7Q-CTFM-LMTC')
+
+      code = '1k7q ctfm lmtc'
+      CouponCode.validate(code).must_equal('1K7Q-CTFM-LMTC')
+
+      code = '1k7qctfmlmtc'
+      CouponCode.validate(code).must_equal('1K7Q-CTFM-LMTC')
+    end
+
+    it 'should valid code-pretest.' do
+      CouponCode.validate('1K7Q', 1).wont_be_nil
+      CouponCode.validate('1K7C', 1).must_be_nil
+
+      CouponCode.validate('1K7Q-CTFM', 2).wont_be_nil
+      CouponCode.validate('1K7Q-CTFW', 2).must_be_nil
+
+      CouponCode.validate('1K7Q-CTFM-LMTC', 3).wont_be_nil
+      CouponCode.validate('1K7Q-CTFM-LMT1', 3).must_be_nil
+
+      CouponCode.validate('7YQH-1FU7-E1HX-0BG9', 4).wont_be_nil
+      CouponCode.validate('7YQH-1FU7-E1HX-0BGP', 4).must_be_nil
+
+      CouponCode.validate('YENH-UPJK-PTE0-20U6-QYME', 5).wont_be_nil
+      CouponCode.validate('YENH-UPJK-PTE0-20U6-QYMT', 5).must_be_nil
+
+      CouponCode.validate('YENH-UPJK-PTE0-20U6-QYME-RBK1', 6).wont_be_nil
+      CouponCode.validate('YENH-UPJK-PTE0-20U6-QYME-RBK2', 6).must_be_nil
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'coupon_code'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: coupon_code
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sanghyun Park
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+description: A Ruby implementation of Perl's Algorithm::CouponCode CPAN module.
+email:
+- sh@baxang.com
+executables:
+- coupon-code
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README-ko.md
+- README.md
+- Rakefile
+- bin/coupon-code
+- coupon_code.gemspec
+- lib/coupon_code.rb
+- lib/coupon_code/version.rb
+- test/coupon_code_test.rb
+- test/test_helper.rb
+homepage: https://github.com/baxang/coupon-code
+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: Generate and validate coupon codes.
+test_files:
+- test/coupon_code_test.rb
+- test/test_helper.rb