doc_repo 0.1.1 → 1.0.0.pre.beta.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doc_repo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0.pre.beta.1
 platform: ruby
 authors:
 - Christopher Sexton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rouge
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
 description: 'Doc Repo: Load in app documentation via an external Github repo'
 email:
 - github@codeography.com
@@ -104,25 +104,36 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/digests.rb
 - 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/doc.rb
+- lib/doc_repo/error.rb
+- lib/doc_repo/gateway_error.rb
+- lib/doc_repo/http_error.rb
+- lib/doc_repo/http_result.rb
+- lib/doc_repo/net_http_adapter.rb
+- lib/doc_repo/rails.rb
+- lib/doc_repo/rails/legacy_versioned_cache.rb
+- lib/doc_repo/redirect.rb
 - lib/doc_repo/repository.rb
-- lib/doc_repo/response.rb
+- lib/doc_repo/result_handler.rb
 - lib/doc_repo/version.rb
 - spec/doc_repo/configuration_spec.rb
-- spec/doc_repo/page_spec.rb
+- spec/doc_repo/doc_spec.rb
+- spec/doc_repo/net_http_adapter_spec.rb
 - spec/doc_repo/repository_spec.rb
-- spec/doc_repo/response_spec.rb
+- spec/doc_repo/result_handler_spec.rb
 - spec/doc_repo_spec.rb
 - spec/spec_helper.rb
+- spec/support/in_memory_cache.rb
 - spec/support/string.rb
 - spec/support/using_env.rb
 homepage: https://github.com/RadiusNetworks/doc_repo
@@ -137,12 +148,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.11
@@ -151,10 +162,12 @@ specification_version: 4
 summary: 'Doc Repo: Load in app documentation via an external Github repo'
 test_files:
 - spec/doc_repo/configuration_spec.rb
-- spec/doc_repo/page_spec.rb
+- spec/doc_repo/doc_spec.rb
+- spec/doc_repo/net_http_adapter_spec.rb
 - spec/doc_repo/repository_spec.rb
-- spec/doc_repo/response_spec.rb
+- spec/doc_repo/result_handler_spec.rb
 - spec/doc_repo_spec.rb
 - spec/spec_helper.rb
+- spec/support/in_memory_cache.rb
 - spec/support/string.rb
 - spec/support/using_env.rb

data/lib/doc_repo/github_file.rb

@@ -1,45 +0,0 @@
-require 'open-uri'
-
-module DocRepo
-  class GithubFile
-
-    attr_reader :org, :repo, :branch, :file, :raw_url
-    def initialize(file,
-                   org: DocRepo.configuration.org,
-                   repo: DocRepo.configuration.repo,
-                   branch: DocRepo.configuration.branch)
-      @file = file
-      @org = org
-      @repo = repo
-      @branch = branch
-      @raw_url = url(file)
-    end
-
-    alias_method :redirect_url, :raw_url
-
-    def read_remote_file
-      open(raw_url, headers).read
-    rescue OpenURI::HTTPError => http_error
-      raise DocRepo::NotFound.new(base: http_error)
-    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://raw.githubusercontent.com/#{org}/#{repo}/#{branch}/docs/#{file}"
-    end
-  end
-end
-
-

data/lib/doc_repo/page.rb

@@ -1,35 +0,0 @@
-require "doc_repo/converters/markdown_parser"
-
-module DocRepo
-  class Page
-    attr_accessor :body
-
-    def initialize(file)
-      @body = GithubFile.new(default_ext(file)).read_remote_file
-    end
-
-    def default_ext(file)
-      if File.extname(file).empty?
-        "#{file}.md"
-      else
-        file
-      end
-    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/response.rb

@@ -1,25 +0,0 @@
-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/spec/doc_repo/page_spec.rb

@@ -1,44 +0,0 @@
-require 'support/string'
-require 'webmock/rspec'
-
-RSpec.describe DocRepo::Page do
-  before do
-    DocRepo.configure do |c|
-      c.org = 'RadiusNetworks'
-      c.repo = 'doc_spec'
-      c.branch = 'master'
-    end
-  end
-
-  let(:body){
-    <<-END.strip_heredoc
-      # A heading
-
-      Some content
-    END
-  }
-
-  let(:rendered_html){
-    <<-END.strip_heredoc
-      <h1 id=\"a-heading\">A heading</h1>
-
-      <p>Some content</p>
-    END
-  }
-
-  it "returns the markdown as html when there is no extension" do
-    stub_request(:get, "https://raw.githubusercontent.com/RadiusNetworks/doc_spec/master/docs/page.md")
-      .to_return(body: body)
-
-    page = DocRepo::Page.new("page")
-    expect(page.to_html).to eq rendered_html
-  end
-
-  it "returns the markdown as html when there is a .md extension" do
-    stub_request(:get, "https://raw.githubusercontent.com/RadiusNetworks/doc_spec/master/docs/page.md")
-      .to_return(body: body)
-
-    page = DocRepo::Page.new("page.md")
-    expect(page.to_html).to eq rendered_html
-  end
-end

data/spec/doc_repo/response_spec.rb

@@ -1,19 +0,0 @@
-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
-