doc_repo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30dd0cd755d3202ed2e493d13e43283ad50be7ae
+  data.tar.gz: d87c1f901a3e3a63f165b8211b0e7049a48ea9be
+SHA512:
+  metadata.gz: 18271a91e38f64eedfe8823d23fc0106953dc7e7c8f2ecb48c8f41dd54161fe46aaf164e09101c5486ad9fb8ae2a8f5a7bb2fa4ff85127d562a15eb8e0d46c97
+  data.tar.gz: 9e34106363f55e04f7a8e9371b08bc2b18f7862a07b77db118986707592eacd9f0dbf5b8e4328ba11ab06cdcd5af4415c165f4e008ed2a23ed6860fbafb8a25d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in doc_repo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Radius Networks
+
+MIT License
+
+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,75 @@
+# DocRepo
+
+Store your markdown based documentation in a repo but serve it from with in your app.
+
+This is a little project that will pull raw markdown from the GitHub API and proxy them through your app. This lets you render things in your app, customize the layout and access control -- but lets you update the docs without re-deploying.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'doc_repo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doc_repo
+
+## Usage
+
+Create an initializer to configure Doc Repo, in rails this would live in `config/initializers/doc_repo.rb`:
+
+```ruby
+DocRepo.configure do |c|
+  # GitHub Orgnization or User:
+  c.org = "RadiusNetworks"
+
+  # GitHub Repo:
+  c.repo = "proximitykit-documentation"
+
+  # Git Branch (Optional):
+  c.branch = "master"
+end
+```
+
+Create a controller to render the documentation pages. In Rails you might use something like this:
+
+```ruby
+class DocsController < ApplicationController
+  def index
+    # If you don't want to store the index view in the app, just redirect to one of the documentation pages:
+    redirect_to doc_path('index')
+  end
+
+  def show
+    DocRepo.respond_with(params[:slug]) do |f|
+      # Render the body:
+      f.html {|body| render text: body, layout: "docs" }
+
+      # Redirect to images and assets:
+      f.redirect {|url| redirect_to url }
+    end
+  rescue DocRepo::NotFound
+    raise ActionController::RoutingError.new('Not Found')
+  end
+
+end
+```
+
+## Contributing
+
+1. Fork it
+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
+
+## License
+
+MIT License.  See the [LICENSE file](LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/doc_repo.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doc_repo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doc_repo"
+  spec.version       = DocRepo::VERSION
+  spec.authors       = ["Christopher Sexton"]
+  spec.email         = ["github@codeography.com"]
+  spec.summary       = "Doc Repo: Load in app documentation via an external Github repo"
+  spec.description   = ""
+  spec.homepage      = ""
+  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_dependency "rouge", "~> 1.6"
+  spec.add_dependency "redcarpet", "~> 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "webmock", "~> 1.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/doc_repo/configuration.rb

@@ -0,0 +1,10 @@
+module DocRepo
+  class Configuration
+    attr_accessor :org, :repo, :branch
+
+    def initialize
+      @org = "RadiusNetworks"
+      @branch = "master"
+    end
+  end
+end

data/lib/doc_repo/converters/markdown_parser.rb

@@ -0,0 +1,58 @@
+# Taken and modified from the Jekyll project under the MIT License
+# https://github.com/jekyll/jekyll/blob/6849d6a/lib/jekyll/converters/markdown/redcarpet_parser.rb
+# https://github.com/jekyll/jekyll/blob/6849d6a/LICENSE
+require 'redcarpet'
+require 'rouge'
+require 'rouge/plugins/redcarpet'
+
+module DocRepo
+  module Converters
+    class MarkdownParser
+      class RougeRenderer < Redcarpet::Render::HTML
+        include Rouge::Plugins::Redcarpet
+
+        def add_code_tags(code, lang)
+          code = code.to_s
+          code = code.sub(
+            /<pre>/,
+            "<pre><code class=\"language-#{lang}\" data-lang=\"#{lang}\">"
+          )
+          code = code.sub(/<\/pre>/, "</code></pre>")
+        end
+
+        def block_code(code, lang)
+          code = "<pre>#{super}</pre>"
+          "<div class=\"highlight\">#{add_code_tags(code, lang)}</div>"
+        end
+
+        protected
+
+        def rouge_formatter(opts = {})
+          Rouge::Formatters::HTML.new(opts.merge(wrap: false))
+        end
+      end
+
+      def initialize(config)
+        @config = config
+        @extensions = config.fetch(:extensions, [])
+          .each_with_object({}){ |e, h| h[e.to_sym] = true }
+        @extensions[:fenced_code_blocks] ||= !@extensions.fetch(:no_fenced_code_blocks, false)
+        @extensions[:fenced_code_blocks] ||= !@extensions[:no_fenced_code_blocks]
+
+        render_class = config.fetch(:render_with, RougeRenderer)
+        @renderer = render_class.new(@extensions)
+        if extensions.fetch(:smart, false)
+          @renderer.extend Redcarpet::Render::SmartyPants
+        end
+      end
+
+      def convert(content)
+        markdown = Redcarpet::Markdown.new(renderer, extensions)
+        markdown.render(content)
+      end
+
+      private
+      attr_reader :config, :extensions, :renderer
+    end
+  end
+end

data/lib/doc_repo/github_file.rb

@@ -0,0 +1,46 @@
+require 'open-uri'
+
+module DocRepo
+  class GithubFile
+
+    attr_reader :org, :repo, :branch, :file
+    def initialize(file,
+                   org: DocRepo.configuration.org,
+                   repo: DocRepo.configuration.repo,
+                   branch: DocRepo.configuration.branch)
+      @file = file
+      @org = org
+      @repo = repo
+      @branch = branch
+    end
+
+    def redirect_url
+      "https://github.com/#{org}/#{repo}/raw/#{branch}/docs/#{file}"
+    end
+
+    def read_remote_file
+      open(url(file), headers).read
+    rescue OpenURI::HTTPError => e
+      raise DocRepo::NotFound
+    end
+
+    def headers
+      hash = {
+        "Accept"  => "application/vnd.github.v3.raw",
+        "User-Agent" => "RadiusNetworks-ProximityKit",
+      }
+
+      if ENV["GITHUB_TOKEN"]
+        hash["Authorization"] = "token #{ENV["GITHUB_TOKEN"]}"
+      end
+
+      hash
+    end
+
+    def url(file)
+      "https://api.github.com/repos/#{org}/#{repo}/contents/docs/#{file}?ref=#{branch}"
+    end
+  end
+end
+
+

data/lib/doc_repo/page.rb

@@ -0,0 +1,25 @@
+module DocRepo
+  class Page
+    attr_accessor :body
+
+    def initialize(file)
+      @body = GithubFile.new("#{file}.md").read_remote_file
+    end
+
+    def to_html
+      Converters::MarkdownParser.new(
+        extensions: %i[
+          no_intra_emphasis
+          tables
+          fenced_code_blocks
+          autolink
+          strikethrough
+          lax_spacing
+          superscript
+          with_toc_data
+        ]
+      ).convert(body)
+    end
+
+  end
+end

data/lib/doc_repo/repository.rb

@@ -0,0 +1,22 @@
+module DocRepo
+  class Repository
+    def respond(slug, &block)
+      if %w(.jpg .png .jpeg .svg .css .txt).include? File.extname(slug)
+        yield DocRepo::Response.redirect(get_redirect_url(slug))
+      else
+        yield DocRepo::Response.html(render_page(slug))
+      end
+    end
+
+    private
+
+    def render_page(slug)
+      DocRepo::Page.new(slug).to_html
+    end
+
+    def get_redirect_url(slug)
+      GithubFile.new(slug).redirect_url
+    end
+  end
+end
+

data/lib/doc_repo/response.rb

@@ -0,0 +1,25 @@
+module DocRepo
+  class Response
+    attr_reader :type, :params
+    def initialize(type, params)
+      @type = type ; @params = params
+    end
+
+    def self.html(*params)
+      self.new :html, params
+    end
+
+    def self.redirect(*params)
+      self.new :redirect, params
+    end
+
+    def html
+      yield *params if type == :html
+    end
+
+    def redirect
+      yield *params if type == :redirect
+    end
+  end
+end
+

data/lib/doc_repo/version.rb

@@ -0,0 +1,3 @@
+module DocRepo
+  VERSION = "0.0.1"
+end

data/lib/doc_repo.rb

@@ -0,0 +1,27 @@
+require "doc_repo/version"
+
+require "doc_repo/configuration"
+require "doc_repo/github_file"
+require "doc_repo/page"
+require "doc_repo/repository"
+require "doc_repo/response"
+require "doc_repo/converters/markdown_parser"
+
+module DocRepo
+  BadPageFormat = Class.new(StandardError)
+  NotFound      = Class.new(StandardError)
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  def self.respond_with(slug, &block)
+    Repository.new.respond(slug, &block)
+  end
+end
+

data/spec/doc_repo/page_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+RSpec.describe DocRepo::Page do
+  def tempfile(body)
+    Tempfile.open("spec") do |f|
+      f.puts body
+      f.rewind
+      yield f
+    end
+  end
+
+  it "returns the markdown as html" do
+    body = <<-END.strip_heredoc
+      # A heading
+
+      Some content
+    END
+
+    stub_request(:get, "https://api.github.com/repos/RadiusNetworks/doc_spec/contents/docs/page.md?ref=master")
+      .to_return(body: body)
+
+
+    page = DocRepo::Page.new("page")
+    expect(page.to_html).to eq <<-END.strip_heredoc
+        <h1 id=\"a-heading\">A heading</h1>
+
+        <p>Some content</p>
+    END
+  end
+end

data/spec/doc_repo/repository_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe DocRepo::Repository do
+
+  it "yields the file block for a jpg" do
+    repo = DocRepo::Repository.new
+
+    repo.respond("sonic_screwdriver.png") do |r|
+      expect { |b| r.redirect(&b) }.to yield_control
+      expect { |b| r.html(&b) }.not_to yield_control
+    end
+  end
+
+  it "determines the right mime type for a jpg" do
+    repo = DocRepo::Repository.new
+
+    repo.respond("sonic_screwdriver.png") do |r|
+      r.redirect do |url|
+        expect( url ).to match %r{.*raw/master/docs/sonic_screwdriver.png}
+      end
+    end
+  end
+end
+

data/spec/doc_repo/response_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe DocRepo::Page do
+  it "calls html block with 1 param" do
+    resp = DocRepo::Response.html 1
+    expect { |b| resp.html &b }.to yield_with_args(1)
+  end
+
+  it "calls html block with 2 params" do
+    resp = DocRepo::Response.html 1, 2
+    expect { |b| resp.html &b }.to yield_with_args(1, 2)
+  end
+
+  it "calls file block with 1 param" do
+    resp = DocRepo::Response.html "/path/to/file"
+    expect { |b| resp.html &b }.to yield_with_args("/path/to/file")
+  end
+end
+

data/spec/doc_repo_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+RSpec.describe DocRepo do
+
+  around do |ex|
+    # Save and Reset the configuration
+    original_config = DocRepo.configuration
+    ex.run
+    DocRepo.instance_variable_set :@configuration, original_config
+  end
+
+  it "yields the configuration" do
+      expect { |b|
+        DocRepo.configure(&b)
+      }.to yield_control
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'webmock/rspec'
+require 'pry'
+require 'doc_repo'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+  config.before do
+    DocRepo.configure do |c|
+      c.org = 'RadiusNetworks'
+      c.repo = 'doc_spec'
+    end
+  end
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  config.warnings = true
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+  Kernel.srand config.seed
+end

data/spec/support/string.rb

@@ -0,0 +1,9 @@
+unless String.new.respond_to? :strip_heredoc
+  String.instance_eval do # self is set to String
+    define_method(:strip_heredoc) do # self is still String
+      leading_space = scan(/^[ \t]*(?=\S)/).min
+      indent = leading_space ? leading_space.size : 0
+      gsub(/^[ \t]{#{indent}}/, '')
+    end
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: doc_repo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christopher Sexton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- github@codeography.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc_repo.gemspec
+- lib/doc_repo.rb
+- lib/doc_repo/configuration.rb
+- lib/doc_repo/converters/markdown_parser.rb
+- lib/doc_repo/github_file.rb
+- lib/doc_repo/page.rb
+- lib/doc_repo/repository.rb
+- lib/doc_repo/response.rb
+- lib/doc_repo/version.rb
+- spec/doc_repo/page_spec.rb
+- spec/doc_repo/repository_spec.rb
+- spec/doc_repo/response_spec.rb
+- spec/doc_repo_spec.rb
+- spec/spec_helper.rb
+- spec/support/string.rb
+homepage: ''
+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: 'Doc Repo: Load in app documentation via an external Github repo'
+test_files:
+- spec/doc_repo/page_spec.rb
+- spec/doc_repo/repository_spec.rb
+- spec/doc_repo/response_spec.rb
+- spec/doc_repo_spec.rb
+- spec/spec_helper.rb
+- spec/support/string.rb