watchdocs-rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d4ce6cd6e1a40a6fd07f03b15182856b0cd506f
-  data.tar.gz: 9a138b39de57b4c8af88dfa30fd07eb0e310cf4f
+  metadata.gz: c3219efab0c6110f67ca59f59d3707f894e79717
+  data.tar.gz: eacf3d9fe251bef0d9c0f5866dad515233cfa73b
 SHA512:
-  metadata.gz: 3677a73a2f29bf78d007620a6abb8115a4cb8dfb7943de3935530cffc53cbff3fb0e8714142b5e30a8221edd848923219bafa09319121480777328400026aadd
-  data.tar.gz: 274be20d49c111a90fce4ad19da7eed5447e85942eec912ba85dfe7249d34b7acb5d726958f17d33c3d49a7444c70aae476870ea2a9a636bdeed9c25a7165a6d
+  metadata.gz: 804a2ff175b8e28e96599dd8ac877f4b1723babd9b844e0b88d39433321aa102925b5977cdd3483d2964d28a95d4a0d4f8da30484d6a52a7d11f52bcf14d2f61
+  data.tar.gz: 1a0b2de9e71e4807820d7e45bfbd444c26f8fe8cff63d17e0ca4e4febb8c5e406add509b0da64302440eefb381b8fe970c899ab8f4eed5f469cc5fbfd181dab8

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -9,7 +9,7 @@ It captures every JSON response, stores request and response details in temporar
 Add to your Gemfile. It is recommended to add to `:test, :development` group.
 
 ```ruby
-gem 'watchdocs-rails', '~> 0.1.1'
+gem 'watchdocs-rails'
 ```
 
 and run
@@ -24,56 +24,36 @@ Create `config/initializers/watchdocs.rb` and configure the gem if you need to c
 
 ```ruby
   Watchdocs::Rails.configure do |c|
-    c.store_class = Watchdocs::Rails::Store::MemoryStore
+    c.buffer_size = 50
     c.temp_directory = 'tmp'
-    c.sync_url = 'http://demo8792890.mockable.io/requests'
+    c.export_url = 'http://demo8792890.mockable.io/requests'
   end
 ```
 
-### store_class
+### buffer_size
 
-This option allows you to specify class that is responsible for storing recordings.
+**Default:** 50
 
-You can select from provided options:
+Buffer is a place where the gem stores recorderd requests. Buffer size is maximum number of requests that can be stored in a buffer. When limit is reached, buffer content is being exported and cleared. *In other words: Buffer is being exported and cleared every `buffer_size` reqests.*
 
-- `Watchdocs::Rails::Store::MemoryStore` **(default)** - stores recordings in memory
-- `Watchdocs::Rails::Store::JsonFileStore` - stores in temporary json file
-
-or you can implement you own store for recordings. Just create module that implements the following methods:
-
-```ruby
-  # Params
-  # content - is a Ruby Array of Hashes
-  def write(content)
-    ...
-  end
-
-  # Returns Ruby Array of Hashes
-  def read
-    ...
-  end
-
-  def delete!
-    ...
-  end
-
-  # Returns true if store already initialized
-  def exists?
-    ...
-  end
-```
+While executing specs buffer is a memory, otherwise it's a temporary file stored in `temp_directory`.
 
 ### temp_directory
 
-**Applicable only when `JsonFileStore` enabled as `store_class`**
+**Default:** tmp
+
 Directory to store temporary file with recordings.
 
-### sync_url
+### export_url
+
+**Default:** http://demo8792890.mockable.io/requests
 
-URL for syncing with your Watchdocs project.
+URL for exporting recorgings to your Watchdocs project.
 
 ## Usage
 
+You can enable Watchdocs to record request while executing specs or making manual tests. You can of course do both at the same time if you want.
+
 ### Tests
 
 If you have some requests specs or features specs that call JSON API then add this line to your `config/environments/test.rb`.
@@ -96,7 +76,7 @@ In `specs/rails_helper.rb`:
 
   config.after(:suite) do
     ....
-    Watchdocs::Rails::Recordings.send
+    Watchdocs::Rails::Recordings.export
   end
 ```
 
@@ -105,21 +85,21 @@ In `specs/rails_helper.rb`:
 
 ```
 Minitest.after_run do
-  Watchdocs::Rails::Recordings.send
+  Watchdocs::Rails::Recordings.export
 end
 ```
 
-### Development
+### Development (manual tests)
 
-If you don't have any specs yet. You can add the following line to `config/environments/development.rb`.
+If you don't have any request specs yet. You can add the following line to `config/environments/development.rb`.
 
 ```ruby
 config.middleware.insert(0, Watchdocs::Rails::Middleware)
 ```
 
-Then the only option is to send recordings manually from `rails c` by running `Watchdocs::Rails::Recordings.send`.
+If your app doesn't make a lot of JSON requests please set `buffer_size` to lower number (f.e. 10, it's 50 by default). Watchdocs will be recording all requests in your development environment during manual tests.
 
-**IMPORTANT NOTE: You need to select `JsonFileStore` as storage option in that case.**
+You can of course enable the middleware in any other environment like dev or staging
 
 
 ## Versioning
@@ -141,7 +121,6 @@ as even minimal functionality is not guaranteed to be implemented yet.
 
 - httparty
 - configurations
-- mini_memory_store
 
 ## Contributing
 

data/lib/watchdocs/rails/{store/file_store.rb → buffer/file_buffer.rb}

@@ -1,7 +1,7 @@
 module Watchdocs
   module Rails
     module Store
-      module JsonFileStore
+      module FileBuffer
         class StorageError < StandardError; end
 
         class << self
@@ -40,7 +40,7 @@ module Watchdocs
           end
 
           def temp_local_path
-            Watchdocs::Rails.configuration.temp_directory
+            Rails.configuration.temp_directory
           end
         end
       end

data/lib/watchdocs/rails/{store/memory_store.rb → buffer/memory_buffer.rb}

@@ -1,7 +1,7 @@
 module Watchdocs
   module Rails
     module Store
-      module MemoryStore
+      module MemoryBuffer
         class << self
           def write(content)
             @store = content

data/lib/watchdocs/rails/buffer.rb

@@ -0,0 +1,9 @@
+module Watchdocs
+  module Rails
+    module Buffer
+    end
+  end
+end
+
+require 'watchdocs/rails/buffer/file_buffer'
+require 'watchdocs/rails/buffer/memory_buffer'

data/lib/watchdocs/rails/configuration.rb

@@ -3,14 +3,14 @@ require 'configurations'
 module Watchdocs
   module Rails
     include Configurations
-    configurable :store_class,
+    configurable :buffer_size,
                  :temp_directory,
                  :sync_url
 
     configuration_defaults do |c|
-      c.store_class = Watchdocs::Rails::Store::MemoryStore
+      c.buffer_size = 50
       c.temp_directory = 'tmp'
-      c.sync_url = 'http://demo8792890.mockable.io/requests'
+      c.export_url = 'http://demo8792890.mockable.io/requests'
     end
   end
 end

data/lib/watchdocs/rails/middleware.rb

@@ -61,7 +61,13 @@ module Watchdocs
       end
 
       def record_call
-        Watchdocs::Rails::Recordings.record_call(report)
+        Rails::Recordings.record(
+          report, from_specs: from_specs?
+        )
+      end
+
+      def from_specs?
+        ::Rails.env.test?
       end
 
       def request_headers(env)

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

@@ -0,0 +1,47 @@
+require 'httparty'
+
+module Watchdocs
+  module Rails
+    module Recordings
+      module Exporter
+        class WatchdocsApiError < StandardError; end
+
+        DEFAULT_ERROR = 'Unknown API Error occured.'.freeze
+
+        class << self
+          def export(payload)
+            response = HTTParty.post(
+              api_url,
+              body: payload.to_json,
+              headers: { 'Content-Type' => 'application/json' }
+            )
+            check_response(response)
+          end
+
+          private
+
+          def check_response(response)
+            case response.code.to_s.chars.first
+            when '2'
+              true
+            when '4', '5'
+              raise WatchdocsApiError, get_error(response.body)
+            else
+              raise WatchdocsApiError, DEFAULT_ERROR
+            end
+          end
+
+          def get_error(response_body)
+            JSON.parse(response_body)['errors'].join(', ')
+          rescue
+            DEFAULT_ERROR
+          end
+
+          def api_url
+            Watchdocs::Rails.configuration.export_url
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module Watchdocs
+  module Rails
+    module Recordings
+      class Recorder
+        attr_reader :store, :output
+
+        def initialize(from_specs: true)
+          set_store(from_specs)
+        end
+
+        def call(new_call)
+          record_new
+          save_recordings
+          send_recordings if buffer_full?
+        end
+
+        private
+
+        def record_new
+          @output = if current_recordings
+                     current_recordings << new_call
+                    else
+                     [new_call]
+                    end
+        end
+
+        def current_recordings
+          @current ||= store.read
+        end
+
+        def save_recordings
+          store.write(output)
+        end
+
+        def send_recordings
+          Recordings.send(output)
+        end
+
+        def set_store(from_specs)
+          @store = if from_specs
+                     Rails::Buffer::MemoryBuffer
+                   else
+                     Rails::Buffer::FileBuffer
+                   end
+        end
+
+        def buffer_full?
+          current_recordings.count > buffer_size
+        end
+
+        def buffer_size
+          Rails.configuration.buffer_size
+        end
+      end
+    end
+  end
+end

data/lib/watchdocs/rails/recordings.rb

@@ -1,45 +1,49 @@
+require 'watchdocs/rails/recordings/recorder'
+require 'watchdocs/rails/recordings/exporter'
+
 module Watchdocs
   module Rails
     module Recordings
+      attr_reader :store
+
       class << self
-        def record_call(new_call)
-          output = if recordings_exists?
-                     current_recordings << new_call
-                   else
-                     [new_call]
-                   end
-          save_recordings(output)
+        def record(new_call, from_specs)
+          Recorder.new(
+            from_specs: from_specs
+          ).call(new_call)
         end
 
-        def clear!
+        def clear!(from_specs: true)
+          set_store(from_specs)
           clear_recordings
         end
 
-        def send
-          Watchdocs::Rails::Bridge.send(current_recordings) &&
-            clear_recordings
+        def export(recordings = nil, from_specs: true)
+          recordings ||= current_recordings
+          set_store(from_specs)
+          send_recordings(recordings) && clear!(from_specs)
         end
 
         private
 
-        def recordings_exists?
-          store.exists?
-        end
-
         def current_recordings
           store.read
         end
 
-        def save_recordings(content)
-          store.write(content)
-        end
-
         def clear_recordings
           store.delete!
         end
 
-        def store
-          Watchdocs::Rails.configuration.store_class
+        def export_recorings(recordings)
+          Exporter.export(recordings)
+        end
+
+        def set_store(from_specs)
+          @store = if from_specs
+                     Rails::Buffer::MemoryBuffer
+                   else
+                     Rails::Buffer::FileBuffer
+                   end
         end
       end
     end

data/lib/watchdocs/rails/version.rb

@@ -1,5 +1,5 @@
 module Watchdocs
   module Rails
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/watchdocs/rails.rb

@@ -1,8 +1,7 @@
 require 'watchdocs/rails/core_extensions'
-require 'watchdocs/rails/store'
+require 'watchdocs/rails/buffer'
 require 'watchdocs/rails/configuration'
 require 'watchdocs/rails/middleware'
-require 'watchdocs/rails/bridge'
 require 'watchdocs/rails/recordings'
 
 module Watchdocs

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watchdocs-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - mazikwyry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2017-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,9 @@ files:
 - lib/watchdocs-rails.rb
 - lib/watchdocs/.DS_Store
 - lib/watchdocs/rails.rb
-- lib/watchdocs/rails/bridge.rb
+- lib/watchdocs/rails/buffer.rb
+- lib/watchdocs/rails/buffer/file_buffer.rb
+- lib/watchdocs/rails/buffer/memory_buffer.rb
 - lib/watchdocs/rails/configuration.rb
 - lib/watchdocs/rails/core_extensions.rb
 - lib/watchdocs/rails/core_extensions/enumerable.rb
@@ -117,9 +119,8 @@ files:
 - lib/watchdocs/rails/core_extensions/object.rb
 - lib/watchdocs/rails/middleware.rb
 - lib/watchdocs/rails/recordings.rb
-- lib/watchdocs/rails/store.rb
-- lib/watchdocs/rails/store/file_store.rb
-- lib/watchdocs/rails/store/memory_store.rb
+- lib/watchdocs/rails/recordings/exporter.rb
+- lib/watchdocs/rails/recordings/recorder.rb
 - lib/watchdocs/rails/version.rb
 - watchdocs-rails-0.1.0.gem
 - watchdocs-rails-0.1.1.gem

data/lib/watchdocs/rails/bridge.rb

@@ -1,45 +0,0 @@
-require 'httparty'
-
-module Watchdocs
-  module Rails
-    module Bridge
-      class WatchdocsApiError < StandardError; end
-
-      DEFAULT_ERROR = 'Unknown API Error occured.'.freeze
-
-      class << self
-        def send(payload)
-          response = HTTParty.post(
-            api_url,
-            body: payload.to_json,
-            headers: { 'Content-Type' => 'application/json' }
-          )
-          check_response(response)
-        end
-
-        private
-
-        def check_response(response)
-          case response.code.to_s.chars.first
-          when '2'
-            true
-          when '4', '5'
-            raise WatchdocsApiError, get_error(response.body)
-          else
-            raise WatchdocsApiError, DEFAULT_ERROR
-          end
-        end
-
-        def get_error(response_body)
-          JSON.parse(response_body)['errors'].join(', ')
-        rescue
-          DEFAULT_ERROR
-        end
-
-        def api_url
-          Watchdocs::Rails.configuration.sync_url
-        end
-      end
-    end
-  end
-end

data/lib/watchdocs/rails/store.rb

@@ -1,31 +0,0 @@
-module Watchdocs
-  module Rails
-    module Store
-      # You can implement you own store for recordings
-      # Just create module that implements following methods
-
-      ## Params
-      ## content - is a Ruby Array of Hashes
-      # def write(content)
-      #   ...
-      # end
-
-      ## Returns Ruby Array of Hashes
-      # def read
-      #   ...
-      # end
-
-      # def delete!
-      #   ...
-      # end
-
-      ## Returns true if store already initialized
-      # def exists?
-      #   ...
-      # end
-    end
-  end
-end
-
-require 'watchdocs/rails/store/file_store'
-require 'watchdocs/rails/store/memory_store'