voucher_code 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c62dae152ad5180eafaa98d79fe3bf685c4cfec7a0cbe076ee0c49dc9672420
+  data.tar.gz: e0c33794ed26111b5e3c031dd16cd2b8d713e9b3d4330f5f81d2169385751c98
+SHA512:
+  metadata.gz: cedc166133946adaa6e0295dc2aa01bca797410477c0ae2cbd6cc32a0fa68ac5f6e97c9b8ded3e82df96052be6edf960e4803ddb4980495012a05b7b280878ee
+  data.tar.gz: bb9f38bd9688ef9ce4ed4a88da0141177baf14f5ffd0532e53143755cec811cb5c067f246f22255233f699a229e7b37fd3075e43e8671bcf1d036ea640214610

data/README.md

@@ -0,0 +1,87 @@
+# Coupon/Voucher Code Generator
+
+Generate unique, random, and hard to guess coupon/voucher codes. Use cases: promo codes, loyalty coupons, gift vouchers, in-app purchases, referral links
+
+This project was inspired from https://github.com/rspective/voucher-code-generator-js
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'voucher_code'
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
+
+## API Reference
+
+### Generate voucher code
+
+Add this snippet to your base code
+
+```ruby
+VoucherCode.generate
+```
+
+If you would like to use custom configuration, there are several attributes you have to understand first.
+
+**Count**
+It used for returning {:count} generated voucher codes
+By default, it sets to 1
+
+**Length**
+
+It used for returning generated voucher codes based on length configuration
+By default, it sets to 8
+
+**Charset**
+
+It used for generating voucher code
+Use this three options:
+config.charset = '0123456789'
+config.charset = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+config.charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+You can also use your own custom charset
+By default, if sets to '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+
+**Prefix**
+
+It used for append prefix before generated voucher code
+For example:
+config.prefix = '2020-'
+It generates 2020-${voucher_code}
+By default, it sets to empty string/''
+
+**Postfix**
+
+It used for append postfix after generated voucher code
+For example:
+config.postfix = '-2020'
+It generates ${voucher_code}-2020
+By default, it sets to empty string/''
+
+**Pattern**
+
+It used for generate voucher code based on your customize pattern
+For example:
+config.pattern = '####-####'
+It generates 'ABHs-12Lo'
+By default, it sets to '########' where it depends on config.length
+
+```ruby
+configuration = {
+  count: 1,
+  length: 8,
+  charset: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ',
+  prefix: 'abcd-',
+  postfix: '-2020',
+  pattern: '########'
+}
+
+VoucherCode.generate(configuration)
+```

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'voucher_code'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,59 @@
+# VoucherCode Global Configuration
+
+VoucherCode.defaults do |config|
+  # ## Count
+  #
+  # It used for returning {:count} generated voucher codes
+  # By default, it sets to 1
+  #
+  # config.count = 1
+
+  # ## Length
+  #
+  # It used for returning generated voucher codes based on length configuration
+  # By default, it sets to 8
+  #
+  # config.length = 8
+
+  # ## Charset
+  #
+  # It used for generating voucher code
+  # Use this three options:
+  # config.charset = '0123456789'
+  # config.charset = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+  # config.charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+  # You can also use your own custom charset
+  # By default, if sets to '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+  #
+  # config.charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+
+  # ## Prefix
+  #
+  # It used for append prefix before generated voucher code
+  # For example:
+  # config.prefix = '2020-'
+  # It generates 2020-${voucher_code}
+  # By default, it sets to empty string/''
+  #
+  # config.prefix = ''
+
+  # ## Postfix
+  #
+  # It used for append postfix after generated voucher code
+  # For example:
+  # config.postfix = '-2020'
+  # It generates ${voucher_code}-2020
+  # By default, it sets to empty string/''
+  #
+  # config.postfix = ''
+
+  # ## Pattern
+  #
+  # It used for generate voucher code based on your customize pattern
+  # For example:
+  # config.pattern = '####-####'
+  # It generates 'ABHs-12Lo'
+  # By default, it sets to '########' where it depends on config.length
+  #
+  # config.pattern = ''
+end

data/lib/generators/voucher_code_generator.rb

@@ -0,0 +1,11 @@
+require 'rails/generators'
+
+class VoucherCodeGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('templates', __dir__)
+  desc 'Preparing required file for voucher code integration'
+
+  def copy_initializer
+    template 'initializer.rb', 'config/initializers/voucher_code.rb'
+  end
+end

data/lib/voucher_code/config.rb

@@ -0,0 +1,82 @@
+require_relative 'resources/charset'
+require_relative 'helpers/randomize'
+
+module VoucherCode
+  # Voucher code configuration
+  class Config
+    attr_reader :config,
+                :count,
+                :length,
+                :charset,
+                :prefix,
+                :postfix,
+                :pattern
+
+    def initialize(config = {})
+      @config = config || {}
+      @count = config[:count] || 1
+      @length = config[:length] || 8
+      @charset = config[:charset] || select_charset('alphanumeric')
+      @prefix = config[:prefix] || ''
+      @postfix = config[:postfix] || ''
+
+      @pattern = if config[:pattern].nil? || config[:pattern].empty?
+                  looping('#', @length)
+                else
+                  config[:pattern]
+                end
+    end
+
+    def generate
+      raise 'Not possible to generate some requested codes.' unless feasible?
+
+      codes = {}
+      while @count.positive?
+        code = generate_single_data
+
+        unless codes[code]
+          codes[code] = true
+          @count -= 1
+        end
+      end
+
+      codes.keys
+    end
+
+    private
+
+    def looping(str, length)
+      result = ''
+
+      i = 0
+      until i > length - 1
+        result += str
+        i += 1
+      end
+
+      result
+    end
+
+    def select_charset(name)
+      selected_charset = Resources::CHARSET[name.to_sym]
+
+      raise 'Invalid charset' unless selected_charset
+
+      selected_charset
+    end
+
+    def generate_single_data
+      code = @pattern.split('').map { |char|
+        char == '#' ?
+          Helpers::Randomize.random_element(@charset) :
+          char
+      }.join('')
+
+      "#{@prefix}#{code}#{@postfix}"
+    end
+
+    def feasible?
+      (@length ** (@pattern.match(/#/) || []).length) >= @count
+    end
+  end
+end

data/lib/voucher_code/helpers/randomize.rb

@@ -0,0 +1,15 @@
+module VoucherCode
+  module Helpers
+    class Randomize
+      class << self
+        def random_int(min, max)
+          (rand * (max - min + 1)).floor + min
+        end
+
+        def random_element(array)
+          array[random_int(0, array.length - 1)]
+        end
+      end
+    end
+  end
+end

data/lib/voucher_code/resources/charset.rb

@@ -0,0 +1,9 @@
+module VoucherCode
+  module Resources
+    CHARSET = {
+      numbers: '0123456789'.freeze,
+      alphabetic: 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.freeze,
+      alphanumeric: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.freeze
+    }
+  end
+end

data/lib/voucher_code/version.rb

@@ -0,0 +1,3 @@
+module VoucherCode
+  VERSION = '1.1.1'.freeze
+end

data/lib/voucher_code.rb

@@ -0,0 +1,25 @@
+require_relative 'voucher_code/version'
+require_relative 'voucher_code/config'
+
+# Generate voucher code
+module VoucherCode
+  class << self
+    def generate(config = {})
+      config = @defaults if @defaults
+
+      configuration = Config.new(config)
+      configuration.generate
+    end
+
+    # Set global defaults for generating voucher code.
+    # @example
+    #   VoucherCode.defaults do |config|
+    #     config.count = 1
+    #     ...
+    #   end
+    def defaults(&block)
+      @defaults = block if block_given?
+      @defaults
+    end
+  end
+end

data/voucher_code.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'voucher_code/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'voucher_code'
+  spec.version       = VoucherCode::VERSION
+  spec.authors       = ['Eka Pramudita D.']
+  spec.email         = ['edharmowongso@gmail.com']
+
+  spec.summary       = %q{A simple gem to generate unique, random, and hard to guess coupon/voucher codes}
+  spec.description   = %q{A simple gem to generate unique, random, and hard to guess coupon/voucher codes. This project was inspired from https://github.com/rspective/voucher-code-generator-js}
+  spec.homepage      = 'https://github.com/edharmowongso/voucher-code'
+  spec.license       = 'MIT'
+
+  spec.require_paths = %w(lib)
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_rubygems_version = '>= 1.3.5'
+  spec.files = %w(voucher_code.gemspec) + Dir['*.md', 'bin/*', 'lib/**/*.rb', 'lib/**/**/*.rb']
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: voucher_code
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Eka Pramudita D.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple gem to generate unique, random, and hard to guess coupon/voucher
+  codes. This project was inspired from https://github.com/rspective/voucher-code-generator-js
+email:
+- edharmowongso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/console
+- bin/setup
+- lib/generators/templates/initializer.rb
+- lib/generators/voucher_code_generator.rb
+- lib/voucher_code.rb
+- lib/voucher_code/config.rb
+- lib/voucher_code/helpers/randomize.rb
+- lib/voucher_code/resources/charset.rb
+- lib/voucher_code/version.rb
+- voucher_code.gemspec
+homepage: https://github.com/edharmowongso/voucher-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: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple gem to generate unique, random, and hard to guess coupon/voucher
+  codes
+test_files: []