has_response 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Tom Benner
+
+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,157 @@
+Has Response
+============
+Extremely simple API support for Rails models
+
+Description
+-----------
+
+Has Response provides very simple support for turning model instances into JSONifiable hashes for use in API responses. The hashes contain only the attributes that are specified, and they can contain hashes of N-order associations as well.
+
+Installation
+------------
+
+Add Has Response to your Gemfile:
+
+```ruby
+gem 'has_response'
+```
+
+Usage
+-----
+
+Include HasResponse and define to\_response in your model:
+
+```ruby
+class User < ActiveRecord::Base
+  include HasResponse
+
+  def to_response
+    {
+      id: id,
+      username: username,
+      avatar_url: avatar.url(:thumb)
+    }
+  end
+end
+```
+
+There's nothing special here yet, but you can now return JSON of users more easily in controllers:
+
+```ruby
+class UsersController < ApplicationController
+  def show
+    user = User.find(params[:id])
+    render :json => user.to_response
+  end
+end
+```
+
+
+Say you want to include the user's Location in your response, too. Set up Location:
+
+```ruby
+class Location < ActiveRecord::Base
+  include HasResponse
+
+  def to_response
+    {
+      id: id,
+      city: city,
+      state: state
+    }
+  end
+end
+```
+
+And the association:
+
+```ruby
+class User < ActiveRecord::Base
+  #...
+  belongs_to :location
+  #...
+end
+```
+
+Then change `user.to_response` to:
+
+```ruby
+user.to_response_with(:location)
+```
+
+This will return:
+
+```ruby
+{
+  id: 1,
+  username: "johndoe",
+  avatar_url: "http://mysite.com/myavatar.jpg",
+  location: {
+    id: 1,
+    city: "San Francisco",
+    state: "CA"
+  }
+}
+```
+
+If you want to add additional columns or method values to any responses, those can be included just like associations are included.  If User responds to a method named `posts_count`, you can easily include that, too:
+
+```ruby
+user.to_response_with(:location, :posts_count)
+```
+
+This will return:
+
+```ruby
+{
+  id: 1,
+  username: "johndoe",
+  avatar_url: "http://mysite.com/myavatar.jpg",
+  location: {
+    id: 1,
+    city: "San Francisco",
+    state: "CA"
+  },
+  posts_count: 2
+}
+```
+
+You can include associations of N-order.  To include a User's Posts, and those Posts' Comments, including their User, use:
+
+```ruby
+user.to_response_with(:location, :posts => {:comments => :user})
+```
+
+This will return:
+
+```ruby
+{
+  id: 1,
+  username: "johndoe",
+  avatar_url: "http://mysite.com/myavatar.jpg",
+  location: ...,
+  posts: [
+    {
+      id: 1,
+      title: "My First Post",
+      content: "My first post!",
+      comments: [
+        {
+          id: 1,
+          content: "Great post!",
+          user: {
+            id: 2,
+            username: "Jane Doe",
+            avatar_url: "http://mysite.com/myavatar.jpg"
+          }
+        }
+      ]
+    }
+  ]
+}
+```
+
+License
+-------
+
+Has Response is released under the MIT License. Please see the MIT-LICENSE file for details.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasResponse'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/has_response/version.rb

@@ -0,0 +1,3 @@
+module HasResponse
+  VERSION = '0.0.1'
+end

data/lib/has_response.rb

@@ -0,0 +1,4 @@
+module HasResponse
+end
+
+require File.expand_path(File.join('..', '..', 'app', 'concerns', 'has_response.rb'), __FILE__)

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: has_response
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tom Benner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extremely simple API support for Rails models
+email:
+- tombenner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/has_response/version.rb
+- lib/has_response.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/tombenner/has_response
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Extremely simple API support for Rails models
+test_files: []