model-api 0.8.10 → 0.8.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4236690ba6188e94302365bcb54af72c44d9895
-  data.tar.gz: 8feab210c4e863f0d031ec4a4ec65f7fad683fbd
+  metadata.gz: 4f14172aa6fcaa7f2c314d673e4295338493588b
+  data.tar.gz: 43e8a3a180fb05ca4d527b953e78e091ecdc75fb
 SHA512:
-  metadata.gz: 6ad9de6daf542958341c2f86f50362a3b554bba9b74e10883a20c6905424f6b3e04b3c63660b48a178a626ce36baac70932f35b58c1533ceb91885346c2eaba6
-  data.tar.gz: 07725bfd70fd203020847b0c07cbd68fcdeb50db2917d999484c6a57d649388df07041e1432ad0cfb99ef86c844cc9853ea58573a353e09573fecfedd86faba0
+  metadata.gz: 50b16368bf036477dbf671d3b0e528e6533ca358a35ae917f4d8ff2408c61470fa161c3c1399850bba0ba0b5bd797c33bd80c81ebc806ece1fa5303971a36020
+  data.tar.gz: 7566d5be7fc86688cf8e09bfa58bab47b644b81e2c87f9859e05edfbd08c9dee37246f2294dae8300f411a9b1751624cd908a1a5a3fb74b113b5b9664e6f66bb

data/README.md

@@ -9,32 +9,35 @@ Developing REST API's in a conventional manner involves many challenges.  Betwee
    
  With model-api, you can:
   * Consolidate your payload and response metadata for a given resource in the ActiveRecord model.
+  * Reduce the lines of code required to implement your Rails-based Rest API dramatically.
+  * Generate OpenAPI documentation guaranteed to be in sync with what your API actually supports.
   * Set up easily-configurable filtering, pagination, sorting, and HATEOAS link generation.
   * Render, link, create, search upon, and sort upon your resources' associated objects with ease.
-  * Easily leverage the ActiveRecord validation rules present in your application's models to
-    validate calls to your API.
-  * Automatically generate OpenAPI documentation with each deployment that's guaranteed to be in
-    sync with what your API actually supports.
-  * Reduce the lines of code required to implement your Rails-based Rest API dramatically.
+  * Leverage ActiveRecord validation rules in your application's models to validate API calls.
+  * Effortlessly support JSON and XML input / output formats together in the same API.
+  * Use Java-style camel-case for API content while utilizing Ruby underscore convention internally.
 
 ## Guides
 This README file is intended to provide a brief introduction.  For more detailed information,
 the following guides are available:
-* [Guide to `api_metadata` options](doc/api_metadata.md)
-* [Guide to `model_metadata` options](doc/api_metadata.md)
-* [Managing data access in `model-api`](doc/api_metadata.md)
+* [Guide to `api_attributes` metadata](doc/api_attributes.md)
+* [Guide to `api_model` metadata](doc/api_model.md)
+* [Managing data access in `model-api`](doc/managing_data_access.md)
+
+General information on the API (including enumerated constants, etc.) can be found here:
+* [General gem usage information](doc/general_info.md)
 
 ## Installation
  
 Put this in your Gemfile:
 
 ``` ruby
-gem 'open-api'
+gem 'model-api'
 ```
 
 ## Configuration
 
-The `model-api` gem doesn't require configuration.  However, if you plan to generate OpenAPI
+The model-api gem doesn't require configuration.  However, if you plan to generate OpenAPI
  documentation, add an `open_api.rb` file to `config/initializers` and configure as follows:
 
 ``` ruby
@@ -78,9 +81,14 @@ class Book < ActiveRecord::Base
   validates :name, presence: true, uniqueness: true, length: { maximum: 50 }
   validates :description, length: { maximum: 250 }
   validates :isbn, presence: true, uniqueness: true, length: { maximum: 13 }
-  
+
+  # Define model-level rules and metadata associated with the REST API.
+  api_model(
+      base_query: ->(opts) { opts[:admin] ? Book.where(public: true) : Book.all }
+  )
+
   # Define the attributes exposed via the REST API.
-  api_attributes \
+  api_attributes(
       id: { filter: true, sort: true },
       name: { filter: true, sort: true },
       description: {},
@@ -90,10 +98,14 @@ class Book < ActiveRecord::Base
       },
       created_at: { read_only: true, filter: true },
       updated_at: { read_only: true, filter: true }
+  )
 
 end
 ```
-An explanation of the options used in the `api_attributes` example above:
+An explanation of the options used in the [`api_model`](doc/api_model.md) example above:
+* `base_query` - Limit data exposed by the API based on context (e.g. current user).
+
+An explanation of the options used in the [`api_attributes`](doc/api_attributes.md) example above:
 * `filter` - Allow filtering by query string parameters (e.g. `?id=123`).
 * `sort` - Allow use of this column in the sort_by parameter.
 * `read_only` - Disallow column updates (via `POST`, `PUT`, or `PATCH`).

data/lib/model-api/base_controller.rb

@@ -188,6 +188,9 @@ module ModelApi
           default_link_options = request.params.to_h.symbolize_keys
           opts[:collection_link_options] ||= default_link_options
           opts[:object_link_options] ||= default_link_options
+          if default_link_options[:exclude_associations].present?
+            opts[:exclude_associations] ||= default_link_options[:exclude_associations]
+          end
         end
         opts[:options_initialized] ||= true
         opts

data/lib/model-api/utils.rb

@@ -419,10 +419,49 @@ module ModelApi
           includes << attr_metadata[:key] if attr_metadata[:type] == :association
         end
         includes = includes.compact.uniq
+        includes = remove_excluded_associations(includes, opts)
         collection = collection.includes(includes) if includes.present?
         collection
       end
 
+      # Does not eager load associations mentioned in the exclude_associations
+      # array defined by user.
+      def remove_excluded_associations(includes, opts)
+        includes_dup = includes.compact.uniq.deep_dup
+        exclude_associations = opts[:exclude_associations]
+        return includes_dup unless exclude_associations.present?
+        exclude_associations.each do |association|
+          remove_association_from_array(includes_dup, association.to_sym)
+        end
+        includes_dup
+      end
+
+      # If the association is present in array form (in collection_includes) delete it.
+      # Then loop over the array elements to remove the association incase of nested associations.
+      def remove_association_from_array(array_collection, association)
+        array_collection.delete(association)
+        array_collection.each_with_index do |collection, i|
+          if collection.is_a?(Hash)
+            array_collection[i] = remove_association_from_hash(collection, association)
+          end
+        end
+        array_collection
+      end
+
+      # Incase of nested associations (in collection_inlcudes) delete the key with the association name
+      # and then loop over the collection to delete associations present as element of the array if any
+      def remove_association_from_hash(hash_collection, association)
+        if hash_collection.keys.include?(association)
+          hash_collection.delete(association)
+        else
+          hash_collection.each do |key, value|
+            hash_collection[key] =
+              remove_association_from_array(value, association) if value.is_a?(Array)
+          end
+        end
+        hash_collection
+      end
+
       def find_class(obj, opts = {})
         return nil if obj.nil?
         opts[:class] || (obj.respond_to?(:klass) ? obj.klass : obj.class)
@@ -459,6 +498,13 @@ module ModelApi
         metadata
       end
 
+      def exclude_associations_metadata(metadata, obj, opts = {})
+        exclude_associations = opts[:exclude_associations].try(:map, &:to_sym)
+        if exclude_associations.present?
+          (exclude_associations.include?(obj.table_name) || exclude_associations.include?(metadata[:key]))
+        end
+      end
+
       def include_item?(metadata, obj, operation, opts = {})
         return false unless metadata.is_a?(Hash)
         return false unless include_item_meets_admin_criteria?(metadata, obj, operation, opts)
@@ -467,6 +513,7 @@ module ModelApi
         return eval_bool(obj, metadata[:sort], opts) if operation == :sort
         return false unless include_item_meets_read_write_criteria?(metadata, obj, operation, opts)
         return false unless include_item_meets_incl_excl_criteria?(metadata, obj, operation, opts)
+        return false if exclude_associations_metadata(metadata, obj, opts)
         true
       end
 

data/model-api.gemspec

@@ -3,7 +3,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name = 'model-api'
-  s.version = '0.8.10'
+  s.version = '0.8.11'
   s.summary = 'Create easy REST API\'s using metadata inside your ActiveRecord models'
   s.description = 'Ruby gem allowing Ruby on Rails developers to create REST API’s using ' \
       'metadata defined inside their ActiveRecord models.'

metadata

@@ -1,61 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: model-api
 version: !ruby/object:Gem::Version
-  version: 0.8.10
+  version: 0.8.11
 platform: ruby
 authors:
 - Matthew Mead
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-01 00:00:00.000000000 Z
+date: 2017-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: open-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.4
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.2
 description: Ruby gem allowing Ruby on Rails developers to create REST API’s using
@@ -90,17 +90,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Create easy REST API's using metadata inside your ActiveRecord models