Upframework

Add features on top of Rails, Especially for APIs. This was created to make structural code reusable to other projects (not solving the same problem all over again). And to make the main application less bloated and only contain domain specific code as much as possible.

The following features are available.

• Creates (create, read, update, destroy) action methods for resources.
• Has render helpers for API or socket responses. ex. Converting models to its designated serializer.
• Converts snake case request params (from js standard) to underscore params (ruby standard)
• Searches layer under app/searches. Usually used for form searches.
• Services layer under app/services. For single responsibility domain-specific logic code.
• Exception notifier and API error response handler.

Basic Usage

Controllers

# app/controllers
# create,show,update,destroy methods are available by default
class ProjectsController < Upframework::ResourcesController
  # Example of broadcasting with a serialized object using ActionCables.
  def udate
    super do
      channel = @project.user
      broadcast_serialized(channel, resource: @project, event: "Project Updated")
    end
  end

  # Example of rendering serialized responsed. This is using fast_jsonapi serializer.
  def custom_action
    render_serialized @project
  end
end

Serializers

# app/serializers
# classes extending Upframework::BaseSerializer has pagination and meta data enabled
class ProjectSerializer < Upframework::BaseSerializer
  belongs_to :user

  has_many :tasks

  default_includes [:user]
end

Searches

#app/searches
class ProjectSearch < Upframework::BaseSearch
  def post_initialize
    @per_page = 10
    @scope = Project.accessible_by(@current_ability)
  end

  def execute
    # query logic here using scope object defined above
    # by default results are paginated
  end
end

#search api available in
/search?resource=Project&arg1=""&arg2=""

Services

#app/services
class Project::SubmitService < Upframework::BaseService
  def post_initialize(id:, **attrs)
    @project = Project.find(id)
  end

  def execute
    # put main logic here
    # ...
    project.save
  end

  def result
    project
  end
end

service = Project::SubmitService.run
service.result => <Project: Instance>
service.success? => true/false

Routes

#config/routes
mount Upframework::Engine => /path

routes being available

GET /search
POST /{resource}/services/:service_name

Installation

Add this line to your application's Gemfile:

gem 'upframework'

And then execute:

$ bundle

Or install it yourself as:

$ gem install upframework

Contributing

Contribution directions go here.

License

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