resthome 0.7.1 → 0.8.0

data/README.rdoc

@@ -60,7 +60,7 @@ Create a simple lorem lipsum generator, using http://www.lipsum.com.
 
 == LastFM Example query arguments
 
-How to use replace query parameters with function arguments.
+How to replace query parameters with function arguments.
 
   class LastFmWebService < RESTHome
     base_uri 'http://ws.audioscrobbler.com'
@@ -87,6 +87,42 @@ How to use replace query parameters with function arguments.
 
 TwilioWebService.service.send_sms_message '5551112222', 'Verification Code: 2121'
 
+== Amazon Simple Email Service (SES)
+
+How to replace body parameters with function arguments.
+
+  require 'digest/sha2'
+  require 'base64'
+
+  class AmazonSESService < RESTHome
+    base_uri 'https://email.us-east-1.amazonaws.com'
+    
+    @@digest256 = OpenSSL::Digest::Digest.new("sha256")
+  
+    route :verify_email_address, '/', :body => {'Action' => 'VerifyEmailAddress', 'EmailAddress' => :arg1}, :method => :post, :expected_status => 200, :no_body => true do |res|
+      res['VerifyEmailAddressResponse']
+    end
+  
+    def initialize(access_key, secret)
+      @access_key = access_key
+      @secret = secret
+    end
+  
+    def build_options!(options)
+      date = Time.now.getutc.httpdate
+      options[:headers] ||= {}
+      options[:headers]['Date'] = date
+      options[:headers]['X-Amzn-Authorization'] = "AWS3-HTTPS AWSAccessKeyId=#{@access_key},Algorithm=HMACSHA256,Signature=#{AmazonSESService.sign_request(@secret, date)}"
+    end
+  
+    def self.sign_request(secret, date)
+      Base64.encode64(OpenSSL::HMAC.digest(@@digest256, secret, date)).gsub("\n","")
+    end
+  end
+
+  service = AmazonSESService.new 'my-access-key', 'it-s-a-secret'
+  service.verify_email_address 'test@test.dev'
+
 == Contributing to RESTHome
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.8.0

data/examples/amazon_ses_service.rb

@@ -0,0 +1,29 @@
+require 'resthome'
+require 'digest/sha2'
+require 'base64'
+
+class AmazonSESService < RESTHome
+  base_uri 'https://email.us-east-1.amazonaws.com'
+  
+  @@digest256 = OpenSSL::Digest::Digest.new("sha256")
+
+  route :verify_email_address, '/', :body => {'Action' => 'VerifyEmailAddress', 'EmailAddress' => :arg1}, :method => :post, :expected_status => 200, :no_body => true do |res|
+    res['VerifyEmailAddressResponse']
+  end
+
+  def initialize(access_key, secret)
+    @access_key = access_key
+    @secret = secret
+  end
+
+  def build_options!(options)
+    date = Time.now.getutc.httpdate
+    options[:headers] ||= {}
+    options[:headers]['Date'] = date
+    options[:headers]['X-Amzn-Authorization'] = "AWS3-HTTPS AWSAccessKeyId=#{@access_key},Algorithm=HMACSHA256,Signature=#{AmazonSESService.sign_request(@secret, date)}"
+  end
+
+  def self.sign_request(secret, date)
+    Base64.encode64(OpenSSL::HMAC.digest(@@digest256, secret, date)).gsub("\n","")
+  end
+end

data/lib/resthome.rb

@@ -38,22 +38,17 @@ class RESTHome
   #   Removes the body argument from a post/put route
   # [:query]
   #   Default set of query arguments
+  # [:body]
+  #   Default set of body arguments
   def self.route(name, path, options={}, &block)
     args = path.scan /:[a-z_]+/
     path = "#{@path_prefix.join if @path_prefix}#{path}"
     function_args = args.collect{ |arg| arg[1..-1] }
 
-    query_args = []
-    if options[:query]
-      options[:query].each do |n, v|
-        next unless v.is_a?(Symbol)
-        idx = v.to_s.gsub(/[^\d]/, '').to_i
-        query_args[idx] = n.to_s
-        options[:query].delete n
-      end
-      query_args.compact!
-    end
+    body_args = get_function_args options, :body
+    function_args += body_args.map { |a| a.downcase.gsub(/[^a-z0-9_]/, '_').sub(/^\d+/, '') }
 
+    query_args = get_function_args options, :query
     function_args += query_args.map { |a| a.downcase.gsub(/[^a-z0-9_]/, '_').sub(/^\d+/, '') }
 
     method = options[:method]
@@ -96,10 +91,18 @@ class RESTHome
       method_src << "path.sub! '#{arg}', URI.escape(#{function_args[idx]}.to_s)\n"
     end
 
-    if options[:no_body].nil?
+    if options[:no_body]
+      if options[:body]
+        method_src << "options[:body] = #{options[:body].inspect}.merge(options[:body] || {})\n"
+      elsif body_args.size > 0
+        method_src << "options[:body] ||= {}\n"
+      end
+    else
       if method == 'post' || method == 'put'
         if options[:resource]
           method_src << "options[:body] = {'#{options[:resource].to_s}' => body}\n"
+        elsif options[:body]
+          method_src << "options[:body] = #{options[:body].inspect}.merge(body || {})\n"
         else
           method_src << "options[:body] = body\n"
         end
@@ -112,8 +115,13 @@ class RESTHome
       method_src << "options[:query] ||= {}\n"
     end
 
-    query_args.each_with_index do |arg, idx|
+    body_args.each_with_index do |arg, idx|
       idx += args.size
+      method_src << "options[:body]['#{arg}'] = #{function_args[idx]}\n"
+    end
+
+    query_args.each_with_index do |arg, idx|
+      idx += body_args.size + args.size
       method_src << "options[:query]['#{arg}'] = #{function_args[idx]}\n"
     end
 
@@ -338,4 +346,20 @@ class RESTHome
     obj = yield(obj) if block_given?
     obj
   end
+
+  private
+
+  def self.get_function_args(options, fld)
+    args = []
+    if options[fld]
+      options[fld].each do |n, v|
+        next unless v.is_a?(Symbol)
+        idx = v.to_s.gsub(/[^\d]/, '').to_i
+        args[idx] = n.to_s
+        options[fld].delete n
+      end
+      args.compact!
+    end
+    args
+  end
 end

data/resthome.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resthome}
-  s.version = "0.7.1"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Doug Youch"]
-  s.date = %q{2011-02-21}
+  s.date = %q{2011-03-09}
   s.description = %q{Simple wrapper class generator for consuming RESTful web services}
   s.email = %q{doug@cykod.com}
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "examples/amazon_product_web_service.rb",
+    "examples/amazon_ses_service.rb",
     "examples/chargify_web_service.rb",
     "examples/last_fm_web_service.rb",
     "examples/twilio_web_service.rb",
@@ -42,6 +43,7 @@ Gem::Specification.new do |s|
   s.summary = %q{RESTful web services consumer}
   s.test_files = [
     "examples/amazon_product_web_service.rb",
+    "examples/amazon_ses_service.rb",
     "examples/chargify_web_service.rb",
     "examples/last_fm_web_service.rb",
     "examples/twilio_web_service.rb",

data/spec/lib/resthome_spec.rb

@@ -473,4 +473,55 @@ describe RESTHome do
     @service.request_options[:query]['artist'].should == 'cher'
     @service.request_options[:query]['track'].should == 'believe'
   end
+
+  it "should support body arguments" do
+    @service_class.class_eval do
+      base_uri 'http://test.dev'
+      route :tracks, '/:version/', :body => {'method' => 'track.getinfo', 'artist' => :arg1, 'track' => :arg2}, :method => :post, :no_body => true
+    end
+    @service = @service_class.new
+
+    fakeweb_response(:post, %r|http://test.dev/2.0/|, 200, [])
+    @service.tracks '2.0', 'cher', 'believe'
+
+    @service.request_method.should == :post
+    @service.request_url.should == 'http://test.dev/2.0/'
+    @service.request_options[:body]['method'].should == 'track.getinfo'
+    @service.request_options[:body]['artist'].should == 'cher'
+    @service.request_options[:body]['track'].should == 'believe'
+  end
+
+  it "should support body arguments" do
+    @service_class.class_eval do
+      base_uri 'http://test.dev'
+      route :tracks, '/:version/', :body => {'method' => 'track.getinfo', 'artist' => :arg1, 'track' => :arg2}, :method => :post
+    end
+    @service = @service_class.new
+
+    fakeweb_response(:post, %r|http://test.dev/2.0/|, 200, [])
+    @service.tracks '2.0', 'cher', 'believe', 'method' => 'track.getinfo2'
+
+    @service.request_method.should == :post
+    @service.request_url.should == 'http://test.dev/2.0/'
+    @service.request_options[:body]['method'].should == 'track.getinfo2'
+    @service.request_options[:body]['artist'].should == 'cher'
+    @service.request_options[:body]['track'].should == 'believe'
+  end
+
+  it "should support body and query arguments" do
+    @service_class.class_eval do
+      base_uri 'http://test.dev'
+      route :tracks, '/:version/', :body => {'method' => 'track.getinfo', 'artist' => :arg1, 'track' => :arg2}, :query => {'auth' => 'xx', 'Sign' => :arg1}, :method => :post
+    end
+    @service = @service_class.new
+
+    fakeweb_response(:post, 'http://test.dev/2.0/?auth=xx&Sign=secret', 200, [])
+    @service.tracks '2.0', 'cher', 'believe', 'secret', 'method' => 'track.getinfo2'
+
+    @service.request_method.should == :post
+    @service.request_url.should == 'http://test.dev/2.0/'
+    @service.request_options[:body]['method'].should == 'track.getinfo2'
+    @service.request_options[:body]['artist'].should == 'cher'
+    @service.request_options[:body]['track'].should == 'believe'
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resthome
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 63
   prerelease: false
   segments: 
   - 0
-  - 7
-  - 1
-  version: 0.7.1
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Doug Youch
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-21 00:00:00 -05:00
+date: 2011-03-09 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -138,6 +138,7 @@ files:
 - Rakefile
 - VERSION
 - examples/amazon_product_web_service.rb
+- examples/amazon_ses_service.rb
 - examples/chargify_web_service.rb
 - examples/last_fm_web_service.rb
 - examples/twilio_web_service.rb
@@ -183,6 +184,7 @@ specification_version: 3
 summary: RESTful web services consumer
 test_files: 
 - examples/amazon_product_web_service.rb
+- examples/amazon_ses_service.rb
 - examples/chargify_web_service.rb
 - examples/last_fm_web_service.rb
 - examples/twilio_web_service.rb