solidus_signifyd 1.0.1 → 1.1.0

data/spec/models/spree/order_spec.rb

@@ -13,7 +13,7 @@ describe Spree::Order, :type => :model do
     subject { order.is_risky? }
 
     context "no signifyd_score" do
-      it { should eq false }
+      it { is_expected.to eq false }
     end
 
     context "signifyd_score present" do
@@ -21,31 +21,58 @@ describe Spree::Order, :type => :model do
 
       context "approved" do
         before { SpreeSignifyd.approve(order: order) }
-        it { should eq false }
+        it { is_expected.to eq false }
       end
 
       context "not approved" do
-        it { should eq true }
+        it { is_expected.to eq true }
       end
     end
   end
 
   describe "transition to complete" do
     let(:order) { create(:order_with_line_items, state: 'confirm') }
-    let!(:payment) { create(:payment, amount: order.total, order: order ) }
 
-    it "calls #create_signifyd_case" do
-      expect(SpreeSignifyd).to receive(:create_case).with(order_number: order.number)
-      order.complete!
+    shared_examples "an order we send to signifyd" do
+      it "creates a new SIGNIFYD case" do
+        expect(SpreeSignifyd).to receive(:create_case).with(order_number: order.number)
+        order.complete!
+      end
     end
 
-    context "the order is already approved" do # e.g. unreturned exchanges are automatically approved
-      it "does not create a case" do
-        order.contents.approve(user: Spree.user_class.first)
+    shared_examples "an order we DO NOT send to signifyd" do
+      it "does not create a new SIGNIFYD case" do
         expect(SpreeSignifyd).not_to receive(:create_case)
         order.complete!
       end
     end
-  end
 
+    context "paid with store credit only" do
+      let!(:payment) { create(:store_credit_payment, amount: order.total, order: order ) }
+
+      it_behaves_like "an order we send to signifyd"
+
+      context "don't send store credit orders to SIGNIFYD" do
+        before { SpreeSignifyd::Config[:exclude_store_credit_orders] = true }
+
+        it_behaves_like "an order we DO NOT send to signifyd"
+
+        it "is immediately approved" do
+          expect{ order.complete! }.to change{ order.approved? }.from(false).to(true)
+        end
+      end
+    end
+
+    context "paid with cash" do
+      let!(:payment) { create(:payment, amount: order.total, order: order ) }
+
+      it_behaves_like "an order we send to signifyd"
+
+      context "the order is already approved" do # e.g. unreturned exchanges are automatically approved
+        before { order.contents.approve(user: Spree.user_class.first) }
+
+        it_behaves_like "an order we DO NOT send to signifyd"
+      end
+    end
+  end
 end

data/spec/models/spree/shipment_spec.rb

@@ -5,52 +5,50 @@ describe Spree::Shipment, :type => :model do
   let(:shipment) { create(:shipment) }
   subject { shipment.determine_state(shipment.order) }
 
-  describe "#determine_state_with_signifyd" do
-
-    context "with a risky order" do
-      before { shipment.order.stub(:is_risky?).and_return(true) }
-
-      context "the order is not approved" do
-        it "returns pending" do
-          shipment.order.stub(:approved?).and_return(false)
-          subject.should eq "pending"
-        end
+  describe "#determine_state" do
+    context "with a canceled order" do
+      before do
+        shipment.order.update(state: 'canceled')
+        shipment.update(state: 'canceled')
       end
 
-      context "the order is approved" do
-        it "defaults to existing behavior" do
-          shipment.order.stub(:approved?).and_return(true)
-          shipment.should_receive(:determine_state).with(shipment.order)
-          subject
-        end
+      it "canceled shipments remain canceled" do
+        expect(subject).to eq "canceled"
       end
     end
 
-    context "without a risky order" do
-      before { shipment.order.stub(:is_risky?).and_return(false) }
+    context "with an approved order" do
+      before { shipment.order.contents.approve(name: 'test approver') }
 
-      it "defaults to existing behavior" do
-        shipment.should_receive(:determine_state).with(shipment.order)
-        subject
+      it "pending shipments remain pending" do
+        expect(subject).to eq "pending"
       end
-    end
 
-    context "shipment state" do
-      [:shipped, :ready].each do |state|
-        context "the shipment is #{state}" do
-          before { shipment.update_columns(state: state) }
-          it "defaults to existing behavior" do
-            shipment.should_receive(:determine_state).with(shipment.order)
-            subject
+      describe "regular Solidus behaviour" do
+        context "order cannot ship" do
+          before { allow(shipment.order).to receive_messages can_ship?: false }
+
+          it 'returns pending' do
+            expect(subject).to eq 'pending'
           end
         end
-      end
 
-      [:pending, :canceled].each do |state|
-        context "the shipment is #{state}" do
-          before { shipment.update_columns(state: state) }
-          it "is pending" do
-            subject.should eq "pending"
+        context "order can ship" do
+          before { allow(shipment.order).to receive_messages can_ship?: true }
+
+          it 'returns shipped when already shipped' do
+            allow(shipment).to receive_messages state: 'shipped'
+            expect(subject).to eq 'shipped'
+          end
+
+          it 'returns pending when unpaid' do
+            allow(shipment.order).to receive_messages paid?: false
+            expect(subject).to eq 'pending'
+          end
+
+          it 'returns ready when paid' do
+            allow(shipment.order).to receive_messages paid?: true
+            expect(subject).to eq 'ready'
           end
         end
       end

data/spec/serializers/spree_signifyd/billing_address_serializer.rb

@@ -6,7 +6,7 @@ module SpreeSignifyd
     let(:serialized_address) { JSON.parse(BillingAddressSerializer.new(bill_address).to_json) }
 
     context "node values" do
-      it { serialized_address.should include 'billingAddress' }
+      it { expect(serialized_address).to include 'billingAddress' }
     end
   end
 end

data/spec/serializers/spree_signifyd/credit_card_serializer_spec.rb

@@ -15,11 +15,11 @@ module SpreeSignifyd
       end
 
       it "expiryMonth" do
-        expect(serialized_credit_card['expiryMonth']).to eq credit_card.month
+        expect(serialized_credit_card['expiryMonth']).to eq credit_card.month.to_i
       end
 
       it "expiryYear" do
-        expect(serialized_credit_card['expiryYear']).to eq credit_card.year
+        expect(serialized_credit_card['expiryYear']).to eq credit_card.year.to_i
       end
     end
   end

data/spec/serializers/spree_signifyd/delivery_address_serializer_spec.rb

@@ -6,8 +6,8 @@ module SpreeSignifyd
     let(:serialized_address) { JSON.parse(DeliveryAddressSerializer.new(delivery_address).to_json) }
 
     context "node values" do
-      it { serialized_address.should include 'deliveryAddress' }
-      it { serialized_address['fullName'].should eq delivery_address.full_name }
+      it { expect(serialized_address).to include 'deliveryAddress' }
+      it { expect(serialized_address['fullName']).to eq delivery_address.full_name }
     end
   end
 end

data/spec/serializers/spree_signifyd/order_serializer_spec.rb

@@ -2,54 +2,95 @@ require 'spec_helper'
 
 module SpreeSignifyd
   describe OrderSerializer do
-    let(:order) { create(:shipped_order, line_items_count: 1) }
+    let(:order) { create :shipped_order,
+      line_items_count: 1,
+      last_ip_address: "127.0.0.1"
+    }
     let(:line_item) { order.line_items.first }
     let(:serialized_order) { JSON.parse(OrderSerializer.new(order).to_json) }
 
+    describe 'document format' do
+      before do
+        # we can't pass payments into the :shipped_order factory
+        order.payments.last.update(avs_response: "M", cvv_response_code: "M")
+      end
+
+      it 'matches the SIGNIFYD V2 api' do
+        expect(serialized_order).to match_schema('v2/case.json')
+      end
+    end
+
     describe "node values" do
       context "purchase" do
 
         let(:purchase) { serialized_order['purchase'] }
 
-        it { purchase['browserIpAddress'].should eq order.last_ip_address }
-        it { purchase['orderId'].should eq order.number }
-        it { purchase['createdAt'].should eq order.completed_at.utc.iso8601 }
-        it { purchase['currency'].should eq order.currency }
-        it { purchase['totalPrice'].should eq order.total.to_s }
+        it { expect(purchase['browserIpAddress']).to eq order.last_ip_address }
+        it { expect(purchase['orderId']).to eq order.number }
+        it { expect(purchase['createdAt']).to eq order.completed_at.utc.iso8601 }
+        it { expect(purchase['currency']).to eq order.currency }
+        it { expect(purchase['totalPrice']).to eq order.total }
 
         context "with a payment" do
-          it { purchase['avsResponseCode'].should eq order.payments.last.avs_response }
-          it { purchase['cvvResponseCode'].should eq order.payments.last.cvv_response_code }
+          it { expect(purchase['avsResponseCode']).to eq order.payments.last.avs_response.to_s }
+          it { expect(purchase['cvvResponseCode']).to eq order.payments.last.cvv_response_code.to_s }
+
+          context "when the payment is a paypal payment" do
+            before do
+              order.payments.first.source.update({
+                cc_type: "paypal"
+              })
+            end
+
+            it "includes a paymentGateway specification for signifyd" do
+              expect(purchase['paymentGateway']).to eql("paypal_account")
+            end
+          end
+
+          context "when the payment is not a paypal payment" do
+            it "does not include a paymentGateway key" do
+              expect(purchase['paymentGateway']).to eql(nil)
+            end
+          end
+        end
+
+        context "paid with store credit" do
+          before do
+            create(:store_credit_payment, amount: order.total, order: order)
+            order.payments.reload
+          end
+
+          it { expect(serialized_order["card"]).to eq({}) }
         end
 
         context "without a payment" do
           let(:order) { create(:completed_order_with_totals) }
 
-          it { purchase['avsResponseCode'].should be nil }
-          it { purchase['cvvResponseCode'].should be nil }
+          it { expect(purchase['avsResponseCode']).to eq "" }
+          it { expect(purchase['cvvResponseCode']).to eq "" }
         end
 
         it "contains a products node" do
-          purchase['products'].should eq [ JSON.parse(SpreeSignifyd::LineItemSerializer.new(line_item).to_json) ]
+          expect(purchase['products']).to eq [ JSON.parse(SpreeSignifyd::LineItemSerializer.new(line_item).to_json) ]
         end
       end
 
       context "userAccount" do
-        it { serialized_order.should include 'userAccount' }
+        it { expect(serialized_order).to include 'userAccount' }
       end
 
       context "recipient" do
-        it { serialized_order.should include 'recipient' }
-        it { serialized_order["recipient"]["confirmationEmail"].should eq order.email }
+        it { expect(serialized_order).to include 'recipient' }
+        it { expect(serialized_order["recipient"]["confirmationEmail"]).to eq order.email }
       end
 
       context "card" do
-        it { serialized_order.should include 'card' }
+        it { expect(serialized_order).to include 'card' }
 
         context "credit card payment" do
           let!(:payment) { create(:payment, order: order) }
 
-          it { serialized_order["card"].should include 'billingAddress'}
+          it { expect(serialized_order["card"]).to include 'billingAddress'}
         end
 
         context "no payment source" do
@@ -62,7 +103,7 @@ module SpreeSignifyd
 
         context "non credit card payment" do
           it "contains no data" do
-            Spree::CreditCard.any_instance.stub(:instance_of?).and_return(false)
+            allow_any_instance_of(Spree::CreditCard).to receive(:instance_of?).and_return(false)
             expect(serialized_order["card"]).to eq({})
           end
         end

data/spec/serializers/spree_signifyd/user_serializer_spec.rb

@@ -9,6 +9,10 @@ module SpreeSignifyd
 
     let(:serialized_user) { JSON.parse(UserSerializer.new(user).to_json) }
 
+    before do
+      old_complete_order.update_attributes(completed_at: 30.days.ago)
+    end
+
     context "node values" do
       it "emailAddress" do
         expect(serialized_user['emailAddress']).to eq user.email
@@ -18,6 +22,10 @@ module SpreeSignifyd
        expect(serialized_user['username']).to eq user.email
       end
 
+      it "phone" do
+        expect(serialized_user['phone']).to eq new_complete_order.ship_address.phone
+      end
+
       it "createdDate" do
        expect(serialized_user['createdDate']).to eq user.created_at.utc.iso8601
       end
@@ -46,7 +54,7 @@ module SpreeSignifyd
       end
 
       it "aggregateOrderDollars" do
-        expect(serialized_user['aggregateOrderDollars']).to eq (old_complete_order.total + new_complete_order.total).to_s
+        expect(serialized_user['aggregateOrderDollars']).to eq (old_complete_order.total + new_complete_order.total)
       end
     end
   end

data/spec/spec_helper.rb

@@ -38,6 +38,7 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.use_transactional_fixtures = false
 
+  config.include RSpec::Rails::Matchers
   config.include FactoryGirl::Syntax::Methods
 
   # Ensure Suite is set to use transactions for speed.
@@ -46,10 +47,16 @@ RSpec.configure do |config|
     DatabaseCleaner.clean_with :truncation
   end
 
+  # allow us to test various preference settings without cross contamination
+  config.before :each do
+    SpreeSignifyd::Config.reset
+  end
+
   # Before each spec check if it is a Javascript test and switch between using database transactions or not where necessary.
   config.before :each do
     DatabaseCleaner.strategy = example.metadata[:js] ? :truncation : :transaction
     DatabaseCleaner.start
+    ActiveJob::Base.queue_adapter = :test
 
     allow(Signifyd::Case).to receive(:create).and_return(
       { code: 201, body: { investigationId: 123 } }

data/spec/support/api_schema_matcher.rb

@@ -0,0 +1,9 @@
+require "json-schema"
+
+RSpec::Matchers.define :match_schema do |schema|
+  match do |candidate|
+    schema_directory = File.expand_path("../schemas",  __FILE__)
+    schema_path = File.join(schema_directory, schema)
+    JSON::Validator.validate!(schema_path, candidate)
+  end
+end

data/spec/support/schemas/v2/case.json

@@ -0,0 +1,305 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "purchase": {
+      "type": "object",
+      "description": "The purchase.",
+      "properties": {
+        "browserIpAddress": {
+          "type": "string",
+          "description": "The IP Address of the browser that was used to make the  This is the IP Address that was used to connect to your site and make the "
+        },
+        "shipments": {
+          "type": "array",
+          "description": "The shipments association with this purchase"
+        },
+        "products": {
+          "type": "array",
+          "description": "The products purchased in the transaction."
+        },
+        "orderId": {
+          "type": "string",
+          "description": "A string uniquely identifying this order."
+        },
+        "createdAt": {
+          "type": "string",
+          "description": "`yyyy-MM-dd'T'HH:mm:ssZ` The date and time when the order was placed, shown on the signifyd console. See the Dates section of these docs for more information about date formats."
+        },
+        "paymentGateway": {
+          "type": "string",
+          "description": "The gateway that processed the transaction. For paypal orders use paypal_account."
+        },
+        "paymentMethod": {
+          "type": "object",
+          "description": "The method the user used to complete the "
+        },
+        "transactionId": {
+          "type": "string",
+          "description": "The unique identifier provided by the payment gateway for this order. If you have provided us with credentials for your payment gateway we can obtain additional details about the order, like AVS and CVV status, from your payment provider."
+        },
+        "currency": {
+          "type": "string",
+          "description": "The currency type of the order, in 3 letter ISO 4217 format. Defaults to USD."
+        },
+        "avsResponseCode": {
+          "type": "string",
+          "description": "The response code from the address verification system (AVS). Accepted codes: http://www.emsecommerce.net/avs_cvv2_response_codes.htm"
+        },
+        "cvvResponseCode": {
+          "type": "string",
+          "description": "The response code from the card verification value (CVV) check. Accepted codes listed on above link."
+        },
+        "orderChannel": {
+          "type": "string",
+          "description": "The method used by the buyer to place the order. Either WEB or PHONE."
+        },
+        "receivedBy": {
+          "type": "string",
+          "description": "If the order was was taken by a customer service or sales agent, his or her name."
+        },
+        "totalPrice": {
+          "type": "number",
+          "description": "The total price of the order, including shipping price and taxes."
+        }
+      },
+      "required": [
+        "browserIpAddress",
+        "orderId",
+        "createdAt",
+        "avsResponseCode",
+        "cvvResponseCode",
+        "totalPrice"
+      ]
+    },
+    "recipient": {
+      "type": "object",
+      "description": "The person receiving the goods.",
+      "properties": {
+        "fullName": {
+          "type": "string",
+          "description": "The full name of the person receiving the goods. If this item is being shipped, then this field is the person it is being shipping to. Don't assume this name is the same as card.cardHolderName. Only put a value here if the name will actually appear on the shipping label. If this item is digital, then this field will likely be blank."
+        },
+        "confirmationEmail": {
+          "type": "string",
+          "description": "When this purchase was completed, you likely sent a confirmation email or you will be sending a confirmation email to someone once you approve the order. This is the email address to which that confirmation email will be sent."
+        },
+        "confirmationPhone": {
+          "type": "string",
+          "description": "The phone number that you would call if there was something wrong with this order or the phone number that was supplied with the shipping information."
+        },
+        "organization": {
+          "type": "string",
+          "description": "If provided by the buyer, the name of the recipient's company or organization."
+        },
+        "deliveryAddress": {
+          "type": "object",
+          "description": "The address to which the order will be delivered.",
+          "properties": {
+            "streetAddress": {
+              "type": "string",
+              "description": "The street number and street name."
+            },
+            "unit": {
+              "type": "string",
+              "description": "The unit or apartment number."
+            },
+            "city": {
+              "type": "string",
+              "description": "The city name."
+            },
+            "provinceCode": {
+              "type": "string",
+              "description": "The code or abbreviation for the province."
+            },
+            "postalCode string": {
+              "type": "string",
+              "description": "The postal code."
+            },
+            "countryCode": {
+              "type": "string",
+              "description": "The two-letter ISO-3166 country code. If left blank, we will assume US."
+            },
+            "latitude": {
+              "type": "number",
+              "description": "The latitude of the address. Used when address details are not provided. Ignored otherwise."
+            },
+            "longitude": {
+              "type": "number",
+              "description": "The longitude of the address. Used when address details are not provided. Ignored otherwise."
+            }
+          }
+        }
+      },
+      "required": [
+        "fullName",
+        "confirmationEmail",
+        "deliveryAddress"
+      ]
+    },
+    "card": {
+      "type": "object",
+      "properties": {
+        "cardHolderName": {
+          "type": "string",
+          "description": "The full name on the credit card that was charged."
+        },
+        "bin": {
+          "type": "number",
+          "description": "The first six digits of the credit card, the bank identification number, which uniquely identifies the issuer."
+        },
+        "last4": {
+          "type": "string",
+          "description": "The last four digits of the card number."
+        },
+        "expiryMonth": {
+          "type": "number",
+          "description": "MM representation of the expiration month of the card."
+        },
+        "expiryYear": {
+          "type": "number",
+          "description": "yyyy representation of the expiration year of the card."
+        },
+        "billingAddress": {
+          "type": "object",
+          "properties": {
+            "streetAddress": {
+              "type": "string",
+              "description": "The street number and street name."
+            },
+            "unit": {
+              "type": "string",
+              "description": "The unit or apartment number."
+            },
+            "city": {
+              "type": "string",
+              "description": "The city name."
+            },
+            "provinceCode": {
+              "type": "string",
+              "description": "The code or abbreviation for the province."
+            },
+            "postalCode string": {
+              "type": "string",
+              "description": "The postal code."
+            },
+            "countryCode": {
+              "type": "string",
+              "description": "The two-letter ISO-3166 country code. If left blank, we will assume US."
+            },
+            "latitude": {
+              "type": "number",
+              "description": "The latitude of the address. Used when address details are not provided. Ignored otherwise."
+            },
+            "longitude": {
+              "type": "number",
+              "description": "The longitude of the address. Used when address details are not provided. Ignored otherwise."
+            }
+          },
+          "description": "The billing address for the card."
+        }
+      },
+      "required": [
+        "cardHolderName",
+        "billingAddress"
+      ]
+    },
+    "userAccount": {
+      "type": "object",
+      "properties": {
+        "email": {
+          "type": "string",
+          "description": "The primary email address associated with the account."
+        },
+        "username": {
+          "type": "string",
+          "description": "The username associated with the account. Please supply this even if it is the same as the email address."
+        },
+        "phone": {
+          "type": "string",
+          "description": "The phone number association with the account."
+        },
+        "createdDate": {
+          "type": "string",
+          "description": "`yyyy-MM-dd'T'HH:mm:ssZ` The date when the account was created. See the Dates section of these docs for more information about date formats."
+        },
+        "accountNumber": {
+          "type": "string",
+          "description": "Your unique identifier for the account."
+        },
+        "lastOrderId": {
+          "type": "string",
+          "description": "The unique identifier for the last order placed by this account, prior to the current order."
+        },
+        "aggregateOrderCount": {
+          "type": "number",
+          "description": "The total count of orders placed by this account since it was created, including the current order."
+        },
+        "aggregateOrderDollars": {
+          "type": "number",
+          "description": "The total amount spent by this account since it was created, including the current order."
+        },
+        "lastUpdateDate": {
+          "type": "string",
+          "description": "`yyyy-MM-dd'T'HH:mm:ssZ` The last time a change was made to this account other than an order being placed. Examples include changing email addresses or adding a new credit card. See the Dates section of these docs for more information about date formats."
+        }
+      }
+    },
+    "seller": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "The business name of the seller."
+        },
+        "domain": {
+          "type": "string",
+          "description": "The domain of the seller."
+        },
+        "shipFromAddress": {
+          "type": "object",
+          "properties": {
+            "streetAddress": {
+              "type": "string",
+              "description": "The street number and street name."
+            },
+            "unit": {
+              "type": "string",
+              "description": "The unit or apartment number."
+            },
+            "city": {
+              "type": "string",
+              "description": "The city name."
+            },
+            "provinceCode": {
+              "type": "string",
+              "description": "The code or abbreviation for the province."
+            },
+            "postalCode string": {
+              "type": "string",
+              "description": "The postal code."
+            },
+            "countryCode": {
+              "type": "string",
+              "description": "The two-letter ISO-3166 country code. If left blank, we will assume US."
+            },
+            "latitude": {
+              "type": "number",
+              "description": "The latitude of the address. Used when address details are not provided. Ignored otherwise."
+            },
+            "longitude": {
+              "type": "number",
+              "description": "The longitude of the address. Used when address details are not provided. Ignored otherwise."
+            }
+          },
+          "description": "The location from which the seller shipped the order."
+        }
+      }
+    }
+  },
+  "required": [
+    "purchase",
+    "recipient",
+    "card"
+  ]
+}