flowcommerce-solidus 0.1.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0101a0d46954d016cd3dac32a96708081c02d77
+  data.tar.gz: 7311c515495ab8d4f004c641619e590c17c70a2d
+SHA512:
+  metadata.gz: e6a81592b490a7ea0b8efe4f1a9673eb1e3a606798d81c862a7cf8eb66595bf03be586504dc2986bce2cc184fe9aeaacb0016a3b02306d52be5ae72d67d34747
+  data.tar.gz: 7c2ba0914d7c8d5e39435e9711b1daf15dec210eca659d244caae85fa0719b1a9968c61064107281f694d90a83373833b979120b27c51af94fb980e45fe8173d

data/.version

@@ -0,0 +1 @@
+0.1.11

data/bin/flowcommerce-solidus

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'fileutils'
+require 'colorize'
+
+module Helper
+  extend self
+
+  def copy_with_path src, destionation
+    target_dir = File.dirname(destionation)
+
+    FileUtils.mkdir_p(target_dir) unless Dir.exists?(target_dir)
+    FileUtils.cp src, destionation
+  end
+
+  def die text
+    puts text.red
+    exit
+  end
+
+  def glob_files root_folders
+    Cli.die './app not found, not in Rails root' unless Dir.exists?('%s/app' % Dir.pwd)
+
+    root_folder = `gem which flowcommerce-solidus`.chomp.sub('/lib/flowcommerce-solidus.rb', '/static')
+
+    files = root_folders.inject([]) do |total, folder|
+      total += Dir['%s/%s/**/*' % [root_folder, folder]]
+    end
+
+    files = files
+      .map { |f| f.sub('%s/' % root_folder, '') }
+      .select{ |f| f =~ /\.\w+$/ }
+
+    has_different_size_file = false
+
+    files.each do |file|
+      source = [root_folder, file].join('/')
+      target = [Dir.pwd, file].join('/')
+
+      do_copy = if File.exists?(target)
+        if File.size(target) == File.size(source)
+          print 'same size'.rjust(15).green
+        else
+          print 'different size'.rjust(15).blue
+          has_different_size_file = true
+        end
+
+        false
+      else
+        print 'copied'.rjust(15).green
+        true
+      end
+
+      Helper.copy_with_path source, target if do_copy
+
+      puts ' %s' % file
+    end
+
+    puts
+    puts ' '*14+'* files with different sizes you have to first deleted or renamed'.yellow if has_different_size_file
+    puts ' '*14+'* checked %d files'.yellow % files.length
+  end
+end
+
+###
+
+class FlowcommerceSolidus < Thor
+  desc 'install', 'Installs Flow Solidus libs in current installation, if missing.'
+  def install
+    Helper.glob_files ['app/flow', 'app/views/spree/shared', 'lib']
+  end
+
+  desc 'install_admin_views', 'Installs views (erb templates) in ./app/views/admin'
+  def install_admin_views
+    Helper.glob_files ['app/views/spree/admin']
+  end
+
+  desc 'install_email_views', 'Installs custom Flow views (erb templates) for email localization'
+  def install_email_views
+    Helper.glob_files ['app/views/spree/order_mailer']
+  end
+
+  desc 'dev_copy [folder]','Copy files from local solids to gem', :hide => true
+  def copy_to_gem solidus_folder=nil
+    Cli.die 'Solidus target folder not defined' unless solidus_folder
+    Cli.die './app not found' unless Dir.exists?('%s/app' % solidus_folder)
+    Cli.die 'Not executed in gem root folder' unless $0.include('/flowcommerce-solidus/bin')
+
+    `rm -rf ./static`
+    `mkdir ./static`
+
+    # add flow folder
+    files  = Dir['%s/app/flow/**/*' % solidus_folder]
+
+    # admin view changes
+    files += Dir['%s/app/views/admin/*' % solidus_folder]
+
+    # add rake tasks
+    files += ['%s/lib/tasks/flow.rake' % solidus_folder]
+
+    # relativise paths and remove folders
+    files  = files
+      .map { |f| f.sub(solidus_folder+'/', '') }
+      .select{ |f| f =~ /\.\w+$/ }
+
+    # copy file to ./static dir in gem home
+    files.each do |file|
+      source = [solidus_folder, file].join('/')
+      target = './static/%s' % file
+
+      Helper.copy_with_path source, target
+    end
+
+    puts files
+
+    puts 'Copied %d files to ./static'.green % files.length
+  end
+end
+
+FlowcommerceSolidus.start ARGV

data/lib/flowcommerce-solidus.rb

@@ -0,0 +1,7 @@
+require 'flowcommerce'
+
+module Flowcommerce
+  module Solidus
+
+  end
+end

data/static/app/flow/README.md

@@ -0,0 +1,77 @@
+<img align="right" src="http://i.imgur.com/tov8bTw.png">
+
+# Flow.io adapter Solidus/Spree
+
+Work in progress. This will be converted to gem.
+
+All flow libs are located in ./app/flow folder with exception of two controllers
+ApplicationController and FlowController that are present in ./app/controllers folder.
+
+
+## Instalation
+
+Define this additional ENV variables. You will find them in [Flow console](https://console.flow.io)
+
+```
+FLOW_API_KEY='SUPERsecretTOKEN'
+FLOW_ORGANIZATION='solidus-app-sandbox'
+FLOW_BASE_COUNTRY='usa'
+```
+
+In ```./config/application.rb``` this is the only peace of code that is needed to
+init complete flow app
+
+```
+  config.to_prepare do
+    # add all flow libs
+    overload = Dir.glob('./app/flow/**/*.rb')
+    overload.reverse.each { |c| require(c) }
+  end
+
+  config.after_initialize do |app|
+    # init Flow payments as an option
+    app.config.spree.payment_methods << Spree::Gateway::Flow
+
+    # define defaults
+    Flow.organization = ENV.fetch('FLOW_ORGANIZATION')
+    Flow.base_country = ENV.fetch('FLOW_BASE_COUNTRY')
+    Flow.api_key      = ENV.fetch('FLOW_API_KEY')
+  end
+```
+
+in ./config/application.rb to enable payments with Flow.
+
+## Flow API specific
+
+Classes that begin with Flow are responsible for comunicating with flow API.
+
+### Flow
+
+Helper class that offeres low level flow api access and few helper methods.
+
+### Flow::Experience
+
+Responsible for selecting current experience. You have to define available experiences in flow console.
+
+### Flow::Order
+
+Maintain and synchronizes Spree::Order with Flow API.
+
+### Flow::Session
+
+Every shop user has a session. This class helps in creating and maintaining session with Flow.
+
+## Decorators
+
+Decorators are found in ./app/flow/decorators folders and they decorate Solidus/Spree models with Flow specific methods.
+
+All methods are prefixed with ```flow_```.
+
+## Helper lib
+
+### Spree::Flow::Gateway
+
+Adapter for Solidus/Spree, that allows using [Flow.io](https://www.flow.io) as payment gateway. Flow is PCI compliant payment processor.
+
+
+

data/static/app/flow/SOLIDUS_FLOW.md

@@ -0,0 +1,127 @@
+# Flow, ActiveMerchant and Solidus integration
+
+Integration of Solidus with Flow, how it is done.
+
+I plan to be concise as possible, but cover all important topics.
+
+## Instalation
+
+In ```./config/application.rb``` this is the only peace of code that is needed to
+init complete flow app.
+
+```
+  config.to_prepare do
+    # add all flow libs
+    overload = Dir.glob('./app/flow/**/*.rb')
+    overload.reverse.each { |c| require(c) }
+  end
+
+  config.after_initialize do |app|
+    # init Flow payments as an option
+    app.config.spree.payment_methods << Spree::Gateway::Flow
+
+    # define defaults
+    Flow.organization = ENV.fetch('FLOW_ORGANIZATION')
+    Flow.base_country = ENV.fetch('FLOW_BASE_COUNTRY')
+    Flow.api_key      = ENV.fetch('FLOW_API_KEY')
+  end
+```
+
+## Things to take into account
+
+ActiveMerchent is not supporting sessions and orders, natively. If one wants
+to maintain sessions and orders in Flow, you have to do it outside the ActiveMerchant
+terminology which focuses around purchases, voids and refunds.
+
+Another thing to have in mind is that Solidus/Spree can't work with ActiveMerchent directly, it has to have
+an adapter. Adapter can be "stupid" and light, and can forward all the "heavy lifting" to ActiveMerchant gem
+but it can also have all the logic localy.
+
+In http://guides.spreecommerce.org/developer/payments.html at the bottom of the page Spree authors say
+
+"better_spree_paypal_express and spree-adyen are good examples of standalone
+custom gateways. No dependency on spree_gateway or activemerchant required."
+
+Reading that we can see this is even considered good approach. For us, this is a possibility
+but we consume ActiveMerchatFlow gem.
+
+## ActiveMerchant gem into more detail
+
+https://github.com/flowcommerce/active_merchant
+
+Sopporst stanard public ActiveMerchant actions which are
+purchase, authorize, capture, void, store and refund.
+
+It depends on following gems
+
+* flowcommerce   - api calls
+* flow-reference - we use currency validations
+
+It is not aware of Solidus or any other shopping lib or framework.
+
+### ActiveMerchant::Flow supported actions in detail
+
+* purchase  - shortcut for authorize and then capture
+* authorize - authorize the cc and funds.
+* capture   - capture the funds
+* void      - cancel the transaction
+* store     - store credit card (gets credit card flow token)
+* refund    - refund the funds
+
+## Solidus/Spree Implementation in more detail
+
+Not present as standalone gem, yet. I will do that once we agree on implementation details.
+
+From product list to purchase, complete chain v1
+
+1. customer has to prepare data, migrate db and connect to Flow. In general
+  * create experiences in Flow console, add tiers, shipping methods, etc.
+  * add flow_data (jsonb) fields to this models
+    * Spree::Variant - we cache localized product prices
+    * Spree::Order   - we cache flow order state details, shipping method
+  * create and sync product catalog via rake tasks
+1. now site users can browse prooducts and add them to cart.
+1. when user comes to shop, FlowSession is created
+1. once product is in cart
+  * spree order is created and linked to Experience that we get from FlowSession
+  * it is captured and synced with flow, realtime
+    * we do this all the time because we want to have 100% accurate prices.
+      Product prices that are shown in cart come directly from Flow API.
+  * in checkout, when customer address is added or shipping method defined,
+    all is synced with flow order.
+  * when order is complete, we trigger flow-cc-authorize or flow-cc-capture directly
+    on Spree::Order object instance. This is good because all gateway actions
+    are functions of the order object anyway.
+    * flow-cc-authorize or flow-cc-capture use ActiveMerchantFlow to execute this actions
+    * ActiveMerchantFlow included flow-reference gem
+
+## What can be better
+
+We need a way to access the order in Rails. Access it after it is created in
+controller but before it hits the render.
+Current implementation is -> "overload" ApplicationController render
+If we detect @spree_order object or debug flags, we react.
+
+* good    - elegant solution, all need code is in one file in few lines of code
+* bad     - somehow intrusive, we overload render, somw people will not like that.
+* alternatives: gem that allows before_render bethod, call explicitly when needed
+
+## Aditional notes - view and frontend
+
+I see many Solidus/Spree merchant gems carry frontend code, js, coffe, views etc.
+I thing that this is bad practise and that shop frontend has to be 100% customer code.
+
+What I did not see but thing is great idea is to have custom light Flow admin present at
+
+/admin/flow
+
+that will ease the way of working with Flow. Code can be made to be Rails 4 and Rails 5 compatibile.
+Part of that is allready done as can be seen here [Flow admin screenshot](https://i.imgur.com/FXbPrwK.png)
+
+By default Flow Admin (on /admin/flow) is anybody that is Solidus admin.
+
+This way we provide good frontend info, some integration notes in realtime as opposed to running
+rake tests to check for integrity of Flow integration.
+
+I suggest we make it part of flow-solidus gem.
+

data/static/app/flow/decorators/admin_decorators.rb

@@ -0,0 +1,34 @@
+# Flow (2017)
+# Enable this modifications if you want to display flow localized line item
+# and total prices beside Solidus/Spree default
+# Example: https://i.imgur.com/7v2ix2G.png
+
+Spree::LineItem.class_eval do
+  # admin show line item price
+  def single_money
+    price  = display_price.to_s
+    price += ' (%s)' % order.flow_line_item_price(self) if order.flow_order
+    price
+  end
+end
+
+###
+
+Spree::Order.class_eval do
+  def display_total
+    price = Flow.format_default_price total
+    price += ' (%s)' % flow_total if flow_order
+    price.html_safe
+  end
+end
+
+###
+
+module Spree::Admin::OrdersHelper
+  # admin show line item total price
+  def line_item_shipment_price(line_item, quantity)
+    price = Spree::Money.new(line_item.price * quantity, { currency: line_item.currency }).to_s
+    price += ' (%s)' % @order.flow_line_item_price(line_item, quantity) if @order.flow_order
+    price.html_safe
+  end
+end

data/static/app/flow/decorators/localized_coupon_code_decorator.rb

@@ -0,0 +1,49 @@
+# Flow (2017)
+
+Spree::Api::OrdersController.class_eval do
+
+  # /flow/promotion_set_option?id=3&type=experience&name=canada&value=1
+  # alias :apply_coupon_code_pointer :apply_coupon_code
+  def apply_coupon_code
+    # find promotion code
+    coupon_code    = params[:coupon_code]
+    promotion_code = Spree::PromotionCode.find_by value: coupon_code
+
+    if promotion_code
+      # promotion code found
+      promotion       = Spree::Promotion.find promotion_code.promotion_id
+
+      # get experience key from session
+      experience_data = JSON.load(session[ApplicationController::FLOW_SESSION_KEY] || '{}')
+
+      experience_key  = experience_data.dig 'local', 'experience', 'key'
+      forbiden_keys   = promotion.flow_data.dig 'filter', 'experience'
+
+      # Rails.logger.error 'experience_key: %s' % experience_key
+      # Rails.logger.error 'forbiden_keys: %s' % forbiden_keys.join(', ')
+
+      allowed = true
+      allowed = false if experience_key && forbiden_keys.is_a?(Array) && !forbiden_keys.include?(experience_key)
+
+      return render(status: 400, json: {
+        successful:  false,
+        success:     nil,
+        status_code: 'coupon_code_not_found',
+        error:       'Promotion is not available in current country'
+      }) unless allowed
+    end
+
+    # call original coupon handler
+    # apply_coupon_code_pointer
+
+    authorize! :update, @order, order_token
+    @order.coupon_code = params[:coupon_code]
+    @handler = Spree::PromotionHandler::Coupon.new(@order).apply
+    if @handler.successful?
+      render "spree/api/promotions/handler", status: 200
+    else
+      logger.error("apply_coupon_code_error=#{@handler.error.inspect}")
+      render "spree/api/promotions/handler", status: 422
+    end
+  end
+end

data/static/app/flow/decorators/spree_credit_card_decorator.rb

@@ -0,0 +1,35 @@
+# added flow specific methods to Spree::CreditCard
+
+Spree::CreditCard.class_eval do
+
+  validate :flow_fetch_cc_token
+
+  def flow_fetch_cc_token
+    return false unless respond_to?(:flow_data) # Flow not installed
+    return false if flow_data['cc_token']
+    return false unless number
+    return errors.add(:verification_value, 'CVV verification value is required') unless verification_value.present?
+
+    # build cc hash
+    data = {}
+    data[:number]           = number
+    data[:name]             = name
+    data[:cvv]              = verification_value
+    data[:expiration_year]  = year.to_i
+    data[:expiration_month] = month.to_i
+
+    card_form = ::Io::Flow::V0::Models::CardForm.new(data)
+    result    = FlowCommerce.instance.cards.post(Flow.organization, card_form)
+
+    # cache the result
+    flow_data['cc_token'] = result.token
+
+    true
+  rescue Io::Flow::V0::HttpClient::ServerError
+    puts $!.message
+    flow_error = $!.message.split(':', 2).first
+    errors.add(:base, flow_error)
+  end
+
+end
+