ship_compliant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f65d2633670d76884e42d644855007e2da8ee22
+  data.tar.gz: 783a260776706a1f4a3aeb1ca9e6584285c4818f
+SHA512:
+  metadata.gz: 0bfe10c93c02e0b4974fe9d6d3048c08169070789449c03dea8ab2b9cb8a94891e18aa77bd8e5ec7b898032c4f89db7602273050fa267a677080c80183e2e243
+  data.tar.gz: 9c94b6613394e17e863323a0bc9455aeacab931556cd5bd9bf4ade86bd5a5c1713175747b1106911372209e9fdf0c9d37f2789373b8fbbdf7470e120e9d15570

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+rvm:
+  #- 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+env: CUCUMBER_FORMAT=progress SHIP_COMPLIANT_KEY=foo SHIP_COMPLIANT_USER=bar SHIP_COMPLIANT_PASS=baz

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ship_compliant.gemspec
+gemspec
+
+gem "savon_spec", group: :test
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Baylor Rae'
+
+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,50 @@
+# ShipCompliant - Ruby API Client
+
+The ShipCompliant gem is an API Client for the [SOAP][soap_wiki] API provided by
+ShipCompliant. This gem has been created for fast implementation and supports
+the 9 main API calls.
+
+[Documentation][documentation_path] | [RDoc][rdoc_path] | [CoreService V1.2][core_service_path]
+
+[![Build Status](https://travis-ci.org/BaylorRae/ship_compliant-ruby.png?branch=master)](https://travis-ci.org/BaylorRae/ship\_compliant-ruby) [![Code Climate](https://codeclimate.com/github/BaylorRae/ship_compliant-ruby.png)](https://codeclimate.com/github/BaylorRae/ship_compliant-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ship_compliant'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Add this to `config/initializers/ship_compliant.rb`
+
+```ruby
+ShipCompliant.configure do |c|
+  c.partner_key = ENV.fetch('SHIP_COMPLIANT_KEY')
+  c.username = ENV.fetch('SHIP_COMPLIANT_USER')
+  c.password = ENV.fetch('SHIP_COMPLIANT_PASS')
+end
+```
+
+## Usage
+
+TODO: Coming soon...
+
+## Contributing
+
+1. Fork it ( http://github.com/BaylorRae/ship_compliant-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[soap_wiki]: http://en.wikipedia.org/wiki/SOAP
+[documentation_path]: http://baylorrae.github.io/ship_compliant-ruby/documentation/
+[rdoc_path]: http://baylorrae.github.io/ship_compliant-ruby/rdoc/
+[core_service_path]: https://shipcompliant.desk.com/customer/portal/articles/1451976-api-coreservice-v1-2?b_id=2759

data/Rakefile

@@ -0,0 +1,47 @@
+require 'bundler/gem_tasks'
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+  t.ruby_opts = "-I./spec -rspec_helper"
+  t.rspec_opts = %w[--format progress]
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new
+
+task default: [:spec, :cucumber]
+
+# SDoc command
+# sdoc --main README.md lib README.md -o pages/rdoc --template=ship_complaint
+require 'sdoc'
+
+class RDoc::Generator::SDoc
+  protected
+  ### Create class tree structure and write it as json
+  def generate_class_tree
+    my_topclasses = %W(SearchSalesOrders VoidSalesOrder AddUpdateProduct CheckCompliance CommitSalesOrder GetInventoryDetails GetSalesOrderExtended AddUpdateBrand)
+
+    debug_msg "Generating class tree"
+    topclasses = @classes.select do |klass|
+      !(!my_topclasses.include?(klass.name) && RDoc::ClassModule === klass.parent)
+    end
+    tree = generate_file_tree + generate_class_tree_level(topclasses)
+    debug_msg "  writing class tree to %s" % TREE_FILE
+    File.open(TREE_FILE, "w", 0644) do |f|
+      f.write('var tree = '); f.write(tree.to_json(:max_nesting => 0))
+    end unless @options.dry_run
+  end
+end
+
+RDoc::Task.new('docs') do |rdoc|
+  rdoc.title = 'ShipCompliant API'
+  rdoc.template = 'ship_complaint'
+  rdoc.options << '--format' << 'sdoc'
+  rdoc.options << '--github'
+
+  rdoc.rdoc_dir = 'pages/rdoc'
+  rdoc.rdoc_files.include('lib/**/*.rb', 'README.md')
+  rdoc.main = 'README.md'
+end

data/cucumber.yml

@@ -0,0 +1,9 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip
+

data/features/add_update_brand.feature

@@ -0,0 +1,20 @@
+Feature: Add Update Brand
+
+  Background:
+    Given I've added my credentials
+
+  Scenario: I add a new brand
+    When I add a new brand
+    Then the brand should have been created
+
+  Scenario: I add a brand that already exists
+    When I add a brand that already exists
+    Then I should get an error for already defined brand
+
+  Scenario: I update a brand that already exists
+    When I update an existing brand
+    Then the brand should have been updated
+
+  Scenario: I ignore an existing brand
+    When I ignore existing brand on update
+    Then the brand should have been updated

data/features/add_update_product.feature

@@ -0,0 +1,24 @@
+Feature: Add Update Product
+
+  Background:
+    Given I've added my credentials
+
+  Scenario: Add new product with missing Brand
+    When I add a new product with invalid brand
+    Then I should get an error message for the missing brand
+
+  Scenario: Add new product
+    When I add a new product
+    Then the product should have been created
+
+  Scenario: Add product that already exists
+    When I add a product that already exists
+    Then I should get an error for already defined product
+
+  Scenario: Update product that already exists
+    When I update a product
+    Then I should get a message that the product was updated
+
+  Scenario: Ignore existing product
+    When I ignore existing product on update
+    Then I should get a message that the product was updated

data/features/check_compliance_of_sales_order_with_address_validations.feature

@@ -0,0 +1,18 @@
+Feature: Check Compliance Of SalesOrder With Address Validation
+
+  Background:
+    Given I've added my credentials
+
+  Scenario: Check compliance with missing product
+    When I check compliance with a missing product
+    Then I should receive a product key error
+
+  Scenario: Check compliance with available product
+    When I check compliance with an available product
+    Then I should receive the sales tax rates
+    And I should receive the shipment compliance results
+    And I should receive the suggested address
+
+  Scenario: Check compliance with non-compliant product
+    When I check compliance with a non-compliant product
+    Then I should receive error messages

data/features/commit_sales_order.feature

@@ -0,0 +1,6 @@
+Feature: Commit Sales Order
+
+  Scenario: I commit a sale with all shipments
+    Given I've added my credentials
+    When I commit a sale with all shipments
+    Then I get a successful commit message

data/features/get_inventory_details.feature

@@ -0,0 +1,7 @@
+Feature: Get Inventory Details
+
+  Scenario: Ask for everything on it
+    Given I've added my credentials
+    When I get inventory details with everthing
+    Then I should be able to get the product information
+    And I should inventory levels for a product

data/features/get_sales_order_extended.feature

@@ -0,0 +1,15 @@
+Feature: Get Sales Order Extended
+
+  Background:
+    Given I've added my credentials
+
+  Scenario: I search for order information
+    When I search for order information
+    Then I should receive shipment compliance statuses
+    And I should receive billing information
+    And I should receive shipment information
+    And I should receive order channel details
+
+  Scenario: I search for an order that doesn't exist
+    When I search for an invalid order
+    Then I should receive an error that the order doesn't exist

data/features/search_sales_orders.feature

@@ -0,0 +1,13 @@
+Feature: Search Sales Orders
+
+  Scenario: I search for orders by purchase date
+    Given I've added my credentials
+    When I search for orders by purchase date
+    Then I should find two orders
+    And I should receive a success status for search
+    And I should have paging cookie information
+
+  Scenario: I have an invalid search
+    Given I've added my credentials
+    When I search with invalid criteria
+    Then I should get an error status for search

data/features/step_definitions/brand_steps.rb

@@ -0,0 +1,73 @@
+When(/^I (create|update|ignore) a (?:new\s)?brand$/) do |action|
+  key = 'HCAS'
+  update_mode = 'ErrorOnExisting'
+
+  case action
+  when 'update'
+    key = 'HCAN'
+    update_mode = 'UpdateExisting'
+  when 'ignore'
+    update_mode = 'IgnoreExisting'
+  end
+
+  @brand_result = ShipCompliant::AddUpdateBrand.brand({
+    key: key,
+    name: 'Hiccups Anonymous',
+    owner: {
+      city: 'Ye Old Brew Port',
+      country: 'US',
+      name: 'John Doe',
+      state: 'LA',
+      street1: '1337 Drunken Ave.',
+      zip: 84742
+    },
+
+    this_brand_is_bottled_by_a_third_party: false,
+    this_brand_is_produced_by_a_third_party: false,
+    this_brand_operates_under_a_trade_name: true,
+    this_brand_was_acquired_from_a_third_party: false
+  }, update_mode: update_mode)
+end
+
+When(/^I add a new brand$/) do
+  VCR.use_cassette('brand_valid') do
+    step "I create a brand"
+  end
+end
+
+When(/^I add a brand that already exists$/) do
+  VCR.use_cassette('brand_already_exists') do
+    step "I create a new brand"
+  end
+end
+
+When(/^I update an existing brand$/) do
+  VCR.use_cassette('brand_update_existing') do
+    step "I update a brand"
+  end
+end
+
+When(/^I ignore existing brand on update$/) do
+  VCR.use_cassette('brand_ignore_existing') do
+    step "I ignore a new brand"
+  end
+end
+
+Then(/^I should get an error for already defined brand$/) do
+  @brand_result.failure?.should be_true
+  @brand_result.errors.length.should == 1
+  error = @brand_result.errors.first
+  
+  error.code.should == 705
+  error.key.should == 'HCAS'
+  error.message.should == 'BrandKey  exists.'
+  error.type.should == 'Validation'
+end
+
+Then(/^the brand should have been updated$/) do
+  @brand_result.success?.should be_true
+end
+
+Then(/^the brand should have been created$/) do
+  @brand_result.success?.should be_true
+end

data/features/step_definitions/commit_sales_order/all_shipments.rb

@@ -0,0 +1,15 @@
+When(/^I commit a sale with all shipments$/) do
+  VCR.use_cassette('commit_salesorder_all_shipments') do
+    @order_commit_result = ShipCompliant::CommitSalesOrder.call({
+      commit_options: 'AllShipments',
+      payments: nil,
+      sales_tax_collected: 0,
+      sales_order_key: '1006932'
+    })
+  end
+end
+
+Then(/^I get a successful commit message$/) do
+  @order_commit_result.success?.should be_true
+  @order_commit_result.committed_shipments.should == ['1']
+end

data/features/step_definitions/compliance_check/available_product_steps.rb

@@ -0,0 +1,175 @@
+When(/^I check compliance with an available product$/) do
+  VCR.use_cassette('compliance_available_product') do
+    @compliance_status = ShipCompliant::CheckCompliance.of_sales_order({
+      address_option: {
+        ignore_street_level_errors: true,
+        reject_if_address_suggested: 'false'
+      },
+      include_sales_tax_rates: true,
+      persist_option: 'Null',
+      sales_order: {
+        bill_to: {
+          city: 'Boulder',
+          company: 'ShipCompliant',
+          country: 'US',
+          date_of_birth: DateTime.new(1987, 8, 6),
+          email: 'emiliy@six88.com',
+          first_name: 'Emily',
+          last_name: 'Sheehan',
+          phone: '303-996-1626',
+          state: 'CO',
+          street1: '1877 Broadway St',
+          street2: 'SUITE 703',
+          zip1: 80304
+        },
+        customer_key: 'd23c963b',
+        discounts: nil,
+        fulfillment_type: 'Daily',
+        order_type: 'Internet',
+        payments: nil,
+        purchase_date: DateTime.new(2014, 3, 12),
+        register_id: 'cf3ee9',
+        sales_order_key: '1006891',
+        sales_tax_collected: 0,
+        shipments: {
+          shipment: {
+            discounts: nil,
+            fulfillment_house: 'InHouse',
+            handling: 0,
+            insured_amount: 0,
+            license_relationship: 'Default',
+            packages: nil,
+            ship_date: DateTime.new(2014, 3, 15),
+            shipping_service: 'UPS',
+            shipment_items: [
+              {
+                shipment_item: {
+                  brand_key: 'DEN',
+                  discounts: nil,
+                  product_key: '04CHRCAB75',
+                  product_quantity: 6,
+                  product_unit_price: 76
+                }
+              },
+              {
+                shipment_item: {
+                  brand_key: 'DEN',
+                  discounts: nil,
+                  product_key: 'TShirt',
+                  product_quantity: 1,
+                  product_unit_price: 25.99
+                }
+              }
+            ],
+            shipment_key: 1,
+            shipment_status: 'SentToFulfillment',
+            shipping: 15,
+            ship_to: {
+              city: 'New York',
+              company: nil,
+              country: 'US',
+              county: nil,
+              date_of_birth: DateTime.new(1987, 8, 6),
+              email: 'emily@six88.com',
+              fax: nil,
+              first_name: 'Emily',
+              last_name: 'Sheehan',
+              phone: '7209375005',
+              state: 'NY',
+              street1: '253 Broadway Ave',
+              street2: 'Floor 9',
+              zip1: 10007,
+              zip2: nil
+            }
+          }
+        },
+        tags: nil
+      }
+    })
+  end
+end
+
+Then(/^I should receive the sales tax rates$/) do
+  @compliance_status.success?.should be_true
+  @compliance_status.compliant?.should be_true
+
+  # Tax Rates
+  @compliance_status.recommended_tax_due.should == 44.1
+  @compliance_status.shipment_sales_tax_rates.should be_kind_of(Array)
+  shipment_taxes = @compliance_status.taxes_for_shipment('1')
+
+  # Freight Taxes
+  shipment_taxes.freight.sales_tax_due.should == 1.33125
+  shipment_taxes.freight.sales_tax_rate.should == 8.875
+
+  # Product Taxes
+  shipment_taxes.taxes_for_product('04CHRCAB75').sales_tax_due.should == 40.47
+  shipment_taxes.taxes_for_product('04CHRCAB75').sales_tax_rate.should == 8.875
+
+  shipment_taxes.taxes_for_product('TShirt').sales_tax_due.should == 2.30661
+  shipment_taxes.taxes_for_product('TShirt').sales_tax_rate.should == 8.875
+end
+
+Then(/^I should receive the shipment compliance results$/) do
+  shipment_compliance = @compliance_status.compliance_rules_for_shipment('1')
+  shipment_compliance.compliant?.should be_true
+  shipment_compliance.shipment_key.should == '1'
+
+  shipment_compliance.rules.length.should == 6
+
+  # Compliance Descriptions
+  compliance_descriptions = shipment_compliance.rules.map { |c| c.compliance_description }
+  compliance_descriptions.should == [
+    'No prohibited products in shipment.',
+    'You have 1 current license in this region for the time of this shipment.',
+    'Rule has been acknowledged.',
+    'Rule has been acknowledged.',
+    'All products within this shipment belong to self-produced brands.',
+    'You have shipped 1.00 cases to this individual between 1/1/2014 and 12/31/2014 and thus are under the customer aggregate volume limit of 36 cases per calendar year.'
+  ]
+
+  # Rule Descriptions
+  rule_descriptions = shipment_compliance.rules.map { |c| c.rule_description }
+  rule_descriptions.should == [
+    'Some Products are always non-compliant.',
+    'A license is required for shipping offsite sales and must be renewed every 1 year. The cost of this license is $125.00.',
+    'Shipments to this region require an excise tax of $.30 per 1 gallon on offsite sales of wine less than or equal to 24% alcohol due within 20 days after every month. For a summary of the taxes in the state, click here.',
+    'Shipments to this region require sales tax for offsite sales shipments. For a summary of the taxes in the state, click here.',
+    'Only wines of your own production are allowed to be shipped to this region. Note: The license holder must produce the wine being shipped..',
+    'Shipments to this region have a per customer volume limit of 36 cases per individual per calendar year. The volume will be calculated from combined onsite and offsite sales.'
+  ]
+end
+
+Then(/^I should receive the suggested address$/) do
+  @compliance_status.address_validation_result.should == 'ValidatedWithStreetLevelNormalization'
+  address = @compliance_status.suggested_address
+  
+  address.city.should == 'New York'
+  address.county.should == 'New York'
+  address.state.should == 'NY'
+  address.street1.should == '253 Broadway'
+  address.street2.should == 'Fl 9'
+  address.zip1.should == 10007
+  address.zip2.should == 2326
+
+  address.details.should == {
+    city_abbreviation: 'New York',
+    congressional_district: '10',
+    county_fips: '36061',
+    time_zone: 'Eastern Time',
+    time_zone_code: '05'
+  }
+
+  address.parts.should == {
+    company: nil,
+    mail_box_name: nil,
+    mail_box_number: nil,
+    post_direction: nil,
+    pre_direction: nil,
+    street_name: 'Broadway',
+    street_number: '253',
+    street_suffix: nil,
+    suite_name: 'Fl',
+    suite_number: '9'
+  }
+end