spree_channable 0.0.18.alpha

data/lib/spree_channable/order_importer.rb

@@ -0,0 +1,280 @@
+module SpreeChannable
+  class OrderImporter
+
+    def self.import(user, params)
+      begin
+        ensure_country_id_from_params params[:ship_address_attributes]
+        ensure_state_id_from_params params[:ship_address_attributes]
+        ensure_country_id_from_params params[:bill_address_attributes]
+        ensure_state_id_from_params params[:bill_address_attributes]
+
+        create_params = params.slice :currency
+        order = Spree::Order.create! create_params
+        order.associate_user!(user) if user.present?
+
+        shipments_attrs = params.delete(:shipments_attributes)
+
+        create_line_items_from_params(params.delete(:line_items_attributes), order)
+        create_shipments_from_params(shipments_attrs, order)
+        create_adjustments_from_params(params.delete(:adjustments_attributes), order)
+        create_payments_from_params(params.delete(:payments_attributes), order)
+
+        if completed_at = params.delete(:completed_at)
+          order.completed_at = completed_at
+          order.state = 'complete'
+        end
+
+        params.delete(:user_id) unless user.present? && user.try(:has_spree_role?, "admin") && params.key?(:user_id)
+
+        order.update_attributes!(params)
+
+        order.create_proposed_shipments unless shipments_attrs.present?
+
+        # Really ensure that the order totals & states are correct
+        order.updater.update
+        if shipments_attrs.present?
+          order.shipments.each_with_index do |shipment, index|
+            shipment.update_columns(cost: shipments_attrs[index][:cost].to_f) if shipments_attrs[index][:cost].present?
+          end
+        end
+        order.reload
+      rescue Exception => e
+        order.destroy if order && order.persisted?
+        raise e.message
+      end
+    end
+
+    def self.create_payments_from_params(payments_hash, order)
+      return [] unless payments_hash
+      payments_hash.each do |p|
+        begin
+          payment = order.payments.build order: order
+          payment.amount = p[:amount].to_f || order.total
+          # Order API should be using state as that's the normal payment field.
+          # spree_wombat serializes payment state as status so imported orders should fall back to status field.
+          payment.state = p[:state] || p[:status] || 'completed'
+          payment.created_at = p[:created_at] if p[:created_at]
+          payment.payment_method = p[:payment_method]
+          payment.source = create_source_payment_from_params(p[:source], payment) if p[:source]
+          payment.save!
+        rescue Exception => e
+          raise "Order import payments: #{e.message} #{p}"
+        end
+      end
+    end
+
+    def self.create_shipments_from_params(shipments_hash, order)
+      return [] unless shipments_hash
+
+      inventory_units = Spree::Stock::InventoryUnitBuilder.new(order).units
+
+      shipments_hash.each do |s|
+        begin
+          shipment = order.shipments.build
+          shipment.tracking = s[:tracking]
+          shipment.stock_location = s[:stock_location]
+
+          shipment_units = s[:inventory_units] || []
+          shipment_units.each do |su|
+            ensure_variant_id_from_params(su)
+
+            inventory_unit = inventory_units.detect {|iu| iu.variant_id.to_i == su[:variant_id].to_i}
+
+            if inventory_unit.present?
+              inventory_unit.shipment = shipment
+
+              if s[:shipped_at].present?
+                inventory_unit.pending = false
+                inventory_unit.state = 'shipped'
+              end
+
+              inventory_unit.save!
+
+              # Don't assign shipments to this inventory unit more than once
+              inventory_units.delete(inventory_unit)
+            end
+          end
+
+          if s[:shipped_at].present?
+            shipment.shipped_at = s[:shipped_at]
+            shipment.state = 'shipped'
+          end
+
+          shipment.save!
+
+          shipping_method = Spree::ShippingMethod.where("channable_channel_name LIKE CONCAT('%', ?, '%')", s[:shipping_method]).first || shipping_method = Spree::ShippingMethod.find_by(name: s[:shipping_method]) || Spree::ShippingMethod.find_by!(admin_name: s[:shipping_method])
+          rate = shipment.shipping_rates.create!(shipping_method: shipping_method, cost: s[:cost])
+
+          shipment.selected_shipping_rate_id = rate.id
+          shipment.update_amounts
+
+          adjustments = s.delete(:adjustments_attributes)
+          create_adjustments_from_params(adjustments, order, shipment)
+        rescue Exception => e
+          raise "Order import shipments: #{e.message} #{s}"
+        end
+      end
+    end
+
+    def self.create_line_items_from_params(line_items, order)
+      return {} unless line_items
+      iterator = case line_items
+                 when Hash
+                   ActiveSupport::Deprecation.warn(<<-EOS, caller)
+              Passing a hash is now deprecated and will be removed in Spree 4.0.
+              It is recommended that you pass it as an array instead.
+
+              New Syntax:
+
+              {
+                "order": {
+                  "line_items": [
+                    { "variant_id": 123, "quantity": 1 },
+                    { "variant_id": 456, "quantity": 1 }
+                  ]
+                }
+              }
+
+              Old Syntax:
+
+              {
+                "order": {
+                  "line_items": {
+                    "1": { "variant_id": 123, "quantity": 1 },
+                    "2": { "variant_id": 123, "quantity": 1 }
+                  }
+                }
+              }
+                   EOS
+                   :each_value
+                 when Array
+                   :each
+                 end
+
+      line_items.send(iterator) do |line_item|
+        begin
+          adjustments = line_item.delete(:adjustments_attributes)
+          extra_params = line_item.except(:variant_id, :quantity, :sku)
+          line_item = ensure_variant_id_from_params(line_item)
+          variant = Spree::Variant.find(line_item[:variant_id])
+          line_item = order.contents.add(variant, line_item[:quantity])
+          # Raise any errors with saving to prevent import succeeding with line items
+          # failing silently.
+          if extra_params.present?
+            line_item.update_attributes!(extra_params)
+          else
+            line_item.save!
+          end
+          create_adjustments_from_params(adjustments, order, line_item)
+        rescue Exception => e
+          raise "Order import line items: #{e.message} #{line_item}"
+        end
+      end
+    end
+
+    def self.create_adjustments_from_params(adjustments, order, adjustable = nil)
+      return [] unless adjustments
+      adjustments.each do |a|
+        begin
+          adjustment = (adjustable || order).adjustments.build(
+              order: order,
+              amount: a[:amount].to_f,
+              label: a[:label],
+              source_type: source_type_from_adjustment(a)
+          )
+          adjustment.save!
+          adjustment.close!
+        rescue Exception => e
+          raise "Order import adjustments: #{e.message} #{a}"
+        end
+      end
+    end
+
+    def self.create_source_payment_from_params(source_hash, payment)
+      begin
+        Spree::CreditCard.create(
+            month: source_hash[:month],
+            year: source_hash[:year],
+            cc_type: source_hash[:cc_type],
+            last_digits: source_hash[:last_digits],
+            name: source_hash[:name],
+            payment_method: payment.payment_method,
+            gateway_customer_profile_id: source_hash[:gateway_customer_profile_id],
+            gateway_payment_profile_id: source_hash[:gateway_payment_profile_id],
+            imported: true
+        )
+      rescue Exception => e
+        raise "Order import source payments: #{e.message} #{source_hash}"
+      end
+    end
+
+    def self.ensure_variant_id_from_params(hash)
+      begin
+        sku = hash.delete(:sku)
+        unless hash[:variant_id].present?
+          hash[:variant_id] = Spree::Variant.active.find_by_sku!(sku).id
+        end
+        hash
+      rescue ActiveRecord::RecordNotFound => e
+        raise "Ensure order import variant: Variant w/SKU #{sku} not found."
+      rescue Exception => e
+        raise "Ensure order import variant: #{e.message} #{hash}"
+      end
+    end
+
+    def self.ensure_country_id_from_params(address)
+      return if address.nil? or address[:country_id].present? or address[:country].nil?
+
+      begin
+        search = {}
+        if name = address[:country]['name']
+          search[:name] = name
+        elsif iso_name = address[:country]['iso_name']
+          search[:iso_name] = iso_name.upcase
+        elsif iso = address[:country]['iso']
+          search[:iso] = iso.upcase
+        elsif iso3 = address[:country]['iso3']
+          search[:iso3] = iso3.upcase
+        end
+
+        address.delete(:country)
+        address[:country_id] = Spree::Country.where(search).first!.id
+
+      rescue Exception => e
+        raise "Ensure order import address country: #{e.message} #{search}"
+      end
+    end
+
+    def self.ensure_state_id_from_params(address)
+      return if address.nil? or address[:state_id].present? or address[:state].nil?
+
+      begin
+        search = {}
+        if name = address[:state]['name']
+          search[:name] = name
+        elsif abbr = address[:state]['abbr']
+          search[:abbr] = abbr.upcase
+        end
+
+        address.delete(:state)
+        search[:country_id] = address[:country_id]
+
+        if state = Spree::State.where(search).first
+          address[:state_id] = state.id
+        else
+          address[:state_name] = search[:name] || search[:abbr]
+        end
+      rescue Exception => e
+        raise "Ensure order import address state: #{e.message} #{search}"
+      end
+    end
+
+    def self.source_type_from_adjustment(adjustment)
+      if adjustment[:tax]
+        'Spree::TaxRate'
+      elsif adjustment[:promotion]
+        'Spree::PromotionAction'
+      end
+    end
+  end
+end

data/lib/spree_channable/return_importer.rb

@@ -0,0 +1,63 @@
+module SpreeChannable
+  class ReturnImporter
+
+
+    # {
+    #             "status": "new",
+    #             "channel_name": "bol",
+    #             "channel_id": "61284922",
+    #             "channable_id": 151,
+    #             "data": {
+    #                 "item": {
+    #                     "id": "11694321",
+    #                     "order_id": "4522232111",
+    #                     "gtin": "0884500642113",
+    #                     "title": "Nike Air Force 1 Winter Premium GS Flax Pack",
+    #                     "quantity": 1,
+    #                     "reason": "Anders, namelijk:",
+    #                     "comment": "De schoenen vielen te groot."
+    #                 },
+    #                 "customer": {
+    #                     "gender": "male",
+    #                     "first_name": "Jans",
+    #                     "last_name": "Van Janssen",
+    #                     "email": "2ixee2337ca74m23423uu@verkopen.bol.com"
+    #                 },
+    #                 "address": {
+    #                     "first_name": "Jans",
+    #                     "last_name": "Van Janssen",
+    #                     "email": "2ixee2337ca74m23423uu@verkopen.bol.com",
+    #                     "street": "Teststraat",
+    #                     "house_number": 12,
+    #                     "address1": "Teststraat 12",
+    #                     "adderss2": "",
+    #                     "city": "Utrecht",
+    #                     "country_code": "NL",
+    #                     "zip_code": "1234 XZ"
+    #                 }
+    #             }
+    #         }
+    def self.import(return_data)
+      order = Spree::Order.find_by_channable_order_id(return_data.data.item.order_id)
+
+      return_reason_id = Spree::ReturnAuthorizationReason.first.id
+      inventory_unit = order.line_items.detect {|li| li.variant.sku == return_data.data.item.gtin}&.inventory_units&.first
+
+
+      if order && inventory_unit
+        return_authorization = Spree::ReturnAuthorization.create!(
+            order_id: order.id,
+            stock_location: ::SpreeChannable.configuration.stock_location,
+            return_authorization_reason_id: return_reason_id
+        )
+        Spree::CustomerReturn.create(
+            stock_location: ::SpreeChannable.configuration.stock_location,
+            channable_order_id: return_data.channable_id,
+            return_items_attributes: {
+                return_authorization_id: return_authorization.id, inventory_unit_id: inventory_unit.id
+            })
+      end
+    end
+
+  end
+end

data/lib/spree_channable/version.rb

@@ -0,0 +1,18 @@
+module SpreeChannable
+  module_function
+
+  # Returns the version of the currently loaded SpreeChannable as a
+  # <tt>Gem::Version</tt>.
+  def version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 18
+    PRE   = 'alpha'.freeze
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/spree_channable.rb

@@ -0,0 +1,36 @@
+require 'spree_core'
+require 'spree_extension'
+require 'spree_channable/engine'
+require 'spree_channable/version'
+require 'spree_channable/order_importer'
+
+require 'channable/client'
+require 'channable/response'
+
+require 'whenever'
+
+module SpreeChannable
+
+  class << self
+    def configuration
+      Configuration.new
+    end
+  end
+
+  class Configuration
+    ATTR_LIST = [:host, :url_prefix, :image_host, :product_condition, :brand, :delivery_period, :use_variant_images, :channable_api_key, :company_id, :project_id, :stock_location, :payment_method, :polling_interval, :active?]
+
+    ATTR_LIST.each do |a|
+      define_method a do
+        setting_model.try(a)
+      end
+    end
+
+    private
+
+    def setting_model
+      ::ChannableSetting.last
+    end
+  end
+
+end

data/spec/fixtures/invalid_channable_order.json

@@ -0,0 +1,117 @@
+{
+  "order": {
+    "channel_id": "123",
+    "channel_name": "bol",
+    "created": "2017-08-02T14:31:48",
+    "data": {
+      "billing": {
+        "address1": "Billingstraat 1",
+        "address2": "Onder de brievanbus huisnummer 1 extra adres info",
+        "address_supplement": "Onder de brievanbus huisnummer 1 extra adres info",
+        "city": "Amsterdam",
+        "company": "Bol.com",
+        "country_code": "NL",
+        "email": "dontemail@me.net",
+        "first_name": "Jans",
+        "house_number": 1,
+        "house_number_ext": "",
+        "last_name": "Janssen",
+        "middle_name": "",
+        "region": "",
+        "street": "Billingstraat",
+        "zip_code": "5000 ZZ"
+      },
+      "customer": {
+        "company": "Bol.com",
+        "email": "dontemail@me.net",
+        "first_name": "Jans",
+        "gender": "male",
+        "last_name": "Janssen",
+        "middle_name": "",
+        "mobile": "",
+        "phone": "0201234567"
+      },
+      "extra": {
+        "comment": "Bol.com order id: 123",
+        "memo": "Order from Channable \n Bol.com order id: 123\n Customer receipt: https:\/\/www.bol.com\/sdd\/orders\/downloadallpackageslips.html"
+      },
+      "price": {
+        "commission": 1.5,
+        "currency": "EUR",
+        "payment_method": "bol",
+        "shipping": 0,
+        "subtotal": 123.45,
+        "total": 123.45,
+        "transaction_fee": 0
+      },
+      "products": [
+        {
+          "commission": 1.5,
+          "delivery_period": "2017-08-02+02:00",
+          "ean": "does_not_exist",
+          "id": "11693020",
+          "price": 61.725,
+          "quantity": 2,
+          "reference_code": "123",
+          "shipping": 0,
+          "title": "Harry Potter"
+        }
+      ],
+      "shipping": {
+        "address1": "Shipmentstraat 42 bis",
+        "address2": "",
+        "address_supplement": "3 hoog achter extra adres info",
+        "city": "Amsterdam",
+        "company": "The Company",
+        "country_code": "NL",
+        "email": "nospam4me@myaccount.com",
+        "first_name": "Jan",
+        "house_number": 42,
+        "house_number_ext": "bis",
+        "last_name": "Janssen",
+        "middle_name": "",
+        "region": "",
+        "street": "Shipmentstraat",
+        "zip_code": "1000 AA"
+      }
+    },
+    "error": false,
+    "fulfillment": {},
+    "id": 299623,
+    "modified": "2017-08-10T18:08:13.699449",
+    "platform_id": "299623",
+    "platform_name": "channable",
+    "project_id": 6496,
+    "status_paid": "paid",
+    "status_shipped": "shipped"
+  },
+  "events": [
+    {
+      "created": "2016-10-20T10:55:08.507355",
+      "id": 1234545,
+      "message": "Sent shipment update to Amazon",
+      "modified": "2016-10-20T10:55:08.507378",
+      "order_id": 299623,
+      "project_id": 91919,
+      "status": "info"
+    },
+    {
+      "created": "2016-10-20T10:54:53.074700",
+      "id": 2370337,
+      "message": "Changed shipping status: not_shipped -> shipped",
+      "modified": "2016-10-20T10:54:53.074705",
+      "order_id": 299623,
+      "project_id": 91919,
+      "status": "info"
+    },
+    {
+      "created": "2016-10-19T10:54:15.008544",
+      "id": 1407404,
+      "message": "Channable order processed: 299623",
+      "modified": "2016-10-19T10:54:15.008551",
+      "order_id": 299623,
+      "project_id": 91919,
+      "status": "info"
+    }
+  ]
+}

data/spec/fixtures/valid_channable_order.json

@@ -0,0 +1,117 @@
+{
+  "order": {
+    "channel_id": "123",
+    "channel_name": "bol",
+    "created": "2017-08-02T14:31:48",
+    "data": {
+      "billing": {
+        "address1": "Billingstraat 1",
+        "address2": "Onder de brievanbus huisnummer 1 extra adres info",
+        "address_supplement": "Onder de brievanbus huisnummer 1 extra adres info",
+        "city": "Amsterdam",
+        "company": "Bol.com",
+        "country_code": "NL",
+        "email": "dontemail@me.net",
+        "first_name": "Jans",
+        "house_number": 1,
+        "house_number_ext": "",
+        "last_name": "Janssen",
+        "middle_name": "",
+        "region": "",
+        "street": "Billingstraat",
+        "zip_code": "5000 ZZ"
+      },
+      "customer": {
+        "company": "Bol.com",
+        "email": "dontemail@me.net",
+        "first_name": "Jans",
+        "gender": "male",
+        "last_name": "Janssen",
+        "middle_name": "",
+        "mobile": "",
+        "phone": "0201234567"
+      },
+      "extra": {
+        "comment": "Bol.com order id: 123",
+        "memo": "Order from Channable \n Bol.com order id: 123\n Customer receipt: https:\/\/www.bol.com\/sdd\/orders\/downloadallpackageslips.html"
+      },
+      "price": {
+        "commission": 1.5,
+        "currency": "EUR",
+        "payment_method": "bol",
+        "shipping": 10,
+        "subtotal": 123.44,
+        "total": 133.44,
+        "transaction_fee": 0
+      },
+      "products": [
+        {
+          "commission": 1.5,
+          "delivery_period": "2017-08-02+02:00",
+          "ean": "9789062387410",
+          "id": "11693020",
+          "price": 61.72,
+          "quantity": 2,
+          "reference_code": "123",
+          "shipping": 0,
+          "title": "Harry Potter"
+        }
+      ],
+      "shipping": {
+        "address1": "Shipmentstraat 42 bis",
+        "address2": "",
+        "address_supplement": "3 hoog achter extra adres info",
+        "city": "Amsterdam",
+        "company": "The Company",
+        "country_code": "NL",
+        "email": "nospam4me@myaccount.com",
+        "first_name": "Jan",
+        "house_number": 42,
+        "house_number_ext": "bis",
+        "last_name": "Janssen",
+        "middle_name": "",
+        "region": "",
+        "street": "Shipmentstraat",
+        "zip_code": "1000 AA"
+      }
+    },
+    "error": false,
+    "fulfillment": {},
+    "id": 299623,
+    "modified": "2017-08-10T18:08:13.699449",
+    "platform_id": "299623",
+    "platform_name": "channable",
+    "project_id": 6496,
+    "status_paid": "paid",
+    "status_shipped": "shipped"
+  },
+  "events": [
+    {
+      "created": "2016-10-20T10:55:08.507355",
+      "id": 1234545,
+      "message": "Sent shipment update to Amazon",
+      "modified": "2016-10-20T10:55:08.507378",
+      "order_id": 299623,
+      "project_id": 91919,
+      "status": "info"
+    },
+    {
+      "created": "2016-10-20T10:54:53.074700",
+      "id": 2370337,
+      "message": "Changed shipping status: not_shipped -> shipped",
+      "modified": "2016-10-20T10:54:53.074705",
+      "order_id": 299623,
+      "project_id": 91919,
+      "status": "info"
+    },
+    {
+      "created": "2016-10-19T10:54:15.008544",
+      "id": 1407404,
+      "message": "Channable order processed: 299623",
+      "modified": "2016-10-19T10:54:15.008551",
+      "order_id": 299623,
+      "project_id": 91919,
+      "status": "info"
+    }
+  ]
+}

data/spree_channable.gemspec

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'spree_channable/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_channable'
+  s.version     = SpreeChannable.version
+  s.summary     = 'Spree Channable'
+  s.description = 'Connect your spree store to channable. Receive orders, generate product feeds and send shipment updates.'
+  s.required_ruby_version = '>= 2.2.7'
+
+  s.author    = 'Fabian Oudhaarlem'
+  s.email     = 'fabian@oldharlem.nl'
+  s.homepage  = 'https://github.com/Oldharlem/spree_channable'
+  s.license = 'BSD-3-Clause'
+
+  s.files       = `git ls-files`.split("\n").reject { |f| f.match(/^spec/) && !f.match(/^spec\/fixtures/) }
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  spree_version = '>= 3.1.0', '< 5.0'
+  s.add_dependency 'rails', '>= 4.2.0'
+  s.add_dependency 'spree_core', spree_version
+  s.add_dependency 'spree_backend', spree_version
+  s.add_dependency 'spree_extension'
+  s.add_dependency 'parallel'
+  s.add_dependency 'httparty'
+  s.add_dependency 'whenever'
+
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'awesome_print'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'capybara-screenshot'
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_bot', '~> 4.7'
+  s.add_development_dependency 'factory_bot_rails', '~> 4.7'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'mysql2'
+  s.add_development_dependency 'pg'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'sass-rails'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3', '~> 1.3.6'
+  s.add_development_dependency 'webdrivers', '~> 3.8.0'
+end