spree_channable 0.0.18.alpha

data/app/models/spree/reimbursement_decorator.rb

@@ -0,0 +1,39 @@
+module Spree
+  module SpreeChannable
+    module ReimbursementDecorator
+      def send_reimbursement_email
+        super unless order.is_channable_order?
+      end
+
+      def reimburse_channable_order
+        return unless order.is_channable_order?
+
+        client = ::Channable::Client.new
+        client.return_update(customer_return.channable_return_id, channable_return)
+      end
+
+      def channable_return
+        {
+            status: channable_return_status
+        }.to_json
+      end
+
+      def channable_return_status
+        case reimbursement_status
+        when 'reimbursed'
+          'accepted'
+        when 'errored'
+          'cancelled'
+        else
+          'accepted'
+        end
+      end
+
+      def self.prepended(base)
+        base.state_machine.after_transition to: :reimbursed, do: :reimburse_channable_order
+      end
+    end
+  end
+end
+
+Spree::Reimbursement.prepend(Spree::SpreeChannable::ReimbursementDecorator)

data/app/models/spree/shipment_decorator.rb

@@ -0,0 +1,28 @@
+module Spree
+  module SpreeChannable
+    module ShipmentDecorator
+
+      def self.prepended(base)
+        base.state_machine.after_transition to: :shipped, do: :send_shipment_update
+      end
+
+      def send_shipment_update
+        return unless order.is_channable_order?
+
+        client = ::Channable::Client.new
+        client.shipment_update(order.channable_order_id, channable_shipment)
+      end
+
+      def channable_shipment
+        {
+            tracking_code: tracking,
+            tracking_url: tracking_url,
+            transporter: shipping_method.channable_transporter_code
+        }.to_json
+      end
+
+    end
+  end
+end
+
+Spree::Shipment.prepend(Spree::SpreeChannable::ShipmentDecorator)

data/app/models/spree/shipment_handler_decorator.rb

@@ -0,0 +1,11 @@
+module Spree
+  module SpreeChannable
+    module ShipmentHandlerDecorator
+      def send_shipped_email
+        super unless @shipment.order.is_channable_order?
+      end
+    end
+  end
+end
+
+Spree::ShipmentHandler.prepend(Spree::SpreeChannable::ShipmentHandlerDecorator)

data/app/models/spree/variant_decorator.rb

@@ -0,0 +1,78 @@
+module Spree
+  module SpreeChannable
+    module VariantDecorator
+
+      def self.same_product_colors(variant)
+        joins(option_values: :translations).where(spree_option_value_translations: {presentation: variant.option_value('color')}, product_id: variant.product_id).includes(:default_price, option_values: :option_type)
+      end
+
+      def to_channable_feed_entry
+        return nil if price.blank?
+
+        Nokogiri::XML::Builder.new do |xml|
+          xml.product {
+            xml.id id
+            xml.product_id product.id
+            xml.title "#{product.name}"
+            xml.description ActionController::Base.helpers.strip_tags(product.normalized_description)
+            xml.link URI.join(::SpreeChannable.configuration.host, "/#{::SpreeChannable.configuration.url_prefix}/" + product.slug).to_s
+            (xml.image_link URI.join(::SpreeChannable.configuration.image_host, get_images.first.attachment.url(:large)).to_s) unless get_images.empty?
+            xml.condition product.property('product_condition') || ::SpreeChannable.configuration.product_condition
+
+            xml.availability can_supply?
+            xml.stock total_on_hand
+            xml.price price
+            xml.sale_price respond_to?(:sale_price) ? (sale_price || price) : price
+
+            xml.gtin sku
+            xml.mpn sku
+            xml.sku sku
+
+            xml.brand product.property('brand') || ::SpreeChannable.configuration.brand
+
+            xml.categories do
+              product.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
+
+            option_values.each do |option_value|
+              xml.send(option_value.option_type.name, option_value.presentation)
+            end
+
+            # Property fields
+
+            xml.gender product.property('gender') || 'Not set'
+            xml.delivery_period product.property('delivery_period') || ::SpreeChannable.configuration.delivery_period
+            xml.material product.property('material') || 'Not set'
+          }
+        end.to_xml
+      end
+
+      def get_images
+        images = []
+        if ::SpreeChannable.configuration.use_variant_images
+          if self.class.respond_to?(:same_product_colors)
+            images = self.class.same_product_colors(self).flat_map(&:images)
+          else
+            self.images
+          end
+        else
+          self.product.images
+        end
+
+        if images.any?
+          images
+        else
+          self.product.images
+        end
+      end
+
+    end
+  end
+end
+
+Spree::Variant.prepend(Spree::SpreeChannable::VariantDecorator)

data/app/overrides/add_settings_to_admin_configurator.rb

@@ -0,0 +1,32 @@
+Deface::Override.new(
+  virtual_path: "spree/admin/shared/sub_menu/_configuration",
+  name: "add_channable_settings_configuration_menu",
+  insert_bottom: '[data-hook="admin_configurations_sidebar_menu"]',
+  text: '<%= configurations_sidebar_menu_item "Channable settings", spree.admin_channable_settings_path %>'
+)
+
+shipping_method_form = <<-ERB
+
+    <div data-hook="admin_shipping_method_form_channable_name" class="col-md-2">
+      <%= f.field_container :channable_channel_name, :class => ['form-group'] do %>
+        <%= f.label :channable_channel_name, Spree.t(:channable_channel_name) + '(s)' %>
+        <%= f.text_field :channable_channel_name, class: 'form-control', label: false %>
+        <%= f.error_message_on :channable_channel_name %>
+      <% end %>
+    </div>
+
+    <div data-hook="admin_shipping_method_form_channable_transporter_code" class="col-md-2">
+      <%= f.field_container :channable_transporter_code, :class => ['form-group'] do %>
+        <%= f.label :channable_transporter_code, Spree.t(:channable_transporter_code) %>
+        <%= f.text_field :channable_transporter_code, class: 'form-control', label: false %>
+        <%= f.error_message_on :channable_transporter_code %>
+      <% end %>
+    </div>
+ERB
+
+Deface::Override.new(
+    virtual_path: "spree/admin/shipping_methods/_form",
+    name: "add_channable_settings_to_shipping_methods",
+    insert_after: '[data-hook="admin_shipping_method_form_tracking_url_field"]',
+    text: shipping_method_form
+)

data/app/overrides/order_index.rb

@@ -0,0 +1,13 @@
+Deface::Override.new(
+    virtual_path: 'spree/admin/orders/index',
+    name: 'add tradebyte order info header',
+    insert_after: '#listing_orders thead th:nth-last-child(3)',
+    partial: 'spree/admin/orders/index_channable_state_override_head'
+)
+
+Deface::Override.new(
+    virtual_path: 'spree/admin/orders/index',
+    name: 'add tradebyte order info',
+    insert_after: '#listing_orders tbody td:nth-last-child(3)',
+    partial: 'spree/admin/orders/index_channable_state_override'
+)

data/app/views/spree/admin/channable_settings/_form.html.erb

@@ -0,0 +1,105 @@
+<%= form_for [:admin, resource] do |f| %>
+  <div data-hook="">
+    <div class="row">
+      <div class="col-md-12">
+        <h2>Feed settings</h2>
+      </div>
+      <div class="col-md-6">
+        <div class="form-group">
+          <%= f.label :host %>
+          <%= f.text_field :host, class: 'form-control' %>
+        </div>
+      </div>
+      <div class="col-md-6">
+        <div class="form-group">
+          <%= f.label :url_prefix, 'Product url prefix (eg. /products)' %>
+          <%= f.text_field :url_prefix, class: 'form-control' %>
+        </div>
+      </div>
+      <div class="col-md-6">
+        <div class="form-group">
+          <%= f.label :image_host %>
+          <%= f.text_field :image_host, class: 'form-control' %>
+        </div>
+      </div>
+      <div class="col-md-6">
+        <div class="form-group">
+          <%= f.label :product_condition %>
+          <%= f.select :product_condition, options_for_select(ChannableSetting::PRODUCT_CONDITIONS), {}, class: 'form-control' %>
+        </div>
+      </div>
+      <div class="col-md-6">
+        <div class="form-group">
+          <%= f.label :brand %>
+          <%= f.text_field :brand, class: 'form-control' %>
+        </div>
+      </div>
+      <div class="col-md-6">
+        <div class="form-group">
+          <%= f.label :delivery_period %>
+          <%= f.text_field :delivery_period, class: 'form-control' %>
+        </div>
+      </div>
+
+      <div class="col-md-12">
+        <div class="form-check">
+          <%= f.check_box :use_variant_images, class: 'form-check-input' %>
+          <%= f.label :use_variant_images, 'Use images on the variant instead of all image', class: 'form-check-label' %>
+        </div>
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="col-md-12">
+        <h2>Order settings</h2>
+      </div>
+      <div class="col-md-12">
+        <div class="form-group">
+          <%= f.label :channable_api_key %>
+          <%= f.text_field :channable_api_key, class: 'form-control' %>
+        </div>
+      </div>
+      <div class="col-md-6">
+        <div class="form-group">
+          <%= f.label :company_id %>
+          <%= f.text_field :company_id, class: 'form-control' %>
+        </div>
+      </div>
+      <div class="col-md-6">
+        <div class="form-group">
+          <%= f.label :project_id %>
+          <%= f.text_field :project_id, class: 'form-control' %>
+        </div>
+      </div>
+      <div class="col-md-6">
+        <div class="form-group">
+          <%= f.label :spree_stock_location_id, 'Stock location' %>
+          <%= f.select :spree_stock_location_id, options_from_collection_for_select(Spree::StockLocation.all, :id, :name, f.object.spree_stock_location_id), {}, class: 'form-control' %>
+        </div>
+      </div>
+      <div class="col-md-6">
+        <div class="form-group">
+          <%= f.label :spree_payment_method_id, 'Payment method' %>
+          <%= f.select :spree_payment_method_id, options_from_collection_for_select(Spree::PaymentMethod.all, :id, :name, f.object.spree_payment_method_id), {}, class: 'form-control' %>
+        </div>
+      </div>
+
+      <div class="col-md-6">
+        <div class="form-group">
+          <%= f.label :polling_interval, 'How often do we need to retrieve orders (minutes)' %>
+          <%= f.number_field :polling_interval, class: 'form-control' %>
+        </div>
+      </div>
+
+      <div class="col-md-12">
+        <div class="form-check">
+          <%= f.check_box :active, class: 'form-check-input' %>
+          <%= f.label :active, 'Connection active?', class: 'form-check-label' %>
+        </div>
+      </div>
+    </div>
+
+  </div>
+
+  <%= render "spree/admin/shared/#{resource.new_record? ? 'new' : 'edit'}_resource_links" %>
+<% end %>

data/app/views/spree/admin/channable_settings/edit.html.erb

@@ -0,0 +1 @@
+<%= render 'form', resource: @channable_setting %>

data/app/views/spree/admin/channable_settings/new.html.erb

@@ -0,0 +1 @@
+<%= render 'form', resource: @channable_setting %>

data/app/views/spree/admin/orders/_index_channable_state_override.html.erb

@@ -0,0 +1,7 @@
+<td>
+  <% if order.is_channable_order? %>
+    <span class="label label-success">Channable order <%= order.channable_order_id %> <%= order.channable_channel_name %></span>
+  <% else %>
+    <span class="label label-success">Regular order</span>
+  <% end %>
+</td>

data/app/views/spree/admin/orders/_index_channable_state_override_head.html.erb

@@ -0,0 +1 @@
+<th><%= sort_link @search, :is_channable_order?, 'Type' %></th>

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" from the root of your extension
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_channable/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/config/routes.rb

@@ -0,0 +1,18 @@
+Spree::Core::Engine.add_routes do
+
+  namespace :admin do
+    resources :channable_settings
+  end
+
+  namespace :api do
+    namespace :v1 do
+      resources :channable, only: [] do
+        collection do
+          get :product_feed
+          get :variant_feed
+        end
+      end
+    end
+  end
+
+end

data/db/migrate/20190710092345_create_channable_settings.rb

@@ -0,0 +1,16 @@
+class CreateChannableSettings < ActiveRecord::Migration[5.0]
+  def change
+    create_table :channable_settings do |t|
+
+      t.string :host
+      t.string :url_prefix
+      t.string :image_host
+      t.string :product_condition
+      t.string :brand
+      t.string :delivery_period
+      t.boolean :use_variant_images
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20190710103701_add_settings_to_settings_table.rb

@@ -0,0 +1,9 @@
+class AddSettingsToSettingsTable < ActiveRecord::Migration[5.0]
+  def change
+    change_table :channable_settings do |t|
+      t.string :channable_api_key
+      t.string :company_id
+      t.string :project_id
+    end
+  end
+end

data/db/migrate/20190710115409_add_order_columns.rb

@@ -0,0 +1,9 @@
+class AddOrderColumns < ActiveRecord::Migration[5.0]
+  def change
+    change_table :spree_orders do |t|
+      t.integer :channable_order_id
+      t.string :channable_channel_order_id
+      t.string :channable_channel_name
+    end
+  end
+end

data/db/migrate/20190711122425_set_order_connection_defaults.rb

@@ -0,0 +1,5 @@
+class SetOrderConnectionDefaults < ActiveRecord::Migration[5.0]
+  def change
+    add_column :channable_settings, :spree_stock_location_id, :integer
+  end
+end

data/db/migrate/20190711123402_add_channable_fields_to_shipping_methods.rb

@@ -0,0 +1,8 @@
+class AddChannableFieldsToShippingMethods < ActiveRecord::Migration[5.0]
+  def change
+    change_table :spree_shipping_methods do |t|
+      t.string :channable_channel_name
+      t.string :channable_transporter_code
+    end
+  end
+end

data/db/migrate/20190711140015_add_payment_method_for_channable.rb

@@ -0,0 +1,7 @@
+class AddPaymentMethodForChannable < ActiveRecord::Migration[5.0]
+  def change
+
+    Spree::PaymentMethod.find_or_create_by(name: 'Paid at channable', display_on: :back_end, type: 'Spree::PaymentMethod::Check', active: true)
+
+  end
+end

data/db/migrate/20190711145940_add_order_import_settings.rb

@@ -0,0 +1,9 @@
+class AddOrderImportSettings < ActiveRecord::Migration[5.0]
+  def change
+    change_table :channable_settings do |t|
+      t.integer :polling_interval, default: 30
+      t.integer :spree_payment_method_id
+      t.boolean :active, default: false
+    end
+  end
+end

data/db/migrate/20190717120144_add_channable_id_to_return_authorisations.rb

@@ -0,0 +1,5 @@
+class AddChannableIdToReturnAuthorisations < ActiveRecord::Migration[5.0]
+  def change
+    add_column :spree_customer_returns, :channable_return_id, :integer
+  end
+end

data/gemfiles/spree_3_2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails-controller-testing'
+gem 'spree_core', '~> 3.2.0'
+gem 'spree_backend', '~> 3.2.0'
+gem 'spree_auth_devise', '~> 3.4.0'
+
+gemspec path: '../'

data/gemfiles/spree_3_5.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails-controller-testing'
+gem 'spree_core', '~> 3.5.0'
+gem 'spree_backend', '~> 3.5.0'
+gem 'spree_auth_devise', '~> 3.4.0'
+
+gemspec path: '../'

data/gemfiles/spree_3_7.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails-controller-testing'
+gem 'spree_core', '~> 3.7.0'
+gem 'spree_backend', '~> 3.7.0'
+gem 'spree_auth_devise', '~> 3.5.0'
+
+gemspec path: '../'

data/gemfiles/spree_master.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails-controller-testing'
+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'
+
+gemspec path: '../'

data/lib/channable/client.rb

@@ -0,0 +1,42 @@
+require 'httparty'
+
+module Channable
+  class Client
+    include ::HTTParty
+
+    def initialize
+      self.class.base_uri "https://api.channable.com/v1/companies/#{SpreeChannable.configuration.company_id}/projects/#{SpreeChannable.configuration.project_id}"
+      self.class.headers 'Authorization' => "Bearer #{SpreeChannable.configuration.channable_api_key}"
+      self.class.headers 'Content-Type' => 'application/json'
+    end
+
+    def get_orders(start_date: 1.day.ago, offset: 0, limit: 100)
+      Channable::Response.new(self.class.get('/orders', query: {
+          limit: limit,
+          start_date: start_date.strftime('%Y-%m-%d'),
+          offset: offset
+      }))
+    end
+
+    def get_returns(start_date: 1.day.ago, offset: 0, limit: 100)
+      Channable::Response.new(self.class.get('/returns', query: {
+          limit: limit,
+          start_date: start_date,
+          offset: offset
+      }))
+    end
+
+    def return_update(return_id, return_body)
+      Channable::Response.new(self.class.post("/returns/#{return_id}/status", body: return_body))
+    end
+
+    def shipment_update(order_id, shipment_body)
+      Channable::Response.new(self.class.post("/orders/#{order_id}/shipment", body: shipment_body))
+    end
+
+    def cancellation_update(order_id)
+      Channable::Response.new(self.class.post("/orders/#{order_id}/cancel"))
+    end
+
+  end
+end

data/lib/channable/response.rb

@@ -0,0 +1,15 @@
+module Channable
+  class Response
+
+    attr_reader :data
+    attr_reader :success
+    attr_reader :response
+
+    def initialize(response_data)
+      @response = response_data
+      @success = response_data.success?
+      @data = JSON.parse(response_data.body, object_class: OpenStruct)
+    end
+
+  end
+end

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

@@ -0,0 +1,20 @@
+module SpreeChannable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_channable'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_channable/engine.rb

@@ -0,0 +1,20 @@
+module SpreeChannable
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_channable'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_channable/factories.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_channable/factories'
+end