watchdocs-rails 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c23ba266af8e362dea8a252ee94b8f14ea674b04
-  data.tar.gz: 1ad9a1c35537eef31a26556ce1d3089359c07438
+  metadata.gz: 759c089b37d5306a90c488465c6f2ba497954820
+  data.tar.gz: cf29d40f4b26ca075296059b967e587dacd46378
 SHA512:
-  metadata.gz: 2e8e923956c0d9f084484ea0a91e007ca3f811b71c4f44c1b9dbd4fff2a84386d403e8306bd25ab3ae81e483c132948de4a72f49932cdf34bda9dce30dd9c03b
-  data.tar.gz: b4ef7736521736cfa8d7c33c719e04b1772e27d840e7dc81380338af88d239ff5152eec7c2b7388929abf364e1eb32ae9c28f46c2460c9c43f38f8d5626fe4f8
+  metadata.gz: da742003e254f774aba12748d588332536a22a2bc368568108b86c1c316470bc921f0d71701cf3a543c43ee2b1f912a7a321a7136cd8c6a6d9560262566a6acf
+  data.tar.gz: 919006c6c34e2301c7954d32c7379c4139030ae306685abfe486df334430be4338b3527e888e8e0cb5975dd8001d758fb2c48a4a7f0e29c906001a9e6cdf8846

data/README.md

@@ -20,18 +20,18 @@ bundle
 
 ## Configuration
 
-Create `config/initializers/watchdocs.rb` and configure the gem if you need to change default configuration:
+Create `config/initializers/watchdocs.rb` and configure the gem with your project credentials:
 
 ```ruby
   Watchdocs::Rails.configure do |c|
-    c.buffer_size = 50
-    c.temp_directory = 'tmp'
-    c.export_url = 'https://watchdocs-api.herokuapp.com/api/v1/project/10/reports'
-    c.api_key = '8L9qh77q9570H0LIz90Aj00T5mcOHW1w'
-    c.api_secret = 'G52uFXHPjyxRY3JdBIsw562uJ8bUdrE2'
+    c.app_id = 'YourAPPid'
+    c.app_secret = 'YourAPPsecret'
   end
 ```
 
+You can get them from your project's Settings page.
+All configuration settings are listed below.
+
 ### buffer_size
 
 **Default:** 50
@@ -48,21 +48,21 @@ Directory to store temporary file with recordings.
 
 ### export_url
 
-**Default:** https://watchdocs-api.herokuapp.com/api/v1/project/10/reports
+**Default:** https://watchdocs-api.herokuapp.com/api/v1/reports
 
-URL for exporting recorgings to your Watchdocs project. (Change 10 to a random number)
+URL for exporting recorgings to your Watchdocs project.
 
-### api_key
+### app_id
 
-**Default:** 8L9qh77q9570H0LIz90Aj00T5mcOHW1w
+**No default value**
 
-API Key which you can get for your Watchdocs project in settings section.
+AppID key which you can get for your Watchdocs project in settings section.
 
-### api_secret
+### app_secret
 
-**Default:** G52uFXHPjyxRY3JdBIsw562uJ8bUdrE2
+**No default value**
 
-API Secret which you can get for your Watchdocs project in settings section.
+App Secret key which you can get for your Watchdocs project in settings section.
 
 ## Usage
 

data/lib/watchdocs/rails/configuration.rb

@@ -6,15 +6,19 @@ module Watchdocs
     configurable :buffer_size,
                  :temp_directory,
                  :export_url,
-                 :api_key,
-                 :api_secret
+                 :app_id,
+                 :app_secret
 
     configuration_defaults do |c|
       c.buffer_size = 50
       c.temp_directory = 'tmp'
-      c.export_url = 'https://watchdocs-api.herokuapp.com/api/v1/project/10/reports'
-      c.api_key = '8L9qh77q9570H0LIz90Aj00T5mcOHW1w'
-      c.api_secret = 'G52uFXHPjyxRY3JdBIsw562uJ8bUdrE2'
+      c.export_url = 'https://watchdocs-api.herokuapp.com/api/v1/reports'
+    end
+
+    not_configured do |prop|
+      warn :not_configured,
+           "You need to configure #{prop} with
+           credentials from your project Settings page."
     end
   end
 end

data/lib/watchdocs/rails/middleware.rb

@@ -84,28 +84,33 @@ module Watchdocs
 
       def body_string(body)
         body_string = ''
-        body.each { |line| body_string += line }
+        body.each { |line| body_string += line } if body
         body_string
       end
 
       def parse_response_body(body)
         return if body.empty?
-        JSON.parse(body).filter_data
-      rescue JSON::ParserError
-        'Invalid JSON'
+        filter_body(JSON.parse(body))
+      rescue JSON::ParserError => e
+        { watchdocs_error: "Invalid JSON data: #{e.message}" }
+      rescue StandardError
+        { watchdocs_error: 'Response body format not supported' }
       end
 
       def parse_request_body(body)
         return if body.empty?
-        JSON.parse(body).filter_data
+        filter_body(JSON.parse(body))
       rescue JSON::ParserError
         begin
-          Rack::Utils.parse_nested_query(body)
-                     .filter_data
+          filter_body(Rack::Utils.parse_nested_query(body))
         rescue StandardError
-          'Request body format not supported'
+          { watchdocs_error: 'Request body format not supported' }
         end
       end
+
+      def filter_body(body)
+        body.is_a?(Enumerable) ? body.filter_data : body
+      end
     end
   end
 end

data/lib/watchdocs/rails/recordings/exporter.rb

@@ -44,8 +44,8 @@ module Watchdocs
 
           def api_auth
             {
-              username: Watchdocs::Rails.configuration.api_key,
-              password: Watchdocs::Rails.configuration.api_secret
+              username: Watchdocs::Rails.configuration.app_id,
+              password: Watchdocs::Rails.configuration.app_secret
             }
           end
         end

data/lib/watchdocs/rails/version.rb

@@ -1,5 +1,5 @@
 module Watchdocs
   module Rails
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watchdocs-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - mazikwyry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler