resourcey 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1306a0fe33325bac9d437ed29f85897248fe1dc
+  data.tar.gz: 80d823122198934120719e54f9420397d53d6ec0
+SHA512:
+  metadata.gz: 0df5cac0005f0a2767626299a7b10a3b44de828216a366ebe45a3a67c0576476b525e6bdeeb477a32cf7d5e1c5e124d33501fabd2ba1c1b21ae58301e3a49359
+  data.tar.gz: 27c5fed3a4b67376769c5abf96e810148a9c772e2de84d11b507199e888b3219372d7eadc9634167e0ed4d639d7d03065c637e5583934eaf3ed607096180a41d

data/README.md

@@ -0,0 +1,63 @@
+# Resourcey
+A lightweight gem for building resource-based APIs.
+
+## Installation
+Add Resourcey to your `Gemfile`:
+```ruby
+gem 'resourcey'
+```
+
+And then:
+```
+bundle
+```
+
+Or install it manually:
+```
+gem install resourcey
+```
+
+## Usage
+### Controller
+For a resource called `user`, just create `UsersController` in a correct namespace (e.g. 'api/v1')
+```ruby
+class Api::V1::UsersController < Resourcey::Controller
+end
+```
+
+For further reading, [click here](/docs/CONTROLLER.md)
+
+### Serializer
+
+Now you need a serializer, let's assume that `User` has an email and an ID, go with this:
+```ruby
+class UserSerializer < Resourcey::Serializer
+  attributes :id, :email
+end
+```
+
+For further reading, [click here](/docs/SERIALIZER.md)
+
+### Fetch the data
+
+Don't forget to create a correct route in your `routes.rb` file, and you're good to go!
+Now just visit `/api/v1/users`, and see how your resources are rendered.
+
+```json
+/* example response */
+
+[
+  { "id": 1, "email": "john.doe@example.com" },
+  { "id": 2, "email": "george.doe@example.com" }
+]
+```
+
+## Gem development
+If you want to take part in developing resourcey, fork this repository, commit your code, and create pull request.
+
+### Requirements
+- ruby 2.4.1
+- bundler
+
+### Running local tests
+- rspec

data/lib/resourcey.rb

@@ -0,0 +1,5 @@
+require 'action_controller'
+
+require 'resourcey/config'
+require 'resourcey/controller'
+require 'resourcey/serializer'

data/lib/resourcey/config.rb

@@ -0,0 +1,19 @@
+module Resourcey
+  class Config
+    attr_accessor :foo
+
+    def initialize
+      self.foo = 'foo'
+    end
+  end
+
+  class << self
+    attr_accessor :config
+  end
+
+  @config ||= Config.new
+
+  def self.configure
+    yield @config
+  end
+end

data/lib/resourcey/controller.rb

@@ -0,0 +1,76 @@
+module Resourcey
+  class Controller < ActionController::Base
+    def index
+      render json: serialized_collection(resources)
+    end
+
+    def show
+      find_resource
+      render json: @resource, serializer: serializer
+    end
+
+    def create
+      @resource = resource_model.new(resource_params)
+
+      if @resource.save
+        render json: @resource, serializer: serializer, status: :ok
+      else
+        render json: { errors: @resource.errors }, status: :bad_request
+      end
+    end
+
+    def update
+      find_resource
+      @resource.assign_attributes(resource_params)
+
+      if @resource.save
+        render json: @resource, serializer: serializer, status: :ok
+      else
+        render json: { errors: @resource.errors }, status: :bad_request
+      end
+    end
+
+    def destroy
+      find_resource
+      @resource.destroy
+
+      if @resource.destroyed?
+        render json: true, status: :ok
+      else
+        render json: { errors: @resource.errors }, status: :bad_request
+      end
+    end
+
+    private
+
+    def find_resource
+      @resource = resource_model.find(params[:id])
+    end
+
+    def resource_model_name
+      @resource_model_name ||= controller_name.singularize.camelize
+    end
+
+    def resource_model
+      name = resource_model_name
+      name.safe_constantize || raise("Cannot find model #{name}")
+    end
+
+    def serializer
+      name = "#{resource_model_name}Serializer"
+      name.safe_constantize || raise("Cannot find serializer #{name}")
+    end
+
+    def resources
+      resource_model.all
+    end
+
+    def resource_params
+      raise('#resource_params must be defined!')
+    end
+
+    def serialized_collection(collection)
+      ActiveModel::Serializer::CollectionSerializer.new(collection, serializer: serializer)
+    end
+  end
+end

data/lib/resourcey/serializer.rb

@@ -0,0 +1,8 @@
+require 'active_model_serializers'
+require 'active_model/serializer'
+
+module Resourcey
+  class Serializer < ActiveModel::Serializer
+    attribute :id
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: resourcey
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- polakowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+description: Lightweight utility to create simple JSON Apis
+email: marek.polakowski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/resourcey.rb
+- lib/resourcey/config.rb
+- lib/resourcey/controller.rb
+- lib/resourcey/serializer.rb
+homepage: http://rubygems.org/gems/resourcey
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+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: resourcey
+test_files: []