apipie-rails-jq 1.4.3.pre.beta.pre.jq.1

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 interactive 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 locally 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 necessary"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Check what is going to be committed"
+   ]
+  },
+  {
+   "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 release 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/rel-eng/packages/.readme

@@ -0,0 +1,3 @@
+the rel-eng/packages directory contains metadata files
+named after their packages. Each file has the latest tagged
+version and the project's relative directory.

data/rel-eng/packages/rubygem-apipie-rails

@@ -0,0 +1 @@
+0.0.7-1 /

data/rel-eng/tito.props

@@ -0,0 +1,5 @@
+[globalconfig]
+default_builder = tito.builder.Builder
+default_tagger = tito.tagger.VersionTagger
+changelog_do_not_remove_cherrypick = 0
+changelog_format = %s (%ae)

data/spec/controllers/api/v1/architectures_controller_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Api::V1::ArchitecturesController do
+  describe "resource description" do
+    subject { Apipie.get_resource_description(Api::V1::ArchitecturesController, "1.0") }
+
+    it "is version 1.0" do
+      expect(subject._version).to eq('1.0')
+
+      expect(Apipie.resource_descriptions['1.0'].size).to eq(2)
+      expect(Apipie.resource_descriptions['1.0'].keys).to include('architectures', 'base')
+    end
+
+    context "there is another version" do
+      let(:v2) { archv2 = Apipie.get_resource_description(Api::V2::ArchitecturesController, "2.0") }
+
+      it "has unique doc url" do
+        expect(subject.doc_url).not_to eq(v2.doc_url)
+      end
+
+      it "has unique methods" do
+        expect(subject._methods.keys).to include(:index)
+        expect(v2._methods.keys).to include(:index)
+        expect(subject._methods[:index]).not_to eq(v2._methods[:index])
+      end
+
+    end
+  end
+end

data/spec/controllers/api/v2/architectures_controller_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Api::V2::ArchitecturesController do
+  let(:resource_description) { Apipie.get_resource_description(described_class, "2.0") }
+
+  describe "resource description" do
+    describe 'version' do
+      subject { resource_description._version }
+
+      it { is_expected.to eq('2.0') }
+    end
+
+    describe 'name' do
+      subject { resource_description.name }
+
+      it { is_expected.to eq('Architectures') }
+    end
+  end
+end

data/spec/controllers/api/v2/empty_middle_controller_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Api::V2::EmptyMiddleController do
+  let(:resource_description) { Apipie.get_resource_description(described_class, '2.0') }
+
+  describe 'resource description' do
+    subject { resource_description }
+
+    context 'when namespaced resources are enabled' do
+      before { Apipie.configuration.namespaced_resources = true }
+      after { Apipie.configuration.namespaced_resources = false }
+
+      # we don't actually expect the resource description to be nil, but resource IDs
+      # are computed at file load time, and altering the value of namespaced_resources
+      # after the fact doesn't change the resource ID, so it can't be found
+      it { is_expected.to be_nil }
+    end
+
+    context 'when namespaced resources are disabled' do
+      it { is_expected.to be_nil }
+    end
+  end
+end

data/spec/controllers/api/v2/nested/resources_controller_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Api::V2::Nested::ResourcesController do
+  let(:resource_description) { Apipie.get_resource_description(described_class, "2.0") }
+
+  describe "resource description" do
+    describe 'version' do
+      subject { resource_description._version }
+
+      it { is_expected.to eq('2.0') }
+    end
+
+    describe 'name' do
+      subject { resource_description.name }
+
+      it { is_expected.to eq('Rsrcs') }
+    end
+  end
+
+  describe '.get_resource_id' do
+    subject { Apipie.get_resource_id(Api::V2::Nested::ResourcesController) }
+
+    it "has resource_id set" do
+      expect(subject).to eq("resource")
+    end
+  end
+end

data/spec/controllers/api/v2/sub/footguns_controller_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Api::V2::Sub::FootgunsController do
+  let(:resource_description) { Apipie.get_resource_description(described_class, '2.0') }
+
+  describe 'resource description' do
+    describe 'version' do
+      subject { resource_description._version }
+
+      it { is_expected.to eq('2.0') }
+    end
+
+    describe 'name' do
+      subject { resource_description.name }
+
+      it { is_expected.to eq('snugtooF') }
+    end
+  end
+end

data/spec/controllers/concerns_controller_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe ConcernsController do
+
+  it "displays is every controller the concern is included" do
+    expect(Apipie["concern_resources#index"]).to be
+    expect(Apipie["concern_resources#show"]).to be
+  end
+
+  it "replies to valid request" do
+    get :show, :params => { :id => '5' }, :session => { :user_id => "secret_hash" }
+    assert_response :success
+  end
+
+  it "passes if required parameter is missing" do
+    expect { get :show, :params => { :id => '5' } }.not_to raise_error
+  end
+
+  it "peserved the order of methods being defined in file" do
+    doc_methods = Apipie.get_resource_description('concern_resources')._methods.keys
+    expect(doc_methods).to eq([:index, :show, :create, :update, :custom])
+  end
+
+  it "replaces a placeholder doc specified in concern with a real path" do
+    path = Apipie["concern_resources#index"].apis.first.path
+    expect(path).to eq('/api/concerns')
+
+    path = Apipie["concern_resources#show"].apis.first.path
+    expect(path).to eq('/concern_resources/:id')
+
+    path = Apipie["concern_resources#custom"].apis.first.path
+    expect(path).to eq('/concern_resources/custom')
+  end
+
+  it "replaces placeholders in param names and descriptions" do
+    create_desc = Apipie["concern_resources#create"].params[:user]
+    name_param, concern_type_param = create_desc.validator.params_ordered
+    expect(name_param.desc).to include "Name of a user"
+    expect(concern_type_param.name).to eq(:user_type)
+  end
+end
+

data/spec/controllers/extended_controller_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe ExtendedController do
+
+  it 'includes params from both original controller and extending concern' do
+    expect(Apipie["extended#create"].params.keys).to eq [:oauth, :user, :admin]
+    user_param = Apipie["extended#create"].params[:user]
+    expect(user_param.validator.params_ordered.map(&:name)).to eq [:name, :password, :from_concern]
+  end
+
+  it 'includes updated metadata' do
+    expect(Apipie['extended#create'].metadata).to eq metadata: 'data'
+  end
+end

data/spec/controllers/included_param_group_controller_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+
+describe IncludedParamGroupController do
+
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  it "does not error when there is a param_group that is deeply nested in response description" do
+    subject = Apipie.get_resource_description(IncludedParamGroupController, Apipie.configuration.default_version)
+    expect(subject._methods.keys).to include(:show)
+  end
+
+end