apipie-rails 0.3.6 → 0.9.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 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

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'fileutils'
+require "json-schema"
 
 describe Apipie::ApipiesController do
 
@@ -12,37 +13,62 @@ describe Apipie::ApipiesController do
     end
 
     it "succeeds on version details" do
-      get :index, :version => "2.0"
+      get :index, :params => { :version => "2.0" }
 
       assert_response :success
     end
 
     it "returns not_found on wrong version" do
-      get :index, :version => "wrong_version"
+      get :index, :params => { :version => "wrong_version" }
 
       assert_response :not_found
     end
 
     it "succeeds on resource details" do
-      get :index, :version => "2.0", :resource => "architectures"
+      get :index, :params => { :version => "2.0", :resource => "architectures" }
 
       assert_response :success
     end
 
     it "returns not_found on wrong resource" do
-      get :index, :version => "2.0", :resource => "wrong_resource"
+      get :index, :params => { :version => "2.0", :resource => "wrong_resource" }
 
       assert_response :not_found
     end
 
     it "succeeds on method details" do
-      get :index, :version => "2.0", :resource => "architectures", :method => "index"
+      get :index, :params => { :version => "2.0", :resource => "architectures", :method => "index" }
 
       assert_response :success
     end
 
     it "returns not_found on wrong method" do
-      get :index, :version => "2.0", :resource => "architectures", :method => "wrong_method"
+      get :index, :params => { :version => "2.0", :resource => "architectures", :method => "wrong_method" }
+
+      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
@@ -130,6 +156,38 @@ describe Apipie::ApipiesController do
     end
   end
 
+  describe "GET index as swagger" do
+
+    let(:swagger_schema) do
+      File.read(File.join(File.dirname(__FILE__),"../lib/swagger/openapi_2_0_schema.json"))
+    end
+
+    it "outputs swagger when format is json and type is swagger" do
+      get :index, :params => { :format => "json", :type => "swagger"}
+
+      assert_response :success
+      expect(response.body).to match(/"swagger":"2.0"/)
+      # puts response.body
+
+      expect(JSON::Validator.validate(swagger_schema, response.body)).to be_truthy
+    end
+
+    it "does not output swagger when format is not json even if type is swagger" do
+      get :index, :params => { :type => "swagger"}
+
+      assert_response :success
+      expect(response.body).not_to match(/"swagger":"2.0"/)
+    end
+
+    it "does not output swagger when format is json even but type is not swagger" do
+      get :index, :params => { :format => "json"}
+
+      assert_response :success
+      expect(response.body).not_to match(/"swagger":"2.0"/)
+    end
+  end
+
+
   describe "authenticate user" do
     it "authenticate user if an authentication method is setted" do
       test = false
@@ -183,6 +241,11 @@ describe Apipie::ApipiesController do
       expect(assigns(:doc)[:resources]["users"][:methods].size).to eq(users_methods - 1)
       expect(assigns(:doc)[:resources]["twitter_example"][:methods].size).to eq(twitter_example_methods)
     end
+    it "does not allow access to swagger when authorization is set" do
+      get :index, :params => { :format => "json", :type => "swagger"}
+
+      assert_response :forbidden
+    end
   end
 
   describe "documentation cache" do
@@ -190,7 +253,7 @@ describe Apipie::ApipiesController do
     let(:cache_dir) { File.join(Rails.root, "tmp", "apipie-cache") }
 
     before do
-      FileUtils.rm_r(cache_dir) if File.exists?(cache_dir)
+      FileUtils.rm_r(cache_dir) if File.exist?(cache_dir)
       FileUtils.mkdir_p(File.join(cache_dir, "apidoc", "v1", "resource"))
       File.open(File.join(cache_dir, "apidoc", "v1.html"), "w") { |f| f << "apidoc.html cache v1" }
       File.open(File.join(cache_dir, "apidoc", "v2.html"), "w") { |f| f << "apidoc.html cache v2" }
@@ -209,25 +272,27 @@ describe Apipie::ApipiesController do
       Apipie.configuration.use_cache = false
       Apipie.configuration.default_version = @orig_version
       Apipie.configuration.cache_dir = @orig_cache_dir
-      # FileUtils.rm_r(cache_dir) if File.exists?(cache_dir)
+      # FileUtils.rm_r(cache_dir) if File.exist?(cache_dir)
     end
 
     it "uses the file in cache dir instead of generating the content on runtime" do
       get :index
       expect(response.body).to eq("apidoc.html cache v1")
-      get :index, :version => 'v1'
+      get :index, :params => { :version => 'v1' }
       expect(response.body).to eq("apidoc.html cache v1")
-      get :index, :version => 'v2'
+      get :index, :params => { :version => 'v2' }
       expect(response.body).to eq("apidoc.html cache v2")
-      get :index, :version => 'v1', :format => "html"
+      get :index, :params => { :version => 'v1', :format => "html" }
       expect(response.body).to eq("apidoc.html cache v1")
-      get :index, :version => 'v1', :format => "json"
+      get :index, :params => { :version => 'v1', :format => "json" }
       expect(response.body).to eq("apidoc.json cache")
-      get :index, :version => 'v1', :format => "html", :resource => "resource"
+      get :index, :params => { :version => 'v1', :format => "html", :resource => "resource" }
       expect(response.body).to eq("resource.html cache")
-      get :index, :version => 'v1', :format => "html", :resource => "resource", :method => "method"
+      get :index, :params => { :version => 'v1', :format => "html", :resource => "resource", :method => "method" }
       expect(response.body).to eq("method.html cache")
     end
 
   end
+
+
 end

data/spec/controllers/concerns_controller_spec.rb

@@ -8,12 +8,12 @@ describe ConcernsController do
   end
 
   it "should reply to valid request" do
-    get :show, :id => '5', :session => "secret_hash"
+    get :show, :params => { :id => '5' }, :session => { :user_id => "secret_hash" }
     assert_response :success
   end
 
   it "should pass if required parameter is missing" do
-    expect { get :show, :id => '5' }.not_to raise_error
+    expect { get :show, :params => { :id => '5' } }.not_to raise_error
   end
 
   it "peserved the order of methods being defined in file" do

data/spec/controllers/extended_controller_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe ExtendedController do
+
+  it 'should include 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 'should include 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 "should 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

data/spec/controllers/memes_controller_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe TestEngine::MemesController do
+
+  describe "#index" do
+    it "should have the full mounted path of engine" do
+      Apipie.routes_for_action(TestEngine::MemesController, :index, {}).first[:path].should eq("/test/memes")
+    end
+  end
+end