solidus_stripe 1.0.0

data/README.md

@@ -0,0 +1,115 @@
+Solidus Stripe
+===============
+
+[![CircleCI](https://circleci.com/gh/solidusio/solidus_stripe.svg?style=svg)](https://circleci.com/gh/solidusio/solidus_stripe)
+
+Stripe Payment Method for Solidus. It works as a wrapper for the ActiveMerchant Stripe gateway.
+
+---
+
+Installation
+------------
+
+In your Gemfile:
+
+```ruby
+gem "solidus_stripe", github: "solidusio/solidus_stripe"
+```
+
+Then run from the command line:
+
+```shell
+bundle install
+bundle exec rails g solidus_stripe:install
+bundle exec rails db:migrate
+```
+
+Usage
+-----
+
+Navigate to *Settings > Payments > Payment Methods* in the admin panel.
+You can now create a new payment method that uses Stripe by selecting
+`Stripe credit card` under Type in the New Payment Method form and saving.
+The Stripe payment method's extra fields will be now shown in the form.
+
+**Configure via database configuration**
+
+If you want to store your Stripe credentials in the database just
+fill the new fields in the form, selecting `custom` (default) in the
+Preference Source field.
+
+**Configure via static configuration**
+
+If you want to store your credentials into your codebase or use ENV
+variables you can create the following static configuration:
+
+```ruby
+# config/initializers/spree.rb
+
+Spree.config do |config|
+  # ...
+
+  config.static_model_preferences.add(
+    Spree::PaymentMethod::StripeCreditCard,
+    'stripe_env_credentials',
+    secret_key: ENV['STRIPE_SECRET_KEY'],
+    publishable_key: ENV['STRIPE_PUBLISHABLE_KEY'],
+    v3_elements: false,
+    server: Rails.env.production? ? 'production' : 'test',
+    test_mode: !Rails.env.production?
+  )
+end
+```
+
+Once your server has been restarted, you can select in the Preference
+Source field a new entry called `stripe_env_credentials`. After saving,
+your  application will start using the static configuration to process
+Stripe payments.
+
+
+Migrating from solidus_gateway
+------------------------------
+
+If you were previously using `solidus_gateway` gem you might want to
+check out our [Wiki page](https://github.com/solidusio/solidus_stripe/wiki/Migrating-from-solidus_gateway)
+that describes how to handle this migration.
+
+Testing
+-------
+
+Then just run the following to automatically build a dummy app if necessary and
+run the tests:
+
+```shell
+bundle exec rake
+```
+
+Releasing
+---------
+
+We use [gem-release](https://github.com/svenfuchs/gem-release) to release this
+extension with ease.
+
+Supposing you are on the master branch and you are working on a fork of this
+extension, `upstream` is the main remote and you have write access to it, you
+can simply run:
+
+```
+gem bump --version minor --tag --release --remote upstream
+```
+
+This command will:
+
+- bump the gem version to the next minor (changing the `version.rb` file)
+- commit the change and push it to upstream master
+- create a git tag
+- push the tag to the upstream remote
+- release the new version on RubyGems
+
+Or you can run these commands individually:
+
+```
+gem bump --version minor --remote upstream
+gem tag --remote upstream
+gem release
+```

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_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'] = 'solidus_stripe'
+  Rake::Task['common:test_app'].invoke
+end

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module Spree
+  class PaymentMethod
+    class StripeCreditCard < Spree::PaymentMethod::CreditCard
+      preference :secret_key, :string
+      preference :publishable_key, :string
+      preference :v3_elements, :boolean
+
+      CARD_TYPE_MAPPING = {
+        'American Express' => 'american_express',
+        'Diners Club' => 'diners_club',
+        'Visa' => 'visa'
+      }
+
+      def partial_name
+        'stripe'
+      end
+
+      def v3_elements?
+        !!preferred_v3_elements
+      end
+
+      def gateway_class
+        ActiveMerchant::Billing::StripeGateway
+      end
+
+      def payment_profiles_supported?
+        true
+      end
+
+      def purchase(money, creditcard, transaction_options)
+        gateway.purchase(*options_for_purchase_or_auth(money, creditcard, transaction_options))
+      end
+
+      def authorize(money, creditcard, transaction_options)
+        gateway.authorize(*options_for_purchase_or_auth(money, creditcard, transaction_options))
+      end
+
+      def capture(money, response_code, transaction_options)
+        gateway.capture(money, response_code, transaction_options)
+      end
+
+      def credit(money, _creditcard, response_code, _transaction_options)
+        gateway.refund(money, response_code, {})
+      end
+
+      def void(response_code, _creditcard, _transaction_options)
+        gateway.void(response_code, {})
+      end
+
+      def cancel(response_code)
+        gateway.void(response_code, {})
+      end
+
+      def create_profile(payment)
+        return unless payment.source.gateway_customer_profile_id.nil?
+
+        options = {
+          email: payment.order.email,
+          login: preferred_secret_key,
+        }.merge! address_for(payment)
+
+        source = update_source!(payment.source)
+        if source.number.blank? && source.gateway_payment_profile_id.present?
+          creditcard = source.gateway_payment_profile_id
+        else
+          creditcard = source
+        end
+
+        response = gateway.store(creditcard, options)
+        if response.success?
+          payment.source.update_attributes!({
+            cc_type: payment.source.cc_type, # side-effect of update_source!
+            gateway_customer_profile_id: response.params['id'],
+            gateway_payment_profile_id: response.params['default_source'] || response.params['default_card']
+          })
+
+        else
+          payment.send(:gateway_error, response.message)
+        end
+      end
+
+      private
+
+      # In this gateway, what we call 'secret_key' is the 'login'
+      def options
+        options = super
+        options.merge(login: preferred_secret_key)
+      end
+
+      def options_for_purchase_or_auth(money, creditcard, transaction_options)
+        options = {}
+        options[:description] = "Spree Order ID: #{transaction_options[:order_id]}"
+        options[:currency] = transaction_options[:currency]
+
+        if customer = creditcard.gateway_customer_profile_id
+          options[:customer] = customer
+        end
+        if token_or_card_id = creditcard.gateway_payment_profile_id
+          # The Stripe ActiveMerchant gateway supports passing the token directly as the creditcard parameter
+          # The Stripe ActiveMerchant gateway supports passing the customer_id and credit_card id
+          # https://github.com/Shopify/active_merchant/issues/770
+          creditcard = token_or_card_id
+        end
+        [money, creditcard, options]
+      end
+
+      def address_for(payment)
+        {}.tap do |options|
+          if address = payment.order.bill_address
+            options[:address] = {
+              address1: address.address1,
+              address2: address.address2,
+              city: address.city,
+              zip: address.zipcode
+            }
+
+            if country = address.country
+              options[:address][:country] = country.name
+            end
+
+            if state = address.state
+              options[:address].merge!(state: state.name)
+            end
+          end
+        end
+      end
+
+      def update_source!(source)
+        source.cc_type = CARD_TYPE_MAPPING[source.cc_type] if CARD_TYPE_MAPPING.include?(source.cc_type)
+        source
+      end
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/solidus_stripe/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/db/migrate/20181010123508_update_stripe_payment_method_type_to_credit_card.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class UpdateStripePaymentMethodTypeToCreditCard < SolidusSupport::Migration[5.1]
+  def up
+    Spree::PaymentMethod.where(type: 'Spree::Gateway::StripeGateway').update_all(type: 'Spree::PaymentMethod::StripeCreditCard')
+
+    Spree::Preference.where("#{ActiveRecord::Base.connection.quote_column_name('key')} LIKE 'spree/gateway/stripe_gateway'").each do |pref|
+      pref.key = pref.key.gsub('spree/gateway/stripe_gateway', 'spree/payment_method/stripe_credit_card')
+      pref.save
+    end
+  end
+
+  def down
+    Spree::PaymentMethod.where(type: 'Spree::PaymentMethod::StripeCreditCard').update_all(type: 'Spree::Gateway::StripeGateway')
+
+    Spree::Preference.where("#{ActiveRecord::Base.connection.quote_column_name('key')} LIKE 'spree/payment_method/stripe_credit_card'").each do |pref|
+      pref.key = pref.key.gsub('spree/payment_method/stripe_credit_card', 'spree/gateway/stripe_gateway')
+      pref.save
+    end
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+secret_key = ENV['STRIPE_SEEDS_SECRET_KEY']
+publishable_key = ENV['STRIPE_SEEDS_PUBLISHABLE_KEY']
+
+puts "Loading seed: solidus_stripe/stripe_payment_method"
+
+if secret_key.blank? || publishable_key.blank?
+  puts "Failure: You have to set both STRIPE_SEEDS_SECRET_KEY and STRIPE_SEEDS_PUBLISHABLE_KEY environment variables."
+else
+  stripe_payment_method = Spree::PaymentMethod::StripeCreditCard.new do |payment_method|
+    payment_method.name = 'Credit Card'
+    payment_method.preferred_test_mode = true
+    payment_method.preferred_secret_key = secret_key
+    payment_method.preferred_publishable_key = publishable_key
+  end
+
+  if stripe_payment_method.save
+    puts "Stripe Payment Method correctly created."
+  else
+    puts "There was some problems with creating Stripe Payment Method:"
+    stripe_payment_method.errors.full_messages.each do |error|
+      puts error
+    end
+  end
+end

data/lib/assets/stylesheets/spree/frontend/solidus_stripe.scss

@@ -0,0 +1,6 @@
+#card_number.StripeElement,
+#card_expiry.StripeElement,
+#card_cvc.StripeElement {
+  border: 1px solid #d9d9db;
+  padding: 5px;
+}

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SolidusStripe
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :migrate, type: :boolean, default: true
+      class_option :auto_run_migrations, type: :boolean, default: false
+      class_option :auto_run_seeds, type: :boolean, default: false
+
+      def add_stylesheets
+        filename = 'vendor/assets/stylesheets/spree/frontend/all.css'
+        if File.file? filename
+          inject_into_file filename, " *= require spree/frontend/solidus_stripe\n", before: '*/', verbose: true
+        end
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_stripe'
+      end
+
+      def run_migrations
+        if options.migrate? && running_migrations?
+          run 'bundle exec rake db:migrate'
+        else
+          puts "Skiping rake db:migrate, don't forget to run it!"
+        end
+      end
+
+      def populate_seed_data
+        return unless options.auto_run_seeds?
+
+        say_status :loading, 'stripe seed data'
+        rake('db:seed:solidus_stripe')
+      end
+
+      private
+
+      def running_migrations?
+        options.auto_run_migrations? || begin
+          response = ask 'Would you like to run the migrations now? [Y/n]'
+          ['', 'y'].include? response.downcase
+        end
+      end
+    end
+  end
+end

data/lib/solidus_stripe.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "active_merchant"
+require "solidus_core"
+require "solidus_support"
+require "solidus_stripe/engine"
+require "solidus_stripe/version"

data/lib/solidus_stripe/engine.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SolidusStripe
+  class Engine < Rails::Engine
+    engine_name 'solidus_stripe'
+
+    initializer "spree.payment_method.add_stripe_credit_card", after: "spree.register.payment_methods" do |app|
+      app.config.spree.payment_methods << Spree::PaymentMethod::StripeCreditCard
+    end
+
+    if SolidusSupport.backend_available?
+      paths["app/views"] << "lib/views/backend"
+    end
+
+    if SolidusSupport.frontend_available?
+      paths["app/views"] << "lib/views/frontend"
+    end
+
+    if SolidusSupport.api_available?
+      paths["app/views"] << "lib/views/api"
+    end
+  end
+end

data/lib/solidus_stripe/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidusStripe
+  VERSION = "1.0.0"
+end

data/lib/tasks/solidus_stripe/db/seed.rake

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+namespace :db do
+  namespace :seed do
+    desc 'Loads stripe sample data'
+    task solidus_stripe: :environment do
+      seed_file = Dir[SolidusStripe::Engine.root.join('db', 'seeds.rb')][0]
+      return unless File.exist?(seed_file)
+
+      puts "Seeding #{seed_file}..."
+      load(seed_file)
+    end
+  end
+end

data/lib/views/api/spree/api/payments/source_views/_stripe.json.jbuilder

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+json.partial!('spree/api/payments/source_views/gateway', payment_source: payment_source)