jekyll-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b656a91c009904f95b4956eb10729f36c4e21abb
+  data.tar.gz: 4236602b696a518f49716c1ed897e6ff8aea6125
+SHA512:
+  metadata.gz: b198d7fdb00e690a68153ff6d25600923a2b3b852697b3007fe1449967f1514507bff4c1329db5d58f1f251fcc43060393c36cf4a67f98aeb21eb52bcbfae947
+  data.tar.gz: ba07b2fb4383520ea1aebeb3c01de06088643d5cea6d34024d0afb56a5f556e5e8c12e59c54c35ebf70e67b12e5949c33bbdc38063712bbc202a9ae2d4cc58c5

data/.gitignore

@@ -0,0 +1,5 @@
+/_site/
+/.bundle/
+/Gemfile.lock
+/pkg/
+/test/fixtures/**/data.json

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Greg Scott
+
+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,40 @@
+# Jekyll::API
+
+Create APIs from Jekyll page data.
+
+## Installation
+
+Follow [Jekyll's instructions for installing Jekyll plugins](http://jekyllrb.com/docs/plugins/#installing-a-plugin). The **Jekyll::API** plugin is available from the `jekyll-api` gem.
+
+## Usage
+
+1. Define data as front-matter in your Markdown Jekyll pages.
+2. Enjoy the API.
+
+For example, the **Jekyll::API** plugin will generate a `/people/jill/data.json` file
+
+```json
+{
+  "title": "Jill"
+}
+```
+
+ from the Jekyll page data in `/people/jill.md`.
+```yaml
+---
+title: Jill
+---
+Hi, my name is {{ page.title }}
+```
+
+If you set `permalink: pretty` in `_config.yml`, the resulting HTTP endpoints will be:
+* HTML - `/people/jill/`
+* JSON - `/people/jill/data.json`
+
+## Contributing
+
+1. Fork it (https://github.com/gregoryjscott/jekyll-api/fork).
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Add some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new Pull Request.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+
+desc 'Run tests'
+task :test do
+  system 'ruby -Ilib test/jekyll/api_test.rb'
+end
+
+task :default => :test

data/jekyll-api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/api/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = 'jekyll-api'
+  spec.version       = Jekyll::API::VERSION
+  spec.authors       = ['Greg Scott']
+  spec.email         = ['i@gregoryjscott.com']
+  spec.summary       = %q{Create APIs from Jekyll page data.}
+  spec.homepage      = 'https://github.com/gregoryjscott/jekyll-api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'jekyll', '~> 2.5'
+
+end

data/lib/jekyll/api/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module API
+    VERSION = "0.0.1"
+  end
+end

data/lib/jekyll/api/writer.rb

@@ -0,0 +1,33 @@
+require 'fileutils'
+
+module Jekyll
+  module API
+    class Writer < Jekyll::Generator
+
+      def generate(site)
+        @site = site
+        Dir.chdir(@site.source) { write_json }
+      end
+
+      def write_json
+        @site.pages.each do |page|
+          page_dir = File.dirname(page.path)
+          page_name = File.basename(page.path, ".*")
+          sub_dir = ''
+          sub_dir = File.join(sub_dir, page_dir) unless page_dir == '.'
+          sub_dir = File.join(sub_dir, page_name) unless page_name == 'index'
+
+          path = @site.source
+          path = File.join(path, sub_dir) unless sub_dir == ''
+          FileUtils.mkdir_p(path) unless Dir.exists?(path)
+
+          name = 'data.json'
+          File.write(File.join(path, name), JSON.dump(page.data))
+          json_file = Jekyll::StaticFile.new(@site, @site.source, sub_dir, name)
+          @site.static_files << json_file
+        end
+      end
+
+    end
+  end
+end

data/lib/jekyll/api.rb

@@ -0,0 +1,3 @@
+require 'jekyll'
+require 'jekyll/api/version'
+require 'jekyll/api/writer'

data/test/fixtures/index.md

@@ -0,0 +1,4 @@
+---
+title: Test
+---
+# {{ page.title }}

data/test/fixtures/people/jill.md

@@ -0,0 +1,4 @@
+---
+title: Jill
+---
+Hi, my name is {{ page.title }}

data/test/jekyll/api_test.rb

@@ -0,0 +1,34 @@
+require 'jekyll/api'
+require 'minitest/autorun'
+
+describe 'Jekyll::API' do
+
+  let(:config) do
+    Jekyll.configuration({
+      'source' => 'test/fixtures',
+      'permalink' => 'pretty',
+      'quiet' => true
+    })
+  end
+
+  let(:site) { Jekyll::Site.new(config) }
+
+  before(:each) do
+    clean
+    site.process
+  end
+
+  it 'creates JSON files for all pages' do
+    json_files_count = json_files.count { |file| File.file?(file) }
+    assert_equal site.pages.count, json_files_count
+  end
+
+  def json_files
+    Dir[File.join('_site', '**', 'data.json')]
+  end
+
+  def clean
+    json_files.each { |json_file| FileUtils.rm(json_file) }
+  end
+
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Greg Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: 
+email:
+- i@gregoryjscott.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-api.gemspec
+- lib/jekyll/api.rb
+- lib/jekyll/api/version.rb
+- lib/jekyll/api/writer.rb
+- test/fixtures/index.md
+- test/fixtures/people/jill.md
+- test/jekyll/api_test.rb
+homepage: https://github.com/gregoryjscott/jekyll-api
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Create APIs from Jekyll page data.
+test_files:
+- test/fixtures/index.md
+- test/fixtures/people/jill.md
+- test/jekyll/api_test.rb