reqres_rspec 0.0.30 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16e3a6ed401d13b632bd5ccc8600f1346715d3d6
-  data.tar.gz: bee53bd581700e1a7b6dd56d97dc7caa3716d0a1
+  metadata.gz: 4f574d33801a5576da4abaffffb99110a428a358
+  data.tar.gz: e303ce1d7e6ba81ce6fe00c21d6ba38e3056ff6d
 SHA512:
-  metadata.gz: ea8fdd6b422fa2d15ca3fd1ec95062142de46cdbd46e653f41c3f5637e8bf7da595a242029c2b7477b10822bf30259589af5623880a04e9ee52e5b4ba4e3f479
-  data.tar.gz: ea7c0260a238d9922b9ecb50013234b59839c9906c9967debf2c87e0b62a9af724dabf74f1c697d7c773f820f82d1f01c98521427ae5ce287263e5e579e20008
+  metadata.gz: 41ea72db92b4ba65ccdbf5623198e5282a05ab0229d14ff6ecf2ee9b0117b7e8ee3d023adc92e9ce74e6537d3690aef5bfe00349901c451bb62310d35cd60d68
+  data.tar.gz: c9aab7c397bdb1e6f642e7c9e89aadbe17b84b379bb51403574fd1947ddb156ab8dde99a52945621cd96455076ee746840413f4f7c14b410c90d2e12774069fc

data/README.md

@@ -37,6 +37,12 @@ by default `reqres_rspec` is not active (this may be configured!). To activate i
 
 Documentation will be put into your application's `/doc` folder
 
+## Upload to S3
+
+By default ReqRes will use `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION` and `AWS_REQRES_BUCKET` environment variables. But you can alter that in configuration, see below.
+
+`REQRES_UPLOAD=1 REQRES_RSPEC=1 bundle exec rspec --order=defined`
+
 ### Sample controller action
 
 ```ruby
@@ -79,6 +85,21 @@ Each param text is started with `@param` and first word will be param name, then
 
  Doc will use full example description, as a title for each separate spec
 
+If you want to group examples in another way, you can do something like:
+
+```ruby
+describe 'Something', reqres_section: 'Foo' do
+  context 'valid params', reqres_title: 'Bakes Pie' do
+    it 'works' do
+      ...
+    end
+  end
+end
+```
+
+In this case all the `reqres_sections` can be used for grouping colleced data into section, and `reqres_title` will become human readable titles:
+[![Cusomized titles](http://i57.tinypic.com/2581lw9.jpg)](http://i57.tinypic.com/2581lw9.jpg)
+
 ### Generates documentation example
 
 [![Generated Doc](http://i44.tinypic.com/kda1pw.png)](http://i44.tinypic.com/kda1pw.png)
@@ -88,7 +109,59 @@ Documentation is written in HTML format, which then converted to PDF. PDF files
 
 ## Configuration
 
-TODO: Write instruction on gem configuration
+```ruby
+ReqresRspec.configure do |c|
+  c.templates_path = Rails.root.join('spec/support/reqres/templates') # Path to custom templates
+  c.output_path = 'some path' # by default it will use doc/reqres
+  c.formatters = %w(MyCustomFormatter) # List of custom formatters, these can be inherited from ReqresRspec::Formatters::HTML
+  c.title = 'My API Documentation' # Title for your documentation
+  c.amazon_s3 = {
+    credentials: {
+      access_key_id: ENV['AWS_ACCESS_KEY_ID'], # by default it will use AWS_ACCESS_KEY_ID env var
+      secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'], # by default it will use AWS_SECRET_ACCESS_KEY env var
+      region: (ENV['AWS_REGION'] || 'us-east-1'),
+    },
+    bucket: ENV['AWS_REQRES_BUCKET'], # by default it will use AWS_REQRES_BUCKET env for bucket name
+    enabled: false # Enable upload (only with REQRES_UPLOAD env var set)
+  }
+end
+```
+
+## Custom Formatter example
+
+```ruby
+class CustomAPIDoc < ReqresRspec::Formatters::HTML
+  private
+  def write
+    # Copy assets
+    %w(styles images components scripts).each do |folder|
+      FileUtils.cp_r(path(folder), output_path)
+    end
+
+    # Generate general pages
+    @pages = {
+      'index.html'          => 'Introduction',
+      'authentication.html' => 'Authentication',
+      'filtering.html'      => 'Filtering, Sorting and Pagination',
+      'locations.html'      => 'Locations',
+      'files.html'          => 'Files',
+      'external-ids.html'   => 'External IDs',
+    }
+
+    @pages.each do |filename, _|
+      @current_page = filename
+      save filename, render("pages/#{filename}")
+    end
+
+    # Generate API pages
+    @records.each do |record|
+      @record       = record
+      @current_page = @record[:filename]
+      save "#{record[:filename]}.html", render('spec.html.erb')
+    end
+  end
+end
+```
 
 ## Future plans
 

data/lib/reqres_rspec/collector.rb

@@ -83,8 +83,8 @@ module ReqresRspec
 
       self.records << {
         filename: prepare_filename_for(spec.class.metadata),
-        group: section, # Top level example group
-        title: spec.class.example.full_description,
+        group: spec.class.metadata[:reqres_section] || section, # Top level example group
+        title: spec.class.metadata[:reqres_title] || spec.class.example.full_description,
         description: description,
         params: params,
         request_path: get_symbolized_path(request),
@@ -181,7 +181,7 @@ module ReqresRspec
     # returns action comments taken from controller file
     # example TODO
     def get_action_comments(controller, action)
-      lines = File.readlines(File.join(ENV['REQRES_RSPEC_ROOT'], 'app', 'controllers', "#{controller}_controller.rb"))
+      lines = File.readlines(File.join(ReqresRspec.root, 'app', 'controllers', "#{controller}_controller.rb"))
 
       action_line = nil
       lines.each_with_index do |line, index|

data/lib/reqres_rspec/configuration.rb

@@ -0,0 +1,67 @@
+module ReqresRspec
+  extend self
+
+  def configure
+    yield configuration
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def logger
+    @logger ||= if defined?(Rails)
+      Rails.logger
+    else
+      Logger.new(STDOUT)
+    end
+  end
+
+  def root
+    configuration.root
+  end
+
+  class Configuration
+    DEFAULT_FORMATTERS = %w(html pdf json)
+    def initialize
+      ReqresRspec.logger.level = Logger::INFO
+      @root = if defined?(Rails)
+        Rails.root.to_s
+      else
+        raise 'REQRES_RSPEC_ROOT is not defined' if ENV['REQRES_RSPEC_ROOT'].blank?
+        ENV['REQRES_RSPEC_ROOT']
+      end
+
+      @templates_path = File.expand_path('../templates', __FILE__)
+      @output_path = File.join(@root, '/doc/reqres')
+
+      requested_formats = (ENV['REQRES_RSPEC_FORMATTERS'].to_s).split(',')
+      requested_formats.sort_by!{|fmt| [DEFAULT_FORMATTERS.index(fmt), fmt]}
+      @formatters = requested_formats.empty? ? %w(html) : requested_formats
+
+      @amazon_s3 = {
+        credentials: {
+          access_key_id: ENV['AWS_ACCESS_KEY_ID'],
+          secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'],
+          region: (ENV['AWS_REGION'] || 'us-east-1'),
+        },
+        bucket: ENV['AWS_REQRES_BUCKET'],
+        enabled: false
+      }
+
+      @title = 'API Docs'
+    end
+
+    attr_accessor :templates_path
+    attr_accessor :output_path
+    attr_accessor :title
+    attr_accessor :formatters
+    attr_reader :root
+    attr_reader :amazon_s3
+
+    def amazon_s3=(config={})
+      @amazon_s3.deep_merge!(config)
+    end
+
+  end
+end

data/lib/reqres_rspec/formatters/base.rb

@@ -0,0 +1,33 @@
+module ReqresRspec
+  module Formatters
+    class Base
+      def initialize(records)
+        @records = records
+        @output_path = ReqresRspec.configuration.output_path
+        @logger = ReqresRspec.logger
+      end
+      attr_reader :logger, :output_path, :records
+
+      def process
+        cleanup
+        write
+      end
+    private
+      def write
+        raise 'Not Implemented'
+      end
+
+      def cleanup_pattern
+        '**/*'
+      end
+
+      def cleanup
+        unless Dir.exist?(output_path)
+          FileUtils.mkdir_p(output_path)
+          logger.info "#{output_path} was recreated"
+        end
+        FileUtils.rm_rf(Dir.glob("#{output_path}/#{cleanup_pattern}"), secure: true)
+      end
+    end
+  end
+end

data/lib/reqres_rspec/formatters/html.rb

@@ -0,0 +1,43 @@
+require 'coderay'
+
+module ReqresRspec
+  module Formatters
+    class HTML < Base
+    private
+      def write
+        files = {
+          'rspec_doc_table_of_content.html' => 'header.erb',
+          'index.html' => 'index.erb',
+          'panel.html' => 'panel.erb'
+        }
+
+        files.each { |filename, template| save(filename, render(template)) }
+
+        @records.each do |record|
+          @record = record
+          save "rspec_doc_#{record[:filename]}.html", render('spec.erb')
+        end
+      end
+
+      def cleanup_pattern
+        '*.html'
+      end
+
+      def path(filename)
+        File.join(ReqresRspec.configuration.templates_path, filename)
+      end
+
+      def render(filename, arguments = {})
+        eval <<-RUBY
+          #{ arguments.map {|k, v| "#{k} = #{v}"}.join("\n") }
+          ERB.new(File.open(path(filename)).read).result(binding)
+        RUBY
+      end
+
+      def save(filename, data)
+        File.write(File.join(output_path, filename), data)
+        logger.info "Reqres::Formatters::HTML saved #{path(filename)}"
+      end
+    end
+  end
+end

data/lib/reqres_rspec/formatters/json.rb

@@ -0,0 +1,16 @@
+module ReqresRspec
+  module Formatters
+    class JSON < Base
+    private
+      def write
+        path = File.join(output_path, 'reqres_rspec.json')
+        File.write(path, ::JSON.pretty_generate(records))
+        logger.info "Reqres::Writers::#{self.class.name} saved doc spec to #{path}"
+      end
+
+      def cleanup_pattern
+        'reqres_rspec.json'
+      end
+    end
+  end
+end

data/lib/reqres_rspec/formatters/pdf.rb

@@ -0,0 +1,35 @@
+module ReqresRspec
+  module Formatters
+    class Pdf < Base
+      # generates PDF file from existing HTML docs
+      # TODO: more info
+      def write
+        # http://www.princexml.com/download/
+        pdf_tool_path = 'prince'
+        pdf_doc_path = File.join(output_path, 'reqres_rspec.pdf')
+
+        if `which #{pdf_tool_path}`.size > 0
+          files = Dir["#{output_path}/*.html"]
+          files.reject!{ |filename| filename.scan(/rspec_doc/).empty? }
+          files.delete("#{output_path}/rspec_doc_table_of_content.html")
+          files.unshift("#{output_path}/rspec_doc_table_of_content.html")
+
+          if files.size > 0
+            files_arg = files.join('" "')
+            `#{pdf_tool_path} "#{files_arg}" -o "#{pdf_doc_path}"`
+
+            logger.info "ReqresRspec::Formatters::Pdf saved doc to #{pdf_doc_path}" if File.exists? pdf_doc_path
+          else
+            logger.error 'No HTML files found'
+          end
+        else
+          logger.error "#{pdf_tool_path} is not installed! Check README.md for more info"
+        end
+      end
+
+      def cleanup_pattern
+        'reqres_rspec.pdf'
+      end
+    end
+  end
+end

data/lib/reqres_rspec/formatters.rb

@@ -0,0 +1,36 @@
+module ReqresRspec
+  module Formatters
+    extend self
+
+    def process(records)
+      formatters = ReqresRspec.configuration.formatters
+      raise 'No formatters defined' if formatters.empty?
+
+      formatters.each do |fmt|
+        case fmt
+        when 'html'
+          HTML.new(records).process
+        when 'pdf'
+          HTML.new(records).process unless formatters.include?('html')
+          Pdf.new(records).process
+        when 'json'
+          JSON.new(records).process
+        else
+          begin
+            klass = Object.const_get(fmt)
+            unless klass.public_instance_methods.include?(:process)
+              raise "Formatter #{fmt} should respond to `process` method"
+            end
+            klass.new(records).process
+          rescue NameError => e
+            if e.message =~ /(uninitialized constant|wrong constant name) #{fmt}$/
+              raise "Formatter #{fmt} does not exists"
+            else
+              raise e
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/reqres_rspec/{writers/templates → templates}/header.erb

@@ -1,6 +1,6 @@
 <html>
 <head>
-  <title><%= ENV['REQRES_RSPEC_APP'] %> API Documentation</title>
+  <title><%= ReqresRspec.configuration.title %></title>
   <link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'>
   <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>
   <style>
@@ -58,7 +58,7 @@
 </head>
 <body>
 <div class="container">
-  <h1><%= ENV['REQRES_RSPEC_APP'] %> API Documentation</h1>
+  <h1><%= ReqresRspec.configuration.title %></h1>
   <p>Generated <%= Time.now.strftime('%d %B %Y at %H:%m:%S')%> with <a href="https://github.com/reqres-api/reqres_rspec">reqres_rspec</a></p>
   <ul>
     <% @records.each_with_index do |record, index| %>

data/lib/reqres_rspec/{writers/templates → templates}/index.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title><%= ENV['REQRES_RSPEC_APP'] %> API Documentation</title>
+    <title><%= ReqresRspec.configuration.title %></title>
     <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8" />
     <link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'>
     <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>

data/lib/reqres_rspec/{writers/templates → templates}/panel.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title><%= ENV['REQRES_RSPEC_APP'] %> API Documentation</title>
+    <title><%= ReqresRspec.configuration.title %></title>
     <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8" />
     <link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'>
     <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>
@@ -86,7 +86,7 @@
   </head>
   <body>
     <h1><a href="rspec_doc_table_of_content.html" target="specs">
-      <%= ENV['REQRES_RSPEC_APP'] %> API
+      <%= ReqresRspec.configuration.title %>
     </a></h1>
     <% @records.group_by{|h| h[:group]}.each do |group, items| %>
       <h2><%= group %></h2>

data/lib/reqres_rspec/{writers/templates → templates}/spec.erb

@@ -1,6 +1,6 @@
 <html>
 <head>
-  <title><%= ENV['REQRES_RSPEC_APP'] %> API Documentation</title>
+  <title><%= ReqresRspec.configuration.title %></title>
   <link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'>
   <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>
   <style>

data/lib/reqres_rspec/uploaders/amazon_s3.rb

@@ -0,0 +1,57 @@
+require 'aws-sdk-core'
+
+module ReqresRspec
+  module Uploaders
+    class AmazonS3
+      def initialize
+        @path     = ReqresRspec.configuration.output_path
+        @logger   = ReqresRspec.logger
+        @enabled  = ReqresRspec.configuration.amazon_s3[:enabled] || false
+        @bucket   = ReqresRspec.configuration.amazon_s3[:bucket]
+
+        ::Aws.config = ReqresRspec.configuration.amazon_s3[:credentials]
+        @s3 = ::Aws::S3::Client.new
+      end
+      attr_reader :logger, :path
+
+      def self.upload
+        uploader = self.new
+        uploader.process if uploader.enabled?
+      end
+
+      def enabled?
+        !!@enabled
+      end
+
+      def process
+        prepare_bucket
+
+        for file in Dir["#{path}/**/*"]
+          next if File.directory?(file)
+          local_path = file.gsub("#{@path}/", '')
+
+          start = Time.now
+          @s3.put_object bucket: @bucket, key: local_path, body: File.open(file, 'rb'), acl: "public-read"
+          done = Time.now
+
+          puts "[#{local_path}] Uploaded in #{done.to_i - start.to_i}s"
+        end
+      end
+
+    private
+      def prepare_bucket
+        @s3.create_bucket(
+          acl: "public-read",
+          bucket: @bucket
+        )
+
+        @s3.put_bucket_website(
+          bucket: @bucket,
+          website_configuration:  {
+            index_document: { suffix: 'index.html' }
+          }
+        )
+      end
+    end
+  end
+end

data/lib/reqres_rspec/uploaders.rb

@@ -0,0 +1,27 @@
+module ReqresRspec
+  module Uploaders
+    extend self
+
+    def upload
+      if defined?(WebMock)
+        WebMock.allow_net_connect!
+      end
+
+      if defined?(VCR)
+        VCR.configure do |c|
+          c.ignore_request do |request|
+            URI(request.uri).host == 's3.amazonaws.com'
+          end
+        end
+      end
+
+      self.constants.each do |name|
+        klass = Object.const_get("ReqresRspec::Uploaders::#{name}")
+        if klass.public_instance_methods.include?(:upload)
+          klass.upload
+        end
+      end
+    end
+
+  end
+end

data/lib/reqres_rspec/utils.rb

@@ -0,0 +1,25 @@
+unless String.respond_to?(:underscore)
+  class String
+    def underscore
+      self.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+  end
+end
+
+unless Hash.respond_to?(:deep_merge)
+  class ::Hash
+    def deep_merge(second)
+      merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+      self.merge(second, &merger)
+    end
+
+    def deep_merge!(second)
+      merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+      self.merge!(second, &merger)
+    end
+  end
+end

data/lib/reqres_rspec/version.rb

@@ -1,3 +1,3 @@
 module ReqresRspec
-  VERSION = '0.0.30'
+  VERSION = '0.1.0'
 end

data/lib/reqres_rspec.rb

@@ -1,21 +1,21 @@
 require 'reqres_rspec/version'
+require 'reqres_rspec/utils'
+require 'reqres_rspec/configuration'
 require 'reqres_rspec/collector'
-require 'reqres_rspec/writers/html'
-require 'reqres_rspec/writers/json_formatter'
-require 'reqres_rspec/generators/pdf'
+require 'reqres_rspec/formatters'
+require 'reqres_rspec/formatters/base'
+require 'reqres_rspec/formatters/html'
+require 'reqres_rspec/formatters/json'
+require 'reqres_rspec/formatters/pdf'
+require 'reqres_rspec/uploaders'
+require 'reqres_rspec/uploaders/amazon_s3'
 
 if defined?(RSpec) && ENV['REQRES_RSPEC'] == '1'
   collector = ReqresRspec::Collector.new
 
   RSpec.configure do |config|
     config.after(:each) do
-      # TODO: remove boilerplate code
-      # TODO: better options
-
       if defined?(Rails)
-        ENV['REQRES_RSPEC_ROOT'] = Rails.root.to_s
-        ENV['REQRES_RSPEC_APP'] = Rails.application.class.to_s.sub('::Application', '')
-
         meta_data = self.class.example.metadata
         if meta_data[:type] == :request && !meta_data[:skip_reqres] == true
           begin
@@ -25,9 +25,6 @@ if defined?(RSpec) && ENV['REQRES_RSPEC'] == '1'
           end
         end
       elsif defined?(Sinatra)
-        raise 'REQRES_RSPEC_ROOT is not defined' if ENV['REQRES_RSPEC_ROOT'].blank?
-        raise 'REQRES_RSPEC_APP is not defined' if ENV['REQRES_RSPEC_APP'].blank?
-
         begin
           collector.collect(self, self.last_request, self.last_response)
         rescue Rack::Test::Error
@@ -41,25 +38,8 @@ if defined?(RSpec) && ENV['REQRES_RSPEC'] == '1'
     config.after(:suite) do
       if collector.records.size > 0
         collector.sort
-        formatters = %w(html pdf json)
-
-        requested_formats = (ENV['REQRES_RSPEC_FORMATTERS'] || 'html').split(',')
-        requested_formats.sort_by!{|fmt| [formatters.index(fmt), fmt]}
-        requested_formats.each do |fmt|
-          case fmt
-          when 'html'
-            ReqresRspec::Writers::Html.new(collector.records).write
-          when 'pdf'
-            ReqresRspec::Writers::Html.new(collector.records).write unless requested_formats.include?('html')
-            ReqresRspec::Generators::Pdf.new.generate
-          when 'json'
-            ReqresRspec::Writers::JSONFormatter.new(collector.records).write
-          else
-            puts "No formatters defined, define one of #{formatters} in REQRES_RSPEC_FORMATTERS"
-          end
-        end
-
-        #
+        ReqresRspec::Formatters.process(collector.records)
+        ReqresRspec::Uploaders.upload if ENV['REQRES_UPLOAD'] == '1'
       end
     end
   end

data/reqres_rspec.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'coderay'
+  spec.add_dependency 'aws-sdk-core', '~> 2.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reqres_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.30
+  version: 0.1.0
 platform: ruby
 authors:
 - rilian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -69,14 +83,20 @@ files:
 - Rakefile
 - lib/reqres_rspec.rb
 - lib/reqres_rspec/collector.rb
-- lib/reqres_rspec/generators/pdf.rb
+- lib/reqres_rspec/configuration.rb
+- lib/reqres_rspec/formatters.rb
+- lib/reqres_rspec/formatters/base.rb
+- lib/reqres_rspec/formatters/html.rb
+- lib/reqres_rspec/formatters/json.rb
+- lib/reqres_rspec/formatters/pdf.rb
+- lib/reqres_rspec/templates/header.erb
+- lib/reqres_rspec/templates/index.erb
+- lib/reqres_rspec/templates/panel.erb
+- lib/reqres_rspec/templates/spec.erb
+- lib/reqres_rspec/uploaders.rb
+- lib/reqres_rspec/uploaders/amazon_s3.rb
+- lib/reqres_rspec/utils.rb
 - lib/reqres_rspec/version.rb
-- lib/reqres_rspec/writers/html.rb
-- lib/reqres_rspec/writers/json_formatter.rb
-- lib/reqres_rspec/writers/templates/header.erb
-- lib/reqres_rspec/writers/templates/index.erb
-- lib/reqres_rspec/writers/templates/panel.erb
-- lib/reqres_rspec/writers/templates/spec.erb
 - reqres_rspec.gemspec
 homepage: https://github.com/reqres-api/reqres_rspec
 licenses:

data/lib/reqres_rspec/generators/pdf.rb

@@ -1,29 +0,0 @@
-module ReqresRspec
-  module Generators
-    class Pdf
-      # generates PDF file from existing HTML docs
-      # TODO: more info
-      def generate
-        # http://www.princexml.com/download/
-        pdf_tool_path = 'prince'
-        html_docs_root = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc')
-        pdf_doc_path = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', "rspec_doc_#{Time.now.strftime("%d-%h-%Y_%H-%M")}.pdf")
-
-        if `which #{pdf_tool_path}`.size > 0
-          files = Dir["#{html_docs_root}/rspec_doc_*.html"]
-          if files.size > 0
-            files_arg = files.map { |f| f if f =~ /\/rspec_doc_\d+\.html/ }.compact.sort.join('" "')
-
-            `#{pdf_tool_path} "#{files_arg}" -o "#{pdf_doc_path}"`
-
-            puts "ReqresRspec::Generators::Pdf saved doc to #{pdf_doc_path}" if File.exists? pdf_doc_path
-          else
-            puts 'No HTML files found'
-          end
-        else
-          puts "ERROR: #{pdf_tool_path} is not installed! Check README.md for more info"
-        end
-      end
-    end
-  end
-end

data/lib/reqres_rspec/writers/html.rb

@@ -1,89 +0,0 @@
-require 'coderay'
-
-module ReqresRspec
-  module Writers
-    class Html
-      def initialize(records)
-        @records = records
-      end
-
-      def write
-        recreate_doc_dir
-        cleanup
-        generate_header
-        generate_specs
-
-        append_index
-        append_panel
-      end
-
-      private
-
-      # recreates /doc dir if it does not exist
-      def recreate_doc_dir
-        doc_dir = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc')
-        unless Dir.exist?(doc_dir)
-          Dir.mkdir(doc_dir)
-          puts "#{doc_dir} was recreated"
-        end
-      end
-
-      # deletes previous version of HTML docs
-      # TODO: more info
-      def cleanup
-        FileUtils.rm_rf(Dir.glob("#{ENV['REQRES_RSPEC_ROOT']}/doc/rspec_doc_*.html"), secure: true)
-        FileUtils.rm_rf(Dir.glob("#{ENV['REQRES_RSPEC_ROOT']}/doc/index.html"), secure: true)
-        FileUtils.rm_rf(Dir.glob("#{ENV['REQRES_RSPEC_ROOT']}/doc/panel.html"), secure: true)
-      end
-
-      # generates contents of HTML docs
-      # TODO: more info
-      def generate_header
-        tpl_path = File.join(File.dirname(__FILE__), 'templates', 'header.erb')
-        rendered_doc = ERB.new(File.open(tpl_path).read).result(binding)
-
-        path = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', 'rspec_doc_table_of_content.html')
-        file = File.open(path, 'w')
-        file.write(rendered_doc)
-        file.close
-        puts "Reqres::Writers::Html saved doc header to #{path}"
-      end
-
-      # generates each separate spec example doc
-      # TODO: more info
-      def generate_specs
-        tpl_path = File.join(File.dirname(__FILE__), 'templates', 'spec.erb')
-
-        @records.each do |record|
-          @record = record
-          rendered_doc = ERB.new(File.open(tpl_path).read).result(binding)
-
-          path = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', "rspec_doc_#{record[:filename]}.html")
-          file = File.open(path, 'w')
-          file.write(rendered_doc)
-          file.close
-          puts "Reqres::Writers::Html saved doc spec to #{path}"
-        end
-      end
-
-      # creates an index file with iframes if does not exists
-      def append_index
-        index_file = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', 'index.html')
-        unless File.exists?(index_file)
-          tpl_path = File.join(File.dirname(__FILE__), 'templates', 'index.erb')
-          rendered_doc = ERB.new(File.open(tpl_path).read).result(binding)
-          File.write index_file, rendered_doc
-        end
-      end
-
-      def append_panel
-        index_file = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', 'panel.html')
-        unless File.exists?(index_file)
-          tpl_path = File.join(File.dirname(__FILE__), 'templates', 'panel.erb')
-          rendered_doc = ERB.new(File.open(tpl_path).read).result(binding)
-          File.write index_file, rendered_doc
-        end
-      end
-    end
-  end
-end

data/lib/reqres_rspec/writers/json_formatter.rb

@@ -1,37 +0,0 @@
-require 'coderay'
-
-module ReqresRspec
-  module Writers
-    class JSONFormatter
-      def initialize(records)
-        @records = records
-      end
-
-      def write
-        recreate_doc_dir
-        cleanup
-
-        path = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', 'reqres_rspec.json')
-        File.write(path, JSON.pretty_generate(@records))
-        puts "Reqres::Writers::JSONFormatter saved doc spec to #{path}"
-      end
-
-      private
-
-      # recreates /doc dir if it does not exist
-      def recreate_doc_dir
-        doc_dir = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc')
-        unless Dir.exist?(doc_dir)
-          Dir.mkdir(doc_dir)
-          puts "#{doc_dir} was recreated"
-        end
-      end
-
-      # deletes previous version of HTML docs
-      # TODO: more info
-      def cleanup
-        FileUtils.rm_rf(Dir.glob("#{ENV['REQRES_RSPEC_ROOT']}/doc/reqres_rspec.json"), secure: true)
-      end
-    end
-  end
-end