spree_fosdick_integration 0.0.3

data/lib/fosdick/sender.rb

@@ -0,0 +1,39 @@
+module Fosdick
+  class Sender
+    include HTTParty
+    base_uri FOSDICK_CONFIG['ipost_uri']
+    format :xml
+
+    def self.send_doc(doc, config)
+      client = config['client_name']
+
+      begin
+        # required sleep 2 sec for Fosdick Shopping Cart iPost interface
+        sleep 2
+        res  = post("/#{client}/cart/ipost.asp", body: doc)
+      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+             Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError
+
+        raise Fosdick::SendError
+      end
+      return validate_and_return(res)
+    end
+
+    private
+
+    def self.validate_and_return(response)
+      order_response = response['UnitycartOrderResponse']['OrderResponse']
+
+      if order_response['SuccessCode'] == 'True'
+        order_response['OrderNumber']
+      else
+        {
+          code:   order_response['ErrorCode'],
+          errors: order_response['Errors']
+        }
+      end
+    end
+  end
+
+  class SendError < StandardError; end
+end

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

@@ -0,0 +1,32 @@
+module SpreeFosdickIntegration
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def self.source_paths
+        paths = self.superclass.source_paths
+        paths << File.expand_path('../templates', __FILE__)
+        paths.flatten
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_fosdick_integration'
+      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
+
+      def copy_initializer
+        copy_file 'fosdick.yml.template', 'config/fosdick.yml'
+        copy_file 'fosdick.rb', 'config/initializers/fosdick.rb'
+      end
+    end
+  end
+end

data/lib/generators/spree_fosdick_integration/install/templates/fosdick.rb

@@ -0,0 +1,6 @@
+FOSDICK_CONFIG = YAML.load_file("#{Rails.root}/config/fosdick.yml")[Rails.env]
+FOSDICK_STATES_EXCEPTIONS = {
+    'U.S. Armed Forces – Americas' => 'AA',
+    'U.S. Armed Forces – Europe'   => 'AE',
+    'U.S. Armed Forces – Pacific'  => 'AP'
+}

data/lib/generators/spree_fosdick_integration/install/templates/fosdick.yml.template

@@ -0,0 +1,18 @@
+defaults: &defaults
+  test: true
+  ipost_uri: 'https://www.unitycart.com'
+  client_name: test
+  adcode: TEST
+  client_code: ad54LIADFJ2754
+  basic_auth:
+    login: CLIENTTEST
+    password: TESTPW22415
+
+test:
+  <<: *defaults
+development:
+  <<: *defaults
+staging:
+  <<: *defaults
+production:
+  <<: *defaults

data/lib/spree_fosdick_integration.rb

@@ -0,0 +1,8 @@
+require 'spree_core'
+require 'spree_fosdick_integration/engine'
+
+require 'spree_fosdick_integration/version'
+
+module SpreeFosdickIntegration
+  # Your code goes here...
+end

data/lib/spree_fosdick_integration/engine.rb

@@ -0,0 +1,22 @@
+module SpreeFosdickIntegration
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_fosdick_integration'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # 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_fosdick_integration/factories.rb

@@ -0,0 +1,31 @@
+FactoryGirl.define do
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_fosdick_integration/factories'
+
+  factory :fosdick_shipment, class: Spree::FosdickShipment do
+    shipment
+    fosdick_order_num '5177595188'
+    external_order_num 'H28547338764'
+    tracking_number nil
+    state 'sent'
+    confirmation_sent false
+    ship_date nil
+
+    factory :fosdick_shipment_shipped do
+      fosdick_order_num '00501201556352008'
+      tracking_number ['9261295598944533641919']
+      state 'shipped'
+      confirmation_sent true
+      ship_date {Time.zone.now}
+    end
+  end
+
+  factory :fosdick_exception, class: Spree::FosdickException do
+    fosdick_shipment
+
+    error_code  'Error'
+    message     'Error - Unknown Shipping Method: 0099DEX'
+    state       'error'
+    happened_at {Time.zone.now}
+  end
+end

data/lib/spree_fosdick_integration/version.rb

@@ -0,0 +1,3 @@
+module SpreeFosdickIntegration
+  VERSION = '0.0.3'
+end

data/script/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_abandoned_cart/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/controllers/admin/fosdick_shipments_controller_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::FosdickShipmentsController, type: :controller do
+  describe '#index' do
+    let!(:fosdick_shipment) { create :fosdick_shipment }
+    let!(:admin)            { create :admin_user }
+    before { sign_in(admin) }
+
+    it 'should have 200 response' do
+      get :index, { use_route: SpreeFosdickIntegration }
+
+      expect(response.status).to eq(200)
+      expect(assigns[:fosdick_shipments]).to eq [fosdick_shipment]
+    end
+  end
+end

data/spec/models/spree/fosdick_exception_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe Spree::FosdickException, type: :model do
+  describe 'relationships with other entities' do
+    it { should belong_to(:fosdick_shipment).class_name('Spree::FosdickShipment')}
+  end
+
+  describe 'instance methods' do
+    let(:shipment)          {create :shipment}
+    let(:fosdick_shipment)  {create :fosdick_shipment,  shipment: shipment}
+    let(:fosdick_exception) {create :fosdick_exception, fosdick_shipment: fosdick_shipment}
+
+    it 'should update fosdick state of a shipment after creation' do
+      expect(fosdick_exception.shipment.fosdick_state).to eq 'exception'
+    end
+
+    it 'should return shipment for current fosdick exception' do
+      expect(fosdick_exception.shipment).to eq shipment
+    end
+  end
+end

data/spec/models/spree/fosdick_shipment_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe Spree::FosdickShipment, type: :model do
+  describe 'relationships with other entities' do
+    it { should belong_to(:shipment).class_name('Spree::Shipment')}
+    it { should have_many(:fosdick_exceptions)}
+    it { should serialize(:tracking_number)   }
+  end
+end

data/spec/models/spree/shipment_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Shipment, type: :model do
+  describe 'relationships with other entities' do
+    it { should have_one(:fosdick_shipment)}
+  end
+
+  describe 'class methods' do
+    let!(:shipment) { create :shipment, shipped_at: nil, state: 'ready', send_atempt: 0 }
+    let!(:result)   { JSON.parse(
+      { 'id'=>'H58716774464',
+        'order_id'=>'R547700419',
+        'email'=>'georgiana@armstrong.co.uk',
+        'cost'=>100.0,
+        'status'=>'ready',
+        'stock_location'=>'NY Warehouse',
+        'shipping_method'=>nil,
+        'tracking'=>'U10000',
+        'placed_on'=>'',
+        'shipped_at'=>nil,
+        'totals'=>
+          { 'item'=>'$0.00',
+            'adjustment'=>'$0.00',
+            'tax'=>'$0.00',
+            'shipping'=>'$0.00',
+            'payment'=>'0.0',
+            'order'=>'$0.00'},
+        'updated_at'=>'2015-11-13T13:18:31Z',
+        'channel'=>'spree',
+        'items'=>[],
+        'shipping_method_code'=>'UPS_GROUND',
+        'billing_address'=>
+          { 'firstname'=>'John',
+            'lastname'=>'Doe',
+            'address1'=>'10 Lovely Street',
+            'address2'=>'Northwest',
+            'zipcode'=>'35005',
+            'city'=>'Herndon',
+            'state'=>'AL',
+            'country'=>'US',
+            'phone'=>'555-555-0199'},
+        'shipping_address'=>nil}.to_json) }
+
+    before { allow(ActiveModel::ArraySerializer).to receive(:new).and_return([result]) }
+
+    it 'should perform shipments to fosdick' do
+      expect(Spree::Shipment.perform_fosdick_shipments).to eq [result]
+    end
+  end
+end

data/spec/services/exception_logger_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+RSpec.describe ExceptionLogger, type: :services do
+  let!(:fosdick_shipment) { create :fosdick_shipment }
+
+  it 'should log exceptions' do
+    ExceptionLogger.new.log('Error', 'Error - Unknown Shipping Method: 0099DEX', fosdick_shipment.id)
+
+    expect(Spree::FosdickException.last.fosdick_shipment).to eq fosdick_shipment
+  end
+end

data/spec/services/fosdick/processor_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+RSpec.describe Fosdick::Processor, type: :services do
+  before { stub_const 'FOSDICK_CONFIG', {
+      'test'        =>true,
+      'ipost_uri'   =>'https://www.unitycart.com',
+      'client_name' =>'test',
+      'adcode'      =>'TEST',
+      'client_code' =>'TEST_CODE',
+      'basic_auth'  =>{
+          'login'   =>'TESTLOG',
+          'password'=>'password'}
+  }}
+
+  let(:config) { FOSDICK_CONFIG }
+  let!(:order_ready_to_ship) {create :order_ready_to_ship}
+
+  describe 'sender service logic' do
+    let(:doc) {Fosdick::Documents::Shipment.new(Spree::Shipment.perform_fosdick_shipments.first, config).to_xml}
+    let(:response) { '<UnitycartOrderResponse xml:lang="en-US">
+                      <OrderResponse ExternalID="YourID">
+                        <SuccessCode>True</SuccessCode>
+                        <OrderNumber>2679987865</OrderNumber>
+                      </OrderResponse>
+                    </UnitycartOrderResponse>'}
+
+    before {
+      stub_request(:post, "https://www.unitycart.com/test/cart/ipost.asp").
+          with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+          to_return(:status => 200, :body => response, :headers => {})
+    }
+
+    it 'should send new shipment to fosdick' do
+      eligible_shipment = Spree::Shipment.perform_fosdick_shipments.last
+
+      expect{Fosdick::Processor.send_shipment(eligible_shipment, config)}.to change{Spree::FosdickShipment.count}.from(0).to(1)
+      expect(Spree::FosdickShipment.last.external_order_num).to eq order_ready_to_ship.shipments.first.number
+      expect(Spree::FosdickShipment.last.fosdick_order_num).to eq '2679987865'
+      expect(Spree::FosdickShipment.last.state).to eq 'sent'
+      expect(Spree::FosdickShipment.last.tracking_number).to eq nil
+      expect(Spree::FosdickShipment.last.ship_date).to eq nil
+
+      expect(Spree::Shipment.last.state).to eq 'shipped'
+      expect(Spree::Shipment.last.fosdick_state).to eq 'success'
+    end
+  end
+
+  describe 'receiver service logic' do
+    let!(:fosdick_shipment) {create :fosdick_shipment, external_order_num: 'H0011001',
+                                                       spree_shipment_id: order_ready_to_ship.shipments.last.id,
+                                                       tracking_number: nil}
+    let(:response) { '[
+    {
+      "fosdick_order_num": "00101201506460001",
+      "external_order_num": "H0011001",
+      "ship_date": "2015-02-06",
+      "trackings": [
+        {
+          "tracking_num": "9274899998944522337",
+          "carrier_code": "92",
+          "carrier_name": "FEDEX SMART POST"
+        },
+        {
+          "tracking_num": "9274899998944599999",
+          "carrier_code": "92",
+          "carrier_name": "FEDEX SMART POST"
+        }
+      ]
+    }]'}
+
+    before {
+      stub_request(:get, "https://www.customerstatus.com/fosdickapi/shipmentdetail.json?external_order_num=#{fosdick_shipment.external_order_num}").
+          with(:headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+          to_return(:status => 200, :body => response, :headers => {})
+    }
+
+    before { Spree::Shipment.last.update_column(:number, 'H0011001')}
+    before { ActionMailer::Base.deliveries.clear }
+
+    it 'should receive shipment details from fosdick' do
+      Fosdick::Processor.receive_shipment({external_order_num: 'H0011001'}, 'shipmentdetail.json' )
+
+      expect(Spree::FosdickShipment.last.tracking_number).to eq (['9274899998944522337', '9274899998944599999'])
+      expect(Spree::FosdickShipment.last.confirmation_sent).to eq true
+      expect(Spree::FosdickShipment.last.ship_date).to eq '2015-02-06 00:00:00'
+      expect(Spree::FosdickShipment.last.fosdick_order_num).to eq '00101201506460001'
+    end
+
+    it 'should notify user by email that order shipped' do
+
+      expect{Fosdick::Processor.receive_shipment({external_order_num: 'H0011001'}, 'shipmentdetail.json' )}.to change{ActionMailer::Base.deliveries.count}.from(0).to(1)
+    end
+  end
+end

data/spec/services/fosdick/receiver_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'json'
+
+RSpec.describe Fosdick::Receiver, type: :services do
+  before { stub_const 'FOSDICK_CONFIG', {
+      'test'        =>true,
+      'ipost_uri'   =>'https://www.unitycart.com',
+      'client_name' =>'test',
+      'adcode'      =>'TEST',
+      'client_code' =>'TEST_CODE',
+      'basic_auth'  =>{
+          'login'   =>'TESTLOG',
+          'password'=>'password'}
+  }}
+
+  let(:fosdick_shipment) {create :fosdick_shipment}
+  let(:config) { FOSDICK_CONFIG }
+  let(:response) { '[
+    {
+      "fosdick_order_num": "00101201506460001",
+      "external_order_num": "0011001",
+      "ship_date": "2015-02-06",
+      "trackings": [
+        {
+          "tracking_num": "9274899998944522337",
+          "carrier_code": "92",
+          "carrier_name": "FEDEX SMART POST"
+        },
+        {
+          "tracking_num": "9274899998944599999",
+          "carrier_code": "92",
+          "carrier_name": "FEDEX SMART POST"
+        }
+      ]
+    }]'}
+
+  before {
+    stub_request(:get, "https://www.customerstatus.com/fosdickapi/shipmentdetail.json?external_order_num=#{fosdick_shipment.external_order_num}").
+        with(:headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => response, :headers => {})
+  }
+  it {expect(Fosdick::Receiver.new('shipmentdetail.json', {external_order_num: fosdick_shipment.external_order_num}).call_api(config)).to eq JSON.parse(response)}
+end

data/spec/services/fosdick/sender_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+RSpec.describe Fosdick::Sender, type: :services do
+  before { stub_const 'FOSDICK_CONFIG', {
+    'test'        =>true,
+    'ipost_uri'   =>'https://www.unitycart.com',
+    'client_name' =>'test',
+    'adcode'      =>'TEST',
+    'client_code' =>'TEST_CODE',
+    'basic_auth'  =>{
+                      'login'   =>'TESTLOG',
+                      'password'=>'password'}
+    }}
+
+  let!(:order_ready_to_ship) {create :order_ready_to_ship}
+
+  let(:config) { FOSDICK_CONFIG }
+  let(:doc) {Fosdick::Documents::Shipment.new(Spree::Shipment.perform_fosdick_shipments.first, config).to_xml}
+  let(:response) { '<UnitycartOrderResponse xml:lang="en-US">
+                      <OrderResponse ExternalID="YourID">
+                        <SuccessCode>True</SuccessCode>
+                        <OrderNumber>2679987865</OrderNumber>
+                      </OrderResponse>
+                    </UnitycartOrderResponse>'}
+
+  before {
+    stub_request(:post, "https://www.unitycart.com/test/cart/ipost.asp").
+      with(:body    => doc,
+           :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+      to_return(:status => 200, :body => response, :headers => {})
+  }
+
+  it {expect(Fosdick::Sender.send_doc(doc, config)).to eq '2679987865'}
+end