woahdae-consumer 0.8.1

data/History.txt

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Woody Peterson
+
+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/Manifest.txt

@@ -0,0 +1,73 @@
+History.txt
+LICENSE
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+app_generators/consumer/USAGE
+app_generators/consumer/consumer_generator.rb
+app_generators/consumer/templates/LICENSE
+app_generators/consumer/templates/README.rdoc
+app_generators/consumer/templates/Rakefile
+app_generators/consumer/templates/TODO
+app_generators/consumer/templates/config/config.yml
+app_generators/consumer/templates/config/config.yml.sample
+app_generators/consumer/templates/lib/base.rb
+app_generators/consumer/templates/rails/init.rb
+app_generators/consumer/templates/script/destroy
+app_generators/consumer/templates/script/generate
+app_generators/consumer/templates/spec/spec_helper.rb
+bin/consumer
+config/website.yml.sample
+consumer.gemspec
+consumer_generators/request/USAGE
+consumer_generators/request/request_generator.rb
+consumer_generators/request/templates/lib/request.rb
+consumer_generators/request/templates/lib/response.rb
+consumer_generators/request/templates/spec/request_spec.rb
+consumer_generators/request/templates/spec/response_spec.rb
+consumer_generators/request/templates/spec/xml/response.xml
+examples/active_record/README.txt
+examples/active_record/ar_spec.rb
+examples/active_record/database.sqlite
+examples/active_record/environment.rb
+examples/active_record/migration.rb
+examples/active_record/models/book.rb
+examples/active_record/models/contributor.rb
+examples/active_record/xml/book.xml
+examples/active_record/xml/book_with_contributors.xml
+examples/active_record/xml/contributor.xml
+examples/active_record/xml/contributor_with_books.xml
+examples/shipping/environment.rb
+examples/shipping/rate.rb
+examples/shipping/shipping.yml.sample
+examples/shipping/shipping_spec.rb
+examples/shipping/ups_rate_request.rb
+examples/shipping/ups_rate_response.xml
+lib/consumer.rb
+lib/consumer/helper.rb
+lib/consumer/mapping.rb
+lib/consumer/request.rb
+rails_generators/request/USAGE
+rails_generators/request/request_generator.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+spec/helper_spec.rb
+spec/mapping_spec.rb
+spec/request_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/xml/rate_response.xml
+spec/xml/rate_response_error.xml
+tasks/rspec.rake
+test/test_consumer_generator.rb
+test/test_consumer_plugin_request_generator.rb
+test/test_generator_helper.rb
+test/test_rails_request_generator.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,8 @@
+Getting Started with Consumer:
+  
+  consumer your_gem_name
+  cd your_gem_name
+  script/generate request
+  
+  The last command should help you get rolling.
+

data/README.rdoc

@@ -0,0 +1,53 @@
+= consumer
+
+http://consumer.rubyforge.org
+
+== DESCRIPTION:
+
+Consumer is a library for consuming xml resources via Builder, libxml, and some request sending / response marshaling glue. It comes with an app generator that creates an empty ready-for-rails gem that itself comes with a generator for making the request/response classes, config files, and specs (see script/generate after creating a new Consumer project).
+
+== FEATURES:
+
+A Consumer request class's features include required variable checks, a place for in-class and yaml defaults, a ready to use builder object for creating the xml, and a method for sending the xml to the class's request url that returns Consumer response objects.
+
+Consumer response classes get their features via mixin instead of inheritance (unlike the request classes), so it can return instances of models that already exist in your project. The main feature here is a mapping method that specifies attribute-xpath pairs to map object attributes to an xml response. Multiple mappings can exist for a class, so it can be created from a variety of xml sources. It can return a single response object or an array of response objects, and can set attributes of a response object to other response objects (i.e. it can handle associations).
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+libxml-ruby
+builder
+activesupport
+
+== INSTALL:
+
+* if you haven't already, <code>gem sources -a http://gems.github.com</code>
+* <code>sudo gem install woahdae-consumer</code>
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Woody Peterson
+
+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,30 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/consumer'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('consumer', Consumer::VERSION) do |p|
+  p.developer('Woody Peterson', 'woody.peterson@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+    ['activesupport','>= 2.0.2'],
+    ['libxml-ruby',  '>= 0.8.3'],
+    ['builder',      '>= 2.1.2']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/app_generators/consumer/USAGE

@@ -0,0 +1,14 @@
+Description:
+
+  Creates an empty ready-for-rails gem primed for consuming an xml resource via
+  Builder, libxml, and some request sending / response marshaling glue.
+  
+  Comes with a generator for making the request/response classes, config files,
+  and specs (see script/generate after creating the gem).
+  
+Usage:
+  
+  consumer your_xml_consuming_gem_name
+  
+  (there are no options)
+  

data/app_generators/consumer/consumer_generator.rb

@@ -0,0 +1,89 @@
+class ConsumerGenerator < RubiGen::Base
+
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @name = base_name
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      # Create stubs
+      # m.template "template.rb",  "some_file_after_erb.rb"
+      # m.template_copy_each ["template.rb", "template2.rb"]
+      # m.file     "file",         "some_file_copied"
+      
+      m.file_copy_each %w(
+        LICENSE
+      )
+      
+      m.template "config/config.yml", "config/#{@name}.yml"
+      m.file "config/config.yml.sample", "config/#{@name}.yml.sample"
+      
+      m.template_copy_each %w(
+        TODO
+        rails/init.rb
+        spec/spec_helper.rb
+        README.rdoc
+        Rakefile
+      )
+      
+      m.template "lib/base.rb", "lib/#{@name}.rb"
+      m.directory "lib/#{@name}"
+      
+      m.dependency "install_rubigen_scripts", [destination_root, 'consumer'],
+        :shebang => options[:shebang], :collision => :force
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+
+    # Installation skeleton.  Intermediate directories are automatically
+    # created so don't sweat their absence here.
+    BASEDIRS = %w(
+      lib
+      script
+      spec
+      rails
+      spec/xml
+      config
+    )
+end

data/app_generators/consumer/templates/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 YOUR NAME
+
+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/app_generators/consumer/templates/README.rdoc

@@ -0,0 +1,3 @@
+== <%= name %>
+
+A gem that provides...

data/app_generators/consumer/templates/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+
+GEM = "<%= name %>"
+GEM_VERSION = "0.0.1"
+AUTHOR = "Your Name"
+EMAIL = "Your Email"
+HOMEPAGE = "http://example.com"
+SUMMARY = "A gem that provides..."
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+end
+
+task :default => :spec
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/app_generators/consumer/templates/TODO

@@ -0,0 +1,4 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/<%= name %>.rb

data/app_generators/consumer/templates/config/config.yml

@@ -0,0 +1,2 @@
+# You should set up your SCM to ignore this, and copy a version to
+# <%= name %>.yml.sample sans sensitive data.

data/app_generators/consumer/templates/config/config.yml.sample

@@ -0,0 +1 @@
+# Check this in to version control with sensitive data as dummy values

data/app_generators/consumer/templates/lib/base.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'consumer'
+
+module <%= name.camelcase %>;end
+
+Dir.glob(File.join(File.dirname(__FILE__), '<%= name %>/**/*.rb')).each {|f| require f}

data/app_generators/consumer/templates/rails/init.rb

@@ -0,0 +1 @@
+require '<%= name %>'

data/app_generators/consumer/templates/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! [:newgem_simple, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/app_generators/consumer/templates/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! [:newgem_simple, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/app_generators/consumer/templates/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require '<%= name %>'
+include <%= name.camelcase %>
+
+class Object
+  def blank?
+    self.nil? || self.empty?
+  end
+end

data/bin/consumer

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rubigen'
+
+if %w(-v --version).include? ARGV.first
+  require 'consumer/version'
+  puts "#{File.basename($0)} #{Consumer::VERSION}"
+  exit(0)
+end
+
+require 'rubigen/scripts/generate'
+source = RubiGen::PathSource.new(:application, 
+  File.join(File.dirname(__FILE__), "../app_generators"))
+RubiGen::Base.reset_sources
+RubiGen::Base.append_sources source
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'consumer')

data/config/website.yml.sample

@@ -0,0 +1,2 @@
+host: unknown@rubyforge.org
+remote_dir: /var/www/gforge-projects/consumer

data/consumer.gemspec

@@ -0,0 +1,48 @@
+Gem::Specification.new do |s|
+  s.name = %q{consumer}
+  s.version = "0.8.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Woody Peterson"]
+  s.date = %q{2009-01-29}
+  s.default_executable = %q{consumer}
+  s.description = %q{Consumer is a library for consuming xml resources via Builder, libxml, and some request sending / response marshaling glue. It comes with an app generator that creates an empty ready-for-rails gem that itself comes with a generator for making the request/response classes, config files, and specs (see script/generate after creating a new Consumer project).}
+  s.email = ["woody.peterson@gmail.com"]
+  s.executables = ["consumer"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "app_generators/consumer/templates/README.rdoc", "examples/active_record/README.txt", "website/index.txt"]
+  s.files = ["History.txt", "LICENSE", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "app_generators/consumer/USAGE", "app_generators/consumer/consumer_generator.rb", "app_generators/consumer/templates/LICENSE", "app_generators/consumer/templates/README.rdoc", "app_generators/consumer/templates/Rakefile", "app_generators/consumer/templates/TODO", "app_generators/consumer/templates/config/config.yml", "app_generators/consumer/templates/config/config.yml.sample", "app_generators/consumer/templates/lib/base.rb", "app_generators/consumer/templates/rails/init.rb", "app_generators/consumer/templates/script/destroy", "app_generators/consumer/templates/script/generate", "app_generators/consumer/templates/spec/spec_helper.rb", "bin/consumer", "config/website.yml.sample", "consumer.gemspec", "consumer_generators/request/USAGE", "consumer_generators/request/request_generator.rb", "consumer_generators/request/templates/lib/request.rb", "consumer_generators/request/templates/lib/response.rb", "consumer_generators/request/templates/spec/request_spec.rb", "consumer_generators/request/templates/spec/response_spec.rb", "consumer_generators/request/templates/spec/xml/response.xml", "examples/active_record/README.txt", "examples/active_record/ar_spec.rb", "examples/active_record/database.sqlite", "examples/active_record/environment.rb", "examples/active_record/migration.rb", "examples/active_record/models/book.rb", "examples/active_record/models/contributor.rb", "examples/active_record/xml/book.xml", "examples/active_record/xml/book_with_contributors.xml", "examples/active_record/xml/contributor.xml", "examples/active_record/xml/contributor_with_books.xml", "examples/shipping/environment.rb", "examples/shipping/rate.rb", "examples/shipping/shipping.yml.sample", "examples/shipping/shipping_spec.rb", "examples/shipping/ups_rate_request.rb", "examples/shipping/ups_rate_response.xml", "lib/consumer.rb", "lib/consumer/helper.rb", "lib/consumer/mapping.rb", "lib/consumer/request.rb", "rails_generators/request/USAGE", "rails_generators/request/request_generator.rb", "script/console", "script/destroy", "script/generate", "script/txt2html", "spec/helper_spec.rb", "spec/mapping_spec.rb", "spec/request_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/xml/rate_response.xml", "spec/xml/rate_response_error.xml", "tasks/rspec.rake", "test/test_consumer_generator.rb", "test/test_consumer_plugin_request_generator.rb", "test/test_generator_helper.rb", "test/test_rails_request_generator.rb", "website/index.html", "website/index.txt", "website/javascripts/rounded_corners_lite.inc.js", "website/stylesheets/screen.css", "website/template.html.erb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://consumer.rubyforge.org}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{consumer}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Consumer is a library for consuming xml resources via Builder, libxml, and some request sending / response marshaling glue}
+  s.test_files = ["test/test_consumer_generator.rb", "test/test_consumer_plugin_request_generator.rb", "test/test_generator_helper.rb", "test/test_rails_request_generator.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.0.2"])
+      s.add_runtime_dependency(%q<libxml-ruby>, [">= 0.8.3"])
+      s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_development_dependency(%q<newgem>, [">= 1.0.7"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.0.2"])
+      s.add_dependency(%q<libxml-ruby>, [">= 0.8.3"])
+      s.add_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_dependency(%q<newgem>, [">= 1.0.7"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.0.2"])
+    s.add_dependency(%q<libxml-ruby>, [">= 0.8.3"])
+    s.add_dependency(%q<builder>, [">= 2.1.2"])
+    s.add_dependency(%q<newgem>, [">= 1.0.7"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/consumer_generators/request/USAGE

@@ -0,0 +1,25 @@
+Description:
+
+  Creates request and response classes. 
+  
+  The first argument is the name of the request class *without* the word
+  "Request" at the end. This is added automatically. i.e. "UPSRate" would
+  generate the UPSRateRequest class.
+  
+  The second (optional) argument is for the response class, and no name
+  trickery here - you get what you say. It defaults to the first argument,
+  so if that was "UPSRate", a UPSRate class would be created as the
+  response object (and UPSRateRequest would return UPSRate object(s)).
+  
+Usage:
+
+  script/generate request ShortRequestClass [ResponseClass=ShortRequestClass]
+  
+  ex. script/generate request UPSRate Rate
+  => generates UPSRateRequest, which returns Rate objects, and generates
+     the Rate class and specs.
+     
+  You should definitely look at the specs, and use DO_IT_LIVE (shown in specs) to
+  get started configuring the request. Once it gets back the kind of xml you want,
+  put it in the generated (empty) xml file and use that to configure the response
+  class with canned data. test one more time live, script/generate again, rinse, repeat.

data/consumer_generators/request/request_generator.rb

@@ -0,0 +1,94 @@
+require 'active_support'
+require 'yaml'
+class RequestGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :request_class, :response_class, :request_file, :response_file
+  attr_reader :response_xml, :request_base, :appname
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @request_base = args.shift
+    @request_class = @request_base + "Request"
+    @response_class = args.shift || @request_base
+    @request_file = @request_class.underscore
+    @response_file = @response_class.underscore
+    @response_xml = @request_base.underscore + "_response.xml"
+    @appname = APP_ROOT.split("/").last
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      m.directory 'lib'
+      m.directory "lib/#{@appname}"
+      m.directory 'spec'
+      m.directory 'spec/xml'
+      
+      # 1 level of namespace support
+      if @request_file.include?("/")
+        namespace = @request_file.split("/")[0]
+        m.directory "lib/#{@appname}/#{namespace}"
+        m.directory "spec/#{namespace}"
+        m.directory "spec/xml/#{namespace}"
+      end
+      
+      templates = [
+        ["lib/request.rb",        "lib/#{@appname}/#{@request_file}.rb"],
+        ["lib/response.rb",       "lib/#{@appname}/#{@response_file}.rb"],
+        ["spec/request_spec.rb",  "spec/#{@request_file}_spec.rb"],
+        ["spec/response_spec.rb", "spec/#{@response_file}_spec.rb"],
+        ["spec/xml/response.xml", "spec/xml/#{@response_xml}"]
+      ]
+      
+      templates.each {|args| m.template *args}
+      
+      # put in a relevant example if the config is still empty
+      if File.exists?("config/#{@appname}.yml")
+        config = YAML.load(File.read("config/#{@appname}.yml"))
+        File.open("config/#{@appname}.yml", "a") do |file|
+          file << "all:\n  global_default: Value\n#{@request_base.underscore}:\n  request_default: Value"
+        end if !config
+      end
+      
+      # Create stubs
+      # m.template           "template.rb.erb", "some_file_after_erb.rb"
+      # m.template_copy_each ["template.rb", "template2.rb"]
+      # m.template_copy_each ["template.rb", "template2.rb"], "some/path"
+      # m.file           "file", "some_file_copied"
+      # m.file_copy_each ["path/to/file", "path/to/file2"]
+      # m.file_copy_each ["path/to/file", "path/to/file2"], "some/path"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates request and response classes
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end