spree_order_reporting 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d43a65960efeb542d22489ce40233395a4acef38
+  data.tar.gz: e9915012a7fece1f04dd87f329a0379d92de56a5
+SHA512:
+  metadata.gz: 4eb8a3c14f76b55a4398c1aa52f698dc346fc83659dc6239c62ca50bd202b720b21226ae37896eb8ba38605536ab74cea6c29533f7f0f3f84aa16ba4b1fc63af
+  data.tar.gz: 18381f2337e8fe1aea412d3c98aeb0d180f7b4742b568fefae24fd144d2849fdafa7f473134a80fbc315f055a199b6e57eceec4dc38bab42bd247018214f473a

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2016 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,100 @@
+# Order Reporting for Spree and Solidus
+
+[![Build Status](https://travis-ci.org/madetech/order_reporting.svg?branch=master)](https://travis-ci.org/madetech/order_reporting)
+
+Automatically sends lists of orders via email based on criteria.
+
+## Installing in Spree app
+
+Add this to your Gemfile:
+
+```
+gem 'spree_order_reporting'
+```
+
+## Installing in Solidus app
+
+Add this to your Gemfile:
+
+```
+gem 'solidus_order_reporting'
+```
+
+## Setup
+
+Three steps to configure:
+
+1. Setup gem with initializer
+2. Create mailer and template
+3. Create query object for selecting orders
+
+### 1. Setup gem with initializer
+
+Create an application initializer in `config/initializers/order_reporting.rb`:
+
+``` ruby
+OrderReporting.mailer_class = OrderReportMailer
+OrderReporting.scheduler = OrderReporting::DelayedJobScheduler.new
+
+OrderReporting.define_report :exported_orders do |config|
+  config.send_every = 24.hours
+  config.query = ExportedOrdersQuery.new
+end
+```
+
+### 2. Create mailer and template
+
+```ruby
+class OrderReportMailer < ActionMailer::Base
+  def exported_orders(orders)
+    @orders = orders
+    mail(to: 'cs@shop.com', subject: 'Exported Orders')
+  end
+end
+```
+
+### 3. Create query object for selecting orders
+
+```ruby
+class ExportedOrdersQuery
+  def orders
+    Spree::Order.exported.where('completed_at > ?', 24.hours.ago)
+  end
+end
+```
+
+## Development
+
+Run spree tests:
+
+```
+rm -rf spec/dummy/
+BUNDLE_GEMFILE=Gemfile.spree.rb bundle
+BUNDLE_GEMFILE=Gemfile.spree.rb bundle exec rake
+```
+
+Run solidus tests:
+
+```
+rm -rf spec/dummy/
+BUNDLE_GEMFILE=Gemfile.solidus.rb bundle
+BUNDLE_GEMFILE=Gemfile.solidus.rb bundle exec rake
+```
+
+## Publishing
+
+Before publishing you will need to have created a new release. To do so update `lib/order_reporting/version.rb` to new version number and commit this change as "New release vx.x.x". Then tag this commit with ```git tag vx.x.x``` and push it `git push origin vx.x.x`. Then you need to publish to RubyGems...
+
+Publish Spree gem:
+
+```
+gem build spree_order_reporting.gemspec
+gem publish spree_order_reporting-x.x.x.gem
+```
+
+Publish Solidus gem:
+
+```
+gem build solidus_order_reporting.gemspec
+gem publish solidus_order_reporting-x.x.x.gem
+```

data/Rakefile

@@ -0,0 +1,38 @@
+require 'bundler'
+
+begin
+  require 'spree/testing_support/extension_rake'
+  require 'rubocop/rake_task'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  RuboCop::RakeTask.new
+
+  task default: %i(first_run rubocop spec)
+rescue LoadError
+  # no rspec available
+end
+
+task :first_run do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  case ENV['BUNDLE_GEMFILE']
+  when /spree/
+    ENV['LIB_NAME'] = 'spree_order_reporting'
+  when /solidus/
+    ENV['LIB_NAME'] = 'solidus_order_reporting'
+  else
+    raise 'Specify BUNDLE_GEMFILE'
+  end
+
+  Rake::Task['extension:test_app'].invoke
+  system 'bundle exec rails g delayed_job:active_record'
+  system 'bundle exec rake db:migrate'
+end

data/app/assets/javascripts/spree/backend/order_reporting.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'

data/app/assets/javascripts/spree/frontend/order_reporting.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/order_reporting.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

data/app/assets/stylesheets/spree/frontend/order_reporting.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/jobs/order_reporting/recurring_report_delayed_job.rb

@@ -0,0 +1,11 @@
+module OrderReporting
+  RecurringReportJob = Struct.new(:scheduler, :report, :options)
+
+  class RecurringReportDelayedJob < RecurringReportJob
+    def perform
+      report.send_report
+    ensure
+      scheduler.schedule(report, options)
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: Hello world

data/config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+end

data/lib/generators/order_reporting/install/install_generator.rb

@@ -0,0 +1,30 @@
+module OrderReporting
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/order_reporting\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/order_reporting\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/order_reporting\n", before: /\*\//, verbose: true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/order_reporting\n", before: /\*\//, verbose: true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=order_reporting'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/order_reporting.rb

@@ -0,0 +1,27 @@
+require 'order_reporting/engine'
+require 'order_reporting/report'
+require 'order_reporting/schedulers/delayed_job_scheduler'
+require 'order_reporting/queries/latest_orders_query'
+
+module OrderReporting
+  extend self
+
+  attr_accessor :scheduler
+  attr_accessor :mailer_class
+
+  def define_report(name)
+    @reports ||= {}
+    @reports[name] = OpenStruct.new(name: name)
+    yield @reports[name]
+    setup_recurring_report(name)
+  end
+
+  def setup_recurring_report(name)
+    return unless @reports[name].respond_to?(:send_every)
+    scheduler.schedule(Report.new(name), self[name])
+  end
+
+  def [](name)
+    @reports[name]
+  end
+end

data/lib/order_reporting/engine.rb

@@ -0,0 +1,20 @@
+module OrderReporting
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'order_reporting'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/order_reporting/factories.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'order_reporting/factories'
+end

data/lib/order_reporting/queries/latest_orders_query.rb

@@ -0,0 +1,7 @@
+module OrderReporting
+  class LatestOrdersQuery
+    def orders
+      Spree::Order.complete.where('updated_at > ?', 24.hours.ago)
+    end
+  end
+end

data/lib/order_reporting/report.rb

@@ -0,0 +1,25 @@
+module OrderReporting
+  class Report
+    def initialize(name)
+      @name = name
+    end
+
+    def send_report
+      orders.tap { |orders| mailer.send(@name, orders) }
+    end
+
+    private
+
+    def mailer
+      report[:mailer_class] || OrderReporting.mailer_class
+    end
+
+    def orders
+      report[:query].orders
+    end
+
+    def report
+      OrderReporting[@name]
+    end
+  end
+end

data/lib/order_reporting/schedulers/delayed_job_scheduler.rb

@@ -0,0 +1,8 @@
+module OrderReporting
+  class DelayedJobScheduler
+    def schedule(report, options)
+      job = RecurringReportDelayedJob.new(self, report, options)
+      Delayed::Job.enqueue(job, run_at: options[:send_every].from_now)
+    end
+  end
+end

data/lib/order_reporting/version.rb

@@ -0,0 +1,3 @@
+module OrderReporting
+  VERSION = '0.0.1'
+end

data/lib/solidus_order_reporting.rb

@@ -0,0 +1,2 @@
+require 'solidus_core'
+require 'order_reporting'

data/lib/spree_order_reporting.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'order_reporting'

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>