RubyGems - spree_fosdick_integration - Versions diffs - 0.0.3 - Mend

spree_fosdick_integration 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (52) hide show

checksums.yaml +7 -0
data/.gitignore +28 -0
data/Gemfile +21 -0
data/LICENSE.txt +22 -0
data/README.md +76 -0
data/Rakefile +15 -0
data/app/controllers/spree/admin/fosdick_shipments_controller.rb +18 -0
data/app/mailers/spree/fosdick_shipment_mailer.rb +13 -0
data/app/models/spree/fosdick_exception.rb +15 -0
data/app/models/spree/fosdick_shipment.rb +8 -0
data/app/models/spree/shipment_decorator.rb +17 -0
data/app/overrides/add_fosdick_panel.rb +8 -0
data/app/serializers/address_serializer.rb +18 -0
data/app/serializers/inventory_unit_serializer.rb +21 -0
data/app/serializers/shipment_serializer.rb +104 -0
data/app/services/exception_logger.rb +21 -0
data/app/views/spree/admin/fosdick_shipments/_filters_bar.html.haml +36 -0
data/app/views/spree/admin/fosdick_shipments/_fosdick_shipments_list.html.haml +28 -0
data/app/views/spree/admin/fosdick_shipments/_fosdick_shipments_list_respond.js.erb +1 -0
data/app/views/spree/admin/fosdick_shipments/_titles.html.haml +5 -0
data/app/views/spree/admin/fosdick_shipments/index.html.haml +3 -0
data/app/views/spree/admin/fosdick_shipments/index.js.haml +1 -0
data/app/views/spree/fosdick_shipment_mailer/order_shipped.html.erb +135 -0
data/config/locales/en.yml +14 -0
data/config/locales/ru.yml +14 -0
data/config/routes.rb +10 -0
data/db/migrate/20151013153126_create_spree_fosdick_shipment.rb +17 -0
data/db/migrate/20151015122038_create_fosdick_exceptions.rb +15 -0
data/db/migrate/20151028105216_add_fosdick_atempt_and_state_spree_shipments.rb +6 -0
data/lib/fosdick/documents/shipment.rb +89 -0
data/lib/fosdick/processor.rb +64 -0
data/lib/fosdick/receiver.rb +49 -0
data/lib/fosdick/sender.rb +39 -0
data/lib/generators/spree_fosdick_integration/install/install_generator.rb +32 -0
data/lib/generators/spree_fosdick_integration/install/templates/fosdick.rb +6 -0
data/lib/generators/spree_fosdick_integration/install/templates/fosdick.yml.template +18 -0
data/lib/spree_fosdick_integration.rb +8 -0
data/lib/spree_fosdick_integration/engine.rb +22 -0
data/lib/spree_fosdick_integration/factories.rb +31 -0
data/lib/spree_fosdick_integration/version.rb +3 -0
data/script/rails +7 -0
data/spec/controllers/admin/fosdick_shipments_controller_spec.rb +16 -0
data/spec/models/spree/fosdick_exception_spec.rb +21 -0
data/spec/models/spree/fosdick_shipment_spec.rb +9 -0
data/spec/models/spree/shipment_spec.rb +50 -0
data/spec/services/exception_logger_spec.rb +11 -0
data/spec/services/fosdick/processor_spec.rb +94 -0
data/spec/services/fosdick/receiver_spec.rb +43 -0
data/spec/services/fosdick/sender_spec.rb +34 -0
data/spec/spec_helper.rb +99 -0
data/spree_fosdick_integration.gemspec +37 -0
metadata +286 -0

data/app/views/spree/admin/fosdick_shipments/_fosdick_shipments_list.html.haml ADDED

@@ -0,0 +1,28 @@
+= paginate fosdick_shipments
+%table#listing_fosdick_shipments.index.sortable{'data-hook' => '', 'data-sortable-link' => update_positions_admin_fosdick_shipments_path}
+  %thead
+    %tr{'data-hook' => 'fosdick_shipments_header'}
+      %th.no-border
+      %th Fosdick order
+      %th External order
+      %th Tracking
+      %th Ship date
+      %th Created at
+      %th State
+      %th Errors
+  %tbody
+  - if fosdick_shipments.present?
+    - fosdick_shipments.each do |ship|
+      %tr{class: cycle('odd', 'even'), 'data-hook' => 'fosdick_shipments_row', id: ship.id}
+        %td.no-border
+          %span.handle
+        %td.align-center= ship.fosdick_order_num
+        %td.align-center= link_to ship.external_order_num, edit_admin_order_path(ship.shipment.order)
+        %td.align-center= ship.tracking_number
+        %td.align-center= ship.ship_date
+        %td.align-center= ship.created_at
+        %td.align-center= ship.state
+        - if ship.fosdick_exceptions.present? && ship.state != 'shipped'
+          %td{style: 'color: red;'}= ship.fosdick_exceptions.pluck(:message).uniq.join('. ')
+        - else
+          %td

data/app/views/spree/admin/fosdick_shipments/_fosdick_shipments_list_respond.js.erb ADDED

	@@ -0,0 +1 @@
1	+ $('table#listing_fosdick_shipments').html('<%= j(render('fosdick_shipments_list', fosdick_shipments: @fosdick_shipments))%>');

data/app/views/spree/admin/fosdick_shipments/_titles.html.haml ADDED

@@ -0,0 +1,5 @@
+- content_for :page_title do
+  Fosdick integration panel
+- content_for :page_actions do
+  %li
+    = button_link_to Spree.t(:back_to_orders_list), admin_orders_path, icon: 'arrow-left'

data/app/views/spree/admin/fosdick_shipments/index.html.haml ADDED

@@ -0,0 +1,3 @@
+= render 'titles'
+= render 'filters_bar'
+= render 'fosdick_shipments_list', fosdick_shipments: @fosdick_shipments

data/app/views/spree/admin/fosdick_shipments/index.js.haml ADDED

	@@ -0,0 +1 @@
1	+ = render 'fosdick_shipments_list_respond'

data/app/views/spree/fosdick_shipment_mailer/order_shipped.html.erb ADDED

@@ -0,0 +1,135 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title><%= Spree.t('fosdick.order_shipped.subject') %></title>
+    <style type="text/css">
+      #outlook a{padding:0;} /* Force Outlook to provide a "view in browser" button. */
+      body{width:100% !important;} .ReadMsgBody{width:100%;} .ExternalClass{width:100%;} /* Force Hotmail to display emails at full width */
+      body{-webkit-text-size-adjust:none;} /* Prevent Webkit platforms from changing default text sizes. */
+      body{font-family:Arial;margin:0; padding:0;}
+      img{border:0; height:auto; line-height:100%; outline:none; text-decoration:none;}
+      table td{border-collapse:collapse;}
+      #backgroundTable{height:100% !important; margin:0; padding:0; width:100% !important;}
+      body, #backgroundTable{
+        background-color:#FAFAFA;
+      }
+      #templateContainer{
+        border: 1px solid #DDDDDD;
+        margin-top: 10px;
+        padding: 20px;
+      }
+      h1, .h1{
+        color:#202020;
+        display:block;
+        font-family:Arial;
+        font-size:34px;
+        font-weight:bold;
+        line-height:100%;
+        margin-top:0;
+        margin-right:0;
+        margin-bottom:10px;
+        margin-left:0;
+        text-align:left;
+      }
+      h2, .h2{
+        color:#202020;
+        display:block;
+        font-family:Arial;
+        font-size:30px;
+        font-weight:bold;
+        line-height:100%;
+        margin-top:0;
+        margin-right:0;
+        margin-bottom:10px;
+        margin-left:0;
+        text-align:left;
+      }
+      h3, .h3{
+        color:#202020;
+        display:block;
+        font-family:Arial;
+        font-size:26px;
+        font-weight:bold;
+        line-height:100%;
+        margin-top:0;
+        margin-right:0;
+        margin-bottom:10px;
+        margin-left:0;
+        text-align:left;
+      }
+      h4, .h4{
+        color:#202020;
+        display:block;
+        font-family:Arial;
+        font-size:22px;
+        font-weight:bold;
+        line-height:100%;
+        margin-top:0;
+        margin-right:0;
+        margin-bottom:10px;
+        margin-left:0;
+        text-align:left;
+      }
+      #templateContainer, .bodyContent{
+        background-color:#FFFFFF;
+      }
+      .bodyContent div{
+        color:#505050;
+        font-family:Arial;
+        font-size:14px;
+        line-height:150%;
+        text-align:left;
+      }
+      .bodyContent div a:link, .bodyContent div a:visited, /* Yahoo! Mail Override */ .bodyContent div a .yshortcuts /* Yahoo! Mail Override */{
+        color:#336699;
+        font-weight:normal;
+        text-decoration:underline;
+      }
+      .bodyContent img{
+        display:inline;
+        height:auto;
+      }
+      #items {
+        margin: 10px 0;
+      }
+    </style>
+  </head>
+  <body leftmargin="0" marginwidth="0" topmargin="0" marginheight="0" offset="0">
+    <center>
+      <table border="0" cellpadding="0" cellspacing="0" height="100%" width="100%" id="backgroundTable">
+        <tr>
+          <td align="center" valign="top">
+            <table border="0" cellpadding="0" cellspacing="0" width="600" id="templateContainer">
+              <tr>
+                <td align="center" valign="top">
+                  <table border="0" cellpadding="0" cellspacing="0" width="600" id="templateBody">
+                    <tr>
+                      <td valign="top" class="bodyContent">
+                        <%= "Your order #{@order_number} has shipped!" %><br>
+                        <%= "Your tracking number - #{@tracking}" %>
+                      </td>
+                    </tr>
+                  </table>
+                </td>
+              </tr>
+            </table>
+            <br />
+          </td>
+        </tr>
+      </table>
+    </center>
+  </body>
+</html>

data/config/locales/en.yml ADDED

@@ -0,0 +1,14 @@
+en:
+  spree:
+    fosdick:
+      order_shipped:
+        subject:                     Oreder shipped
+      fosdick_num:                   Fosdick Number
+      shipment_num:                  External order
+      state_exception:               Exception
+      state_sent:                    Successfully sent
+      state_shipped:                 Successfully shipped
+      integration_state:             Integration state
+      date_range_created:            Date range - Created
+      date_range_shipped:            Date range - Shipped
+      select_integration_state:      Select integration state

data/config/locales/ru.yml ADDED

@@ -0,0 +1,14 @@
+ru:
+  spree:
+    fosdick:
+      order_shipped:
+        subject:                     Заказ отправлен
+      fosdick_num:                   Fosdick номер
+      shipment_num:                  Номер доставки
+      state_exception:               Исключение
+      state_sent:                    Успешно отправлено
+      state_shipped:                 Успешно поставляется
+      integration_state:             Статус интеграции
+      date_range_created:            Диапазон дат - Дата создания
+      date_range_shipped:            Диапазон дат - Поставляется
+      select_integration_state:      Выберите статус интеграции

data/config/routes.rb ADDED

@@ -0,0 +1,10 @@
+Spree::Core::Engine.routes.draw do
+  namespace :admin do
+    resources :fosdick_shipments, only: [:index] do
+      collection do
+        post :update_positions
+      end
+    end
+  end
+  get '123' => 'admin/fosdick_shipments#index'
+end

data/db/migrate/20151013153126_create_spree_fosdick_shipment.rb ADDED

@@ -0,0 +1,17 @@
+class CreateSpreeFosdickShipment < ActiveRecord::Migration
+  def change
+    create_table :spree_fosdick_shipments do |t|
+      t.belongs_to :spree_shipment
+      t.string     :fosdick_order_num
+      t.string     :external_order_num
+      t.text       :tracking_number
+      t.string     :state
+      t.boolean    :confirmation_sent, default: false, null: false
+      t.datetime   :ship_date
+      t.timestamps
+    end
+    add_index :spree_fosdick_shipments, :spree_shipment_id
+  end
+end

data/db/migrate/20151015122038_create_fosdick_exceptions.rb ADDED

@@ -0,0 +1,15 @@
+class CreateFosdickExceptions < ActiveRecord::Migration
+  def change
+    create_table :spree_fosdick_exceptions do |t|
+      t.belongs_to :spree_fosdick_shipment
+      t.string     :error_code
+      t.string     :message
+      t.string     :state
+      t.datetime   :happened_at
+      t.timestamps
+    end
+    add_index :spree_fosdick_exceptions, :spree_fosdick_shipment_id
+  end
+end

data/db/migrate/20151028105216_add_fosdick_atempt_and_state_spree_shipments.rb ADDED

@@ -0,0 +1,6 @@
+class AddFosdickAtemptAndStateSpreeShipments < ActiveRecord::Migration
+  def change
+    add_column :spree_shipments, :send_atempt,   :integer, default: 0,       null: false
+    add_column :spree_shipments, :fosdick_state, :string,  default: 'ready', null: false
+  end
+end

data/lib/fosdick/documents/shipment.rb ADDED

@@ -0,0 +1,89 @@
+module Fosdick
+  module Documents
+    class Shipment
+      def initialize(shipment, config)
+        @shipment = shipment
+        @config   = config
+      end
+      def to_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.UnitycartOrderPost('xml:lang' => 'en-US') {
+            xml.ClientCode(@config['client_code'])
+            xml.Test('Y') if test?
+            xml.TransactionID(SecureRandom.hex(15))
+            xml.Order {
+              xml.ShippingMethod(@shipment['shipping_method'])
+              xml.Subtotal(0)
+              xml.Total(0)
+              xml.ExternalID("#{@shipment['id']}")
+              xml.AdCode(@shipment['adcode'] || @config['adcode'])
+              xml.Prepaid('Y')
+              xml.PaymentType(5)
+              xml.ShipFirstname truncate_name
+              xml.ShipLastname(@shipment['shipping_address']['lastname'])
+              xml.ShipAddress1(@shipment['shipping_address']['address1'])
+              xml.ShipAddress2(@shipment['shipping_address']['address2'])
+              xml.ShipCity(truncate_city)
+              if (@shipment['shipping_address']['country'] != 'US')
+                xml.ShipStateOther(ship_state)
+              else
+                xml.ShipState(ship_state)
+              end
+              xml.ShipZip(@shipment['shipping_address']['zipcode'])
+              xml.ShipCountry(@shipment['shipping_address']['country'])
+              xml.ShipPhone(@shipment['shipping_address']['phone'])
+              xml.Email(@shipment['email'])
+              xml.Code(@shipment['shipping_method_code'])
+              (1..5).each do |i|
+                next unless @shipment.key? "custom#{i}"
+                xml.send("Custom#{i}", @shipment["custom#{i}"])
+              end
+              xml.Items {
+                @shipment['items'].each_with_index do |item, index|
+                  xml.Item {
+                    xml.Inv item['product_id']
+                    xml.Qty item['quantity']
+                    xml.PricePer 0
+                  }
+                end
+              }
+            }
+          }
+        end
+        builder.to_xml
+      end
+      private
+      def truncate_name
+        if @shipment['shipping_address']['firstname'].present?
+          name = @shipment['shipping_address']['firstname']
+          (name.length > 15) ? name.slice(0..15) : name
+        end
+      end
+      def test?
+        @config['test']
+      end
+      def truncate_city
+        city = @shipment['shipping_address']['city']
+        (city.length > 12) ? city.slice(0..12) : city
+      end
+      def ship_state
+        state = @shipment['shipping_address']['state']
+        FOSDICK_STATES_EXCEPTIONS.has_key?(state) ? FOSDICK_STATES_EXCEPTIONS[state] : ModelUN.convert_state_name(state)
+      end
+    end
+  end
+end

data/lib/fosdick/processor.rb ADDED

@@ -0,0 +1,64 @@
+module Fosdick
+  class Processor
+    def self.send_shipment(shipment, config)
+      doc = Fosdick::Documents::Shipment.new(shipment, config).to_xml
+      res = Fosdick::Sender.send_doc(doc, config)
+      log_fosdick_shipment(shipment, res)
+    end
+    def self.receive_shipment(options = {}, end_point = 'shipmentdetail.json' )
+      res = Fosdick::Receiver.new(end_point, options).call_api(FOSDICK_CONFIG)
+      update_shipment_info(res, options)
+    end
+    private
+    def self.log_fosdick_shipment(shipment, fosdick_response)
+      spree_shipment = Spree::Shipment.find_by_number(shipment['id'])
+      if fosdick_response.is_a? String
+        Spree::FosdickShipment.where(fosdick_order_num: fosdick_response).first_or_create(
+            spree_shipment_id:  spree_shipment.id,
+            external_order_num: shipment['id'],
+            state:             'sent')
+        spree_shipment.update(state: 'shipped', fosdick_state: 'success')
+      else
+        fosdick_shipment = Spree::FosdickShipment.create(
+            spree_shipment_id:  spree_shipment.id,
+            external_order_num: shipment['id'],
+            state:              'exception')
+        Array(fosdick_response[:errors]).map {|exception| ExceptionLogger.new.log(fosdick_response[:code], exception.join(' - '), fosdick_shipment.id)}
+      end
+      spree_shipment.increment!(:send_atempt)
+    end
+    def self.update_shipment_info(fosdick_response, options)
+      shipment         = Spree::Shipment.find_by_number(options[:external_order_num])
+      fosdick_shipment = Spree::FosdickShipment.where(external_order_num: options[:external_order_num], spree_shipment_id: shipment.id).first_or_create
+      if fosdick_response.is_a? Array
+        fosdick_response.each do |fos_shipment|
+          trackings = []
+          ship_date = fos_shipment.has_key?('ship_date') ? fos_shipment['ship_date'].to_date : nil
+          fos_shipment['trackings'].each {|tracking| trackings << tracking['tracking_num'] unless trackings.include?(tracking['tracking_num']) }
+          fosdick_shipment.update(tracking_number: trackings, ship_date: ship_date, fosdick_order_num: fos_shipment['fosdick_order_num'])
+          fosdick_shipment.update(state: 'shipped') unless ship_date.nil?
+          shipment.update(shipped_at: ship_date, state: 'shipped', tracking: trackings.join(', ')) if shipment.present?
+          shipment.order.update(shipment_state: 'shipped') if ship_date.present?
+          if fosdick_shipment.confirmation_sent == false && trackings.present?
+            Spree::FosdickShipmentMailer.order_shipped(shipment).deliver
+            fosdick_shipment.update(confirmation_sent: true)
+          end
+        end
+      elsif fosdick_response.is_a? Hash
+        ExceptionLogger.new.log('Error', fosdick_response['error'], fosdick_shipment.id)
+      end
+    end
+  end
+end

data/lib/fosdick/receiver.rb ADDED

@@ -0,0 +1,49 @@
+require 'open-uri'
+require 'net/http'
+module Fosdick
+  class Receiver
+    def initialize(end_point, request_options={})
+      @end_point       = end_point
+      @request_options = request_options
+    end
+    def call_api(fosdick_options)
+      fetch_data(@end_point, fosdick_options)
+    end
+    private
+    def fetch_data(end_point, options={})
+      # required sleep 2 sec for Fosdick API
+      sleep 2
+      response = request(end_point, options)
+      # process only valid to JSON.parse data
+      begin
+        response.nil? ? nil : JSON.parse(response.body)
+      rescue JSON::ParserError
+        nil
+      end
+    end
+    def api_url(end_point)
+      "https://www.customerstatus.com/fosdickapi/#{end_point}?#{ { }.merge(@request_options).to_query }"
+    end
+    def request(end_point, options={})
+      uri = URI(api_url(end_point))
+      Net::HTTP.start(uri.host, uri.port,
+                      use_ssl: uri.scheme == 'https',
+                      verify_mode: OpenSSL::SSL::VERIFY_NONE) do |http|
+        request = Net::HTTP::Get.new uri.request_uri
+        request['Accept'] = 'application/json'
+        request.basic_auth(options['basic_auth']['login'], options['basic_auth']['password']) if options['basic_auth'].present?
+        http.request request
+      end
+    end
+  end
+end