amazon_feed_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e65d748831183d31838b0643bba6c9d754a61e081eb795af60d97dbabeb8cc93
+  data.tar.gz: 7dfd2f7f363cac1c9de9cec3a829f00788bb55e5e4ebdc8e52db2a9ae3a14952
+SHA512:
+  metadata.gz: 50ca85f80b98618a32e98cb9529be2d52b114472dec4d971aaa4bcb0fab33387945d776049736193c1d83867f7d98675da9074fac70487b54a122c3ad0dabba9
+  data.tar.gz: f04365c4acb03579b19ccad8675c9e001519f738822ade5fb4b156b825fc66fb6d8690e30b86f5e6eee912363e4b14c13eb9cac2a73f78c479c3bcd277460d86

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+    - 'bin/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Layout/IndentationConsistency:
+  EnforcedStyle: rails
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Amazon.xsd

@@ -0,0 +1,92 @@
+<?xml version="1.0"?>
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
+<xsd:annotation>
+<xsd:documentation>
+$Date: 2004/11/18 $
+AMAZON.COM CONFIDENTIAL.This document and the information contained in it are
+confidential and proprietary information of Amazon.com and may not be reproduced,distributed or used, in whole or in part, for any purpose other than as necessary to list products for sale on the www.amazon.com web site pursuant to an agreement with Amazon.com.
+</xsd:documentation>
+</xsd:annotation>
+<xsd:include schemaLocation="amzn-base.xsd"/>
+
+<xsd:element name="Amazon-Vendor-Only">	
+<xsd:complexType>
+<xsd:sequence>
+	<xsd:element name="Cost" type="CurrencyAmount"/>
+</xsd:sequence>				
+</xsd:complexType>
+</xsd:element>
+<xsd:annotation>
+<xsd:documentation>
+If you are using the Amazon-Only structure, please also include and populate the Amazon-Vendor-Only structure.
+</xsd:documentation>
+</xsd:annotation>
+
+<xsd:element name="Amazon-Only">
+<xsd:complexType>
+<xsd:sequence>
+	<xsd:element name="Tier" type="xsd:positiveInteger"/>
+	<xsd:element name="PurchasingCategory" type="StringNotNull"/>
+	<xsd:element name="PurchasingSubCategory" type="StringNotNull"/>
+	<xsd:element name="PackagingType" type="StringNotNull"/>
+	<xsd:element name="UnderlyingAvailability">
+	<xsd:simpleType>
+		<xsd:restriction base="xsd:string">
+			<xsd:enumeration value="backordered"/>
+			<xsd:enumeration value="manufacturer-out-of-stock"/>
+			<xsd:enumeration value="pre-ordered"/>
+			<xsd:enumeration value="2-3-days"/>
+			<xsd:enumeration value="1-2-weeks"/>
+			<xsd:enumeration value="4-6-weeks"/>
+		</xsd:restriction>
+	</xsd:simpleType>
+	</xsd:element>
+	<xsd:element name="ReplenishmentCategory">
+	<xsd:simpleType>
+		<xsd:restriction base="xsd:string">
+			<xsd:enumeration value="basic-replenishment"/>
+			<xsd:enumeration value="limited-replenishment"/>
+			<xsd:enumeration value="manufacturer-out-of-stock"/>
+			<xsd:enumeration value="new-product"/>
+			<xsd:enumeration value="non-replenishable"/>
+			<xsd:enumeration value="non-stockupable"/>
+			<xsd:enumeration value="obsolete"/>
+			<xsd:enumeration value="planned-replenishment"/>
+		</xsd:restriction>
+	</xsd:simpleType>
+	</xsd:element>
+	<xsd:element name="DropShipStatus">
+	<xsd:simpleType>
+		<xsd:restriction base="xsd:string">
+			<xsd:enumeration value="drop-ship-disabled"/>
+			<xsd:enumeration value="drop-ship-disabled-by-buyer"/>
+			<xsd:enumeration value="drop-ship-enabled"/>
+			<xsd:enumeration value="drop-ship-enabled-no-auto-pricing"/>
+			<xsd:enumeration value="drop-ship-only"/>
+		</xsd:restriction>
+	</xsd:simpleType>
+	</xsd:element>
+	<xsd:element name="OutOfStockWebsiteMessage">
+	<xsd:simpleType>
+		<xsd:restriction base="xsd:string">
+			<xsd:enumeration value="email-me-when-available"/>
+			<xsd:enumeration value="out-of-stock"/>
+			<xsd:enumeration value="pre-order-ute"/>
+			<xsd:enumeration value="underlying-availability"/>
+		</xsd:restriction>
+	</xsd:simpleType>
+	</xsd:element>
+	</xsd:sequence>
+	</xsd:complexType>
+	</xsd:element>
+</xsd:schema>
+
+
+
+
+
+
+
+
+
+

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+# 0.1.0
+
+* Validate product message
+* Validate fragance message

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in amazon_feed_validator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    amazon_feed_validator (0.1.0)
+      activesupport (~> 5.2)
+      hashie (~> 3.6)
+      nokogiri (~> 1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    hashie (3.6.0)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.59.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  amazon_feed_validator!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.59)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Emil Kampp
+
+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,43 @@
+# AmazonFeedValidator
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amazon_feed_validator'
+```
+
+## Usage
+
+To validate a single feed item based on Amazons feed type enumeration:
+
+```ruby
+validator = AmazonFeedValidator.new(feed, name: 'Product')
+validator.validate # => true or false
+validator.errors # => ["Some error description"]
+```
+
+To validate a whole feed file:
+
+```ruby
+validator = AmazonFeedValidator.new(feed, name: 'amzn-envelope')
+validator.validate # => true or false
+validator.errors # => ["Some error description"]
+```
+
+## Development
+
+To update xsd files run:
+
+```bash
+bundle exec rake amazon:xsd
+```
+
+## Testing
+
+To run all tests:
+
+```bash
+bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,27 @@
+# rubocop:disable Lint/HandleExceptions
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+import './lib/tasks/amazon.rake'
+
+begin
+  require 'rubocop/rake_task'
+
+  RuboCop::RakeTask.new(:rubocop) do |t|
+    t.options = ['--display-cop-names']
+  end
+rescue LoadError
+  # noop
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec rubocop]
+
+desc 'Load the environment'
+task :environment do
+  require_relative './lib/amazon_feed_validator'
+end
+
+# rubocop:enable Lint/HandleExceptions

data/amazon_feed_validator.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amazon_feed_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'amazon_feed_validator'
+  spec.version       = AmazonFeedValidator::VERSION
+  spec.authors       = ['Emil Kampp']
+  spec.email         = ['emil@kampp.me']
+
+  spec.summary       = 'Validate your Amazon feed files'
+  spec.description   = 'Validates your Amazon XML feed files'
+  spec.homepage      = 'https://amazon.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.59'
+
+  spec.add_runtime_dependency 'activesupport', '~> 5.2'
+  spec.add_runtime_dependency 'hashie', '~> 3.6'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.8'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'amazon_feed_validator'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/amazon_feed_validator.rb

@@ -0,0 +1,10 @@
+require 'active_support/all'
+require 'hashie/mash'
+require 'nokogiri'
+
+require 'amazon_feed_validator/version'
+require 'amazon_feed_validator/constructor_methods'
+
+module AmazonFeedValidator
+  # Your code goes here...
+end

data/lib/amazon_feed_validator/constructor_methods.rb

@@ -0,0 +1,12 @@
+# rubocop:disable Style/AccessModifierDeclarations
+
+require 'amazon_feed_validator/feed_validator'
+
+module AmazonFeedValidator
+  def new(*args)
+    AmazonFeedValidator::FeedValidator.new(*args)
+  end
+  module_function :new
+end
+
+# rubocop:enable Style/AccessModifierDeclarations

data/lib/amazon_feed_validator/feed_validator.rb

@@ -0,0 +1,37 @@
+module AmazonFeedValidator
+  class FeedValidator
+    XSDDIR = File.expand_path('../xsd', __dir__)
+
+    attr_reader :feed, :options, :errors
+
+    def initialize(feed, **options)
+      @feed = Nokogiri::XML feed
+      @options = Hashie::Mash.new options
+    end
+
+    def validate
+      @errors = Nokogiri::XML::Schema(xsd_file(options.name))
+        .validate(feed)
+        .map(&:to_s)
+      errors.empty?
+    end
+
+    private
+
+      def xsd_file(name)
+        file = File.read File.expand_path sanitize_name(name), XSDDIR
+
+        # Replace schema location references with ones pointing to local xsd
+        # files
+        file.gsub! \
+          'schemaLocation="',
+          "schemaLocation=\"#{XSDDIR}/"
+      end
+
+      def sanitize_name(name)
+        name ||= 'Product.xsd'
+        name = "#{name}.xsd" unless name.include? '.xsd'
+        name
+      end
+  end
+end