unival 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f131f2b231fa0981cc0dcdbf9a4c2c66e6a01c2
-  data.tar.gz: f909669d667ae23c4126135c99373270cda9b2a6
+  metadata.gz: 0204bad560f1a43b5a28a93df8e85b043d5cd774
+  data.tar.gz: cb8513fbd798e2a01a63577c5b387a9f608a2198
 SHA512:
-  metadata.gz: ab72aa119283e6b348bb7d1a0113f8dce488871e3f0eeba0cd8f62afd7ea85e464b5fb2fe7d310643dcc1c06ed5fea4d9c1b54b8ad8956b9f9fe1321e4e95308
-  data.tar.gz: 0873880dde74259563b8e0498a9144f1d934baf7da48c6a632bce5652a824b96a2734f27d24e517822e6dcdf6bfb47c126f6f05f701378240c4742e2da181378
+  metadata.gz: 741ebc19adb0a168780646444b0c296752ee6f1181542a688ac31162a632b2cad07791f84fc7d8beff639a523b7a4561f2bb6201f4c158d7f9c8611f61fa1650
+  data.tar.gz: 6f6d53b4ac06a4c5fac071069085b4d0188012667b659a46cb8db44cf01756493b377729e87f1d77e0fed41f404a19569baa91d8084b35ee40376c57eeac4506

data/.travis.yml

@@ -0,0 +1,9 @@
+gemfile:
+  - gemfiles/Gemfile.rails-3.2.x
+  - gemfiles/Gemfile.rails-4.1.x
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+cache: bundler
+sudo: false

data/Gemfile

@@ -6,7 +6,7 @@ source "http://rubygems.org"
 #   $ BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1.x bundle exec rake
 #
 # etc.
-gem 'activemodel', "> 3"
+gem 'activemodel', "~> 3"
 gem 'rack', '~> 1.4'
 
 # Add dependencies to develop your gem here.

data/README.md

@@ -36,6 +36,15 @@ full-on replace assignment).
 
 will give the same response as the POST example, except that `is_create` will be set to `true`.
 
+## Translations
+
+If you have I18n enabled, and you have enabled translation introspection, you will receive the translation keys instead of the
+translated error strings. To set up translation introspection, make sure that the I18n backend you use supports introspection:
+
+    class << I18n.backend
+      include I18n::Backend::Metadata
+    end
+
 ## Concerns
 
 This approach is relatively insecure as it allows for probing. Use something like `Rack::Attack` to limit the number of

data/gemfiles/Gemfile.rails-3.2.x

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+gem 'activemodel', "> 3", '< 4'
+gem 'rack', '~> 1.4'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'activerecord', "~> 3", '< 4'
+  gem 'rack-test'
+  gem 'rake', '~> 10.0'
+  gem 'yard'
+  gem 'sqlite3'
+  gem "rspec", "~> 3.4"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", '~> 2.1'
+end

data/gemfiles/Gemfile.rails-4.1.x

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+gem 'activemodel', "> 3"
+gem 'rack', '~> 1.4'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'activerecord', "~> 4"
+  gem 'rack-test'
+  gem 'rake', '~> 10.0'
+  gem 'yard'
+  gem 'sqlite3'
+  gem "rspec", "~> 3.4"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", '~> 2.1'
+end

data/lib/unival.rb

@@ -1,4 +1,5 @@
 module Unival
   require_relative 'unival/version'
+  require_relative 'unival/utils'
   require_relative 'unival/app'
 end

data/lib/unival/app.rb

@@ -1,9 +1,10 @@
 require 'json'
 
 class Unival::App
+  include Unival::Utils
+  
   SUPPORTED_METHODS = %w( PUT POST PATCH )
   Inv = Class.new(StandardError)
-  
   def call(env)
     req = Rack::Request.new(env)
     
@@ -17,27 +18,26 @@ class Unival::App
     
     query_params = extract_query_or_route_params_from(req)
     
-    model_class_name = query_params.delete('model')
-    raise Inv, "No model class given (by default passed as the `model' query-string param)" unless model_class_name.present?
-  
-    model_class = Kernel.const_get(model_class_name)
-    raise Inv, "Invalid model or model not permitted" unless model_accessible?(model_class)
+    model_module_name = query_params.delete('model')
+    raise Inv, "No model class given (by default passed as the `model' query-string param)" if model_module_name.to_s.empty?
+    
+    model_module = Kernel.const_get(model_module_name)
+    raise Inv, "Invalid model or model not permitted" unless model_accessible?(model_module)
     
     model = if req.post?
-      raise Inv, "The model module does not support .new" unless model_class.respond_to?(:new)
-      model_class.new
+      raise Inv, "The model module does not support .new" unless model_module.respond_to?(:new)
+      model_module.new
     else
       model_id = query_params.delete('id')
       raise Inv, "No model ID to find given (by default passed as the `id' query-string param)" unless model_id
-      raise Inv, "The model module does not support .find" unless model_class.respond_to?(:find)
-      model_class.find(model_id)
+      raise Inv, "The model module does not support .find" unless model_module.respond_to?(:find)
+      model_module.find(model_id)
     end
     
-    model_data = if query_params['format'].to_s.downcase == 'jquery'
-      repack_jquery_serialization(model_class_name, params)
-    else
-      params
-    end
+    # Instead of scanning for instance_methods, check the object itself.
+    raise Inv, "The model (#{model.class}) does not support `#valid?'" unless model.respond_to?(:valid?)
+    
+    model_data = filter_model_params(model_module, params)
     
     # Instead of scanning for instance_methods, check the object itself.
     raise Inv, "The model does not support `#valid?'" unless model.respond_to?(:valid?)
@@ -47,23 +47,22 @@ class Unival::App
     
     is_create = req.post?
     if model.valid?
-      d = {model: model_class.to_s, is_create: is_create, valid: true, errors: nil}
+      d = {model: model_module.to_s, is_create: is_create, valid: true, errors: nil}
       [200, {'Content-Type' => 'application/json'}, [JSON.dump(d)]]
     else
-      d = {model: model_class.to_s, is_create: is_create, valid: false, errors: model.errors.as_json}
+      model_errors = replace_with_translation_keys(model.errors.as_json)
+      d = {model: model_module.to_s, is_create: is_create, valid: false, errors: model_errors}
       [409, {'Content-Type' => 'application/json'}, [JSON.dump(d)]]
     end
   rescue Exception => e
     if e.to_s =~ /NotFound/
       d = {error: "Model not found: #{e}"}
       [404, {'Content-Type' => 'application/json'}, [JSON.dump(d)]]
-    elsif e === Inv
+    elsif e.is_a?(Inv)
       d = {error: e.message}
       [400, {'Content-Type' => 'application/json'}, [JSON.dump(d)]]
-      []
     else
-      d = {error: e.message}
-      [502, {'Content-Type' => 'application/json'}, [JSON.dump(d)]]
+      raise e # Something we can't handle internally, raise it up the stack for eventual exception capture in middleware
     end
   end
 
@@ -73,30 +72,23 @@ class Unival::App
     true
   end
   
-  # Logs the exception for later use
-  def log_exception(e)
-    $stderr.puts e.message
+  # Replaces the literal strings in the model errors (furnished as
+  # a json-able Hash with arbitrary nesting) with the I18n keys.
+  # Only gets performed if the translation introspection module is present
+  # on the I18n backend currently in use.
+  def replace_with_translation_keys(model_errors)
+    return model_errors if internationalized?
+    deep_translation_replace(model_errors)
+  end
+  
+  # Can be used to do optional parameter filtering.
+  # If you want to use strong parameters, this is the place to apply them.
+  def filter_model_params(model_module, params)
+    params
   end
   
   # Extract params like :format, :id and :model
   def extract_query_or_route_params_from(rack_request)
     Rack::Utils.parse_nested_query(rack_request.query_string)
   end
-
-  # Hackishly use Rack to reconstruct a hash of keys-values, with nesting
-  def repack_jquery_serialization(model_class_name, jquery_array_of_fields)
-    reassembled_query = jquery_array_of_fields.map do |elem|
-      Rack::Utils.escape(elem.fetch('name')) + '=' + Rack::Utils.escape(elem.fetch('value'))
-    end.join('&')
-  
-    param_hash = Rack::Utils.parse_nested_query(reassembled_query)
-  
-    raise "The resulting parametric object must be a Hash" unless param_hash.is_a?(Hash)
-    raise "The resulting parametric object must have 1 key" unless param_hash.keys.one?
-    object_params = param_hash.fetch(param_hash.keys[0])
-
-    raise "The resulting unwrapped object params must be a Hash" unless object_params.is_a?(Hash)
-  
-    return object_params.with_indifferent_access
-  end
 end

data/lib/unival/utils.rb

@@ -0,0 +1,19 @@
+module Unival::Utils
+  def deep_translation_replace(v)
+    if v.is_a?(Array)
+      v.map{|e| deep_translation_replace(e) }
+    elsif v.is_a?(Hash)
+      v.each_with_object({}){|(k, v), o| o[deep_translation_replace(k)] = deep_translation_replace(v) }
+    else
+      if v.respond_to?(:translation_metadata)
+        v.translation_metadata.fetch(:key)
+      else
+        v
+      end
+    end
+  end
+
+  def internationalized?
+    !defined?(I18n) || !I18n.backend
+  end
+end

data/lib/unival/version.rb

@@ -1,3 +1,3 @@
 module Unival
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/app_spec.rb

@@ -4,10 +4,42 @@ require 'rack/test'
 require 'active_record'
 require 'sqlite3'
 
-describe 'Unival full-stack' do
+describe 'Unival app' do
   include Rack::Test::Methods
   let(:app) { Unival::App.new }
   
+  describe 'with a model module that supports the proper methods' do
+    module SomeModel
+      class UserData < Struct.new(:name)
+        def valid?
+          name == 'John'
+        end
+        
+        def errors
+          ['name is wrong']
+        end
+      end
+      
+      def self.find(id)
+        return SomeModel
+      end
+    end
+  end
+  
+  describe 'with a model module that returns nil from find()' do
+    module NilReturningModel
+      def self.find(id); end
+    end
+    
+    it 'returns a 400 and explains what happened' do
+      put '/?id=123&model=NilReturningModel', JSON.dump({name: 'Julik', email: 'julik@example.com'})
+    
+      expect(last_response).not_to be_ok
+      parsed = JSON.parse(last_response.body, symbolize_names: true)
+      expect(parsed).to eq({:error=>"The model (NilClass) does not support `#valid?'"})
+    end
+  end
+  
   describe 'with a class that gives a nonsensical to_json' do
     class Nonsense
       def self.to_json(encoder)
@@ -31,4 +63,30 @@ describe 'Unival full-stack' do
       expect(parsed).to eq({:model => "Nonsense", :is_create => true, :valid => true, :errors => nil})
     end
   end
+  
+  describe 'with enabled I18n that provides introspection' do
+    it 'replaces errors with their keys' do
+      fake_errors = [
+        double('missing field error string', translation_metadata: {key: 'missing.field'})
+      ]
+      
+      module TranslatedModel
+      end
+      
+      fake_model = double('Translated model with errors')
+      
+      expect(TranslatedModel).to receive(:new).and_return(fake_model) 
+
+      expect(fake_model).to receive(:attributes=)
+      expect(fake_model).to receive(:valid?).and_return(false)
+      expect(fake_model).to receive(:errors).and_return(fake_errors)
+      expect(fake_errors).to receive(:as_json).and_return(fake_errors)
+      
+      post '/?model=TranslatedModel', JSON.dump({name: 'Julik', email: 'julik@example.com'})
+      
+      parsed = JSON.parse(last_response.body, symbolize_names: true)
+      expect(last_response).not_to be_ok
+      expect(parsed[:errors]).to eq(["missing.field"])
+    end
+  end
 end

data/spec/full_stack_spec.rb

@@ -10,12 +10,7 @@ describe 'Unival full-stack' do
   
   # This is a full-stack speck, so we are going to do real ActiveRecord and stuff.
   before :all do
-    
-    if ActiveRecord::VERSION::MAJOR < 4
-      ActiveRecord::Base.establish_connection(adapter: 'sqlite3', dbfile: ':memory:')
-    else
-      ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
-    end
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
     
     ActiveRecord::Schema.define do
       create_table :people do |t|
@@ -56,8 +51,8 @@ describe 'Unival full-stack' do
     john = Person.create name: 'John', email: 'john@example.com'
     
     post '/?model=Person', JSON.dump({name: 'John', email: 'another-john@example.com'})
-    parsed = JSON.parse(last_response.body, symbolize_names: true)
     
+    parsed = JSON.parse(last_response.body, symbolize_names: true)
     expect(last_response).not_to be_ok
     expect(last_response.status).to eq(409)
     expect(parsed).to eq({
@@ -97,7 +92,7 @@ describe 'Unival full-stack' do
     
     let(:app) { MoreRestrictive.new }
     
-    it 'performs validation in raw JSON format for a new record and returns an error if the saving would cause a duplicate' do
+    it 'performs validation for a model that is permitted, but forbids it for a model that is not' do
       post '/?model=Person', JSON.dump({name: 'John', email: 'john@example.com'})
       expect(last_response).to be_ok
       

data/spec/spec_helper.rb

@@ -4,5 +4,5 @@ require 'rspec'
 require 'unival'
 
 RSpec.configure do |config|
-  
+  config.order = 'random'
 end

data/unival.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: unival 0.0.2 ruby lib
+# stub: unival 0.0.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "unival"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2016-05-19"
+  s.date = "2016-05-23"
   s.description = " A minimal endpoint for driving server-side validations from a remote UI "
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [
@@ -21,12 +21,16 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
+    "gemfiles/Gemfile.rails-3.2.x",
+    "gemfiles/Gemfile.rails-4.1.x",
     "lib/unival.rb",
     "lib/unival/app.rb",
+    "lib/unival/utils.rb",
     "lib/unival/version.rb",
     "spec/app_spec.rb",
     "spec/full_stack_spec.rb",
@@ -45,7 +49,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activemodel>, ["> 3"])
       s.add_runtime_dependency(%q<rack>, ["~> 1.4"])
-      s.add_development_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, ["~> 4"])
       s.add_development_dependency(%q<rack-test>, [">= 0"])
       s.add_development_dependency(%q<rake>, ["~> 10.0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
@@ -56,7 +60,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<activemodel>, ["> 3"])
       s.add_dependency(%q<rack>, ["~> 1.4"])
-      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<activerecord>, ["~> 4"])
       s.add_dependency(%q<rack-test>, [">= 0"])
       s.add_dependency(%q<rake>, ["~> 10.0"])
       s.add_dependency(%q<yard>, [">= 0"])
@@ -68,7 +72,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<activemodel>, ["> 3"])
     s.add_dependency(%q<rack>, ["~> 1.4"])
-    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<activerecord>, ["~> 4"])
     s.add_dependency(%q<rack-test>, [">= 0"])
     s.add_dependency(%q<rake>, ["~> 10.0"])
     s.add_dependency(%q<yard>, [">= 0"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unival
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -42,16 +42,16 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -161,12 +161,16 @@ extra_rdoc_files:
 files:
 - ".document"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/Gemfile.rails-3.2.x
+- gemfiles/Gemfile.rails-4.1.x
 - lib/unival.rb
 - lib/unival/app.rb
+- lib/unival/utils.rb
 - lib/unival/version.rb
 - spec/app_spec.rb
 - spec/full_stack_spec.rb