apipie-rails 0.5.18 → 0.6.0

data/rel-eng/gem_release.ipynb

@@ -0,0 +1,398 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Release of apipie-rails gem\n",
+    "\n",
+    "### Requirements\n",
+    "- push access to https://github.com/Apipie/apipie-rails\n",
+    "- push access to rubygems.org for apipie-rails\n",
+    "- sudo yum install python-slugify asciidoc\n",
+    "- ensure neither the `git push` or `gem push` don't require interractive auth. If you can't use api key or ssh key to auth skip these steps and run them form the shell manually\n",
+    "- ensure all checks have passed on the branch you're about to release\n",
+    "\n",
+    "### Release process\n",
+    "- Follow the steps with `<Shift>+<Enter>` or `<Ctrl>+<Enter>,<Down>`\n",
+    "- If anything fails, fix it and re-run the step if applicable\n",
+    "\n",
+    "### Release settings"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%autosave 0"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%cd .."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Update the following notebook settings"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "NEW_VERSION = '0.5.20'\n",
+    "LAST_VERSION = '0.5.19'\n",
+    "GIT_REMOTE_UPSTREAM = 'origin'\n",
+    "STABLE_RELEASE = False\n",
+    "WORK_BRANCH = 'stable' if STABLE_RELEASE else 'master'\n",
+    "# Array of strings, e.g. [\"21cbsc214g3\", \"21casc214g3\"]\n",
+    "CHERRY_PICKS = []\n",
+    "GEMFILE='Gemfile.rails61'"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Ensure the repo is up to date"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git checkout {WORK_BRANCH}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git fetch {GIT_REMOTE_UPSTREAM}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git rebase {GIT_REMOTE_UPSTREAM}/{WORK_BRANCH}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Cherry picks for stable release"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "if STABLE_RELEASE:\n",
+    "    for cp in CHERRY_PICKS:\n",
+    "        ! git cherry-pick -x {cp}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Run tests localy if your setup allows, otherwise ensure the HEAD is green"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! BUNDLE_GEMFILE=gemfiles/{GEMFILE} bundle update"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": true
+   },
+   "outputs": [],
+   "source": [
+    "! BUNDLE_GEMFILE=gemfiles/{GEMFILE} bundle exec rspec"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Update release related stuff"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! sed -i 's/VERSION = .*/VERSION = \"{NEW_VERSION}\"/' lib/apipie/version.rb"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Parse git changelog\n",
+    "from IPython.display import Markdown as md\n",
+    "from subprocess import check_output\n",
+    "from shlex import split\n",
+    "import re\n",
+    "\n",
+    "def format_log_entry(entry):\n",
+    "    author = re.search(r'author:(.*)', entry).group(1)\n",
+    "    entry = re.sub(r'author:(.*)', '', entry)\n",
+    "    entry = re.sub(r'([fF]ixes|[rR]efs)[^-]*-\\s*(.*)', r'\\2', entry)\n",
+    "    entry = '* ' + entry.capitalize()\n",
+    "    entry = re.sub(r'\\(#([0-9]+)\\)', r'[#\\1](https://github.com/Apipie/apipie-rails/pull/\\1)', entry)\n",
+    "    entry = entry + f'({author})'\n",
+    "    return entry\n",
+    "\n",
+    "def skip(entry):\n",
+    "    if re.match(r'Merge pull', entry) or \\\n",
+    "      re.match(r'^i18n', entry) or \\\n",
+    "      re.match(r'^Bump to version', entry):\n",
+    "        return True\n",
+    "    else:\n",
+    "        return False \n",
+    "git_log_cmd = 'git log --pretty=format:\"%%s author:%%an\" v%s..HEAD' % LAST_VERSION\n",
+    "log = check_output(split(git_log_cmd)).decode('utf8').split('\\n')\n",
+    "change_log = [format_log_entry(e) for e in log if not skip(e)]\n",
+    "md('\\n'.join(change_log))\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Write release notes\n",
+    "from datetime import datetime\n",
+    "import fileinput\n",
+    "import sys\n",
+    "\n",
+    "fh = fileinput.input('CHANGELOG.md', inplace=True)  \n",
+    "for line in fh:  \n",
+    "    print(line.rstrip())\n",
+    "    if re.match(r'========', line):\n",
+    "        print('## [v%s](https://github.com/Apipie/apipie-rails/tree/v%s) (%s)' % (NEW_VERSION, NEW_VERSION, datetime.today().strftime('%Y-%m-%d')))\n",
+    "        print('[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v%s...v%s)' % (LAST_VERSION, NEW_VERSION))\n",
+    "        for entry in change_log:\n",
+    "            print(entry)\n",
+    "        print('')\n",
+    "fh.close()  "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Manual step: Update deps in the gemspec if neccessary"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Check what is going to be commited"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": false
+   },
+   "outputs": [],
+   "source": [
+    "! git add -u\n",
+    "! git status"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": true
+   },
+   "outputs": [],
+   "source": [
+    "! git diff --cached"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Commit changes"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": true
+   },
+   "outputs": [],
+   "source": [
+    "! git commit -m \"Bump to {NEW_VERSION}\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Tag new version"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git tag {NEW_VERSION}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Build the gem"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! BUNDLE_GEMFILE=gemfiles/{GEMFILE} bundle exec rake build"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! gem push pkg/apipie-rails-{NEW_VERSION}.gem"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### PUSH the changes upstream If everything is correct"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git push {GIT_REMOTE_UPSTREAM} {WORK_BRANCH}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git push --tags {GIT_REMOTE_UPSTREAM} {WORK_BRANCH}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Now the new release is in upstream repo"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Some manual steps follow to improve the UX\n",
+    "\n",
+    "#### New relase on GitHub\n",
+    "\n",
+    "Copy the following changelog lines to the description in form on link below\n",
+    "The release title is the new version."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print('\\n')\n",
+    "print('\\n'.join(change_log))\n",
+    "print('\\n\\nhttps://github.com/Apipie/apipie-rails/releases/new?tag=%s' % NEW_VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Congratulations\n",
+    "\n",
+    "Release is public now."
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

data/spec/controllers/apipies_controller_spec.rb

@@ -47,6 +47,31 @@ describe Apipie::ApipiesController do
 
       assert_response :not_found
     end
+
+    it "succeeds on method details with a supported language" do
+      allow(Apipie.configuration).to receive(:languages).and_return(%w[en es])
+
+      get :index, :params => { :version => "2.0", :resource => "architectures", :method => "index.es" }
+
+      assert_response :success
+    end
+
+    it "succeeds on method details with the default language" do
+      allow(Apipie.configuration).to receive(:default_locale).and_return("en")
+      allow(Apipie.configuration).to receive(:languages).and_return([])
+
+      get :index, :params => { :version => "2.0", :resource => "architectures", :method => "index.en" }
+
+      assert_response :success
+    end
+
+    it "returns not_found on a method with an unsupported language" do
+      allow(Apipie.configuration).to receive(:languages).and_return(%w[en es])
+
+      get :index, :params => { :version => "2.0", :resource => "architectures", :method => "index.jp" }
+
+      assert_response :not_found
+    end
   end
 
   describe "reload_controllers" do

data/spec/dummy/config/application.rb

@@ -1,10 +1,7 @@
 require File.expand_path('../boot', __FILE__)
 
-require "active_model/railtie"
-require "active_record/railtie"
 require "action_controller/railtie"
 require "action_view/railtie"
-require "action_mailer/railtie"
 
 Bundler.require
 require "apipie-rails"

data/spec/dummy/config/environments/development.rb

@@ -13,9 +13,6 @@ Dummy::Application.configure do
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
 
-  # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
-
   # Print deprecation notices to the Rails logger
   config.active_support.deprecation = :log
 

data/spec/dummy/config/environments/production.rb

@@ -34,9 +34,6 @@ Dummy::Application.configure do
   # Enable serving of images, stylesheets, and javascripts from an asset server
   # config.action_controller.asset_host = "http://assets.example.com"
 
-  # Disable delivery errors, bad email addresses will be ignored
-  # config.action_mailer.raise_delivery_errors = false
-
   # Enable threaded mode
   # config.threadsafe!
 

data/spec/dummy/config/environments/test.rb

@@ -20,11 +20,6 @@ Dummy::Application.configure do
   # Disable request forgery protection in test environment
   config.action_controller.allow_forgery_protection    = false
 
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
-
   # Use SQL instead of Active Record's schema dumper when creating the test database.
   # This is necessary if your schema can't be completely dumped by the schema dumper,
   # like if you have constraints or database-specific column types

data/spec/lib/swagger/response_validation_spec.rb

@@ -10,78 +10,78 @@ RSpec.describe PetsController, :type => :controller do
   end
 
   it "does not raise error when rendered output matches the described response" do
-    response = get :return_and_validate_expected_response, {format: :json}
+    response = get :return_and_validate_expected_response, format: :json
     expect(response).to match_declared_responses
   end
 
   it "does not raise error when rendered output (array) matches the described response" do
-    response = get :return_and_validate_expected_array_response, {format: :json}
+    response = get :return_and_validate_expected_array_response, format: :json
     expect(response).to match_declared_responses
   end
 
   it "does not raises error when rendered output includes null in the response" do
-    response = get :return_and_validate_expected_response_with_null, {format: :json}
+    response = get :return_and_validate_expected_response_with_null, format: :json
     expect(response).to match_declared_responses
   end
 
   it "does not raise error when rendered output includes null (instead of an object) in the response" do
-    response = get :return_and_validate_expected_response_with_null_object, {format: :json}
+    response = get :return_and_validate_expected_response_with_null_object, format: :json
     expect(response).to match_declared_responses
   end
 
   it "raises error when a response field has the wrong type" do
-    response = get :return_and_validate_type_mismatch, {format: :json}
+    response = get :return_and_validate_type_mismatch, format: :json
     expect(response).not_to match_declared_responses
   end
 
   it "raises error when a response has a missing field" do
-    response = get :return_and_validate_missing_field, {format: :json}
+    response = get :return_and_validate_missing_field, format: :json
     expect(response).not_to match_declared_responses
   end
 
   it "raises error when a response has an extra property and 'swagger_allow_additional_properties_in_response' is false" do
-    response = get :return_and_validate_extra_property, {format: :json}
+    response = get :return_and_validate_extra_property, format: :json
     expect(response).not_to match_declared_responses
   end
 
   it "raises error when a response has is array instead of object" do
     # note: this action returns HTTP 201, not HTTP 200!
-    response = get :return_and_validate_unexpected_array_response, {format: :json}
+    response = get :return_and_validate_unexpected_array_response, format: :json
     expect(response).not_to match_declared_responses
   end
 
   it "does not raise error when a response has an extra property and 'swagger_allow_additional_properties_in_response' is true" do
     Apipie.configuration.swagger_allow_additional_properties_in_response = true
-    response = get :return_and_validate_extra_property, {format: :json}
+    response = get :return_and_validate_extra_property, format: :json
     expect(response).to match_declared_responses
   end
 
   it "does not raise error when a response has an extra field and 'additional_properties' is specified in the response" do
     Apipie.configuration.swagger_allow_additional_properties_in_response = false
-    response = get :return_and_validate_allowed_extra_property, {format: :json}
+    response = get :return_and_validate_allowed_extra_property, format: :json
     expect(response).to match_declared_responses
   end
 
   it "raises error when a response sub-object has an extra field and 'additional_properties' is not specified on it, but specified on the top level of the response" do
     Apipie.configuration.swagger_allow_additional_properties_in_response = false
-    response = get :sub_object_invalid_extra_property, {format: :json}
+    response = get :sub_object_invalid_extra_property, format: :json
     expect(response).not_to match_declared_responses
   end
 
-  it "does not rais error when a response sub-object has an extra field and 'additional_properties' is specified on it" do
+  it "does not raise error when a response sub-object has an extra field and 'additional_properties' is specified on it" do
     Apipie.configuration.swagger_allow_additional_properties_in_response = false
-    response = get :sub_object_allowed_extra_property, {format: :json}
+    response = get :sub_object_allowed_extra_property, format: :json
     expect(response).to match_declared_responses
   end
 
   describe "auto validation" do
     auto_validate_rendered_views
     it "raises exception when a response field has the wrong type and auto validation is turned on" do
-      expect { get :return_and_validate_type_mismatch, {format: :json} }.to raise_error(Apipie::ResponseDoesNotMatchSwaggerSchema)
+      expect { get :return_and_validate_type_mismatch, format: :json }.to raise_error(Apipie::ResponseDoesNotMatchSwaggerSchema)
     end
 
     it "does not raise an exception when calling an undocumented method" do
-      expect { get :undocumented_method, {format: :json} }.not_to raise_error
+      expect { get :undocumented_method, format: :json }.not_to raise_error
     end
 
   end
@@ -89,12 +89,12 @@ RSpec.describe PetsController, :type => :controller do
 
   describe "with array field" do
     it "no error for valid response" do
-      response = get :returns_response_with_valid_array, {format: :json}
+      response = get :returns_response_with_valid_array, format: :json
       expect(response).to match_declared_responses
     end
 
     it "error if type of element in the array is wrong" do
-      response = get :returns_response_with_invalid_array, {format: :json}
+      response = get :returns_response_with_invalid_array, format: :json
       expect(response).not_to match_declared_responses
     end
   end

data/spec/spec_helper.rb

@@ -13,7 +13,13 @@ require 'test_engine'
 module Rails4Compatibility
   module Testing
     def process(*args)
-      compatible_request(*args) { |*new_args| super(*new_args) }
+      compatible_request(*args) do |*new_args|
+        if Gem.ruby_version < Gem::Version.new('3.0.0')
+          super(*new_args)
+        else
+          super(new_args[0], **new_args[1])
+        end
+      end
     end
 
     def compatible_request(method, action, hash = {})

data/spec/support/rails-42-ruby-26.rb

@@ -0,0 +1,15 @@
+if RUBY_VERSION >= '2.6.0'
+  if Rails.version < '5'
+    # rubocop:disable Style/CommentAnnotation
+    class ActionController::TestResponse < ActionDispatch::TestResponse
+      def recycle!
+        # hack to avoid MonitorMixin double-initialize error:
+        @mon_mutex_owner_object_id = nil
+        @mon_mutex = nil
+        initialize
+      end
+    end
+    # rubocop:enable Style/CommentAnnotation
+  end
+end
+