acts_as_api 0.0.1

data/History.txt

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

data/Manifest.txt

@@ -0,0 +1,16 @@
+README.rdoc
+History.txt
+Manifest.txt
+PostInstall.txt
+Rakefile
+lib/acts_as_api.rb
+lib/acts_as_api/array.rb
+lib/acts_as_api/base.rb
+lib/acts_as_api/rendering.rb
+script/console
+script/destroy
+script/generate
+spec/acts_as_api_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on acts_as_api, see http://acts_as_api.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,49 @@
+= acts_as_api
+
+* http://github.com/ffwdme/acts_as_api
+
+
+== DESCRIPTION:
+
+acts_as_api makes creating XML/JSON responses in Rails 3 easy and fun.
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  See example app :)
+
+== REQUIREMENTS:
+
+* Rails 3 beta 4
+
+== INSTALL:
+
+    sudo gem install acts_as_api
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Christian Bäuerlein
+
+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,28 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/acts_as_api'
+
+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 'acts_as_api' do
+  self.developer 'Christian Bäuerlein', 'christian@ffwdme.com'
+  #self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  #self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['activerecord','>= 3.0.0.beta4'], ['actionpack','>= 3.0.0.beta4']]
+
+end
+
+require 'newgem/tasks'
+# In Netbeans the next lines causes every rspec test to run twice.
+# If you're not using Netbeans and having problem with testing - try to disable it.
+#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/acts_as_api.rb

@@ -0,0 +1,35 @@
+require "rubygems"
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "acts_as_api/base"
+require "acts_as_api/rendering"
+require "acts_as_api/array"
+
+# acts_as_api is a gem that aims to make the construction of JSON and XML
+# responses in rails 3 easy and fun.
+#
+# Therefore it attaches a couple of helper methods to active record and
+# the action controller base classes.
+#
+# acts_as_api uses the default serializers of your rails app and doesn't
+# force you into more dependencies.
+module ActsAsApi
+  VERSION = '0.0.1'
+
+  # The accepted response formats
+  # Default is +[:xml, :json]+
+  ACCEPTED_API_FORMATS = [:xml, :json]
+
+end
+
+# Attach ourselves to active record
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend ActsAsApi::Base
+end
+
+# Attach ourselves to the abstract controller of rails
+if defined?(AbstractController::Rendering)
+  AbstractController::Rendering.send :include, ActsAsApi::Rendering
+end

data/lib/acts_as_api/array.rb

@@ -0,0 +1,25 @@
+# The standard ruby Array class is extended by one method.
+class Array
+
+  # Neccessary to render an Array of models, e.g. the result of a search.
+  #
+  # The Array checks all its items if they respond to the +as_api_response+ method.
+  # If they do, the result of this method will be collected.
+  # If they don't, the item itself will be collected.
+  def as_api_response
+
+    sub_items = []
+
+    each do |item|
+      if item.respond_to?(:as_api_response)
+        sub_items << item.as_api_response
+      else
+        sub_items << item
+      end
+    end
+
+    sub_items
+
+  end
+
+end

data/lib/acts_as_api/base.rb

@@ -0,0 +1,115 @@
+module ActsAsApi
+  # This module enriches the ActiveRecord::Base module of Rails.
+  module Base
+    # Indicates if the current model acts as api.
+    # False by default.
+    def acts_as_api?
+      false
+    end
+
+    # When invoked, it enriches the current model with the
+    # class and instance methods to act as api.
+    def acts_as_api
+
+      class_eval do
+        include ActsAsApi::Base::InstanceMethods
+        extend ActsAsApi::Base::ClassMethods
+      end
+
+    end
+
+    module ClassMethods
+
+      def acts_as_api?#:nodoc:
+        self.included_modules.include?(InstanceMethods)
+      end
+
+      # Determines the attributes, methods of the model that are accessible in the api response.
+      # *Note*: There is only whitelisting for api accessible attributes.
+      # So once the model acts as api, you have to determine all attributes here that should
+      # be contained in the api responses.
+      def api_accessible(*attributes)
+        write_inheritable_attribute(:api_accessible, Set.new(attributes) + (api_accessible_attributes || []))
+      end
+
+      # Returns an array of all the attributes that have been made accessible to the api response.
+      def api_accessible_attributes
+        read_inheritable_attribute(:api_accessible)
+      end
+
+    end
+
+
+    module InstanceMethods
+
+      # Creates the api response of the model and returns it as a Hash.
+      def as_api_response
+        api_attributes = self.class.api_accessible_attributes
+
+        api_output = {}
+
+        return api_output if api_attributes.nil?
+
+        api_attributes.each do |attribute|
+
+          case attribute
+          when Symbol
+
+            if self.respond_to?(attribute)
+              out = send attribute
+
+              if out.respond_to?(:as_api_response)
+                out = out.send(:as_api_response)
+              end
+
+              api_output[attribute] = out
+
+            end
+
+          when Hash
+
+            queue = []
+            queue << { :parent =>  api_output, :item => attribute}
+
+            until queue.empty? do
+
+              leaf = queue.pop
+
+              leaf[:item].each do |k,v|
+
+                case v
+                when Symbol
+
+                  if self.respond_to?(v)
+                    out = send v
+
+                    if out.respond_to?(:as_api_response)
+                      out = out.send(:as_api_response)
+                    end
+
+                    leaf[:parent][k] = out
+
+                  end
+
+                when Hash
+                  leaf[:parent][k] ||= {}
+                  queue << { :parent =>  leaf[:parent][k], :item => v}
+                end
+
+              end
+
+            end
+
+          end
+          
+        end
+
+        api_output
+
+      end
+      
+    end
+
+
+  end
+end

data/lib/acts_as_api/rendering.rb

@@ -0,0 +1,43 @@
+module ActsAsApi
+
+  # The methods of this module are included into the AbstractController::Rendering
+  # module.
+  module Rendering
+
+    # Provides an alternative to the +render+ method used within the controller
+    # to simply generate API outputs.
+    #
+    # The default Rails serializers are used to serialize the data.
+    def render_for_api(render_options)
+
+      # extract the api format and model
+      api_format_options = {}
+
+      ActsAsApi::ACCEPTED_API_FORMATS.each do |item|
+        if render_options.has_key?(item)
+          api_format_options[item] = render_options[item]
+          render_options.delete item
+        end
+      end
+
+
+      api_format =  api_format_options.keys.first
+      api_model =  api_format_options.values.first
+
+      # set the params to render
+      output_params = render_options
+
+      # set the name of the root node - pluralize for arrays
+      api_root_name = api_model.is_a?(Array) ? api_model.first.class.name.downcase.pluralize : api_model.class.name.downcase
+      output_params[:root] = api_root_name
+
+      # create the Hash as response
+      output_params[api_format] = api_model.as_api_response
+
+      render output_params
+
+    end
+
+  end
+  
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/acts_as_api.rb'}"
+puts "Loading acts_as_api gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/acts_as_api_spec.rb

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "setting up acts_as_api" do
+
+  before(:each) do
+    @luke = Customer.new({ :firstname => 'Luke', :lastname => 'Skywalker', :age => 25, :active => true  })
+    @han  = Customer.new({ :firstname => 'Han',  :lastname => 'Solo',      :age => 35, :active => true  })
+    @leia = Customer.new({ :firstname => 'Princess',  :lastname => 'Leia', :age => 25, :active => false })
+
+    # always reset the api_accessible values
+    Customer.write_inheritable_attribute(:api_accessible, Set.new )
+  end
+  
+  it "should be disabled by default" do
+    Customer.acts_as_api?.should be_false
+    Customer.should_not respond_to :api_accessible
+    # now enable it
+    Customer.acts_as_api
+    # should respond now
+    Customer.acts_as_api?.should be_true
+    Customer.should respond_to :api_accessible
+  end
+
+  it "check simple attributes list" do
+
+    Customer.api_accessible :firstname, :lastname
+
+    response = @luke.as_api_response
+
+    response.should be_kind_of(Hash)
+
+    response.should have(2).keys
+
+    response.keys.should include(:firstname, :lastname)
+
+    response.values.should include(@luke.firstname, @luke.lastname)
+
+  end
+
+  it "check method call in attributes list" do
+
+    Customer.api_accessible :full_name
+
+    response = @luke.as_api_response
+
+    response.should be_kind_of(Hash)
+
+    response.should have(1).keys
+
+    response.keys.should include(:full_name)
+
+    response.values.should include(@luke.full_name)
+
+  end
+
+  
+  it "check renaming the node/key of an attribute" do
+
+  end
+
+  it "check renaming the node/key of a method" do
+
+  end
+
+  it "check included associations in attributes list (DON'T act_as_api themselves)" do
+    
+  end
+
+
+  it "check included associations in attributes list (DO act_as_api themselves)" do
+
+  end
+
+  it "check creating a sub node and putting an attribute in it" do
+
+  end
+
+
+
+  it "check creating multiple sub nodes and putting an attribute in it" do
+
+  end
+
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'rubygems'
+require 'active_support'
+require 'active_record'
+require 'action_controller'
+
+require 'acts_as_api'
+
+require 'spec_models'
+

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Christian B\xC3\xA4uerlein"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-30 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  type: :development
+  version_requirements: *id004
+description: acts_as_api makes creating XML/JSON responses in Rails 3 easy and fun.
+email: 
+- christian@ffwdme.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- README.rdoc
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- Rakefile
+- lib/acts_as_api.rb
+- lib/acts_as_api/array.rb
+- lib/acts_as_api/base.rb
+- lib/acts_as_api/rendering.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/acts_as_api_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/ffwdme/acts_as_api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: acts_as_api
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: acts_as_api makes creating XML/JSON responses in Rails 3 easy and fun.
+test_files: []
+