business_catalyst 0.1.0

data/lib/business_catalyst/csv/row.rb

@@ -0,0 +1,108 @@
+# encoding: utf-8
+require 'csv'
+
+module BusinessCatalyst
+  module CSV
+
+    class NoSuchColumnError < StandardError; end
+
+    # Shared logic for building a row for a CSV export for Business Catalust.
+    # Instead of sublcassing Row directly in your project, subclass CatalogRow
+    # or ProductRow, which have column definitions set up for those tables.
+    class Row
+      def initialize(*args)
+      end
+
+      # Override to return Array of column config Arrays in the format:
+      #
+      #   [
+      #     ["Header", :mapping_name, default_value, TransformerClass],
+      #     ...
+      #   ]
+      #
+      # "default_value" and "TransformerClass" are optional, and will default to nil and
+      # GenericTransformer, respectively, if not specified.
+      def self.columns
+        raise NotImplementedError, "Implement to return Array of column config Arrays in the format: [[\"Header\", :mapping_name, default_value, TransformerClass]]"
+      end
+
+      # Define value for BC column using a block. Column argument should be
+      # one of the mapping name symbols returned by Row.columns.
+      def self.map(column, &block)
+        unless columns.any? {|c| c[1] == column}
+          raise NoSuchColumnError, "no such column '#{column.inspect}'"
+        end
+        define_method(column, &block)
+      end
+
+      # Set the default currency for the current application.
+      # Alias for CurrencyTransformer.default_currency=
+      #
+      #   class MyRow < BusinessCatalyst::CSV:Row
+      #     default_currency "US"
+      #   end
+      #
+      def self.default_currency(currency)
+        CurrencyTransformer.default_currency = currency
+      end
+
+      # Nice shortcut for generating a csv.
+      # TODO: add option to usea file splitter.
+      #
+      # Manual:
+      #
+      #   ProductRow.generate("products.csv") do |csv|
+      #     products.each do |product|
+      #       csv << ProductRow.new(product).to_a
+      #     end
+      #   end
+      #
+      # Automatic collection handling:
+      #
+      #   ProductRow.generate("products.csv", products) do |product|
+      #     ProductRow.new(product)
+      #   end
+      #
+      def self.generate(file_name, collection = nil)
+        ::CSV.open(file_name, 'wb') do |csv|
+          csv << headers
+          if collection.respond_to?(:each)
+            collection.each do |item|
+              row = yield(item)
+              raise ArgumentError, "input must be a valid Row" unless row.kind_of?(self)
+              csv << row.to_a
+            end
+          else
+            yield csv
+          end
+        end
+      end
+
+      def to_a
+        self.class.columns.map { |column|
+          csv_value(column[1], column)
+        }
+      end
+
+      def self.headers
+        @headers ||= columns.map(&:first)
+      end
+
+      def csv_value(method, config = nil)
+        config ||= self.class.columns.find {|c| c[1] == method}
+        raise NoSuchColumnError, "no configuration found for #{method.inspect} in #{self.class.to_s}.columns" if config.nil?
+
+        input = if respond_to?(method)
+                  send(method)
+                else
+                  config.fetch(2, nil)
+                end
+
+        transformer = config.fetch(3, GenericTransformer)
+        transformer.transform(input)
+      end
+
+    end
+
+  end
+end

data/lib/business_catalyst/csv/transformers/catalog_transformer.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+module BusinessCatalyst
+  module CSV
+
+    class CatalogTransformer < Transformer
+      def normalized_input
+        # ensure at least a 1D array
+        normalized_input = input.kind_of?(Array) ? input : [input]
+
+        # now convert to 2D array
+        unless normalized_input.first.kind_of?(Array)
+          normalized_input = [normalized_input]
+        end
+
+        normalized_input
+      end
+
+      def transform
+        normalized_input.map { |path|
+          if path.any?
+            sanitized_names = path.map { |name|
+              BusinessCatalyst.sanitize_catalog_name(name)
+            }
+            "/" + sanitized_names.join("/")
+          end
+        }.join(";")
+      end
+    end
+
+  end
+end

data/lib/business_catalyst/csv/transformers/currency_transformer.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+require 'bigdecimal'
+
+module BusinessCatalyst
+  module CSV
+
+    class CurrencyTransformer < Transformer
+      BC_CURRENCY_REGEX = /\A\w+\/\d/.freeze
+
+      def self.default_currency
+        @default_currency || "US"
+      end
+
+      def self.default_currency=(currency)
+        @default_currency = currency
+      end
+
+      attr_accessor :currency
+
+      def initialize(input, currency = nil)
+        @currency = currency || self.class.default_currency
+        super(input)
+      end
+
+      def transform
+        if input
+          inputs = Array(input).map {|n| number_to_currency(n) }.compact
+          if inputs.any?
+            inputs.join(";")
+          end
+        end
+      end
+
+      def number_to_currency(input)
+        if input
+          input_s = input.kind_of?(BigDecimal) ? input.to_s('F') : input.to_s.strip
+          if input_s != ""
+            if is_bc_currency_string?(input_s)
+              input_s
+            else
+              "#{currency}/#{input_s}"
+            end
+          end
+        end
+      end
+
+      def is_bc_currency_string?(input)
+        !!(input =~ BC_CURRENCY_REGEX)
+      end
+    end
+
+  end
+end

data/lib/business_catalyst/csv/transformers/invalid_input_error.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+module BusinessCatalyst
+  module CSV
+
+    class InvalidInputError < StandardError
+    end
+
+  end
+end

data/lib/business_catalyst/csv/transformers/product_attributes_transformer.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+module BusinessCatalyst
+  module CSV
+
+    # Example: Chain*|5|N:Rope Chain||US/0,Box Chain||US/5,Snake Chain||US/5;Length*|5|N:16 inch||US/0,18 inch||US/0,20 inch||US/0,24 inch||US/0
+    #
+    # Name1REQ|display_as|keep_stock:Option1.name|Option1.image|Option1.price,Option2.name|...;Name2...
+    class ProductAttributesTransformer < Transformer
+
+      def transform
+        if input.kind_of?(String)
+          input
+        elsif input
+          attributes.map {|attribute|
+            name        = BusinessCatalyst.sanitize_catalog_name(attribute.name)
+            required    = attribute.required ? '*' : ''
+            display_as  = attribute.display_as.to_i
+            keep_stock  = BooleanTransformer.transform(attribute.keep_stock)
+
+            text = ["#{name}#{required}", display_as, keep_stock].join("|")
+            text << ":"
+
+            text << attribute.options.map {|option|
+              name  = BusinessCatalyst.sanitize_catalog_name(option.name.to_s)
+              image = option.image.to_s.strip
+              price = CurrencyTransformer.transform(option.price)
+              [name, image, price].join("|")
+            }.join(",")
+
+            text
+          }.join(";")
+        end
+      end
+
+      def attributes
+        if input.kind_of?(Array)
+          input.compact
+        else
+          [input].compact
+        end
+      end
+
+    end
+  end
+end

data/lib/business_catalyst/csv/transformers/product_code_transformer.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module BusinessCatalyst
+  module CSV
+
+    class ProductCodeTransformer < Transformer
+
+      def initialize(input)
+        if input.blank?
+          raise InvalidInputError, "product_code must not be blank"
+        end
+        super(input)
+      end
+
+      def transform
+        input.to_s
+      end
+
+    end
+
+  end
+end

data/lib/business_catalyst/csv/transformers/seo_friendly_url_transformer.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module BusinessCatalyst
+  module CSV
+
+    class SEOFriendlyUrlTransformer < Transformer
+
+      def initialize(input)
+        input = input.to_s
+        raise InvalidInputError, "seo_friendly_url must not be blank" if input.nil? || input.strip == ""
+        raise InvalidInputError, "seo_friendly_url '#{input}' is not globally unique" unless self.class.is_globally_unique?(input)
+        self.class.register_url(input)
+        super(input)
+      end
+
+      def transform
+        input
+      end
+
+      def self.reset_global_urls!
+        @global_urls = {}
+      end
+
+      def self.global_urls
+        @global_urls ||= {}
+      end
+
+      def self.register_url(url)
+        global_urls[url] = true
+      end
+
+      def self.is_globally_unique?(url)
+        !global_urls.fetch(url, false)
+      end
+
+    end
+
+  end
+end

data/lib/business_catalyst/csv/transformers/transformer.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module BusinessCatalyst
+  module CSV
+
+    class Transformer
+      attr_accessor :input
+
+      def initialize(input)
+        @input = input
+      end
+
+      def transform
+        raise NotImplementedError, "Transformer subclasses must implement #transform"
+      end
+
+      def self.transform(input)
+        self.new(input).transform
+      end
+    end
+
+  end
+end

data/lib/business_catalyst/csv/transformers/uri_array_transformer.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module BusinessCatalyst
+  module CSV
+    class URIArrayTransformer < Transformer
+
+      def transform
+        if input
+          Array(input).map {|s| URI.encode(s.to_s).gsub(";", " ") }.join(";")
+        end
+      end
+
+    end
+  end
+end

data/lib/business_catalyst/csv/transformers/uri_transformer.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+module BusinessCatalyst
+  module CSV
+
+    class URITransformer < Transformer
+
+      def transform
+        URI.encode(input) if input
+      end
+
+    end
+
+  end
+end

data/lib/business_catalyst/csv/transformers.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+require 'business_catalyst/csv/transformers/invalid_input_error'
+require 'business_catalyst/csv/transformers/transformer'
+require 'business_catalyst/csv/transformers/catalog_transformer'
+require 'business_catalyst/csv/transformers/currency_transformer'
+require 'business_catalyst/csv/transformers/product_attributes_transformer'
+require 'business_catalyst/csv/transformers/product_code_transformer'
+require 'business_catalyst/csv/transformers/seo_friendly_url_transformer'
+require 'business_catalyst/csv/transformers/uri_array_transformer'
+require 'business_catalyst/csv/transformers/uri_transformer'
+
+module BusinessCatalyst
+  module CSV
+
+    # Just calls to_s on input
+    class GenericTransformer < Transformer
+      def transform
+        input.to_s if input
+      end
+    end
+
+
+    class ArrayTransformer < Transformer
+      def transform
+        if input
+          Array(input).map {|s| s.to_s.gsub(";", " ") }.join(";")
+        end
+      end
+    end
+
+
+    class BooleanTransformer < Transformer
+      def transform
+        input ? "Y" : "N"
+      end
+    end
+
+    class TemplateIDTransformer < Transformer
+      def transform
+        if input.kind_of?(Symbol)
+          case input
+          when :default
+            0
+          when :none
+            -1
+          when :parent
+            -2
+          else
+            raise InvalidInputError, "#{input} is not a valid template ID"
+          end
+        else
+          input
+        end
+      end
+    end
+
+  end
+end

data/lib/business_catalyst/version.rb

@@ -0,0 +1,3 @@
+module BusinessCatalyst
+  VERSION = "0.1.0"
+end

data/lib/business_catalyst.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require "business_catalyst/version"
+require "business_catalyst/csv/product_attribute"
+require "business_catalyst/csv/transformers"
+require "business_catalyst/csv/row"
+require "business_catalyst/csv/product_row"
+require "business_catalyst/csv/catalog_row"
+require "business_catalyst/csv/file_splitter"
+
+module BusinessCatalyst
+
+  # The following characters cause an error message if they appear in a catalog name.
+  CATALOG_CHAR_BLACKLIST = /[\\\/;#:"\|_@=\?]/.freeze
+  MORE_STRICT_BLACKLIST = /[\\\/;&,#:"\|\._@=\?]/.freeze
+
+  # Strip all characters out of a catalog name that will cause an error. Replaces them with
+  # " " and then squishes all whitespace to single space to preserve word structure.
+  def self.sanitize_catalog_name(name)
+    return name if name.nil?
+    sanitized = name.strip
+    sanitized.gsub!(CATALOG_CHAR_BLACKLIST, " ")
+    sanitized.gsub!(/\s+/, " ")
+    sanitized
+  end
+
+  # A guess as to how business catalyst converts names to URL's, based on this blog entry:
+  # http://www.businesscatalyst.com/bc-blog/seo-friendly-urls-for-products-and-catalogs
+  #
+  # Downcases, converts invalid characters and whitespace to '-', and finally removes multiple
+  # consecutive dashes and leading and trailing dashes. Does NOT append
+  # numbers to ensure uniqueness, you must do this yourself after conversion.
+  def self.seo_friendly_url(name)
+    name.strip.downcase.gsub(/[^a-z0-9\-]/, "-").gsub(/-{2,}/, "-").gsub(/\A-+|-+\Z/, "")
+  end
+
+  def self.reset_global_urls!
+    BusinessCatalyst::CSV::SEOFriendlyUrlTransformer.reset_global_urls!
+  end
+
+end

data/spec/lib/business_catalyst/business_catalyst_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe BusinessCatalyst do
+  subject { BusinessCatalyst }
+
+  describe "#seo_friendly_url" do
+    it "replaces bad SEO chars with '-'" do
+      subject.seo_friendly_url("a&b").should eq("a-b")
+    end
+    it "replaces multiple consecutive bad SEO chars with single '-'" do
+      subject.seo_friendly_url("a/;&,#:\"|._@=?()b").should eq("a-b")
+    end
+    it "replaces whitespace with '-'" do
+      subject.seo_friendly_url("a  b").should eq("a-b")
+    end
+    it "removes leading and trailing whitespace" do
+      subject.seo_friendly_url(" a b \n").should eq("a-b")
+    end
+    it "removes leading and trailing '-'" do
+      subject.seo_friendly_url("-a-b-").should eq("a-b")
+    end
+    it "squishes multiple consecutive '-'" do
+      subject.seo_friendly_url("a--b").should eq("a-b")
+    end
+    it "downcases input" do
+      subject.seo_friendly_url("A B").should eq("a-b")
+    end
+    it "strips random unicode characters" do
+      subject.seo_friendly_url("test”®").should eq("test")
+    end
+  end
+
+end

data/spec/lib/business_catalyst/csv/catalog_row_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe BusinessCatalyst::CSV::CatalogRow do
+  subject { BusinessCatalyst::CSV::CatalogRow.new }
+end

data/spec/lib/business_catalyst/csv/file_splitter_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require 'fileutils'
+
+module BusinessCatalyst
+  module CSV
+    describe FileSplitter do
+      subject {
+        FileSplitter.new("test", :max_rows_per_file => 10, :header_row => ["Column 1"], :verbose => false, :logger => nil)
+      }
+
+      after(:each) do
+        # cleanup any files generated
+
+        begin
+          subject.close
+        rescue IOError
+          # if it's already closed, awesome!
+        end
+
+        Dir.glob("test_*").each do |test_file|
+          FileUtils.rm(test_file)
+        end
+      end
+
+      def get_csv_writer_path(writer)
+        if RUBY_VERSION =~ /\A1\.8/
+          writer.send(:instance_variable_get, :@dev).path
+        else
+          writer.path
+        end
+      end
+
+      describe "#start" do
+        it "yields self" do
+          expect {|b| subject.start(&b) }.to yield_control.once
+        end
+        it "opens a new file with the new row range appended" do
+          subject.start do |splitter|
+            expect(get_csv_writer_path(splitter.current_file)).to eq("test_1-10.csv")
+          end
+        end
+      end
+
+      describe "#start_row" do
+        it "increments #current_row" do
+          expect { subject.start_row }.to change(subject, :current_row).by(1)
+        end
+        it "increments #total_rows" do
+          expect { subject.start_row }.to change(subject, :total_rows).by(1)
+        end
+        context "when current_row becomes greater than max_rows_per_file" do
+          before do
+            subject.max_rows_per_file = 10
+            subject.send(:instance_variable_set, :@current_row, 10)
+            subject.send(:instance_variable_set, :@total_rows, 10)
+          end
+          it "resets current_row to 1" do
+            expect { subject.start_row }.to change(subject, :current_row).to(1)
+          end
+          it "closes #current_file" do
+            file = double("File", :close => nil)
+            subject.send(:instance_variable_set, :@current_file, file)
+            subject.start_row
+            expect(file).to have_received(:close)
+          end
+          it "opens a new file with the new row range appended" do
+            subject.start_row
+            expect(get_csv_writer_path(subject.current_file)).to eq("test_11-20.csv")
+          end
+          it "appends the new file name to #all_files" do
+            subject.start_row
+            expect(subject.all_files.last).to eq("test_11-20.csv")
+          end
+          it "prepends the header row to the new file" do
+            subject.header_row = ["Column 1", "Column 2"]
+            subject.start_row
+            file = get_csv_writer_path(subject.current_file)
+            subject.close
+            line = File.open(file, 'r') do |f|
+              f.readline
+            end
+            expect(line).to eq("Column 1,Column 2\n")
+          end
+          it "calls a block provided to #on_file_change" do
+            it_works = false
+            subject.on_file_change do
+              it_works = true
+            end
+            subject.start_row
+            expect(it_works).to eq(true)
+          end
+          it "calls a block provided to #on_file_change with itself, if block arity is 1 or more" do
+            subject.on_file_change do |s|
+              expect(s).to eq(subject)
+            end
+            subject.start_row
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/lib/business_catalyst/csv/product_attribute_spec.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+require 'spec_helper'
+
+module BusinessCatalyst
+  module CSV
+    describe ProductAttribute do
+
+      describe "#new" do
+        it "raises ArgumentError when display_as is invalid symbol" do
+          expect {
+            ProductAttribute.new("Test", :display_as => :invalid, :required => false, :keep_stock => false)
+          }.to raise_error(ArgumentError)
+        end
+        it "raises ArgumentError when display_as is invalid integer" do
+          expect {
+            ProductAttribute.new("Test", :display_as => -1)
+          }.to raise_error(ArgumentError)
+        end
+      end
+
+      describe "#add_options" do
+        context "when given an Array of Arrays" do
+          it "calls add_option with the splat of each array item" do
+            attribute = ProductAttribute.new("Test", :display_as => :dropdown, :required => false, :keep_stock => false)
+            attribute.add_options([["Opt", "img", 1]])
+            expect(attribute.options).to eq([ProductAttribute::Option.new("Opt", "img", 1)])
+          end
+          it "coerces arguments to array" do
+            attribute = ProductAttribute.new("Test", :display_as => :dropdown, :required => false, :keep_stock => false)
+            attribute.add_options(["Opt1", "img", 1], ["Opt2", "img", 1])
+            expect(attribute.options).to eq([
+              ProductAttribute::Option.new("Opt1", "img", 1),
+              ProductAttribute::Option.new("Opt2", "img", 1)
+            ])
+          end
+        end
+        context "when given an Array of Hashes" do
+          it "handles hashes correctly" do
+            attribute = ProductAttribute.new("Test", :display_as => :dropdown, :required => false, :keep_stock => false)
+            attribute.add_options([{:name => "Opt1", :image => "img", :price => 1}])
+            expect(attribute.options).to eq([ProductAttribute::Option.new("Opt1", "img", 1)])
+          end
+        end
+        context "when given an Array of ProductAttribute::Option instances" do
+          it "adds just appends the object(s) to #options" do
+            attribute = ProductAttribute.new("Test", :display_as => :dropdown, :required => false, :keep_stock => false)
+            attribute.add_options([ProductAttribute::Option.new("Opt1", "img", 1)])
+            expect(attribute.options).to eq([ProductAttribute::Option.new("Opt1", "img", 1)])
+          end
+        end
+        context "when given several strings" do
+          it "it turns each into an option with a name only" do
+            attribute = ProductAttribute.new("Test", :display_as => :dropdown, :required => false, :keep_stock => false)
+            attribute.add_options("Opt1", "Opt2")
+            expect(attribute.options).to eq([
+              ProductAttribute::Option.new("Opt1", nil, nil),
+              ProductAttribute::Option.new("Opt2", nil, nil)
+            ])
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/lib/business_catalyst/csv/product_row_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe BusinessCatalyst::CSV::ProductRow do
+  subject { ProductRow.new }
+end