ship_compliant 0.1.0

data/spec/lib/ship_compliant/channel_details_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe ChannelDetails do
+
+    context "order_channel" do
+      it "gets the order_channel" do
+        subject.order_channel.should == 'order-channel'
+      end
+    end
+
+    context "advertiser_key" do
+      it "gets the advertiser_key" do
+        subject.advertiser_key.should == 'advertiser-key'
+      end
+    end
+    
+    context "advertiser_name" do
+      it "gets the advertiser_name" do
+        subject.advertiser_name.should == 'advertiser-name'
+      end
+    end
+
+    context "meta" do
+      it "gets channel meta" do
+        subject.meta.should == 'channel-meta'
+      end
+    end
+
+    subject do
+      ChannelDetails.new({
+        order_channel: 'order-channel',
+        advertiser_key: 'advertiser-key',
+        advertiser_name: 'advertiser-name',
+        meta: 'channel-meta'
+      })
+    end
+
+  end
+end

data/spec/lib/ship_compliant/check_compliance_result_spec.rb

@@ -0,0 +1,135 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe CheckComplianceResult do
+    it_behaves_like "BaseResult"
+
+    context "compliant?" do
+      it "successed if the salesorder was compliant" do
+        subject.compliant?.should be_true
+      end
+
+      it "fails if the salesorder was not compliant" do
+        result = CheckComplianceResult.new({
+          sales_order: { is_compliant: false }
+        })
+
+        result.compliant?.should be_false
+      end
+    end
+
+    context "recommended_tax_due" do
+      it "gets the tax due as a float" do
+        subject.recommended_tax_due.should == 1372.34
+      end
+    end
+
+    context "shipment_sales_tax_rates" do
+      it "returns an array of sales tax rates" do
+        subject.shipment_sales_tax_rates.should == [
+          {
+            :@shipment_key => 'ORDER-KEY',
+            freight_sales_tax_rate: {
+              :@sales_tax_due => 100.5,
+              :@sales_tax_rate => 10.34
+            },
+            product_sales_tax_rates: {
+              product_sales_tax_rate: {
+                :@brand_key => 'ABC',
+                :@product_key => '123',
+                :@sales_tax_due => 12.332,
+                :@sales_tax_rate => 0.844
+              }
+            }
+          }
+        ]
+      end
+    end
+
+    context "taxes_for_shipment" do
+      it "finds taxes from shipment_key" do
+        subject.taxes_for_shipment('ORDER-KEY').should == ShipmentSalesTaxRate.new(
+          shipment_key = 'ORDER-KEY',
+          freight = FreightSalesTaxRate.new({ sales_tax_due: 100.5, sales_tax_rate: 10.34 }),
+          products = [
+            ProductSalesTaxRate.new({ brand_key: 'ABC', product_key: '123', sales_tax_due: 12.332, sales_tax_rate: 0.844 })
+          ]
+        )
+      end
+    end
+
+    context "shipment_compliance_rules" do
+      it "returns compliance rules as an array" do
+        subject.shipment_compliance_rules.should == [
+          {
+            is_compliant: true,
+            key: 'ORDER-KEY'
+          }
+        ]
+      end
+    end
+
+    context "compliance_rules_for_shipment" do
+      it "finds compliance rules for shipment" do
+        subject.compliance_rules_for_shipment('ORDER-KEY').should == ShipmentCompliance.new({
+          is_compliant: true,
+          key: 'ORDER-KEY'
+        })
+      end
+    end
+
+    context "address_validation_result" do
+      it "gets the address validation result" do
+        subject.address_validation_result.should == 'AddressValidated'
+      end
+    end
+
+    context "suggested_address" do
+      it "returns the suggested address" do
+        subject.suggested_address.should == SuggestedAddress.new({
+          city: 'Bluebell',
+          state: 'Ice Cream'
+        })
+      end
+    end
+
+    subject do
+      CheckComplianceResult.new({
+        sales_order: {
+          is_compliant: true,
+          sales_tax_rates: {
+            recommended_sales_tax_due: '1372.34',
+            shipment_sales_tax_rates: {
+              shipment_sales_tax_rate: {
+                :@shipment_key => 'ORDER-KEY',
+                freight_sales_tax_rate: {
+                  :@sales_tax_due => 100.5,
+                  :@sales_tax_rate => 10.34
+                },
+                product_sales_tax_rates: {
+                  product_sales_tax_rate: {
+                    :@brand_key => 'ABC',
+                    :@product_key => '123',
+                    :@sales_tax_due => 12.332,
+                    :@sales_tax_rate => 0.844
+                  }
+                }
+              }
+            }
+          },
+          shipments: {
+            shipment_compliance_response: {
+              is_compliant: true,
+              key: 'ORDER-KEY'
+            }
+          }
+        },
+        address_validation_result: 'AddressValidated',
+        suggested_address: {
+          city: 'Bluebell',
+          state: 'Ice Cream'
+        }
+      })
+    end
+  end
+end

data/spec/lib/ship_compliant/check_compliance_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe CheckCompliance do
+
+    before { savon.mock! }
+    after { savon.unmock! }
+
+    context "of_sales_order" do
+      let(:message) do
+        {
+          'Request' => {
+            'Security' => {
+              'PartnerKey' => 'abc-123',
+              'Username' => 'bob@example.com',
+              'Password' => 'secret'
+            },
+            'IncludeSalesTax' => true,
+            'CustomerKey' => 'CUST-1',
+            'FooBar' => {
+              'Baz' => false
+            }
+          }
+        }
+      end
+      let(:response) { File.read('spec/fixtures/check_compliance.xml') }
+
+      it "queries the client with product information" do
+        savon.expects(:check_compliance_of_sales_order_with_address_validation)
+          .with(message: message).returns(response)
+
+        result = CheckCompliance.of_sales_order({
+          include_sales_tax: true,
+          customer_key: 'CUST-1',
+          foo_bar: { baz: false }
+        })
+
+        result.should be_kind_of(CheckComplianceResult)
+      end
+    end
+
+  end
+end

data/spec/lib/ship_compliant/client_spec.rb

@@ -0,0 +1,73 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe Client do
+
+    it "inherits from Savon::Client" do
+      ShipCompliant.client.should be_kind_of(Savon::Client)
+    end
+
+    it "uses wsdl from configuration" do
+      ShipCompliant.configure do |c|
+        c.wsdl = 'http://example.com'
+      end
+
+      ShipCompliant.client.globals[:wsdl].should == 'http://example.com'
+    end
+
+    it "uses log value from configuration" do
+      # configuration is defined in spec_helper.rb
+      ShipCompliant.client.globals[:log].should == false
+    end
+
+    context "call" do
+      before { savon.mock! }
+      after { savon.unmock! }
+
+      it "simplifies the actual api" do
+        message = {
+          'Request' =>  {
+            'Security' => ShipCompliant.configuration.credentials,
+            'InventoryType' => 'All',
+            'FulfillmentLocation' => 'WineShipping'
+          }
+        }
+        savon.expects(:search_sales_orders)
+          .with(message: message)
+          .returns(File.read('spec/fixtures/search_sales_orders.xml'))
+
+        ShipCompliant.client.call(:search_sales_orders, {
+            'InventoryType' => 'All',
+            'FulfillmentLocation' => 'WineShipping'
+        })
+      end
+
+      it "the response's result directly" do
+        ShipCompliant.client.stub(:savon_call) do
+          stub(to_hash: {
+            a_method_response: {
+              a_method_result: {
+                response_status: 'Success'
+              }
+            }
+          })
+        end
+
+        result = ShipCompliant.client.call(:a_method, {})
+        result.should == {
+          response_status: 'Success'
+        }
+      end
+    end
+
+    context "wsdl=" do
+      it "changes the default wsdl" do
+        ShipCompliant.configuration = nil
+        ShipCompliant.client.globals[:wsdl].should == 'https://ws-dev.shipcompliant.com/services/1.2/coreservice.asmx?WSDL'
+        ShipCompliant.wsdl = 'http://ws.example.com?WSDL'
+        ShipCompliant.client.globals[:wsdl].should == 'http://ws.example.com?WSDL'
+      end
+    end
+
+  end
+end

data/spec/lib/ship_compliant/commit_sales_order_result_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe CommitSalesOrderResult do
+    it_behaves_like "BaseResult"
+
+    context "shipments" do
+      it "returns the shipments as an array" do
+        subject.shipments.should == [
+          { key: 'SHIPMENT-KEY', is_committed: true }
+        ]
+      end
+    end
+
+    context "committed_shipments" do
+      it "returns the shipment keys for committed shipments" do
+        subject.committed_shipments.should == ['SHIPMENT-KEY']
+      end
+    end
+
+    subject do
+      CommitSalesOrderResult.new({
+        shipments: {
+          shipment_commit_response: {
+            key: "SHIPMENT-KEY",
+            is_committed: true
+          }
+        }
+      })
+    end
+  end
+end

data/spec/lib/ship_compliant/commit_sales_order_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe CommitSalesOrder do
+
+    before { savon.mock! }
+    after { savon.unmock! }
+
+    it "commits a sales order" do
+      message = {
+        'Request' => {
+          'Security' => {
+            'PartnerKey' => 'abc-123',
+            'Username' => 'bob@example.com',
+            'Password' => 'secret'
+          },
+          'CommitOptions' => 'AllShipments',
+          'Payments' => nil,
+          'SalesTaxCollected' => 0,
+          'SalesOrderKey' => 'ORDER-KEY'
+        }
+      }
+
+      savon.expects(:commit_sales_order)
+        .with(message: message)
+        .returns(File.read('spec/fixtures/void_order_success.xml'))
+        
+      result = ShipCompliant::CommitSalesOrder.call({
+        commit_options: 'AllShipments',
+        payments: nil,
+        sales_tax_collected: 0,
+        sales_order_key: 'ORDER-KEY'
+      })
+
+      result.should be_kind_of(CommitSalesOrderResult)
+    end
+  end
+end

data/spec/lib/ship_compliant/compliance_rule_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe ComplianceRule do
+
+    context "compliance_description" do
+      it "gets the description" do
+        subject.compliance_description.should == 'Howdy Stranger'
+      end
+    end
+
+    context "rule_description" do
+      it "gets the rule" do
+        subject.rule_description.should == 'Must say hi to people you do not know.'
+      end
+    end
+
+    context "compliant?" do
+      it "check this rule passed" do
+        subject.compliant?.should be_true
+      end
+    end
+
+    context "license_relationship" do
+      it "gets the relationship" do
+        subject.license_relationship.should == 'StrangerToFriend'
+      end
+    end
+
+    context "rule_type" do
+      it "gets the rule type" do
+        subject.rule_type.should == 'BeCourteous'
+      end
+    end
+
+    subject do
+      ComplianceRule.new(
+        compliance_description: 'Howdy Stranger',
+        is_compliant: true,
+        license_relationship: 'StrangerToFriend',
+        rule_description: 'Must say hi to people you do not know.',
+        rule_type: 'BeCourteous'
+      )
+    end
+
+  end
+end

data/spec/lib/ship_compliant/configuration_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe Configuration do
+
+    before do
+      ShipCompliant.configuration = nil
+      ShipCompliant.configure do |c|
+        c.partner_key = 'abc-123'
+        c.username = 'bob@example.com'
+        c.password = 'secret'
+      end
+    end
+    
+    it "stores user credentials" do
+      ShipCompliant.configuration.partner_key.should == 'abc-123'
+      ShipCompliant.configuration.username.should == 'bob@example.com'
+      ShipCompliant.configuration.password.should == 'secret'
+    end
+
+    it "creates authentication hash" do
+      ShipCompliant.configuration.credentials.should == {
+        'PartnerKey' => 'abc-123',
+        'Username' => 'bob@example.com',
+        'Password' => 'secret'
+      }
+    end
+
+    it "defaults log to true" do
+      ShipCompliant.configuration.log.should == true
+    end
+
+    context "wsdl" do
+      it "defaults to core services" do
+        ShipCompliant.configuration.wsdl.should == 'https://ws-dev.shipcompliant.com/services/1.2/coreservice.asmx?WSDL'
+      end
+
+      it "can be changed" do
+        ShipCompliant.configure do |c|
+          c.wsdl = 'http://example.com'
+        end
+        ShipCompliant.configuration.wsdl.should == 'http://example.com'
+      end
+    end
+
+  end
+end