simple-api-field-control 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e687ba0705ce4cf319e8e418d694bfc7facff7c
-  data.tar.gz: 3fc6ca4df295129f21af751c21b5fdfad23cb89d
+  metadata.gz: 439ff260bc4fe9699898e09688a52959297e1033
+  data.tar.gz: 1f3313fdaa62fd02705c237cfd16bc7576ae47f1
 SHA512:
-  metadata.gz: fc139af6699b179e4ac2840a5ea67a098fc9864585748f7c3d0cdc01d9659279c709f34fae1b97ed03c22a198966a32d7176ab7319a6aeb62f3fce4ac694730e
-  data.tar.gz: 6101163b030952b2a326b4a7944259b8bb4e90d0e68d541d81adb3aea938620a97c21745f0416642cb22825f932623c8488625d87281a4c888306454efe7b95d
+  metadata.gz: f24980accd66b1465fd64e29d56d8b90ccf0fa7bbf55919c301ce87b1276b289dd4f1706dce4f50b8bc80767d0598edde3d03a1f7db55099c8889d546304a5a0
+  data.tar.gz: 846dc43ae0bc55af4b7d2d535bfa79ac913bed42ebea93df59560bfe285789a2f5e5969ef5cb7c64f8fd43fd4b811b14f508fc3ae57e2047565defca87bd29b4

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -4,7 +4,7 @@ gem "activesupport", ">= 3.0"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
-group :development do
+group :development, :test do
   gem "activerecord", ">= 3.0"
   gem "rspec", "~> 2.8.0"
   gem "shoulda", ">= 0"
@@ -17,3 +17,7 @@ group :development do
   gem "json_spec", "~> 1.1.1"
   gem "nokogiri", ">= 1.5"
 end
+
+group :test do
+  gem "rake", "10.1.0"
+end

data/Gemfile.lock

@@ -100,6 +100,7 @@ DEPENDENCIES
   jeweler (= 1.8.7)
   json_spec (~> 1.1.1)
   nokogiri (>= 1.5)
+  rake (= 10.1.0)
   rdoc (~> 3.12)
   rspec (~> 2.8.0)
   shoulda

data/README.md

@@ -1,12 +1,15 @@
 # simple-api-field-control
 
-Ever needed to simply include a few calculated fields/virtual attributes/custom methods in your serialization? This gem makes it simple and supports both JSON and XML rendering.
+[![Gem Version](https://badge.fury.io/rb/simple-api-field-control.png)](http://badge.fury.io/rb/simple-api-field-control)
+[![Build Status](https://travis-ci.org/tkrajcar/simple-api-field-control.png?branch=master)](https://travis-ci.org/tkrajcar/simple-api-field-control)
+
+Ever needed to simply include or exclude a few calculated fields/virtual attributes/custom methods in your serialization? This gem makes it simple and supports both JSON and XML rendering.
 
 ## Usage
 
 1. Include `gem "simple-api-field-control"` in your Gemfile.
 2. In your model class where you want to use this module, add `include SimpleAPIFieldControl`.
-3. Add one or more `api_include :name_of_method` lines to your model.
+3. Add one or more `api_include :name_of_method` or `api_exclude :name_of_method` lines to your model.
 
 
 Example model file:
@@ -15,6 +18,18 @@ Example model file:
 class Post < ActiveRecord::Base
   include SimpleAPIFieldControl
 
+  # schema:
+  # create_table :posts, :force => true do |t|
+  #   t.string :subject
+  #   t.string :api_key
+  #   t.string :other_secret
+  # end
+
+  api_include :subject_length
+  api_include :subject_words
+  api_exclude :api_key
+  api_exclude :other_secret
+
   def subject_length
     self.subject.length
   end
@@ -22,23 +37,20 @@ class Post < ActiveRecord::Base
   def subject_words
     self.subject.split(' ').length
   end
-
-  api_include :subject_length
-  api_include :subject_words
 end
 ```
 
 Example output:
 
 ```
-p = Post.create!(subject: "Hello, people!")
-=> #<Post id: 2, subject: "Hello, people!">
+p = Post.create!(subject: "Hello, people!", api_key: "foo", other_secret: "bar")
+=> #<Post id: 1, subject: "Hello, people!", api_key: "foo", other_secret: "bar">
 puts p.to_json
-=> {"id":2,"subject":"Hello, people!","subject_length":14,"subject_words":2}
+{"id":1,"subject":"Hello, people!","subject_length":14,"subject_words":2}
 puts p.to_xml
 => <?xml version="1.0" encoding="UTF-8"?>
 <post>
-  <id type="integer">2</id>
+  <id type="integer">1</id>
   <subject>Hello, people!</subject>
   <subject-length type="NilClass">14</subject-length>
   <subject-words type="NilClass">2</subject-words>

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "simple-api-field-control"
   gem.homepage = "http://github.com/tkrajcar/simple-api-field-control"
   gem.license = "MIT"
-  gem.summary = "Simple DSL for ActiveRecord objects to include virtual attributes/custom methods in to_json/to_xml."
-  gem.description = "Ever needed to simply include a few calculated fields/virtual attributes/custom methods in your serialization? This gem makes it simple and supports both JSON and XML rendering."
+  gem.summary = "A simple DSL for ActiveRecord objects to include/exclude virtual attributes/custom methods in to_json/to_xml."
+  gem.description = "A simple DSL for ActiveRecord objects to include/exclude virtual attributes/custom methods in to_json/to_xml."
   gem.email = "allegro@conmolto.org"
   gem.authors = ["Tim Krajcar"]
   # dependencies defined in Gemfile
@@ -31,7 +31,7 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task :default => :test
+task :default => :spec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/simple-api-field-control.rb

@@ -5,10 +5,11 @@ module SimpleAPIFieldControl
 
   included do
     class_attribute :api_include_fields
+    class_attribute :api_exclude_fields
   end
 
   def serializable_hash(options = nil)
-    options = { methods: self.class.api_include_fields }.merge(options || {})
+    options = { methods: self.class.api_include_fields, except: api_exclude_fields }.merge(options || {})
     super(options)
   end
 
@@ -17,5 +18,10 @@ module SimpleAPIFieldControl
       self.api_include_fields ||= []
       self.api_include_fields << field
     end
+
+    def api_exclude(field)
+      self.api_exclude_fields ||= []
+      self.api_exclude_fields << field
+    end
   end
 end

data/simple-api-field-control.gemspec

@@ -0,0 +1,87 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "simple-api-field-control"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Krajcar"]
+  s.date = "2013-08-19"
+  s.description = "A simple DSL for ActiveRecord objects to include/exclude virtual attributes/custom methods in to_json/to_xml."
+  s.email = "allegro@conmolto.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/simple-api-field-control.rb",
+    "simple-api-field-control.gemspec",
+    "spec/Post.rb",
+    "spec/active-record-setup.rb",
+    "spec/simple-api-field-control_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/tkrajcar/simple-api-field-control"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "A simple DSL for ActiveRecord objects to include/exclude virtual attributes/custom methods in to_json/to_xml."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0"])
+      s.add_development_dependency(%q<activerecord>, [">= 3.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["= 1.8.7"])
+      s.add_development_dependency(%q<git>, ["= 1.2.5"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<json_spec>, ["~> 1.1.1"])
+      s.add_development_dependency(%q<nokogiri>, [">= 1.5"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0"])
+      s.add_dependency(%q<activerecord>, [">= 3.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["= 1.8.7"])
+      s.add_dependency(%q<git>, ["= 1.2.5"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<json_spec>, ["~> 1.1.1"])
+      s.add_dependency(%q<nokogiri>, [">= 1.5"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0"])
+    s.add_dependency(%q<activerecord>, [">= 3.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["= 1.8.7"])
+    s.add_dependency(%q<git>, ["= 1.2.5"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<json_spec>, ["~> 1.1.1"])
+    s.add_dependency(%q<nokogiri>, [">= 1.5"])
+  end
+end
+

data/spec/Post.rb

@@ -1,8 +1,17 @@
 class Post < ActiveRecord::Base
   include SimpleAPIFieldControl
 
+  # schema:
+  # create_table :posts, :force => true do |t|
+  #   t.string :subject
+  #   t.string :api_key
+  #   t.string :other_secret
+  # end
+
   api_include :subject_length
   api_include :subject_words
+  api_exclude :api_key
+  api_exclude :other_secret
 
   def subject_length
     self.subject.length

data/spec/active-record-setup.rb

@@ -9,5 +9,7 @@ ActiveRecord::Schema.define do
   self.verbose = false
   create_table :posts, :force => true do |t|
     t.string :subject
+    t.string :api_key
+    t.string :other_secret
   end
 end

data/spec/simple-api-field-control_spec.rb

@@ -2,7 +2,10 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Simple API Field Control" do
   before(:all) do
-    @post = Post.create!(subject: "Test Post")
+    @post = Post.create!(subject: "Test Post", api_key: "foo", other_secret: "bar")
+    @json = @post.to_json
+    @xml = Nokogiri::XML::Document.parse(@post.to_xml)
+
   end
 
   it "should know its subject length" do
@@ -13,16 +16,27 @@ describe "Simple API Field Control" do
     @post.subject_words.should eq 2
   end
 
-  it "should serialize to JSON with subject_length and subject_words included" do
-    json = @post.to_json
-    json.should have_json_path("subject_length")
-    json.should have_json_path("subject_words")
+  context "JSON serialization" do
+    it "should occur with subject_length and subject_words" do
+      @json.should have_json_path("subject_length")
+      @json.should have_json_path("subject_words")
+    end
+
+    it "should occur without api_key or other_secret" do
+      @json.should_not have_json_path("api_key")
+      @json.should_not have_json_path("other_secret")
+    end
   end
 
-  it "should serialize to XML with subject_length and subject_words included" do
-    #xml = @post.to_xml
-    doc = Nokogiri::XML::Document.parse(@post.to_xml)
-    doc.xpath('//subject-length').text.should eq('9')
-    doc.xpath('//subject-words').text.should eq('2')
+  context "XML serialization" do
+    it "should occur with subject_length and subject_words" do
+      @xml.xpath('//subject-length').text.should eq('9')
+      @xml.xpath('//subject-words').text.should eq('2')
+    end
+
+    it "should occur without api_key or other_secret" do
+      @xml.xpath('//api-key').text.should eq("")
+      @xml.xpath('//other-secret').text.should eq("")
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-api-field-control
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Krajcar
@@ -178,9 +178,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '1.5'
-description: Ever needed to simply include a few calculated fields/virtual attributes/custom
-  methods in your serialization? This gem makes it simple and supports both JSON and
-  XML rendering.
+description: A simple DSL for ActiveRecord objects to include/exclude virtual attributes/custom
+  methods in to_json/to_xml.
 email: allegro@conmolto.org
 executables: []
 extensions: []
@@ -190,6 +189,7 @@ extra_rdoc_files:
 files:
 - .document
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -197,6 +197,7 @@ files:
 - Rakefile
 - VERSION
 - lib/simple-api-field-control.rb
+- simple-api-field-control.gemspec
 - spec/Post.rb
 - spec/active-record-setup.rb
 - spec/simple-api-field-control_spec.rb
@@ -224,6 +225,6 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Simple DSL for ActiveRecord objects to include virtual attributes/custom
+summary: A simple DSL for ActiveRecord objects to include/exclude virtual attributes/custom
   methods in to_json/to_xml.
 test_files: []