apill 2.9.0 → 3.0.0

data/spec/apill/middleware/api_request_spec.rb

@@ -3,15 +3,18 @@ require 'apill/middleware/api_request'
 
 module    Apill
 module    Middleware
-describe  ApiRequest do
+describe  ApiRequest, singletons: HumanError::Configuration do
   let(:app) { ->(_env) { [200, {}, 'response'] } }
 
   before(:each) do
-    HumanError.configure do |config|
-      config.api_error_documentation_url = 'http://error.com'
-      config.knowledgebase_url           = 'http://knowledge.com'
-      config.api_version                 = '1'
-    end
+    HumanError.configuration.url_mappings = {
+      'external_documentation_urls'  => {
+        'errors.invalid_subdomain_response' => 'http://example.com/foo',
+      },
+      'developer_documentation_urls' => {
+        'errors.invalid_subdomain_response' => 'http://example.com/foo',
+      },
+    }
 
     Apill.configure do |config|
       config.allowed_subdomains     = %w{api matrix}
@@ -47,30 +50,25 @@ describe  ApiRequest do
 
     status, headers, response = api_request_middleware.call(request)
 
-    expect(status).to   eql 404
-    expect(headers).to  eql({})
-    expect(response).to eql(
-      [
-        '{' \
-          '"error":' \
-          '{' \
-            '"status":404,' \
-            '"code":1010,' \
-            '"developer_documentation_uri":"http://error.com/1010?version=1",' \
-            '"customer_support_uri":"http://knowledge.com/1234567890",' \
-            '"developer_message_key":"errors.invalid.subdomain.error.developer",' \
-            '"developer_message":"The resource you attempted to access is either not ' \
-                                 'authorized for the authenticated user or does not ' \
-                                 'exist.",' \
-            '"developer_details":' \
-              '{' \
-                '"http_host":"notvalid.example.com"' \
-              '},' \
-            '"friendly_message_key":"errors.invalid.subdomain.error.friendly",' \
-            '"friendly_message":"Sorry! The resource you tried to access does not ' \
-                                'exist."' \
-          '}' \
-        '}',
+    expect(status).to                 eql 404
+    expect(headers).to                eql({})
+    expect(JSON.load(response[0])).to include(
+      'errors' => [
+        {
+          'id'     => match(/[a-z0-9\-]+/),
+          'links'  => {
+            'about'         => nil,
+            'documentation' => nil,
+          },
+          'status' => 404,
+          'code'   => 'errors.invalid_subdomain_error',
+          'title'  => 'Invalid Subdomain',
+          'detail' => 'The resource you attempted to access is either not authorized ' \
+                      'for the authenticated user or does not exist.',
+          'source' => {
+            'http_host' => 'notvalid.example.com',
+          },
+        },
       ],
     )
   end
@@ -88,30 +86,25 @@ describe  ApiRequest do
 
     status, headers, response = api_request_middleware.call(request)
 
-    expect(status).to   eql 400
-    expect(headers).to  eql({})
-    expect(response).to eql(
-      [
-        '{' \
-          '"error":' \
-          '{' \
-            '"status":400,' \
-            '"code":1007,' \
-            '"developer_documentation_uri":"http://error.com/1007?version=1",' \
-            '"customer_support_uri":"http://knowledge.com/1234567890",' \
-            '"developer_message_key":"errors.invalid.api.request.error.developer",' \
-            '"developer_message":"The accept header that you passed in the request ' \
-                                 'cannot be parsed, please refer to the documentation ' \
-                                 'to verify.",' \
-            '"developer_details":' \
-              '{' \
-                '"accept_header":""' \
-              '},' \
-            '"friendly_message_key":"errors.invalid.api.request.error.friendly",' \
-            '"friendly_message":"Sorry! We couldn\'t understand what you were trying ' \
-                                'to ask us to do."' \
-          '}' \
-        '}',
+    expect(status).to                 eql 400
+    expect(headers).to                eql({})
+    expect(JSON.load(response[0])).to include(
+      'errors' => [
+        {
+          'id'     => match(/[a-z0-9\-]+/),
+          'links'  => {
+            'about'         => nil,
+            'documentation' => nil,
+          },
+          'status' => 400,
+          'code'   => 'errors.invalid_api_request_error',
+          'title'  => 'Invalid API Request',
+          'detail' => 'The accept header that you passed in the request cannot be ' \
+                      'parsed, please refer to the documentation to verify.',
+          'source' => {
+            'accept_header' => '',
+          },
+        },
       ],
     )
   end

data/spec/apill/resource/model_spec.rb

@@ -0,0 +1,66 @@
+require 'rspectacular'
+require 'apill/resource/model'
+
+module    Apill
+module    Resource
+describe  Model do
+  it 'can chain multiple processors together' do
+    resource           = double
+    processed_resource = double
+
+    model = Model.new(resource:   resource,
+                      parameters: {
+                        'filter' => {
+                          'query'          => 'my_query',
+                          'single_arity'   => true,
+                          'multiple_arity' => 'multi',
+                        },
+                        'sort'   => 'my_attribute',
+                        'page'   => {
+                          'number' => 10,
+                          'size'   => 100,
+                        },
+                      })
+
+    allow(resource).to receive(:single_arity).
+                       and_return(resource)
+    allow(resource).to receive(:multiple_arity).
+                       with('multi').
+                       and_return(resource)
+    allow(resource).to receive(:order).
+                       with('my_attribute' => 'asc').
+                       and_return(resource)
+    allow(resource).to receive(:page).
+                       with(10).
+                       and_return(resource)
+    allow(resource).to receive(:per).
+                       with(100).
+                       and_return(resource)
+    allow(resource).to receive(:for_query).
+                       with('my_query').
+                       and_return(processed_resource)
+    allow(resource).to receive(:total_pages).
+                       and_return(10)
+    allow(resource).to receive(:current_page).
+                       and_return(5)
+    allow(resource).to receive(:prev_page).
+                       and_return(4)
+    allow(resource).to receive(:next_page).
+                       and_return(6)
+
+    allow(processed_resource).to receive(:page).
+                                 with(10).
+                                 and_return(resource)
+
+    expect(model.processed).to eql processed_resource
+    expect(model.meta).to      eql(
+      'current-page'  => 5,
+      'total-pages'   => 10,
+      'previous-page' => 4,
+      'next-page'     => 6,
+      'sort'          => { 'my_attribute' => 'asc' },
+    )
+  end
+end
+end
+end

data/spec/apill/resource/processors/filtering_spec.rb

@@ -0,0 +1,84 @@
+require 'rspectacular'
+require 'apill/resource/processors/filtering'
+
+module    Apill
+module    Resource
+module    Processors
+describe  Filtering do
+  let(:filtering_resource) { double }
+
+  it 'can return the resource if not filtered parameters are passed in' do
+    filtering = Filtering.new(filtering_resource)
+
+    expect(filtering.processed).to eql filtering_resource
+  end
+
+  it 'can return a queried resource' do
+    filtering = Filtering.new(filtering_resource,
+                              'filter' => {
+                                'stuff' => 'blah',
+                              })
+
+    allow(filtering_resource).to receive(:for_stuff).
+                                 with('blah').
+                                 and_return 'stuffed'
+
+    expect(filtering.processed).to eql 'stuffed'
+  end
+
+  it 'does not try to query if the resource cannot query for that thing' do
+    filtering = Filtering.new(filtering_resource,
+                              'filter' => {
+                                'whatever' => 'blah',
+                              })
+
+    expect(filtering.processed).to eql filtering_resource
+  end
+
+  it 'can query for something that does not take arguments' do
+    filtering = Filtering.new(filtering_resource,
+                              'filter' => {
+                                'stuff' => 'blah',
+                              })
+
+    allow(filtering_resource).to receive(:stuff).
+                                 and_return 'stuffed'
+
+    expect(filtering.processed).to eql 'stuffed'
+  end
+
+  it 'can query for something that does not take arguments' do
+    filtering = Filtering.new(filtering_resource,
+                              'filter' => {
+                                'stuff'       => 'blah',
+                                'other_stuff' => 'other_blah',
+                              })
+
+    allow(filtering_resource).to receive(:for_stuff).
+                                 with('blah').
+                                 and_return filtering_resource
+    allow(filtering_resource).to receive(:other_stuff).
+                                 and_return 'other_stuffed'
+
+    expect(filtering.processed).to eql 'other_stuffed'
+  end
+
+  it 'can handle objects (eg ActiveRelation) that store their proxy class in klass' do
+    resource_class = double
+    filtering      = Filtering.new(filtering_resource,
+                                   'filter' => {
+                                     'stuff' => 'blah',
+                                   })
+
+    allow(filtering_resource).to receive(:klass).
+                                 and_return(resource_class)
+    allow(resource_class).to     receive(:stuff)
+    allow(filtering_resource).to receive(:stuff).
+                                 and_return 'stuffed'
+
+    expect(filtering.processed).to eql 'stuffed'
+  end
+end
+end
+end
+end

data/spec/apill/resource/processors/indexing_spec.rb

@@ -0,0 +1,11 @@
+require 'rspectacular'
+require 'apill/resource/processors/indexing'
+
+module    Apill
+module    Resource
+module    Processors
+describe  Indexing do
+end
+end
+end
+end

data/spec/apill/resource/processors/paging_spec.rb

@@ -0,0 +1,54 @@
+require 'rspectacular'
+require 'apill/resource/processors/paging'
+
+module    Apill
+module    Resource
+module    Processors
+describe  Paging do
+  let(:paging_resource)    { double }
+  let(:processed_resource) { double }
+
+  it 'can return a default page' do
+    paging = Paging.new(paging_resource)
+
+    allow(processed_resource).to receive(:total_pages).and_return  10
+    allow(processed_resource).to receive(:current_page).and_return 1
+    allow(processed_resource).to receive(:prev_page).and_return    nil
+    allow(processed_resource).to receive(:next_page).and_return    nil
+
+    allow(paging_resource).to receive(:page).
+                              with(1).
+                              and_return paging_resource
+    allow(paging_resource).to receive(:per).
+                              with(25).
+                              and_return processed_resource
+
+    expect(paging.processed).to eql processed_resource
+    expect(paging.meta).to      eql(
+      'total-pages'   => 10,
+      'current-page'  => 1,
+      'previous-page' => nil,
+      'next-page'     => nil,
+    )
+  end
+
+  it 'can return a pageed resource' do
+    paging = Paging.new(paging_resource,
+                        'page' => {
+                          'number' => 5,
+                          'size'   => 10,
+                        })
+
+    allow(paging_resource).to receive(:page).
+                              with(5).
+                              and_return paging_resource
+    allow(paging_resource).to receive(:per).
+                              with(10).
+                              and_return processed_resource
+
+    expect(paging.processed).to eql processed_resource
+  end
+end
+end
+end
+end

data/spec/apill/resource/processors/sorting_spec.rb

@@ -0,0 +1,74 @@
+require 'rspectacular'
+require 'apill/resource/processors/sorting'
+
+module    Apill
+module    Resource
+module    Processors
+describe  Sorting do
+  let(:sorting_resource) { double }
+
+  it 'can return a default sort' do
+    sorting = Sorting.new(sorting_resource)
+
+    allow(sorting_resource).to receive(:order).
+                               with('created_at' => 'desc').
+                               and_return('sorted')
+
+    expect(sorting.processed).to eql 'sorted'
+    expect(sorting.meta).to      eql(
+      'sort' => {
+        'created_at' => 'desc',
+      },
+    )
+  end
+
+  it 'can return an ascending sort' do
+    sorting = Sorting.new(sorting_resource, 'sort' => 'my_attribute')
+
+    allow(sorting_resource).to receive(:order).
+                               with('my_attribute' => 'asc').
+                               and_return('sorted')
+
+    expect(sorting.processed).to eql 'sorted'
+    expect(sorting.meta).to      eql(
+      'sort' => {
+        'my_attribute' => 'asc',
+      },
+    )
+  end
+
+  it 'can return a descending sort' do
+    sorting = Sorting.new(sorting_resource, 'sort' => '-my_attribute')
+
+    allow(sorting_resource).to receive(:order).
+                               with('my_attribute' => 'desc').
+                               and_return('sorted')
+
+    expect(sorting.processed).to eql 'sorted'
+    expect(sorting.meta).to eql(
+      'sort' => {
+        'my_attribute' => 'desc',
+      },
+    )
+  end
+
+  it 'can return multiple sorts' do
+    sorting = Sorting.new(sorting_resource, 'sort' => '-my_attribute,my_other_attribute')
+
+    allow(sorting_resource).to receive(:order).
+                               with('my_attribute'       => 'desc',
+                                    'my_other_attribute' => 'asc').
+                               and_return('sorted')
+
+    expect(sorting.processed).to eql 'sorted'
+    expect(sorting.meta).to eql(
+      'sort' => {
+        'my_attribute'       => 'desc',
+        'my_other_attribute' => 'asc',
+      },
+    )
+  end
+end
+end
+end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apill
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 3.0.0
 platform: ruby
 authors:
 - jfelchner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-07 00:00:00.000000000 Z
+date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: human_error
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: kaminari
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -85,14 +71,20 @@ files:
 - lib/apill/matchers/subdomain_matcher.rb
 - lib/apill/matchers/version_matcher.rb
 - lib/apill/middleware/api_request.rb
-- lib/apill/mixins/indexable.rb
-- lib/apill/mixins/pageable.rb
-- lib/apill/mixins/queryable.rb
-- lib/apill/mixins/sortable.rb
 - lib/apill/parameters.rb
+- lib/apill/parameters/filter.rb
+- lib/apill/parameters/index.rb
+- lib/apill/parameters/page.rb
+- lib/apill/parameters/sort.rb
 - lib/apill/requests/base.rb
 - lib/apill/requests/rack_request.rb
 - lib/apill/requests/rails_request.rb
+- lib/apill/resource.rb
+- lib/apill/resource/model.rb
+- lib/apill/resource/processors/filtering.rb
+- lib/apill/resource/processors/indexing.rb
+- lib/apill/resource/processors/paging.rb
+- lib/apill/resource/processors/sorting.rb
 - lib/apill/responses/invalid_api_request_response.rb
 - lib/apill/responses/invalid_subdomain_response.rb
 - lib/apill/serializers/json_api.rb
@@ -108,6 +100,11 @@ files:
 - spec/apill/parameters_spec.rb
 - spec/apill/requests/rack_request_spec.rb
 - spec/apill/requests/rails_request_spec.rb
+- spec/apill/resource/model_spec.rb
+- spec/apill/resource/processors/filtering_spec.rb
+- spec/apill/resource/processors/indexing_spec.rb
+- spec/apill/resource/processors/paging_spec.rb
+- spec/apill/resource/processors/sorting_spec.rb
 homepage: https://github.com/jfelchner/apill
 licenses:
 - MIT
@@ -144,3 +141,8 @@ test_files:
 - spec/apill/parameters_spec.rb
 - spec/apill/requests/rack_request_spec.rb
 - spec/apill/requests/rails_request_spec.rb
+- spec/apill/resource/model_spec.rb
+- spec/apill/resource/processors/filtering_spec.rb
+- spec/apill/resource/processors/indexing_spec.rb
+- spec/apill/resource/processors/paging_spec.rb
+- spec/apill/resource/processors/sorting_spec.rb

data/lib/apill/mixins/indexable.rb

@@ -1,49 +0,0 @@
-module Apill
-module Mixins
-module Indexable
-  module ClassMethods
-    def index(model)
-      define_method(:indexed_model_name) do
-        model
-      end
-    end
-  end
-
-  def self.included(base)
-    base.extend ClassMethods
-  end
-
-  private
-
-  def index_params
-    @index_params ||= params[:index_params] || params || {}
-  end
-
-  def filtered_resource
-    @filtered_resource ||= begin
-      resource = if defined? super
-                   super
-                 else
-                   __send__(indexed_model_name)
-                 end
-
-      if index_params.key? 'q'
-        resource.search(index_params['q'])
-      else
-        resource
-      end
-    end
-  end
-
-  def filter_data
-    filter_data = defined?(super) ? super : {}
-
-    filter_data.merge(indexing_data)
-  end
-
-  def indexing_data
-    {}
-  end
-end
-end
-end

data/lib/apill/mixins/pageable.rb

@@ -1,51 +0,0 @@
-module  Apill
-module  Mixins
-module  Pageable
-  module ClassMethods
-    def paginate(model)
-      define_method(:paginated_model_name) do
-        model
-      end
-    end
-  end
-
-  def self.included(base)
-    base.extend ClassMethods
-  end
-
-  private
-
-  def filtered_resource
-    @filtered_resource ||= begin
-      page_number    = params[:page]
-      items_per_page = params[:per_page]
-
-      resource = if defined? super
-                   super
-                 else
-                   __send__(paginated_model_name)
-                 end
-
-      @paginated_resource = resource.
-                              page(page_number).
-                              per(items_per_page)
-    end
-  end
-
-  def filter_data
-    filter_data = defined?(super) ? super : {}
-
-    filter_data.merge(pagination_data)
-  end
-
-  def pagination_data
-    {
-      'total-pages'   => @paginated_resource.total_pages,
-      'current-page'  => @paginated_resource.current_page,
-      'previous-page' => @paginated_resource.prev_page,
-      'next-page'     => @paginated_resource.next_page,
-    }
-  end
-end
-end
-end