reidiculous-actionwebservice-client 3.0.4

data/Rakefile

@@ -0,0 +1,180 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require File.join(File.dirname(__FILE__), 'lib', 'action_web_service', 'version')
+
+PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+PKG_NAME      = 'actionwebservice'
+PKG_VERSION   = ActionWebService::VERSION::STRING + PKG_BUILD
+PKG_FILE_NAME   = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_DESTINATION = ENV["RAILS_PKG_DESTINATION"] || "../#{PKG_NAME}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = "aws"
+RUBY_FORGE_USER    = "webster132"
+
+desc "Default Task"
+task :default => [ :test ]
+
+
+# Run the unit tests
+Rake::TestTask.new { |t|
+  t.libs << "test"
+  t.test_files = Dir['test/*_test.rb']
+  t.verbose = true
+}
+
+SCHEMA_PATH = File.join(File.dirname(__FILE__), *%w(test fixtures db_definitions))
+
+desc 'Build the MySQL test database'
+task :build_database do 
+  %x( mysqladmin -uroot create actionwebservice_unittest )
+  %x( mysql -uroot actionwebservice_unittest < #{File.join(SCHEMA_PATH, 'mysql.sql')} )
+end
+
+desc 'Build the sqlite3 test database'
+task :build_sqlite3_database do
+  filename = 'actionwebservice_unittest.db'
+  File.delete filename if File.exist? filename
+  %x(sqlite3 #{filename}  < #{File.join(SCHEMA_PATH, 'sqlite3.sql')})
+end
+
+
+# Generate the RDoc documentation
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "Action Web Service -- Web services for Action Pack"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('CHANGELOG')
+  rdoc.rdoc_files.include('lib/action_web_service.rb')
+  rdoc.rdoc_files.include('lib/action_web_service/*.rb')
+  rdoc.rdoc_files.include('lib/action_web_service/api/*.rb')
+  rdoc.rdoc_files.include('lib/action_web_service/client/*.rb')
+  rdoc.rdoc_files.include('lib/action_web_service/container/*.rb')
+  rdoc.rdoc_files.include('lib/action_web_service/dispatcher/*.rb')
+  rdoc.rdoc_files.include('lib/action_web_service/protocol/*.rb')
+  rdoc.rdoc_files.include('lib/action_web_service/support/*.rb')
+}
+
+
+# Create compressed packages
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = PKG_NAME
+  s.summary = "Web service support for Action Pack."
+  s.description = %q{Adds WSDL/SOAP and XML-RPC web service support to Action Pack}
+  s.version = PKG_VERSION
+
+  s.author = "Leon Breedt, Kent Sibilev"
+  s.email = "bitserf@gmail.com, ksibilev@yahoo.com"
+  s.rubyforge_project = "aws"
+  s.homepage = "http://www.rubyonrails.org"
+
+  s.add_dependency('actionpack', '= 2.3.5' + PKG_BUILD)
+  s.add_dependency('activerecord', '= 2.3.5' + PKG_BUILD)
+
+  s.has_rdoc = true
+  s.requirements << 'none'
+  s.require_path = 'lib'
+  s.autorequire = 'actionwebservice'
+
+  s.files = [ "Rakefile", "setup.rb", "README", "TODO", "CHANGELOG", "MIT-LICENSE" ]
+  s.files = s.files + Dir.glob( "examples/**/*" ).delete_if { |item| item.match( /\.(svn|git)/ ) }
+  s.files = s.files + Dir.glob( "lib/**/*" ).delete_if { |item| item.match( /\.(svn|git)/ ) }
+  s.files = s.files + Dir.glob( "test/**/*" ).delete_if { |item| item.match( /\.(svn|git)/ ) }
+  s.files = s.files + Dir.glob( "generators/**/*" ).delete_if { |item| item.match( /\.(svn|git)/ ) }
+end
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+
+# Publish beta gem
+desc "Publish the API documentation"
+task :pgem => [:package] do 
+  Rake::SshFilePublisher.new("davidhh@wrath.rubyonrails.org", "public_html/gems/gems", "pkg", "#{PKG_FILE_NAME}.gem").upload
+  `ssh davidhh@wrath.rubyonrails.org './gemupdate.sh'`
+end
+
+# Publish documentation
+desc "Publish the API documentation"
+task :pdoc => [:rdoc] do 
+  Rake::SshDirPublisher.new("davidhh@wrath.rubyonrails.org", "public_html/aws", "doc").upload
+end
+
+
+def each_source_file(*args)
+	prefix, includes, excludes, open_file = args
+	prefix ||= File.dirname(__FILE__)
+	open_file = true if open_file.nil?
+	includes ||= %w[lib\/action_web_service\.rb$ lib\/action_web_service\/.*\.rb$]
+	excludes ||= %w[lib\/action_web_service\/vendor]
+	Find.find(prefix) do |file_name|
+		next if file_name =~ /\.svn/
+		file_name.gsub!(/^\.\//, '')
+		continue = false
+		includes.each do |inc|
+			if file_name.match(/#{inc}/)
+				continue = true
+				break
+			end
+		end
+		next unless continue
+		excludes.each do |exc|
+			if file_name.match(/#{exc}/)
+				continue = false
+				break
+			end
+		end
+		next unless continue
+		if open_file
+			File.open(file_name) do |f|
+				yield file_name, f
+			end
+		else
+			yield file_name
+		end
+	end
+end
+
+desc "Count lines of the AWS source code"
+task :lines do
+  total_lines = total_loc = 0
+  puts "Per File:"
+	each_source_file do |file_name, f|
+    file_lines = file_loc = 0
+    while line = f.gets
+      file_lines += 1
+      next if line =~ /^\s*$/
+      next if line =~ /^\s*#/
+      file_loc += 1
+    end
+    puts "  #{file_name}: Lines #{file_lines}, LOC #{file_loc}"
+    total_lines += file_lines
+    total_loc += file_loc
+  end
+  puts "Total:"
+  puts "  Lines #{total_lines}, LOC #{total_loc}"
+end
+
+desc "Publish the release files to RubyForge."
+task :release => [ :package ] do
+  require 'rubyforge'
+
+  packages = %w( gem tgz zip ).collect{ |ext| "pkg/#{PKG_NAME}-#{PKG_VERSION}.#{ext}" }
+
+  rubyforge = RubyForge.new
+  rubyforge.login
+  rubyforge.add_release(PKG_NAME, PKG_NAME, "REL #{PKG_VERSION}", *packages)
+end

data/TODO

@@ -0,0 +1,32 @@
+= Post-1.0
+  - Document/Literal SOAP support
+    - URL-based dispatching, URL identifies method
+
+  - Add :rest dispatching mode, a.l.a. Backpack API. Clean up dispatching
+    in general. Support vanilla XML-format as a "Rails" protocol?
+    XML::Simple deserialization into params?
+
+      web_service_dispatching_mode :rest
+
+      def method1(params)
+      end
+
+      def method2(params)
+      end
+
+
+      /ws/method1
+        <xml>
+      /ws/method2
+        <yaml>
+
+  - Allow locking down a controller to only accept messages for a particular
+    protocol.  This will allow us to generate fully conformant error messages
+    in cases where we currently fudge it if we don't know the protocol.
+
+  - Allow AWS user to participate in typecasting, so they can centralize
+    workarounds for buggy input in one place
+  
+= Refactoring
+  - Don't have clean way to go from SOAP Class object to the xsd:NAME type
+    string -- NaHi possibly looking at remedying this situation

data/lib/action_web_service.rb

@@ -0,0 +1,71 @@
+#--
+# Copyright (C) 2005 Leon Breedt
+#
+# 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.
+#++
+
+begin
+  require 'activesupport'
+  require 'actioncontroller'
+  require 'activerecord'
+  require 'activesupport'
+  require 'actionpack'
+  require 'active_support/core_ext/class/inheritable_attributes'
+  require 'action_dispatch/routing'
+rescue LoadError
+  require 'rubygems'
+  gem 'activesupport', '3.0.4'
+  gem 'actionpack', '3.0.4'
+  gem 'activerecord', '3.0.4'
+  gem 'activesupport', '3.0.4'
+end
+
+$:.unshift(File.dirname(__FILE__) + "/action_web_service/vendor/")
+
+require 'action_web_service/support/class_inheritable_options'
+require 'action_web_service/support/signature_types'
+require 'action_web_service/base'
+require 'action_web_service/client'
+require 'action_web_service/invocation'
+require 'action_web_service/api'
+require 'action_web_service/casting'
+require 'action_web_service/struct'
+require 'action_web_service/container'
+require 'action_web_service/protocol'
+require 'action_web_service/dispatcher'
+require 'action_web_service/scaffolding'
+
+ActionWebService::Base.class_eval do
+  include ActionWebService::Container::Direct
+  include ActionWebService::Invocation
+end
+
+# ActionController::Base.class_eval do
+#   include ActionWebService::Protocol::Discovery
+#   include ActionWebService::Protocol::Soap
+#   include ActionWebService::Protocol::XmlRpc
+#   include ActionWebService::Container::Direct
+#   include ActionWebService::Container::Delegated
+#   include ActionWebService::Container::ActionController
+#   include ActionWebService::Invocation
+#   include ActionWebService::Dispatcher
+#   include ActionWebService::Dispatcher::ActionController
+#   include ActionWebService::Scaffolding
+# end

data/lib/action_web_service/api.rb

@@ -0,0 +1,297 @@
+module ActionWebService # :nodoc:
+  module API # :nodoc:
+    # A web service API class specifies the methods that will be available for
+    # invocation for an API. It also contains metadata such as the method type
+    # signature hints.
+    #
+    # It is not intended to be instantiated.
+    #
+    # It is attached to web service implementation classes like
+    # ActionWebService::Base and ActionController::Base derivatives by using
+    # <tt>container.web_service_api</tt>, where <tt>container</tt> is an
+    # ActionController::Base or a ActionWebService::Base.
+    #
+    # See ActionWebService::Container::Direct::ClassMethods for an example
+    # of use.
+    class Base
+      # Whether to transform the public API method names into camel-cased names 
+      class_inheritable_option :inflect_names, true
+
+      # By default only HTTP POST requests are processed
+      class_inheritable_option :allowed_http_methods, [ :post ]
+       
+      # Whether to allow ActiveRecord::Base models in <tt>:expects</tt>.
+      # The default is +false+; you should be aware of the security implications
+      # of allowing this, and ensure that you don't allow remote callers to
+      # easily overwrite data they should not have access to.
+      class_inheritable_option :allow_active_record_expects, false
+
+      # If present, the name of a method to call when the remote caller
+      # tried to call a nonexistent method. Semantically equivalent to
+      # +method_missing+.
+      class_inheritable_option :default_api_method
+
+      # Disallow instantiation
+      private_class_method :new, :allocate
+      
+      class << self
+        include ActionWebService::SignatureTypes
+
+        # API methods have a +name+, which must be the Ruby method name to use when
+        # performing the invocation on the web service object.
+        #
+        # The signatures for the method input parameters and return value can
+        # by specified in +options+.
+        #
+        # A signature is an array of one or more parameter specifiers. 
+        # A parameter specifier can be one of the following:
+        #
+        # * A symbol or string representing one of the Action Web Service base types.
+        #   See ActionWebService::SignatureTypes for a canonical list of the base types.
+        # * The Class object of the parameter type
+        # * A single-element Array containing one of the two preceding items. This
+        #   will cause Action Web Service to treat the parameter at that position
+        #   as an array containing only values of the given type.
+        # * A Hash containing as key the name of the parameter, and as value
+        #   one of the three preceding items
+        # 
+        # If no method input parameter or method return value signatures are given,
+        # the method is assumed to take no parameters and/or return no values of
+        # interest, and any values that are received by the server will be
+        # discarded and ignored.
+        #
+        # Valid options:
+        # [<tt>:expects</tt>]             Signature for the method input parameters
+        # [<tt>:returns</tt>]             Signature for the method return value
+        # [<tt>:expects_and_returns</tt>] Signature for both input parameters and return value
+        def api_method(name, options={})
+          unless options.is_a?(Hash)
+            raise(ActionWebServiceError, "Expected a Hash for options")
+          end
+          validate_options([:expects, :returns, :expects_and_returns], options.keys)
+          if options[:expects_and_returns]
+            expects = options[:expects_and_returns]
+            returns = options[:expects_and_returns]
+          else
+            expects = options[:expects]
+            returns = options[:returns]
+          end
+          expects = canonical_signature(expects)
+          returns = canonical_signature(returns)
+          if expects
+            expects.each do |type|
+              type = type.element_type if type.is_a?(ArrayType)
+              if type.type_class.ancestors.include?(ActiveRecord::Base) && !allow_active_record_expects
+                raise(ActionWebServiceError, "ActiveRecord model classes not allowed in :expects")
+              end
+            end
+          end
+          name = name.to_sym
+          public_name = public_api_method_name(name)
+          method = Method.new(name, public_name, expects, returns)
+          write_inheritable_hash("api_methods", name => method)
+          write_inheritable_hash("api_public_method_names", public_name => name)
+        end
+
+        # Whether the given method name is a service method on this API
+        #
+        #   class ProjectsApi < ActionWebService::API::Base
+        #     api_method :getCount, :returns => [:int]
+        #   end
+        #
+        #   ProjectsApi.has_api_method?('GetCount')   #=> false
+        #   ProjectsApi.has_api_method?(:getCount)    #=> true
+        def has_api_method?(name)
+          api_methods.has_key?(name)
+        end
+  
+        # Whether the given public method name has a corresponding service method
+        # on this API
+        #
+        #   class ProjectsApi < ActionWebService::API::Base
+        #     api_method :getCount, :returns => [:int]
+        #   end
+        #
+        #   ProjectsApi.has_api_method?(:getCount)    #=> false
+        #   ProjectsApi.has_api_method?('GetCount')   #=> true
+        def has_public_api_method?(public_name)
+          api_public_method_names.has_key?(public_name)
+        end
+  
+        # The corresponding public method name for the given service method name
+        #
+        #   ProjectsApi.public_api_method_name('GetCount')  #=> "GetCount"
+        #   ProjectsApi.public_api_method_name(:getCount)   #=> "GetCount"
+        def public_api_method_name(name)
+          if inflect_names
+            name.to_s.camelize
+          else
+            name.to_s
+          end
+        end
+  
+        # The corresponding service method name for the given public method name
+        #
+        #   class ProjectsApi < ActionWebService::API::Base
+        #     api_method :getCount, :returns => [:int]
+        #   end
+        #        
+        #   ProjectsApi.api_method_name('GetCount') #=> :getCount
+        def api_method_name(public_name)
+          api_public_method_names[public_name]
+        end
+  
+        # A Hash containing all service methods on this API, and their
+        # associated metadata.
+        #
+        #   class ProjectsApi < ActionWebService::API::Base
+        #     api_method :getCount,          :returns => [:int]
+        #     api_method :getCompletedCount, :returns => [:int]
+        #   end
+        #
+        #   ProjectsApi.api_methods #=> 
+        #     {:getCount=>#<ActionWebService::API::Method:0x24379d8 ...>,
+        #      :getCompletedCount=>#<ActionWebService::API::Method:0x2437794 ...>}
+        #   ProjectsApi.api_methods[:getCount].public_name #=> "GetCount"
+        def api_methods
+          read_inheritable_attribute("api_methods") || {}
+        end
+
+        # The Method instance for the given public API method name, if any
+        #
+        #   class ProjectsApi < ActionWebService::API::Base
+        #     api_method :getCount,          :returns => [:int]
+        #     api_method :getCompletedCount, :returns => [:int]
+        #   end
+        #
+        #   ProjectsApi.public_api_method_instance('GetCount')  #=> <#<ActionWebService::API::Method:0x24379d8 ...>
+        #   ProjectsApi.public_api_method_instance(:getCount)   #=> nil
+        def public_api_method_instance(public_method_name)
+          api_method_instance(api_method_name(public_method_name))
+        end
+
+        # The Method instance for the given API method name, if any
+        #
+        #   class ProjectsApi < ActionWebService::API::Base
+        #     api_method :getCount,          :returns => [:int]
+        #     api_method :getCompletedCount, :returns => [:int]
+        #   end
+        #
+        #   ProjectsApi.api_method_instance(:getCount) #=> <ActionWebService::API::Method:0x24379d8 ...>
+        #   ProjectsApi.api_method_instance('GetCount') #=> <ActionWebService::API::Method:0x24379d8 ...>
+        def api_method_instance(method_name)
+          api_methods[method_name]
+        end
+
+        # The Method instance for the default API method, if any
+        def default_api_method_instance
+          return nil unless name = default_api_method
+          instance = read_inheritable_attribute("default_api_method_instance")
+          if instance && instance.name == name
+            return instance
+          end
+          instance = Method.new(name, public_api_method_name(name), nil, nil)
+          write_inheritable_attribute("default_api_method_instance", instance)
+          instance
+        end
+
+        private
+          def api_public_method_names
+            read_inheritable_attribute("api_public_method_names") || {}
+          end
+  
+          def validate_options(valid_option_keys, supplied_option_keys)
+            unknown_option_keys = supplied_option_keys - valid_option_keys
+            unless unknown_option_keys.empty?
+              raise(ActionWebServiceError, "Unknown options: #{unknown_option_keys}")
+            end
+          end
+      end
+    end
+
+    # Represents an API method and its associated metadata, and provides functionality
+    # to assist in commonly performed API method tasks.
+    class Method
+      attr :name
+      attr :public_name
+      attr :expects
+      attr :returns
+
+      def initialize(name, public_name, expects, returns)
+        @name = name
+        @public_name = public_name
+        @expects = expects
+        @returns = returns
+        @caster = ActionWebService::Casting::BaseCaster.new(self)
+      end
+      
+      # The list of parameter names for this method
+      def param_names
+        return [] unless @expects
+        @expects.map{ |type| type.name }
+      end
+
+      # Casts a set of Ruby values into the expected Ruby values
+      def cast_expects(params)
+        @caster.cast_expects(params)
+      end
+
+      # Cast a Ruby return value into the expected Ruby value
+      def cast_returns(return_value)
+        @caster.cast_returns(return_value)
+      end
+
+      # Returns the index of the first expected parameter
+      # with the given name
+      def expects_index_of(param_name)
+        return -1 if @expects.nil?
+        (0..(@expects.length-1)).each do |i|
+          return i if @expects[i].name.to_s == param_name.to_s
+        end
+        -1
+      end
+
+      # Returns a hash keyed by parameter name for the given
+      # parameter list
+      def expects_to_hash(params)
+        return {} if @expects.nil?
+        h = {}
+        @expects.zip(params){ |type, param| h[type.name] = param }
+        h
+      end
+
+      # Backwards compatibility with previous API
+      def [](sig_type)
+        case sig_type
+        when :expects
+          @expects.map{|x| compat_signature_entry(x)}
+        when :returns
+          @returns.map{|x| compat_signature_entry(x)}
+        end
+      end
+
+      # String representation of this method
+      def to_s
+        fqn = ""
+        fqn << (@returns ? (@returns[0].human_name(false) + " ") : "void ")
+        fqn << "#{@public_name}("
+        fqn << @expects.map{ |p| p.human_name }.join(", ") if @expects
+        fqn << ")"
+        fqn
+      end
+
+      private
+        def compat_signature_entry(entry)
+          if entry.array?
+            [compat_signature_entry(entry.element_type)]
+          else
+            if entry.spec.is_a?(Hash)
+              {entry.spec.keys.first => entry.type_class}
+            else
+              entry.type_class
+            end
+          end
+        end
+    end
+  end
+end