rspec_request_helpers 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99dde53b6b3cdf370ea4d38a79cca61fb7e73b433019da817c65fbd9a6c3b0ca
-  data.tar.gz: 4b713ccbebe9399f23effd83a2d8dfe9c18b2132b1516b5f9c71c8f3975688c9
+  metadata.gz: 17e13bcdd36a8111ca76111fce8b9c53c7453d4bcc61817b2840952792afdd21
+  data.tar.gz: d67ab35a255933d2e1ceac515e274474b7cacbc415e3892f66780ccc951c6c94
 SHA512:
-  metadata.gz: 86f0a680809c597d6c0136b486f2d73886bf5434fa845b9cb53dea584eb28741cab9e39c9fb3b038a35a79af43f15a80903befa8943025ab2813aa04364cf5be
-  data.tar.gz: fa75a1d9c6fba201ba9fd5da5c382af659a286bae0c94fb9d384cf89f603b62fec448389f9bb8cd08dbfd5235c9e73e9e254347219260f08694d6232d417bd02
+  metadata.gz: 95f028fbf6238c016495c4bef1ab6aed57ba9b16b2f3c8fd7b90b7a40298dc95a26d74c88d732b061a391ca8ef60c8ce5718d2d8bd449ee212f432812fb43be9
+  data.tar.gz: 39749b39469ed69c7cd57478b7cc060fb4b4765bd595a29824720c0ded45669b05f44a164ce2f0d395f3a02806f46e21e429647cba62d871ddbb1bc85300f496

data/Gemfile.lock

@@ -1,45 +1,41 @@
 PATH
   remote: .
   specs:
-    rspec_request_helpers (0.2.3)
+    rspec_request_helpers (0.3.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
-      factory_bot
-      parser
-      rack (~> 2.0)
+      rack
       railties (>= 3.0)
-      rspec (~> 3.0)
+      rspec (>= 2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.2.1)
-      actionview (= 5.2.2.1)
-      activesupport (= 5.2.2.1)
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.2.1)
-      activesupport (= 5.2.2.1)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.2.2.1)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    ast (2.4.0)
+      zeitwerk (~> 2.1, >= 2.1.8)
     builder (3.2.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
     crass (1.0.4)
     diff-lcs (1.3)
     erubi (1.8.0)
-    factory_bot (5.0.2)
-      activesupport (>= 4.2.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     loofah (2.2.3)
@@ -48,27 +44,25 @@ GEM
     method_source (0.9.0)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
-    nokogiri (1.10.2)
+    nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
-    parser (2.6.2.0)
-      ast (~> 2.4.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.0.6)
+    rack (2.0.7)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
+    rails-html-sanitizer (1.2.0)
       loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.2.1)
-      actionpack (= 5.2.2.1)
-      activesupport (= 5.2.2.1)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
+      thor (>= 0.20.3, < 2.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -87,6 +81,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    zeitwerk (2.1.10)
 
 PLATFORMS
   ruby
@@ -95,6 +90,7 @@ DEPENDENCIES
   bundler (~> 1.16)
   pry
   rake (~> 10.0)
+  rspec (~> 3.0)
   rspec_request_helpers!
 
 BUNDLED WITH

data/README.md

@@ -1,55 +1,45 @@
 # Rspec Request Helpers
 
-This gem provides few tools to make testing of API endpoint in your Rails application more effective.
-
-[![RSpec flow part 1](http://img.youtube.com/vi/YkZYNlUHHOg/1.jpg)](http://www.youtube.com/watch?v=YkZYNlUHHOg) [![RSpec flow part 2](http://img.youtube.com/vi/CB60JdImYC4/2.jpg)](http://www.youtube.com/watch?v=CB60JdImYC4)
+This gem provides few helpers for request testing
 
 This rules were influenced by real projects experience so
-In order to use it in your `rspec/requests` specs you need to follow one rule:
-
-    For every test example you need to define path, headers, params, and expected_response.
+In order to use it for your `rspec/requests` specs you need to follow convention
 
-    NOTE: version 0.1.1 introduced the helpers which ensure naming conventions. They have identical names and in fact are
-    wrappers around RSpec `let` functionality.
+```ruby
+  RSpec.describe 'Some API' do
+    path { '/api/v1/posts' }
+    headers do
+      {
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json',
+        'X-App-Token' => user.api_key
+      }
+    end
+    params do
+      {
+        name: name,
+        description: description,
+        author_id: author_id
+      }
+    end
+    response do
+      { id: 123, name: name, description: description, author: 'Bob Poster' }
+    end
+
+    it `creates post` do
+      # Ex. do_post_and_assert_201_json_parsed
+    end
+  end
+```
 
 So what you'll got for that? - Few handy methods for the testing routine
 
 | Action | Meaning | RSpec Example |
 |---|---|---|
-| `do_get`, `do_post`, `do_put`, `do_delete`, `do_patch` | Sends apropriate request to endpoint with valid params and headers | `get(path, valid_params, valid_headers)` |
+| `do_get`, `do_post`, `do_put`, `do_delete`, `do_patch` | Sends apropriate request to endpoint with valid params and headers | `get(path, params, headers)` |
 | `assert_201_json`, `assert_404_xml`, `assert_422_json` etc | Assert response status code and mime type (Dynamicly generated based on config ) | `expect(response).to have_http_status(status)`<br>`expect(response.content_type).to eq mime_type` |
-| `do_post_and_assert_201_json_response_body` | Shorthand for asserting content type, HTTP status code and if parsed body of the response is equal to | `expect(parsed_body).to eq(expected_response)` |
-
-Version 0.2.0 introduced `database` method which acceps the code block witch allow creation of database records via `FactoryBot` and Rspec `let`, `let!` syntax.
-
-```ruby
-#
-# Usage:
-# user(:user, name: 'Bob') translates to let(:user) { FactoryBot.create(:user, name: 'Bob') }
-# user!(:user, name: 'Bob') translates to let!(:user) { FactoryBot.create(:user, name: 'Bob') }
-# user_list(:user, name: 'Bob', 3) translates to let(:user) { FactoryBot.create_list(:user, 3, name: 'Bob') }
-# user_list!(:user, name: 'Bob', 3) translates to let!(:user) { FactoryBot.create_list(:user, 3, name: 'Bob') }
-#
-database do
-  company2!(:company, name: name, domain_name: domain, location: location_name)
-  company3!(:company, name: name2, domain_name: domain, location: location_name)
-  order1!(:order, :ordered, :with_items, items_count: 1, status: IN_QC, company_id: company3.id, delivered_at: Time.zone.now)
-  order2!(:order, :ordered, :with_items, items_count: 1, status: COMPLETED, company_id: company3.id, delivered_at: Time.zone.now, order_date: (Time.zone.now - 1.day))
-  order3!(:order, :ordered, :with_items, items_count: 1, status: NOT_READY, company_id: company3.id)
-end
-```
-
-Since version 0.2.1 there is an ability to define regular variables which text example depends on in separate block with handy syntax support
-
-```ruby
-vars do
-  variant_id { variant.id }
-  issue_id { issue.id }
-  issue_message { 'Packed 5 instead of 3 items' }
-  item_id { item.id }
-  mispick_report { MispickReport.last }
-end
-```
+| `assert_200_json_raw`, `assert_201_json_hash`, `assert_201_json_object` | Same as above plus check against raw, hash or object presentation of response | `expect(response_body).to eq(expected_response)`
+| `do_post_and_assert_201_json_parsed` | Shorthand for asserting content type, HTTP status code and if parsed body of the response is equal to | `expect(response_hash).to eq(expected_response)` |
 
 ## Installation
 

data/lib/rspec_request_helpers/helpers.rb

@@ -1,64 +1,6 @@
 module RspecRequestHelpers
   module Helpers
     module ClassMethods
-      require 'parser/current'
-
-      class DatabaseDSLTranslator < ::Parser::TreeRewriter
-        def on_send(node)
-          _, method_name, *args = node.children
-
-          factory_attrs = args.map { |e| e.loc.expression.source }.join(', ')
-
-          case method_name
-          when /list!$/
-            replace(node.loc.expression, "let!(:#{method_name.to_s.sub(/_list!$/,'')}) { FactoryBot.create_list(#{factory_attrs}) }")
-          when /list$/
-            replace(node.loc.expression, "let(:#{method_name.to_s.sub(/_list$/,'')}) { FactoryBot.create_list(#{factory_attrs}) }")
-          when /!$/
-            replace(node.loc.expression, "let!(:#{method_name.to_s.sub(/!$/,'')}) { FactoryBot.create(#{factory_attrs}) }")
-          else
-            replace(node.loc.expression, "let(:#{method_name}) { FactoryBot.create(#{factory_attrs}) }")
-          end
-        end
-      end
-
-      #
-      # Tiny DSL for creating list or single database records
-      # via factory_bot syntax and Rspec :let or :let! methods
-      # Usage:
-      # user(:user, name: 'Bob') is translated to let(:user) { FactoryBot.create(:user, name: 'Bob') }
-      # user!(:user, name: 'Bob') is translated to let!(:user) { FactoryBot.create(:user, name: 'Bob') }
-      # user_list(:user, name: 'Bob', 3) is translated to let(:user) { FactoryBot.create_list(:user, 3, name: 'Bob') }
-      # user_list!(:user, name: 'Bob', 3) is translated to let!(:user) { FactoryBot.create_list(:user, 3, name: 'Bob') }
-      #
-      def database(&block)
-        parser        = Parser::CurrentRuby.new
-        rewriter      = DatabaseDSLTranslator.new
-        buffer        = Parser::Source::Buffer.new('(string)')
-        buffer.source = Parser::CurrentRuby.parse(block.source).children.last.loc.expression.source
-        rspec_factory = rewriter.rewrite(buffer, parser.parse(buffer))
-        self.class_eval(rspec_factory)
-      end
-
-      class VarsDSL
-        def initialize(klass)
-          @klass = klass
-        end
-
-        def method_missing(method_name, *args, &block)
-          case method_name
-          when /!$/
-            @klass.class_eval { let!(:"#{method_name.to_s.sub(/!$/,'')}", &block) }
-          else
-            @klass.class_eval { let(method_name, &block) }
-          end
-        end
-      end
-
-      def vars(&block)
-        VarsDSL.new(self).instance_eval(&block)
-      end
-
       def path(&block)
         let(:path, &block)
       end
@@ -71,7 +13,7 @@ module RspecRequestHelpers
         let(:headers, &block)
       end
 
-      def expected_response(&block)
+      def response(&block)
         let(:expected_response, &block)
       end
     end
@@ -89,42 +31,45 @@ module RspecRequestHelpers
     end
 
     def response_body
-      JSON.parse(response.body, symbolize_names: true)
+      response.body
     end
 
-    def response_object
-      OpenStruct.new(responce_body)
+    def response_hash
+      parse_json(response_body)
     end
 
     def response_objects
-      JSON.parse(response.body, object_class: OpenStruct)
+      JSON.parse(response_body, object_class: OpenStruct)
     end
 
-    def assert_body
-      expect(response.body).to eq expected_response
+    def assert_raw
+      expect(response_body).to eq expected_response
     end
 
-    def assert_response_object
-      expect(response_object).to have_attributes(expected_response)
+    def assert_object
+      expect(response_objects).to have_attributes(expected_response)
     end
 
-    def assert_response_body
-      expect(response_body).to eq(expected_response)
+    def assert_hash
+      expect(response_hash).to eq(expected_response)
     end
 
     def self.generate_helpers
       %i(get post put patch delete).each do |http_verb|
         define_method :"do_#{http_verb}" do
+          is_not_json_get = (http_verb == :get || headers['Content-Type'] != 'application/json')
+          params_require_normalization = Rails::VERSION::MAJOR < 4 && is_not_json_get
+          normalized_params = params_require_normalization ? params : params.to_json
           if Rails::VERSION::MAJOR >= 5
-            public_send(http_verb, path, params: params, headers: headers)
+            public_send(http_verb, path, params: normalized_params, headers: headers)
           else
-            public_send(http_verb, path, params, headers)
+            public_send(http_verb, path, normalized_params, headers)
           end
         end
 
         RspecRequestHelpers.configuration.content_types.each do |type, mime_type|
           RspecRequestHelpers.configuration.symbols_with_status_codes.each do |status, code|
-            %i(body response_object response_body).each do |resp_assertion|
+            %i(raw hash object).each do |resp_assertion|
               define_method :"assert_#{code}_#{type}" do
                 expect(response).to have_http_status(status)
                 expect(response.content_type).to eq mime_type

data/lib/rspec_request_helpers/version.rb

@@ -1,3 +1,3 @@
 module RspecRequestHelpers
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/rspec_request_helpers.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rspec_request_helpers/version'
@@ -35,13 +34,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activesupport', version_string
   spec.add_runtime_dependency 'actionpack',    version_string
   spec.add_runtime_dependency 'railties',      version_string
-  spec.add_runtime_dependency 'factory_bot'
+  spec.add_runtime_dependency 'rspec', '>= 2.4'
 
-  spec.add_dependency 'rspec', '~> 3.0'
-  spec.add_dependency 'rack', '~> 2.0'
-  spec.add_dependency 'parser'
+  spec.add_dependency 'rack'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'pry'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_request_helpers
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrii Baran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-26 00:00:00.000000000 Z
+date: 2019-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,75 +53,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
+        version: '1.16'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: parser
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement