spree_fosdick_integration 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b13986672e0deb67ca5905d5bb4ddd945baf4535
+  data.tar.gz: c8f580eb733f0bf062a9ed39154c7879eee2d110
+SHA512:
+  metadata.gz: 97ee5e4468d6637dca27732d38eec742864ae783e7acb5872745fa8bdef388337a6bac43dbccd32fcc751cfc0f171cc9e715cef8135695f5f8cd9b970dd54f19
+  data.tar.gz: e0370185fa1dd7097b24be8b92705ebe2b3acca64c132462ef31c5235f742cdf773e70c7e36bc2c060e2de59dd46d32b3dbf1a75863b3927c520db428d2da58b

data/.gitignore

@@ -0,0 +1,28 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+.ruby-version
+.ruby-gemset
+nbproject
+*.swp
+spec/dummy
+config/fosdick.yml

data/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spree_fosdick_integration.gemspec
+gem 'httparty'
+gem 'nokogiri'
+gem 'model_un'
+
+spree_version = '3-1-stable'
+
+gem 'spree',             github: 'spree/spree',             branch: spree_version
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: spree_version
+
+gem 'haml'
+gem 'haml-rails'
+gem 'active_model_serializers', '~> 0.9.3'
+
+group :test do
+  gem 'shoulda-matchers', require: false
+  gem 'webmock'
+end
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 JetRuby Agency
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# SpreeFosdickIntegration
+
+Current gem provides easy integration for you Spree Commerce based apps with full service fulfillment services of Fosdick Fulfillment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spree_fosdick_integration'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_fosdick_integration:install
+```
+Update ``` config/fosdick.yml ``` with your credentials received from Fosdick
+
+## Usage
+Create a rake task to push shipments to Fosdick iPost interface:
+
+```
+desc "Push shipments to Fosdick iPost interface"
+task push_shipments_fosdick: :environment do
+  eligible_shipments = Spree::Shipment.perform_fosdick_shipments
+
+  if eligible_shipments.present?
+    eligible_shipments.each do |shipment|
+      Fosdick::Processor.send_shipment(shipment, FOSDICK_CONFIG)
+    end
+  end
+end
+```
+
+Create a rake task to receive shipment information from Fosdick API:
+
+```
+desc "Receive shipment information from Fosdick API"
+task receive_shipments_fosdick: :environment do
+  eligible_shipments = Spree::FosdickShipment.eligible_fosdick_shipments
+
+  if eligible_shipments.present?
+    eligible_shipments.each do |fosdick_shipment|
+      # get tracking details
+      Fosdick::Processor.receive_shipment({external_order_num: fosdick_shipment.external_order_num }) if fosdick_shipment.tracking_number.nil?
+      # get ship_date
+      Fosdick::Processor.receive_shipment({external_order_num: fosdick_shipment.external_order_num }, 'shipments.json') if fosdick_shipment.ship_date.nil?
+    end
+  end
+end
+```
+
+Override the email view to customise:
+
+```
+app/views/spree/fosdick_shipment_mailer/order_shipped.html.erb
+```
+
+## Testing
+
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
+
+```shell
+bundle
+bundle exec rake test_app
+bundle exec rspec spec
+```
+
+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_fosdick_integration/factories'
+```

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task default: [:spec]
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_fosdick_integration'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/controllers/spree/admin/fosdick_shipments_controller.rb

@@ -0,0 +1,18 @@
+class Spree::Admin::FosdickShipmentsController < Spree::Admin::BaseController
+  respond_to :js, only: [:index]
+
+  def index
+    params[:q] ||= {}
+
+    params_clone = params[:q].deep_dup
+
+    [:created_at_gt, :created_at_lt, :ship_date_gt, :ship_date_lt].each do |date_param|
+      if params_clone[date_param].present?
+        params_clone[date_param] = Time.zone.parse(params_clone[date_param]).beginning_of_day rescue ''
+      end
+    end
+
+    @search = Spree::FosdickShipment.includes(:fosdick_exceptions).ransack(params_clone)
+    @fosdick_shipments = @search.result(distinct: true).page(params[:page]).per(Spree::Config[:admin_products_per_page]).order(created_at: :desc)
+  end
+end

data/app/mailers/spree/fosdick_shipment_mailer.rb

@@ -0,0 +1,13 @@
+module Spree
+  class FosdickShipmentMailer < ActionMailer::Base
+    default from: 'spree@example.com'
+
+    def order_shipped(shipment)
+      @shipment = shipment
+      @tracking = shipment.tracking,
+      @order_number = shipment.order.number
+
+      mail to: @shipment.order.email, subject: Spree.t('fosdick.order_shipped.subject')
+    end
+  end
+end

data/app/models/spree/fosdick_exception.rb

@@ -0,0 +1,15 @@
+class Spree::FosdickException < ActiveRecord::Base
+  belongs_to :fosdick_shipment, class_name: 'Spree::FosdickShipment', foreign_key: :spree_fosdick_shipment_id
+
+  after_create :update_shipment_fosdick_state
+
+  def shipment
+    self.fosdick_shipment.shipment
+  end
+
+  private
+
+  def update_shipment_fosdick_state
+    self.shipment.update_column(:fosdick_state, "#{message.include?('Duplicate') ? 'duplicate' : 'exception'}")
+  end
+end

data/app/models/spree/fosdick_shipment.rb

@@ -0,0 +1,8 @@
+class Spree::FosdickShipment < ActiveRecord::Base
+  belongs_to :shipment,           class_name: 'Spree::Shipment',         foreign_key: :spree_shipment_id
+  has_many   :fosdick_exceptions, class_name: 'Spree::FosdickException', foreign_key: :spree_fosdick_shipment_id
+
+  scope :eligible_fosdick_shipments, -> { where.not(fosdick_order_num: nil).where(state: 'sent', ship_date: nil)}
+
+  serialize :tracking_number
+end

data/app/models/spree/shipment_decorator.rb

@@ -0,0 +1,17 @@
+Spree::Shipment.class_eval do
+  has_one :fosdick_shipment, class_name: 'Spree::FosdickShipment', foreign_key: :spree_shipment_id, dependent: :delete
+
+  def self.perform_fosdick_shipments
+    shipments = where(shipped_at: nil, state: 'ready', send_atempt: 0..2).where.not(fosdick_state: ['duplicate', 'success'])
+
+    JSON.parse(ActiveModel::ArraySerializer.new(shipments, each_serializer: ShipmentSerializer, root: false).to_json) if shipments.present?
+  end
+
+  def bill_to
+    order.bill_address
+  end
+
+  def ship_to
+    order.ship_address
+  end
+end

data/app/overrides/add_fosdick_panel.rb

@@ -0,0 +1,8 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/orders/index',
+  name: 'admin_fosdick_index_button',
+  insert_before: "erb[silent]:contains('if can? :edit, Spree::Order.new ')",
+  text: "<li style='padding-right: 5px;'>
+           <%= button_link_to 'Fosdick panel', admin_fosdick_shipments_path, icon: '', id: 'admin_fosdick_index' %>
+         </li>"
+)

data/app/serializers/address_serializer.rb

@@ -0,0 +1,18 @@
+require 'active_model/serializer'
+
+class AddressSerializer < ActiveModel::Serializer
+  attributes :firstname, :lastname, :address1, :address2, :zipcode, :city,
+             :state, :country, :phone
+
+  def country
+    object.country.try(:iso)
+  end
+
+  def state
+    if object.state
+      object.state.abbr
+    else
+      object.state_name
+    end
+  end
+end

data/app/serializers/inventory_unit_serializer.rb

@@ -0,0 +1,21 @@
+require 'active_model/serializer'
+
+class InventoryUnitSerializer < ActiveModel::Serializer
+  attributes :product_id, :name, :quantity, :price
+
+  def quantity
+    object.respond_to?(:quantity) ? object.quantity : 1
+  end
+
+  def price
+    object.line_item.price.round(2).to_f
+  end
+
+  def product_id
+    object.variant.sku
+  end
+
+  def name
+    object.variant.name
+  end
+end

data/app/serializers/shipment_serializer.rb

@@ -0,0 +1,104 @@
+require 'active_model/serializer'
+
+class ShipmentSerializer < ActiveModel::Serializer
+  attributes :id, :order_id, :email, :cost, :status, :stock_location,
+            :shipping_method, :tracking, :placed_on, :shipped_at, :totals,
+            :updated_at, :channel, :items, :shipping_method_code
+
+  has_one :bill_to, serializer: AddressSerializer, root: 'billing_address'
+  has_one :ship_to, serializer: AddressSerializer, root: 'shipping_address'
+
+  def id
+    object.number
+  end
+
+  def order_id
+    object.order.number
+  end
+
+  def email
+    object.order.email
+  end
+
+  def channel
+    object.order.channel || 'spree'
+  end
+
+  def cost
+    object.cost.to_f
+  end
+
+  def status
+    object.state
+  end
+
+  def stock_location
+    object.stock_location.name
+  end
+
+  def shipping_method
+    if object.shipping_method.try(:name)
+      if object.shipping_method.try(:name).include?('Standard') || object.shipping_method.try(:name).include?('Free')
+        ''
+      elsif object.shipping_method.try(:name).include?('Expedited')
+        object.shipping_method.try(:code)
+      end
+    else
+      ''
+    end
+  end
+
+  def shipping_method_code
+    object.shipping_method.try(:code)
+  end
+
+  def placed_on
+    if object.order.completed_at?
+      object.order.completed_at.getutc.try(:iso8601)
+    else
+      ''
+    end
+  end
+
+  def shipped_at
+    object.shipped_at.try(:iso8601)
+  end
+
+  def totals
+    {
+      item: object.order.display_item_total.to_s,
+      adjustment: object.order.display_adjustment_total.to_s, #adjustment_total.to_s,
+      tax: object.order.display_tax_total.to_s, #tax_total.to_s,
+      shipping: object.order.display_ship_total.to_s, #shipping_total.to_s
+      payment: object.order.payments.completed.sum(:amount).to_s,
+      order: object.order.display_total.to_s
+    }
+  end
+
+  def updated_at
+    object.updated_at.iso8601
+  end
+
+  def items
+    i = []
+    object.inventory_units.each do |inventory_unit|
+      i << InventoryUnitSerializer.new(inventory_unit, root: false)
+    end
+    i
+  end
+
+  private
+
+  def adjustment_total
+    object.order.adjustment_total.to_f
+  end
+
+  def shipping_total
+    object.order.shipment_total.to_f
+  end
+
+  def tax_total
+    object.order.tax_total.to_f
+  end
+
+end

data/app/services/exception_logger.rb

@@ -0,0 +1,21 @@
+class ExceptionLogger
+
+  def log(code, message, instance_id)
+    # Include notification logic if needed
+    unless Spree::FosdickException.find_by(spree_fosdick_shipment_id: instance_id, error_code: code).present?
+      Spree::FosdickException.create! build_fosdick_exception_attributes(code, message, instance_id)
+    end
+  end
+
+  private
+
+  def build_fosdick_exception_attributes(code, message, instance_id)
+    {
+      spree_fosdick_shipment_id: instance_id,
+      error_code: code,
+      message: message,
+      state: 'error',
+      happened_at: Time.now.in_time_zone
+    }
+  end
+end

data/app/views/spree/admin/fosdick_shipments/_filters_bar.html.haml

@@ -0,0 +1,36 @@
+.row
+  - content_for :table_filter do
+    %div{'data-hook' => 'admin_fosdick_shipments_index_search'}
+      = search_form_for [:admin, @search] do |f|
+        .field-block.alpha.four.columns
+          .date-range-filter.field
+            = label_tag :q_created_at, Spree.t('fosdick.date_range_created')
+            .date-range-fields
+              = f.text_field :created_at_gt, class: 'datepicker datepicker-from', value: params[:q][:created_at_gt], placeholder: Spree.t(:start)
+              %span.range-divider{style: 'padding-top: 3px;'}
+              = f.text_field :created_at_lt, class: 'datepicker datepicker-to', value: params[:q][:created_at_lt], placeholder: Spree.t(:stop)
+        .field-block.alpha.four.columns
+          .date-range-filter.field
+            = label_tag :q_ship_date, Spree.t('fosdick.date_range_shipped')
+            .date-range-fields
+              = f.text_field :ship_date_gt, class: 'datepicker datepicker-from', value: params[:q][:ship_date_gt], placeholder: Spree.t(:start)
+              %span.range-divider{style: 'padding-top: 3px;'}
+              = f.text_field :ship_date_lt, class: 'datepicker datepicker-to', value: params[:q][:ship_date_lt], placeholder: Spree.t(:stop)
+
+        .field-block.alpha.four.columns
+          .date-range-filter.field
+            = label_tag :q_external_order_num_cont, Spree.t('fosdick.shipment_num')
+            = f.text_field :external_order_num_cont
+
+        .four.columns
+          .field
+            = label_tag :q_state_count, Spree.t('fosdick.integration_state')
+            = f.select :state_eq, [[Spree.t('fosdick.successfully_sent'),'sent'],
+                                   [Spree.t('fosdick.successfully_shipped'),'shipped'],
+                                   [Spree.t('fosdick.state_exception'),'exception']],
+                                  {include_blank: Spree.t('fosdick.select_integration_state')}, class: 'select2'
+
+        .clearfix
+        .actions.filter-actions
+          %div{'data-hook' => 'admin_abandoned_orders_index_search_buttons'}
+            = button Spree.t(:filter_results), 'search'