weak_parameters 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a10d28d1fedc2265c21778bc396a9290d873634
-  data.tar.gz: 10443cf7641573095ca36b799a09bb460740b428
+  metadata.gz: cc43dbf15b3f5fe477fe58c0788a80aa036317f5
+  data.tar.gz: d6a24136ebea5ade178a61d4555e376128d95432
 SHA512:
-  metadata.gz: f63c30ce3c389a79648fc265591e0976fd2f3d45b6568f190fff16068f3b0c26ad3edca2fcbea87f2ea7ccd6de97a4e27ea436f06d07b97c9b7dd9f8e8eb9ef1
-  data.tar.gz: 58530920dd4a349f99f19683551bab09b9a8a5a58b247317a7e785e7df1774b97edc2edb83735cdbbeffa5395d486121ac83e61e37dddd62446941a4682f4b86
+  metadata.gz: 7b716fa12192074d863010d6b25369e1d00ec03571ae7e4872f40bba877373f1964f670790518f51a640ccac0bb742e53206625a77f9ea0a639de67b49a7452c
+  data.tar.gz: 6f8a71f1741499f9f0acde74dc8f0ea6a1fbb673679beaf8101c7a314f674d5c90f87a3731b83bd37994994d936d8d5bc85b623d2f0d61ed88d4b505dc862f3d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.4.1
+- Support rails-api
+
 ## 0.4.0
 - Support Rails 5
 

data/lib/weak_parameters.rb

@@ -57,6 +57,7 @@ module WeakParameters
     initializer 'weak_parameters' do
       ActiveSupport.on_load :action_controller do
         ActionController::Base.extend WeakParameters::Controller
+        ActionController::API.extend WeakParameters::Controller if Object.const_defined?('ActionController::API')
       end
     end
   end

data/lib/weak_parameters/version.rb

@@ -1,3 +1,3 @@
 module WeakParameters
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/spec/dummy/app/controllers/api/recipes_controller.rb

@@ -0,0 +1,5 @@
+module API
+  class RecipesController < APIController
+    include WithRecipe
+  end
+end

data/spec/dummy/app/controllers/api/strongs_controller.rb

@@ -0,0 +1,5 @@
+module API
+  class StrongsController < APIController
+    include WithStrong
+  end
+end

data/spec/dummy/app/controllers/api_controller.rb

@@ -0,0 +1,5 @@
+class APIController < ActionController::API
+  rescue_from WeakParameters::ValidationError do
+    head 400
+  end
+end

data/spec/dummy/app/controllers/concerns/with_recipe.rb

@@ -0,0 +1,47 @@
+module WithRecipe
+  extend ActiveSupport::Concern
+
+  included do
+    validates :create do
+      any :object
+      string :name, required: true, except: %w[invalid wrong]
+      integer :type, only: 0..3
+      integer :number, only: [0, 1]
+      boolean :flag
+      hash :config
+      array :tags
+      float :rate
+      file :attachment
+      integer :custom, only: 0..1, handler: :render_error
+      string :zip_code do |value|
+        zip_pattern(value)
+      end
+      object :nested, required: true do
+        integer :number, only: [0, 1]
+      end
+
+      list :numbers, :integer, description: 'some numbers'
+
+      object :body do
+        list :items, :object, description: 'some items' do
+          string :name
+          integer :price
+        end
+      end
+    end
+  end
+
+  def create
+    head 201
+  end
+
+  private
+
+  def render_error
+    head 403
+  end
+
+  def zip_pattern(value)
+    value =~ /\A\d{3}-\d{4}\z/
+  end
+end

data/spec/dummy/app/controllers/concerns/with_strong.rb

@@ -0,0 +1,61 @@
+module WithStrong
+  extend ActiveSupport::Concern
+
+  included do
+    validates :create do
+      any :object
+      any :strong_object, strong: true
+      string :name, required: true, except: %w[invalid wrong]
+      string :strong_name, required: true, strong: true, except: %w[invalid wrong]
+      integer :type, only: 0..3
+      integer :strong_type, strong: true, only: 0..3
+      integer :number, only: [0, 1]
+      integer :strong_number, strong: true, only: [0, 1]
+      boolean :flag
+      boolean :strong_flag, strong: true
+      hash :config
+      hash :strong_config, strong: true
+      array :tags
+      array :strong_tags, strong: true
+      float :rate
+      float :strong_rate, strong: true
+      file :attachment
+      file :strong_attachment, strong: true
+      integer :custom, only: 0..1, handler: :render_error
+      integer :strong_custom, strong: true, only: 0..1, handler: :render_error
+      string :zip_code do |value|
+        value =~ /\A\d{3}-\d{4}\z/
+      end
+      string :strong_zip_code, strong: true do |value|
+        value =~ /\A\d{3}-\d{4}\z/
+      end
+      object :nested, required: true do
+        integer :number, only: [0, 1]
+      end
+      object :strong_nested, required: true do
+        integer :strong_number, strong: true, only: [0, 1]
+      end
+
+      list :numbers, :integer, description: 'some numbers'
+
+      list :strong_numbers, :integer, strong: true, description: 'some numbers'
+
+      object :strong_body do
+        list :items, :object, description: 'some items' do
+          string :name
+          integer :strong_price, strong: true
+        end
+      end
+    end
+  end
+
+  def create
+    head 201
+  end
+
+  private
+
+  def render_error
+    head 403
+  end
+end

data/spec/dummy/app/controllers/recipes_controller.rb

@@ -1,43 +1,3 @@
 class RecipesController < ApplicationController
-  validates :create do
-    any :object
-    string :name, required: true, except: %w[invalid wrong]
-    integer :type, only: 0..3
-    integer :number, only: [0, 1]
-    boolean :flag
-    hash :config
-    array :tags
-    float :rate
-    file :attachment
-    integer :custom, only: 0..1, handler: :render_error
-    string :zip_code do |value|
-      zip_pattern(value)
-    end
-    object :nested, required: true do
-      integer :number, only: [0, 1]
-    end
-
-    list :numbers, :integer, description: 'some numbers'
-
-    object :body do
-      list :items, :object, description: 'some items' do
-        string :name
-        integer :price
-      end
-    end
-  end
-
-  def create
-    head 201
-  end
-
-  private
-
-  def render_error
-    head 403
-  end
-
-  def zip_pattern(value)
-    value =~ /\A\d{3}-\d{4}\z/
-  end
+  include WithRecipe
 end

data/spec/dummy/app/controllers/strongs_controller.rb

@@ -1,57 +1,3 @@
 class StrongsController < ApplicationController
-  validates :create do
-    any :object
-    any :strong_object, strong: true
-    string :name, required: true, except: %w[invalid wrong]
-    string :strong_name, required: true, strong: true, except: %w[invalid wrong]
-    integer :type, only: 0..3
-    integer :strong_type, strong: true, only: 0..3
-    integer :number, only: [0, 1]
-    integer :strong_number, strong: true, only: [0, 1]
-    boolean :flag
-    boolean :strong_flag, strong: true
-    hash :config
-    hash :strong_config, strong: true
-    array :tags
-    array :strong_tags, strong: true
-    float :rate
-    float :strong_rate, strong: true
-    file :attachment
-    file :strong_attachment, strong: true
-    integer :custom, only: 0..1, handler: :render_error
-    integer :strong_custom, strong: true, only: 0..1, handler: :render_error
-    string :zip_code do |value|
-      value =~ /\A\d{3}-\d{4}\z/
-    end
-    string :strong_zip_code, strong: true do |value|
-      value =~ /\A\d{3}-\d{4}\z/
-    end
-    object :nested, required: true do
-      integer :number, only: [0, 1]
-    end
-    object :strong_nested, required: true do
-      integer :strong_number, strong: true, only: [0, 1]
-    end
-
-    list :numbers, :integer, description: 'some numbers'
-
-    list :strong_numbers, :integer, strong: true, description: 'some numbers'
-
-    object :strong_body do
-      list :items, :object, description: 'some items' do
-        string :name
-        integer :strong_price, strong: true
-      end
-    end
-  end
-
-  def create
-    head 201
-  end
-
-  private
-
-  def render_error
-    head 403
-  end
+  include WithStrong
 end

data/spec/dummy/config/routes.rb

@@ -1,4 +1,9 @@
 Dummy::Application.routes.draw do
   resources :recipes, only: :create
   resources :strongs, only: :create
+
+  scope :api do
+    resources :recipes, only: :create
+    resources :strongs, only: :create
+  end
 end

data/spec/requests/api/recipes_spec.rb

@@ -0,0 +1,188 @@
+require "spec_helper"
+
+describe "Recipes with rails-api", type: :request do
+  let(:params) do
+    {
+      object: [],
+      name: "name",
+      number: 0,
+      type: 1,
+      flag: true,
+      config: {},
+      tags: [],
+      attachment: Rack::Test::UploadedFile.new(__FILE__),
+      zip_code: "123-4567",
+      custom: 0,
+      nested: {
+        number: 0
+      },
+      numbers: [1, 2, 3],
+      body: {
+        items: [
+          { name: "foo", price: 100 },
+          { name: "bar", price: 100 }
+        ]
+      }
+    }
+  end
+
+  shared_examples_for "400" do
+    it "returns 400" do
+      post "/api/recipes", params: params
+      expect(response.status).to eq(400)
+    end
+  end
+
+  shared_examples_for "201" do
+    it "creates a new recipe" do
+      post "/api/recipes", params: params
+      expect(response.status).to eq(201)
+    end
+  end
+
+  describe "POST /api/recipes" do
+    context "without required param" do
+      before do
+        params.delete(:name)
+      end
+      include_examples "400"
+    end
+
+    context "with wrong string param" do
+      before do
+        params[:name] = ["x"]
+      end
+      include_examples "400"
+    end
+
+    context "with wrong integer param" do
+      before do
+        params[:type] = "x"
+      end
+      include_examples "400"
+    end
+
+    context "with exceptional interger param" do
+      before do
+        params[:number] = [1]
+      end
+      include_examples "400"
+    end
+
+    context "with wrong boolean param" do
+      before do
+        params[:flag] = "x"
+      end
+      include_examples "400"
+    end
+
+    context "with wrong array param" do
+      before do
+        params[:tags] = "x"
+      end
+      include_examples "400"
+    end
+
+    context "with wrong hash param" do
+      before do
+        params[:config] = "x"
+      end
+      include_examples "400"
+    end
+
+    context "with wrong float param" do
+      before do
+        params[:rate] = "-x"
+      end
+      include_examples "400"
+    end
+
+    context "with wrong file param" do
+      before do
+        params[:attachment] = "x"
+      end
+      include_examples "400"
+    end
+
+    context "with block failure" do
+      before do
+        params[:zip_code] = "123-456"
+      end
+      include_examples "400"
+    end
+
+    context "with invalid param to :only condition" do
+      before do
+        params[:type] = 4
+      end
+      include_examples "400"
+    end
+
+    context "with invalid param to :except condition" do
+      before do
+        params[:name] = "invalid"
+      end
+      include_examples "400"
+    end
+
+    context "without non-required param" do
+      before do
+        params.delete(:type)
+      end
+      include_examples "201"
+    end
+
+    context "with valid condition", :autodoc do
+      include_examples "201"
+    end
+
+    context "with custom handler option" do
+      before do
+        params[:custom] = "invalid"
+      end
+      it "delegates to specified method" do
+        post "/recipes", params: params
+        expect(response.status).to eq(403)
+      end
+    end
+
+    context "with wrong nested params" do
+      before do
+        params[:nested][:number] = true
+      end
+      include_examples "400"
+    end
+
+    context "with wrong repeated params" do
+      describe 'scalar' do
+        before do
+          params[:numbers] = 1
+        end
+        include_examples "400"
+      end
+
+      describe 'wrong type' do
+        before do
+          params[:numbers] = ["foo"]
+        end
+        include_examples "400"
+      end
+    end
+
+    context "with complex params" do
+      describe 'invalid parameter' do
+        before do
+          params[:body][:items] << { price: "xxx" }
+        end
+        include_examples "400"
+      end
+
+      describe 'missing parameter' do
+        before do
+          params.delete :body
+        end
+        include_examples "201"
+      end
+    end
+  end
+end

data/spec/requests/api/strong_spec.rb

@@ -0,0 +1,100 @@
+require "spec_helper"
+
+describe "Strong with rails-api", type: :request do
+  let(:params) do
+    {
+      object: [1],
+      strong_object: [1],
+      name: "name",
+      strong_name: "name",
+      number: 0,
+      strong_number: 0,
+      type: 1,
+      strong_type: 1,
+      flag: true,
+      strong_flag: true,
+      config: { a: 1 },
+      strong_config: { a: 1, b: { c: 2 } },
+      tags: [1],
+      strong_tags: [1],
+      attachment: Rack::Test::UploadedFile.new(__FILE__),
+      strong_attachment: Rack::Test::UploadedFile.new(__FILE__),
+      zip_code: "123-4567",
+      strong_zip_code: "123-4567",
+      custom: 0,
+      strong_custom: 0,
+      nested: {
+        number: 0
+      },
+      strong_nested: {
+        strong_number: 0
+      },
+      numbers: [1, 2, 3],
+      strong_numbers: [1, 2, 3],
+      body: {
+        items: [
+          { name: "foo", price: 100 },
+          { name: "bar", price: 100 }
+        ]
+      },
+      strong_body: {
+        items: [
+          { name: "foo", strong_price: 100 },
+          { name: "bar", strong_price: 100 }
+        ]
+      }
+    }
+  end
+
+  describe "#permitted_params" do
+    it "returns permitted_params" do
+      post "/api/strongs", params: params
+      expect(controller.permitted_params).to have_key "strong_object"
+      expect(controller.permitted_params).not_to have_key "object"
+
+      expect(controller.permitted_params).to have_key "strong_name"
+      expect(controller.permitted_params).not_to have_key "name"
+
+      expect(controller.permitted_params).to have_key "strong_number"
+      expect(controller.permitted_params).not_to have_key "number"
+
+      expect(controller.permitted_params).to have_key "strong_type"
+      expect(controller.permitted_params).not_to have_key "type"
+
+      expect(controller.permitted_params).to have_key "strong_flag"
+      expect(controller.permitted_params).not_to have_key "flag"
+
+      expect(controller.permitted_params).to have_key "strong_config"
+      expect(controller.permitted_params).not_to have_key "config"
+
+      expect(controller.permitted_params).to have_key "strong_tags"
+      expect(controller.permitted_params).not_to have_key "tags"
+
+      expect(controller.permitted_params).not_to have_key "strong_rate"
+      expect(controller.permitted_params).not_to have_key "rate"
+
+      expect(controller.permitted_params).to have_key "strong_attachment"
+      expect(controller.permitted_params).not_to have_key "attachment"
+
+      expect(controller.permitted_params).to have_key "strong_zip_code"
+      expect(controller.permitted_params).not_to have_key "zip_code"
+
+      expect(controller.permitted_params).to have_key "strong_custom"
+      expect(controller.permitted_params).not_to have_key "custom"
+
+      expect(controller.permitted_params).to have_key "strong_nested"
+      expect(controller.permitted_params).not_to have_key "nested"
+
+      expect(controller.permitted_params).to have_key "strong_numbers"
+      expect(controller.permitted_params).not_to have_key "numbers"
+
+      expect(controller.permitted_params).to have_key "strong_body"
+      expect(controller.permitted_params).not_to have_key "body"
+
+      expect(controller.permitted_params[:strong_body]).to have_key "items"
+
+      expect(controller.permitted_params[:strong_body][:items].first).to have_key "strong_price"
+      expect(controller.permitted_params[:strong_body][:items].first).not_to have_key "name"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weak_parameters
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-02 00:00:00.000000000 Z
+date: 2016-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -155,7 +155,12 @@ files:
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/api/recipes_controller.rb
+- spec/dummy/app/controllers/api/strongs_controller.rb
+- spec/dummy/app/controllers/api_controller.rb
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/with_recipe.rb
+- spec/dummy/app/controllers/concerns/with_strong.rb
 - spec/dummy/app/controllers/recipes_controller.rb
 - spec/dummy/app/controllers/strongs_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
@@ -188,6 +193,8 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/requests/api/recipes_spec.rb
+- spec/requests/api/strong_spec.rb
 - spec/requests/recipes_spec.rb
 - spec/requests/strong_spec.rb
 - spec/spec_helper.rb
@@ -220,7 +227,12 @@ test_files:
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/api/recipes_controller.rb
+- spec/dummy/app/controllers/api/strongs_controller.rb
+- spec/dummy/app/controllers/api_controller.rb
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/with_recipe.rb
+- spec/dummy/app/controllers/concerns/with_strong.rb
 - spec/dummy/app/controllers/recipes_controller.rb
 - spec/dummy/app/controllers/strongs_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
@@ -253,6 +265,8 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/requests/api/recipes_spec.rb
+- spec/requests/api/strong_spec.rb
 - spec/requests/recipes_spec.rb
 - spec/requests/strong_spec.rb
 - spec/spec_helper.rb