spree_surrogate_key 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c6ea271b15b5ef40e6ee826a99984032a6b460b434280f31b52e8c32e3a06fe
+  data.tar.gz: e258ced84ba8a4dd2bbc4a061236e7757b2350736dd32d2c549e446cb691449e
+SHA512:
+  metadata.gz: 4f06e4d128dcaf43527d45ed1aafbf7cf40ceddd000e34d70eec8ba70d96d59306caeb3220cdb5b519487e2a1f41e41b5e0eecf48d7d86198a0d1f487e4ee55d
+  data.tar.gz: 1b864aee685ff8bc44b09bff621dc9e46461b82500fc94d3e1fa051ea371daa72bcff17619ecb7c2bb9a496aa62b558eca6595eb08e9ac172d505216b147ebae

data/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: ci
+
+on: push
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    env:
+      DATABASE_HOST: 0.0.0.0
+      DATABASE_PASSWORD: mysql123
+      RAILS_ENV: test
+      REDIS_URL: redis://0.0.0.0:6379
+      TZ: Asia/Tokyo
+
+    services:
+      mysql:
+        image: mysql:8.0.23
+        options: --health-cmd "mysqladmin ping -h localhost" --health-interval 20s --health-timeout 10s --health-retries 10
+        env:
+          MYSQL_ROOT_PASSWORD: ${{ env.DATABASE_PASSWORD }}
+        ports:
+          - 3306:3306
+      redis:
+        image: redis:6.2-alpine
+        options: --health-cmd "redis-cli -h localhost ping" --health-interval 10s --health-timeout 5s --health-retries 15
+        ports:
+          - 6379:6379
+      webdriver_chrome:
+        image: selenium/standalone-chrome:95.0
+        ports:
+          - 4444:4444
+        options: "--shm-size 2g"
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 3.0.3
+
+      - name: Exec tests 👚
+        env:
+          DB_HOST: 127.0.0.1
+          DB_PASSWORD: ${{ env.DATABASE_PASSWORD }}
+          DB_USERNAME: root
+        run: |
+          bundle exec rake test_app
+          bundle exec rake spec

data/.gitignore

@@ -0,0 +1,25 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.localeapp/locales
+.project
+.vscode
+coverage
+default
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.sw?
+spec/dummy
+.rvmrc
+.sass-cache
+public/spree
+.ruby-version
+.ruby-gemset
+*.gem
+*/*.gem
+.bundle
+vendor/bundle

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-r spec_helper
+-f documentation

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+gem 'spree'
+# gem 'spree_backend', github: 'spree/spree', branch: 'main'
+gem 'rails-controller-testing'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2022 ROUTE06, Inc.
+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,56 @@
+# SpreeSurrogateKey
+
+A [Spree](https://github.com/spree/spree) extension that purge fastly surrogate key.
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    gem 'spree_surrogate_key'
+    ```
+
+2. Install the gem using Bundler
+
+    ```ruby
+    bundle install
+    ```
+
+3. Copy & run migrations
+
+    ```ruby
+    bundle exec rails g spree_surrogate_key:install
+    ```
+
+4. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle update
+bundle exec rake
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_surrogate_key/factories'
+```
+
+## Releasing
+
+```shell
+bundle exec gem bump -p -t
+bundle exec gem release
+```
+
+For more options please see [gem-release REAMDE](https://github.com/svenfuchs/gem-release)
+
+## Contributing
+
+Copyright (c) 2022  ROUTE06, Inc., released under the New BSD License

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_surrogate_key'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/models/concerns/spree_surrogate_key/cdn_purgeable.rb

@@ -0,0 +1,40 @@
+module SpreeSurrogateKey
+  module CdnPurgeable
+    extend ActiveSupport::Concern
+
+    included do
+      after_update_commit :purge_cdn_cache
+      after_touch :purge_cdn_cache
+    end
+
+    def purge_cdn_cache
+      return if @already_purged
+      purge_cdn_cache!
+    rescue StandardError => e
+      logger.error(e.message)
+    end
+
+    def purge_cdn_cache!
+      if cdn_api_enabled?
+        cdn_api.purge_by_key(cdn_surrogate_key)
+        @already_purged = true
+      end
+    end
+
+    def cdn_api
+      @cdn_api ||=
+        begin
+          fastly = Fastly.new(api_key: Rails.configuration.x.fastly[:api_key])
+          Fastly::Service.new({ id: Rails.configuration.x.fastly[:service_id] }, fastly)
+        end
+    end
+
+    def cdn_api_enabled?
+      Rails.configuration.x.fastly[:enabled]
+    end
+
+    def cdn_surrogate_key
+      raise NotImplementedError
+    end
+  end
+end

data/app/models/spree_surrogate_key/configuration.rb

@@ -0,0 +1,13 @@
+module SpreeSurrogateKey
+  class Configuration < Spree::Preferences::Configuration
+
+   # Some example preferences are shown below, for more information visit:
+   # https://dev-docs.spreecommerce.org/internals/preferences
+
+   preference :enabled, :boolean, default: true
+   # preference :dark_chocolate, :boolean, default: true
+   # preference :color, :string, default: 'Red'
+   # preference :favorite_number, :integer
+   # preference :supported_locales, :array, default: [:en]
+  end
+end

data/app/models/spree_surrogate_key/spree/option_type_decorator.rb

@@ -0,0 +1,16 @@
+module SpreeSurrogateKey::Spree::OptionTypeDecorator
+  def self.prepended(base)
+    base.include SpreeSurrogateKey::CdnPurgeable
+    base.before_destroy :purge_cdn_cache, prepend: true
+  end
+
+  private
+
+  def cdn_surrogate_key
+    products.map do |product|
+      "product-#{product.id}"
+    end.join(' ')
+  end
+end
+
+Spree::OptionType.prepend(SpreeSurrogateKey::Spree::OptionTypeDecorator) unless Spree::OptionType.included_modules.include?(SpreeSurrogateKey::Spree::OptionTypeDecorator)

data/app/models/spree_surrogate_key/spree/product_decorator.rb

@@ -0,0 +1,13 @@
+module SpreeSurrogateKey::Spree::ProductDecorator
+  def self.prepended(base)
+    base.include SpreeSurrogateKey::CdnPurgeable
+  end
+
+  private
+
+  def cdn_surrogate_key
+    "product-#{id}"
+  end
+end
+
+Spree::Product.prepend(SpreeSurrogateKey::Spree::ProductDecorator) unless Spree::Product.included_modules.include?(SpreeSurrogateKey::Spree::ProductDecorator)

data/app/models/spree_surrogate_key/spree/taxon_decorator.rb

@@ -0,0 +1,16 @@
+module SpreeSurrogateKey::Spree::TaxonDecorator
+  def self.prepended(base)
+    base.include SpreeSurrogateKey::CdnPurgeable
+    base.before_destroy :purge_cdn_cache, prepend: true
+  end
+
+  private
+
+  def cdn_surrogate_key
+    products.map do |product|
+      "product-#{product.id}"
+    end.join(' ')
+  end
+end
+
+Spree::Taxon.prepend(SpreeSurrogateKey::Spree::TaxonDecorator) unless Spree::Taxon.included_modules.include?(SpreeSurrogateKey::Spree::TaxonDecorator)

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" from the root of your extension
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_surrogate_key/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/fastly.yml

@@ -0,0 +1,13 @@
+default: &default
+  api_key: "dummy"
+  enabled: false
+  service_id: "dummy"
+
+test:
+  <<: *default
+
+development:
+  <<: *default
+
+production:
+  <<: *default

data/config/initializers/spree_surrogate_key.rb

@@ -0,0 +1,3 @@
+if Rails.root.join("config/fastly.yml").exist?
+  Rails.application.config.x.fastly = Rails.application.config_for(:fastly).deep_symbolize_keys
+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.add_routes do
+  # Add your extension routes here
+end

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

@@ -0,0 +1,25 @@
+module SpreeSurrogateKey
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../", __dir__)
+      class_option :migrate, type: :boolean, default: true
+
+      def copy_default_configuration_file
+        copy_file "config/fastly.yml"
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_surrogate_key'
+      end
+
+      def run_migrations
+        run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bundle exec rails db:migrate'
+        else
+          puts 'Skipping rails db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_surrogate_key/engine.rb

@@ -0,0 +1,24 @@
+module SpreeSurrogateKey
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_surrogate_key'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'spree_surrogate_key.environment', before: :load_config_initializers do |_app|
+      SpreeSurrogateKey::Config = SpreeSurrogateKey::Configuration.new
+    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/spree_surrogate_key/factories.rb

@@ -0,0 +1,6 @@
+FactoryBot.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 'spree_surrogate_key/factories'
+end

data/lib/spree_surrogate_key/version.rb

@@ -0,0 +1,11 @@
+module SpreeSurrogateKey
+  VERSION = '0.0.1'.freeze
+
+  module_function
+
+  # Returns the version of the currently loaded SpreeSurrogateKey as a
+  # <tt>Gem::Version</tt>.
+  def version
+    Gem::Version.new VERSION
+  end
+end

data/lib/spree_surrogate_key.rb

@@ -0,0 +1,5 @@
+require 'fastly'
+require 'spree_core'
+require 'spree_extension'
+require 'spree_surrogate_key/engine'
+require 'spree_surrogate_key/version'

data/spree_surrogate_key.gemspec

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'spree_surrogate_key/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_surrogate_key'
+  s.version     = SpreeSurrogateKey.version
+  s.summary     = 'Add extension summary here'
+  s.description = 'Add (optional) extension description here'
+  s.required_ruby_version = '>= 2.5'
+
+  s.author    = 'ROUTE06'
+  s.email     = 'development+rubygems@route06.co.jp'
+  s.homepage  = 'https://github.com/route06/spree_surrogate_key'
+  s.license   = 'BSD-3-Clause'
+
+  s.files       = `git ls-files`.split("\n").reject { |f| f.match(/^spec/) && !f.match(/^spec\/fixtures/) }
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'spree', '~> 4.3.1'
+  s.add_dependency 'rails', '~> 6.1.0'
+  # s.add_dependency 'spree_backend' # uncomment to include Admin Panel changes
+  s.add_dependency 'spree_extension'
+  s.add_dependency 'fastly'
+
+  s.add_development_dependency 'spree_dev_tools', '~> 0.1.12'
+  # net-smtp, net-imap and net-pop were removed from default gems in Ruby 3.1, but is used by the `mail` gem.
+  s.add_development_dependency 'net-smtp'
+  s.add_development_dependency 'mysql2'
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: spree_surrogate_key
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ROUTE06
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: spree_extension
+  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: fastly
+  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: spree_dev_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.12
+- !ruby/object:Gem::Dependency
+  name: net-smtp
+  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: mysql2
+  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: Add (optional) extension description here
+email: development+rubygems@route06.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/.gitkeep
+- app/controllers/.gitkeep
+- app/models/.gitkeep
+- app/models/concerns/spree_surrogate_key/cdn_purgeable.rb
+- app/models/spree_surrogate_key/configuration.rb
+- app/models/spree_surrogate_key/spree/option_type_decorator.rb
+- app/models/spree_surrogate_key/spree/product_decorator.rb
+- app/models/spree_surrogate_key/spree/taxon_decorator.rb
+- app/serializers/.gitkeep
+- app/services/.gitkeep
+- bin/rails
+- config/fastly.yml
+- config/initializers/spree_surrogate_key.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/spree_surrogate_key/install/install_generator.rb
+- lib/spree_surrogate_key.rb
+- lib/spree_surrogate_key/engine.rb
+- lib/spree_surrogate_key/factories.rb
+- lib/spree_surrogate_key/version.rb
+- spree_surrogate_key.gemspec
+homepage: https://github.com/route06/spree_surrogate_key
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Add extension summary here
+test_files: []