pragma-rails 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac8702d88c5f2db7d4777025f5c2b30c114742b1
-  data.tar.gz: fe42df1b4394704eb074ff68f1aef27f5e3fe9fd
+  metadata.gz: 2296947bedbdc7b81cac15053a92a8d59ecdb276
+  data.tar.gz: aeece846c1d8717ee920294da0e63f33834ffa93
 SHA512:
-  metadata.gz: 0ee9e39e7bc75d8160751a015978cabad1eb5e5bb99b70106655aab1d2e068f0a06496d85096625c72410275e67720235361bd5558edd79012c53b3ae6f83c9a
-  data.tar.gz: 05d5f0a2f798f2001e31a854ddacc7f5b353d4b91179e51633ed7af48b8362ea9d0f4de44c93bd641f1d92ac7eac04995ed56c137d8cd022b7b75c922db1a536
+  metadata.gz: 2d3ae5a6057b1da3c878db167f310661ec9fcc919427c96036378a2fcec58b8a9a82d5f0e78eac38dd631235056d981b3d2b775b0ef2f0f22156ae7480bf7cce
+  data.tar.gz: 6348bd9002b966c8b604deffdd4aa6ed41f27d3f036105fc1bae4a9c70f1e58661f3503921c7acafa377c066b00a427506b3d77de2ff2a60282406474724291a

data/README.md

@@ -29,8 +29,83 @@ $ gem install pragma-rails
 
 ## Usage
 
-All documentation is in the [doc](https://github.com/pragmarb/pragma-rails/tree/master/doc)
-folder.
+The gem provides two modules which you can include in your controllers to integrate with Pragma.
+
+### Basic controllers
+
+The first module is `Pragma::Rails::Controller`. It gives you a `#run` method which you can call in
+your controller to run the provided Pragma operation:
+
+```ruby
+module API
+  module V1
+    class PostsController < ApplicationController
+      include Pragma::Rails::Controller
+
+      def create
+        run API::V1::Post::Operation::Create
+      end
+    end
+  end
+end
+```
+
+In the example above, `PostsController#create` will run the `API::V1::Post::Operation::Create`
+operation and respond with the status code, headers and resource output by the operation.
+
+By default, the `#params` method will be used as the operation's parameters and `#current_user`, if
+available, will be used as the operation's user. You can override these defaults by overriding the
+`#operation_params` and `#operation_user` methods in your controller:
+
+```ruby
+module API
+  module V1
+    class PostsController < ApplicationController
+      include Pragma::Rails::Controller
+
+      def create
+        run API::V1::Post::Operation::Create
+      end
+
+      private
+
+      def operation_params
+        params.merge(my_additional: 'param')
+      end
+
+      def operation_user
+        User.authenticate_from params
+      end
+    end
+  end
+end
+```
+
+### Resource controllers
+
+Resource controllers abstract even more of the logic behind your controllers by inferring the
+operations supported by a resource and automagically providing controller actions that run them.
+
+Provided that the name of the controller and the name of the operation stay the same, the example
+above could be rewritten as:
+
+```ruby
+module API
+  module V1
+    class PostsController < ApplicationController
+      include Pragma::Rails::ResourceController
+    end
+  end
+end
+```
+
+You will still have to define a route to your `#create` action, of course, but you don't have to
+write the action anymore! This works with any actions, not only the default CRUD actions defined
+by Rails. So, for instance, if you have an `API::V1::Post::Operation::Publish` operation, a
+`#publish` action will be accessible in the `API::V1::PostsController` controller.
+
+Note that `Pragma::Rails::Controller` is included automatically when including
+`Pragma::Rails::ResourceController`.
 
 ## Contributing
 

data/lib/pragma/rails/resource_controller.rb

@@ -46,7 +46,8 @@ module Pragma
         def class_exists?(klass)
           Object.const_get(klass)
           true
-        rescue NameError
+        rescue NameError => e
+          raise e unless e.message.include?("uninitialized constant #{klass}")
           false
         end
       end

data/lib/pragma/rails/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Pragma
   module Rails
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pragma-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-30 00:00:00.000000000 Z
+date: 2017-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pragma