merchant_sidekick 0.4.2

data/.gitignore

@@ -0,0 +1,12 @@
+Gemfile.lock
+doc
+docs
+pkg
+.DS_Store
+coverage
+.yardoc
+.rvmrc
+*.gem
+*.sqlite3
+*.rbc
+*.lock

data/Changelog.md

@@ -0,0 +1,38 @@
+# MerchantSidekick Changelog
+
+## 0.4.2 (NOT RELEASED YET)
+
+* Renamed state transition exit callbacks for order and invoice
+* Loosened active_record gem dependency to work with Rails 3.2.x
+* Version bump
+
+## 0.4.1 (NOT RELEASED YET)
+
+* Fix overridden `build_#{relation}` method signature
+* Fix deprecations on class\_inheritable\_writer
+* Fix deprecations when using Money class with ActiveMerchant
+* Fix authorize\_net\_gateway and paypal_gateway merchant gateways
+* Refactored out active_merchant specific gateways into separate module
+* Removed option to load gateway configuration from database
+* Added gateway spec
+* Allow for MerchantSidekick::Gateway.default_gateway to use type name
+* Refactored default_gateway for active merchant gateway types into base class
+* Added bogus gateway configuration wrapper
+* Cart instances can now be added directly to purchase
+* Cart instances can now be sold
+* Change @customer.purchase syntax to accept :from => @merchant
+* Change @merchant.sell syntax to accept :to => @customer
+* Ignoring blank sellables from purchase and sell
+
+## 0.4.0 (2011-12-27)
+
+* Compatibility with ActiveRecord 3.1
+* Refactored code into modules
+
+## 0.0.2 (2009-04-28)
+
+* Fixed invoice void, capture and purchase.
+
+## 0.0.1 (2008-08-06)
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2008-2011 Juergen Fesslmeier.
+
+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,88 @@
+# MerchantSidekick
+
+MerchantSidekick is a light-weight E-commerce framework for Ruby on Rails applications.
+
+## Features
+
+MerchantSidekick includes in- and outbound order management and invoicing, 
+a shopping cart, taxation and payment processing. It integrates with 
+[ActiveMerchant](http://activemerchant.org) for payment processing by default.
+The plugin can be extended to use other payment processors outside the scope
+of ActiveMerchant.
+
+## Quickstart
+
+    gem install merchant_sidekick
+
+    rails new my_app
+
+    cd my_app
+
+    gem "merchant_sidekick"
+
+    rails generate merchant_sidekick:install
+
+    rake db:migrate
+
+    # edit config/initializers/merchant_sidekick.rb
+    MerchantSidekick::default_gateway = :bogus_gateway
+    
+    # edit app/models/user.rb
+    class User < ActiveRecord::Base
+      acts_as_buyer
+    end
+
+    # edit app/models/product.rb
+    class Product < ActiveRecord::Base
+      acts_as_sellable
+    end
+
+    rails generate controller orders
+
+    # edit app/controllers/orders_controller.rb
+    class OrdersController < ApplicationController
+      before_filter load_cart
+      ...
+      
+      def create
+        @credit_card = ActiveMerchant::Billing::CreditCard.new(params[:credit_card] || {})
+        if @credit_card.valid?
+          @order = @user.purchase(@cart)
+          @payment = @order.pay(@credit_card)
+          redirect_to [@order] and return if @payment.valid?
+        end
+        render :template => "new"
+      end
+      
+      protected
+      
+      def load_cart
+        @cart = YAML.load(session[:cart].to_s)
+      end
+      
+      ...
+    
+    end
+    
+
+## License
+
+Copyright (c) 2008-2012 Juergen Fesslmeier, released under the 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/Rakefile

@@ -0,0 +1,10 @@
+require "rubygems"
+require "rake/testtask"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/lib/merchant_sidekick.rb

@@ -0,0 +1,45 @@
+require "active_record"
+require "active_support/core_ext" # TODO remove once we replace inheritable_attribute readers with configurations
+require "money"
+require "merchant_sidekick/version"
+require "merchant_sidekick/money"
+require "acts_as_list"
+require "aasm"
+require "active_merchant"
+
+ActiveRecord::Base.extend MerchantSidekick::Money
+
+require 'merchant_sidekick/addressable/addressable'
+require 'merchant_sidekick/addressable/address'
+ActiveRecord::Base.send(:include, MerchantSidekick::Addressable)
+
+require 'merchant_sidekick/sellable'
+require 'merchant_sidekick/buyer'
+require 'merchant_sidekick/seller'
+
+require 'merchant_sidekick/line_item'
+require 'merchant_sidekick/order'
+require 'merchant_sidekick/purchase_order'
+require 'merchant_sidekick/sales_order'
+require 'merchant_sidekick/invoice'
+require 'merchant_sidekick/purchase_invoice'
+require 'merchant_sidekick/sales_invoice'
+
+ActiveRecord::Base.send(:include, MerchantSidekick::Sellable)
+ActiveRecord::Base.send(:include, MerchantSidekick::Buyer)
+ActiveRecord::Base.send(:include, MerchantSidekick::Seller)
+
+require 'merchant_sidekick/shopping_cart/cart'
+require 'merchant_sidekick/shopping_cart/line_item'
+
+require 'merchant_sidekick/gateway'
+require 'merchant_sidekick/payment'
+
+require 'merchant_sidekick/active_merchant/credit_card_payment'
+
+require 'merchant_sidekick/active_merchant/gateways/base'
+require 'merchant_sidekick/active_merchant/gateways/bogus_gateway'
+require 'merchant_sidekick/active_merchant/gateways/authorize_net_gateway'
+require 'merchant_sidekick/active_merchant/gateways/paypal_gateway'
+
+require 'merchant_sidekick/railtie' if defined?(Rails)

data/lib/merchant_sidekick/active_merchant/credit_card_payment.rb

@@ -0,0 +1,117 @@
+# This class handles all credit card payment transactions using ActiveMerchant.
+module MerchantSidekick
+  module ActiveMerchant
+    class CreditCardPayment < Payment
+      cattr_accessor :gateway
+      serialize :params
+
+      class << self
+
+        # Returns an active merchant gateway instance, based on the following:
+        #
+        #   * an active merchant gateway instance assigned to the gateway
+        #     class accessor
+        #   * a merchant sidekick specific gateway identifier, 
+        #     e.g. :authorize_net_gateway, is passed into the gateway class accessor
+        #   * otherwise falls back to the default gateway assigned as
+        #     MerchantSidekick::Gateways::Gateway.default_gateway
+        #
+        # Declare as needed in the environment.
+        #
+        # E.g.
+        #
+        #   CreditCardPayment.gateway = ActiveMerchant::Billing::AuthorizeNetGateway.new({
+        #     :login    => @login_id,
+        #     :password => @transaction_key
+        #   })
+        #
+        #   or
+        #
+        #   CreditCardPayment.gateway = :authorize_net_gateway
+        #
+        def gateway
+          if @@gateway.is_a? ::ActiveMerchant::Billing::Gateway
+            @@gateway
+          elsif @@gateway.is_a? Symbol
+            @@gateway = "::MerchantSidekick::ActiveMerchant::Gateways::#{@@gateway.to_s.classify}".constantize.gateway
+            @@gateway
+          else
+            @@gateway = MerchantSidekick::Gateway.default_gateway
+          end
+        end
+
+        def authorize(amount, credit_card, options = {})
+          process('authorization', amount, options) do |gw|
+            gw.authorize(amount.cents, credit_card, options)
+          end
+        end
+
+        def capture(amount, authorization, options = {})
+          process('capture', amount, options) do |gw|
+            gw.capture(amount.cents, authorization, options)
+          end
+        end
+
+        def purchase(amount, credit_card, options = {})
+          process('purchase', amount, options) do |gw|
+            gw.purchase(amount.cents, credit_card, options)
+          end
+        end
+
+        def void(amount, authorization, options = {})
+          process('void', amount, options) do |gw|
+            gw.void(authorization, options)
+          end
+        end
+
+        # requires :card_number option
+        def credit(amount, authorization, options = {})
+          process('credit', amount, options) do |gw|
+            gw.credit(amount.cents, authorization, options)
+          end
+        end
+
+        # works with paypal payflow
+        def transfer(amount, destination_account, options={})
+          process('transfer', amount, options) do |gw|
+            gw.transfer(amount.cents, destination_account, options)
+          end
+        end
+
+        private
+
+        def process(action, amount = nil, options = {})
+          result = CreditCardPayment.new
+          result.amount = amount
+          result.action = action
+
+          begin
+            options[:currency] = amount.currency if amount.respond_to?(:currency)
+            response = yield gateway
+
+            result.success   = response.success?
+            result.reference = response.authorization
+            result.message   = response.message
+            result.params    = response.params
+            result.test      = response.test?
+          rescue ::ActiveMerchant::ActiveMerchantError => e
+            result.success   = false
+            result.reference = nil
+            result.message   = e.message
+            result.params    = {}
+            result.test      = gateway.test?
+          end
+          result
+        end
+      end
+
+      #--- instance methods
+
+      # override in sublcass
+      def payment_type
+        :credit_card
+      end
+
+    end
+  end
+end

data/lib/merchant_sidekick/active_merchant/gateways/authorize_net_gateway.rb

@@ -0,0 +1,26 @@
+# Implements the AuthorizeNet specific active merchant gateway wrapper
+# to configure the gateway properly.
+module MerchantSidekick
+  module ActiveMerchant
+    module Gateways
+      class AuthorizeNetGateway < ::MerchantSidekick::ActiveMerchant::Gateways::Base
+        class << self
+
+          # Returns an active merchant authorize net gateway instance 
+          # unless there is already one assigned.
+          def gateway
+            unless @@gateway
+              ::ActiveMerchant::Billing::Base.mode = :test if config[:mode] == "test"
+              @@gateway = ::ActiveMerchant::Billing::AuthorizeNetGateway.new({
+                :login    => config[:login_id],
+                :password => config[:transaction_key]
+              }.merge(config[:mode] == "test" ? {:test => true} : {}))
+            end
+            @@gateway
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/merchant_sidekick/active_merchant/gateways/base.rb

@@ -0,0 +1,29 @@
+# Implements the base gateway for all active merchant gateways
+module MerchantSidekick
+  class << self
+    
+    # Overrides MerchantSidekick::default_gateway setter defined in merchant_sidekick/gateway
+    def default_gateway=(value)
+      ::MerchantSidekick::ActiveMerchant::Gateways::Base.default_gateway = value
+    end
+  end
+
+  module ActiveMerchant
+    
+    module Gateways
+      class Base < MerchantSidekick::Gateway
+        class << self
+
+          def default_gateway=(value)
+            if value.is_a?(Symbol)
+              super "::MerchantSidekick::ActiveMerchant::Gateways::#{value.to_s.classify}".constantize.gateway
+            else
+              super value
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/merchant_sidekick/active_merchant/gateways/bogus_gateway.rb

@@ -0,0 +1,19 @@
+# Implements the bogus gatway active merchant gateway wrapper
+module MerchantSidekick
+  module ActiveMerchant
+    module Gateways
+      class BogusGateway < ::MerchantSidekick::ActiveMerchant::Gateways::Base
+        class << self
+
+          def gateway
+            unless @@gateway
+              @@gateway = ::ActiveMerchant::Billing::BogusGateway.new
+            end
+            @@gateway
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/merchant_sidekick/active_merchant/gateways/paypal_gateway.rb

@@ -0,0 +1,43 @@
+# Implements the Paypal Website Payments Pro specific active merchant gateway wrapper
+# to configure the gateway properly.
+module MerchantSidekick
+  module ActiveMerchant
+    module Gateways
+      class PaypalGateway < ::MerchantSidekick::ActiveMerchant::Gateways::Base
+        class << self
+
+          # Returns an active merchant paypal gateway instance
+          #
+          # E.g.
+          #
+          #    # config/active_merchant.yml
+          #    development:
+          #      api_username: seller_XYZ_biz_api1.example.com
+          #      api_password: ABCDEFG123456789
+          #      signature: AsPC9BjkCyDFQXbStoZcgqH3hpacAX3IenGazd35.nEnXJKR9nfCmJDu
+          #      pem_file_name: config/paypal.pem
+          #      mode: test
+          #    production:
+          #      ...
+          #
+          def gateway
+            unless @@gateway
+              options = {
+                :login    => config[:api_username],
+                :password => config[:api_password]
+              }
+              options.merge!({:test => true}) if config[:mode] == "test"
+              options.merge!({:signature => config[:signature]}) unless config[:signature].blank?
+            
+              ::ActiveMerchant::Billing::Base.mode = :test if config[:mode] == "test"
+              ::ActiveMerchant::Billing::PaypalGateway.pem_file = File.read(File.expand_path(config[:pem_file_name])) if config[:pem_file_name]
+              @@gateway = ::ActiveMerchant::Billing::PaypalGateway.new(options)
+            end
+            @@gateway
+          end
+
+        end
+      end
+    end
+  end
+end