rails-rapido 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c7c8672e3ca4ed53db33a2bb7345b9500428f5e
+  data.tar.gz: de8ef790022968819a797c831517886894e70c7d
+SHA512:
+  metadata.gz: 0b1c4da043e6f9573eb6218440dd56f6ad4e0fc8117a1e8792fd4af4491deb4310fa37efbbffb05d40ed2324c8e08045f787a9d04aa415598fcd73784428d597
+  data.tar.gz: '082bd98d224b0ae9fa5979b008d87fe398184449a5c12509b48bd965b416f63f7f177736864c91af1fb38fc28cb45731917d4813d6895cd362ab00732ee4b865'

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,124 @@
+AllCops:
+  TargetRubyVersion: 2.3.4
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  Exclude:
+    - '**/templates/**/*'
+    - '**/vendor/**/*'
+    - 'actionpack/lib/action_dispatch/journey/parser.rb'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+
+# Align `when` with `case`.
+Style/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Style/CommentIndentation:
+  Enabled: true
+
+# No extra empty lines.
+Style/EmptyLines:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Style/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Style/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Style/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Style/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: rails
+
+# Two spaces, no tabs (for indentation).
+Style/IndentationWidth:
+  Enabled: true
+
+Style/SpaceAfterColon:
+  Enabled: true
+
+Style/SpaceAfterComma:
+  Enabled: true
+
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Style/SpaceAroundKeyword:
+  Enabled: true
+
+Style/SpaceAroundOperators:
+  Enabled: true
+
+Style/SpaceBeforeFirstArg:
+    Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Style/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Style/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Style/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+# Detect hard tabs, no hard tabs.
+Style/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Style/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Style/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Lint/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,84 @@
+# Rapido
+
+Rapido is a simple module library that can be included into your Rails controllers to dry up a standard, RESTful API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rapido'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rapido
+
+## Usage
+
+Simply including the Rapido::Controller module into your controller is all you need to do if:
+
+1. Odd controller name: your controller's name follows the standard [Resource.pluralize]Controller format.
+1. Odd controller methods: you don't need any additional API endpoints other then the standard REST create/show/index/delete/update endpoints.
+1. Resource ownership: the resource governed by your controller is not nested within an owner, e.g. /api/v1/[parent_resource]/[parent_resource_id]/[my_resource]
+
+If your controller has any of these characteristics, you'll need to do a little bit more work to properly configure your controller.
+
+### Odd controller name
+
+If for some reason your controller name does not follow the standard format, you'll need to override the override the `resource_class` method. For example, if you have a controller named `MyOddleNamedWidgetController` for the `Widget` resource:
+
+```
+class MyOddlyNamedWidgetController < ApplicationController
+  include Rapido::Controller
+
+  private
+
+  def resource_class
+    Widget
+  end
+end
+```
+
+
+### Odd controller methods
+
+If you have endpoints other than create, show, index, update, and delete, you can add them as additional methods like so:
+
+```
+class WidgetsController < ApplicationController
+  include Rapido::Controller
+
+  def spin
+    resource.spin!
+    head :ok
+  end
+end
+```
+
+### Resource ownership
+
+If your resources has a `belongs_to` relationship that is reflected in the API route as a nested resource, you can specify the `resource_owner` class to include the relationship when retrieving the resource.
+
+```
+class WidgetsController < ApplicationController
+  include Radido::Controller
+
+  resource_owner_name :widget_factory
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jskirst/rapido.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rapido'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rapido.rb

@@ -0,0 +1,5 @@
+require 'rapido/version'
+require 'rapido/controller'
+
+module Rapido
+end

data/lib/rapido/controller.rb

@@ -0,0 +1,150 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/rescuable'
+
+module Rapido
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      rescue_from ActiveRecord::RecordNotFound do |e|
+        render json: { errors: [ e.to_s ] }, status: 404
+      end
+    end
+
+    class_methods do
+      def resource_owner_name(name = nil)
+        @resource_owner_name = name.to_s if name
+        @resource_owner_name
+      end
+    end
+
+    def index
+      render json: { resource_name.pluralize => resource_collection.map(&:to_h), meta: index_meta }
+    end
+
+    def show
+      render json: resource.to_h
+    end
+
+    def create
+      new_resource = build_resource
+      if new_resource.save
+        render json: new_resource.to_h
+      else
+        render json: { errors: new_resource.errors.full_messages }, status: 422
+      end
+    end
+
+    def destroy
+      resource.destroy
+      head :ok
+    end
+
+    def update
+      resource.assign_attributes(resource_update_params)
+      if resource.save
+        render json: resource.to_h
+      else
+        render json: { errors: resource.errors.full_messages }, status: 422
+      end
+    end
+
+    private
+
+      def index_meta
+        {
+          pagination: {
+            per_page: resource_collection.limit_value,
+            total_pages: resource_collection.total_pages,
+            total_objects: resource_collection.count,
+          }
+        }
+      end
+
+      def resource_required_param
+        resource_name.to_sym
+      end
+
+      def resource_create_permitted_params
+        []
+      end
+
+      def resource_update_permitted_params
+        []
+      end
+
+      def resource_update_params
+        params
+          .require(resource_required_param)
+          .permit(resource_update_permitted_params)
+      end
+
+      def resource_create_params
+        params
+          .require(resource_required_param)
+          .permit(resource_create_permitted_params)
+      end
+
+      def build_resource_params
+        {
+          resource_owner_reference.to_sym => resource_owner.id
+        }.merge(resource_create_params)
+      end
+
+      def build_resource
+        resource_class.new(build_resource_params)
+      end
+
+      def resource_collection
+        resource_class
+          .where("#{resource_owner_reference} = ?", resource_owner.id)
+          .page(params[:page])
+      end
+
+      def resource_owner_name
+        return self.class.resource_owner_name if self.class.resource_owner_name
+        @resource_owner_name ||= resource_owner.class.name.underscore
+      end
+
+      def resource_owner_class
+        @resource_owner_class ||= resource_owner_name.camelize.constantize
+      end
+
+      def resource_owner_reference
+        "#{resource_owner_name}_id"
+      end
+
+      def resource_owner
+        @resource_owner ||= resource_owner_class.find(params[resource_owner_reference])
+      end
+
+      def resource
+        @resource ||=
+          resource_class
+            .where("#{resource_owner_reference} = ?", resource_owner.id)
+            .find(params[:id])
+      end
+
+      def resource_reference
+        "#{resource_name}_id"
+      end
+
+      def resource_class
+        @resource_class ||=
+          resource_controller_class.constantize
+      end
+
+      def resource_name(name = nil)
+        return @resource_name = name if name
+        @resource_name ||= resource_controller_class.underscore
+      end
+
+      def resource_controller_class
+        @resource_controller_class ||=
+          self.class.name.split('::')[-1].remove('Controller').singularize
+      end
+
+      class ResourceOwnerNameNotSpecified < StandardError; end
+  end
+end

data/lib/rapido/version.rb

@@ -0,0 +1,3 @@
+module Rapido
+  VERSION = '0.1.0'
+end

data/rapido.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rapido/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails-rapido'
+  spec.version       = Rapido::VERSION
+  spec.authors       = ['Jonathan Kirst']
+  spec.email         = ['jskirst@gmail.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Rails API Dryer-o'
+  spec.description   = 'Opinionated RESTfull API controller library.'
+  spec.homepage      = 'https://github.com/jskirst/rapido'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: rails-rapido
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Kirst
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Opinionated RESTfull API controller library.
+email:
+- jskirst@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rapido.rb
+- lib/rapido/controller.rb
+- lib/rapido/version.rb
+- rapido.gemspec
+homepage: https://github.com/jskirst/rapido
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Rails API Dryer-o
+test_files: []