datashift_spree 0.1.0

data/LICENSE.txt

@@ -0,0 +1,27 @@
+== DataShift Spree
+
+## License
+
+Copyright:: (c) Autotelik Media Ltd 2012
+Author ::   Tom Statter
+Date ::     Sept 2012
+
+The 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.markdown

@@ -0,0 +1,81 @@
+##  DataShift 
+
+Specific loaders and command line tasks for Spree E-Commerce.
+
+Wiki here : **https://github.com/autotelik/datashift/wiki**
+
+### Features
+
+Import and Export Spree models through .xls or CSV  files, including
+all associations and setting configurable defaults or over rides.
+
+High level rake and thor command line tasks for import/export provided.
+
+Specific loaders and command line tasks provided out the box for **Spree E-Commerce**, 
+enabling import/export of Product data including creating Variants with different
+ count on hands and all associations including Properties/Taxons/OptionTypes and Images.
+
+Loaders can be configured via YAML with over ride values, default values and mandatory column settings.
+
+Many example Spreadsheets/CSV files in spec/fixtures, fully documented with comments for each column.
+
+## Installation
+
+Add gem 'datashift' to your Gemfile/bundle, or install the latest gem as usual :
+
+    gem install datashift
+
+To use :
+
+    gem 'datashift'
+    require 'datashift'
+
+
+To use the Thor command line applications :
+
+    Create a high level .thor file - e.g mysite.thor - in your applications root directory 
+
+Edit the file and add the following to pull in the thor commands :
+
+```ruby
+    require 'thor'
+    require 'datashift'
+
+    DataShift::load_commands
+```
+To check the available tasks run
+
+    bundle exc thor list datashift
+
+To get usage information use thor help <command>, for example
+
+    bundle exec thor help datashift:generate:excel
+
+
+## License
+
+Copyright:: (c) Autotelik Media Ltd 2012
+
+Author ::   Tom Statter
+
+Date ::     Dec 2012
+
+The 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/VERSION

@@ -0,0 +1 @@
+0.1.0

data/datashift_spree.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('../lib/', __FILE__)
+puts lib
+$:.unshift '.' 
+$:.unshift lib unless $:.include?(lib)
+
+require 'rake'
+  
+require 'datashift_spree'
+
+Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = DataShift::SpreeHelper::gem_name
+  s.version = DataShift::SpreeHelper::gem_version
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Thomas Statter"]
+  s.date = "2012-09-10"
+  s.description = "Comprehensive tools to import/export between Excel/CSV and ActiveRecord databases, Rails apps, and any Ruby project"
+  s.email = "rubygems@autotelik.co.uk"
+  
+  s.files = FileList["datashift_spree.thor", 
+    "README.markdown",
+    "datashift_spree.gemspec",
+    'VERSION', 
+    "LICENSE.txt", 
+    "{lib,spec}/**/*"].exclude("rdoc").exclude("nbproject").exclude("fixtures").exclude(".log").exclude(".contrib").to_a
+  
+  s.homepage = "http://github.com/autotelik/datashift"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Shift data betwen Excel/CSV and Ruby"
+  
+  s.add_dependency(%q<datashift>, [">= 0.9.0"])
+end
+

data/datashift_spree.thor

@@ -0,0 +1,52 @@
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2010
+#
+# License::   MIT - Free, OpenSource
+#
+# Details::   Gem::Specification for DataShift Spree gem.
+#
+#             Provides support for moving data between .xls (Excel/OpenOffice)
+#             Spreedsheets and CSV files specifically tailored for uploading or exporting
+#             Spree Products, associations and Images
+
+
+class DatashiftSpree < Thor
+  
+  desc 'build', 'Build gem '
+  
+  method_option :version, :required => true, :aliases => '-v', :desc => "YAML config containing static definitions"
+  method_option :push, :aliases => '-p', :desc => "Push most recent gem to rubygems"
+  method_option :install, :aliases => '-i', :desc => "Run gem install on the built gems"
+
+  def build()
+
+    $:.unshift '.'  # 1.9.3 quite strict, '.' must be in load path for relative paths to work from here
+
+    gemspec = 'datashift_spree.gemspec'
+
+    # Bump the VERSION file
+   
+    system("echo #{options[:version]} > VERSION ") if(options[:version])
+
+    puts "Will build gem #{gemspec}"
+      
+    system("gem build #{gemspec}") 
+       
+    glob = options[:version] ? "datashift_spree-#{options[:version]}.gem" : "datashift_spree-*.gem"
+    
+    files = Dir[glob].sort_by { |f|File.mtime(f) }
+    files.reject! { |f| (File.file?(f) ? false : true) }
+    recent = files.reverse[0]
+      
+    if(options[:install] && recent)         
+      puts recent
+      system("gem install --no-ri --no-rdoc #{recent}")
+    end
+    
+     if(options[:push] && recent) 
+      system("gem push #{recent}")
+     end
+  end
+
+end

data/lib/datashift_spree.rb

@@ -0,0 +1,118 @@
+# Copyright:: (c) Autotelik Media Ltd 2010 - 2012 Tom Statter
+# Author ::   Tom Statter
+# Date ::     Aug 2012
+# License::   Free, Open Source.
+#
+# 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.
+#++
+
+
+# Details::   Active Record Loader
+# 
+# To pull DataShift commands into your main Spree application :
+#
+#     require 'datashift_spree'
+#
+#     DataShift::SpreeHelper::load_commands
+#
+require 'rbconfig'
+
+module DataShift
+
+  module SpreeHelper
+    
+  def self.gem_version
+    unless(@gem_version)
+      if(File.exists?(File.join(root_path, 'VERSION') ))
+        File.read( File.join(root_path, 'VERSION') ).match(/.*(\d+.\d+.\d+)/)
+        @gem_version = $1
+      else
+        @gem_version = '1.0.0'
+      end
+    end
+    @gem_version
+  end
+
+  def self.gem_name
+    "datashift_spree"
+  end
+
+  def self.root_path
+    File.expand_path("#{File.dirname(__FILE__)}/..")
+  end
+
+  def self.library_path
+    File.expand_path("#{File.dirname(__FILE__)}/../lib")
+  end
+  
+  def self.require_libraries
+    
+    loader_libs = %w{ lib  }
+
+    # Base search paths - these will be searched recursively
+    loader_paths = []
+
+    loader_libs.each {|l| loader_paths << File.join(root_path(), l) }
+
+    # Define require search paths, any dir in here will be added to LOAD_PATH
+
+    loader_paths.each do |base|
+      $:.unshift base  if File.directory?(base)
+      Dir[File.join(base, '**', '**')].each do |p|
+        if File.directory? p
+          $:.unshift p
+        end
+      end
+    end
+    
+    require_libs = %w{ loaders helpers }
+    require_libs.each do |base|
+      Dir[File.join(library_path, base, '**/*.rb')].each do |rb|
+        unless File.directory? rb
+         # require rb
+        end
+      end
+    end
+
+  end
+
+  # Load all the datashift rake tasks and make them available throughout app
+  def self.load_tasks
+    # Long parameter lists so ensure rake -T produces nice wide output
+    ENV['RAKE_COLUMNS'] = '180'
+    base = File.join(root_path, 'tasks', '**')
+    Dir["#{base}/*.rake"].sort.each { |ext| load ext }
+  end
+
+  
+  # Load all the datashift Thor commands and make them available throughout app
+
+  def self.load_commands()
+    base = File.join(library_path, 'thor', '**')
+    
+    Dir["#{base}/*.thor"].each do |f|
+      next unless File.file?(f)
+      Thor::Util.load_thorfile(f)
+    end
+  end
+  end
+end
+
+DataShift::SpreeHelper::require_libraries

data/lib/datashift_spree_helper.rb

@@ -0,0 +1,32 @@
+# Copyright:: (c) Autotelik Media Ltd 2010 - 2012 Tom Statter
+# Author ::   Tom Statter
+# Date ::     Aug 2012
+# License::   Free, Open Source.
+#
+# 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.
+#++
+
+require 'datashift'
+
+require 'datashift_spree'
+require 'helpers/spree_helper'
+
+require 'loaders/spree/product_loader'
+require 'loaders/spree/image_loader'

data/lib/helpers/spree_helper.rb

@@ -0,0 +1,74 @@
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Aug 2011
+# License::   MIT
+#
+# Details::   Spree Helper for Product Loading. 
+# 
+#             Utils to try to manage different Spree versions seamlessly.
+#             
+#             Spree Helper for RSpec testing, enables mixing in Support for
+#             testing or loading Rails Spree e-commerce.
+# 
+#             The Spree version you want to test should be picked up from spec/Gemfile
+# 
+#             Since datashift gem is not a Rails app or a Spree App, provides utilities to internally
+#             create a Spree Database, and to load Spree components, enabling standalone testing.
+#
+# =>          Has been tested with  0.11.2, 0.7, 1.0.0
+#
+# =>          TODO - See if we can improve DB creation/migration ....
+#             N.B Some or all of Spree Tests may fail very first time run,
+#             as the database is auto generated
+# =>          
+require 'spree'
+require 'spree_core'
+    
+module DataShift
+    
+  module SpreeHelper
+        
+    def self.root
+      Gem.loaded_specs['spree_core'] ? Gem.loaded_specs['spree_core'].full_gem_path  : ""
+    end
+    
+    # Helpers so we can cope with both pre 1.0 and post 1.0 versions of Spree in same datashift version
+
+    def self.get_spree_class(x)
+      if(is_namespace_version())    
+        ModelMapper::class_from_string("Spree::#{x}")
+      else
+        ModelMapper::class_from_string(x.to_s)
+      end
+    end
+      
+    def self.get_product_class
+      if(is_namespace_version())
+        Object.const_get('Spree').const_get('Product')
+      else
+        Object.const_get('Product')
+      end
+    end
+    
+    def self.version
+      Gem.loaded_specs['spree'] ? Gem.loaded_specs['spree'].version.version : "0.0.0"
+    end
+    
+    def self.is_namespace_version
+      SpreeHelper::version.to_f >= 1
+    end
+  
+    def self.lib_root
+      File.join(root, 'lib')
+    end
+
+    def self.app_root
+      File.join(root, 'app')
+    end
+
+    def self.load()
+      require 'spree'
+      require 'spree_core'
+    end   
+  end
+end 

data/lib/loaders/spree/image_loader.rb

@@ -0,0 +1,74 @@
+# Copyright:: (c) Autotelik Media Ltd 2011
+# Author ::   Tom Statter
+# Date ::     Jan 2011
+# License::   MIT. Free, Open Source.
+#
+require 'loader_base'
+#require 'paperclip/attachment_loader'
+
+module DataShift
+
+
+  module SpreeHelper
+     
+    # TODO - extract this out of SpreeHelper to create  a general paperclip loader
+    class ImageLoader < LoaderBase
+
+#      include DataShift::SpreeImageLoading
+      include DataShift::CsvLoading
+      include DataShift::ExcelLoading
+      
+      def initialize(image = nil, options = {})
+        
+        opts = options.merge(:load => false)  # Don't need operators and no table Spree::Image
+
+        super( DataShift::SpreeHelper::get_spree_class('Image'), image, opts )
+        
+        if(DataShift::SpreeHelper::version.to_f > 1.0 )
+          @attachment_klazz  = DataShift::SpreeHelper::get_spree_class('Variant' )
+        else
+          @attachment_klazz  = DataShift::SpreeHelper::get_spree_class('Product' )
+        end
+        
+        puts "Attachment Class is #{@attachment_klazz}" if(@verbose)
+          
+        raise "Failed to create Image for loading" unless @load_object
+      end
+      
+      def process()
+
+        if(current_value && @current_method_detail.operator?('attachment') )
+          
+          # assign the image file data as an attachment
+          @load_object.attachment = get_file(current_value)
+          
+          puts "Image attachment created : #{@load_object.inspect}"
+              
+        elsif(current_value && @current_method_detail.operator )    
+          
+          # find the db record to assign our Image to
+          add_record( get_record_by(@attachment_klazz, @current_method_detail.operator, current_value) )
+                
+        end
+          
+      end
+    
+      def add_record(record)
+        if(record)
+          if(SpreeHelper::version.to_f > 1 )
+            @load_object.viewable = record
+          else
+            @load_object.viewable = record.product   # SKU stored on Variant but we want it's master Product
+          end
+          @load_object.save
+          puts "Image viewable set : #{record.inspect}"
+          
+        else
+          puts "WARNING - Cannot set viewable - No matching record supplied"
+          logger.error"Failed to find a matching record"
+        end
+      end
+    end
+          
+  end
+end