middleman-headless 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60d9db815ea80cd14b4c15235a0bcb23dade91a5
+  data.tar.gz: bd21422ab42088fb4b7dcc052641d9f75661adb7
+SHA512:
+  metadata.gz: 0f81a9b100c7a56e7eea9d5ec41479814fccc4f8fec9090e66848005eb526e5fac0a16b91140e29ce0595f41168b3e33d5fe86b43d825febd0c709b072bb34b1
+  data.tar.gz: 41cbd4124e95f43e1ff4366c0e3ebbcfaffa8fd69318fc4746cab985ae96301fe662d6a0d5b0138a0e28d760e1c696f73fcfd5fdb0ac29647d5fcd03c750b704

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Two Many Projects (Joël Gähwiler, Adina Renner)
+
+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,3 @@
+# middleman-headless
+
+**Middleman extension to load content from the Headless Content Management System.**

data/lib/middleman-headless.rb

@@ -0,0 +1,6 @@
+require 'middleman-core'
+
+Middleman::Extensions.register :headless do
+  require 'middleman-headless/extension'
+  MiddlemanHeadless::Extension
+end

data/lib/middleman-headless/extension.rb

@@ -0,0 +1,37 @@
+require 'middleman-core'
+
+require 'middleman-headless/interface'
+
+module MiddlemanHeadless
+  class Extension < ::Middleman::Extension
+    option :address, 'https://0.0.0.0:4000', 'The Headless address'
+    option :app_key, nil, 'The applications key used for authentication'
+    option :app_secret, nil, 'The applications secret used for authentication"'
+    option :verify, true, 'Certificates are verified by default'
+    option :space, nil, 'The space to be used'
+    option :preview, false, 'Enable preview mode'
+
+    def initialize(app, options_hash={}, &block)
+      super
+      require 'oauth2'
+
+      app.before do
+        extensions[:headless].clear unless app.build?
+      end
+    end
+
+    def interface
+      @interface ||= Interface.new(options)
+    end
+
+    def clear
+      @interface = nil
+    end
+
+    helpers do
+      def headless
+        extensions[:headless].interface
+      end
+    end
+  end
+end

data/lib/middleman-headless/interface.rb

@@ -0,0 +1,203 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
+module MiddlemanHeadless
+  class Interface
+    attr_reader :options
+
+    def initialize(options)
+      @options = options
+      @entries_cache = {}
+      @asset_cache = {}
+
+      @client = OAuth2::Client.new(
+        @options.app_key,
+        @options.app_secret,
+        site: @options.address,
+        token_url: '/auth/token',
+        ssl: {
+          verify: @options.verify
+        }
+      )
+
+      @access_token = @client.client_credentials.get_token scope: ''
+    end
+
+    def space
+      @space ||= Space.new(get("space/#{@options.space}").with_indifferent_access, self)
+    end
+
+    def entries(content_type)
+      content_type = content_type[:slug] if content_type.is_a?(Hash)
+      path = "entries/#{@options.space}/#{content_type}"
+      @entries_cache[content_type.to_sym] ||= get(path).map do |item|
+        Entry.new(item.with_indifferent_access, self)
+      end
+    end
+
+    def entry(content_type, id)
+      entries(content_type).find do |item|
+        item.id == id
+      end
+    end
+
+    def asset(id)
+      return nil if id.nil?
+      path = "asset/#{@options.space}/#{id}"
+      @asset_cache[id.to_sym] ||= Asset.new(get(path).with_indifferent_access, self)
+    end
+
+    def token
+      @access_token.token
+    end
+
+    def method_missing(key)
+      entries(key.to_s)
+    end
+
+    protected
+
+    def get(path)
+      path = "/content/#{path.to_s}"
+      path = "#{path}?preview=enabled" if @options.preview
+      JSON.parse(@access_token.get(path).body)
+    end
+  end
+
+  class Item
+    def initialize(data, interface)
+      @data = data
+      @interface = interface
+    end
+
+    def method_missing(key)
+      @data[key]
+    end
+  end
+
+  class Space < Item
+    def content_types
+      @data[:content_types].map do |item|
+        Item.new(item, @interface)
+      end
+    end
+
+    def languages
+      @data[:languages].map do |item|
+        Item.new(item, @interface)
+      end
+    end
+  end
+
+  class Entry
+    def initialize(data, interface)
+      @data = data
+      @interface = interface
+    end
+
+    def id
+      @data[:id]
+    end
+
+    def name
+      @data[:name]
+    end
+
+    def version(key)
+      return nil if @data[:versions][key].nil?
+      Version.new(@data[:versions][key], @interface)
+    end
+
+    def field(key)
+      v = version(I18n.locale)
+      return nil if v.nil?
+      v.field(key)
+    end
+
+    def asset(key)
+      @interface.asset(field(key))
+    end
+
+    def assets(key)
+      field(key).map do |value|
+        @interface.asset(value)
+      end
+    end
+
+    def reference(key, type=nil)
+      type = key if type.nil?
+      Reference.new(type, field(key), @interface)
+    end
+
+    def references(key, type=nil)
+      type = key if type.nil?
+      field(key).map do |value|
+        Reference.new(type, value, @interface)
+      end
+    end
+
+    def method_missing(key)
+      field(key)
+    end
+  end
+
+  class Version
+    def initialize(data, interface)
+      @data = data
+      @interface = interface
+    end
+
+    def field(key)
+      @data[:fields][key]
+    end
+
+    def updated_at
+      @data[:updated_at]
+    end
+
+    def published_at
+      @data[:published_at]
+    end
+
+    def method_missing(key)
+      field(key)
+    end
+  end
+
+  class Asset
+    def initialize(data, interface)
+      @data = data
+      @interface = interface
+    end
+
+    def key
+      @data[:key]
+    end
+
+    def name
+      @data[:name]
+    end
+
+    def url(options={})
+      opts = options.length > 0 ? "?#{options.to_query}" : ''
+      "#{@interface.options.address}/content/file/#{key}#{opts}"
+    end
+  end
+
+  class Reference
+    def initialize(type, id, interface)
+      @type = type
+      @id = id
+      @interface = interface
+    end
+
+    def entry
+      @interface.entry(@type, @id)
+    end
+
+    def method_missing(*args)
+      e = entry
+      return nil if e.nil?
+      entry.send(*args)
+    end
+  end
+end

data/middleman-headless.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-headless'
+  s.version     = '0.3.0'
+  s.licenses    = ['MIT']
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Joël Gähwiler']
+  s.email       = ['joel@twomanyprojects.com']
+  s.homepage    = 'https://github.com/twomanyprojects/middleman-headless'
+  s.summary     = %q{Middleman extension to load content from the Headless Content Management System.}
+
+  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']
+
+  s.add_runtime_dependency('middleman-core', ['~> 4.1'])
+  s.add_runtime_dependency('oauth2', ['~> 1.2'])
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: middleman-headless
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Joël Gähwiler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 
+email:
+- joel@twomanyprojects.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/middleman-headless.rb
+- lib/middleman-headless/extension.rb
+- lib/middleman-headless/interface.rb
+- middleman-headless.gemspec
+homepage: https://github.com/twomanyprojects/middleman-headless
+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.2
+signing_key: 
+specification_version: 4
+summary: Middleman extension to load content from the Headless Content Management
+  System.
+test_files: []