spree_channable 0.0.18.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc45055d9e1bef626d21f196471a45402d5c220cc05d0db9f7488630addc54a6
+  data.tar.gz: 0ef0d52b27cce58f5fe3edbc8fac265163b517ae4354c671513689d0dbe8ee3b
+SHA512:
+  metadata.gz: c83193ff3364edc06054c6ecea2fe661c6d30de3af8f01aa4f95998b72d99dbcab4a633bce31c6736104519992a8443bd67696f7f38fce81f3e044b7913f717f
+  data.tar.gz: 43dac314d47fb2fdd16374b6a6ace86df645655accb6e63d9e20c1241b36b9fca52fac39fda740276a7ad3abd81d3437ed69ecd6b77f040e70069d8ebc09c2a6

data/.gitignore

@@ -0,0 +1,23 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.localeapp/locales
+.project
+.vscode
+coverage
+default
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.sw?
+spec/dummy
+.rvmrc
+.sass-cache
+public/spree
+.ruby-version
+.ruby-gemset
+gemfiles/*.gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-r spec_helper
+-f documentation

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Appraisals'
+  Exclude:
+    - 'spec/dummy/**/*'
+    - 'lib/generators/**/*'
+
+Rails:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 150
+
+# DISABLED
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,35 @@
+sudo: required
+dist: trusty
+
+language: ruby
+
+env:
+  - DB=postgres
+  - DB=mysql
+
+gemfile:
+  - gemfiles/spree_3_2.gemfile
+  - gemfiles/spree_3_5.gemfile
+  - gemfiles/spree_3_7.gemfile
+  - gemfiles/spree_master.gemfile
+
+script:
+  - bundle exec rake test_app
+  - bundle exec rake spec
+
+rvm:
+  - 2.5.1
+  - 2.4.2
+
+matrix:
+  allow_failures:
+    - gemfile: gemfiles/spree_master.gemfile
+
+before_install:
+  - mysql -u root -e "GRANT ALL ON *.* TO 'travis'@'%';"
+  - wget -N https://chromedriver.storage.googleapis.com/2.35/chromedriver_linux64.zip -P ~/
+  - unzip ~/chromedriver_linux64.zip -d ~/
+  - rm ~/chromedriver_linux64.zip
+  - sudo mv -f ~/chromedriver /usr/local/share/
+  - sudo chmod +x /usr/local/share/chromedriver
+  - sudo ln -s /usr/local/share/chromedriver /usr/local/bin/chromedriver

data/Appraisals

@@ -0,0 +1,27 @@
+appraise 'spree-3-2' do
+  gem 'spree_core', '~> 3.2.0'
+  gem 'spree_backend', '~> 3.2.0'
+  gem 'spree_auth_devise', '~> 3.4.0'
+  gem 'rails-controller-testing'
+end
+
+appraise 'spree-3-5' do
+  gem 'spree_core', '~> 3.5.0'
+  gem 'spree_backend', '~> 3.5.0'
+  gem 'spree_auth_devise', '~> 3.4.0'
+  gem 'rails-controller-testing'
+end
+
+appraise 'spree-3-7' do
+  gem 'spree_core', '~> 3.7.0'
+  gem 'spree_backend', '~> 3.7.0'
+  gem 'spree_auth_devise', '~> 3.5.0'
+  gem 'rails-controller-testing'
+end
+
+appraise 'spree-master' do
+  gem 'spree_core', github: 'spree/spree', branch: 'master'
+  gem 'spree_backend', github: 'spree/spree', branch: 'master'
+  gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+  gem 'rails-controller-testing'
+end

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+gem 'spree_core', github: 'spree/spree', branch: 'master'
+gem 'spree_backend', github: 'spree/spree', branch: 'master'
+# Provides basic authentication functionality for testing parts of your engine
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
+gem 'rails-controller-testing'
+
+gem 'rubocop', require: false
+gem 'rubocop-rspec', require: false
+
+gemspec

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, Fabian Oudhaarlem
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. 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.
+
+3. Neither the name of the copyright holder 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 HOLDER 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,56 @@
+# SpreeChannable
+
+Channable offers many ways to transform a product feed to many marketplace formats. On top channable offers an order connection to accept incoming orders from connected marketplaces. This gem connects your spree store to the channable platform. The feeds are configurable and can be directly loaded into channable. 
+The order connection can be enabled by channable on request and can be easily configured through the spree admin panel. 
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+  ```ruby
+  gem 'spree_channable', github: 'Oldharlem/spree_channable'
+  ```
+
+2. Install the gem using Bundler:
+  ```ruby
+  bundle install
+  ```
+
+3. Copy & run migrations
+  ```ruby
+  bundle exec rails g spree_channable:install
+  ```
+
+4. Schedule order imports
+
+Schedule the `SpreeChannable::OrderImportJob.perform_later` to run every `SpreeChannable.configuration.polling_interval` minutes. This script will pull all orders placed `SpreeChannable.configuration.polling_interval` minutes ago. Please configure the integration through the channable settings under spree configurations before running the script. 
+
+5. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+  
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_channable/factories'
+```
+
+
+## Contributing
+
+If you'd like to contribute, please take a look at the
+[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
+pull request.
+
+Copyright (c) 2019 Fabian Oudhaarlem, 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_channable'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/spree_channable.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_channable.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_channable.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_channable.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/channable_settings_controller.rb

@@ -0,0 +1,14 @@
+module Spree
+  module Admin
+    class ChannableSettingsController < ResourceController
+      def index
+        path = model_class.last ? edit_admin_channable_setting_path(model_class.last.id) : new_admin_channable_setting_path
+        redirect_to path
+      end
+
+      def model_class
+        @model_class ||= ::ChannableSetting
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v1/channable_controller.rb

@@ -0,0 +1,21 @@
+class Spree::Api::V1::ChannableController < Spree::Api::BaseController
+
+  before_action :get_products, only: [:variant_feed, :product_feed]
+
+  def variant_feed
+    headers["Content-Type"] = 'application/atom+xml; charset=utf-8'
+    render plain: Spree::Product.to_channable_variant_xml(@products)
+  end
+
+  def product_feed
+    headers["Content-Type"] = 'application/atom+xml; charset=utf-8'
+    render plain: Spree::Product.to_channable_product_xml(@products)
+  end
+
+  private
+
+  def get_products
+    @products = Spree::Product.active.includes([:option_types, :taxons, product_properties: :property, variants: [{option_values: :option_type}, :default_price, :images], master: [{option_values: :option_type}, :default_price, :images]])
+  end
+
+end

data/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/app/jobs/spree_channable/order_import_job.rb

@@ -0,0 +1,37 @@
+module SpreeChannable
+  class OrderImportJob < ApplicationJob
+    queue_as :default
+
+    def perform(*args)
+      return unless ::SpreeChannable.configuration.active?
+
+      @client = ::Channable::Client.new
+      channable_orders = get_orders
+      channable_orders.each &method(:persist_order)
+    end
+
+    def get_orders
+      limit = 100
+      orders = []
+      loop do
+        order_data = client.get_orders(offset: orders.size, limit: limit, start_date: (SpreeChannable.configuration.polling_interval * 2).minutes.ago)
+        order_data.data.orders.each {|order| orders << order} if order_data.data.orders.any?
+
+        break if order_data.data.total < limit || (!order_data.success && order_data.response.code != 429)
+      end
+      orders
+    end
+
+    def persist_order(channable_order)
+      return if Spree::Order.exists?(channable_order_id: channable_order.id)
+      begin
+        order_attributes = Spree::Order.channable_to_order_params(channable_order)
+        SpreeChannable::OrderImporter.import(nil, order_attributes)
+      rescue StandardError => e
+        Rails.logger.warn "[CHANNABLE] Failed to import order #{channable_order.id}. #{e}"
+        @client.cancellation_update(channable_order.id)
+      end
+    end
+
+  end
+end

data/app/jobs/spree_channable/return_import_job.rb

@@ -0,0 +1,36 @@
+module SpreeChannable
+  class ReturnImportJob < ApplicationJob
+    queue_as :default
+
+    def perform(*args)
+      return unless ::SpreeChannable.configuration.active?
+
+      @client = ::Channable::Client.new
+      channable_returns = get_returns
+      channable_returns.each &method(:persist_return)
+    end
+
+    def get_returns
+      limit = 100
+      returns = []
+      loop do
+        return_data = @client.get_returns(offset: returns.size, limit: limit, start_date: (SpreeChannable.configuration.polling_interval * 2).minutes.ago)
+        return_data.data.returns.each {|return_data| returns << return_data} if return_data.data.returns.any?
+
+        break if return_data.data.total < limit || (!return_data.success && return_data.response.code != 429)
+      end
+      returns
+    end
+
+    def persist_return(channable_return)
+      return if Spree::ReturnAuthorization.exists?(channable_return_id: channable_return.channable_id)
+      begin
+        SpreeChannable::ReturnImporter.import(channable_return)
+      rescue StandardError => e
+        Rails.logger.warn "[CHANNABLE] Failed to import return #{channable_return.channable_id}. #{e}"
+        @client.return_update(channable_return.channable_id, {status: 'cancelled'}.to_json)
+      end
+    end
+
+  end
+end

data/app/models/channable_setting.rb

@@ -0,0 +1,10 @@
+class ChannableSetting < ActiveRecord::Base
+
+  belongs_to :stock_location, foreign_key: 'spree_stock_location_id', class_name: 'Spree::StockLocation'
+  belongs_to :payment_method, foreign_key: 'spree_payment_method_id', class_name: 'Spree::PaymentMethod'
+
+  PRODUCT_CONDITIONS = ['New', 'Used']
+
+  validates_inclusion_of :product_condition, in: PRODUCT_CONDITIONS
+
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,127 @@
+module Spree
+  module SpreeChannable
+    module OrderDecorator
+
+      def channable_client
+        @channable_client ||= ::Channable::Client.new
+      end
+
+      def deliver_order_confirmation_email
+        unless is_channable_order?
+          super
+        end
+      end
+
+      def send_cancel_email
+        unless is_channable_order?
+          super
+        end
+      end
+
+      def is_channable_order?
+        channable_order_id.present?
+      end
+
+      def cancel_channable_order
+        return unless is_channable_order?
+
+        channable_client.cancellation_update(channable_order_id)
+      end
+
+      def self.prepended(base)
+        base.state_machine.after_transition to: :cancelled, do: :cancel_channable_order
+
+        class << base
+
+          def channable_to_order_params(channable_order)
+              order_params = {}
+
+              order_params[:channable_order_id] = channable_order.id
+              order_params[:channable_channel_order_id] = channable_order.channel_id
+              order_params[:channable_channel_name] = channable_order.channel_name
+              order_params[:completed_at] = DateTime.parse(channable_order.created)
+              order_params[:email] = channable_order.data.shipping.email
+
+              order_params[:bill_address_attributes] = build_address(channable_order.data.billing)
+              order_params[:ship_address_attributes] = build_address(channable_order.data.shipping)
+
+              order_params[:shipments_attributes] = build_shipments_attributes(channable_order)
+              order_params[:payments_attributes] = build_payments_attributes(channable_order)
+              order_params[:line_items_attributes] = build_line_items_attributes(channable_order)
+
+              order_params
+          end
+
+          def build_address(address_params)
+            {
+                firstname: address_params.first_name,
+                lastname: address_params.last_name,
+                address1: address_params.street,
+                address2: [address_params.house_number, address_params.house_number_ext].join(' '),
+                city: address_params.city,
+                zipcode: address_params.zip_code,
+                phone: '0612345678',
+                country: {
+                    'iso' => address_params.country_code
+                }
+            }
+          end
+
+          def build_shipments_attributes(channable_order)
+            [
+                {
+                    tracking: nil,
+                    stock_location: ::SpreeChannable.configuration.stock_location,
+                    shipping_method: channable_order.channel_name,
+                    inventory_units: channable_order.data.products.flat_map do |item|
+                      variant = Spree::Variant.active.find_by_sku!(item.ean)
+                      item.quantity.times.map do
+                        {
+                            variant_id: variant.id
+                        }
+                      end
+                    end
+                }
+            ]
+          end
+
+          def build_payments_attributes(channable_order)
+            [
+                {
+                    amount: channable_order.data.price.total.to_f,
+                    state: 'completed',
+                    payment_method: ::SpreeChannable.configuration.payment_method
+                }
+            ]
+          end
+
+          def build_line_items_attributes(channable_order)
+            channable_order.data.products.map do |item|
+              variant = Spree::Variant.active.find_by_sku!(item.ean)
+              {
+                  variant_id: variant.id,
+                  quantity: item.quantity,
+                  price: item.price.to_f
+              }
+            end.compact
+          end
+
+
+          def build_adjustments_attributes(channable_order)
+            raise 'Not implemented'
+            [
+                {
+                    label: 'Channable Discount',
+                    amount: -(channable_order['discount'].abs.to_f)
+                }
+            ]
+          end
+
+        end
+      end
+    end
+  end
+end
+
+Spree::Order.prepend(Spree::SpreeChannable::OrderDecorator)
+

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,118 @@
+require 'parallel'
+
+module Spree
+  module SpreeChannable
+    module ProductDecorator
+      def self.prepended(base)
+        class << base
+
+          def to_channable_variant_xml(products)
+            builder = Nokogiri::XML::Builder.new do |xml|
+              xml.feed(xmlns: 'http://www.w3.org/2005/Atom') do
+                xml.title 'Channable variant feed'
+                xml.link(rel: 'self', href: ::SpreeChannable.configuration.host)
+                xml.updated DateTime.now.strftime('%Y-%m-%dT%H:%M:%S%z')
+
+                Parallel.map(products) {|product| product.to_channable_variant_xml}.each do |products_xml|
+                  products_xml.each do |variant_xml|
+                    xml.parent << Nokogiri::XML(variant_xml).at('product')
+                  end
+                end
+
+              end
+            end
+
+            builder.to_xml
+          end
+
+          def to_channable_product_xml(products)
+            builder = Nokogiri::XML::Builder.new do |xml|
+              xml.feed(xmlns: 'http://www.w3.org/2005/Atom') do
+                xml.title 'Channable product feed'
+                xml.link(rel: 'self', href: ::SpreeChannable.configuration.host)
+                xml.updated DateTime.now.strftime('%Y-%m-%dT%H:%M:%S%z')
+
+                xml.products do
+                  Parallel.map(products) {|product| product.to_channable_product_xml}.each do |product_xml|
+                    xml.parent << Nokogiri::XML(product_xml).at('product')
+                  end
+                end
+
+              end
+            end
+
+            builder.to_xml
+          end
+        end
+      end
+
+
+      def to_channable_variant_xml
+        variants.active.map do |variant|
+          variant.to_channable_feed_entry
+        end
+      end
+
+      def to_channable_product_xml
+        Nokogiri::XML::Builder.new do |xml|
+          xml.product do
+            xml.id id
+            xml.title "#{name}"
+            xml.description ActionController::Base.helpers.strip_tags(normalized_description)
+            xml.link URI.join(::SpreeChannable.configuration.host, "/#{::SpreeChannable.configuration.url_prefix}/" + slug).to_s
+            (xml.image_link URI.join(::SpreeChannable.configuration.image_host, images.first.attachment.url(:large)).to_s) if images.any?
+            xml.condition property('product_condition') || ::SpreeChannable.configuration.product_condition
+
+            xml.price price
+
+            xml.brand property('brand') || ::SpreeChannable.configuration.brand
+
+            xml.categories do
+              taxons.each do |taxon|
+                xml.category taxon.self_and_ancestors.collect(&:name).join('|')
+              end
+            end
+
+            xml.currency Spree::Config.currency
+            xml.locale I18n.default_locale
+
+            # Property fields
+
+            xml.gender property('gender') || 'Not set'
+            xml.delivery_period property('delivery_period') || ::SpreeChannable.configuration.delivery_period
+            xml.material property('material') || 'Not set'
+
+            xml.variants do
+              variants.each do |variant|
+                xml.variant do
+                  xml.id variant.id
+                  xml.product_id id
+                  xml.options_text variant.options_text
+                  (xml.image_link URI.join(::SpreeChannable.configuration.image_host, variant.get_images.first.attachment.url(:large)).to_s) unless variant.get_images.empty?
+
+                  xml.availability variant.can_supply?
+                  xml.stock variant.total_on_hand
+                  xml.price variant.price
+                  xml.sale_price variant.respond_to?(:sale_price) ? (variant.sale_price || variant.price) : variant.price
+
+                  xml.sku variant.sku
+
+                  xml.currency Spree::Config.currency
+                  xml.locale I18n.default_locale
+
+                  variant.option_values.each do |option_value|
+                    xml.send(option_value.option_type.name, option_value.presentation)
+                  end
+                end
+              end
+            end
+
+          end
+        end.to_xml
+      end
+
+    end
+  end
+end
+
+Spree::Product.prepend(Spree::SpreeChannable::ProductDecorator)