promocode_generator 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Mjg4Y2M2NTJlZmI2MjVmNzczMDk5NDc1ZjdkZTRhNDRmYTYxNDI2Zg==
+  data.tar.gz: !binary |-
+    ZTU3ZjgwZWQ0ZmI1ZWY3ZjBkOTkzYmYzZjZlMjJmN2ZjNzkxZGNmZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YzM2YWI5ZTQzZjE1YjgwMmI2NGJhMTEzOWUxNWU4MmE0NWQ2NWRkNmQ5NDJk
+    MDhhOGNkNTY1NjMxOGI5YmY0N2UzYTQ0NGU4MTk2YjFlN2ExOTRkODQ0Mjlh
+    MWJhY2JiMmE5OGQ5MDI1N2I2YmEyNGMwMWJlN2MyNzExYzRjODU=
+  data.tar.gz: !binary |-
+    ZjY3MWNkZTIxMzM5ZjAwNmY2Yjg1MDY5MjYwMGExZjBhOTQwM2E5MTJmN2Vm
+    MGUxNzRlOTgwZDhkMmYyMjVmZjRhM2IwYjNjYjA0ZWFlZTZiODZlZjVkNWU3
+    YmZkZjgyZjc3YzgyNjJlNDc2N2M2Yjg1ZWQ2MzUxY2I2OGMwMTc=

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/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pascal Ehlert
+
+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,44 @@
+# Promocode Generator
+
+Generates save and unique (when used with AR) codes which can be handed to customers for promotional campaigns.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'promocode_generator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install promocode_generator
+
+## Usage
+
+Without Rails:
+  
+  Use PromocodeGenerator.generate(length) to produce a promotional code of the desired length.
+
+With Rails:
+
+  In your model, use the promocode_attribute method to automatically generate a promotional code of length 8 in the before_save hook:
+  
+  ```ruby
+  class Campaign < ActiveRecord::Base
+    promocode_attribute :code
+  end
+  ```
+  
+  Basic uniqueness validation comes by default so that codes are generated until a non-existing code is found in the db. Provide the :reject_if option to customize:
+  `promocode_attribute :code, :reject_if => Proc.new { |code| ModelA.where(:code => code).any? }`
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/promocode_generator/model_additions.rb

@@ -0,0 +1,14 @@
+module PromocodeGenerator
+  module ModelAdditions
+    def promocode_attribute(attribute, options = {})
+      options[:reject_if] ||= Proc.new { |code| self.where(attribute => code).any? }
+
+      before_save do
+        # Make sure not to generate the same code twice!
+        begin
+          self.code = PromocodeGenerator.generate
+        end while options[:reject_if].call(code)
+      end 
+    end
+  end
+end

data/lib/promocode_generator/version.rb

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

data/lib/promocode_generator.rb

@@ -0,0 +1,11 @@
+require "promocode_generator/version"
+require "promocode_generator/model_additions"
+
+module PromocodeGenerator
+  # Generates an 8 character random code of uppercase letters and numbers
+  # It explicitly excludes the letters I, L, O and the number 0 to avoid
+  # confusion
+  def self.generate(length = 8)
+    [('A'..'Z').to_a - ['I', 'L', 'O'], ('1'..'9').to_a].flatten.shuffle[0,length].join
+  end
+end

data/promocode_generator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'promocode_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "promocode_generator"
+  spec.version       = PromocodeGenerator::VERSION
+  spec.authors       = ["Pascal Ehlert"]
+  spec.email         = ["pascal@hacksrus.net"]
+  spec.description   = %q{}
+  spec.summary       = %q{Generates a safe, unique and easy to quote promotional code}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "supermodel"
+end

data/spec/promocode_generator/model_additions_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+# Dummy reject condition that can be stubbed in the tests below
+module RejectCondition
+  def self.check(code)
+    false 
+  end
+end
+
+class Campaign < SuperModel::Base
+  include ActiveModel::Validations::Callbacks
+  extend PromocodeGenerator::ModelAdditions
+  promocode_attribute :code, :reject_if => Proc.new { |code| RejectCondition.check(code) }
+end
+
+describe PromocodeGenerator::ModelAdditions do
+  let(:campaign) { Campaign.new(:name => "foo") }
+
+  context "when the model is saved" do
+    it "generates a code" do
+      expect(PromocodeGenerator).to receive(:generate).once.and_return('ABCDEFG')
+      campaign.save!
+    end
+
+    it "assigns the code to the model" do
+      campaign.save!
+      expect(campaign.code).not_to be_nil
+    end
+  end
+
+  context "when the reject_if block returns false" do
+    before { RejectCondition.stub(:check).and_return(true, false) }
+    after { RejectCondition.unstub(:check) }
+
+    it "generates a new code" do
+      expect(PromocodeGenerator).to receive(:generate).exactly(2).times
+      campaign.save!
+    end
+  end
+end

data/spec/promocode_generator_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe PromocodeGenerator do
+  describe ".generate" do
+    it "generates a code of the given length" do
+      expect(PromocodeGenerator.generate(10).length).to eq(10)
+    end
+
+    it "generates a code with default length" do
+      expect(PromocodeGenerator.generate.length).to be > 0
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'promocode_generator'
+require 'supermodel'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: promocode_generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pascal Ehlert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  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: supermodel
+  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: ''
+email:
+- pascal@hacksrus.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/promocode_generator.rb
+- lib/promocode_generator/model_additions.rb
+- lib/promocode_generator/version.rb
+- promocode_generator.gemspec
+- spec/promocode_generator/model_additions_spec.rb
+- spec/promocode_generator_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Generates a safe, unique and easy to quote promotional code
+test_files:
+- spec/promocode_generator/model_additions_spec.rb
+- spec/promocode_generator_spec.rb
+- spec/spec_helper.rb