unveil 0.1.4 → 0.1.5

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    unveil (0.1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activerecord (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    i18n (0.6.1)
+    multi_json (1.6.0)
+    rake (10.0.3)
+    sqlite3 (1.3.7)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bundler
+  rake
+  sqlite3
+  unveil!

data/HISTORY.md

@@ -0,0 +1,24 @@
+History
+=======
+
+0.1.5 - February 22, 2013
+-------------------------
++ Modernize the gem by adding Bundler and using modern gem conventions
++ Add Travis CI
+
+0.1.4 - February 15, 2011
+-------------------------
++ Fix a bug where scopes are available to all models
+
+0.1.3 - February 15, 2011
+-------------------------
++ Write tests for old features
++ Allow named scopes (e.g. @post.unveil(:with_comments))
++ Allow calling unveil on an object even if unveil wasn't called in the model
++ Write tests for new features
++ Document the installation process in the README
++ Document the :include option in the README
+
+0.1.2 - January 13, 2011
+------------------------
+This was the first real version, so it introduced the basic functionality.

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Shaun Chapman
+
+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,174 @@
+Unveil
+======
+[![Build Status](https://travis-ci.org/shaunchapman/unveil.png?branch=master)](https://travis-ci.org/shaunchapman/unveil)
+
+Unveil provides a super simple way to specify which of a model's attributes are available to an API in a Ruby on Rails application.
+
+
+Usage
+-----
+The basic usage is as follows:
+
+1. In your model, specify which attributes should be available to the API:
+
+        class User < ActiveRecord::Base
+          unveil :only => [:id, :first_name, :last_name, :email], :methods => :name
+
+          def name
+            "#{first_name} #{last_name}"
+          end
+        end
+
+2. In your controller, call `unveil`:
+
+        class UsersController < ApplicationController
+          def index
+            @users = User.all
+
+            respond_to do |format|
+              format.html
+              format.json { render :json => @users.unveil }
+              format.xml  { render :xml => @users.unveil }
+            end
+          end
+
+          def show
+            @user = User.find(params[:id])
+
+            respond_to do |format|
+              format.html
+              format.json { render :json => @user.unveil }
+              format.xml  { render :xml => @user.unveil }
+            end
+          end
+        end
+
+
+### Create named scopes
+
+This following will create a named scope `:authenticated` in addition to the default scope:
+
+    class User < ActiveRecord::Base
+      unveil :only => [:id, :first_name, :last_name]
+      unveil :authenticated
+    end
+
+Example:
+
+    >> User.first.unveil
+    => {"id" => 1, "first_name" => "John", "last_name" => "Smith"}
+    >> User.first.unveil(:authenticated)
+    => {"id" => 1, "first_name" => "John", "last_name" => "Smith", :email => "johnsmith@example.com"}
+
+
+### Include associated records
+
+    class Post < ActiveRecord::Base
+      unveil :only => [:id, :title, :body]
+
+      unveil :with_comments,
+        :only => [:id, :title, :body],
+        :include => {
+          :comments => {
+            :except => :user_id,
+            :include => {
+              :user => {
+                :only => [:id, :username],
+                :methods => [:name, :picture_url]
+              }
+            }
+          }
+        }
+    end
+
+Calling `Post.all.unveil(:with_comments)` might return something like:
+
+    [
+      {
+        "id" => 1,
+        "title" => "Best Post Ever",
+        "body" => "This is the post.",
+        "comments" => [
+          {
+            "id": 1,
+            "body": "First comment",
+            "user": {
+              "id": 3,
+              "username": "forrestgump",
+              "name": "Forrest Gump",
+              "picture_url": "http://example.com/images/user_pictures/3.jpg"
+            }
+          },
+          {
+            "id": 2,
+            "body": "Second comment",
+            "user": {
+              "id": 1,
+              "username": "johnsmith",
+              "name": "John Smith",
+              "picture_url": "http://example.com/images/user_pictures/1.jpg"
+            }
+          }
+        ]
+      },
+      {
+        "id" => 2,
+        "title" => "Second Best Post Ever",
+        "body" => "This is a post without comments.",
+        "comments" => []
+      }
+    ]
+
+
+### Override at any time
+
+You can pass an options hash to `unveil` at any time (e.g. in a controller) if you need to fine tune what's returned for a specific object:
+
+    if @user == current_user
+      render :json => @user.unveil
+    else
+      render :json => @user.unveil(:except => [:birthday, :email])
+    end
+
+Unveil uses [serializable_hash](http://rubydoc.info/docs/rails/ActiveModel/Serialization) so you can send any parameters to `unveil` that
+`serializable_hash` accepts.
+
+
+### What's returned
+
++ Calling `unveil` on an object will return a hash, so you can do with it anything you can do with a hash:
+
+        >> post = Post.new
+        => #<Post id: nil, title: nil, body: nil, views: nil, created_at: nil, updated_at: nil>
+        >> post.attribute_names
+        => ["body", "created_at", "title", "updated_at", "views"]
+        >> post.unveil.keys
+        => ["body", "title"]
+
++ Calling `unveil` on an array of objects returns an array of hashes.
+
+
+Installation
+------------
+Install the gem with Bundler:
+
+1. Add the following to your `Gemfile`:
+
+        gem 'unveil'
+
+2. Run:
+
+        bundle install
+
+Or install the gem with RubyGems:
+
+    gem install unveil
+
+Or install as a Rails plugin:
+
+    rails plugin install git@github.com:shaunchapman/unveil.git
+
+
+License
+-------
+Copyright (c) 2011 Shaun Chapman. See LICENSE for details.

data/Rakefile

@@ -1,6 +1,7 @@
-require 'rake'
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'rake/rdoctask'
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -12,12 +13,3 @@ Rake::TestTask.new(:test) do |t|
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
-
-desc 'Generate documentation for the unveil plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Unveil'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'lib', 'unveil')

data/lib/unveil/version.rb

@@ -0,0 +1,3 @@
+module Unveil
+  VERSION = '0.1.5'
+end

data/test/test_helper.rb

@@ -14,7 +14,7 @@ def load_schema
   # Create the fixtures
   fixtures = ActiveRecord::Schema.tables
   fixtures.delete('schema_migrations')
-  Fixtures.create_fixtures(File.dirname(__FILE__) + '/fixtures', fixtures)
+  ActiveRecord::Fixtures.create_fixtures(File.dirname(__FILE__) + '/fixtures', fixtures)
 
   # Require Unveil
   require File.dirname(__FILE__) + '/../init'

data/unveil.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/unveil/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'unveil'
+  gem.version       = Unveil::VERSION
+
+  gem.authors       = ['Shaun Chapman']
+  gem.email         = ['shaunchapman@gmail.com']
+  gem.description   = %q{Unveil provides a super simple way to specify which of a model's attributes are available to an API in a Ruby on Rails application.}
+  gem.summary       = %q{Build custom objects for use in an API}
+  gem.homepage      = 'https://github.com/shaunchapman/unveil'
+
+  # Dependencies
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'activerecord'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'sqlite3'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

metadata

@@ -1,71 +1,138 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: unveil
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 4
-  version: 0.1.4
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Shaun Chapman
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-15 00:00:00 -05:00
-default_executable: 
-dependencies: []
-
-description: Unveil provides a super simple way to specify which of a model's attributes are available to an API in a Ruby on Rails application.
-email: shaunchapman@gmail.com
+date: 2013-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: activerecord
+  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: 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: sqlite3
+  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: Unveil provides a super simple way to specify which of a model's attributes
+  are available to an API in a Ruby on Rails application.
+email:
+- shaunchapman@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- HISTORY.md
+- LICENSE
+- README.md
 - Rakefile
+- init.rb
+- lib/unveil.rb
 - lib/unveil/core_ext.rb
 - lib/unveil/error.rb
-- lib/unveil.rb
+- lib/unveil/version.rb
 - test/fixtures/users.yml
 - test/schema.rb
 - test/test_helper.rb
 - test/unveil_test.rb
-has_rdoc: true
-homepage: http://github.com/shaunchapman/unveil
+- unveil.gemspec
+homepage: https://github.com/shaunchapman/unveil
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -2556614104741764564
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -2556614104741764564
 requirements: []
-
-rubyforge_project: unveil
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Build custom objects for use in an API
-test_files: []
-
+test_files:
+- test/fixtures/users.yml
+- test/schema.rb
+- test/test_helper.rb
+- test/unveil_test.rb