watchdocs-rails 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bac1e9b41646c40171505b88313de4c347fdb3ce
-  data.tar.gz: ceb761af9b816983c4baa0605191ccd079355dbb
+  metadata.gz: 623cd0977c17c12f52dcb6d73669296483905b9b
+  data.tar.gz: 25b282a6b8cb5cb0b969e6aed7265b22b0156ec9
 SHA512:
-  metadata.gz: afdea6aa7702019c7bf315a4e4d0b20b94cec50e3ef4360307f71719d1aa20494c31859c8ce9d0a1916715ecb6192fcb9878cf38a69c6d0d3f4d25de4b1e1e83
-  data.tar.gz: 88b468b03a902f133b861b69e4c21c04666f7d716ec1fdeb4fd8d3b99ce54cfb6013d0697f5236ee5d82aaf08982da0c6f2c29dd0c04869812ff841c77733689
+  metadata.gz: 0c19e929f480150be5276579d777247c472759e68abba1ff740e25820894c482aced4af0bc2d86e63e1761723c22bcf052568cb8141d1814629fe35617a63286
+  data.tar.gz: f2860ed94519961867e5ec9fe329415684fe0a0d1cfaf87b347f98ed670016d2a932de6351c30bba187764612eaac13bc792e4b42a513bf192c46beb227c605e

data/lib/generators/templates/rspec.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.before(:suite) do
+    Watchdocs::Rails::Recordings.clear!
+  end
+
+  config.after(:suite) do
+    Watchdocs::Rails::Recordings.export
+  end
+end

data/lib/generators/watchdocs/install_generator.rb

@@ -0,0 +1,112 @@
+require 'rails/generators'
+require 'colorize'
+
+module Watchdocs
+  module Generators
+    MissingCredentialsError = Class.new(Thor::Error)
+
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      class_option :app_id, type: :string
+      class_option :app_secret, type: :string
+
+      def create_initializer_file
+        if !options['app_id'].present? || !options['app_secret'].present?
+          raise MissingCredentialsError, <<-ERROR.strip_heredoc
+          --app_id or/and --app_secret options is missing
+          Please specify both with credentials from Settings tab of your project.
+          ERROR
+        end
+
+        initializer 'watchdocs.rb' do
+          <<-END.gsub(/^\s+\|/, '')
+            |Watchdocs::Rails.configure do |c|
+            |  c.app_id = '#{options['app_id']}'
+            |  c.app_secret = '#{options['app_secret']}'
+            |end
+          END
+        end
+      end
+
+      def install_with_specs
+        if yes?('Do you have any request specs? Would you like to use Watchdocs with them in test environment? [y,n]')
+          application(nil, env: 'test') do
+            'config.middleware.insert(0, Watchdocs::Rails::Middleware)'
+          end
+          if yes?('  Do you test with RSpec? [y,n]')
+            template 'rspec.rb', 'spec/support/watchdocs.rb'
+            begin
+              append_file 'spec/rails_helper.rb', "require 'support/watchdocs.rb'"
+            rescue Errno::ENOENT
+              warning = <<-END.gsub(/^\s+\|/, '')
+                |  You don't have rails_helper.rb, so please add the following line
+                |  to the file where you have your RSpec configuration.
+                |  -------------------------------
+                |  require 'support/watchdocs.rb'
+                |  -------------------------------
+              END
+              puts warning.yellow
+            end
+          elsif yes?('  Ok, maybe you test with a Minitest? [y,n]')
+            begin
+              append_file 'test/test_helper.rb',
+                        'Minitest.after_run { Watchdocs::Rails::Recordings.export }'
+            rescue Errno::ENOENT
+              warning = <<-END.gsub(/^\s+\|/, '')
+                |  You don't have test_helper.rb, so please add the following line
+                |  to the file where you have your Minitest configuration.
+                |  ----------------------------------------------------------
+                |  Minitest.after_run { Watchdocs::Rails::Recordings.export }
+                |  ----------------------------------------------------------
+              END
+              puts warning.yellow
+            end
+          else
+            warning = <<-END.gsub(/^\s+\|/, '')
+              |  We are sorry, but we don't have auto setup for you testing framework.
+              |  You need to manually add the following line to be executed after all your specs:
+              |  -----------------------------------
+              |  Watchdocs::Rails::Recordings.export
+              |  -----------------------------------
+            END
+            puts warning.yellow
+          end
+          puts 'Watchdocs enabled for test environment!'.green
+
+        end
+      end
+
+      def install_with_runtime
+        if yes?('Do you want to record your API endpoints in developent environment? [y,n]')
+          application(nil, env: 'development') do
+            'config.middleware.insert(0, Watchdocs::Rails::Middleware)'
+          end
+          if yes?('  Do you use Procfile to run your app? [y,n]')
+            append_file 'Procfile', 'watchdocs: watchdocs --every 60.seconds'
+            puts 'Watchdocs worker added to your Procfile!'.green
+          else
+            warning = <<-END.gsub(/^\s+\|/, '')
+              |  To make sure we will receive all recorded request please run this worker command with your app:
+              |  -----------------------------
+              |  watchdocs --every 60.seconds
+              |  -----------------------------
+            END
+            puts warning.yellow
+
+          end
+          info = <<-END.gsub(/^\s+\|/, '')
+            |  If you would like to enable recording in any other environment (f.e. dev server, staging)
+            |  just add the following line to you 'config/environments/{env}.rb':
+            |  -----------------------------------------------------------
+            |    config.middleware.insert(0, Watchdocs::Rails::Middleware)
+            |  -----------------------------------------------------------
+          END
+          puts info.light_blue
+        end
+        puts 'Setup is completed. Now run your app and make some requests!
+        Check app.watchdocs.io after a minute or so.'.green
+      end
+    end
+  end
+end

data/lib/watchdocs/rails/engine.rb

@@ -0,0 +1,6 @@
+module Watchdocs
+  module Rails
+    class Engine < Rails::Engine
+    end
+  end
+end

data/lib/watchdocs/rails/version.rb

@@ -1,5 +1,5 @@
 module Watchdocs
   module Rails
-    VERSION = '0.10.0'
+    VERSION = '0.11.0'
   end
 end

data/watchdocs-rails.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'configurations', '~> 2.0'
   spec.add_runtime_dependency 'activesupport', '>4', '<6'
   spec.add_runtime_dependency 'recurrent', '~> 0.4'
+  spec.add_runtime_dependency 'colorize', '~> 0.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watchdocs-rails
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - mazikwyry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-02 00:00:00.000000000 Z
+date: 2017-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 description: |-
   It captures every JSON response, stores request and
                           response details in temporary storage.
@@ -130,6 +144,8 @@ files:
 - bin/setup
 - bin/watchdocs
 - lib/.DS_Store
+- lib/generators/templates/rspec.rb
+- lib/generators/watchdocs/install_generator.rb
 - lib/watchdocs-rails.rb
 - lib/watchdocs/.DS_Store
 - lib/watchdocs/rails.rb
@@ -141,6 +157,7 @@ files:
 - lib/watchdocs/rails/core_extensions/enumerable.rb
 - lib/watchdocs/rails/core_extensions/hash.rb
 - lib/watchdocs/rails/core_extensions/object.rb
+- lib/watchdocs/rails/engine.rb
 - lib/watchdocs/rails/helpers.rb
 - lib/watchdocs/rails/helpers/body_helper.rb
 - lib/watchdocs/rails/helpers/query_string_helper.rb