jekyll-github-pages-gem 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddae3765c69834ad6ce99f7877b24a82763b84091ef1a37f89e5cc59b9f33af9
-  data.tar.gz: 5e870fffed02cb6406dad46486f2ee27c89b1a3e2974f4c017550c0f992c5631
+  metadata.gz: '098a19ac5d1add1794fdeefedfb016295cc8425252f6fef8d779131d607c6e6f'
+  data.tar.gz: ded2b48d54fb483856e8f68f513bc43f6684991ae840fa8a52484ecefa88cd58
 SHA512:
-  metadata.gz: 89d97db24baa0f986183f43332e5932a29562057f2af5003bbd51a8e1a6de7f51227c5ee36c2d7ff13f4f30520d08f83bff8bb473b014b9ba1af4f7e573e9605
-  data.tar.gz: b913a38f11818fc3b92180e14858d54f5c72b522ba278b7fd8d314bbba2a6f855c336558c99bbcfafa52fa3ef21f03fae106f1d6836b5f3cdfe0433ef8a3f453
+  metadata.gz: cd88085069bfbc591964cd4b2e88149fcaba6ecfc5d2b36d75c7bfe90362f13c8983ee1dcf641d17951eb580e4d106aa806796bc3a59a00d6caf9751ca00d22a
+  data.tar.gz: 17eec0bca32dfa3671f5b44c50a80bdd3cba86ac266487b66a4c3e9c96f882d86352760971b486e666e5558b739c3b2f0430af193a2d5daa42ebf7f5de13a14d

data/Gemfile

@@ -3,7 +3,7 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'kramdown'
+gem 'kramdown', '~> 2.3.0'
 
 gem 'octokit', '~> 4.18'
 
@@ -16,6 +16,8 @@ gem 'faraday', '~> 0.17.1'
 
 gem 'rake'
 
+gem 'rdoc'
+
 group :test do
   gem 'minitest'
   gem 'mocha'

data/Gemfile.lock

@@ -1,14 +1,17 @@
 PATH
   remote: .
   specs:
-    jekyll-github-pages-gem (1.0.0)
+    jekyll-github-pages-gem (1.1.0)
+      carrierwave (>= 2.0.0.rc, < 3.0)
+      kramdown (~> 2.3.0)
+      octokit (~> 4.18)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activesupport (6.0.3.1)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -16,7 +19,7 @@ GEM
       zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
+    ast (2.4.1)
     carrierwave (2.1.0)
       activemodel (>= 5.0.0)
       activesupport (>= 5.0.0)
@@ -24,43 +27,47 @@ GEM
       image_processing (~> 1.1)
       mimemagic (>= 0.3.0)
       mini_mime (>= 0.1.3)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     docile (1.3.2)
     faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    ffi (1.12.2)
-    ffi (1.12.2-x64-mingw32)
-    i18n (1.8.2)
+    ffi (1.13.1-x64-mingw32)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    image_processing (1.10.3)
+    image_processing (1.11.0)
       mini_magick (>= 4.9.5, < 5)
       ruby-vips (>= 2.0.17, < 3)
-    jaro_winkler (1.5.4)
-    kramdown (2.1.0)
-    mimemagic (0.3.4)
+    kramdown (2.3.0)
+      rexml
+    mimemagic (0.3.5)
     mini_magick (4.10.1)
     mini_mime (1.0.2)
-    minitest (5.14.0)
+    minitest (5.14.1)
     mocha (1.11.2)
     multipart-post (2.1.1)
     octokit (4.18.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    parallel (1.19.1)
-    parser (2.7.1.0)
-      ast (~> 2.4.0)
-    public_suffix (4.0.4)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    public_suffix (4.0.5)
     rainbow (3.0.0)
     rake (13.0.1)
+    rdoc (6.2.1)
+    regexp_parser (1.7.1)
     rexml (3.2.4)
-    rubocop (0.81.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.89.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
     ruby-vips (2.0.17)
       ffi (~> 1.9)
@@ -75,21 +82,21 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
-  ruby
   x64-mingw32
 
 DEPENDENCIES
   carrierwave (>= 2.0.0.rc, < 3.0)
   faraday (~> 0.17.1)
   jekyll-github-pages-gem!
-  kramdown
+  kramdown (~> 2.3.0)
   minitest
   mocha
   octokit (~> 4.18)
   rake
+  rdoc
   rubocop (~> 0.71)
   simplecov
 

data/README.md

@@ -9,8 +9,11 @@
 Our git flow process is typical--we have a master branch that gets released to the public, and feature branches for individual tasks. We don't have a development branch yet since this isn't used in production yet.
 If you have questions on how to contribute, please contact admin@msoe-sse.com or msoe.sg.hosting@gmail.com and we will get back to you at our earliest convenience.
 
+## Generating HTML Documentation
+To generate HTML documentation for the Gem run the command `rake rdoc` and the HTML will then be available in the `html/` directory in the project.
+
 ## Continuous Integration
 There are checks that will be performed whenever Pull Requests are opened.  To save time on the build server, please run the tests locally to check for errors that will occur in the CI builds.
 
-1. To run [Rubocop](https://github.com/ashmaroli/rubocop-jekyll), run the command `bundle exec rubocop`
+1. To run [Rubocop](https://github.com/ashmaroli/rubocop-jekyll), run the command `bundle exec rubocop`. Note the command `bundle exec rubocop -a` will attempt to automatically fix any offenses found by rubocop but some still need to be resolved manually.
 2. To run all unit tests, run the command `rake`

data/Rakefile

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
 require 'rake/testtask'
+require 'rdoc/task'
 
 task default: 'test'
 
 Rake::TestTask.new do |t|
   t.test_files = FileList['tests/**/*_test.rb']
 end
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/jekyll_github_pages.gemspec

@@ -2,10 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name = 'jekyll-github-pages-gem'
-  s.version = '1.0.1'
+  s.version = '1.1.0'
   s.summary = 'A gem that uses the github API to make edits with a jekyll blog'
   s.files = Dir['*', 'lib/**/*']
   s.require_paths = ['lib']
   s.licenses = ['MIT']
   s.authors = ['MSOE SSE Web Team']
+  s.add_runtime_dependency('carrierwave', '>= 2.0.0.rc', '< 3.0')
+  s.add_runtime_dependency('kramdown', '~> 2.3.0')
+  s.add_runtime_dependency('octokit', '~> 4.18')
+  s.required_ruby_version = '>= 2.5.1'
 end

data/lib/factories/base_factory.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'kramdown'
+
+module Factories
+  ##
+  # The base class for all jekyll factories
+  class BaseFactory
+    protected
+
+    def fix_header_syntax(text)
+      document = Kramdown::Document.new(text)
+      header_elements = document.root.children.select { |x| x.type == :header }
+      lines = text.split("\n")
+      lines = lines.map do |line|
+        if header_elements.any? { |x| line.include? x.options[:raw_text] }
+          # This regex matches the line into 2 groups with the first group being the repeating #
+          # characters and the beginning of the string and the second group being the rest of the string
+          line_match = line.match(/(#*)(.*)/)
+          line = "#{line_match.captures.first} #{line_match.captures.last.strip}"
+        else
+          line.delete("\r\n")
+        end
+      end
+      lines.join("\r\n")
+    end
+
+    def add_line_break_to_markdown_if_necessary(markdown)
+      lines = markdown.split("\n")
+      # The regular expression in the if statement looks for a markdown reference to a link like
+      # [logo]: https://ieeextreme.org/wp-content/uploads/2019/05/Xtreme_colour-e1557478323964.png
+      # If a post starts with that reference in jekyll followed by an image using that reference
+      # the line below will be interperted as a paragraph tag instead of an image tag. To fix that
+      # we add a line break to the start of the markdown.
+      return "\r\n#{markdown}" if lines.first&.match?(/\[(.*)\]: (.*)/)
+
+      markdown
+    end
+  end
+end

data/lib/factories/page_factory.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative '../models/page'
+
+module Factories
+  ##
+  # This class is a factory for parsing page text and creating a correseponding page model
+  class PageFactory < BaseFactory
+    ##
+    # This method parses markdown in a page a returns a page model
+    #
+    # Params:
+    # +page_contents+::markdown in a given page
+    # +github_ref+::a sha for a ref indicating the head of a branch a page is pushed to on the GitHub server
+    # +pull_request_url+::a url to the pull request with the branch the pull request is pushed to on the GitHub server
+    def create_page(page_contents, github_ref, pull_request_url)
+      create_page_model(page_contents, github_ref, pull_request_url) if !page_contents.nil? && page_contents.is_a?(String)
+    end
+
+    ##
+    # This method takes parameters for a given page and formats them
+    # as a valid page for a Jekyll website
+    #
+    # Params:
+    # +text+:: the required markdown contents of the post
+    # +title+:: the required title of the post
+    # +permalink+:: the link to the page on a Jekyll website (e.g /about)
+    def create_jekyll_page_text(text, title, permalink)
+      header_converted_text = fix_header_syntax(text)
+      header_converted_text = add_line_break_to_markdown_if_necessary(header_converted_text)
+
+      %(---
+layout: page
+title: #{title}
+permalink: #{permalink}
+---
+#{header_converted_text})
+    end
+
+    private
+
+    def create_page_model(page_contents, github_ref, pull_request_url)
+      result = Page.new
+
+      result.github_ref = github_ref
+      result.pull_request_url = pull_request_url
+
+      # What this regular expression does is it matches three groups
+      # The first group represents the header of the page which appears
+      # between the two --- lines. The second group is for helping capture newline characters
+      # correctly and the third group is the actual page contents
+      match_obj = page_contents.match(/---(.*)---(\r\n|\r|\n)(.*)/m)
+      header = match_obj.captures[0]
+      parse_page_header(header, result)
+      result.contents = match_obj.captures[2]
+
+      result
+    end
+
+    def parse_page_header(header, page_model)
+      # The following regular expressions in this method look for specific properities
+      # located in the post header.
+      page_model.title = header.match(/title:\s*(.*)(\r\n|\r|\n)/).captures.first
+      page_model.permalink = header.match(/permalink:\s*(.*)(\r\n|\r|\n)/).captures.first
+    end
+  end
+end

data/lib/factories/post_factory.rb

@@ -5,7 +5,7 @@ require_relative '../models/post'
 module Factories
   ##
   # This class is a factory for parsing post text and creating a correseponding post model
-  class PostFactory
+  class PostFactory < BaseFactory
     LEAD = '{: .lead}'
     BREAK = '<!–-break-–>'
 
@@ -23,6 +23,50 @@ module Factories
       create_post_model(post_contents, file_path, ref) if !post_contents.nil? && post_contents.is_a?(String)
     end
 
+    ##
+    # This method takes parameters for a given post and formats them
+    # as a valid post for a Jekyll website
+    #
+    # Params:
+    # +text+:: the required markdown contents of the post
+    # +author+:: the required author of the post
+    # +title+:: the required title of the post
+    # +tags+:: optional tags specific to the post, defaults to nil
+    # +overlay+:: the optional overlay color of the post, defaults to nil
+    # +hero+:: a link to an optional background image for a post, defaults to nil
+    # +set_published_property+::an optional flag to set the published: true property for a post, defaults to false
+    # +append_lead_break_section+::an optional flag indicating whether to append to lead break section to a post, default to false
+    def create_jekyll_post_text(text, author, title, tags = nil, overlay = nil,
+                                hero = nil, set_published_property = false, append_lead_break_section = false)
+      header_converted_text = fix_header_syntax(text)
+      header_converted_text = add_line_break_to_markdown_if_necessary(header_converted_text)
+
+      parsed_tags = nil
+      parsed_tags = format_tags(tags) if tags
+
+      tag_section = %(tags:
+#{parsed_tags})
+
+      lead_break_section = "{: .lead}\r\n<!–-break-–>"
+
+      hero_to_use = hero
+      hero_to_use = DEFAULT_HERO if hero_to_use&.empty?
+      result = %(---
+layout: post
+title: #{title}
+author: #{author}\r\n)
+
+      result += "#{tag_section}\r\n" unless !parsed_tags || parsed_tags.empty?
+      result += "hero: #{hero_to_use}\n" if hero_to_use
+      result += "overlay: #{overlay}\n" if overlay
+      result += "published: true\n" if set_published_property
+      result += "---\n"
+      result += "#{lead_break_section}\n" if append_lead_break_section
+      result += header_converted_text
+
+      result
+    end
+
     private
 
     def parse_tags(header)
@@ -34,6 +78,16 @@ module Factories
       result.join(', ')
     end
 
+    def format_tags(tags)
+      tag_array = tags.split(',')
+      result = ''
+      tag_array.each do |tag|
+        result += "  - #{tag.strip}"
+        result += "\r\n" if tag != tag_array.last
+      end
+      result
+    end
+
     def create_post_model(post_contents, file_path, ref)
       result = Post.new
 

data/lib/jekyll_github_pages.rb

@@ -4,15 +4,17 @@
 require 'carrierwave'
 
 # Source Files
+require 'factories/base_factory'
 require 'factories/post_factory'
-require 'services/post_services/base_post_service'
-require 'services/post_services/post_creation_service'
-require 'services/post_services/post_editing_service'
-require 'services/post_services/post_pull_request_editing_service'
-require 'services/github_service'
+require 'factories/page_factory'
 
+require 'services/base_editing_service'
+require 'services/github_service'
 require 'services/kramdown_service'
+require 'services/page_service'
+require 'services/post_service'
 
+require 'models/page'
 require 'models/post'
 require 'models/post_image_manager'
 

data/lib/models/page.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+##
+# An object repsenting a page on a Jekyll website
+class Page
+  attr_accessor :title
+  attr_accessor :permalink
+  attr_accessor :contents
+  # The GitHub ref the page's markdown is at. This is used to indicate
+  # whether a page is in PR or not
+  attr_accessor :github_ref
+  attr_accessor :pull_request_url
+end

data/lib/services/{post_services/base_post_service.rb → base_editing_service.rb}

@@ -2,8 +2,8 @@
 
 module Services
   ##
-  # The base class for service classes responsible for performing operations on posts
-  class BasePostService
+  # The base class for service classes responsible for performing operations on the Jekyll website
+  class BaseEditingService
     def initialize(repo_name, access_token)
       @github_service = GithubService.new(repo_name, access_token)
       @kramdown_service = KramdownService.new

data/lib/services/github_service.rb

@@ -4,8 +4,6 @@ require 'octokit'
 require 'base64'
 require 'date'
 require 'cgi'
-require_relative 'kramdown_service'
-require_relative '../factories/post_factory'
 
 module Services
   ##
@@ -13,92 +11,13 @@ module Services
   class GithubService
     def initialize(full_repo_name, access_token)
       @full_repo_name = full_repo_name
-      @access_token = access_token
-
-      @kramdown_service = Services::KramdownService.new
-      @post_factory = Factories::PostFactory.new
-    end
-
-    ##
-    # This method fetches all the markdown contents of all the posts on a Jekyll website
-    # that have been written and returns a list of models representing a Post.
-    def get_all_posts
-      result = []
-      client = create_octokit_client
-      posts = client.contents(@full_repo_name, path: '_posts')
-      posts.each do |post|
-        post_api_response = client.contents(@full_repo_name, path: post.path)
-
-        post_model = create_post_from_api_response(post_api_response, nil)
-        image_paths = @kramdown_service.get_all_image_paths(post_model.contents)
-
-        images = []
-        image_paths.each do |image_path|
-          image_content = client.contents(@full_repo_name, path: image_path)
-          images << create_post_image(image_path, image_content.content)
-        end
-
-        post_model.images = images
-
-        result << post_model
-      end
-      result
-    end
-
-    ##
-    # This method fetches all of the posts that have been written but have not been merged into master yet.
-    def get_all_posts_in_pr(pr_body)
-      result = []
-      client = create_octokit_client
-      pull_requests_for_user = get_open_jekyll_pull_requests(pr_body)
-
-      pull_requests_for_user.each do |pull_request|
-        pull_request_files = client.pull_request_files(@full_repo_name, pull_request[:number])
-
-        post = nil
-        images = []
-        pull_request_files.each do |pull_request_file|
-          contents_url_params = CGI.parse(pull_request_file[:contents_url])
-
-          # The CGI.parse method returns a hash with the key being the URL and the value being an array of
-          # URI parameters so in order to get the ref we need to grab the first value in the hash and the first
-          # URI parameter in the first hash value
-          ref = contents_url_params.values.first.first
-          file_contents = client.contents(@full_repo_name, path: pull_request_file[:filename], ref: ref)
-
-          if pull_request_file[:filename].end_with?('.md')
-            post = create_post_from_api_response(file_contents, ref)
-            result << post
-          else
-            images << create_post_image(pull_request_file[:filename], file_contents.content)
-          end
-        end
-
-        post.images = images
-      end
-      result
-    end
-
-    ##
-    # This method fetches a single post from a Jekyll website given a post title
-    # and returns a Post model
-    #
-    # Params:
-    # +title+:: A title of a Jekyll website post
-    # +ref+::a sha for a ref indicating the head of a branch a post is pushed to on the GitHub server
-    def get_post_by_title(title, ref)
-      result = nil
-      result = get_all_posts_in_pr.find { |x| x.title == title } if ref
-      result = get_all_posts.find { |x| x.title == title } unless ref
-      result&.images&.each { |x| PostImageManager.instance.add_downloaded_image(x) }
-      result
+      @client = Octokit::Client.new(access_token: access_token)
     end
 
     ##
     # This method gets the sha of the commit at the head of master in a Jekyll website repo
     def get_master_head_sha
-      client = create_octokit_client
-      client.ref(@full_repo_name, 'heads/master')[:object][:sha]
+      @client.ref(@full_repo_name, 'heads/master')[:object][:sha]
     end
 
     ##
@@ -107,8 +26,7 @@ module Services
     # Params
     # +head_sha+::the sha of the head of a certain branch
     def get_base_tree_for_branch(head_sha)
-      client = create_octokit_client
-      client.commit(@full_repo_name, head_sha)[:commit][:tree][:sha]
+      @client.commit(@full_repo_name, head_sha)[:commit][:tree][:sha]
     end
 
     ##
@@ -117,8 +35,7 @@ module Services
     # Params
     # +text+::the text content to create a blob for
     def create_text_blob(text)
-      client = create_octokit_client
-      client.create_blob(@full_repo_name, text)
+      @client.create_blob(@full_repo_name, text)
     end
 
     ##
@@ -127,8 +44,7 @@ module Services
     # Params
     # +content+::the base 64 encoded content to create a blob for
     def create_base64_encoded_blob(content)
-      client = create_octokit_client
-      client.create_blob(@full_repo_name, content, 'base64')
+      @client.create_blob(@full_repo_name, content, 'base64')
     end
 
     ##
@@ -140,7 +56,6 @@ module Services
     # +file_information+::an array of hashes containing the file path and the blob sha for a file
     # +sha_base_tree+::the sha of the base tree
     def create_new_tree_with_blobs(file_information, sha_base_tree)
-      client = create_octokit_client
       blob_information = []
       file_information.each do |file|
         # This mode property on this hash represents the file mode for a GitHub tree.
@@ -150,24 +65,24 @@ module Services
                               type: 'blob',
                               sha: file[:blob_sha] }
       end
-      client.create_tree(@full_repo_name, blob_information, base_tree: sha_base_tree)[:sha]
+      @client.create_tree(@full_repo_name, blob_information, base_tree: sha_base_tree)[:sha]
     end
 
     ##
-    # This method commits and pushes a tree to a Jekyll website repo
+    # This method commits and pushes a tree to a Jekyll website repo and returns the sha of the new commit
     #
     # Params:
     # +commit_message+::the message for the new commit
     # +tree_sha+::the sha of the tree to commit
     # +head_sha+::the sha of the head to commit from
     def commit_and_push_to_repo(commit_message, tree_sha, head_sha, ref_name)
-      client = create_octokit_client
-      sha_new_commit = client.create_commit(@full_repo_name, commit_message, tree_sha, head_sha)[:sha]
-      client.update_ref(@full_repo_name, ref_name, sha_new_commit)
+      sha_new_commit = @client.create_commit(@full_repo_name, commit_message, tree_sha, head_sha)[:sha]
+      @client.update_ref(@full_repo_name, ref_name, sha_new_commit)
+      sha_new_commit
     end
 
     ##
-    # This method creates a pull request for a branch in a Jekyll website repo
+    # This method creates a pull request for a branch in a Jekyll website repo and returns the url of the newly created pull request
     #
     # Params:
     # +source_branch+::the source branch for the PR
@@ -176,9 +91,9 @@ module Services
     # +pr_body+::the body for the PR
     # +reviewers+::an array of pull request reviewers for the PR
     def create_pull_request(source_branch, base_branch, pr_title, pr_body, reviewers)
-      client = create_octokit_client
-      pull_number = client.create_pull_request(@full_repo_name, base_branch, source_branch, pr_title, pr_body)[:number]
-      client.request_pull_request_review(@full_repo_name, pull_number, reviewers: reviewers)
+      pull_request = @client.create_pull_request(@full_repo_name, base_branch, source_branch, pr_title, pr_body)
+      @client.request_pull_request_review(@full_repo_name, pull_request[:number], reviewers: reviewers)
+      pull_request[:html_url]
     end
 
     ##
@@ -189,10 +104,9 @@ module Services
     # +ref_name+:: the name of the branch to create if necessary
     # +master_head_sha+:: the sha representing the head of master
     def create_ref_if_necessary(ref_name, master_head_sha)
-      client = create_octokit_client
-      client.ref(@full_repo_name, ref_name)
+      @client.ref(@full_repo_name, ref_name)
     rescue Octokit::NotFound
-      client.create_ref(@full_repo_name, ref_name, master_head_sha)
+      @client.create_ref(@full_repo_name, ref_name, master_head_sha)
     end
 
     ##
@@ -200,38 +114,71 @@ module Services
     # It will also strip off the starting refs portion of the name
     #
     # Params:
-    # +oauth_token+::a user's oauth access token
     # +ref_sha+:: the sha of the ref to fetch
     def get_ref_name_by_sha(ref_sha)
-      client = create_octokit_client
-      ref_response = client.refs(@full_repo_name).find { |x| x[:object][:sha] == ref_sha }
+      ref_response = @client.refs(@full_repo_name).find { |x| x[:object][:sha] == ref_sha }
       ref_response[:ref].match(%r{refs/(.*)}).captures.first
     end
 
-    private
+    ##
+    # This method will fetch and decode contents of a given file with text contents on GitHub.
+    # By default, it will fetch the file contents from the master branch unless a ref to a branch
+    # is supplied
+    #
+    # Params:
+    # +file_path+::the path to a file in a GitHub repo
+    # +ref+::an optional ref to a branch to fetch the file from
+    def get_text_contents_from_file(file_path, ref = nil)
+      api_contents = if ref
+                       @client.contents(@full_repo_name, path: file_path, ref: ref)
+                     else
+                       @client.contents(@full_repo_name, path: file_path)
+                     end
+      Base64.decode64(api_contents.content).dup.force_encoding('UTF-8')
+    end
 
-    def create_post_from_api_response(post, ref)
-      # Base64.decode64 will convert our string into a ASCII string
-      # calling force_encoding('UTF-8') will fix that problem
-      text_contents = Base64.decode64(post.content).dup.force_encoding('UTF-8')
-      @post_factory.create_post(text_contents, post.path, ref)
+    ##
+    # This method will fetch the GitHub contents for a given file on GitHub via the GitHub
+    # contents API. The full response from the API will be returned
+    #
+    # Params:
+    # +path+::the path to a file in a GitHub repo
+    def get_contents_from_path(path)
+      @client.contents(@full_repo_name, path: path)
     end
 
-    def get_open_jekyll_pull_requests(pull_request_body)
-      client = create_octokit_client
-      open_pull_requests = client.pull_requests(@full_repo_name, state: 'open')
-      open_pull_requests.select { |x| x[:body] == pull_request_body }
+    ##
+    # This method will fetch all open pull requests for the current user matching a specific PR body
+    #
+    # Params:
+    # +pull_request_body+::the body of the PR to look for
+    def get_open_pull_requests_with_body(pull_request_body)
+      open_pull_requests = @client.pull_requests(@full_repo_name, state: 'open')
+      open_pull_requests.select { |x| x[:body] == pull_request_body && x[:user][:login] == @client.user[:login] }
     end
 
-    def create_post_image(filename, contents)
-      result = PostImage.new
-      result.filename = filename
-      result.contents = contents
-      result
+    ##
+    # This method will fetch all pull request files for a given pull request
+    #
+    # Params:
+    # +pr_number+::the pull request number for the pull request to get all files for
+    def get_pr_files(pr_number)
+      @client.pull_request_files(@full_repo_name, pr_number)
     end
 
-    def create_octokit_client
-      Octokit::Client.new(access_token: @access_token)
+    ##
+    # Parses the URL for a file's contents to determine the ref of the file
+    # The ref is used to determine what branch the file is located on
+    #
+    # Params:
+    # +contents_url+::the contents url for a file in a GitHub repo
+    def get_ref_from_contents_url(contents_url)
+      contents_url_params = CGI.parse(contents_url)
+
+      # The CGI.parse method returns a hash with the key being the URL and the value being an array of
+      # URI parameters so in order to get the ref we need to grab the first value in the hash and the first
+      # URI parameter in the first hash value
+      contents_url_params.values.first.first
     end
   end
 end