workarea-api-admin 4.4.7 → 4.5.0

data/app/controllers/workarea/api/admin/redirects_controller.rb

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Redirects'
               schema do
@@ -97,6 +102,8 @@ module Workarea
         def index
           @redirects = Navigation::Redirect
                         .all
+                        .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                        .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                         .order_by(sort_field => sort_direction)
                         .page(params[:page])
 

data/app/controllers/workarea/api/admin/releases_controller.rb

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Releases'
               schema do
@@ -97,6 +102,8 @@ module Workarea
         def index
           @releases = Release
                         .all
+                        .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                        .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                         .order_by(sort_field => sort_direction)
                         .page(params[:page])
           respond_with releases: @releases

data/app/controllers/workarea/api/admin/shipping_services_controller.rb

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Shipping services'
               schema do
@@ -97,6 +102,8 @@ module Workarea
         def index
           @shipping_services = Shipping::Service
                                 .all
+                                .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                                .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                                 .order_by(sort_field => sort_direction)
                                 .page(params[:page])
 

data/app/controllers/workarea/api/admin/shippings_controller.rb

@@ -34,6 +34,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Shippings'
               schema do
@@ -52,6 +57,8 @@ module Workarea
         def index
           @shippings = Shipping
                           .all
+                          .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                          .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                           .order_by(sort_field => sort_direction)
                           .page(params[:page])
 

data/app/controllers/workarea/api/admin/swagger_controller.rb

@@ -25,6 +25,39 @@ module Workarea
             key :consumes, ['application/json']
             key :produces, ['application/json']
 
+            # define update_at params for re-use later
+            parameter :updated_at_starts_at do
+              key :name, :updated_at_starts_at
+              key :in, :query
+              key :description, 'Starting datetime for filtering on last updated'
+              key :type, :string
+              key :format, 'date-time'
+            end
+
+            parameter :updated_at_ends_at do
+              key :name, :updated_at_ends_at
+              key :in, :query
+              key :description, 'Ending datetime for filtering on last updated'
+              key :type, :string
+              key :format, 'date-time'
+            end
+
+            parameter :created_at_starts_at do
+              key :name, :created_at_starts_at
+              key :in, :query
+              key :description, 'Starting datetime for filtering on creation date'
+              key :type, :string
+              key :format, 'date-time'
+            end
+
+            parameter :created_at_ends_at do
+              key :name, :created_at_ends_at
+              key :in, :query
+              key :description, 'Ending datetime for filtering on creation date'
+              key :type, :string
+              key :format, 'date-time'
+            end
+
             security_definition :BasicAuth do
               key :type, :basic
             end

data/app/controllers/workarea/api/admin/tax_categories_controller.rb

@@ -72,6 +72,8 @@ module Workarea
         def index
           @tax_categories = Tax::Category
                                 .all
+                                .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                                .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                                 .order_by(sort_field => sort_direction)
                                 .page(params[:page])
 

data/app/controllers/workarea/api/admin/users_controller.rb

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'User'
               schema do
@@ -94,12 +99,19 @@ module Workarea
           end
         end
 
-
         def index
-          @users = User
-                      .all
-                      .order_by(sort_field => sort_direction)
-                      .page(params[:page])
+          criteria = User.all
+
+          if params[:email].present?
+            criteria = criteria.where(email: params[:email])
+          end
+
+          @users =
+            criteria
+            .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+            .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
+            .order_by(sort_field => sort_direction)
+            .page(params[:page].presence || 1)
 
           respond_with users: @users.to_a.map { |u| api_attributes_for(u) }
         end
@@ -113,17 +125,17 @@ module Workarea
           )
         end
 
-        swagger_path '/users/{id}' do
+        swagger_path '/users/{id_or_email}' do
           operation :get do
-            key :summary, 'Show User by ID'
-            key :description, 'Returns a user by ID'
+            key :summary, 'Show User by ID or Email'
+            key :description, 'Returns a user by ID or email address'
             key :operationId, 'showUser'
             key :produces, ['application/json']
 
             parameter do
-              key :name, :id
+              key :name, :id_or_email
               key :in, :path
-              key :description, 'user ID'
+              key :description, 'user ID or URL escaped email address'
               key :required, true
               key :type, :string
             end
@@ -145,9 +157,9 @@ module Workarea
             key :operationId, 'updateUser'
 
             parameter do
-              key :name, :id
+              key :name, :id_or_email
               key :in, :path
-              key :description, 'ID of user to update'
+              key :description, 'ID or email address of user to update'
               key :required, true
               key :type, :string
             end
@@ -203,9 +215,9 @@ module Workarea
             key :operationId, 'removeUser'
 
             parameter do
-              key :name, :id
+              key :name, :id_or_email
               key :in, :path
-              key :description, 'ID of user to remove'
+              key :description, 'ID or email address of user to remove'
               key :required, true
               key :type, :string
             end
@@ -285,6 +297,8 @@ module Workarea
 
         def find_user
           @user = User.find(params[:id])
+        rescue Mongoid::Errors::DocumentNotFound
+          @user = User.find_by(email:  URI.unescape(params[:id]))
         end
 
         def api_attributes_for(user)

data/app/models/workarea/api/admin/date_filtering.rb

@@ -0,0 +1,27 @@
+module Workarea
+  module Api
+    module Admin
+      module DateFiltering
+        extend ActiveSupport::Concern
+        included do
+          index({ updated_at: 1 })
+          index({ created_at: 1 })
+
+          scope :by_updated_at, ->(starts_at:, ends_at:) do
+            query = criteria
+            query = query.where(:updated_at.gte => starts_at) unless starts_at.nil?
+            query = query.where(:updated_at.lte => ends_at) unless ends_at.nil?
+            query
+          end
+
+          scope :by_created_at, ->(starts_at:, ends_at:) do
+            query = criteria
+            query = query.where(:created_at.gte => starts_at) unless starts_at.nil?
+            query = query.where(:created_at.lte => ends_at) unless ends_at.nil?
+            query
+          end
+        end
+      end
+    end
+  end
+end

data/lib/workarea/api/admin/engine.rb

@@ -5,9 +5,20 @@ module Workarea
         include Workarea::Plugin
         isolate_namespace Workarea::Api::Admin
 
+        # Depending on plugin loading order, to_prepare may cause an autoload of
+        # {ApplicationDocument}s so make sure we add this dependency before
+        # `config.to_prepare`
+        initializer 'workarea.api.admin.date_filtering' do
+          Workarea::ApplicationDocument.include(DateFiltering)
+        end
+
         config.after_initialize do
           Workarea::Api::Admin::Swagger.generate!
         end
+
+        config.to_prepare do
+          ApplicationDocument.include(DateFiltering)
+        end
       end
     end
   end

data/test/documentation/workarea/api/admin/email_signups_documentation_test.rb

@@ -26,8 +26,8 @@ module Workarea
           end
         end
 
-        def test_and_document_show
-          description 'Showing an email signup'
+        def test_and_document_show_by_id
+          description 'Showing an email signup by ID'
           route admin_api.email_signup_path(':id')
 
           record_request do
@@ -35,6 +35,18 @@ module Workarea
             assert_equal(200, response.status)
           end
         end
+
+        def test_and_document_show_by_email
+          description 'Showing an email signup by email'
+          route admin_api.email_signup_path(':email')
+
+          signup = create_email_signup(email: 'test@workarea.com')
+
+          record_request do
+            get admin_api.email_signup_path(URI.escape(signup.email, '+@.'))
+            assert_equal(200, response.status)
+          end
+        end
       end
     end
   end

data/test/documentation/workarea/api/admin/global_functionality_documentation_test.rb

@@ -0,0 +1,140 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class GlobalFunctionalityDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Global Functionality'
+
+        def test_and_document_locale
+          description 'Dealing with locales'
+          route admin_api.products_path
+          parameter :locale, 'I18n locale key'
+
+          set_locales(available: [:en, :es], default: :en)
+          create_product(name_translations: {
+              en: 'Test Product',
+              es: 'Producto de prueba'
+            }
+          )
+
+          record_request do
+            get admin_api.products_path,
+              params: {
+                locale: 'en'
+              }
+
+            assert_equal(200, response.status)
+          end
+
+          record_request do
+            get admin_api.products_path,
+              params: {
+                locale: 'es'
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_filtered_by_updated_at
+          description 'Filtering by updated time stamp'
+          route admin_api.products_path
+          parameter :updated_at_starts_at, 'Start of a last updated at date range'
+          parameter :updated_at_ends_at, 'End of a last updated at date range'
+
+          2.times { create_product }
+
+          record_request do
+            get admin_api.products_path,
+                  params: {
+                    updated_at_starts_at: 1.day.ago,
+                    updated_at_ends_at: 1.day.from_now
+                  }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_filtered_by_created_at
+          description 'Filtering by created at time stamp'
+          route admin_api.products_path
+
+          parameter :created_at_starts_at, 'Start of a created at date range'
+          parameter :created_at_ends_at, 'End of a created at date range'
+
+
+          2.times { create_product }
+
+          record_request do
+            get admin_api.products_path,
+                  params: {
+                    created_at_starts_at: 1.day.ago,
+                    created_at_ends_at: 1.day.from_now
+                  }
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_sorting
+          description 'Sorting results'
+          route admin_api.products_path
+
+          parameter :sort_by, 'Field on which to sort (see responses for possible values)'
+          parameter :sort_direction, 'Direction to sort (asc or desc)'
+
+          2.times { create_product }
+
+          record_request do
+            get admin_api.products_path,
+                  params: {
+                    sort_by: 'created_at',
+                    sort_direction: 'desc',
+                  }
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_pagination
+          description 'Paging results'
+          route admin_api.products_path
+
+          parameter :page, 'Current page'
+
+          2.times { create_product }
+
+          record_request do
+            get admin_api.products_path,
+                  params: {
+                    page: 1
+                  }
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_additional_pages
+          description 'Retrieving addtional pages of results'
+          route admin_api.products_path
+
+          parameter :page, 'Current page'
+
+          Workarea.with_config do |config|
+            config.per_page = 2
+
+            3.times { create_product }
+            record_request do
+              get admin_api.products_path,
+                    params: {
+                      page: 2
+                    }
+              assert_equal(200, response.status)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/documentation/workarea/api/admin/orders_documentation_test.rb

@@ -34,17 +34,24 @@ module Workarea
           parameter :sort_direction, 'Direction to sort (asc or desc)'
           parameter :placed_at_greater_than, 'Start of a placed_at date range'
           parameter :placed_at_less_than, 'End of a placed_at date range'
+          parameter :email, 'Email address on the order'
 
           3.times { |i| create_placed_order(id: 1000 + i, placed_at: i.weeks.ago) }
 
+          create_placed_order(email: 'test@workarea.com', id: 10000, placed_at: 0.weeks.ago)
+          create_placed_order(email: 'test@workarea.com', id: 10001, placed_at: 1.weeks.ago)
+          create_placed_order(email: 'test@workarea.com', id: 10002, placed_at: 2.weeks.ago)
+
           record_request do
             get admin_api.orders_path,
-                  params:
-                    { page: 1,
-                      sort_by: 'created_at',
-                      sort_direction: 'desc',
-                      placed_at_greater_than: 2.weeks.ago - 1.day,
-                      placed_at_less_than: 2.weeks.ago + 1.day }
+                  params: {
+                    page: 1,
+                    sort_by: 'created_at',
+                    sort_direction: 'desc',
+                    placed_at_greater_than: 2.weeks.ago - 1.day,
+                    placed_at_less_than: 2.weeks.ago + 1.day,
+                    email: 'test@workarea.com'
+                  }
 
             assert_equal(200, response.status)
           end