standardapi 5.0.0.rc1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32b4ca6314bc038faf8b73560d327096f4c4bf53
-  data.tar.gz: 1162cb994c7921a7ffc4eea033a40b0e5f4f50b5
+  metadata.gz: b36f880979bf42f01bf760a716e446580c28e640
+  data.tar.gz: bf9b2403a472cc7e3aa27a7accb8123dbf8d81a8
 SHA512:
-  metadata.gz: deaa898296ded369ca9c9b2289eaab9c803977d9f51f5283bf20d546da33b41e9d6fa2c7750195a9c438a87b59434f29fd0eca79421bce83db6774244276456c
-  data.tar.gz: eaeb860e977eee866a9f98ce6ef4b10f697a95a2a6d3e33a286fc390e45102fc287b3139c14ab1a6868b04a115deacabe745c15286f11de76ab86922f6a440c8
+  metadata.gz: 1c407ac90c71b0d6c43806c064b8b74c0b19ecbe2b2d842b6d0bade57303061e4d56b633c4948d5ee9642407ebcc4cb67693e2224c9a51cb6181fea2855ca3be
+  data.tar.gz: 542ef97bdf8d1cd448bb245c334c04d246e86a9827af2fd9eed918df5201d12b36b273f156ade841bcd8cc31a5cda7181b336de86fb477ebb51581b530589d6e

data/README.md

@@ -1,6 +1,7 @@
 # StandardAPI
 
-StandardAPI makes it easy to expose a query interface for your Rails models
+StandardAPI makes it easy to expost a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)
+interface to your Rails models.
 
 # Installation
 
@@ -10,15 +11,79 @@ In your Gemfile
 
     gem 'standardapi', require: 'standard_api'
 
-StandardAPI is a module you can include into any controllers you want to have
-API access to, or in the ApplicationController, giving all inherited controller
-access.
+# Usage
+
+StandardAPI is a module that can be included into any controller to expose a API
+for. Alternatly, it can be included into `ApplicationController`, giving all
+inherited controllers an exposed API.
 
     class ApplicationController < ActiveController::Base
         include StandardAPI::Controller
 
     end
 
+By default any paramaters passed to update and create are whitelisted with by
+the method named after the model the controller represents. For example, the
+following will only allow the `caption` attribute of the `Photo` model to be
+updated.
+
+    class PhotosController < ApplicationController
+      include StandardAPI
+      
+      def photo_params
+        [:caption]
+      end
+    end
+
+If greater control of the allowed paramaters is required, the `model_params`
+method can be overridden. It simply returns a set of `StrongParameters`.
+
+    class PhotosController < ApplicationController
+      include StandardAPI
+      
+      def model_params
+        if @photo.author == current_user
+          [:caption]
+        else
+          [:comment]
+        end
+      end
+    end
+
+Similarly, the ordering and includes (including of relationships in the reponse)
+is whitelisted as well.
+
+Full Example:
+
+    class PhotosController < ApplicationController
+      including StandardAPI
+
+      # Allowed paramaters
+      def photo_params
+        [:caption]
+      end
+
+      # Allowed orderings
+      def photo_orders
+        [:id, :created_at, :updated_at]
+      end
+
+      # Allowed includes
+      def photo_includes
+        { author: [:photos] }
+      end
+
+    end
+
+Note how includes can also support nested includes. So in this case when
+including the author, the photos that the author took can also be included.
+
+# Interface Specification
+
+# Testing
+
+##
+
 And example contoller and it's tests.
 
     class PhotosController < ApplicationController

data/lib/standard_api/controller.rb

@@ -44,6 +44,7 @@ module StandardAPI
     end
 
     def create
+      puts model_params.inspect
       record = model.new(model_params)
       instance_variable_set("@#{model.model_name.singular}", record)
       

data/lib/standard_api/helpers.rb

@@ -59,7 +59,7 @@ module StandardAPI
     
     def cached_at_columns_for_includes(includes)
       includes.select{|k,v| ![:where, :limit, :order].include?(k.to_sym) }.map { |k, v|
-        ["#{k}_cached_at"] + cached_at_columns_for_includes(v).map{|v| "#{k}_#{v}"}
+        ["#{k}_cached_at"] + cached_at_columns_for_includes(v).map { |v2| "#{k}_#{v2}" }
       }.flatten
     end
     

data/lib/standard_api/test_case.rb

@@ -11,14 +11,21 @@ require File.expand_path(File.join(__FILE__, '../test_case/update_tests'))
 module StandardAPI::TestCase
       
   def self.included(klass)
-    model_class_name = klass.controller_class.name.gsub(/Controller$/, '').singularize
+    begin
+      controller_class_name = klass.name.gsub(/Test$/, '')
+      controller_class = controller_class_name.constantize 
+    rescue NameError => e
+      raise e if e.message != "uninitialized constant #{controller_class_name}"
+    end
 
     [:filters, :orders, :includes].each do |attribute|
       klass.send(:class_attribute, attribute)
     end
 
     begin
+      model_class_name = klass.name.gsub(/ControllerTest$/, '').singularize
       model_class = model_class_name.constantize
+
       klass.send(:filters=, model_class.attribute_names)
       klass.send(:orders=, model_class.attribute_names)
       klass.send(:includes=, model_class.reflect_on_all_associations.map(&:name))
@@ -34,6 +41,7 @@ module StandardAPI::TestCase
       acc
     end
 
+
     klass.controller_class.action_methods.each do |action|
       if const_defined?("StandardAPI::TestCase::#{action.capitalize}Tests") && routes[klass.controller_class.controller_path][action]
         klass.include("StandardAPI::TestCase::#{action.capitalize}Tests".constantize)

data/lib/standard_api/test_case/update_tests.rb

@@ -43,7 +43,7 @@ module StandardAPI
         attrs = attributes_for(singular_name, :nested).select{|k,v| !model.readonly_attributes.include?(k.to_s) }
         create_webmocks(attrs)
         put :update, params: {:id => m.id, singular_name => attrs}, format: :json
-        assert_response :ok
+        assert_response :ok, "Updating #{m.class.name} with #{attrs.inspect}"
 
         # (m.attribute_names & attrs.keys.map(&:to_s)).each do |test_key|
         view_attributes(m.reload).select { |x| attrs.keys.map(&:to_s).include?(x) }.each do |key, value|
@@ -78,7 +78,8 @@ module StandardAPI
           create_webmocks(attrs)
 
           put :update, params: {:id => m.id, :include => includes, singular_name => attrs}, format: :json
-
+          assert_response :ok, "Updating #{m.class.name} with #{attrs.inspect}"
+        
           json = JSON.parse(response.body)
           includes.each do |included|
             assert json.key?(included.to_s), "#{included.inspect} not included in response"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standardapi
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc1
+  version: 5.0.0
 platform: ruby
 authors:
 - James Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,84 +16,120 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: activerecord-sort
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: activerecord-filter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: jbuilder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +256,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  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'
 description: StandardAPI makes it easy to expose a query interface for your Rails
   models
 email:
@@ -269,9 +319,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1