spree_pay_cash_on_delivery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d57538d652e1803ab90d194e4535920ce3c85466
+  data.tar.gz: 30d1f1c97989e4f7d75afacd65a05dd5649d2fbb
+SHA512:
+  metadata.gz: dd8b03960a1142e3134dbe21c9c669921634145334a2d3384416f89b260971c4d99ac5f040dbc8506f1694cfceaa2665f35159741d32eb91a3005e44b9bf79cb
+  data.tar.gz: 32753a9c42666c722e7112b5721df1d0985c86026faa7bd4754378180ced67871da39eb5b4e925f6cad1a3f96c822f4f8fef6eddb788ebd65f55863963186a7d

data/.gitignore

@@ -0,0 +1,14 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', branch: '2-4-stable'
+# Provides basic authentication functionality for testing parts of your engine
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '2-4-stable'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2014 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,31 @@
+SpreePayCashOnDelivery
+======================
+
+Adds 'Cash on delivery' payment method to Spree Commerce with ability to set delivery fees in the admin panel.
+ 
+
+Installation
+------------
+
+Add spree_pay_cash_on_delivery to your Gemfile:
+
+```ruby
+gem 'spree_pay_cash_on_delivery', github: 'sliaquat/spree_pay_cash_on_delivery'
+```
+
+Then run:
+
+```ruby
+bundle install
+```
+ 
+Usage
+-----
+ 
+ - For adding 'Cash on delivery' payment method, log in to the admin back end ("http://localhost:3000/admin") and go to "Configurations" > "Payment Methods". Click "New Payment Method" and select 
+ "Spree::CashOnDelivery::PaymentMethod" form the provider drop down. Save.
+ 
+ 
+ - For setting the 'Cash on delivery' fee, log in to the admin back end ("http://localhost:3000/admin") and go to "Configurations" > "Cash on delivery config"
+
+Copyright (c) 2014 Sanad Liaquat, released under the New BSD 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_pay_cash_on_delivery'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/spree_pay_cash_on_delivery.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'

data/app/assets/javascripts/spree/frontend/spree_pay_cash_on_delivery.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/spree_pay_cash_on_delivery.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

data/app/assets/stylesheets/spree/frontend/spree_pay_cash_on_delivery.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/controllers/spree/admin/cash_on_delivery_configs_controller.rb

@@ -0,0 +1,19 @@
+
+
+module Spree
+  module Admin
+    class CashOnDeliveryConfigsController < Spree::Admin::BaseController
+
+      def edit
+        @charge = Spree::CashOnDelivery::Config.charge
+      end
+
+      def update
+        Spree::CashOnDelivery::Config.charge = params[:cash_on_delivery_charge]
+        flash[:success] = "Cash on delivery charge has been updated"
+        redirect_to edit_admin_cash_on_delivery_configs_path
+      end
+
+    end
+  end
+end

data/app/models/spree/cash_on_delivery/payment_method.rb

@@ -0,0 +1,80 @@
+module Spree
+
+  module CashOnDelivery
+
+
+    class PaymentMethod < Spree::PaymentMethod
+
+      def payment_profiles_supported?
+        false # we want to show the confirm step.
+      end
+
+
+      def create_adjustment(payment)
+        adjustment = Spree::Adjustment.create(
+            amount: Spree::CashOnDelivery::Config.charge.to_f,
+            order: payment.order,
+            adjustable: payment.order,
+            source: self,
+            :mandatory => true,
+            :included => true,
+            label: "Cash On Delivery Fee"
+        )
+
+        payment.order.adjustments << adjustment
+
+        payment.update_attribute(:amount, payment.amount + Spree::CashOnDelivery::Config.charge.to_f)
+        payment.order.updater.update_adjustment_total
+        payment.order.updater.update_order_total
+        payment.order.persist_totals
+        # end
+      end
+
+
+      def authorize(*args)
+        ActiveMerchant::Billing::Response.new(true, "", {}, {})
+      end
+
+      def capture(payment, source, gateway_options)
+        ActiveMerchant::Billing::Response.new(true, "", {}, {})
+      end
+
+      def void(*args)
+        ActiveMerchant::Billing::Response.new(true, "", {}, {})
+      end
+
+      def actions
+        %w{capture void}
+      end
+
+      def can_capture?(payment)
+        payment.state == 'pending' || payment.state == 'checkout'
+      end
+
+      def can_void?(payment)
+        payment.state != 'void'
+      end
+
+      def source_required?
+        false
+      end
+
+      #def provider_class
+      #  self.class
+      #end
+
+      def payment_source_class
+        nil
+      end
+
+      def method_type
+        'cash_on_delivery'
+      end
+
+      def auto_capture?
+        true
+      end
+
+    end
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,18 @@
+Spree::Order.class_eval do
+
+  state_machine do
+    before_transition :to => :complete, :do => :calcuate_order_adjustement
+  end
+
+  def calcuate_order_adjustement
+    updater.update_adjustment_total
+    updater.update_order_total
+    persist_totals
+  end
+
+
+  def cash_on_delivery_payment?
+    payments && payments.last.payment_method.is_a?(Spree::CashOnDelivery::PaymentMethod)
+  end
+
+end

data/app/models/spree/payment_decorator.rb

@@ -0,0 +1,18 @@
+Spree::Payment.class_eval do
+
+  # for Cash on Delivery
+  #TODO: As it stands now, this method is copy from spree-core/app/models/spree/payment.rb Improve!
+  def build_source
+    return if source_attributes.nil? || !new_record?
+    if payment_method and payment_method.respond_to?(:create_adjustment)
+      payment_method.create_adjustment(self)
+    elsif source.blank? && payment_method.try(:payment_source_class)
+      self.source = payment_method.payment_source_class.new(source_attributes)
+      self.source.payment_method_id = payment_method.id
+      self.source.user_id = self.order.user_id if self.order
+    end
+
+  end
+
+end
+

data/app/models/spree/payment_method_configuration.rb

@@ -0,0 +1,3 @@
+class Spree::PaymentMethodConfiguration <  Spree::Preferences::Configuration
+  preference :charge, :string, :default => '5.0'
+end

data/app/overrides/add_cash_on_delivery_config_to_admin_configuration_side_bar.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(virtual_path: "spree/admin/shared/_configuration_menu",
+                     name: "cash_on_delivery_config_settings_added_to_configuration_menu",
+                     insert_bottom: ".sidebar",
+                     partial: "spree/admin/shared/cash_on_delivery_config_settings"
+)

data/app/views/spree/admin/cash_on_delivery_configs/edit.html.erb

@@ -0,0 +1,38 @@
+<%= render :partial => 'spree/admin/shared/configuration_menu' %>
+
+<% content_for :page_title do %>
+    <%= Spree.t(:cash_on_delivery) %>
+<% end %>
+
+<%= form_tag admin_cash_on_delivery_configs_path, :method => :put do %>
+    <div id="preferences" data-hook>
+
+      <fieldset class="general no-border-top">
+
+        <fieldset class="security no-border-bottom">
+          <legend align="center"><%= Spree.t(:cash_on_delivery_config)%></legend>
+              <div class="field">
+                <%= label_tag(:cash_on_delivery_charge, 'Cash on delivery charge: ') + tag(:br) %>
+
+                <%= text_field_tag(:cash_on_delivery_charge, @charge, onkeypress: 'return ((event.charCode >= 48 && event.charCode <= 57) || event.charCode == 46)') %>
+              </div>
+
+        </fieldset>
+
+        <div class="form-buttons filter-actions actions" data-hook="buttons">
+          <%= button Spree.t('actions.update'), 'refresh' %>
+          <span class="or"><%= Spree.t(:or) %></span>
+          <%= link_to_with_icon 'remove', Spree.t('actions.cancel'), edit_admin_general_settings_url, :class => 'button' %>
+        </div>
+
+      </fieldset>
+
+    </div>
+
+
+<% end %>
+
+<script>
+    $('#store_default_currency').select2();
+    $('#currency').select2();
+</script>

data/app/views/spree/admin/payments/source_views/_cash_on_delivery.html.erb

@@ -0,0 +1,6 @@
+<label>Status</label>
+<% if @payment.state? %>
+  <%= @payment.state.titleize %>
+<% else %>
+  <%= @payment.source.state.titleize %> 
+<% end %>

data/app/views/spree/admin/shared/_cash_on_delivery_config_settings.html.erb

@@ -0,0 +1 @@
+<%= configurations_sidebar_menu_item Spree.t(:cash_on_delivery_config), edit_admin_cash_on_delivery_configs_path %>

data/app/views/spree/checkout/payment/_cash_on_delivery.html.erb

@@ -0,0 +1,3 @@
+<%= t('fee', :amount => number_to_currency(Spree::CashOnDelivery::Config.charge, currency: Spree::Config.preferred_currency, unit: "")) %> Rs.
+<% @order.bill_address ||= Spree::Address.default %>
+<%= hidden_field_tag "payment_source[#{payment_method.id}][amount]", @order.total %>

data/bin/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_pay_cash_on_delivery/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/initializers/load_preferences.rb

@@ -0,0 +1,5 @@
+module Spree
+  module CashOnDelivery
+    Config = Spree::PaymentMethodConfiguration.new
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/config/routes.rb

@@ -0,0 +1,5 @@
+Spree::Core::Engine.add_routes do
+  namespace :admin do
+    resource :cash_on_delivery_configs
+  end
+end

data/lib/generators/spree_pay_cash_on_delivery/install/install_generator.rb

@@ -0,0 +1,31 @@
+module SpreePayCashOnDelivery
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, :type => :boolean, :default => false
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/spree_pay_cash_on_delivery\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/spree_pay_cash_on_delivery\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/spree_pay_cash_on_delivery\n", :before => /\*\//, :verbose => true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/spree_pay_cash_on_delivery\n", :before => /\*\//, :verbose => true
+      end
+
+      # def add_migrations
+      #   run 'bundle exec rake railties:install:migrations FROM=spree_pay_cash_on_delivery'
+      # end
+      #
+      # def run_migrations
+      #   run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+      #   if run_migrations
+      #     run 'bundle exec rake db:migrate'
+      #   else
+      #     puts 'Skipping rake db:migrate, don\'t forget to run it!'
+      #   end
+      # end
+    end
+  end
+end

data/lib/spree_pay_cash_on_delivery.rb

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

data/lib/spree_pay_cash_on_delivery/engine.rb

@@ -0,0 +1,25 @@
+module SpreePayCashOnDelivery
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_pay_cash_on_delivery'
+
+    # 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_cash_on_delivery.register.payment_method", :after => "spree.register.payment_methods" do |app|
+      app.config.spree.payment_methods << Spree::CashOnDelivery::PaymentMethod
+    end
+
+  end
+end

data/lib/spree_pay_cash_on_delivery/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_pay_cash_on_delivery/factories'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+# Run Coverage report
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec/dummy'
+  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 'database_cleaner'
+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 and other useful helpers defined in spree_core.
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/capybara_ext'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/factories'
+require 'spree/testing_support/url_helpers'
+
+# Requires factories defined in lib/spree_pay_cash_on_delivery/factories.rb
+require 'spree_pay_cash_on_delivery/factories'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  # Infer an example group's spec type from the file location.
+  config.infer_spec_type_from_file_location!
+
+  # == URL Helpers
+  #
+  # Allows access to Spree's routes in specs:
+  #
+  # visit spree.admin_path
+  # current_path.should eql(spree.products_path)
+  config.include Spree::TestingSupport::UrlHelpers
+
+  # == 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"
+
+  # Capybara javascript drivers require transactional fixtures set to false, and we use DatabaseCleaner
+  # to cleanup after each test instead.  Without transactional fixtures set to false the records created
+  # to setup a test will be unavailable to the browser, which runs under a separate server instance.
+  config.use_transactional_fixtures = false
+
+  # Ensure Suite is set to use transactions for speed.
+  config.before :suite do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  # Before each spec check if it is a Javascript test and switch between using database transactions or not where necessary.
+  config.before :each do
+    DatabaseCleaner.strategy = RSpec.current_example.metadata[:js] ? :truncation : :transaction
+    DatabaseCleaner.start
+  end
+
+  # After each spec clean the database.
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+
+  config.fail_fast = ENV['FAIL_FAST'] || false
+  config.order = "random"
+end

data/spree_pay_cash_on_delivery.gemspec

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_pay_cash_on_delivery'
+  s.version     = '0.1.0'
+  s.summary     = 'Spree Cash On Delivery payment method'
+  s.description = 'This extension adds Cash on delivery payment method to Spree'
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.author    = 'Sanad Liaquat'
+  s.email     = 'sanadhussain@gmail.com'
+  s.homepage  = 'https://github.com/sliaquat'
+
+  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.license       = "MIT"
+  s.add_dependency 'spree_core', '~> 2.4.1'
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: spree_pay_cash_on_delivery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sanad Liaquat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-03 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.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+description: This extension adds Cash on delivery payment method to Spree
+email: sanadhussain@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/spree_pay_cash_on_delivery.js
+- app/assets/javascripts/spree/frontend/spree_pay_cash_on_delivery.js
+- app/assets/stylesheets/spree/backend/spree_pay_cash_on_delivery.css
+- app/assets/stylesheets/spree/frontend/spree_pay_cash_on_delivery.css
+- app/controllers/spree/admin/cash_on_delivery_configs_controller.rb
+- app/models/spree/cash_on_delivery/payment_method.rb
+- app/models/spree/order_decorator.rb
+- app/models/spree/payment_decorator.rb
+- app/models/spree/payment_method_configuration.rb
+- app/overrides/add_cash_on_delivery_config_to_admin_configuration_side_bar.rb
+- app/views/spree/admin/cash_on_delivery_configs/edit.html.erb
+- app/views/spree/admin/payments/source_forms/_cash_on_delivery.html.erb
+- app/views/spree/admin/payments/source_views/_cash_on_delivery.html.erb
+- app/views/spree/admin/shared/_cash_on_delivery_config_settings.html.erb
+- app/views/spree/checkout/payment/_cash_on_delivery.html.erb
+- bin/rails
+- config/initializers/load_preferences.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/spree_pay_cash_on_delivery/install/install_generator.rb
+- lib/spree_pay_cash_on_delivery.rb
+- lib/spree_pay_cash_on_delivery/engine.rb
+- lib/spree_pay_cash_on_delivery/factories.rb
+- spec/spec_helper.rb
+- spree_pay_cash_on_delivery.gemspec
+homepage: https://github.com/sliaquat
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Spree Cash On Delivery payment method
+test_files: []