middleman-api 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff76c79af0bdd288eb64afe2553d3dc4960d3248
-  data.tar.gz: a6718aa8ed1a1bc5629171cdde57eb93aeadad56
+  metadata.gz: b8adf32c44de93b020c1e960b594795deef6826d
+  data.tar.gz: 5ed241fc62eb24859ea4eca5d9fff5e9d3154226
 SHA512:
-  metadata.gz: 2aaa08b51a0b3f60a8597f1346d0969d09b758f47e3093bb3aec60f8c464cc3d22cbaf0e3e0d23fde05ade89c4a1b530bcefbf6e54a922ef33c9695edb2ad9c4
-  data.tar.gz: ce5e5c7bab76254bd8e302d82dc0a6778bc70b4644a7efebc5e5dbb2f5f253e825097ca43ede747bacb80825edfeb6faafdbcae060394c9b6ce76ab6baea7e57
+  metadata.gz: 3621601f77d78a370292f93f2ab6751daa04e034830163bdea501c3ccc6315081935dffe0bf0cd5386e10cc6f8a038dada155174d4e13ec8dc679b4b2cfb559b
+  data.tar.gz: 5b1017aa5d384c8fc74ff04eac51d27712bf48d538440f99a96e59be54364515f4ddfd17d8e96f21ce4080336f5c9131393955d68ffff16a0f415a6cb601babb

data/Gemfile

@@ -8,6 +8,12 @@ group :development do
   gem "yard",     "~> 0.8.0"
 end
 
+if RUBY_VERSION <= "1.9.3"
+  gem "pry-debugger"
+else
+  gem "pry-byebug"
+end
+
 group :test do
   gem "middleman", github: "middleman/middleman", branch: "v3-stable" do
     gem "middleman"
@@ -20,12 +26,6 @@ group :test do
   gem "aruba",    "~> 0.4.11"
   gem "rspec",    "~> 2.7"
 
-  if RUBY_VERSION <= "1.9.3"
-    gem "pry-debugger"
-  else
-    gem "pry-byebug"
-  end
-
   # Template Engines
   gem "redcarpet"
   gem "slim"

data/features/support/env.rb

@@ -1,4 +1,9 @@
 PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
 require "middleman-core"
 require "middleman-core/step_definitions"
+
+# Don't encode html entities for tests
+require 'active_support/json'
+ActiveSupport.escape_html_entities_in_json = false
+
 require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-api')

data/lib/middleman-api.rb

@@ -1,7 +1 @@
-require "middleman-core"
-require "middleman-more"
-
-Middleman::Extensions.register(:api) do
-  require "middleman-api/extension"
-  Middleman::Api
-end
+require "middleman-api/extension"

data/lib/middleman-api/extension.rb

@@ -1,32 +1,80 @@
-require "middleman-api/template"
-require "middleman-api/sitemap"
+require "active_support/core_ext"
 
 # Extension namespace
 module Middleman::Api
-  class << self
+  class Extension < ::Middleman::Extension
 
-    # Called when extension is activated
-    def registered(app, options={})
-      # Add class methods to context
-      app.send :include, ClassMethods
+    # Support for .json and .xml
+    option :formats, [:json, :xml]
 
-      app.after_configuration do
-        # Register json.erb template
-        sitemap.register_resource_list_manipulator(:middleman_api_template, Middleman::Api::Template.new(self), false)
+    def after_configuration
+      # Hack to reload our templates dir into the FileWatcher API
+      # https://github.com/middleman/middleman/issues/1217#issuecomment-38014250
+      fix_templates_for_filewatcher!
+      app.ignore "__api/*"
+    end
+
+    def manipulate_resource_list(resources)
+      new_resources = []
+
+      options.formats.each do |format|
+        proxy_parent = ::Middleman::Sitemap::Resource.new(
+          app.sitemap, "__api/proxy.#{format}", fetch_template)
+        proxy_parent.add_metadata locals: { resource_data: nil }
+
+        new_resources << proxy_parent
+
+        resources.each do |resource|
+          ext = resource.ext.gsub('.','').to_sym
 
-        # Register resource manipulator for pages with frontmatter
-        sitemap.register_resource_list_manipulator(:middleman_api, Middleman::Api::Sitemap.new(self), false)
+          next if resource.ignored? || ext == format
+          next unless resource.template?
+
+          new_resources << add_proxy_for_format(resource, format)
+        end
       end
+
+      return resources + new_resources
     end
 
-    alias :included :registered
+    private
 
-    module ClassMethods
-      # @return [Hash]
-      def api_formats
-        [:json, :xml]
+      def fix_templates_for_filewatcher!
+        extension_templates_dir = File.expand_path('../', __FILE__)
+        templates_dir_relative_from_root = Pathname(extension_templates_dir)
+          .relative_path_from(Pathname(app.root))
+        app.files.reload_path(templates_dir_relative_from_root)
+      end
+
+      def add_proxy_for_format(resource, format)
+        path = "#{resource.destination_path.split('.').first}.#{format}"
+
+        proxy = ::Middleman::Sitemap::Resource.new(
+          app.sitemap, path, fetch_template)
+        proxy.add_metadata locals: template_data(resource, format)
+        proxy.add_metadata options: { layout: false }
+        proxy.proxy_to "__api/proxy.#{format}"
+
+        return proxy
+      end
+
+      # Resource data hash
+      # @return [Hash] resource data to be parsed into json
+      def template_data(resource, format)
+        data = {}
+        data[:resource_data] = {
+          meta:    resource.data,
+          path:    resource.url,
+          content: resource.render
+        }.send("to_#{format}")
+
+        return data
+      end
+
+      def fetch_template
+        File.expand_path("../template.erb", __FILE__)
       end
-    end
 
+    ::Middleman::Extensions.register(:api, Middleman::Api::Extension)
   end
 end

data/lib/middleman-api/template.erb

@@ -0,0 +1 @@
+<%= resource_data %>

data/middleman-api.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "middleman-api"
-  s.version     = "0.1.2"
+  s.version     = "0.2.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["jordanandree"]
   s.email       = ["jordanandree@gmail.com"]

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: middleman-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - jordanandree
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-04-27 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.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: middleman-more
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
 description: Middleman Extension that generates JSON and XML endpoints
@@ -59,7 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - Rakefile
@@ -85,10 +85,7 @@ files:
 - fixtures/middleman-app/source/tilt/textile.html.textile
 - lib/middleman-api.rb
 - lib/middleman-api/extension.rb
-- lib/middleman-api/sitemap.rb
-- lib/middleman-api/template.json.erb
-- lib/middleman-api/template.rb
-- lib/middleman-api/template.xml.erb
+- lib/middleman-api/template.erb
 - lib/middleman_extension.rb
 - middleman-api.gemspec
 - readme.md
@@ -101,17 +98,17 @@ 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.4.4
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Middleman Extension that generates JSON and XML endpoints

data/lib/middleman-api/sitemap.rb

@@ -1,39 +0,0 @@
-require "active_support/core_ext"
-
-module Middleman::Api
-  class Sitemap
-    def initialize(app)
-      @app = app
-    end
-
-    # Update the main sitemap resource list
-    # @return [void]
-    def manipulate_resource_list(resources)
-      proxies = []
-      resources.each do |resource|
-        ext = resource.ext.gsub('.','').to_sym
-        if resource.template? && !resource.ignored? && !(@app.api_formats.include?(ext))
-          @app.api_formats.each do |format|
-            path = "#{resource.destination_path.split('.').first}.#{format}"
-            proxy = ::Middleman::Sitemap::Resource.new(@app.sitemap, path)
-            proxy.proxy_to "api.#{format}"
-            proxy.add_metadata locals: template_data(resource, format)
-            proxy.add_metadata options: { layout: false }
-            proxies << proxy
-          end
-        end
-      end
-      proxies + resources
-    end
-
-    # Resource data hash
-    # @return [Hash] resource data to be parsed into json
-    def template_data(resource, format)
-      data = {}
-      data[:meta] = resource.data
-      data[:path] = resource.url
-      data[:content] = resource.render
-      { data: data.send("to_#{format}") }
-    end
-  end
-end

data/lib/middleman-api/template.json.erb

@@ -1 +0,0 @@
-<%= data %>

data/lib/middleman-api/template.rb

@@ -1,25 +0,0 @@
-module Middleman::Api
-  class Template
-    def initialize(app)
-      @app = app
-      @app.after_configuration do
-        api_formats.each {|f| ignore "api.#{f}"} 
-      end
-    end
-
-    # Update the main sitemap resource list
-    # @return [void]
-    def manipulate_resource_list(resources)
-      templates = []
-      @app.api_formats.each do |f|
-        templates << ::Middleman::Sitemap::Resource.new(@app.sitemap, "api.#{f}", template(f))
-      end
-      resources + templates
-    end
-
-    private
-      def template(format)
-        File.expand_path "../template.#{format}.erb", __FILE__
-      end
-  end
-end

data/lib/middleman-api/template.xml.erb

@@ -1 +0,0 @@
-<%= data %>