contentful_middleman 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ccfe1bc9ea0a8cfa76de3d65aa382141e3d81da0
+  data.tar.gz: 5929f5f756b15d636a17e575a40c81bf3f0b1230
+SHA512:
+  metadata.gz: ece6120ab1f940ce2bd6dac04a5ef093d322caf057e4f17a247362445b7a61b6eac19f35da0eef2e9c3f00b56f9417a19ebc1fab5fc8440c2e2a0dd16ea5bcc8
+  data.tar.gz: d20282b168ad58b84b9d77400dbaa01d9527d776119dd2510263f8de3b32cd824bb330ade6045ad17e77221185032938d94d51b93a8d71213e77e2d6e975d1ff

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+.bundle
+Gemfile*.lock
+pkg/*
+.rvmrc
+.DS_Store
+.rbenv-version
+.ruby-version
+tmp
+doc
+.yardoc
+build/
+.sass-cache
+coverage

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+
+script: "bundle exec rake test"
+
+env: TEST=true

data/.yardopts

@@ -0,0 +1,3 @@
+lib/**/*.rb
+--no-private
+--hide-void-return

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+0.0.4
+===
+
+* Publish first Gem version
+
+0.0.3
+===
+
+* Minor updates
+
+
+0.0.2
+===
+
+* First release

data/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/middleman/middleman-blog/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake test`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake test`. If your specs fail, return to step 5.
+7. Add, commit, and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

@@ -0,0 +1,18 @@
+# If you have OpenSSL installed, we recommend updating
+# the following line to use "https"
+source 'http://rubygems.org'
+
+gem "middleman-core", :github => "middleman/middleman", :branch => 'v3-stable'
+
+# Specify your gem's dependencies in contentful_middleman.gemspec
+gemspec
+
+gem "rake"
+gem "yard"
+
+# Test tools
+gem "rspec"
+gem "simplecov"
+
+gem "cane", :platforms => [:mri_19, :mri_20], :require => false
+gem 'coveralls', :require => false

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Contentful GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# Contentful Middleman
+
+[![Build Status](https://travis-ci.org/contentful/contentful_middleman.png)](https://travis-ci.org/contentful/contentful_middleman)
+
+Contentful Middleman is a [Middleman](http://middlemanapp.com/) extension to use the Middleman static side generator together with the API-driven [Contentful CMS](https://www.contentful.com). It is powered by the [Contentful Ruby Gem](https://github.com/contentful/contentful.rb).
+
+Experience the power of Middleman while staying sane as a developer by letting end-users edit content in a web-based interface.
+
+This extensions supports both page-based content as well as blog posts through middleman-blog.
+
+## Installation
+
+Add the following line to the Gemfile of your Middleman project:
+
+```
+gem "contentful_middleman"
+```
+
+Then as usual, run:
+
+```
+bundle install
+```
+
+## Configuration
+
+To configure the extension, add the following configuration block to Middleman's config.rb:
+
+```
+activate :contentful do |f|
+  # The Space ID of your Contentful space
+  f.space = 'YOUR_SPACE_ID'
+
+  # The access token (API Key) for the Content Delivery API
+  f.access_token = 'YOUR_CONTENT_DELIVERY_API_ACCESS_TOKEN'
+
+  # Optional: Options for middleman-blog
+
+  # Filter Entries for your blog posts. See Contentful gem and Content Delivery API documentation.
+  f.blog_posts_query = {content_type: "6LbnqgnwA08qYaU", category: "news" } 
+  
+  # Which keys to use in the article template for blog posts
+  # Key: template variable
+  # Value: Entry method or block
+  f.blog_post_mappings = {
+      slug: :id,
+      date: :created_at,
+      body: :id,
+      tags: :tags,
+      title: ->(e){"#{e.id}XXXX"}
+  }
+
+  # Define your own template for blog posts
+  f.new_article_template = "/my_templates/article.tt"
+
+  # Automatically synchronize blog posts before building with "middleman build"
+  f.sync_blog_before_build = true # default: false
+end
+```
+
+## Using managed content in regular pages
+
+The `contentful` helper provides a Contentful gem client object, that can be used to fetch managed content from Contentful:
+
+```
+  <ol>
+    <% contentful.entries(content_type: '6LbnqgnwA08qYaU').each do |entry| %>
+      <li>
+        <%= entry.title %>
+        <%= entry.body %>
+        <%= entry.created_at %>
+      </li>
+    <% end %>
+  </ol>
+```
+
+## Synchronizing blog posts manually
+
+Blog posts are synchronized to your repo as YAML files with front matter, just as if you would write them manually. Either automatically when building, or manually by running:
+
+```
+middleman contentful
+```

data/Rakefile

@@ -0,0 +1,36 @@
+require 'middleman-core'
+
+require 'rake/clean'
+
+desc "Run tests, both RSpec and Cucumber"
+task :test => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run RSpec"
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color', '--format nested']
+end
+
+begin
+  require 'cane/rake_task'
+
+  desc "Run cane to check quality metrics"
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.no_style = true
+    cane.no_doc = true
+    cane.abc_glob = "lib/contentful_middleman/**/*.rb"
+  end
+rescue LoadError
+  # warn "cane not available, quality task not provided."
+end
+
+desc "Build HTML documentation"
+task :doc do
+  sh 'bundle exec yard'
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new

data/TODO

@@ -0,0 +1,15 @@
+- add specs
+- add travis ci
+
+- publish yard docs
+  - add comments
+
+- support multiple instances and blog instances
+
+- building through webhook
+- preview mode
+
+- blog posts
+  - add draft?
+  - add ignore?
+  - use title field from content type

data/contentful_middleman.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "contentful_middleman/version"
+
+Gem::Specification.new do |s|
+  s.name        = "contentful_middleman"
+  s.version     = ContentfulMiddleman::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Sascha Konietzke"]
+  s.email       = ["sascha@contentful.com"]
+  s.homepage    = "https://www.contentful.com"
+  s.summary     = %q{Include mangablable content from the Contentful CMS and API into your Middleman projects}
+  s.description = %q{Load blog posts and other managed content into Middleman}
+  s.license = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # The version of middleman-core your extension depends on
+  s.add_dependency("middleman-core", ["~> 3.3"])
+
+  # Additional dependencies
+  s.add_dependency("contentful")
+
+  s.add_development_dependency 'rubygems-tasks', '~> 0.2'
+end

data/lib/contentful_middleman.rb

@@ -0,0 +1,7 @@
+require "middleman-core"
+
+require 'contentful_middleman/version'
+require 'contentful_middleman/core'
+require "contentful_middleman/commands/sync_blog"
+
+::Middleman::Extensions.register(:contentful, ContentfulMiddleman::Core)

data/lib/contentful_middleman/commands/article.tt

@@ -0,0 +1,9 @@
+---
+# Warning: This file is auto-generated from the Contentful CMS. Local changes will overriden on next sync.
+
+title: <%= @title %>
+date: <%= @date.strftime('%F %R %Z') %>
+tags: <%= @tags.join(', ') %>
+---
+
+<%= @body %>

data/lib/contentful_middleman/commands/sync_blog.rb

@@ -0,0 +1,88 @@
+require 'middleman-core/cli'
+require 'date'
+require 'middleman-blog/uri_templates'
+
+module Middleman
+  module Cli
+    # This class provides an "contentful" command for the middleman CLI.
+    class SyncBlog < Thor
+      include Thor::Actions
+      include ::Middleman::Blog::UriTemplates
+
+      check_unknown_options!
+
+      namespace :contentful
+
+      def self.source_root
+        ENV['MM_ROOT']
+      end
+
+      # Tell Thor to exit with a nonzero exit code on failure
+      def self.exit_on_failure?
+        true
+      end
+
+      desc "contentful", "Synchronize Contentful blog posts"
+      method_option "lang",
+        aliases: "-l",
+        desc: "The language to create the post with (defaults to I18n.default_locale if avaliable)"
+      method_option "blog",
+        aliases: "-b",
+        desc: "The name of the blog to create the post inside (for multi-blog apps, defaults to the only blog in single-blog apps)"
+      def contentful
+        contentful_middleman = shared_instance.contentful_middleman
+        client = shared_instance.contentful_middleman_client
+        contentful_middleman_options = contentful_middleman.options
+        blog_post_mappings = contentful_middleman.blog_post_mappings
+
+        if shared_instance.respond_to? :blog
+          shared_instance.logger.info "  Contentful Sync: Start..."
+
+          client.entries(contentful_middleman_options.blog_posts_query).each do |entry|
+            slug  = value_from_object(entry, blog_post_mappings[:slug])
+            title = value_from_object(entry, blog_post_mappings[:title])
+            date  = value_from_object(entry, blog_post_mappings[:date]).strftime("%Y-%m-%d")
+            tags  = value_from_object(entry, blog_post_mappings[:tags]) || []
+            body  = value_from_object(entry, blog_post_mappings[:body])
+
+            @title = title
+            @slug  = slug || safe_parameterize(title)
+            @date  = date ? Time.zone.parse(date) : Time.zone.now
+            @tags  = tags
+            @lang  = options[:lang] || ( I18n.default_locale if defined? I18n )
+            @body  = body
+
+            blog_inst = shared_instance.blog(options[:blog])
+
+            path_template = blog_inst.source_template
+            params = date_to_params(@date).merge(lang: @lang.to_s, title: @slug)
+            article_path = apply_uri_template path_template, params
+
+            template contentful_middleman.options.new_article_template, File.join(shared_instance.source_dir, article_path + blog_inst.options.default_extension)
+          end
+
+          shared_instance.logger.info " Contentful Sync: Done!"
+        else
+          raise Thor::Error.new "You need to activate the blog extension in config.rb before you can create an article"
+        end
+      end
+
+      private
+        def shared_instance
+          @shared_instance ||= ::Middleman::Application.server.inst
+        end
+
+        def value_from_object(object, mapping)
+          if ( mapping.is_a?(Symbol) || mapping.is_a?(String) ) && object.respond_to?(mapping)
+            object.send(mapping)
+          elsif mapping.is_a?(Proc)
+            object.instance_exec(object, &mapping)
+          else
+            shared_instance.logger.warn "Warning - Unknown mapping (#{mapping}) for object (#{object.class}) with ID (#{object.id})"
+            nil
+          end
+        end
+    end
+
+  end
+end

data/lib/contentful_middleman/core.rb

@@ -0,0 +1,69 @@
+require 'middleman-core'
+require 'contentful'
+
+# The Contentful Middleman extensions allows to load managed content into Middleman projects through the Contentful Content Management Platform.
+module ContentfulMiddleman
+  class Core < ::Middleman::Extension
+    DEFAULT_BLOG_MAPPINGS = {
+      slug: :id,
+      date: :created_at,
+      title: :id,
+      body: :id,
+      tags: :tags
+    }
+
+    self.supports_multiple_instances = false
+
+    option :space, nil, 'The Contentful Space ID'
+    option :access_token, nil, 'The Contentful Content Delivery API access token'
+
+    option :new_article_template, File.expand_path('../commands/article.tt', __FILE__), 'Path (relative to project root) to an ERb template that will be used to generate new Contentful articles from the "middleman contentful" command.'
+
+    option :blog_posts_query, {}, "The conditions that are used on the Content Delivery API to query for blog posts"
+    option :blog_post_mappings, {}, "The mappings from Contentful DynamicResources to Middleman"
+
+    option :sync_blog_before_build, false, "Synchronize the blog from Contentful before the build phase"
+
+    def initialize(app, options_hash={}, &block)
+      super
+
+      app.set :contentful_middleman, self
+      app.set :contentful_middleman_client, client
+
+      app.before_build do |builder|
+        contentful_middleman.sync_blog if contentful_middleman.middleman_blog_enabled? && contentful_middleman.options.sync_blog_before_build
+      end
+    end
+
+    # Is the Middleman blog extension enabled?
+    def middleman_blog_enabled?
+      app.respond_to? :blog
+    end
+
+    # Synchronize blog posts from Contentful through the CLI task
+    def sync_blog
+      Middleman::Cli::SyncBlog.new.contentful
+      true
+    end
+
+    def blog_post_mappings
+      @blog_post_mappings ||= ContentfulMiddleman::Core::DEFAULT_BLOG_MAPPINGS.merge(options.blog_post_mappings)
+    end
+
+    # The Contentful Gem client for the Content Delivery API
+    def client
+      @client ||= Contentful::Client.new(
+        access_token: options.access_token,
+        space: options.space,
+        dynamic_entries: :auto
+      )
+    end
+
+    helpers do
+      # A helper method to access the Contentful Gem client
+      def contentful
+        contentful_middleman_client
+      end
+    end
+  end
+end

data/lib/contentful_middleman/version.rb

@@ -0,0 +1,3 @@
+module ContentfulMiddleman
+   VERSION = "0.0.4"
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'contentful_middleman'

data/spec/contentful_middleman_spec.rb

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+
+describe 'ContentfulMiddleman' do
+  it "should be pending" do
+    pending
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+SimpleCov.root(File.expand_path(File.dirname(__FILE__) + '/..'))
+
+require 'coveralls'
+Coveralls.wear!

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: contentful_middleman
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Sascha Konietzke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: contentful
+  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: 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'
+description: Load blog posts and other managed content into Middleman
+email:
+- sascha@contentful.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- .yardopts
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- TODO
+- contentful_middleman.gemspec
+- lib/contentful_middleman.rb
+- lib/contentful_middleman/commands/article.tt
+- lib/contentful_middleman/commands/sync_blog.rb
+- lib/contentful_middleman/core.rb
+- lib/contentful_middleman/version.rb
+- lib/middleman_extension.rb
+- spec/contentful_middleman_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.0.0
+signing_key: 
+specification_version: 4
+summary: Include mangablable content from the Contentful CMS and API into your Middleman
+  projects
+test_files:
+- spec/contentful_middleman_spec.rb
+- spec/spec_helper.rb