aws-sdk 1.0.0

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--files guides/*
+--files NOTICE.txt
+--files LICENSE.txt
+--exclude '~$'
+--title 'AWS SDK for Ruby'

data/LICENSE.txt

@@ -0,0 +1,171 @@
+Apache License
+Version 2.0, January 2004
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control
+with that entity. For the purposes of this definition, "control" means
+(i) the power, direct or indirect, to cause the direction or
+management of such entity, whether by contract or otherwise, or (ii)
+ownership of fifty percent (50%) or more of the outstanding shares, or
+(iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but not
+limited to compiled object code, generated documentation, and
+conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object
+form, made available under the License, as indicated by a copyright
+notice that is included in or attached to the work (an example is
+provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the
+purposes of this License, Derivative Works shall not include works
+that remain separable from, or merely link (or bind by name) to the
+interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the
+original version of the Work and any modifications or additions to
+that Work or Derivative Works thereof, that is intentionally submitted
+to Licensor for inclusion in the Work by the copyright owner or by an
+individual or Legal Entity authorized to submit on behalf of the
+copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent to
+the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control
+systems, and issue tracking systems that are managed by, or on behalf
+of, the Licensor for the purpose of discussing and improving the Work,
+but excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of, publicly
+display, publicly perform, sublicense, and distribute the Work and
+such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except
+as stated in this section) patent license to make, have made, use,
+offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such
+Contributor that are necessarily infringed by their Contribution(s)
+alone or by combination of their Contribution(s) with the Work to
+which such Contribution(s) was submitted. If You institute patent
+litigation against any entity (including a cross-claim or counterclaim
+in a lawsuit) alleging that the Work or a Contribution incorporated
+within the Work constitutes direct or contributory patent
+infringement, then any patent licenses granted to You under this
+License for that Work shall terminate as of the date such litigation
+is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work
+or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You meet
+the following conditions:
+
+   1.  You must give any other recipients of the Work or Derivative
+   Works a copy of this License; and
+   2.  You must cause any modified files to carry prominent notices
+   stating that You changed the files; and
+   3.  You must retain, in the Source form of any Derivative Works
+   that You distribute, all copyright, patent, trademark, and
+   attribution notices from the Source form of the Work, excluding
+   those notices that do not pertain to any part of the Derivative
+   Works; and
+   4.  If the Work includes a "NOTICE" text file as part of its
+   distribution, then any Derivative Works that You distribute must
+   include a readable copy of the attribution notices contained within
+   such NOTICE file, excluding those notices that do not pertain to
+   any part of the Derivative Works, in at least one of the following
+   places: within a NOTICE text file distributed as part of the
+   Derivative Works; within the Source form or documentation, if
+   provided along with the Derivative Works; or, within a display
+   generated by the Derivative Works, if and wherever such third-party
+   notices normally appear. The contents of the NOTICE file are for
+   informational purposes only and do not modify the License. You may
+   add Your own attribution notices within Derivative Works that You
+   distribute, alongside or as an addendum to the NOTICE text from the
+   Work, provided that such additional attribution notices cannot be
+   construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may
+provide additional or different license terms and conditions for use,
+reproduction, or distribution of Your modifications, or for any such
+Derivative Works as a whole, provided Your use, reproduction, and
+distribution of the Work otherwise complies with the conditions stated
+in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work by
+You to the Licensor shall be under the terms and conditions of this
+License, without any additional terms or conditions. Notwithstanding
+the above, nothing herein shall supersede or modify the terms of any
+separate license agreement you may have executed with Licensor
+regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed
+to in writing, Licensor provides the Work (and each Contributor
+provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied, including, without
+limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
+MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely
+responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your
+exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise, unless
+required by applicable law (such as deliberate and grossly negligent
+acts) or agreed to in writing, shall any Contributor be liable to You
+for damages, including any direct, indirect, special, incidental, or
+consequential damages of any character arising as a result of this
+License or out of the use or inability to use the Work (including but
+not limited to damages for loss of goodwill, work stoppage, computer
+failure or malfunction, or any and all other commercial damages or
+losses), even if such Contributor has been advised of the possibility
+of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer, and
+charge a fee for, acceptance of support, warranty, indemnity, or other
+liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only on
+Your own behalf and on Your sole responsibility, not on behalf of any
+other Contributor, and only if You agree to indemnify, defend, and
+hold each Contributor harmless for any liability incurred by, or
+claims asserted against, such Contributor by reason of your accepting
+any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/NOTICE.txt

@@ -0,0 +1,2 @@
+AWS SDK for Ruby
+Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.

data/README.rdoc

@@ -0,0 +1,189 @@
+= Getting Started with the AWS SDK for Ruby
+
+The AWS SDK for Ruby helps you to get started building applications
+using AWS infrastructure services, including Amazon Simple Storage
+Service (Amazon S3), Amazon Elastic Compute Cloud (Amazon EC2), Amazon
+SimpleDB, and more. This guide shows how you can start building Ruby
+and Rails applications on the Amazon Web Services platform with the
+AWS Ruby gem.
+
+= Get Set Up
+
+To get set up, you must sign up for Amazon Web Services, get your AWS
+credentials, and set up your environment.
+
+== Sign Up for AWS Products
+
+Before you can begin, you must sign up for each AWS product you want
+to use. The sample included in the SDK uses Amazon S3, so we'll use
+that product as an example here.
+
+=== To sign up for a product
+
+1. Go to the home page for the product, for example
+   http://aws.amazon.com/s3.
+
+   *Tip:* Go to http://aws.amazon.com/products for a list of links to all our products.
+
+2. Click the sign-up button on the top right corner of the page.
+
+3. Follow the on-screen instructions. If you don't already have an AWS
+   account, you are prompted to create one as part of the sign-up
+   process.
+
+AWS sends you a confirmation e-mail after the sign-up process is
+complete. You can view your current account activity or manage your
+account at any time, by going to http://aws.amazon.com and clicking
+the *Account* tab.
+
+== Get Your Credentials
+
+To use the AWS SDK for Ruby, you need your AWS Access Key ID and Secret Access Key.
+
+=== To get your AWS Access Key ID and Secret Access Key
+
+1. Go to http://aws.amazon.com.
+
+2. Click *Account* and then click <b>Security Credentials</b>.
+   The Security Credentials page displays (you might be prompted to log in).
+
+3. Scroll down to Access Credentials and make sure the <b>Access Keys</b> tab
+   is selected.  The AWS Access Key ID appears in the Access Key column.
+
+4. To view the Secret Access Key, click *Show*.
+
+   *Important!* Your Secret Access Key is a secret, which only you and
+   AWS should know. It is important to keep it confidential to protect
+   your account. Store it securely in a safe place. Never include it in
+   your requests to AWS, and never e-mail it to anyone. Do not share it
+   outside your organization, even if an inquiry appears to come from AWS
+   or Amazon.com. No one who legitimately represents Amazon will ever ask
+   you for your Secret Access Key.
+
+== Set Up Your Environment
+
+The AWS Ruby gem runs on Ruby 1.8.7 and later. If you have an older
+version of Ruby, RVM is a great way to get started using the latest
+version.
+
+= Install the SDK
+
+To install the AWS Ruby gem, just enter:
+
+  gem install aws-sdk
+
+= Run the Samples
+
+Now that you've installed the gem, you can run the samples, which you
+can find in our GitHub repository:
+
+  $ git clone git://github.com/amazonwebservices/aws-sdk-for-ruby.git
+  $ cd aws-sdk-for-ruby/samples/
+
+The subdirectories of the +samples+ directory contain several code
+samples that you can run.  These samples demonstrate basic usage of
+the SDK features.
+
+== To run the Amazon S3 Sample
+
+1. Create a file named config.yml in the samples directory as follows:
+
+     # Fill in your AWS Access Key ID and Secret Access Key
+     # http://aws.amazon.com/security-credentials
+     access_key_id: REPLACE_WITH_ACCESS_KEY_ID
+     secret_access_key: REPLACE_WITH_SECRET_ACCESS_KEY
+
+2. Run a sample script with the Ruby interpreter. For example, to run
+   the s3/upload_file.rb sample:
+
+     $ echo "Hello, World!" > helloworld.txt
+     $ ruby s3/upload_file.rb unique-bucket-name helloworld.txt
+
+== To use the AWS ORM in a Rails 3 application
+
+1. Install the gem:
+
+     $ gem install aws-sdk
+
+2. Start a new Rails project:
+
+     $ gem install rails
+     $ rails new myapp
+     $ cd myapp/
+
+3. Add the following line to your Gemfile:
+
+     gem 'aws-sdk'
+
+4. Install dependencies:
+
+     $ bundle install
+
+5. Create config/aws.yml as follows:
+
+     # Fill in your AWS Access Key ID and Secret Access Key
+     # http://aws.amazon.com/security-credentials
+     access_key_id: REPLACE_WITH_ACCESS_KEY_ID
+     secret_access_key: REPLACE_WITH_SECRET_ACCESS_KEY
+
+6. Create config/initializers/aws.rb as follows:
+
+     # load the libraries
+     require 'aws'
+     # log requests using the default rails logger
+     AWS.config(:logger => Rails.logger)
+     # load credentials from a file
+     config_path = File.expand_path(File.dirname(__FILE__)+"/../aws.yml")
+     AWS.config(YAML.load(File.read(config_path)))
+
+7. Create app/models/my_record.rb as follows:
+
+     class MyRecord < AWS::Record::Base
+       string_attr :name
+     end
+
+8. Create the SimpleDB domain:
+
+     $ rails console
+     > MyRecord.create_domain
+
+Now, you can play around with the model by creating some records and querying them:
+
+  > MyRecord.find(:all).to_a
+  => []
+  > MyRecord.new(:name => "The first one").save
+  => true
+  > MyRecord.new(:name => "The second one").save
+  => true
+  > MyRecord.where('name like ?', "%first%").count
+  => 1
+
+Exit the rails console before continuing to the next step:
+
+  > exit
+
+9. Generate a scaffold controller for your model:
+
+     $ rails generate scaffold_controller MyRecord name:string
+     $ rails server
+
+10. Add a route to your scaffold controller in config/routes.rb:
+
+      Myapp::Application.routes.draw do
+        # add this line:
+        resources :my_records
+      end
+
+11. Now, you can create records in the browser at http://localhost:3000/my_records.
+
+= Where Do I Go from Here?
+
+For more information about the AWS SDK for Ruby, including a complete
+list of supported AWS products, go to
+http://aws.amazon.com/sdkforruby.
+
+The SDK reference documentation provides information about both the
+AWS Ruby gem and AWS Rails integration gem. You can find it at
+http://docs.amazonwebservices.com/AWSRubySDK/latest.
+
+Licensed under Apache 2.0. See {file:LICENSE.txt} and {file:NOTICE.txt} files.

data/lib/aws-sdk.rb

@@ -0,0 +1,14 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'aws'

data/lib/aws.rb

@@ -0,0 +1,63 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+# AWS is the root module for all of the Amazon Web Services.  It is also 
+# where you can configure you access to AWS.  
+#
+# = Supported Services
+#
+# The currently supported services are:
+#
+# * {EC2}
+# * {S3}
+# * {SimpleDB}
+# * {SimpleEmailService}
+# * {SNS}
+# * {SQS}
+#
+# = AWS::Record
+#
+# In addition to the above services, bundled is an ORM based on AWS services
+# See {AWS::Record} for more information.
+#
+# = Configuration
+#
+# You call {AWS.config} with a hash of options to configure your 
+# access to the Amazon Web Services.  
+#
+# At a minimum you need to set your access credentials. See {AWS.config} 
+# for additional configuration options.
+#
+#    AWS.config(
+#      :access_key_id => 'ACCESS_KEY_ID',
+#      :secret_access_key => 'SECRET_ACCESS_KEY') 
+#
+# == Rails
+# 
+# If you are loading AWS inside a Rails web application, place your
+# configuration inside:
+#
+#   config/initializers/aws.rb
+#
+module AWS; end
+
+require 'aws/common'
+
+%w(ec2 s3 simple_db simple_email_service sns sqs record rails).each do |service|
+  $:.each do |load_path|
+    if (Pathname.new(load_path) + "aws" + "#{service}.rb").exist?
+      require "aws/#{service}"
+      break
+    end
+  end
+end