spree_promo_user_usage_limit 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7235d225118aa976d48fb24dc2d8a74664ec23a6
+  data.tar.gz: 02ae4c12220a4e61e46686742166ac04de6201a7
+SHA512:
+  metadata.gz: 406421fa46f8702dd5c3c3a4015e2230e3608a64786e443debb9f51bd20988068602c1c339384d760a2f3db5baed4b1050a375a53a6902bc10f022b1d6d014a0
+  data.tar.gz: 3c3b7f00ea6d9c4b053dfa78e83061266883ceb3e3a44781ddbc57357da149702baaf3b63999e807700ef1d6a52c3b319bca2c50b11aa8762c10869bc3a0e5c2

data/.gitignore

@@ -0,0 +1,19 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+.ruby*
+doc/
+vendor/bundle/
+.bundle/
+bin/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,21 @@
+before_script:
+  - "bundle exec rake test_app"
+script:
+  - "bundle exec rspec spec"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - jruby-19mode
+  - jruby-21mode
+  - rbx-2
+env:
+  - DB=sqlite
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+    - rvm: jruby-21mode
+notifications:
+  recipients:
+    - swrobel@gmail.com

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 2.0.0, 2.1.0, 2.2.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+gem 'sqlite3', platforms: :ruby
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Stefan Wrobel
+
+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,60 @@
+Spree Promo User Usage Limit
+======================
+[![Build Status](http://img.shields.io/travis/swrobel/spree_promo_user_usage_limit/2-0-stable.svg)](https://travis-ci.org/swrobel/spree_promo_user_usage_limit) [![Dependency Status](http://img.shields.io/gemnasium/swrobel/spree_promo_user_usage_limit.svg)](https://gemnasium.com/swrobel/spree_promo_user_usage_limit) [![Coverage Status](http://img.shields.io/coveralls/swrobel/spree_promo_user_usage_limit/2-0-stable.svg)](https://coveralls.io/r/swrobel/spree_promo_user_usage_limit) [![Code Climate](http://img.shields.io/codeclimate/github/swrobel/spree_promo_user_usage_limit.svg)](https://codeclimate.com/github/swrobel/spree_promo_user_usage_limit)
+
+Adding this rule to a promo will allow you to set a limit on the number of completed orders for which a given user can apply it (default 1 use).
+
+![screenshot](screenshot.png)
+
+Installation
+------------
+
+1. Add spree_promo_user_usage_limit to your Gemfile:
+
+  ```ruby
+  gem 'spree_promo_user_usage_limit'
+  ```
+
+1. Bundle your dependencies:
+
+  ```shell
+  bundle
+  ```
+
+1. Add this rule to a promo and set the number of uses you want to allow
+
+1. Profit.
+
+Versioning
+----------
+Versions files the pattern MAJOR.MINOR.PATCH [SemVer-style](http://semver.org/). MAJOR.MINOR version will always match the Spree version that gem is compatible with. PATCH version is incremented as new bugfix releases of this gem come out, indepently of new Spree PATCH versions.
+
+For example, version 2.1.0 is compatible with the Spree 2.1.x series, while version 2.0.0 is compatible with the Spree 2.0.x series.
+
+You should not need to worry about this, as the gemspec has the appropriate constraints. But hey, the more you know.
+
+Testing
+-------
+This extension is tested against the following rubies:
+
+* 1.9.3
+* 2.0
+* 2.1
+* jruby-19mode
+* jruby-21mode (experimental)
+* rubinius (experimental)
+
+### Running the tests locally
+
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
+
+```shell
+bundle
+bundle exec rake test_app
+bundle exec rspec spec
+```
+
+License
+-------
+
+Copyright (c) 2014 Stefan Wrobel, released under the MIT License

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_promo_user_usage_limit'
+  Rake::Task['extension:test_app'].invoke
+end

data/Versionfile

@@ -0,0 +1,15 @@
+# This file is used to designate compatibilty with different versions of Spree
+# Please see http://spreecommerce.com/documentation/extensions.html#versionfile for details
+
+# Examples
+#
+# '1.2.x'  => { :branch => 'master' }
+# '1.1.x'  => { :branch => '1-1-stable' }
+# '1.0.x'  => { :branch => '1-0-stable' }
+# '0.70.x' => { :branch => '0-70-stable' }
+# '0.40.x' => { :tag => 'v1.0.0', :version => '1.0.0' }
+
+"2.3.x" => { :branch => "master" }
+"2.2.x" => { :branch => "2-2-stable" }
+"2.1.x" => { :branch => "2-1-stable" }
+"2.0.x" => { :branch => "2-0-stable" }

data/app/models/spree/promotion/rules/user_usage_limit.rb

@@ -0,0 +1,30 @@
+# A rule to restrict a promotion to N uses per user
+module Spree
+  class Promotion
+    module Rules
+      class UserUsageLimit < PromotionRule
+        preference :uses, :integer, default: 1
+
+        attr_accessible :preferred_uses
+
+        def applicable?(promotable)
+          promotable.is_a?(Spree::Order)
+        end
+
+        def eligible?(order, options = {})
+          if order.user
+            order_ids = order.user.orders.complete.pluck(:id)
+          elsif order.email
+            order_ids = Spree::Order.complete.where(email: order.email).pluck(:id)
+          else # user or email required to check against previous orders
+            return false
+          end
+          action_ids = promotion.actions.pluck(:id)
+          promotion_count = Spree::Adjustment.promotion.where(adjustable_id: order_ids).where(originator_id: action_ids).count
+
+          promotion_count < preferred_uses
+        end
+      end
+    end
+  end
+end

data/app/views/spree/admin/promotions/rules/_user_usage_limit.html.erb

@@ -0,0 +1,5 @@
+<div class="field alpha omega eight columns">
+  <label>
+    <%= Spree.t('user_usage_limit.label', input: text_field_tag("#{param_prefix}[preferred_uses]", promotion_rule.preferred_uses, style: 'width: 40px;')).html_safe %>
+  </label>
+</div>

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  spree:
+    promotion_rule_types:
+      user_usage_limit:
+        description: Can be used a limited number of times per user.
+        name: User usage limit
+    user_usage_limit:
+      label: Can only be used %{input} times per user

data/config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+end

data/lib/spree_promo_user_usage_limit/engine.rb

@@ -0,0 +1,25 @@
+module SpreePromoUserUsageLimit
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_promo_user_usage_limit'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+
+    initializer "spree_promo_user_usage_limit.register.promotion_rules" do |app|
+      app.config.spree.promotions.rules << Spree::Promotion::Rules::UserUsageLimit
+
+    end
+  end
+end

data/lib/spree_promo_user_usage_limit/factories.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_promo_user_usage_limit/factories'
+end

data/lib/spree_promo_user_usage_limit.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'spree_promo_user_usage_limit/engine'

data/spec/models/spree/promotion/rules/user_usage_limit_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Spree::Promotion::Rules::UserUsageLimit do
+  let(:user) { create(:user) }
+  let(:promotion) { create(:promotion) }
+  let(:rule) { Spree::Promotion::Rules::UserUsageLimit.create }
+
+  before do
+    promotion.rules << rule
+    promotion.actions << Spree::Promotion::Actions::CreateAdjustment.new
+  end
+
+  describe "#applicable?" do
+    context "with an order" do
+      let(:order) { mock_model(Spree::Order, :user => nil, :email => nil) }
+
+      it { rule.should be_applicable(order) }
+    end
+
+    context "with a promotion" do
+      it { rule.should_not be_applicable(promotion) }
+    end
+  end
+
+  context "without a user or guest email" do
+    let(:order) { mock_model(Spree::Order, :user => nil, :email => nil) }
+
+    it { rule.should_not be_eligible(order) }
+  end
+
+  context "for a signed user" do
+    context "with no completed orders" do
+      let(:order) { mock_model(Spree::Order, :user => user) }
+
+      it { rule.should be_eligible(order) }
+    end
+
+    context "with a completed order" do
+      let(:order) { create(:completed_order_with_totals, user: user) }
+
+      context "that didn't use the promo" do
+        it { rule.should be_eligible(order) }
+      end
+
+      context "that used the promo" do
+        before { create(:adjustment, adjustable: order, source: order, originator: promotion.actions.first) }
+
+        it { rule.should_not be_eligible(order) }
+      end
+    end
+
+    context "with an incomplete order that used the promo" do
+      let(:order) { create(:order_with_totals, user: user) }
+      before { create(:adjustment, adjustable: order, source: order, originator: promotion.actions.first) }
+
+      it { rule.should be_eligible(order) }
+    end
+  end
+
+  context "for a guest user" do
+    let(:email) { 'user@spreecommerce.com' }
+    let(:order) { create(:completed_order_with_totals, email: email) }
+
+    context "with no other orders" do
+      it { rule.should be_eligible(order) }
+    end
+
+    context "with another order" do
+      before { create(:adjustment, adjustable: order, source: order, originator: promotion.actions.first) }
+
+      it { rule.should_not be_eligible(order) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,57 @@
+# Run Coverage report
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter 'spec/dummy'
+  add_filter 'vendor'
+  add_filter 'bin'
+  add_group 'Controllers', 'app/controllers'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Mailers', 'app/mailers'
+  add_group 'Models', 'app/models'
+  add_group 'Views', 'app/views'
+  add_group 'Libraries', 'lib'
+end
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'rspec/rails'
+require 'ffaker'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+# Requires factories defined in spree_core
+require 'spree/testing_support/factories'
+
+# Requires factories defined in lib/spree_promo_user_usage_limit/factories.rb
+require 'spree_promo_user_usage_limit/factories'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  config.color = true
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  config.use_transactional_fixtures = true
+
+  config.fail_fast = ENV['FAIL_FAST'] || false
+end

data/spree_promo_user_usage_limit.gemspec

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_promo_user_usage_limit'
+  s.version     = '2.0.0'
+  s.summary     = 'Allow each user to use a promotion a maximum of N times'
+  s.description = 'Adding this rule to a promo will allow you to set a limit on the number of completed orders for which a given user can apply it (default 1 use).'
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.author    = 'Stefan Wrobel'
+  s.email     = 'swrobel@gmail.com'
+  s.homepage  = 'https://github.com/swrobel/spree_promo_user_usage_limit'
+  s.license   = 'MIT'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'spree_core', '~> 2.0.0'
+
+  s.add_development_dependency 'factory_girl', '~> 4.4'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'rspec-rails',  '~> 2.13'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: spree_promo_user_usage_limit
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Stefan Wrobel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: coveralls
+  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: Adding this rule to a promo will allow you to set a limit on the number
+  of completed orders for which a given user can apply it (default 1 use).
+email: swrobel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Versionfile
+- app/models/spree/promotion/rules/user_usage_limit.rb
+- app/views/spree/admin/promotions/rules/_user_usage_limit.html.erb
+- config/locales/en.yml
+- config/routes.rb
+- lib/spree_promo_user_usage_limit.rb
+- lib/spree_promo_user_usage_limit/engine.rb
+- lib/spree_promo_user_usage_limit/factories.rb
+- screenshot.png
+- spec/models/spree/promotion/rules/user_usage_limit_spec.rb
+- spec/spec_helper.rb
+- spree_promo_user_usage_limit.gemspec
+homepage: https://github.com/swrobel/spree_promo_user_usage_limit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Allow each user to use a promotion a maximum of N times
+test_files:
+- spec/models/spree/promotion/rules/user_usage_limit_spec.rb
+- spec/spec_helper.rb