collection_json_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 240dd9d091a8eb659286c677b94d636751e337aa
+  data.tar.gz: 147e1d601de30be39add7146439d904f16d690e8
+SHA512:
+  metadata.gz: 8a726a16a1b3090e749d53bb2e35b21de897c98615aa1124a6193db1141c88e0fa0f2048a6983b76584af30e891e5f06ce1481119b89dc2cebe060478d6e0c8b
+  data.tar.gz: c51c2ceca97f4348e4404a029d78cd914471121553c78e22c22f9090f6145231fe0e09a6a2f5afbc6bd7a438378f120706f2c94ae8f36b9f2cee2081b47107e0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in collection_json_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Carles Jove i Buxeda
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+CollectionJson Rails
+====================
+
+This gem will add Rails specific features to [CollectionJson
+Serializer](https://github.com/carlesjove/collection_json_serializer).
+
+## Features
+
+#### Parsing of incoming templates:
+
+It integrates with strong parameters. `accept_template!` accepts one argument:
+the name of the model. That is what you would usually pass at the `require()`
+method of strong parameters. This will parse the incoming template as params,
+and return the result of `params.require(:model)`. Then, you can just proceed as
+usual.
+
+```ruby
+class PostsController < ApplicationController
+  include CollectionJson::Rails::AcceptTemplate
+
+  private
+
+  def post_params
+    accept_template!(:post).permit(:title)
+  end
+```
+
+## TO-DO Features
+
+#### One step serialization:
+
+```ruby
+class PostsController < ApplicationController
+  include CollectionJson::Rails::Render
+
+  def index
+    @posts = Post.all
+
+    render json: @posts, status: :ok
+  end
+```
+
+#### Generators:
+
+```bash
+$ rails g cj:serializer post
+# => app/serializers/post_serializer.rb
+```
+
+Wonder: should be invocated by scaffold, models, etc. generators?
+
+#### URLs helpers
+
+No more fighting with routes generation:
+
+```ruby
+class PostSerializer < CollectionJson::Serializer
+  href :posts_url
+
+  items do
+    href :post_url, :self
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'collection_json_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install collection_json_rails
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/collection_json_rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test
+

data/collection_json_rails.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'collection_json_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "collection_json_rails"
+  spec.version       = CollectionJson::Rails::VERSION
+  spec.authors       = ["Carles Jove i Buxeda"]
+  spec.email         = ["hola@carlus.cat"]
+  spec.summary       = %q{Collection+JSON Serializers with the Rails touch}
+  spec.description   = %q{Adds Rails specific funcionalitaties for an enjoyable
+  experience}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionpack", "~> 4.0"
+  spec.add_dependency "railties", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/collection_json_rails.rb

@@ -0,0 +1,4 @@
+require "collection_json_rails/version"
+
+require "collection_json_rails/action_controller/accept_template"
+

data/lib/collection_json_rails/action_controller/accept_template.rb

@@ -0,0 +1,35 @@
+module CollectionJson::Rails
+  module AcceptTemplate
+    def accept_template!(key)
+      return params.require(key) unless template_is_valid?
+      parse_template_as_params!(params, key).require(key)
+    end
+
+    private
+
+    def template_is_valid?
+      params.key?(:template) && params[:template].key?(:data)
+    end
+
+    # Parses a Collection+JSON template as the params Rails expects
+    #
+    # "template": {
+    #   "data": [
+    #     { "name": "title", "value": "Best title ever" }
+    #   ]
+    # }
+    #
+    # "key_name": {
+    #   "title": "Best title ever"
+    # }
+    def parse_template_as_params!(params, key)
+      params[:template][:data].each do |d|
+        params[key] = Hash.new unless params.key?(key)
+        params[key][d[:name]] = d[:value]
+      end
+
+      params
+    end
+  end
+end
+

data/lib/collection_json_rails/version.rb

@@ -0,0 +1,5 @@
+module CollectionJson
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/test/controller/accept_template_test.rb

@@ -0,0 +1,32 @@
+require 'minitest_helper'
+
+class PostsController < ActionController::Base
+  include CollectionJson::Rails::AcceptTemplate
+
+  def create
+    accept_template!(:post).permit(:title, :body)
+    head :ok
+  end
+end
+
+class TestAcceptTemplate < ActionController::TestCase
+  tests PostsController
+
+  def setup
+    @template = {
+      template: {
+        data: [
+          { name: "title", value: "My Post Title" },
+          { name: "body", value: "This is my first Post" }
+        ]
+      }
+    }
+  end
+
+  def test_that_incoming_templates_are_accepted
+    post :create, @template
+
+    assert_response :ok
+  end
+end
+

data/test/minitest_helper.rb

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rails'
+require 'action_controller'
+
+require 'collection_json_rails'
+
+require 'minitest/autorun'
+
+module ActionController
+  SharedTestRoutes = ActionDispatch::Routing::RouteSet.new
+  SharedTestRoutes.draw do
+    post ':controller(/:action)'
+  end
+
+  class Base
+    include ActionController::Testing
+    include SharedTestRoutes.url_helpers
+  end
+
+  class ActionController::TestCase
+    setup do
+      @routes = SharedTestRoutes
+    end
+  end
+end
+

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: collection_json_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Carles Jove i Buxeda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: |-
+  Adds Rails specific funcionalitaties for an enjoyable
+    experience
+email:
+- hola@carlus.cat
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- collection_json_rails.gemspec
+- lib/collection_json_rails.rb
+- lib/collection_json_rails/action_controller/accept_template.rb
+- lib/collection_json_rails/version.rb
+- test/controller/accept_template_test.rb
+- test/minitest_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Collection+JSON Serializers with the Rails touch
+test_files:
+- test/controller/accept_template_test.rb
+- test/minitest_helper.rb
+has_rdoc: