woahdae-consumer 0.8.1

data/consumer_generators/request/templates/lib/request.rb

@@ -0,0 +1,55 @@
+# === Vendor API Docs
+# http://www.example.com/handy_docs
+class <%= "#{appname.camelcase}::#{request_class}" %> < Consumer::Request
+  
+  ### Note: Everything except to_xml is optional (though handy) ###
+  
+  response_class "<%= response_class %>"
+  yaml_defaults "<%= appname %>.yml", "<%= request_base.underscore %>"
+  
+  # If root is found in a response, code + message will be raised
+  error_paths({
+    :root    => "//Error",
+    :code    => "//ErrorCode",
+    :message => "//ErrorDescription"
+  })
+  
+  # Instance variables that must be set before xml sendoff
+  def required
+    return [
+      # :required_attrs_array
+    ]
+  end
+  
+  # Lowest priority; overwritten by YAML, then params
+  def defaults
+    return {
+      # :sensible_default => "Value"
+    }
+  end
+  
+  def url
+    return "www.example.com/testing" if $TESTING
+    
+    "www.example.com"
+  end
+
+  def headers
+    {"SoapAction" => ""}
+  end
+  
+  # Called before required vars are checked, too
+  def before_to_xml; end
+  
+  # All this has to do is return xml, and we have a Builder instance to help.
+  # Also, defaults, YAML, and the params are accessed via instance variables.
+  def to_xml
+    b.instruct!
+    
+    # docs at http://builder.rubyforge.org/classes/Builder/XmlMarkup.html
+    # example:
+    b.<%= request_class %> {
+      b.Hello "World"
+    }
+  end
+end

data/consumer_generators/request/templates/lib/response.rb

@@ -0,0 +1,12 @@
+class <%= "#{appname.camelcase}::#{response_class}" %>
+  include Consumer::Mapping
+  attr_accessor :attribute
+  
+  # This is fairly dense; see documentation for full explanation
+  # map(:all or :first, "root xpath", registry, opts = {}, &postprocessing)
+  map(:all, "//FullyQualified/Xpath/ToRoot", {
+      :attribute => "RelativeOrFQxPathToValue",
+    },
+    :include => [:association1, :association2]
+  ) {|<%= response_class.underscore %>| <%= response_class.underscore%>.attribute.strip! }
+end

data/consumer_generators/request/templates/spec/request_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe <%= "#{appname.camelcase}::#{request_class}" %> do
+
+  it "creates xml" do
+    <%= request_class.underscore %> = <%= request_class %>.new({
+      # :attribute => value
+    })
+    xml = <%= request_class.underscore %>.to_xml_etc
+    xml.should =~ /\<\?xml/
+  end
+  
+  # run "DO_IT_LIVE=true spec spec" to contact the api
+  if ENV['DO_IT_LIVE']
+    
+    it "contacts the live api and returns <%= response_class %> instance(s)" do
+      $DEBUG = true # spit out xml for the request & response
+      
+      <%= response_class.underscore %> = <%= request_class %>.new({
+        # :attribute => "value"
+      }).do
+      <%= response_class.underscore %>.should_not be_blank
+    end
+
+  end
+
+end

data/consumer_generators/request/templates/spec/response_spec.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe <%= "#{appname.camelcase}::#{response_class}" %> do
+  it "should make an instance of itself via from_xml" do
+    file = "spec/xml/<%= response_xml %>"
+    xml = File.read("#{file}")
+    
+    <%= response_class %>.from_xml(xml).should_not be_blank
+  end
+end

data/examples/active_record/README.txt

@@ -0,0 +1 @@
+This is an example focusing on maps in an active_record environment. Requests are irrelevant here, as they're not intended to ever be used with ActiveRecord (althogh nothing prevents it).

data/examples/active_record/ar_spec.rb

@@ -0,0 +1,33 @@
+require 'spec'
+require 'environment'
+
+# Very broad tests to see ROXML working with Active Record
+
+describe "ROXML in ActiveRecord" do
+  before(:all) do
+    @book_xml = File.read("xml/book.xml")
+    @book_with_contributors_xml = File.read("xml/book_with_contributors.xml")
+    @contributor_with_books_xml = File.read("xml/contributor_with_books.xml")
+    @contributor_xml = File.read("xml/contributor.xml")
+  end
+
+  it "creates a valid AR object from xml" do
+    book = Book.from_xml(@book_xml)
+    book.isbn.should == "0974514055"
+    book.title.should == "Programming Ruby - 2nd Edition"
+    book.description.should == "Second edition of the great book out there"
+    book.save.should be_true
+  end
+
+  describe "habtm for books-contributors" do
+    it "works from the book side of the relationship" do
+      book = Book.from_xml(@book_with_contributors_xml)
+      book.contributors.size.should == 3
+    end
+    
+    it "works from the contributor side of the relationship" do
+      contributor = Contributor.from_xml(@contributor_with_books_xml)
+      contributor.books.size.should == 3
+    end
+  end
+end

data/examples/active_record/environment.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'active_record'
+require 'sqlite3'
+
+
+require File.dirname(__FILE__) + '/../../lib/consumer.rb'
+
+$:.unshift(File.dirname(__FILE__))
+require 'models/contributor'
+require 'models/book'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :dbfile  => 'database.sqlite'
+)

data/examples/active_record/migration.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/environment'
+
+ActiveRecord::Schema.define do
+  create_table "books", :force => true do |t|
+    t.string  :title
+    t.text    :description
+    t.string  :isbn
+  end
+  
+  create_table "contributors", :force => true do |t|
+    t.string :name
+    t.string :role
+  end
+  
+  create_table "books_contributors", :force => true do |t|
+    t.integer :book_id
+    t.integer :contributor_id
+  end
+end

data/examples/active_record/models/book.rb

@@ -0,0 +1,13 @@
+class Book < ActiveRecord::Base
+  include Consumer::Mapping
+  has_and_belongs_to_many :contributors
+
+  @habtm_registry = {
+    :isbn => "attribute::isbn",
+    :title => "title",
+    :description => "description"
+  }
+  
+  map(:first, "//BookResponse/book", @habtm_registry, :include => :contributors)
+  map(:all, "//ContributorResponse/contributor/books/book", @habtm_registry)
+end

data/examples/active_record/models/contributor.rb

@@ -0,0 +1,12 @@
+class Contributor < ActiveRecord::Base
+  include Consumer::Mapping
+  has_and_belongs_to_many :books
+
+  @habtm_registry = {
+    :role => "attribute::role",
+    :name => "name"
+  }
+  
+  map(:first, "//ContributorResponse/contributor", @habtm_registry, :include => :books)
+  map(:all, "//BookResponse/book/contributors/contributor", @habtm_registry)
+end

data/examples/active_record/xml/book.xml

@@ -0,0 +1,6 @@
+<BookResponse>
+  <book isbn="0974514055">
+    <title>Programming Ruby - 2nd Edition</title>
+    <description>Second edition of the great book out there</description>
+  </book>
+</BookResponse>

data/examples/active_record/xml/book_with_contributors.xml

@@ -0,0 +1,11 @@
+<BookResponse>
+  <book isbn="0974514055">
+    <title>Programming Ruby - 2nd Edition</title>
+    <description>Second edition of the great book out there</description>
+    <contributors>
+      <contributor role="author"><name>David Thomas</name></contributor>
+      <contributor role="supporting author"><name>Andrew Hunt</name></contributor>
+      <contributor role="supporting author"><name>Chad Fowler</name></contributor>
+    </contributors>
+  </book>
+</BookResponse>

data/examples/active_record/xml/contributor.xml

@@ -0,0 +1,3 @@
+<ContributorResponse>
+  <contributor role="author"><name>David Thomas</name></contributor>
+</ContributorResponse>

data/examples/active_record/xml/contributor_with_books.xml

@@ -0,0 +1,19 @@
+<ContributorResponse>
+  <contributor role="author">
+    <name>David Thomas</name>
+    <books>
+      <book isbn="0974514055">
+        <title>Programming Ruby - 2nd Edition</title>
+        <description>Second edition of the great book out there</description>
+      </book>
+      <book isbn="1112223334">
+        <title>Hitchhikers Guide to the Galaxy</title>
+        <description>42</description>
+      </book>
+      <book isbn="4556677889">
+        <title>Cats</title>
+        <description>lol</description>
+      </book>
+    </books>
+  </contributor>
+</ContributorResponse>

data/examples/shipping/environment.rb

@@ -0,0 +1,3 @@
+require '../../lib/consumer'
+require "ups_rate_request"
+require 'rate'

data/examples/shipping/rate.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/environment"
+
+class Rate
+  include Consumer::Mapping
+  attr_accessor :service, :code, :price, :carrier
+  
+  # UPS
+  map(:all, "//RatingServiceSelectionResponse/RatedShipment", {
+    :price => "TotalCharges/MonetaryValue",
+    # :name => "Service",
+    :code => "Service/Code"
+  }) {|instance| instance.carrier = "UPS" }
+  
+end
+

data/examples/shipping/shipping.yml.sample

@@ -0,0 +1,8 @@
+ups:
+  access_license_number: 1A2B33G45CC98765
+  user_id: upsuser
+  password: upspass
+  sender_zip: "98115"
+  sender_country: US
+  sender_city: Seattle
+  sender_state: WA

data/examples/shipping/shipping_spec.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'spec'
+require File.dirname(__FILE__) + "/environment"
+
+$TESTING = true
+$DEBUG = true
+describe "Shipping" do
+  if ENV['DO_IT_LIVE'] # http://www.youtube.com/watch?v=2tJjNVVwRCY&feature=related
+    describe "UPS" do
+      it "should work" do
+        rates = UPSRateRequest.new(
+          :zip => "98125",
+          :country => "US",
+          :weight => "5.00",
+
+          # optional
+          # :city => "Seattle",
+          # :state => "WA",
+          :request_type => "Shop" # take out shop, and it'll return one ground rate
+        ).do
+        
+        rates.should_not be_nil
+        rates.size.should > 1 # comment unless request_type => 'Shop'
+      end
+    end
+  end
+end

data/examples/shipping/ups_rate_request.rb

@@ -0,0 +1,182 @@
+require File.dirname(__FILE__) + "/environment"
+
+# === Vendor API Docs
+# 
+# http://www.ups.com/gec/techdocs/pdf/dtk_RateXML_V1.zip
+class UPSRateRequest < Consumer::Request
+  response_class "Rate"
+  error_paths({
+    :root    => "//Error",
+    :code    => "//ErrorCode",
+    :message => "//ErrorDescription"
+  })
+  yaml_defaults "shipping.yml", "ups"
+  required(
+    # these are in shipping.yml
+    :access_license_number,
+    :sender_zip,
+    :sender_country,
+    # these must be passed in
+    :zip,
+    :country,
+    # :city,
+    # :state,
+    :weight
+  )
+  defaults({
+    :customer_type  => "wholesale",
+    :pickup_type    => "daily_pickup",
+    :request_type   => "Rate", # or Shop
+    :service_type   => "ground",
+    :package_type   => "your_packaging",
+    :weight_units   => 'LBS', # or KGS
+    :measure_units  => 'IN',
+    :measure_length => 0,
+    :measure_width  => 0,
+    :measure_height => 0,
+    # optional, but all or none
+    # :currency_code  => "US",
+    # :insured_value  => 0
+  })
+  # optional
+  # * :city
+  # * :state
+  # * :sender_city
+  # * :sender_state
+  
+  
+  def url
+    return "https://wwwcie.ups.com/ups.app/xml/Rate" if $TESTING
+    
+    "https://www.ups.com/ups.app/xml/Rate"
+  end
+
+  API_VERSION = "1.0001"
+  
+  PackageTypes = {
+    "ups_envelope" => "01",
+    "your_packaging" => "02",
+    "ups_tube" => "03",
+    "ups_pak" => "04",
+    "ups_box" => "21",
+    "fedex_25_kg_box" => "24",
+    "fedex_10_kg_box" => "25"
+  }
+
+  ServiceTypes = {
+    "next_day" => "01",
+    "2day" => "02",
+    "ground" => "03",
+    "worldwide_express" => "07",
+    "worldwide_expedited" => "08",
+    "standard" => "11",
+    "3day" => "12",
+    "next_day_saver" => "13",
+    "next_day_early" => "14",
+    "worldwide_express_plus" => "54",
+    "2day_early" => "59"
+  }
+  
+  PaymentTypes = {
+    'prepaid' => 'Prepaid',
+    'consignee' => 'Consignee',
+    'bill_third_party' => 'BillThirdParty',
+    'freight_collect' => 'FreightCollect'
+  }
+
+  # UPS-Specific types
+
+  PickupTypes = {
+    'daily_pickup' => '01',
+    'customer_counter' => '03',
+    'one_time_pickup' => '06',
+    'on_call' => '07',
+    'suggested_retail_rates' => '11',
+    'letter_center' => '19',
+    'air_service_center' => '20'
+  }
+
+  CustomerTypes = {
+    'wholesale' => '01',
+    'ocassional' => '02',
+    'retail' => '04'
+  }
+  
+  def to_xml
+    b.instruct!
+
+    b.AccessRequest {
+      b.AccessLicenseNumber @access_license_number
+      b.UserId @user_id
+      b.Password @password
+    }
+    
+    b.instruct!
+    
+    b.RatingServiceSelectionRequest { 
+      b.Request {
+        b.TransactionReference {
+          b.CustomerContext 'Rating and Service'
+          b.XpciVersion API_VERSION
+        }
+        b.RequestAction 'Rate'
+        b.RequestOption @request_type
+      }
+      b.CustomerClassification {
+        b.Code CustomerTypes[@customer_type]
+      }
+      b.PickupType {
+        b.Code PickupTypes[@pickup_type]
+      }
+      b.Shipment {
+        b.Shipper {
+          b.Address {
+            b.PostalCode @sender_zip
+            b.CountryCode @sender_country
+            b.City @sender_city 
+            b.StateProvinceCode @sender_state
+          }
+        }
+        b.ShipTo {
+          b.Address {
+            b.PostalCode @zip
+            b.CountryCode @country
+            b.City @city
+            b.StateProvinceCode @state 
+          }
+        }
+        b.Service {
+          b.Code ServiceTypes[@service_type]
+        }
+        b.Package {
+          b.PackagingType {
+            b.Code PackageTypes[@package_type]
+            b.Description 'Package'
+          }
+          b.Description 'Rate Shopping'
+          b.PackageWeight {
+            b.Weight @weight
+            b.UnitOfMeasurement {
+              b.Code @weight_units
+            }
+          }
+          b.Dimensions {
+            b.UnitOfMeasurement {
+              b.Code @measure_units
+            }
+            b.Length @measure_length
+            b.Width @measure_width
+            b.Height @measure_height
+          }
+          b.PackageServiceOptions {
+            b.InsuredValue {
+              b.CurrencyCode @currency_code
+              b.MonetaryValue @insured_value
+            }
+          }
+        }
+      }
+    }
+        
+  end
+end