publicize 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-06-11
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/publicize.rb
+lib/activerecord_extensions.rb
+test/test_helper.rb
+test/test_publicize.rb

data/README.rdoc

@@ -0,0 +1,57 @@
+= publicize
+
+* http://github.com/#{github_username}/#{project_name}
+
+== DESCRIPTION:
+
+The Publicize gem extends ActiveRecord to support features commonly needed
+by Rails-based web services. When creating a web service, Publicize allows
+developers to specify how models will be exposed and, equally important,
+what fields will be exposed.
+
+== FEATURES/PROBLEMS:
+
+XML generation does not currently work.
+
+== SYNOPSIS:
+
+Examples to be provided later.
+
+== REQUIREMENTS:
+
+* Allows developers to specify the name under which a model will be exposed.
+* Allows developers to specify which fields will be exposed.
+* Allow developers to specify alternate names for exposed fields, i.e. - the
+  web service may expose friendlier names than the underlying database.
+* Allows developers to expose "virtual" fields for a web service, i.e. - the
+  output of a method can be publicized, not just database-derived model
+  attributes.
+
+== INSTALL:
+
+* gem install publicize
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 MetroStar Systems
+
+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/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/publicize'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'publicize' do
+  self.developer 'David Keener', 'dkeener@keenertech.com'
+  self.rubyforge_name       = self.name
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/activerecord_extensions.rb

@@ -0,0 +1,111 @@
+require 'active_record'
+
+module Publicize
+  module ActiveRecordExtensions
+
+    PublicizedField = Struct.new(:name, :label)
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+      base.send(:include, InstanceMethods)
+      base.class_eval do
+        attr_accessor :controller
+      end
+    end
+
+    module ClassMethods
+
+      # Defines a field to be publicized. This may be a "virtual" field, i.e. -
+      # it may be a method rather than a database-derived class attribute.
+
+      def publicize_field(name, opts={})
+        publicized_fields << PublicizedField.new(name, opts[:as].nil? ? name : opts[:as])
+      end
+
+      # Defines whether 1) the resource is publicized, and 2) optionally under
+      # which name.
+
+      def publicize_model(name = self.name)
+        @publicized_name = name.to_s.downcase.dasherize
+        @publicized = true
+      end
+      
+      # Indicates whether the model has been publicized or not.
+      
+      def is_publicized?
+        @publicized.nil? ? false : true
+      end
+
+      # Gets an array of the fields specified to be publicized.
+
+      def publicized_fields
+        @publicized_fields ||= []
+      end
+
+      # Gets the name under which a model will be publicized. Defaults to the
+      # name of the model itself.
+
+      def publicized_name
+        @publicized_name || self.name.downcase.dasherize
+      end
+      
+      # Returns the PublicizedField structure associated with the specified
+      # label.
+      
+      def select_publicized_field(label)
+        publicized_fields.select {|x| x.label.to_s == label.to_s}
+      end
+
+    end
+
+    module InstanceMethods
+      
+      def as_json(options = {})
+        if self.class.is_publicized?
+
+          # Based on ActiveRecord setting, do {"name" : {"field1" : "value1", ...}}
+          if ActiveRecord::Base.include_root_in_json == true
+            {self.class.publicized_name => publicize.as_json(options)}
+          else
+            publicize.as_json(options)
+          end
+
+        else
+          super(options)
+        end
+      end
+      
+      def to_xml(options = {})
+        if self.class.is_publicized?
+          xml = options[:builder] ||= Builder::XmlMarkup.new(options)
+          xml.instruct! unless options[:skip_instruct]
+          xml.level_one do
+            xml.tag!(:test, 'content')
+          end
+        else
+          super(options)
+        end
+      end
+      
+      # Generates an ordered hash containing publicized fields for a class
+      # instance. Not generally used directly by end users of the gem.
+      
+      def publicize
+        if !self.class.is_publicized?
+          logger.warn("WARNING (Publicize): Attempted to publicize an unpublicized model")
+          return nil
+        end
+        # TODO: Can switch to a regular hash when using Ruby 1.9
+        hsh = ActiveSupport::OrderedHash.new
+        self.class.publicized_fields.each do |pf|
+          hsh[pf.label.nil? ? pf.name : pf.label] = ((v = eval(pf.name.to_s)).nil? ? '' : v)
+        end
+        hsh
+      end
+      
+    end
+    
+  end
+end
+
+ActiveRecord::Base.send(:include, Publicize::ActiveRecordExtensions)

data/lib/publicize.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'activerecord_extensions'
+
+module Publicize
+  VERSION = '0.0.1'
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/publicize'

data/test/test_publicize.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestPublicize < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: publicize
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Keener
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-21 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 6
+        - 2
+        version: 2.6.2
+  type: :development
+  version_requirements: *id002
+description: |-
+  The Publicize gem extends ActiveRecord to support features commonly needed
+  by Rails-based web services. When creating a web service, Publicize allows
+  developers to specify how models will be exposed and, equally important,
+  what fields will be exposed.
+email: 
+- dkeener@keenertech.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/publicize.rb
+- lib/activerecord_extensions.rb
+- test/test_helper.rb
+- test/test_publicize.rb
+has_rdoc: true
+homepage: http://github.com/#{github_username}/#{project_name}
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: publicize
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: The Publicize gem extends ActiveRecord to support features commonly needed by Rails-based web services
+test_files: 
+- test/test_helper.rb
+- test/test_publicize.rb