resat 0.7.0

data/examples/rightscale/README.rdoc

@@ -0,0 +1,39 @@
+= Synopsis
+
+This example uses the RightScale REST API:
+http://wiki.rightscale.com/2._References/01-RightScale/03-RightScale_API
+
+This example will list all your servers, create a new server using the
+'Rails all-in-one' server template and delete it.
+
+See the main README.rdoc for instructions on how to setup resat prior to
+running the examples.
+
+= How to
+
+* Run:
+
+    $ resat scenarios -d user:<your RightScale username> -d pass:<your RightScale password> -d acct:<your RightScale account number>
+
+* See:
+
+    $ cat output.yml
+
+* See more:
+
+    $ vi /tmp/resat.log
+
+  or
+
+    $ vi resat.log
+
+  if <tt>/tmp</tt> does not exist
+
+= Additional Examples
+
+The <i>run_server</i> example in the <i>additional</i> folder will create and
+launch a server in the <i>default</i> deployment and wait until it's
+operational before running an operational script on it. It will then stop and
+delete it. See the file <tt>additional/run_server.yml</tt>
+(http://github.com/raphael/resat/blob/master/examples/rightscale/additional/run_server.yml) 
+for additional information.

data/examples/rightscale/additional/run_server.yml

@@ -0,0 +1,75 @@
+# This scenario will launch an All-in-on Rails server, wait for it to become
+# operational, run a RightScript (Mongrels restart) and then stop the server,
+# wait for it to be stopped and delete it.
+#
+# Note: This scenario reuses the 'create_server' scenario to create the 
+# Rails All-in-one server.
+#
+name: Launch rails servers and run RightScript
+includes:
+  - ../scenarios/create_server
+steps:
+  - request:                    # Step 1. Start server
+      resource:       servers
+      id:             $server_id
+      custom:
+        name:         start
+        type:         post
+
+  - request:                    # Step 2. Retrieve Mongrels restart RightScript
+      operation:      index
+      resource:       right_scripts
+    filters:
+      - name:         Get Rails server template
+        target:       body
+        extractors:
+          - field:    right-scripts/right-script[name='RB mongrel_cluster (re)start v1']/href
+            variable: right_script_id
+
+  - request:                    # Step 3. Wait for server to become operational
+      resource:       servers
+      id:             $server_id
+      operation:      show
+    guards:
+      - name:         Wait for operational state
+        target:       body
+        field:        server/state
+        pattern:      "operational"
+        period:       10
+        timeout:      900
+
+  - request:                    # Step 4. Restart Mongrels
+      resource:       servers
+      id:             $server_id
+      custom:
+        name:         run_script
+        type:         post
+      params:
+        - name:       right_script
+          value:      $right_script_id
+
+  - request:                    # Step 5. Stop server
+      resource:       servers
+      id:             $server_id
+      custom:
+        name:         stop
+        type:         post
+
+  - request:                    # Step 6. Wait for server to become stopped
+      resource:       servers
+      id:             $server_id
+      operation:      show
+    guards:
+      - name:         Wait for stop state
+        target:       body
+        field:        server/state
+        pattern:      "stopped"
+        period:       10
+        timeout:      900
+ 
+  - request:                    # Step 7. Now delete the server
+      operation:      destroy
+      resource:       servers
+      id:             $server_id
+
+

data/examples/rightscale/config/resat.yaml

@@ -0,0 +1,34 @@
+# Hostname used for API calls
+host:    moo.rightscale.com 
+
+# Port
+# port: 443
+
+# Common base URL to all API calls
+base_url: api/acct/$acct
+
+# Use HTTPS?
+use_ssl:  yes
+
+# Basic auth username if any
+username: $user
+
+# Basic auth password if any
+password: $pass
+
+# Common request headers for all API calls
+headers:
+  - name:  X-API-VERSION
+    value: '1.0'
+    
+# Common parameters for all API calls
+params:
+
+# Global variables
+variables:
+    
+# Input file
+#input: variables.yml
+
+# Output file
+#output: variables.yml

data/examples/rightscale/scenarios/create_server.yml

@@ -0,0 +1,48 @@
+# Create new Rails all-in-one server in default deployment
+name: Create Rails Server
+steps:
+  - request:                     # Step 1. Retrieve default deployment
+      operation:      index
+      resource:       deployments
+      valid_codes:
+        - 200 
+    filters:
+      - name:         Get default deployment
+        target:       body
+        extractors:
+          - field:    deployments/deployment/href
+            variable: deployment
+
+  - request:                     # Step 2. Retrieve Rails template
+      operation:      index
+      resource:       server_templates
+    filters:
+      - name:         Get Rails server template
+        target:       body
+        extractors:
+          - field:    server-templates/ec2-server-template[nickname='Rails all-in-one-developer v8']/href
+            variable: server_template
+
+  - request:                     # Step 3. Create server
+      operation:      create
+      resource:       servers
+      valid_codes:
+        - 201
+      params:
+        - name:       server[nickname]
+          value:      'Resat Rails Server'
+        - name:       server[server_template_href]
+          value:      $server_template
+        - name:       server[deployment_href]
+          value:      $deployment
+    filters:
+      - name:         validate server response
+        target:       body
+        is_empty:     true
+      - name:         Get server id
+        target:       header
+        extractors:
+          - field:    location
+            pattern:  '.*\/(\d+)$'
+            variable: server_id
+            export:   true     # Export id to other scenarios

data/examples/rightscale/scenarios/delete_server.yml

@@ -0,0 +1,13 @@
+# Delete previously created server
+name: Delete Rails Server
+steps:
+  - request:
+      operation:      destroy
+      resource:       servers
+      id:             $server_id
+      valid_codes:
+        - 200
+    filters:
+      - name:         validate destroy response
+        target:       body
+        is_empty:     true

data/examples/rightscale/scenarios/list_servers.yml

@@ -0,0 +1,9 @@
+# List servers in default deployment
+name: List servers
+steps:
+  - request:
+      operation: index
+      resource:  servers
+      valid_codes:
+        - 200
+      

data/examples/twitter/README.rdoc

@@ -0,0 +1,50 @@
+= Synopsis
+
+This example uses the Twitter REST API:
+
+http://apiwiki.twitter.com/REST+API+Documentation
+
+<b>Please note</b>: This example will send a tweet on your behalf with the text:
+
+  Checking out resat (http://tinyurl.com/dg8gf9)
+
+by default. Override the default text in the <tt>config/resat.yaml</tt> file or
+via the command line:
+
+  $ resat scenarios -d tweet:'My custom tweet' -d user:... -d pass:...
+
+See the main README.rdoc for instructions on how to setup resat prior to
+running the examples.
+
+= How to
+
+* Run:
+
+    $ resat scenarios -d user:<your twitter username> -d pass:<your twitter password>
+
+* See:
+
+    $ cat output.yml
+
+* See more:
+
+    $ vi /tmp/resat.log
+
+  or
+
+    $ vi resat.log
+
+  if <tt>/tmp</tt> does not exist
+
+= Additional Examples
+
+The <i>additional</i> folder contains two additional scenarios which are not ran
+by default:
+
+* <tt>follow.yml</tt>: Follow given user
+* <tt>send_message.yml</tt>: Send direct message to given user with given content
+
+Both these scenarios require inputs. Inputs are given using the <tt>--define</tt>
+(or <tt>-d</tt>) resat option:
+
+  $ resat additional/follow -d followed:rgsimon

data/examples/twitter/additional/follow.yml

@@ -0,0 +1,15 @@
+# Follow username specified on command line
+#
+# Usage:
+#   resat follow -d followed:rgsimon
+
+name: Follow given user
+config: ../config/resat.yaml
+steps:
+  - request:
+      resource:  notifications        # Act on the 'notifications' resource
+      custom:                         # Use a custom operation (i.e. not a CRUD operation)
+        name:    follow               # Operation name
+        type:    post                 # POST request
+      id:        $followed            # ID of user to follow
+      format:    xml                  # Get response in XML format

data/examples/twitter/additional/send_message.yml

@@ -0,0 +1,19 @@
+# Send direct message to username specified on command line
+# Note: user must be following you otherwise the request returns 403.
+#
+# Usage:
+#   resat send_message -d to:rgsimon -d text:'Hello from resat!'
+
+name: Send Direct Message
+config: ../config/resat.yaml
+steps:
+  - request:
+      resource:  direct_messages  # Act on the 'direct_messages' resource
+      custom:                     # Use a custom operation (i.e. not a CRUD operation)
+        name:    new.xml          # Operation name
+        type:    post             # POST request
+      params:
+        - name:  user             # 'user' parameter
+          value: $to              # Username 
+        - name:  text             # 'text' parameter
+          value: $text            # Message content

data/examples/twitter/config/resat.yaml

@@ -0,0 +1,40 @@
+# Hostname used for API calls
+host:    twitter.com 
+
+# Port
+# port: 443
+
+# Common base URL to all API calls
+base_url: 
+
+# Use HTTPS?
+use_ssl:  yes
+
+# Basic auth username if any
+# Uses variable 'user' from the command line
+username: $user
+
+# Basic auth password if any
+# Uses variable 'pass' from the command line
+password: $pass
+
+# Common request headers for all API calls
+headers:
+# - name:  header_name
+#   value: header_value
+    
+# Common parameters for all API calls
+params:
+# - name:  param_name
+#   value: param_value
+
+# Global variables
+variables:
+  - name:  tweet
+    value: 'Checking out resat (http://tinyurl.com/dg8gf9)'
+    
+# Input file
+# input: input.yml
+
+# Output file
+output: output.yml

data/examples/twitter/output.yml

@@ -0,0 +1,5 @@
+--- 
+- name: last_public_tweet
+  value: "Novellus' CoolFill CVD Process Advances Tungsten Fill for Sub-32nm ...: Logic devices, though not as aggress.. http://tinyurl.com/csja8w"
+- name: last_friends_tweet
+  value: "@rgsimon Hey resat is cool!"

data/examples/twitter/scenarios/timelines.yml

@@ -0,0 +1,31 @@
+# Retrieve public and private recent tweets
+#
+# http://twitter.com/statuses/public_timeline.format
+# http://twitter.com/statuses/public_timeline.format
+name: Twitter Timelines
+config: ../config/resat.yaml
+steps:
+  - request:
+      resource:  statuses
+      custom:                         # Use a custom operation (i.e. not a CRUD operation)
+        name:    public_timeline.xml  # Operation name
+        type:    get                  # GET request
+    filters:
+      - name: extract latest public tweet
+        target: body
+        extractors:
+          - field:    statuses/status/text
+            variable: last public tweet
+            save:     yes
+  - request:
+      resource:  statuses
+      custom:                         # Use a custom operation (i.e. not a CRUD operation)
+        name:    friends_timeline.xml # Operation name
+        type:    get                  # GET request
+    filters:
+      - name: extract latest friends tweet
+        target: body
+        extractors:
+          - field:    statuses/status/text
+            variable: last friends tweet
+            save:     yes

data/examples/twitter/scenarios/tweet.yml

@@ -0,0 +1,14 @@
+# Send Tweet
+# http://twitter.com/statuses/update.format
+name: Send Tweet
+config: ../config/resat.yaml
+steps:
+  - request:
+      resource:  statuses        # Act on the 'notifications' resource
+      custom:                    # Use a custom operation (i.e. not a CRUD operation)
+        name:    update.xml      # Operation name
+        type:    post            # POST request
+      params:
+        - name:  status
+          value: $tweet
+

data/lib/api_request.rb

@@ -0,0 +1,145 @@
+# API request
+# See resat.rb for usage information.
+#
+
+require 'uri'
+require 'rexml/document'
+require File.join(File.dirname(__FILE__), 'net_patch')
+
+module Resat
+  
+  class ApiRequest
+    include Kwalify::Util::HashLike
+    attr_reader :request, :response, :send_count, :failures
+
+    # Prepare request so 'send' can be called
+    def prepare
+      @format ||= 'xml'
+      @failures = []
+      @send_count = 0
+
+      # 1. Normalize call fields
+      @headers ||= []
+      @params ||= []
+      # Clone config values so we don't mess with them when expanding variables
+      Config.headers.each do |h| 
+        @headers << { 'name' => h['name'].dup, 'value' => h['value'].dup }
+      end if Config.headers
+      Config.params.each do |p|
+        @params << { 'name' => p['name'].dup, 'value' => p['value'].dup }
+      end if Config.params && request_class.REQUEST_HAS_BODY
+      Variables.substitute!(@params)
+      Variables.substitute!(@headers)
+
+      # 2. Build URI
+      Variables.substitute!(@id) if @id
+      uri_class = (@use_ssl || @use_ssl.nil? && Config.use_ssl) ? URI::HTTPS : URI::HTTP
+      port = @port || Config.port || uri_class::DEFAULT_PORT
+      @uri = uri_class.build( :host => @host || Config.host, :port => port )
+      base_url = "/#{@base_url || Config.base_url}/".squeeze('/')
+      Variables.substitute!(base_url)
+      path = "#{base_url}#{@resource}"
+      path = "#{path}/#{@id}" if @id
+      path = "#{path}.#{@format}" if @format && !@custom
+      path = "#{path}#{@custom.separator}#{@custom.name}" if @custom
+      @uri.merge!(path)
+
+      # 3. Build request
+      case @operation
+        when 'index', 'show' then request_class = Net::HTTP::Get
+        when 'create'        then request_class = Net::HTTP::Post
+        when 'update'        then request_class = Net::HTTP::Put
+        when 'destroy'       then request_class = Net::HTTP::Delete
+      else
+        if @custom
+          case @custom.type
+            when 'get'    then request_class = Net::HTTP::Get
+            when 'post'   then request_class = Net::HTTP::Post
+            when 'put'    then request_class = Net::HTTP::Put
+            when 'delete' then request_class = Net::HTTP::Delete
+          end
+        else
+          @failures << "Missing request operation for request on '#{@resource}'."
+          return
+        end
+      end
+      @request = request_class.new(@uri.to_s)
+      username = @username || Config.username
+      Variables.substitute!(username) if username
+      password = @password || Config.password
+      Variables.substitute!(password) if password
+      if username && password 
+        @request.basic_auth(username, password)
+      end
+      form_data = Hash.new
+      @headers.each { |header| @request[header['name']] = header['value'] }
+      @params.each { |param| form_data[param['name']] = param['value'] }
+      @request.set_form_data(form_data) unless form_data.empty?
+      Log.request(@request)
+
+      # 4. Send request and check response code
+      @oks = @valid_codes.map { |r| r.to_s } if @valid_codes
+      @oks ||= %w{200 201 202 203 204 205 206}
+     end
+    
+    # Actually send the request
+    def send
+      sleep(delay_seconds) # Delay request if needed
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      http.use_ssl = Config.use_ssl
+      begin
+        res = http.start { |http| @response = http.request(@request) }
+      rescue Exception => e
+        @failures << "Exception raised while making request: #{e.message}"
+      end
+      if @failures.size == 0
+        @send_count += 1
+        if @oks.include?(res.code)
+          Log.response(@response)
+        else
+          Log.response(@response, false)
+          @failures << "Request returned #{res.code}"
+        end
+      end
+    end
+    
+    # Does response include given header or body field? 
+    def has_response_field?(field, target)
+      return unless @response
+      return @response.key?(field) if target == 'header'
+      doc = REXML::Document.new(@response.body) rescue nil
+      return doc && !doc.elements[field].nil?
+    end
+    
+    # Get value of response header or body field
+    def get_response_field(field, target)
+      return unless @response
+      return @response[field] if target == 'header'
+      doc = REXML::Document.new(@response.body)
+      elem = doc.elements[field]
+      return elem.get_text.to_s if elem
+    end
+
+    protected
+    
+    # Calculate number of seconds to wait before sending request
+    def delay_seconds
+      seconds = nil
+      if delay = @delay || Config.delay
+        min_delay = max_delay = nil
+        if delay =~ /([\d]+)\.\.([\d]+)/
+          min_delay = Regexp.last_match[1].to_i
+          max_delay = Regexp.last_match[2].to_i
+        elsif delay.to_i.to_s == delay
+          min_delay = max_delay = delay.to_i
+        end
+        if min_delay && max_delay
+          seconds = rand(max_delay - min_delay + 1) + min_delay
+        end
+      end
+      seconds || 0
+    end
+
+  end
+
+end