solidus_prismic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7de04219212949a3f62aabd1878861ae382e4699
+  data.tar.gz: 993c76e94a0cdc14f9149f4570728115b44ad9c9
+SHA512:
+  metadata.gz: 1bc896500242600e6bf059b32ac97793931bee687be4f111ba3edac513575c097022177f505aee8ca2ea16b9165f2c55ea976ead0d6e415abdd00e2b946a1a0b
+  data.tar.gz: dac6f867f1ba5d92f9f4c5d87d829bea83aaced8b793af53f5cbf344170e082160c2f638762199541801e30e95f2968d29cbeff4a92da38e6c662b7b2c19cc63

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2017 Deseret Book
+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,157 @@
+# Solidus Prismic
+
+[Prismic.io](https://prismic.io) Client for use in Solidus based applications.
+Prismic is a CMS Backend that can be used to suplement your site with additional
+content. That content can be updated through Prismic allowing you to make changes
+to your site without a deploy.
+
+## Installation
+
+Add solidus_prismic to your Gemfile:
+
+```ruby
+gem 'solidus_prismic'
+```
+
+Then, run bundle install.
+
+Create an account and repository at [Prismic.io](https://prismic.io)
+
+After that's done, you need to set additional environment variables:
+```
+# These values are found at: https://yourapp.prismic.io/settings/apps/
+PRISMIC_API_URL=https://yourapp.prismic.io/api # Required
+PRISMIC_ACCESS_TOKEN=123FAKE456 # Only required if using a private API or preview refs
+```
+
+## Example
+
+_NOTE: This is an example of one way to use Prismic to add content to your sites.
+You can do any number of things as long as you can model the data in Prismic and
+set up a mechanism to render it in your store. This is an example of adding custom
+content to a Product page._
+
+Create a Repeatable Custom Type in Prismic called `Products`
+
+Edit the Product Type using the JSON editor tab on the right and paste this:
+
+```
+{
+  "Main" : {
+    "uid" : {
+      "type" : "UID",
+      "config" : {
+        "label" : "Product Slug",
+        "placeholder" : "Product Slug"
+      }
+    },
+    "title" : {
+      "type" : "StructuredText",
+      "config" : {
+        "single" : "heading1",
+        "label" : "Title",
+        "placeholder" : "title"
+      }
+    },
+    "description" : {
+      "type" : "StructuredText",
+      "config" : {
+        "multi" : "paragraph, preformatted, heading1, heading2, heading3, heading4, heading5, heading6, strong, em, hyperlink, image, embed, list-item, o-list-item, o-list-item",
+        "label" : "Description",
+        "placeholder" : "Description"
+      }
+    }
+  }
+}
+```
+
+The UID field which will translate to the Product Slug in Solidus as a unique identifier and label.
+The Title field gives allows for a custom Product Title
+The Description field gives allows for a custom Product Description
+
+Hit Save at the top.
+
+Go to your Solidus app
+
+Add `include PrismicHelper` to `Spree::ProductsController`:
+
+```
+# app/controllers/spree/products_controller_decorator.rb
+
+Spree::ProductsController.class_eval do
+  include PrismicHelper
+
+  before_action :get_prismic_documents, only: :show
+
+  ##
+  # Retrieve Prismic Document for the current @product
+  #
+  def get_prismic_documents
+    @prismic_document = prismic_api.get_by_uid 'products', @product.slug
+  end
+end
+```
+
+Now that you have your Prismic Document you can add that custom data to your Product page:
+
+```
+<%# views/spree/products/show.html.erb %>
+
+<% cache [I18n.locale, current_pricing_options, @product] do %>
+  <div data-hook="product_show" itemscope itemtype="http://schema.org/Product">
+    <% @body_id = 'product-details' %>
+
+    <div class="columns six alpha" data-hook="product_left_part">
+      ...
+    </div>
+
+    <div class="columns ten omega" data-hook="product_right_part">
+      <div class="row" data-hook="product_right_part_wrap">
+
+        <div id="product-description" data-hook="product_description">
+
+          <!-- Check for Custom Prismic Data or render from Database -->
+          <h1 class="product-title" itemprop="name">
+            <% if @prismic_document&.fragments['title'].present? %>
+              <%= @prismic_document.fragments['title'].as_text %>
+            <% else %>
+              <%= @product.name %>
+            <% end %>
+          </h1>
+
+          <div itemprop="description" data-hook="description">
+            <% if @prismic_document&.fragments['description'].present? %>
+              <%= @prismic_document.fragments['description'].as_text %>
+            <% else %>
+              <%= product_description(@product) rescue Spree.t(:product_has_no_description) %>
+            <% end %>
+          </div>
+          <!-- End Prismic -->
+
+          <div id="cart-form" data-hook="cart_form">
+            <%= render partial: 'cart_form' %>
+          </div>
+
+        </div>
+
+        <%= render partial: 'taxons' %>
+
+      </div>
+    </div>
+
+  </div>
+<% end %>
+```
+
+Use the `include PrismicHelper` on any file that you want to retrieve Prismic data from.
+
+## 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, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+Copyright (c) 2017 Deseret Book, released under the New BSD License

data/Rakefile

@@ -0,0 +1,30 @@
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+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
+  ENV['LIB_NAME'] = 'solidus_prismic'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/solidus_prismic.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/solidus_prismic.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/solidus_prismic.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/solidus_prismic.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/helpers/prismic_helper.rb

@@ -0,0 +1,70 @@
+module PrismicHelper
+  require 'prismic'
+
+  ##
+  # Setting @ref as the actual ref id being queried, even if it's the master ref.
+  # To be used to call the API, for instance: api.form('everything').submit(ref)
+  # If we fail to initialize the Prismic API we return the last successful ref
+  # stored in Rails cache
+  #
+  def prismic_ref
+    if api.nil?
+      @ref = Rails.cache.fetch('prismic_ref')
+    else
+      master_ref = api.master_ref.ref
+      Rails.cache.write('prismic_ref', master_ref)
+      @ref ||= preview_ref || experiment_ref || master_ref
+    end
+  end
+
+  ##
+  # Access and initialization of the Prismic::API object.
+  #
+  def prismic_api
+    prismic_url = ENV['PRISMIC_API_URL']
+    @api ||= Prismic.api(prismic_url, ENV['PRISMIC_ACCESS_TOKEN'])
+  rescue Prismic::API::PrismicWSConnectionError,
+         Prismic::API::BadPrismicResponseError,
+         Prismic::API::PrismicWSAuthError,
+         Net::OpenTimeout => e
+    Rails.logger.error e
+    @api = nil
+  end
+
+  private
+
+  ##
+  # Returns the ref of the user's Prismic preview token
+  #
+  def preview_ref
+    preview_token = params[:token]
+    if preview_token
+      cookies[Prismic::PREVIEW_COOKIE] = { value: preview_token, expires: 30.minutes.from_now }
+      preview_token
+    elsif request.cookies.key?(Prismic::PREVIEW_COOKIE)
+      request.cookies[Prismic::PREVIEW_COOKIE]
+    end
+  end
+
+  ##
+  # Returns the ref for the Prismic experiment the user is part of
+  #
+  def experiment_ref
+    experiments = api.experiments.current
+    if experiments
+      if request.cookies.key?(Prismic::EXPERIMENTS_COOKIE)
+        # If they are already placed into an experiment group use that
+        request.cookies[Prismic::EXPERIMENTS_COOKIE]
+      else
+        # Else assign them randomly to a group
+        ref = experiments.variations.sample.ref
+        cookies[Prismic::EXPERIMENTS_COOKIE] = { value: ref, expires: 1.year.from_now }
+        ref
+      end
+    else
+      # If there are no experiments remove the experiments cookie
+      cookies.delete Prismic::EXPERIMENTS_COOKIE
+      nil
+    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/solidus_prismic/install/install_generator.rb

@@ -0,0 +1,30 @@
+module SolidusPrismic
+  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/solidus_prismic\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_prismic\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_prismic\n", before: /\*\//, verbose: true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_prismic\n", before: /\*\//, verbose: true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_prismic'
+      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/solidus_prismic.rb

@@ -0,0 +1,2 @@
+require 'solidus_core'
+require 'solidus_prismic/engine'

data/lib/solidus_prismic/engine.rb

@@ -0,0 +1,20 @@
+module SolidusPrismic
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'solidus_prismic'
+
+    # 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/solidus_prismic/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 'solidus_prismic/factories'
+end

data/lib/solidus_prismic/version.rb

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

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: solidus_prismic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Saupe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  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: prismic.io
+  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: capybara
+  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: poltergeist
+  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: coffee-rails
+  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: sass-rails
+  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: database_cleaner
+  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: factory_girl
+  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: rspec-rails
+  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: rubocop
+  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: rubocop-rspec
+  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: simplecov
+  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: sqlite3
+  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: Solidus Client for communicating with Prismic.io
+email: esaupe@deseretbook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/solidus_prismic.js
+- app/assets/javascripts/spree/frontend/solidus_prismic.js
+- app/assets/stylesheets/spree/backend/solidus_prismic.css
+- app/assets/stylesheets/spree/frontend/solidus_prismic.css
+- app/helpers/prismic_helper.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/solidus_prismic/install/install_generator.rb
+- lib/solidus_prismic.rb
+- lib/solidus_prismic/engine.rb
+- lib/solidus_prismic/factories.rb
+- lib/solidus_prismic/version.rb
+homepage: https://www.deseretbook.com
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Solidus Prismic Client
+test_files: []