watchdocs-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65f40dd4195dcebaf6c921fe90e58fa47a797ba2
+  data.tar.gz: cd195f1205230dd2e01f6852c3fbfd0ee4c3ec37
+SHA512:
+  metadata.gz: b6e626a941d6a69c278cf18eae9cf51df81bbe17f3b37c4fbb21c989e41b3538bf8a3f08b064cccb162fc64e96101a8a8b434aeb772563aafb3b16d4a4e2d58e
+  data.tar.gz: fc7014ea8d4bdc6a97a418ece8c25e7137eba5853cfe5c49dcc56b647731511fecd1a2d58aee1310841c5e223690281f6f6b84f9c03f4b7fd5201139f7298d16

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in watchdocs-rails.gemspec
+gemspec

data/README.md

@@ -0,0 +1,152 @@
+# watchdocs-rails
+
+[Watchdocs](http://watchdocs.io) Rails JSON API requests watcher.
+
+It captures every JSON response, stores request and response details in temporary storage. Provides methods to send recorded calls to [Watchdocs](http://watchdocs.io) which checks them agains the documentation or create docs for new calls.
+
+## Installation
+
+Add to your Gemfile. It is recommended to add to `:test, :development` group.
+
+```ruby
+gem 'watchdocs-rails', '~> 0.1.0'
+```
+
+and run
+
+```
+bundle
+```
+
+## Configuration
+
+Create `config/initializers/watchdocs.rb` and configure the gem if you need to change default configuration:
+
+```ruby
+  Watchdocs::Rails.configure do |c|
+    c.store_class = Watchdocs::Rails::Store::MemoryStore
+    c.temp_directory = 'tmp'
+    c.sync_url = 'http://demo8792890.mockable.io/requests'
+  end
+```
+
+### store_class
+
+This option allows you to specify class that is responsible for storing recordings.
+
+You can select from provided options:
+
+- `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
+```
+
+### temp_directory
+
+**Applicable only when `JsonFileStore` enabled as `store_class`**
+Directory to store temporary file with recordings.
+
+### sync_url
+
+URL for syncing with your Watchdocs project.
+
+## Usage
+
+### Tests
+
+If you have some requests specs or features specs that call JSON API then add this line to your `config/environments/test.rb`.
+
+```ruby
+config.middleware.insert(0, Watchdocs::Rails::Middleware)
+```
+
+Update/create your spec hooks:
+
+#### RSpec
+
+In `specs/rails_helper.rb`:
+
+```ruby
+  config.before(:suite) do
+    ....
+    Watchdocs::Rails::Recordings.clear!
+  end
+
+  config.after(:suite) do
+    ....
+    Watchdocs::Rails::Recordings.send
+  end
+```
+
+#### Minitest
+
+
+```
+Minitest.after_run do
+  Watchdocs::Rails::Recordings.send
+end
+```
+
+### Development
+
+If you don't have any 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`.
+
+**IMPORTANT NOTE: You need to select `JsonFileStore` as storage option in that case.**
+
+
+## Versioning
+
+Semantic versioning (http://semver.org/spec/v2.0.0.html) is used.
+
+For a version number MAJOR.MINOR.PATCH, unless MAJOR is 0:
+
+1. MAJOR version is incremented when incompatible API changes are made,
+2. MINOR version is incremented when functionality is added in a backwards-compatible manner,
+3. PATCH version is incremented when backwards-compatible bug fixes are made.
+
+Major version "zero" (0.y.z) is for initial development. Anything may change at any time.
+The public API should not be considered stable.
+Furthermore, version "double-zero" (0.0.x) is not intended for public use,
+as even minimal functionality is not guaranteed to be implemented yet.
+
+## Dependencies
+
+- httparty
+- configurations
+- mini_memory_store
+
+## Contributing
+
+1. Fork it ( https://github.com/<user>/<gem>/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "watchdocs/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/watchdocs/rails/bridge.rb

@@ -0,0 +1,45 @@
+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/configuration.rb

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

data/lib/watchdocs/rails/core_extensions/enumerable.rb

@@ -0,0 +1,11 @@
+module Enumerable
+  def filter_data
+    map do |v|
+      if v.is_a?(Enumerable)
+        v.filter_data
+      else
+        v.json_data_type
+      end
+    end
+  end
+end

data/lib/watchdocs/rails/core_extensions/hash.rb

@@ -0,0 +1,16 @@
+class Hash
+  def filter_data
+    filtered = map do |k, v|
+      if v.is_a?(Enumerable)
+        [k, v.filter_data]
+      else
+        [k, v.json_data_type]
+      end
+    end
+    Hash[filtered]
+  end
+
+  def upcased_keys
+    map { |k, _v| k.upcase }
+  end
+end

data/lib/watchdocs/rails/core_extensions/object.rb

@@ -0,0 +1,15 @@
+class Object
+  def json_data_type
+    if is_a?(Numeric)
+      'number'
+    elsif is_a?(NilClass)
+      'null'
+    elsif is_a?(String)
+      'string'
+    elsif is_a?(TrueClass) || is_a?(FalseClass)
+      'boolean'
+    else
+      '*****'
+    end
+  end
+end

data/lib/watchdocs/rails/core_extensions.rb

@@ -0,0 +1,3 @@
+require 'watchdocs/rails/core_extensions/enumerable'
+require 'watchdocs/rails/core_extensions/hash'
+require 'watchdocs/rails/core_extensions/object'

data/lib/watchdocs/rails/middleware.rb

@@ -0,0 +1,89 @@
+module Watchdocs
+  module Rails
+    class Middleware
+      attr_reader :app, :report
+
+      def initialize(app)
+        @app = app
+        @report = {}
+      end
+
+      def call(env)
+        app.call(env).tap do |response|
+          if json_response?(response)
+            catch_request(env)
+            catch_response(response)
+            match_endpoint_pattern
+            record_call
+          end
+        end
+      end
+
+      private
+
+      def json_response?(response)
+        headers = response.second
+        headers['Content-Type'] && headers['Content-Type'].include?('json')
+      end
+
+      def catch_request(env)
+        @report[:request] = {
+          method: env['REQUEST_METHOD'],
+          url: env['PATH_INFO'],
+          query_string_params: CGI.parse(env['QUERY_STRING']),
+          body: parse_body(env['rack.input'].read),
+          headers: request_headers(env)
+        }
+      end
+
+      def catch_response(response)
+        status, headers, body = *response
+        @report[:response] = {
+          status: status,
+          headers: headers.to_hash.upcased_keys,
+          body: parse_body(body_string(body))
+        }
+      end
+
+      def match_endpoint_pattern
+        @report[:endpoint] = begin
+          Rails.application.routes.router.routes
+               .simulator.memos(report[:request][:url])
+               .last.path.spec.to_s.sub('(.:format)', '')
+        end
+      rescue
+        @report[:endpoint] = 'No routes match'
+      end
+
+      def record_call
+        Watchdocs::Rails::Recordings.record_call(report)
+      end
+
+      def request_headers(env)
+        env.keys
+           .select { |k| k.start_with? 'HTTP_' }
+           .map { |k| format_header(k) }
+           .sort
+      end
+
+      def format_header(header)
+        header.sub(/^HTTP_/, '')
+              .tr('_', '-')
+      end
+
+      def body_string(body)
+        return if body.empty?
+        body_string = ''
+        body.each { |line| body_string += line }
+        body_string
+      end
+
+      def parse_body(body)
+        return if body.empty?
+        JSON.parse(body).filter_data
+      rescue JSON::ParserError
+        'Invalid JSON'
+      end
+    end
+  end
+end

data/lib/watchdocs/rails/recordings.rb

@@ -0,0 +1,47 @@
+module Watchdocs
+  module Rails
+    module Recordings
+      class << self
+        def record_call(new_call)
+          output = if recordings_exists?
+                     current_recordings << new_call
+                   else
+                     [new_call]
+                   end
+          save_recordings(output)
+        end
+
+        def clear!
+          clear_recordings
+        end
+
+        def send
+          Watchdocs::Rails::Bridge.send(current_recordings) &&
+            clear_recordings
+        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
+        end
+      end
+    end
+  end
+end

data/lib/watchdocs/rails/store/file_store.rb

@@ -0,0 +1,49 @@
+module Watchdocs
+  module Rails
+    module Store
+      module JsonFileStore
+        class StorageError < StandardError; end
+
+        class << self
+          def write(content)
+            File.write(path_to_file, content.to_json)
+            path_to_file
+          rescue StandardError => e
+            raise StorageError, e
+          end
+
+          def read
+            file = File.open(path_to_file, 'r')
+            JSON.parse(file.read)
+          rescue JSON::ParserError
+            []
+          rescue StandardError => e
+            raise StorageError, e
+          ensure
+            file.close
+          end
+
+          def delete!
+            File.delete(path_to_file)
+          rescue StandardError => e
+            raise StorageError, e
+          end
+
+          def exists?
+            File.exist?(path_to_file)
+          end
+
+          private
+
+          def path_to_file
+            "#{temp_local_path}/reqests.json"
+          end
+
+          def temp_local_path
+            Watchdocs::Rails.configuration.temp_directory
+          end
+        end
+      end
+    end
+  end
+end

data/lib/watchdocs/rails/store/memory_store.rb

@@ -0,0 +1,33 @@
+require 'mini_memory_store'
+
+module Watchdocs
+  module Rails
+    module Store
+      module MemoryStore
+        class << self
+          def write(content)
+            store.set(content)
+          end
+
+          def read
+            store.get
+          end
+
+          def delete!
+            store.clear
+          end
+
+          def exists?
+            store.get
+          end
+
+          private
+
+          def store
+            @store ||= MiniMemoryStore.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/watchdocs/rails/store.rb

@@ -0,0 +1,31 @@
+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'

data/lib/watchdocs/rails/version.rb

@@ -0,0 +1,5 @@
+module Watchdocs
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/watchdocs/rails.rb

@@ -0,0 +1,11 @@
+require 'watchdocs/rails/core_extensions'
+require 'watchdocs/rails/store'
+require 'watchdocs/rails/configuration'
+require 'watchdocs/rails/middleware'
+require 'watchdocs/rails/bridge'
+require 'watchdocs/rails/recordings'
+
+module Watchdocs
+  module Rails
+  end
+end

data/lib/watchdocs-rails.rb

@@ -0,0 +1 @@
+require 'watchdocs/rails'

data/watchdocs-rails.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'watchdocs/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'watchdocs-rails'
+  spec.version       = Watchdocs::Rails::VERSION
+  spec.authors       = ['mazikwyry']
+  spec.email         = ['a.mazur@exlabs.co.uk']
+  spec.licenses      = ['MIT']
+
+  spec.summary       = 'Rails Rack-Middleware for capturing JSON requests
+                        and responses details'
+  spec.description   = 'It captures every JSON response, stores request and
+                        response details in temporary storage.
+                        Provides methods to send recorded calls to Watchdocs
+                        which checks them agains the documentation or create
+                        docs for new calls.'
+  spec.homepage      = 'http://watchdocs.io'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency 'mini_memory_store', '~> 0.1.0'
+  spec.add_runtime_dependency 'httparty', '~> 0.14.0'
+  spec.add_runtime_dependency 'configurations', '~> 2.2', '>= 2.2.0'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: watchdocs-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mazikwyry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: mini_memory_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: configurations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: |-
+  It captures every JSON response, stores request and
+                          response details in temporary storage.
+                          Provides methods to send recorded calls to Watchdocs
+                          which checks them agains the documentation or create
+                          docs for new calls.
+email:
+- a.mazur@exlabs.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/.DS_Store
+- lib/watchdocs-rails.rb
+- lib/watchdocs/.DS_Store
+- lib/watchdocs/rails.rb
+- lib/watchdocs/rails/bridge.rb
+- lib/watchdocs/rails/configuration.rb
+- lib/watchdocs/rails/core_extensions.rb
+- lib/watchdocs/rails/core_extensions/enumerable.rb
+- lib/watchdocs/rails/core_extensions/hash.rb
+- 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/version.rb
+- watchdocs-rails.gemspec
+homepage: http://watchdocs.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Rails Rack-Middleware for capturing JSON requests and responses details
+test_files: []