beyond_the_api_test_helpers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bc32ded39e0add424209b6bdabce6d8f6110956
+  data.tar.gz: b8f2eeab1d3eda9c41479669793998c6e67f239e
+SHA512:
+  metadata.gz: d1d359c59cd3bc49c207d6f06b6d069e1228dbe7821424efcf3ab21d312eee27e275f67659f80fcb17fa83221b3b051e6335e8f1bbe77923978999be8de3a83e
+  data.tar.gz: 386a552a8c3c88e329fb70e46ff83fd36a49f4b6ea21a736ad86f3190558d1be8be61a58c8769843c52b7d9cb4aef0a5a59d90c241bec7d8f46213fa8db7ff2c

data/.gitignore

@@ -0,0 +1,19 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history
+
+.gem

data/.rubocop.yml

@@ -0,0 +1,60 @@
+AllCops:
+  DisabledByDefault: false
+  TargetRubyVersion: 2.3
+  Exclude:
+    - db/migrate/*
+    - db/schema.rb
+    - lib/generators/**/*
+    - lib/rails/generators/**/*
+    - lib/populate/**/*
+    - bin/*
+Rails:
+  Enabled: true
+Metrics/LineLength:
+  Max: 100
+Metrics/ClassLength:
+  CountComments: false
+  Max: 100
+  Exclude:
+    - test/**/*
+Metrics/ClassLength:
+  CountComments: false
+  Max: 300
+  Include:
+    - test/**/*
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - test/**/*
+Metrics/BlockLength:
+  Enabled: false
+  Include:
+    - test/**/*
+Style/PredicateName:
+  Enabled: true
+  Exclude:
+    - test/support/shoulda/**/*
+Style/PredicateName:
+  Enabled: false
+  Include:
+    - test/support/shoulda/**/*
+Style/AsciiComments:
+  Enabled: false
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+Style/WordArray:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 William Weckl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Beyond The API Test Helpers
+
+Beyond The API is a framework created to standardize Rails APIs and make things easier.
+
+This gem consist in various test helpers for testing an application based in Beyond The API gem.
+
+The tests are based in minitest.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'beyond_the_api_test_helpers', require: false, group: :test
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install beyond_the_api_test_helpers
+
+## Installation
+
+Include in your test_helper.rb:
+```ruby
+require 'beyond_the_api_test_helpers'
+```
+
+## Usage
+
+TODO
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/williamweckl/beyond_the_api_test_helpers.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/beyond_the_api_test_helpers.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'beyond_the_api_test_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'beyond_the_api_test_helpers'
+  spec.version       = BeyondTheApiTestHelpers::VERSION
+  spec.authors       = ['William Weckl']
+  spec.email         = ['william.weckl@gmail.com']
+
+  spec.summary       = 'Test helpers for beyond the API.'
+  spec.description   = 'Test helpers for beyond the API.'
+  spec.homepage      = 'http://rubygems.org/gems/beyond_the_api_test_helpers'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'minitest'
+  spec.add_dependency 'mocha'
+  spec.add_dependency 'shoulda', '>= 3.5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/config.reek

@@ -0,0 +1,63 @@
+---
+### Generic smell configuration
+
+IrresponsibleModule:
+  enabled: false
+UnusedPrivateMethod:
+  enabled: false
+NilCheck:
+  enabled: false
+
+"app/controllers":
+  TooManyStatements:
+    max_statements: 10
+  NestedIterators:
+    max_allowed_nesting: 2
+  UnusedPrivateMethod:
+    enabled: false
+  UncommunicativeModuleName:
+    enabled: false
+  InstanceVariableAssumption:
+    enabled: false
+  ManualDispatch:
+    enabled: false
+"app/helpers":
+  UtilityFunction:
+    enabled: false
+  FeatureEnvy:
+    enabled: false
+  ManualDispatch:
+    enabled: false
+"app/models":
+  Attribute:
+    enabled: false
+"app/serializer":
+  RepeatedConditional:
+    enabled: false
+"test/support":
+  UtilityFunction:
+    enabled: false
+  FeatureEnvy:
+    enabled: false
+  TooManyStatements:
+    max_statements: 10
+  InstanceVariableAssumption:
+    enabled: false
+  TooManyMethods:
+    max_methods: 20
+  ManualDispatch:
+    enabled: false
+  DataClump:
+    enabled: false
+"test/requests":
+  UncommunicativeModuleName:
+    enabled: false
+
+### Excluding directories
+
+# Directories below will not be scanned at all
+exclude_paths:
+  - db/migrate
+  - lib/generators
+  - lib/rails/generators
+  - lib/populate

data/lib/beyond_the_api_test_helpers.rb

@@ -0,0 +1,43 @@
+require 'beyond_the_api_test_helpers/i18n_test_helpers'
+Dir["#{File.dirname(__FILE__)}/beyond_the_api_test_helpers/request/**/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/beyond_the_api_test_helpers/shoulda/**/*.rb"].each { |f| require f }
+
+I18n.enforce_available_locales = false
+
+class TestExceptionLocalizationHandler
+  # :reek:LongParameterList: { enabled: false }
+  def call(exception, _locale, _key, _options)
+    raise exception.message
+  end
+end
+
+class TestLanguage
+  cattr_accessor :current
+end
+
+ActiveSupport::TestCase.class_eval do
+  include BeyondTheApiTestHelpers::I18nTestHelpers
+
+  # Setup ActiveJob to run with test adapter
+  ActiveJob::Base.queue_adapter = :test
+
+  # Raise errors on i18n missing translations
+  I18n.exception_handler = ::TestExceptionLocalizationHandler.new
+
+  Faker::Config.locale = I18n.locale = TestLanguage.current = I18n.available_locales.sample
+
+  teardown do
+    I18n.locale = TestLanguage.current
+  end
+end
+
+ActionDispatch::IntegrationTest.class_eval do
+  include BeyondTheApiTestHelpers::Request::Helpers
+  include BeyondTheApiTestHelpers::Request::CommonAssertions
+  include BeyondTheApiTestHelpers::Request::IndexAssertions
+  include BeyondTheApiTestHelpers::Request::ShowAssertions
+  include BeyondTheApiTestHelpers::Request::CreateAssertions
+  include BeyondTheApiTestHelpers::Request::UpdateAssertions
+  include BeyondTheApiTestHelpers::Request::DestroyAssertions
+  include BeyondTheApiTestHelpers::Request::RestoreAssertions
+end

data/lib/beyond_the_api_test_helpers/i18n_test_helpers.rb

@@ -0,0 +1,13 @@
+module BeyondTheApiTestHelpers
+  module I18nTestHelpers
+    def assert_i18n_for_all_locales
+      I18n.available_locales.each do |locale|
+        ActiveRecord::Base.transaction do
+          Faker::Config.locale = I18n.locale = locale
+          yield
+          raise ActiveRecord::Rollback
+        end
+      end
+    end
+  end
+end

data/lib/beyond_the_api_test_helpers/request/common_assertions.rb

@@ -0,0 +1,51 @@
+module BeyondTheApiTestHelpers
+  module Request
+    module CommonAssertions
+      def assert_request_needs_to_be_logged(url, http_method)
+        assert_i18n_for_all_locales do
+          send(http_method, url, params: @params, headers: @headers)
+          response_assertions(status: 403)
+          assert_equal true, json['redirect_to_login']
+          assert_equal I18n.t('api.errors.messages.require_user_authentication'), json['error']
+        end
+      end
+
+      def meta
+        json['meta']
+      end
+
+      def json_response_name
+        json[@response_name]
+      end
+
+      def request_instance_variables_set(params = {})
+        params.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+        @headers ||= {}
+        @params ||= {}
+        @response_name ||= (@klass || subject.class).to_s.underscore
+      end
+
+      def request_instance_variables_set_pluralize(params = {})
+        request_instance_variables_set(params)
+        @response_name = @response_name.pluralize
+      end
+
+      def assert_not_found_request
+        response_assertions(status: 404)
+        not_found_obj = @not_found_name ? I18n.t(@not_found_name) : subject.class.model_name.human
+        not_found_message = I18n.t('api.errors.messages.not_found',
+                                   obj: not_found_obj)
+        assert_equal not_found_message, json['error']
+      end
+
+      def assert_parameter_missing_request
+        response_assertions(status: 400)
+        parameter_missing_message = I18n.t('api.errors.messages.parameter_missing',
+                                           parameter: subject.class.to_s.underscore)
+        assert_equal parameter_missing_message, json['error']
+      end
+    end
+  end
+end

data/lib/beyond_the_api_test_helpers/request/create_assertions.rb

@@ -0,0 +1,82 @@
+module BeyondTheApiTestHelpers
+  module Request
+    module CreateAssertions
+      def assert_request_create_valid(url, options = {})
+        request_instance_variables_set options
+        if required_login
+          assert_request_needs_to_be_logged(url, :post)
+          @headers.merge!(logged_in_headers)
+        end
+
+        assert_i18n_for_all_locales do
+          do_create_request_with_transaction(url)
+        end
+      end
+
+      def assert_request_create_missing_param(url, options = {})
+        request_instance_variables_set options
+        @headers.merge!(logged_in_headers) if required_login
+        post(url, params: {}, headers: @headers)
+        assert_parameter_missing_request
+      end
+
+      def assert_request_create_with_errors(url, invalid_params, options = {})
+        request_instance_variables_set options
+        @headers.merge!(logged_in_headers) if required_login
+
+        ActiveRecord::Base.transaction do
+          do_create_request_and_assert_invalid(url, invalid_params)
+          raise ActiveRecord::Rollback
+        end
+      end
+
+      def assert_request_create_not_found(urls_not_found, options = {})
+        request_instance_variables_set options
+        @headers.merge!(logged_in_headers) if required_login
+
+        urls_not_found.each do |url_not_found|
+          assert_request_create_not_found_i18n_all(url_not_found)
+        end
+      end
+
+      private
+
+      def do_create_request_with_transaction(url)
+        ActiveRecord::Base.transaction do
+          do_create_request_and_assert(url)
+          Redis.current.flushdb if @flush_redis_db_between_i18n_tests
+          raise ActiveRecord::Rollback
+        end
+      end
+
+      # :reek:DuplicateMethodCall: { max_calls: 2 }
+      def do_create_request_and_assert(url)
+        klass = @klass || subject.class
+        old_count = klass.count
+        post(url, params: @params, headers: @headers)
+        response_assertions(status: 201)
+        assert_equal old_count + 1, klass.count unless @skip_count
+        assert_equal I18n.t(*@message), json['success']
+        assert_kind_of Hash, json_response_name unless @skip_json_response_name
+      end
+
+      # :reek:DuplicateMethodCall: { max_calls: 2 }
+      def do_create_request_and_assert_invalid(url, invalid_params)
+        klass = @klass || subject.class
+        old_count = klass.count
+        post(url, params: invalid_params, headers: @headers)
+        response_assertions(status: 422)
+        assert_equal old_count, klass.count
+        assert_kind_of Hash, json['errors']
+        assert_kind_of Array, json['full_error_messages']
+      end
+
+      def assert_request_create_not_found_i18n_all(url_not_found)
+        assert_i18n_for_all_locales do
+          post(url_not_found, params: @params, headers: @headers)
+          assert_not_found_request
+        end
+      end
+    end
+  end
+end