solidus_ship_compliant 1.0.0

data/lib/tasks/solidus_ship_compliant/export.rake

@@ -0,0 +1,78 @@
+namespace :solidus_ship_compliant do
+  desc 'Export products to Ship Compliant'
+  task :export_products, [:product_ids] => :environment do |_task, args|
+    # Export brands in case that were not exported
+    Rake::Task['solidus_ship_compliant:export_brands'].invoke
+
+    # Get brand and category taxonomies
+    brand_taxnomy = Spree::Taxonomy.find_by(name: 'Brand')
+    category_taxonomy = Spree::Taxonomy.find_by(name: 'Categories')
+
+    product_list(args.extras).in_groups_of(100) do |product_ids|
+      # Create Ship Compliant product per Spree::Product variants
+      Spree::Product.where(id: product_ids).each do |product|
+        brand_taxon = product.taxons.where(taxonomy: brand_taxnomy).first
+        category_taxon = product.taxons.where(taxonomy: category_taxonomy).first
+
+        product.variants.each do |variant|
+          result = ShipCompliant::AddUpdateProduct.product({
+            bottle_size_ms: variant.bottle_size,
+            brand_key: brand_taxon.brand_key,
+            default_case: variant.default_case || '12',
+            default_wholesale_case_price: variant.default_wholesale_case_price || '270',
+            description: variant.description || 'Denver Snow Flake Cab 2013',
+            percent_alcohol: variant.percent_alcohol || '14.1',
+            product_distribution: 'Both',
+            product_key: variant.product_key,
+            product_type: category_taxon.name, # [Wine, Beer, Cider]
+            unit_price: variant.price.to_f,
+            varietal: variant.varietal || 'Cabernet Sauvignon',
+            vintage: variant.vintage || 2013,
+            volume_amount: variant.volumne_amount || 750,
+            volume_unit: variant.volume_unit || 'milliliter',
+          }, update_mode: 'IgnoreExisting')
+
+          if result.success?
+            puts "Product #{variant.name} added successfully."
+          else
+            result.errors.each do |error|
+              puts error.message
+            end
+          end
+        end
+      end
+    end
+  end
+
+  desc 'Export brands to Ship Compliant'
+  task export_brands: :environment do
+    # Get brand taxonomy and taxons
+    taxonomy = Spree::Taxonomy.find_by(name: 'Brand')
+    taxons = taxonomy.root.children
+
+    taxons.each do |taxon|
+      result = ShipCompliant::AddUpdateBrand.brand({
+        key: taxon.brand_key,
+        name: taxon.name,
+        this_brand_is_bottled_by_a_third_party: true,
+        this_brand_is_produced_by_a_third_party: true,
+        this_brand_operates_under_a_trade_name: false,
+        this_brand_was_acquired_from_a_third_party: false
+      })
+
+      if result.success?
+        puts "Brand #{taxon.name} added successfully."
+      else
+        result.errors.each do |error|
+          puts error.message
+        end
+      end
+    end
+  end
+
+  def product_list(sku_list)
+    sku_list.present? &&
+      Spree::Product.joins(:master).where("spree_variants.sku IN (?)", sku_list) ||
+      Spree::Product.joins(:master)
+  end
+end

data/solidus_ship_compliant.gemspec

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+$:.push File.expand_path('../lib', __FILE__)
+require 'solidus_ship_compliant/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'solidus_ship_compliant'
+  s.version     = SolidusShipCompliant::VERSION
+  s.author      = 'Jonathan Tapia'
+  s.email       = 'jonathan.tapia@magmalabs.io'
+  s.homepage    = 'http://github.com/jtapia/solidus_ship_compliant'
+  s.summary     = 'Solidus Engine for Ship compliant tax calculation service'
+  s.description = 'Solidus Engine for Ship compliant tax calculation service'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  solidus_version = ['>= 2.0', '< 3']
+  s.add_dependency 'solidus_core', solidus_version
+  s.add_dependency 'solidus_support'
+  s.add_dependency 'deface', '~> 1.0'
+
+  s.add_development_dependency 'byebug'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_bot'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'poltergeist'
+  s.add_development_dependency 'pry-rails'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'simplecov'
+end

data/spec/controllers/admin/ship_compliant_settings_controller_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Spree::Admin::ShipCompliantSettingsController do
+  stub_authorization!
+
+   context '#edit' do
+    it 'should assign a SolidusShipCompliant::Config and render the view' do
+      get :edit
+
+      expect(assigns(:config)).to be_an_instance_of(SolidusShipCompliant::Configuration)
+      expect(response).to render_template('edit')
+    end
+  end
+
+  context '#update' do
+    let(:config) { SolidusShipCompliant::Config }
+
+    context 'with existing value' do
+      around do |example|
+        default_weight = config.get_preference(:username)
+        example.run
+        config.set_preference(:username, default_weight)
+      end
+
+      it "updates the existing value" do
+        expect(config.has_preference?(:username)).to be(true)
+        post :update, params: { username: 'user_test' }
+        expect(config.send("username")).to eql('user_test')
+      end
+    end
+
+    context 'without existing value' do
+      it "doesn't produce an error" do
+        post :update, params: { 'not_real_parameter_name' => 'not_real' }
+        expect(response).to redirect_to(spree.edit_admin_ship_compliant_settings_path)
+      end
+    end
+  end
+end

data/spec/models/calculator/ship_compliant_calculator_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Spree::Calculator::ShipCompliantCalculator do
+  let(:calculator) { Spree::Calculator::ShipCompliantCalculator.new }
+
+  describe '.description' do
+    it 'should not be nil' do
+      expect(Spree::Calculator::ShipCompliantCalculator.description).to eq Spree.t(:ship_compliant_tax)
+    end
+  end
+
+  describe '#compute_order' do
+    it 'should raise an error' do
+      expect {
+        calculator.compute_order(nil)
+      }.to raise_error(RuntimeError)
+    end
+  end
+end

data/spec/models/spree/ship_compliant_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Spree::ShipCompliant, type: :model do
+  let!(:taxonomy) { create(:taxonomy, name: 'Brand') }
+  let!(:brand_taxon) { create(:taxon, taxonomy: taxonomy) }
+  let!(:order) { create(:order_ready_to_ship) }
+
+  subject { Spree::ShipCompliant.new(order) }
+
+  context '#address_from_spree_address' do
+    it 'returns the payload address' do
+      expect(subject.address_from_spree_address(order.ship_address)).to_not be_nil
+    end
+  end
+
+  context '#shipment_items' do
+    it 'returns the 3 first chars of taxon name' do
+      expect(subject.shipment_items).to_not be_nil
+    end
+  end
+end

data/spec/models/spree/taxon_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Spree::Taxon, type: :model do
+  let!(:taxon) { create(:taxon, name: 'Brand') }
+
+  context '#brand_key' do
+    it 'returns the 3 first chars of taxon name' do
+      expect(taxon.brand_key).to eql('BRA')
+    end
+
+    it 'returns the first char of taxon name splitted' do
+      taxon.name = 'Test Taxon'
+      expect(taxon.brand_key).to eql('TT')
+    end
+  end
+end

data/spec/models/spree/variant_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Spree::Variant, type: :model do
+  let!(:taxonomy) { create(:taxonomy, name: 'Brand') }
+  let!(:brand_taxon) { create(:taxon, taxonomy: taxonomy) }
+  let!(:bottle_size_option_type) { create(:option_type, name: 'Bottle Size', presentation: 'Bottle Size') }
+  let!(:bottle_size_option_value) { create(:option_value, option_type: bottle_size_option_type) }
+  let!(:default_case) { create(:property, name: 'default_case') }
+  let!(:default_wholesale_case_price) { create(:property, name: 'default_wholesale_case_price') }
+  let!(:percent_alcohol) { create(:property, name: 'percent_alcohol') }
+  let!(:varietal) { create(:property, name: 'varietal') }
+  let!(:vintage) { create(:property, name: 'vintage') }
+  let!(:volume_amount) { create(:property, name: 'volume_amount') }
+  let!(:volume_unit) { create(:property, name: 'volume_unit') }
+
+  let!(:product) { create(:product, taxons: [brand_taxon]) }
+
+  let!(:bottle_size_product_property) { create(:product_option_type, product: product, option_type: bottle_size_option_type) }
+  let!(:default_case_product_property) { create(:product_property, product: product, property: default_case, value: '1') }
+  let!(:default_wholesale_case_price_product_property) { create(:product_property, product: product, property: default_wholesale_case_price, value: '670') }
+  let!(:percent_alcohol_product_property) { create(:product_property, product: product, property: percent_alcohol, value: '5%') }
+  let!(:varietal_product_property) { create(:product_property, product: product, property: varietal, value: 'Cabernet Sauvignon') }
+  let!(:vintage_product_property) { create(:product_property, product: product, property: vintage, value: '2003') }
+  let!(:volume_amount_product_property) { create(:product_property, product: product, property: volume_amount, value: '750') }
+  let!(:volume_unit_product_property) { create(:product_property, product: product, property: volume_unit, value: 'milliliter') }
+
+  let!(:variant) { create(:variant, product: product) }
+
+  context 'validations' do
+    it 'should validate bottle_size is present' do
+      expect(variant.brand_key).to_not be_nil
+    end
+
+    it 'should validate bottle_size is present' do
+      expect(variant.product_key).to_not be_nil
+    end
+
+    it 'should validate bottle_size is present' do
+      expect(variant.bottle_size).to_not be_nil
+    end
+
+    it 'should validate default_case is present' do
+      expect(variant.default_case).to_not be_nil
+    end
+
+    it 'should validate default_wholesale_case_price is present' do
+      expect(variant.default_wholesale_case_price).to_not be_nil
+    end
+
+    it 'should validate percent_alcohol is present' do
+      expect(variant.percent_alcohol).to_not be_nil
+    end
+
+    it 'should validate varietal is present' do
+      expect(variant.varietal).to_not be_nil
+    end
+
+    it 'should validate vintage is present' do
+      expect(variant.vintage).to_not be_nil
+    end
+
+    it 'should validate volume_amount is present' do
+      expect(variant.volume_amount).to_not be_nil
+    end
+
+    it 'should validate volume_unit is present' do
+      expect(variant.volume_unit).to_not be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path('../dummy/config/environment.rb', __FILE__)
+abort('The Rails environment is running in production mode!') if Rails.env.production?
+
+require 'rspec/rails'
+
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |file| require file }
+
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError
+  `bin/rails db:migrate`
+end
+
+# Requires factories defined in lib/solidus_ship_compliant/factories.rb
+require 'solidus_ship_compliant/factories'
+
+RSpec.configure do |config|
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+  config.filter_rails_from_backtrace!
+end

data/spec/support/ability.rb

@@ -0,0 +1,15 @@
+RSpec.configure do |config|
+  config.after do
+    Spree::Ability.abilities.delete(AbilityDecorator) if Spree::Ability.abilities.include?(AbilityDecorator)
+  end
+end
+
+if defined? CanCan::Ability
+  class AbilityDecorator
+    include CanCan::Ability
+
+    def initialize(user)
+      cannot :manage, Spree::Order
+    end
+  end
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,23 @@
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  config.before do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, :js) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before do
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/devise.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.include Devise::TestHelpers, type: :view
+  config.include Rack::Test::Methods, type: :feature
+  config.include Devise::Test::ControllerHelpers, type: :controller
+end

data/spec/support/factory_bot.rb

@@ -0,0 +1,5 @@
+require 'factory_bot'
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end

data/spec/support/preferences.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before do
+    Spree::Auth::Config.preference_store = Spree::Auth::Config.default_preferences
+  end
+end

data/spec/support/spree.rb

@@ -0,0 +1,14 @@
+require 'spree/testing_support/factories'
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/url_helpers'
+require 'spree/testing_support/capybara_ext'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/flash'
+require 'spree/testing_support/order_walkthrough'
+
+RSpec.configure do |config|
+  config.include Spree::TestingSupport::UrlHelpers
+  config.include Spree::TestingSupport::ControllerRequests, type: :controller
+  config.include Spree::TestingSupport::Flash
+  config.include Spree::BaseHelper
+end

metadata

@@ -0,0 +1,307 @@
+--- !ruby/object:Gem::Specification
+name: solidus_ship_compliant
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Tapia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: solidus_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Solidus Engine for Ship compliant tax calculation service
+email: jonathan.tapia@magmalabs.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/solidus_ship_complaint.js
+- app/assets/javascripts/spree/frontend/solidus_ship_complaint.js
+- app/assets/stylesheets/spree/backend/solidus_ship_complaint.css
+- app/assets/stylesheets/spree/frontend/solidus_ship_complaint.css
+- app/controllers/spree/admin/orders_controller_decorator.rb
+- app/controllers/spree/admin/ship_compliant_settings_controller.rb
+- app/controllers/spree/checkout_controller_decorator.rb
+- app/models/spree/calculator/ship_compliant_calculator.rb
+- app/models/spree/ship_compliant.rb
+- app/models/spree/taxon_decorator.rb
+- app/models/spree/variant_decorator.rb
+- app/overrides/spree/admin/shared/_configuration_menu/_add_ship_compliant_config_menu.html.erb.deface
+- app/views/spree/admin/shared/_ship_complaint_tabs.html.erb
+- app/views/spree/admin/ship_compliant_settings/edit.html.erb
+- bin/rails
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/solidus_ship_compliant/install/install_generator.rb
+- lib/solidus_ship_compliant.rb
+- lib/solidus_ship_compliant/configuration.rb
+- lib/solidus_ship_compliant/engine.rb
+- lib/solidus_ship_compliant/error.rb
+- lib/solidus_ship_compliant/factories.rb
+- lib/solidus_ship_compliant/version.rb
+- lib/tasks/solidus_ship_compliant/export.rake
+- solidus_ship_compliant.gemspec
+- spec/controllers/admin/ship_compliant_settings_controller_spec.rb
+- spec/factories/variant_factory_override.rb
+- spec/features/checkout_spec.rb
+- spec/models/calculator/ship_compliant_calculator_spec.rb
+- spec/models/spree/ship_compliant_spec.rb
+- spec/models/spree/taxon_spec.rb
+- spec/models/spree/variant_spec.rb
+- spec/spec_helper.rb
+- spec/support/ability.rb
+- spec/support/database_cleaner.rb
+- spec/support/devise.rb
+- spec/support/factory_bot.rb
+- spec/support/preferences.rb
+- spec/support/spree.rb
+homepage: http://github.com/jtapia/solidus_ship_compliant
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Solidus Engine for Ship compliant tax calculation service
+test_files:
+- spec/controllers/admin/ship_compliant_settings_controller_spec.rb
+- spec/factories/variant_factory_override.rb
+- spec/features/checkout_spec.rb
+- spec/models/calculator/ship_compliant_calculator_spec.rb
+- spec/models/spree/ship_compliant_spec.rb
+- spec/models/spree/taxon_spec.rb
+- spec/models/spree/variant_spec.rb
+- spec/spec_helper.rb
+- spec/support/ability.rb
+- spec/support/database_cleaner.rb
+- spec/support/devise.rb
+- spec/support/factory_bot.rb
+- spec/support/preferences.rb
+- spec/support/spree.rb