jekyll-contentful-data-import 0.1.1

data/spec/jekyll-contentful/data_exporter_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'stringio'
+
+describe Jekyll::Contentful::DataExporter do
+  subject { described_class.new('foo', []) }
+
+  describe 'instance methods' do
+    it '#destination_directory' do
+      expected = File.join(Dir.pwd, '_data', 'contentful', 'spaces')
+      expect(subject.destination_directory).to eq(expected)
+    end
+
+    it '#destination_file' do
+      expected = File.join(Dir.pwd, '_data', 'contentful', 'spaces', 'foo.yaml')
+      expect(subject.destination_file).to eq(expected)
+    end
+
+    it '#setup_directory' do
+      expect(Dir).to receive(:mkdir).with(File.join(Dir.pwd, '_data'))
+      expect(Dir).to receive(:mkdir).with(File.join(Dir.pwd, '_data', 'contentful'))
+      expect(Dir).to receive(:mkdir).with(File.join(Dir.pwd, '_data', 'contentful', 'spaces'))
+
+      subject.setup_directory
+    end
+
+    describe '#run' do
+      before do
+        allow(subject).to receive(:setup_directory)
+      end
+
+      it 'creates or overwrites data file' do
+        expect(File).to receive(:open).with(subject.destination_file, 'w')
+        subject.run
+      end
+
+      it 'serializes entries onto data file' do
+        allow(File).to receive(:open).and_yield(StringIO.new)
+        expect_any_instance_of(::Jekyll::Contentful::Serializer).to receive(:to_yaml)
+
+        subject.run
+      end
+    end
+  end
+end

data/spec/jekyll-contentful/importer_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+class ClientDouble
+  def entries(options = {})
+    []
+  end
+end
+
+class ExporterDouble
+  def run; end
+end
+
+describe Jekyll::Contentful::Importer do
+  let(:config) do
+    {
+      'spaces' => [
+        {
+          'example' => {
+            'space' => 'cfexampleapi',
+            'access_token' => 'b4c0n73n7fu1'
+          }
+        }
+      ]
+    }
+  end
+  subject { described_class.new(config) }
+
+  describe 'instance methods' do
+    it '#spaces' do
+      expect(subject.spaces).to match([['example', {'space' => 'cfexampleapi', 'access_token' => 'b4c0n73n7fu1'}]])
+    end
+
+    describe '#client' do
+      it 'creates client with some defaults' do
+        expect(::Contentful::Client).to receive(:new).with(space: 'foo', access_token: 'foobar', dynamic_entries: :auto, raise_errors: true)
+
+        subject.client('foo', 'foobar')
+      end
+
+      it 'can override the defaults' do
+        expect(::Contentful::Client).to receive(:new).with(space: 'foo', access_token: 'foobar', dynamic_entries: :auto, raise_errors: false)
+
+        subject.client('foo', 'foobar', raise_errors: false)
+      end
+    end
+
+    describe '#run' do
+      it 'runs exporter for each space' do
+        allow(subject).to receive(:spaces).and_return([['foo', {}], ['bar', {}]])
+        allow(subject).to receive(:client).and_return(ClientDouble.new)
+
+        expect(Jekyll::Contentful::DataExporter).to receive(:new).and_return(ExporterDouble.new).twice
+
+        subject.run
+      end
+
+      it 'runs exporter with correct arguments' do
+        allow(subject).to receive(:client).and_return(ClientDouble.new)
+
+        expect(Jekyll::Contentful::DataExporter).to receive(:new).with('example', [], config['spaces'].first['example']).and_return(ExporterDouble.new)
+
+        subject.run
+      end
+    end
+  end
+end

data/spec/jekyll-contentful/mappers/base_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+class SomeMapper
+  def initialize(entry, config); end
+  def map; end
+end
+
+describe Jekyll::Contentful::Mappers::Base do
+  let(:entry) { EntryDouble.new('foo') }
+  subject { described_class.new(entry, {}) }
+
+  describe 'class methods' do
+    describe '::mapper_for' do
+      it 'returns default mapper if no config sent' do
+        expect(described_class.mapper_for(entry, {})).to be_a described_class
+      end
+
+      it 'returns configured mapper if config sent' do
+        config = {'content_types' => { entry.content_type.id => 'SomeMapper' } }
+        expect(described_class.mapper_for(entry, config)).to be_a SomeMapper
+      end
+    end
+  end
+
+  describe 'instance methods' do
+    describe '#map' do
+      class FileDouble
+        attr_reader :url
+
+        def initialize(url)
+          @url = url
+        end
+      end
+
+      class AssetDouble < Contentful::Asset
+        attr_reader :title, :file
+        def initialize(title, url)
+          @title = title
+          @file = FileDouble.new(url)
+        end
+      end
+
+      class LocationDouble < Contentful::Location
+        def initialize(lat, lon)
+          @lat = lat
+          @lon = lon
+        end
+
+        def properties
+          { 'lat' => @lat, 'lon' => @lon }
+        end
+      end
+
+      class LinkDouble < Contentful::Link
+        attr_reader :id
+
+        def initialize(id)
+          @id = id
+        end
+      end
+
+      it 'maps a simple entry' do
+        expected = { 'sys' => { 'id' => 'foo' } }
+        expect(subject.map).to eq expected
+      end
+
+      it 'maps a complete entry' do
+        entry = EntryDouble.new('foo', ContentTypeDouble.new, {
+          'asset' => AssetDouble.new('some_title', 'some_url'),
+          'location' => LocationDouble.new(12.32, 43.34),
+          'link' => LinkDouble.new('bar'),
+          'entry' => EntryDouble.new('baz'),
+          'array' => [
+            LinkDouble.new('foobar'),
+            'blah'
+          ],
+          'value' => 'foobar'
+        })
+
+        subject.instance_variable_set(:@entry, entry)
+
+        expected = {
+          'sys' => { 'id' => 'foo' },
+          'asset' => {
+            'title' => 'some_title',
+            'url' => 'some_url'
+          },
+          'location' => {
+            'lat' => 12.32,
+            'lon' => 43.34
+          },
+          'link' => {
+            'sys' => { 'id' => 'bar' }
+          },
+          'entry' => {
+            'sys' => { 'id' => 'baz' }
+          },
+          'array' => [
+            { 'sys' => { 'id' => 'foobar' } },
+            'blah'
+          ],
+          'value' => 'foobar'
+        }
+
+        expect(subject.map).to match expected
+      end
+    end
+  end
+end

data/spec/jekyll-contentful/serializer_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Jekyll::Contentful::Serializer do
+  let(:entries) { [EntryDouble.new('foo')] }
+  subject { described_class.new(entries, {}) }
+
+  describe 'instance methods' do
+    describe '#serialize' do
+      describe 'uses proper mapper' do
+        it 'uses default mappen if none specified in config' do
+          expect_any_instance_of(Jekyll::Contentful::Mappers::Base).to receive(:map)
+
+          subject.serialize
+        end
+
+        it 'uses specified mapper' do
+          subject.instance_variable_set(:@config, {'content_types' => {'' => 'MapperDouble'}})
+
+          expect_any_instance_of(MapperDouble).to receive(:map)
+
+          subject.serialize
+        end
+      end
+
+      it 'serializes a single entry without fields' do
+        expected = [{'sys' => {'id' => 'foo'}}]
+        expect(subject.serialize).to eq(expected)
+      end
+
+      it 'serializes a single entry with fields' do
+        subject.instance_variable_set(:@entries, [EntryDouble.new('foo', ContentTypeDouble.new, {'foobar' => 'bar'})])
+
+        expected = [{'sys' => {'id' => 'foo'}, 'foobar' => 'bar'}]
+        expect(subject.serialize).to eq(expected)
+      end
+
+      it 'serializes multiple entries' do
+        subject.instance_variable_set(:@entries, [
+          EntryDouble.new('foo', ContentTypeDouble.new, {'foobar' => 'bar'}),
+          EntryDouble.new('bar', ContentTypeDouble.new, {'foobar' => 'baz'})
+        ])
+
+        expected = [
+          {'sys' => {'id' => 'foo'}, 'foobar' => 'bar'},
+          {'sys' => {'id' => 'bar'}, 'foobar' => 'baz'}
+        ]
+        expect(subject.serialize).to match(expected)
+      end
+    end
+
+    it '#to_yaml' do
+      allow(subject).to receive(:serialize).and_return({'a' => 123})
+
+      expected = "---\na: 123\n"
+      expect(subject.to_yaml).to eq(expected)
+    end
+  end
+end

data/spec/jekyll/commands/contentful_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Jekyll::Commands::Contentful do
+  describe 'class methods' do
+    describe '::init_with_program' do
+      it 'implements jekyll command interface' do
+        expect(described_class.respond_to?(:init_with_program)).to be_truthy
+      end
+    end
+
+    describe '::process' do
+      it 'calls contentful importer' do
+        expect_any_instance_of(Jekyll::Contentful::Importer).to receive(:run)
+
+        described_class.process
+      end
+
+      it 'triggers a rebuild when --rebuild is sent' do
+        allow_any_instance_of(Jekyll::Contentful::Importer).to receive(:run)
+        expect(Jekyll::Commands::Build).to receive(:process)
+
+        described_class.process([], {'rebuild' => true})
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+$LOAD_PATH.unshift File.expand_path('lib', __FILE__)
+
+require 'vcr'
+require 'yaml'
+require 'rspec'
+
+require 'jekyll'
+require File.expand_path('../../lib/jekyll-contentful-data-import.rb', __FILE__)
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/fixtures/vcr_fixtures"
+  config.hook_into :webmock
+end
+
+def vcr(cassette)
+  VCR.use_cassette(cassette) do
+    yield if block_given?
+  end
+end
+
+def yaml(name)
+  yaml = YAML.parse(File.read("spec/fixtures/yaml_fixtures/#{name}.yaml")).to_ruby
+  yield yaml if block_given?
+  yaml
+end
+
+class ContentTypeDouble
+  attr_reader :id
+
+  def initialize(id = '')
+    @id = id
+  end
+end
+
+class EntryDouble < Contentful::DynamicEntry
+  attr_reader :id, :content_type, :fields
+
+  def initialize(id = '', content_type = ContentTypeDouble.new, fields = {})
+    @id = id
+    @content_type = content_type
+    @fields = fields
+  end
+end
+
+class MapperDouble
+  def initialize(entry, config); end
+  def map; end
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-contentful-data-import
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Contentful GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: contentful
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  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: pry
+  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: Load blog posts and other managed content into Jekyll
+email:
+- david.litvak@contentful.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- jekyll-contentful.gemspec
+- lib/jekyll-contentful-data-import.rb
+- lib/jekyll-contentful-data-import/data_exporter.rb
+- lib/jekyll-contentful-data-import/importer.rb
+- lib/jekyll-contentful-data-import/mappers.rb
+- lib/jekyll-contentful-data-import/mappers/base.rb
+- lib/jekyll-contentful-data-import/serializer.rb
+- lib/jekyll-contentful-data-import/version.rb
+- lib/jekyll/commands/contentful.rb
+- spec/fixtures/vcr_fixtures/entries.yml
+- spec/jekyll-contentful/data_exporter_spec.rb
+- spec/jekyll-contentful/importer_spec.rb
+- spec/jekyll-contentful/mappers/base_spec.rb
+- spec/jekyll-contentful/serializer_spec.rb
+- spec/jekyll/commands/contentful_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.contentful.com
+licenses:
+- MIT
+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.0
+signing_key: 
+specification_version: 4
+summary: Include mangablable content from the Contentful CMS and API into your Jekyll
+  projects
+test_files:
+- spec/fixtures/vcr_fixtures/entries.yml
+- spec/jekyll-contentful/data_exporter_spec.rb
+- spec/jekyll-contentful/importer_spec.rb
+- spec/jekyll-contentful/mappers/base_spec.rb
+- spec/jekyll-contentful/serializer_spec.rb
+- spec/jekyll/commands/contentful_spec.rb
+- spec/spec_helper.rb