middleman-headless 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5de691702df171e1d91948bc6f390f7ae83aea39
-  data.tar.gz: 4334d46621814749bf57780b7a92f24f15294a9b
+  metadata.gz: 02fde3f80d8802e683bcfd98cc2aaa59c49d668a
+  data.tar.gz: 33dfef11c36b4a22fa09e9aa8fe866c7343ff01b
 SHA512:
-  metadata.gz: 6424dab2df2aa3a64a7e87b5298abc7bcc7d48f0bd067b7859f6cf8a3db77f529d4ef1163d3e1264a5fc3b604cd81eecb72b6cfde5e44a467be36a2d1b3a5517
-  data.tar.gz: ff1eac0b5345627a770a63dbf913087b11cbb0382221a89b7455dc7cbe4887e38f8197d3f3241caa58a517e19864ec806d42aafaed1ee1a96bb64debea9c4ec6
+  metadata.gz: a784d489c4ba026ec11f067b3858a4df3e29d1eae05065c5b2c18c4bfb96e2b31022a663dd44886c6219ce6087b3b796d18bd86dde2acd0aa974ed6d2f848fe3
+  data.tar.gz: 3b0c1fe73bb16ee698e48231a17d9810f69489be8a44ebd70ca44be67d51445a02ae443e0f251d83c7439da8ec0208fcd98187ccbbcbae84bdbda7855ad1e3c5

data/.gitignore

@@ -1,5 +1,2 @@
-# Ignore bundler lock file
+example/build/
 /Gemfile.lock
-
-# Ignore pkg folder
-/pkg

data/README.md

@@ -1,3 +1,25 @@
 # middleman-headless
 
-**Middleman extension to load content from the Headless Content Management System.**
+**Middleman extension to load content from the Headless Content Management System.**
+
+## Example
+
+The example middleman site in `./example` shows how you can retrieve data from a headless instance.
+
+First of all, you need to create a new space in your headless server with the slug `example`.
+
+After that you need to create the following content types:
+
+```
+post:
+  title: string
+  body: string (multiline)
+  image: asset
+  author: reference (author)
+
+author (has no fields)
+```
+
+Now you need to add English as a language with the slug `en`.
+
+Finally, you can create as many entries you like.

data/example/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'middleman', '>= 4.0.0'
+gem 'middleman-livereload'
+gem 'middleman-headless', path: '../'

data/example/Gemfile.lock

@@ -0,0 +1,138 @@
+PATH
+  remote: ../
+  specs:
+    middleman-headless (0.3.5)
+      middleman-core (~> 4.1)
+      mime-types (~> 3.1)
+      oauth2 (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.0.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    backports (3.10.3)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.12.2)
+    compass-import-once (1.0.5)
+      sass (>= 3.2, < 3.5)
+    concurrent-ruby (1.0.5)
+    contracts (0.13.0)
+    dotenv (2.2.1)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    erubis (2.7.0)
+    eventmachine (1.2.5)
+    execjs (2.7.0)
+    faraday (0.12.2)
+      multipart-post (>= 1.2, < 3)
+    fast_blank (1.0.0)
+    fastimage (2.1.0)
+    ffi (1.9.18)
+    haml (5.0.4)
+      temple (>= 0.8.0)
+      tilt
+    hamster (3.0.0)
+      concurrent-ruby (~> 1.0)
+    hashie (3.5.6)
+    http_parser.rb (0.6.0)
+    i18n (0.7.0)
+    jwt (1.5.6)
+    kramdown (1.15.0)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    memoist (0.16.0)
+    middleman (4.2.1)
+      coffee-script (~> 2.2)
+      compass-import-once (= 1.0.5)
+      haml (>= 4.0.5)
+      kramdown (~> 1.2)
+      middleman-cli (= 4.2.1)
+      middleman-core (= 4.2.1)
+      sass (>= 3.4.0, < 4.0)
+    middleman-cli (4.2.1)
+      thor (>= 0.17.0, < 2.0)
+    middleman-core (4.2.1)
+      activesupport (>= 4.2, < 5.1)
+      addressable (~> 2.3)
+      backports (~> 3.6)
+      bundler (~> 1.1)
+      contracts (~> 0.13.0)
+      dotenv
+      erubis
+      execjs (~> 2.0)
+      fast_blank
+      fastimage (~> 2.0)
+      hamster (~> 3.0)
+      hashie (~> 3.4)
+      i18n (~> 0.7.0)
+      listen (~> 3.0.0)
+      memoist (~> 0.14)
+      padrino-helpers (~> 0.13.0)
+      parallel
+      rack (>= 1.4.5, < 3)
+      sass (>= 3.4)
+      servolux
+      tilt (~> 2.0)
+      uglifier (~> 3.0)
+    middleman-livereload (3.4.6)
+      em-websocket (~> 0.5.1)
+      middleman-core (>= 3.3)
+      rack-livereload (~> 0.3.15)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    minitest (5.10.3)
+    multi_json (1.12.2)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    padrino-helpers (0.13.3.4)
+      i18n (~> 0.6, >= 0.6.7)
+      padrino-support (= 0.13.3.4)
+      tilt (>= 1.4.1, < 3)
+    padrino-support (0.13.3.4)
+      activesupport (>= 3.1)
+    parallel (1.12.0)
+    public_suffix (3.0.0)
+    rack (2.0.3)
+    rack-livereload (0.3.16)
+      rack
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    sass (3.4.25)
+    servolux (0.13.0)
+    temple (0.8.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    uglifier (3.2.0)
+      execjs (>= 0.3.0, < 3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  middleman (>= 4.0.0)
+  middleman-headless!
+  middleman-livereload
+
+BUNDLED WITH
+   1.13.6

data/example/config.rb

@@ -0,0 +1,10 @@
+activate :headless,
+  address: 'http://0.0.0.0:4000',
+  app_key: 'key',
+  app_secret: 'secret',
+  space: 'example',
+  download_assets: true
+
+configure :development do
+  activate :livereload
+end

data/example/source/index.html.erb

@@ -0,0 +1,27 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>Example</title>
+
+  <style>
+    body {
+      font-family: sans-serif;
+      font-size: 16px;
+    }
+  </style>
+</head>
+
+<body>
+
+<h1><%= headless.space.name %></h1>
+
+<% headless.posts.each do |post| %>
+  <h2><%= post.title %></h2>
+  <p><%= image_tag post.asset(:image).url(width: 400), alt: post.asset(:image).name %></p>
+  <p><%= post.body %></p>
+  <p>Written by <%= post.reference(:author).name %></p>
+<% end %>
+
+</body>
+</html>

data/lib/middleman-headless/extension.rb

@@ -11,6 +11,10 @@ module MiddlemanHeadless
     option :space, nil, 'The space to be used'
     option :preview, false, 'Enable preview mode'
     option :cache, false, 'Enable caching. You need to restart the middleman to get updated content.'
+    option :download_assets, false, 'Download assets and replace links during a build.'
+    option :assets_dir, 'assets', 'The directory to place downloaded assets in.'
+    option :process_exts, %w(.html .json), 'The extension of files to process for downloadable assets.'
+    option :assets_hash_length, 8, 'The length of the appended hash key to the asset filenames.'
 
     expose_to_config :headless
     expose_to_template :headless
@@ -25,11 +29,47 @@ module MiddlemanHeadless
     end
 
     def headless
+      if options.app_key.blank? or options.app_secret.blank? or options.address.blank?
+        raise 'missing app_key, app_secret or address'
+      end
+
       @interface ||= Interface.new(options)
     end
 
     def clear
       @interface = nil unless options.cache
     end
+
+    def after_build(builder)
+      download_assets(builder) if options[:download_assets] and app.build?
+    end
+
+    def download_assets(builder)
+      downloads = {}
+      builder.thor.say 'Downloading headless assets...'
+
+      Middleman::Util.all_files_under(app.config[:build_dir]).each do |file|
+        next unless options[:process_exts].include?(File.extname(file))
+
+        content = File.binread(file.expand_path)
+
+        content.gsub! /hldl:\/\/([A-z0-9=]+)\// do
+          data = JSON.parse(Base64.urlsafe_decode64($1))
+          hash = Digest::SHA1.hexdigest(data['addr'])[0..options[:assets_hash_length]]
+          id = "#{data['name']}-#{hash}.#{data['ext']}"
+          downloads[id] = data['addr']
+          "/#{options[:assets_dir]}/#{id}"
+        end
+
+        File.open(file.expand_path, 'wb') { |f| f.write(content) }
+        builder.thor.say_status :processed, file
+      end
+
+      downloads.each do |id, url|
+        dest = Pathname(app.config[:build_dir]).join(options[:assets_dir], id)
+        builder.thor.get url, dest, verbose: false
+        builder.thor.say_status :downloaded, dest
+      end
+    end
   end
 end

data/lib/middleman-headless/interface.rb

@@ -1,3 +1,4 @@
+require 'mime/types'
 require 'active_support/core_ext/hash/indifferent_access'
 
 module MiddlemanHeadless
@@ -187,9 +188,24 @@ module MiddlemanHeadless
       @data[:name]
     end
 
+    def content_type
+      @data[:content_type]
+    end
+
+    def extension
+      MIME::Types[content_type].first.preferred_extension
+    end
+
     def url(options={})
       opts = options.length > 0 ? "?#{options.to_query}" : ''
-      "#{@interface.options.address}/content/file/#{key}#{opts}"
+      addr = "#{@interface.options.address}/content/file/#{key}#{opts}"
+
+      if @interface.options[:download_assets]
+        data = { addr: addr, ext: extension, name: name.parameterize }
+        "hldl://#{Base64.urlsafe_encode64(JSON.generate(data))}/"
+      else
+        addr
+      end
     end
   end
 

data/middleman-headless.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'middleman-headless'
-  s.version     = '0.3.5'
+  s.version     = '0.4.0'
   s.licenses    = ['MIT']
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Joël Gähwiler']
@@ -17,5 +17,6 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_runtime_dependency('middleman-core', ['~> 4.1'])
-  s.add_runtime_dependency('oauth2')
+  s.add_runtime_dependency('oauth2', ['~> 1.4'])
+  s.add_runtime_dependency('mime-types', ['~> 3.1'])
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-headless
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Joël Gähwiler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-21 00:00:00.000000000 Z
+date: 2017-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -28,16 +28,30 @@ dependencies:
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 description: 
 email:
 - joel@twomanyprojects.com
@@ -49,6 +63,10 @@ files:
 - Gemfile
 - LICENSE.md
 - README.md
+- example/Gemfile
+- example/Gemfile.lock
+- example/config.rb
+- example/source/index.html.erb
 - lib/middleman-headless.rb
 - lib/middleman-headless/extension.rb
 - lib/middleman-headless/interface.rb