Pragma on Rails

This gem provides Ruby on Rails integration for the Pragma architecture.

Installation

Add this line to your application's Gemfile:

gem 'pragma-rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pragma-rails

Usage

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:

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:

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:

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

Bug reports and pull requests are welcome on GitHub at https://github.com/pragmarb/pragma-rails.

License

The gem is available as open source under the terms of the MIT License.