rails-rapido 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 04bd1cc6e6fd9527fc1b90022653cf1f8d48c041
-  data.tar.gz: bb1d6b86f00de708625b1b62f0aeb8363f4e6571
+SHA256:
+  metadata.gz: eae5461189f3b0d670b870ac16c3f8e5b04ca3b57465e95151a360fd563cfa71
+  data.tar.gz: d89ae7dbcb57d036a65bf4f507f36b331e00ba77bb34e6305bd86f46e844e463
 SHA512:
-  metadata.gz: 6ff34955402b0927030447e6cf25314cc0be498ebe8da896d0d490902753fb0d2efd4d9cbf3961f7b2651d0bcf12e3934b2eb27bb88b56159cc411c1245651ef
-  data.tar.gz: 2966b6c780cd4b58e85719e338bd2ef7b4780199aaa523bc1d348c474efdd759e866877514f254cd6c2a8ac3a116a26291c1b93c5d57d082b91e7d46b7a764ce
+  metadata.gz: ac1880f71e3289703a168beb617dcacb8136f6aceafddda189e143bd35e059608da3d6c6d4b6d7143a2af8dea1993dfee283d54407b9e5ad214c6807f5e317ea
+  data.tar.gz: be1bea5642f1da1261b786abe9c668737ef96fac8525207322635c937a158deb32759a03f68b93e9907132fd77dfc5ceb8462b8656860467e2a444b2a7b0803e

data/README.md

@@ -4,7 +4,79 @@
 
 Rapido is a simple, highly opinionated library that can be included into your Rails controllers to enforce standardized behavior and security.
 
-Documentation coming soon.
+## API
+
+#### `belongs_to`
+
+Specifies the owner of the resource. For example, if many `Post` belonged to `User`, then in the `PostsController`, the following would be included: `belongs_to :user` and `Post` would be retrieved like so:
+
+`User.find(params[:user_id]).posts.find([params[:id])`.
+
+##### Optional Parameters
+
+**has_one** 
+
+Default `false`. If `true`, will treat the `belongs_to` as `has_one`.
+
+**owner** 
+
+This is the owner of the owner - if supplied, will be used to retrieve the owner. For example, if `User` belongs to `Group`, `Post` belongs to `User`, then in the `PostsController` if `belongs_to :user, owner: :current_group` was supplied, then the User would be retrieved from group before Post is retrieved from user, like so:
+
+`current_group.users.find(params[:user_id]).posts.find(params[:id])`.
+
+**getter**
+
+Specifies the method to call to retrieve the owner, rather than retrieving by with URL parameters. For example, if `Post` belongs to `User`, then in the `PostsController` if `belongs_to :user, getter: :current_user` was supplied, then the post would be retrieved like so: 
+
+`current_user.posts.find(params[:id])`. 
+
+This can be useful when ownership exists but is not reflected in the route structure explicitly.
+
+**foreign_key**
+
+Default `id`. Specifies the name of the lookup column for the owner. For example, if `Post` belongs to `User`, then in the `PostsController` if `belongs_to :user, foreign_key: :token` is supplied, then the post would be retrieved like so: 
+
+`User.find_by(token: id).posts.find(params[:id])`.
+
+**foreign_key_param**
+
+Default `[singular owner name]_id`. Specifies the param used as the owner's foreign key. For example, if `Post` belongs to `User`, then in the `PostsController` if `belongs_to :user, foreign_key_param: :author_id` is supplied, then the post would be retrieved like so: 
+
+`User.find(params[:author_id]).posts.find(params[:id])`.
+
+#### `lookup_param`
+
+Specifies the param used to retrieve the resource. For example, if `Post` belongs to `User`, then in the `PostsController` if `lookup_param :token` is supplied, then the post would be retrieved like so: 
+
+`User.find_by(params[:id]).posts.find_by(token: params[:token])`.
+
+#### `presented_by`
+
+Specifies the class that will present the resource. This class must accept the resource as the only parameter at initialization, and respond to the `as_json` for output when used with the `Rapido::ApiController`.
+
+#### `collection_presented_by`
+
+Specifies the class that will present a collection of resources, as in the index method. Similar to `presented_by`, the class must accept the resource collection as the only argument at initialization, and respond to `as_json` for output when used with the `Rapido::ApiController`. The `collection_presented_by` can also accept a list of arguments, as symbols, that should be pulled from the `params` hash and passed to presenter class at initialization as optional argments.
+
+For example, if `params` contained a `:filter` parameter which should be used by the presenter to filter the collection, then the following would work: 
+
+`collection_presented_by WidgetsCollectionPresenter, :filter`
+
+The `initialize` method of the presenter should be structured as such:
+
+`def initialize(widgets, filter = nil)`
+
+#### `attr_permitted`
+
+Accepts a list of symbols. These symbols specify the attributes that are supplied to StrongParameters as permitted parameters in `create` and `update` actions.
+
+#### `permit_no_params!`
+
+This will disallow any parameters in `create` and `update` actions.
+
+#### `permit_all_params!`
+
+This will permit all parameters in `create` and `update` actions.
 
 ## Development
 
@@ -14,9 +86,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Testing
 
-Run `rake` to execute the feature tests written for the sample application in the `test` directory.
+Run `cucumber test/test_5_1` to execute all the tests in the test application.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jskirst/rapido.
+Bug reports and pull requests are welcome on GitHub at https://github.com/starfighter/rapido.
 

data/lib/rapido/api_controller.rb

@@ -16,35 +16,49 @@ module Rapido
     end
 
     def index
-      render json: resource_collection.map(&:to_h)
+      render json: present_resource_collection(resource_collection)
     end
 
     def show
-      render json: resource.to_h
+      render json: present_resource(resource)
     end
 
     def create
       new_resource = build_resource(resource_params)
       if new_resource.save
-        render json: new_resource.to_h, status: :created
+        render json: present_resource(new_resource), status: :created
       else
         render json: { errors: new_resource.errors.full_messages }, status: 422
       end
     end
 
     def destroy
-      resource_hsh = resource.to_h
+      resource_before_destruction = present_resource(resource)
       resource.destroy
-      render json: resource_hsh
+      render json: resource_before_destruction
     end
 
     def update
       resource.assign_attributes(resource_params)
       if resource.save
-        render json: resource.to_h
+        render json: present_resource(resource)
       else
         render json: { errors: resource.errors.full_messages }, status: 422
       end
     end
+
+    private
+
+    def present_resource(resource)
+      return presenter.new(resource).as_json if presenter
+      resource.to_h
+    end
+
+    def present_resource_collection(resource_collection)
+      args = collection_presenter_args.nil? ? nil : collection_presenter_args.map { |arg| params[arg] }
+      return collection_presenter.new(*[resource_collection, *args].compact).as_json if collection_presenter
+      return resource_collection.map{ |r| presenter.new(r).as_json } if presenter
+      resource_collection.map(&:to_h)
+    end
   end
 end

data/lib/rapido/controller.rb

@@ -44,6 +44,11 @@ module Rapido
         end
       end
 
+      def collection_presented_by(presenter_class, *args)
+        @collection_presenter ||= presenter_class
+        @collection_presenter_args = args if args.count > 0
+      end
+
       def owner_lookup_defaults
         owner_lookup_param(@owner_class, :id)
         owner_lookup_field(:id)
@@ -81,6 +86,10 @@ module Rapido
       def resource_class_name
         resource_class_from_controller
       end
+
+      def presented_by(presenter_class)
+        @presenter ||= presenter_class
+      end
     end
 
     private
@@ -95,6 +104,14 @@ module Rapido
         end
       end
 
+      def collection_presenter
+        setting(:collection_presenter)
+      end
+
+      def collection_presenter_args
+        setting(:collection_presenter_args)
+      end
+
       def owner_class
         return nil unless setting(:owner_class)
         @owner_class ||= begin
@@ -138,6 +155,10 @@ module Rapido
         end
       end
 
+      def presenter
+        setting(:presenter)
+      end
+
       def resource
         @resource ||= begin
           if setting(:has_one)

data/lib/rapido/version.rb

@@ -1,3 +1,3 @@
 module Rapido
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-rapido
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jonathan Kirst
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2018-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kaminari
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Rails API Dryer-o