resourcey 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5348dbbfc10aec535cb095b78c129e9c8156c307
-  data.tar.gz: e7bd3e77e11450f4ea48bf33df1159fccce6360c
+  metadata.gz: 08220e7540269d7c02a3058371dbc684b12769b2
+  data.tar.gz: ff2a774f66ebce7bf4b0126dcea60d57a9c7c0fa
 SHA512:
-  metadata.gz: 2ebf6b3b8b417a0b155a6f228cc7f20a321bbe405286c8bd4fc6a241bb49fecca8fc2589c2c59e0084d30e5b1489b4f3257151aebf3aa2fc62936ae1366d3163
-  data.tar.gz: cc7c5945c9020292441d3886e53d35575f53a379b63a335e944505e05d748b82805543b7a041df698a2eb046f44ea14576cdb16035ef3757d71b5b7bb3b4a2a2
+  metadata.gz: 1ac82cee0ce23c84eec113fc7a949cb6c5b0167ae549ee9d939416ca8a28eca76feedf0a847ca02e8a5ddd0e88e438f1261e9e466ebdef25e7372a699cabca6b
+  data.tar.gz: 8920071fe981a532febb3248a650ec750ab89de5b7b7a95cfc63e17f090e63b0670efdfa1482d4e94ce656256a8de8247225d087d83eae4d5b6d33fd6f365877

data/README.md

@@ -1,9 +1,10 @@
 # Resourcey
-![Gem Version](https://img.shields.io/gem/v/resourcey.svg?label=version&colorB=43bd15) ![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)
+![Gem Version](https://img.shields.io/gem/v/resourcey.svg?label=version&colorB=43bd15) ![Test coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg) ![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)
 
 A lightweight rails gem for building resource-based APIs.
 
 ### Table of contents
+- [Requirements](#requirements)
 - [Installation](#installation)
 - [Usage](#usage)
   - [Controller](#controller)
@@ -14,6 +15,9 @@ A lightweight rails gem for building resource-based APIs.
 - [Configuration](#configuration)
 - [Contributing](#contributing)
 
+## Requirements
+Resourcey requires ruby 2.2.2 or higher.
+
 ## Installation
 Add Resourcey to your `Gemfile`:
 ```ruby
@@ -104,15 +108,18 @@ Resourcey.configure do |config|
 end
 ```
 
-### Available config variables
-- `default_paginator` - name of paginator that will be used in every controller, if not configured on controller-level (default: `:paged`)
+#### Available config variables
+| **config var** | **description**| **default** |
+| --- | --- | --- |
+| `default_paginator` | Name of paginator that will be used in every controller, if not configured on controller-level. Click [here](/docs/PAGINATION.md) for details. | `:paged`
+| `controller_parent` | Class or class name of controller, that `Resourcey::Controller` will inherit from. | `ActionController::Base` |
 
 ## Contributing
 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
+- ruby 2.2.2 or higher
+- bundler gem
 
 ### Running local tests
 - rspec

data/lib/resourcey/config.rb

@@ -1,9 +1,23 @@
+require 'action_controller'
+
 module Resourcey
   class Config
     attr_accessor :default_paginator
+    attr_reader :controller_parent
 
     def initialize
       self.default_paginator = :paged
+      self.controller_parent = ActionController::Base
+    end
+
+    def controller_parent=(value)
+      return @controller_parent = value if value.class == Class
+
+      begin
+        @controller_parent = value.to_s.constantize
+      rescue
+        raise Errors::RuntimeError.new("#{value} is not a valid class name")
+      end
     end
   end
 

data/lib/resourcey/controller.rb

@@ -1,7 +1,7 @@
 require 'resourcey/controller_modules'
 
 module Resourcey
-  class Controller < ActionController::Base
+  class Controller < Resourcey.config.controller_parent
     include Resourcey::ControllerFiltering
     include Resourcey::ControllerPagination
     include Resourcey::ControllerModel

data/lib/resourcey/errors.rb

@@ -5,5 +5,6 @@ module Resourcey
     class NotImplemented < BaseError; end
     class ClassNotFound < BaseError; end
     class OptionNotAllowed < BaseError; end
+    class RuntimeError < BaseError; end
   end
 end

data/lib/resourcey/initializer.rb

@@ -0,0 +1,7 @@
+module Resourcey
+  class Initializer < Rails::Railtie
+    initializer 'resourcey.load_controller', after: :load_config_initializers do
+      require 'resourcey/controller'
+    end
+  end
+end

data/lib/resourcey.rb

@@ -1,9 +1,9 @@
-require 'action_controller'
+require 'rails'
 
 require 'resourcey/errors'
 require 'resourcey/config'
-require 'resourcey/controller'
 require 'resourcey/serializer'
 require 'resourcey/paginator'
 require 'resourcey/filter'
 require 'resourcey/filter_processor'
+require 'resourcey/initializer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resourcey
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - polakowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,6 +97,7 @@ files:
 - lib/resourcey/errors.rb
 - lib/resourcey/filter.rb
 - lib/resourcey/filter_processor.rb
+- lib/resourcey/initializer.rb
 - lib/resourcey/paginator.rb
 - lib/resourcey/serializer.rb
 homepage: https://github.com/polakowski/resourcey
@@ -111,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -119,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: resourcey