solidus_content 0.1.0

data/lib/solidus_content.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_support'
+
+require 'solidus_content/version'
+require 'solidus_content/engine'
+require 'solidus_content/configuration'
+require 'solidus_content/providers'
+require 'solidus_content/active_record'

data/lib/solidus_content/active_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SolidusContent
+  def self.table_name_prefix
+    'solidus_content_'
+  end
+end

data/lib/solidus_content/configuration.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+
+module SolidusContent
+  class Configuration
+    UnknownProvider = Class.new(StandardError)
+
+    # Register of content-providers, use symbols for keys and callables as
+    # values. Each content-provider will be called passing the `entry_options:`
+    # and `entry_type_options:`.
+    def providers
+      @providers ||= Hash.new do |_hash, key|
+        raise UnknownProvider, "Can't find a provider for #{key.inspect}"
+      end
+    end
+
+    # Set to true to prevent SolidusContent from adding the default route.
+    # See also the README and config/routes.rb.
+    attr_accessor :skip_default_route
+
+    def register_provider(name, provider)
+      if provider.is_a? Symbol
+        require "solidus_content/providers/#{provider.to_s.underscore}"
+        provider = SolidusContent::Providers.const_get(provider)
+      end
+      providers[name.to_sym] = provider
+    end
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield config
+  end
+end

data/lib/solidus_content/engine.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spree/core'
+require 'solidus_content'
+
+module SolidusContent
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace ::Spree
+
+    engine_name 'solidus_content'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/solidus_content/factories.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :entry_type, class: SolidusContent::EntryType do
+    sequence(:name) { |n| "entry_type_#{n}" }
+    options { {} }
+    provider_name { :json }
+  end
+
+  factory :entry, class: SolidusContent::Entry do
+    entry_type
+  end
+end

data/lib/solidus_content/providers.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SolidusContent
+  # This module will be the namespace for default providers
+  module Providers
+  end
+
+  def self.provider_names
+    SolidusContent.config.providers.keys
+  end
+
+  def self.human_provider_name(name)
+    I18n.t("solidus_content.providers.#{name}")
+  end
+
+  # Register all the default providers
+  config.register_provider :json, :JSON
+  config.register_provider :raw, :RAW
+  config.register_provider :yaml, :YAML
+  config.register_provider :contentful, :Contentful
+  config.register_provider :prismic, :Prismic
+  config.register_provider :solidus_static_content, :SolidusStaticContent
+end

data/lib/solidus_content/providers/contentful.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SolidusContent
+  module Providers
+    class Contentful
+      class << self
+        def call(input)
+          require 'contentful' unless defined?(::Contentful)
+
+          type_options = input.dig(:type_options)
+
+          client = ::Contentful::Client.new(
+            space: type_options[:contentful_space_id],
+            access_token: type_options[:contentful_access_token],
+          )
+
+          entry = client.entry(input.dig(:options, :entry_id))
+
+          input.merge(
+            data: entry.fields,
+            provider_client: client,
+            provider_entry: entry,
+          )
+        end
+
+        def entry_type_fields
+          %i[contentful_space_id contentful_access_token]
+        end
+
+        def entry_fields
+          %i[entry_id]
+        end
+      end
+    end
+  end
+end

data/lib/solidus_content/providers/json.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module SolidusContent
+  module Providers
+    class JSON
+      class << self
+        def call(input)
+          dir = Rails.root.join(input.dig(:type_options, :path))
+          file = dir.join(input[:slug] + '.json')
+          data = ::JSON.parse(file.read, symbolize_names: true)
+
+          input.merge(data: data)
+        end
+
+        def entry_type_fields
+          %i[path]
+        end
+
+        def entry_fields
+          []
+        end
+      end
+    end
+  end
+end

data/lib/solidus_content/providers/prismic.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SolidusContent
+  module Providers
+    class Prismic
+      class << self
+        def call(input)
+          require 'prismic' unless defined?(::Prismic)
+
+          type_options = input.dig(:type_options)
+
+          client = ::Prismic.api(
+            type_options[:api_entry_point],
+            type_options.dig(:api_token)
+          )
+
+          entry = client.getByID(input.dig(:options, :id))
+
+          input.merge(
+            data: entry.fields,
+            provider_client: client,
+            provider_entry: entry,
+          )
+        end
+
+        def entry_type_fields
+          %i[api_entry_point api_token]
+        end
+
+        def entry_fields
+          %i[id]
+        end
+      end
+    end
+  end
+end

data/lib/solidus_content/providers/raw.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Let the content come from the entry itself.
+module SolidusContent
+  module Providers
+    class RAW
+      class << self
+        def call(input)
+          input.merge(data: input[:options])
+        end
+
+        def entry_type_fields
+          []
+        end
+
+        def entry_fields
+          []
+        end
+      end
+    end
+  end
+end

data/lib/solidus_content/providers/solidus_static_content.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SolidusContent
+  module Providers
+    class SolidusStaticContent
+      class << self
+        def call(input)
+          slug = input.dig(:options, :slug) || input[:slug]
+
+          input.merge(data: Spree::Page.find_by!(slug: slug).attributes.symbolize_keys)
+        end
+
+        def entry_type_fields
+          []
+        end
+
+        def entry_fields
+          %i[slug]
+        end
+      end
+    end
+  end
+end

data/lib/solidus_content/providers/yaml.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module SolidusContent
+  module Providers
+    class YAML
+      class << self
+        def call(input)
+          dir = Rails.root.join(input.dig(:type_options, :path))
+          file = dir.join(input[:slug] + '.yml')
+          file = dir.join(input[:slug] + '.yaml') unless file.exist?
+
+          data = load(file)
+
+          input.merge(data: data)
+        end
+
+        def load(file)
+          ::YAML.load_file(file).symbolize_keys
+        end
+
+        def entry_type_fields
+          %i[path]
+        end
+
+        def entry_fields
+          []
+        end
+      end
+    end
+  end
+end

data/lib/solidus_content/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidusContent
+  VERSION = '0.1.0'
+end

data/solidus_content.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/solidus_content/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'solidus_content'
+  spec.version = SolidusContent::VERSION
+  spec.authors = ['Andrea Vassallo', 'Elia Schito']
+  spec.email = 'contact@solidus.io'
+
+  spec.summary = 'Manage your Solidus content sources'
+  spec.description = ''
+  spec.homepage = 'https://github.com/nebulab/solidus_content#readme'
+  spec.license = 'BSD-3-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/nebulab/solidus_content#readme'
+  spec.metadata['changelog_uri'] = 'https://github.com/nebulab/solidus_content/releases'
+
+  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
+  spec.add_dependency 'solidus_support', '~> 0.5'
+
+  spec.add_development_dependency 'solidus_dev_support'
+end

data/spec/features/admin/content/create_entry_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'Create entry', :js do
+  let(:admin_user) { create(:admin_user) }
+  let!(:entry_type) { create(:entry_type, provider_name: :raw) }
+
+  before do
+    login_as admin_user
+
+    visit spree.new_admin_entry_path
+  end
+
+  context 'with the correct information' do
+    it 'creates the entry type' do
+      expect {
+        click_on 'Create'
+      }.to change(SolidusContent::Entry, :count).by(1)
+      expect(SolidusContent::Entry.last.entry_type).to eq(entry_type)
+    end
+  end
+
+  context 'with the incorrect information' do
+    it 'shows error messages' do
+      expect {
+        fill_in 'solidus_content_entry_slug', with: ''
+        click_on 'Create'
+      }.not_to change(SolidusContent::EntryType, :count)
+
+      within '#errorExplanation' do
+        expect(page).to have_text("Slug can't be blank")
+      end
+    end
+  end
+end

data/spec/features/admin/content/create_entry_type_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'Create entry type', :js do
+  let(:admin_user) { create(:admin_user) }
+
+  before do
+    login_as admin_user
+
+    visit spree.new_admin_entry_type_path
+  end
+
+  context 'with the correct information' do
+    it 'creates the entry type' do
+      fill_in 'solidus_content_entry_type_name', with: 'Entry name'
+      find('#solidus_content_entry_type_provider_name').find(:xpath, 'option[2]').select_option
+
+      expect {
+        click_on 'Create'
+      }.to change(SolidusContent::EntryType, :count).by(1)
+    end
+  end
+
+  context 'with the incorrect information' do
+    it 'shows error messages' do
+      expect {
+        click_on 'Create'
+      }.not_to change(SolidusContent::EntryType, :count)
+
+      within '#errorExplanation' do
+        expect(page).to have_text("Name can't be blank")
+      end
+    end
+  end
+end

data/spec/features/admin/content/delete_entry_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'Delete entry', :js do
+  let(:admin_user) { create(:admin_user) }
+
+  before do
+    login_as admin_user
+
+    create(:entry)
+    visit spree.admin_entries_path
+  end
+
+  it 'deletes entry' do
+    expect {
+      accept_confirm { find('.delete-entry').click }
+    }.to change(SolidusContent::Entry, :count).from(1).to(0)
+  end
+end