solidus_content 0.1.0

data/spec/solidus_content/configuration_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusContent::Configuration do
+  subject(:configuration) { described_class.new }
+
+  describe '#providers' do
+    context 'without a configuration' do
+      it 'is an empty hash' do
+        expect(configuration.providers).to eq({})
+      end
+    end
+
+    context 'with a configuration' do
+      let(:foo_provider) { double(:foo_provider) }
+
+      before { configuration.providers[:foo] = foo_provider }
+
+      context 'when asking for an existing configuration' do
+        it 'returns the configuration' do
+          expect(configuration.providers[:foo]).to eq(foo_provider)
+        end
+      end
+
+      context 'when asking for a not existing configuration' do
+        it 'returns the configuration' do
+          expect { configuration.providers[:bar] }
+            .to raise_error(
+              SolidusContent::Configuration::UnknownProvider,
+              "Can't find a provider for :bar"
+            )
+        end
+      end
+    end
+  end
+end

data/spec/solidus_content/providers/contentful_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusContent::Providers::Contentful do
+  describe '.entry_type_fields' do
+    subject { described_class.entry_type_fields }
+
+    it { is_expected.to eq(%i[contentful_space_id contentful_access_token]) }
+  end
+
+  describe '.call' do
+    subject do
+      described_class.call(
+        type_options: {
+          contentful_space_id: contentful_space_id,
+          contentful_access_token: contentful_access_token
+        },
+        options: {
+          entry_id: entry_id
+        }
+      )
+    end
+
+    let(:contentful_space_id) { 'contentful_space_id' }
+    let(:contentful_access_token) { 'contentful_access_token' }
+    let(:entry_id) { 'entry_id' }
+
+    let(:contentful) { instance_double(Contentful::Client) }
+    let(:entry) { instance_double(Contentful::Entry) }
+    let(:data) { instance_double(Hash) }
+
+    before do
+      allow(Contentful::Client)
+        .to receive(:new)
+        .and_return(contentful)
+
+      allow(contentful)
+        .to receive(:entry)
+        .and_return(entry)
+
+      allow(entry).to receive(:fields).and_return(data)
+    end
+
+    it 'returns data using Contentful client' do
+      expect(Contentful::Client)
+        .to receive(:new)
+        .with(space: contentful_space_id, access_token: contentful_access_token)
+        .and_return(contentful)
+
+      expect(contentful).to receive(:entry).with(entry_id).and_return(entry)
+
+      expect(subject[:data]).to eq(data)
+    end
+  end
+end

data/spec/solidus_content/providers/json_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusContent::Providers::JSON do
+  describe '.entry_type_fields' do
+    subject { described_class.entry_type_fields }
+
+    it { is_expected.to eq(%i[path]) }
+  end
+
+  context 'with an absolute path' do
+    let(:path) { File.absolute_path('content', FIXTURE_PATH) }
+
+    it 'uses the absolute path as is' do
+      expect(described_class.call(
+        slug: 'example',
+        type_options: { path: path },
+      )[:data]).to eq(foo: 'json_bar')
+    end
+  end
+
+  context 'with a relative path' do
+    before { allow(Rails).to receive(:root).and_return(Pathname(FIXTURE_PATH)) }
+
+    it 'uses the absolute path as is' do
+      expect(described_class.call(
+        slug: 'example',
+        type_options: { path: 'content' },
+      )[:data]).to eq(foo: 'json_bar')
+    end
+  end
+end

data/spec/solidus_content/providers/prismic_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusContent::Providers::Prismic do
+  describe '.entry_type_fields' do
+    subject { described_class.entry_type_fields }
+
+    it { is_expected.to eq(%i[api_entry_point api_token]) }
+  end
+
+  describe '.call' do
+    subject do
+      described_class.call(
+        type_options: type_options,
+        options: {
+          id: id
+        }
+      )
+    end
+
+    let(:api_entry_point) { 'api_entry_point' }
+    let(:id) { 'id' }
+
+    let(:prismic) { instance_double(Prismic::API) }
+    let(:entry) { instance_double(Prismic::Form) }
+    let(:data) { instance_double(Hash) }
+
+    before do
+      allow(::Prismic)
+        .to receive(:api)
+        .and_return(prismic)
+
+      allow(prismic)
+        .to receive(:getByID)
+        .and_return(entry)
+
+      allow(entry).to receive(:fields).and_return(data)
+    end
+
+    context 'when using private repository' do
+      let(:api_token) { 'api_token' }
+
+      let(:type_options) do
+        {
+          api_entry_point: api_entry_point,
+          api_token: api_token,
+        }
+      end
+
+      it 'returns data using Prismic client' do
+        expect(::Prismic)
+          .to receive(:api)
+          .with(api_entry_point, api_token)
+          .and_return(prismic)
+
+        expect(prismic).to receive(:getByID).with(id).and_return(entry)
+
+        expect(subject[:data]).to eq(data)
+      end
+    end
+
+    context 'when using public repository' do
+      let(:type_options) do
+        {
+          api_entry_point: api_entry_point
+        }
+      end
+
+      it 'returns data using Prismic client' do
+        expect(::Prismic)
+          .to receive(:api)
+          .with(api_entry_point, nil)
+          .and_return(prismic)
+
+        expect(prismic).to receive(:getByID).with(id).and_return(entry)
+
+        expect(subject[:data]).to eq(data)
+      end
+    end
+  end
+end

data/spec/solidus_content/providers/solidus_static_content_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusContent::Providers::SolidusStaticContent do
+  let(:page) { create(:page) }
+
+  describe '.entry_type_fields' do
+    subject { described_class.entry_type_fields }
+
+    it { is_expected.to eq(%i[]) }
+  end
+
+  context 'when passing the slug in the options' do
+    it 'returns static content data' do
+      expect(
+        described_class.call(slug: page.slug)[:data]
+      ).to eq(page.reload.attributes.symbolize_keys)
+    end
+  end
+
+  context 'when using the entry slug' do
+    it 'returns static content data' do
+      expect(
+        described_class.call(
+          slug: page.slug,
+          options: {
+            slug: page.slug
+          }
+        )[:data]
+      ).to eq(page.reload.attributes.symbolize_keys)
+    end
+  end
+end

data/spec/solidus_content/providers/yaml_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusContent::Providers::YAML do
+  let(:path) { File.absolute_path('content', FIXTURE_PATH) }
+
+  describe '.entry_type_fields' do
+    subject { described_class.entry_type_fields }
+
+    it { is_expected.to eq(%i[path]) }
+  end
+
+  context 'when the yml extension isn\'t available' do
+    it 'uses the yaml extension' do
+      expect(described_class.call(
+        slug: 'example_2',
+        type_options: { path: path },
+      )[:data]).to eq(foo: 'yaml_bar')
+    end
+  end
+
+  context 'when both yml and yaml extensions are available' do
+    it 'uses the yml one' do
+      expect(described_class.call(
+        slug: 'example',
+        type_options: { path: path },
+      )[:data]).to eq(foo: 'yml_bar')
+    end
+  end
+
+  context 'with an absolute path' do
+    it 'uses the absolute path as is' do
+      expect(described_class.call(
+        slug: 'example',
+        type_options: { path: path },
+      )[:data]).to eq(foo: 'yml_bar')
+    end
+  end
+
+  context 'with a relative path' do
+    before { allow(Rails).to receive(:root).and_return(Pathname(FIXTURE_PATH)) }
+
+    it 'uses the absolute path as is' do
+      expect(described_class.call(
+        slug: 'example',
+        type_options: { path: 'content' },
+      )[:data]).to eq(foo: 'yml_bar')
+    end
+  end
+end

data/spec/solidus_content_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusContent do
+  describe '.table_name_prefix' do
+    it 'returns the correct prefix' do
+      expect(described_class.table_name_prefix).to eq('solidus_content_')
+    end
+  end
+
+  describe '.configure' do
+    it 'yields the configuration' do
+      expect { |b| described_class.configure(&b) }.to yield_with_args(described_class.config)
+    end
+  end
+
+  describe '.config' do
+    it 'returns an instance of SolidusContent::Config' do
+      expect(described_class.config).to be_instance_of(SolidusContent::Configuration)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+# Run Coverage report
+require 'solidus_dev_support/rspec/coverage'
+
+File.expand_path('dummy/config/environment.rb', __dir__).tap { |dummy_app|
+  # Create the dummy app if it's still missing.
+  system 'bin/rake extension:test_app' unless File.exist? dummy_app
+
+  require dummy_app
+}
+
+# Requires factories and other useful helpers defined in spree_core.
+require 'solidus_dev_support/rspec/feature_helper'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+# Requires factories defined in lib/solidus_content/factories.rb
+require 'solidus_content/factories'
+require 'solidus_static_content/factories'
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.use_transactional_fixtures = false
+end
+
+FIXTURE_PATH = File.expand_path('fixtures', __dir__)

data/spec/support/warden.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.include Warden::Test::Helpers
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: solidus_content
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrea Vassallo
+- Elia Schito
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: solidus_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: solidus_dev_support
+  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: ''
+email: contact@solidus.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gem_release.yml"
+- ".github/stale.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/solidus_content.js
+- app/assets/javascripts/spree/frontend/solidus_content.js
+- app/assets/stylesheets/spree/backend/solidus_content.css
+- app/assets/stylesheets/spree/frontend/solidus_content.css
+- app/controllers/solidus_content/resource_controller.rb
+- app/controllers/spree/admin/entries_controller.rb
+- app/controllers/spree/admin/entry_types_controller.rb
+- app/controllers/spree/solidus_content_controller.rb
+- app/models/solidus_content/application_record.rb
+- app/models/solidus_content/entry.rb
+- app/models/solidus_content/entry_type.rb
+- app/models/solidus_content/provider/fields.rb
+- app/views/spree/admin/entries/_form.html.erb
+- app/views/spree/admin/entries/_options_form.html.erb
+- app/views/spree/admin/entries/edit.html.erb
+- app/views/spree/admin/entries/index.html.erb
+- app/views/spree/admin/entries/new.html.erb
+- app/views/spree/admin/entry_types/_form.html.erb
+- app/views/spree/admin/entry_types/_options_form.html.erb
+- app/views/spree/admin/entry_types/edit.html.erb
+- app/views/spree/admin/entry_types/index.html.erb
+- app/views/spree/admin/entry_types/new.html.erb
+- app/views/spree/admin/shared/_solidus_content_sub_menu.html.erb
+- bin/console
+- bin/rails
+- bin/rails-engine
+- bin/rails-sandbox
+- bin/rake
+- bin/rspec
+- bin/sandbox
+- bin/setup
+- config/initializers/spree.rb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20200207135842_create_solidus_content_entries.rb
+- db/migrate/20200306110114_create_solidus_content_entry_types.rb
+- lib/generators/solidus_content/install/install_generator.rb
+- lib/generators/solidus_content/install/templates/initializer.rb
+- lib/solidus_content.rb
+- lib/solidus_content/active_record.rb
+- lib/solidus_content/configuration.rb
+- lib/solidus_content/engine.rb
+- lib/solidus_content/factories.rb
+- lib/solidus_content/providers.rb
+- lib/solidus_content/providers/contentful.rb
+- lib/solidus_content/providers/json.rb
+- lib/solidus_content/providers/prismic.rb
+- lib/solidus_content/providers/raw.rb
+- lib/solidus_content/providers/solidus_static_content.rb
+- lib/solidus_content/providers/yaml.rb
+- lib/solidus_content/version.rb
+- solidus_content.gemspec
+- spec/features/admin/content/create_entry_spec.rb
+- spec/features/admin/content/create_entry_type_spec.rb
+- spec/features/admin/content/delete_entry_spec.rb
+- spec/features/admin/content/delete_entry_type_spec.rb
+- spec/features/admin/content/edit_entry_spec.rb
+- spec/features/admin/content/edit_entry_type_spec.rb
+- spec/features/admin/content/list_entries_spec.rb
+- spec/features/admin/content/list_entry_types_spec.rb
+- spec/features/admin/sidebar_spec.rb
+- spec/features/render_content_with_views_spec.rb
+- spec/fixtures/content/example.json
+- spec/fixtures/content/example.yaml
+- spec/fixtures/content/example.yml
+- spec/fixtures/content/example_2.yaml
+- spec/models/solidus_content/entry_spec.rb
+- spec/models/solidus_content/entry_type_spec.rb
+- spec/solidus_content/configuration_spec.rb
+- spec/solidus_content/providers/contentful_spec.rb
+- spec/solidus_content/providers/json_spec.rb
+- spec/solidus_content/providers/prismic_spec.rb
+- spec/solidus_content/providers/solidus_static_content_spec.rb
+- spec/solidus_content/providers/yaml_spec.rb
+- spec/solidus_content_spec.rb
+- spec/spec_helper.rb
+- spec/support/warden.rb
+homepage: https://github.com/nebulab/solidus_content#readme
+licenses:
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://github.com/nebulab/solidus_content#readme
+  source_code_uri: https://github.com/nebulab/solidus_content#readme
+  changelog_uri: https://github.com/nebulab/solidus_content/releases
+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: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Manage your Solidus content sources
+test_files:
+- spec/features/admin/content/create_entry_spec.rb
+- spec/features/admin/content/create_entry_type_spec.rb
+- spec/features/admin/content/delete_entry_spec.rb
+- spec/features/admin/content/delete_entry_type_spec.rb
+- spec/features/admin/content/edit_entry_spec.rb
+- spec/features/admin/content/edit_entry_type_spec.rb
+- spec/features/admin/content/list_entries_spec.rb
+- spec/features/admin/content/list_entry_types_spec.rb
+- spec/features/admin/sidebar_spec.rb
+- spec/features/render_content_with_views_spec.rb
+- spec/fixtures/content/example.json
+- spec/fixtures/content/example.yaml
+- spec/fixtures/content/example.yml
+- spec/fixtures/content/example_2.yaml
+- spec/models/solidus_content/entry_spec.rb
+- spec/models/solidus_content/entry_type_spec.rb
+- spec/solidus_content/configuration_spec.rb
+- spec/solidus_content/providers/contentful_spec.rb
+- spec/solidus_content/providers/json_spec.rb
+- spec/solidus_content/providers/prismic_spec.rb
+- spec/solidus_content/providers/solidus_static_content_spec.rb
+- spec/solidus_content/providers/yaml_spec.rb
+- spec/solidus_content_spec.rb
+- spec/spec_helper.rb
+- spec/support/warden.rb