aws_sdk 3.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (390) hide show
  1. data/lib/aws-sdk.rb +14 -0
  2. data/lib/aws.rb +49 -0
  3. data/lib/aws/api_config/AutoScaling-2011-01-01.yml +791 -0
  4. data/lib/aws/api_config/CloudFormation-2010-05-15.yml +303 -0
  5. data/lib/aws/api_config/DynamoDB-2011-12-05.yml +540 -0
  6. data/lib/aws/api_config/EC2-2011-12-15.yml +3638 -0
  7. data/lib/aws/api_config/EC2-2012-04-01.yml +3739 -0
  8. data/lib/aws/api_config/ELB-2011-08-15.yml +512 -0
  9. data/lib/aws/api_config/IAM-2010-05-08.yml +1221 -0
  10. data/lib/aws/api_config/SNS-2010-03-31.yml +248 -0
  11. data/lib/aws/api_config/SQS-2011-10-01.yml +314 -0
  12. data/lib/aws/api_config/STS-2011-06-15.yml +54 -0
  13. data/lib/aws/api_config/SimpleDB-2009-04-15.yml +305 -0
  14. data/lib/aws/api_config/SimpleEmailService-2010-12-01.yml +231 -0
  15. data/lib/aws/api_config/SimpleWorkflow-2012-01-25.yml +721 -0
  16. data/lib/aws/auto_scaling.rb +162 -0
  17. data/lib/aws/auto_scaling/activity.rb +102 -0
  18. data/lib/aws/auto_scaling/activity_collection.rb +82 -0
  19. data/lib/aws/auto_scaling/client.rb +765 -0
  20. data/lib/aws/auto_scaling/config.rb +18 -0
  21. data/lib/aws/auto_scaling/errors.rb +22 -0
  22. data/lib/aws/auto_scaling/group.rb +420 -0
  23. data/lib/aws/auto_scaling/group_collection.rb +96 -0
  24. data/lib/aws/auto_scaling/group_options.rb +146 -0
  25. data/lib/aws/auto_scaling/instance.rb +192 -0
  26. data/lib/aws/auto_scaling/instance_collection.rb +63 -0
  27. data/lib/aws/auto_scaling/launch_configuration.rb +150 -0
  28. data/lib/aws/auto_scaling/launch_configuration_collection.rb +144 -0
  29. data/lib/aws/auto_scaling/notification_configuration.rb +89 -0
  30. data/lib/aws/auto_scaling/notification_configuration_collection.rb +184 -0
  31. data/lib/aws/auto_scaling/request.rb +23 -0
  32. data/lib/aws/auto_scaling/scaling_policy.rb +125 -0
  33. data/lib/aws/auto_scaling/scaling_policy_collection.rb +72 -0
  34. data/lib/aws/auto_scaling/scaling_policy_options.rb +61 -0
  35. data/lib/aws/auto_scaling/scheduled_action.rb +145 -0
  36. data/lib/aws/auto_scaling/scheduled_action_collection.rb +195 -0
  37. data/lib/aws/auto_scaling/tag.rb +59 -0
  38. data/lib/aws/auto_scaling/tag_collection.rb +112 -0
  39. data/lib/aws/cloud_formation.rb +270 -0
  40. data/lib/aws/cloud_formation/client.rb +339 -0
  41. data/lib/aws/cloud_formation/config.rb +18 -0
  42. data/lib/aws/cloud_formation/errors.rb +22 -0
  43. data/lib/aws/cloud_formation/request.rb +29 -0
  44. data/lib/aws/cloud_formation/stack.rb +256 -0
  45. data/lib/aws/cloud_formation/stack_collection.rb +206 -0
  46. data/lib/aws/cloud_formation/stack_event.rb +75 -0
  47. data/lib/aws/cloud_formation/stack_event_collection.rb +47 -0
  48. data/lib/aws/cloud_formation/stack_options.rb +72 -0
  49. data/lib/aws/cloud_formation/stack_output.rb +53 -0
  50. data/lib/aws/cloud_formation/stack_resource.rb +117 -0
  51. data/lib/aws/cloud_formation/stack_resource_collection.rb +84 -0
  52. data/lib/aws/cloud_formation/stack_resource_summary_collection.rb +72 -0
  53. data/lib/aws/cloud_formation/stack_summary.rb +71 -0
  54. data/lib/aws/cloud_formation/stack_summary_collection.rb +127 -0
  55. data/lib/aws/core.rb +474 -0
  56. data/lib/aws/core/async_handle.rb +90 -0
  57. data/lib/aws/core/autoloader.rb +64 -0
  58. data/lib/aws/core/cacheable.rb +78 -0
  59. data/lib/aws/core/client.rb +541 -0
  60. data/lib/aws/core/client/query_json.rb +110 -0
  61. data/lib/aws/core/client/query_xml.rb +122 -0
  62. data/lib/aws/core/collection.rb +234 -0
  63. data/lib/aws/core/collection/limitable.rb +99 -0
  64. data/lib/aws/core/collection/simple.rb +90 -0
  65. data/lib/aws/core/configuration.rb +445 -0
  66. data/lib/aws/core/data.rb +242 -0
  67. data/lib/aws/core/default_signer.rb +67 -0
  68. data/lib/aws/core/http/curb_handler.rb +136 -0
  69. data/lib/aws/core/http/handler.rb +77 -0
  70. data/lib/aws/core/http/httparty_handler.rb +114 -0
  71. data/lib/aws/core/http/net_http_handler.rb +85 -0
  72. data/lib/aws/core/http/request.rb +250 -0
  73. data/lib/aws/core/http/response.rb +74 -0
  74. data/lib/aws/core/indifferent_hash.rb +88 -0
  75. data/lib/aws/core/inflection.rb +47 -0
  76. data/lib/aws/core/lazy_error_classes.rb +90 -0
  77. data/lib/aws/core/log_formatter.rb +454 -0
  78. data/lib/aws/core/meta_utils.rb +45 -0
  79. data/lib/aws/core/model.rb +57 -0
  80. data/lib/aws/core/naming.rb +30 -0
  81. data/lib/aws/core/option_grammar.rb +700 -0
  82. data/lib/aws/core/page_result.rb +73 -0
  83. data/lib/aws/core/policy.rb +916 -0
  84. data/lib/aws/core/resource.rb +408 -0
  85. data/lib/aws/core/resource_cache.rb +40 -0
  86. data/lib/aws/core/response.rb +202 -0
  87. data/lib/aws/core/response_cache.rb +50 -0
  88. data/lib/aws/core/service_interface.rb +61 -0
  89. data/lib/aws/core/session_signer.rb +90 -0
  90. data/lib/aws/core/signature/version_2.rb +42 -0
  91. data/lib/aws/core/signature/version_3.rb +73 -0
  92. data/lib/aws/core/signature/version_3_http.rb +72 -0
  93. data/lib/aws/core/signature/version_4.rb +138 -0
  94. data/lib/aws/core/uri_escape.rb +42 -0
  95. data/lib/aws/core/xml/frame.rb +242 -0
  96. data/lib/aws/core/xml/frame_stack.rb +85 -0
  97. data/lib/aws/core/xml/grammar.rb +299 -0
  98. data/lib/aws/core/xml/parser.rb +70 -0
  99. data/lib/aws/core/xml/root_frame.rb +65 -0
  100. data/lib/aws/core/xml/sax_handlers/libxml.rb +47 -0
  101. data/lib/aws/core/xml/sax_handlers/nokogiri.rb +55 -0
  102. data/lib/aws/core/xml/sax_handlers/ox.rb +41 -0
  103. data/lib/aws/core/xml/sax_handlers/rexml.rb +43 -0
  104. data/lib/aws/core/xml/stub.rb +123 -0
  105. data/lib/aws/dynamo_db.rb +213 -0
  106. data/lib/aws/dynamo_db/attribute_collection.rb +460 -0
  107. data/lib/aws/dynamo_db/batch_get.rb +206 -0
  108. data/lib/aws/dynamo_db/batch_write.rb +251 -0
  109. data/lib/aws/dynamo_db/client.rb +888 -0
  110. data/lib/aws/dynamo_db/config.rb +20 -0
  111. data/lib/aws/dynamo_db/errors.rb +20 -0
  112. data/lib/aws/dynamo_db/expectations.rb +40 -0
  113. data/lib/aws/dynamo_db/item.rb +130 -0
  114. data/lib/aws/dynamo_db/item_collection.rb +852 -0
  115. data/lib/aws/dynamo_db/item_data.rb +31 -0
  116. data/lib/aws/dynamo_db/keys.rb +41 -0
  117. data/lib/aws/dynamo_db/primary_key_element.rb +47 -0
  118. data/lib/aws/dynamo_db/request.rb +28 -0
  119. data/lib/aws/dynamo_db/resource.rb +33 -0
  120. data/lib/aws/dynamo_db/table.rb +489 -0
  121. data/lib/aws/dynamo_db/table_collection.rb +165 -0
  122. data/lib/aws/dynamo_db/types.rb +86 -0
  123. data/lib/aws/ec2.rb +431 -0
  124. data/lib/aws/ec2/attachment.rb +140 -0
  125. data/lib/aws/ec2/attachment_collection.rb +54 -0
  126. data/lib/aws/ec2/availability_zone.rb +87 -0
  127. data/lib/aws/ec2/availability_zone_collection.rb +43 -0
  128. data/lib/aws/ec2/block_device_mappings.rb +53 -0
  129. data/lib/aws/ec2/client.rb +4121 -0
  130. data/lib/aws/ec2/collection.rb +36 -0
  131. data/lib/aws/ec2/config.rb +18 -0
  132. data/lib/aws/ec2/config_transform.rb +63 -0
  133. data/lib/aws/ec2/customer_gateway.rb +90 -0
  134. data/lib/aws/ec2/customer_gateway_collection.rb +73 -0
  135. data/lib/aws/ec2/dhcp_options.rb +106 -0
  136. data/lib/aws/ec2/dhcp_options_collection.rb +87 -0
  137. data/lib/aws/ec2/elastic_ip.rb +157 -0
  138. data/lib/aws/ec2/elastic_ip_collection.rb +97 -0
  139. data/lib/aws/ec2/errors.rb +32 -0
  140. data/lib/aws/ec2/filtered_collection.rb +90 -0
  141. data/lib/aws/ec2/has_permissions.rb +44 -0
  142. data/lib/aws/ec2/image.rb +254 -0
  143. data/lib/aws/ec2/image_collection.rb +228 -0
  144. data/lib/aws/ec2/instance.rb +669 -0
  145. data/lib/aws/ec2/instance_collection.rb +346 -0
  146. data/lib/aws/ec2/internet_gateway.rb +122 -0
  147. data/lib/aws/ec2/internet_gateway/attachment.rb +78 -0
  148. data/lib/aws/ec2/internet_gateway_collection.rb +54 -0
  149. data/lib/aws/ec2/key_pair.rb +82 -0
  150. data/lib/aws/ec2/key_pair_collection.rb +99 -0
  151. data/lib/aws/ec2/network_acl.rb +256 -0
  152. data/lib/aws/ec2/network_acl/association.rb +56 -0
  153. data/lib/aws/ec2/network_acl/entry.rb +147 -0
  154. data/lib/aws/ec2/network_acl_collection.rb +64 -0
  155. data/lib/aws/ec2/network_interface.rb +228 -0
  156. data/lib/aws/ec2/network_interface/attachment.rb +100 -0
  157. data/lib/aws/ec2/network_interface_collection.rb +103 -0
  158. data/lib/aws/ec2/permission_collection.rb +174 -0
  159. data/lib/aws/ec2/region.rb +97 -0
  160. data/lib/aws/ec2/region_collection.rb +51 -0
  161. data/lib/aws/ec2/request.rb +22 -0
  162. data/lib/aws/ec2/reserved_instances.rb +53 -0
  163. data/lib/aws/ec2/reserved_instances_collection.rb +40 -0
  164. data/lib/aws/ec2/reserved_instances_offering.rb +58 -0
  165. data/lib/aws/ec2/reserved_instances_offering_collection.rb +39 -0
  166. data/lib/aws/ec2/resource.rb +161 -0
  167. data/lib/aws/ec2/resource_tag_collection.rb +211 -0
  168. data/lib/aws/ec2/route_table.rb +205 -0
  169. data/lib/aws/ec2/route_table/association.rb +119 -0
  170. data/lib/aws/ec2/route_table/route.rb +113 -0
  171. data/lib/aws/ec2/route_table_collection.rb +72 -0
  172. data/lib/aws/ec2/security_group.rb +458 -0
  173. data/lib/aws/ec2/security_group/egress_ip_permission_collection.rb +63 -0
  174. data/lib/aws/ec2/security_group/ingress_ip_permission_collection.rb +61 -0
  175. data/lib/aws/ec2/security_group/ip_permission.rb +128 -0
  176. data/lib/aws/ec2/security_group_collection.rb +135 -0
  177. data/lib/aws/ec2/snapshot.rb +143 -0
  178. data/lib/aws/ec2/snapshot_collection.rb +131 -0
  179. data/lib/aws/ec2/subnet.rb +161 -0
  180. data/lib/aws/ec2/subnet_collection.rb +115 -0
  181. data/lib/aws/ec2/tag.rb +81 -0
  182. data/lib/aws/ec2/tag_collection.rb +107 -0
  183. data/lib/aws/ec2/tagged_collection.rb +53 -0
  184. data/lib/aws/ec2/tagged_item.rb +85 -0
  185. data/lib/aws/ec2/volume.rb +170 -0
  186. data/lib/aws/ec2/volume_collection.rb +97 -0
  187. data/lib/aws/ec2/vpc.rb +166 -0
  188. data/lib/aws/ec2/vpc_collection.rb +70 -0
  189. data/lib/aws/ec2/vpn_connection.rb +99 -0
  190. data/lib/aws/ec2/vpn_connection/telemetry.rb +49 -0
  191. data/lib/aws/ec2/vpn_connection_collection.rb +96 -0
  192. data/lib/aws/ec2/vpn_gateway.rb +123 -0
  193. data/lib/aws/ec2/vpn_gateway/attachment.rb +45 -0
  194. data/lib/aws/ec2/vpn_gateway_collection.rb +77 -0
  195. data/lib/aws/elb.rb +65 -0
  196. data/lib/aws/elb/availability_zone_collection.rb +138 -0
  197. data/lib/aws/elb/backend_server_policy_collection.rb +140 -0
  198. data/lib/aws/elb/client.rb +539 -0
  199. data/lib/aws/elb/config.rb +18 -0
  200. data/lib/aws/elb/errors.rb +26 -0
  201. data/lib/aws/elb/instance_collection.rb +174 -0
  202. data/lib/aws/elb/listener.rb +189 -0
  203. data/lib/aws/elb/listener_collection.rb +119 -0
  204. data/lib/aws/elb/listener_opts.rb +45 -0
  205. data/lib/aws/elb/load_balancer.rb +253 -0
  206. data/lib/aws/elb/load_balancer_collection.rb +113 -0
  207. data/lib/aws/elb/load_balancer_policy.rb +93 -0
  208. data/lib/aws/elb/load_balancer_policy_collection.rb +208 -0
  209. data/lib/aws/elb/request.rb +23 -0
  210. data/lib/aws/errors.rb +122 -0
  211. data/lib/aws/iam.rb +418 -0
  212. data/lib/aws/iam/access_key.rb +180 -0
  213. data/lib/aws/iam/access_key_collection.rb +128 -0
  214. data/lib/aws/iam/account_alias_collection.rb +79 -0
  215. data/lib/aws/iam/client.rb +1609 -0
  216. data/lib/aws/iam/collection.rb +83 -0
  217. data/lib/aws/iam/config.rb +18 -0
  218. data/lib/aws/iam/errors.rb +22 -0
  219. data/lib/aws/iam/group.rb +111 -0
  220. data/lib/aws/iam/group_collection.rb +132 -0
  221. data/lib/aws/iam/group_policy_collection.rb +47 -0
  222. data/lib/aws/iam/group_user_collection.rb +84 -0
  223. data/lib/aws/iam/login_profile.rb +99 -0
  224. data/lib/aws/iam/mfa_device.rb +52 -0
  225. data/lib/aws/iam/mfa_device_collection.rb +127 -0
  226. data/lib/aws/iam/policy.rb +46 -0
  227. data/lib/aws/iam/policy_collection.rb +188 -0
  228. data/lib/aws/iam/request.rb +29 -0
  229. data/lib/aws/iam/resource.rb +71 -0
  230. data/lib/aws/iam/server_certificate.rb +141 -0
  231. data/lib/aws/iam/server_certificate_collection.rb +138 -0
  232. data/lib/aws/iam/signing_certificate.rb +169 -0
  233. data/lib/aws/iam/signing_certificate_collection.rb +131 -0
  234. data/lib/aws/iam/user.rb +205 -0
  235. data/lib/aws/iam/user_collection.rb +133 -0
  236. data/lib/aws/iam/user_group_collection.rb +98 -0
  237. data/lib/aws/iam/user_policy.rb +90 -0
  238. data/lib/aws/iam/user_policy_collection.rb +45 -0
  239. data/lib/aws/iam/virtual_mfa_device.rb +139 -0
  240. data/lib/aws/iam/virtual_mfa_device_collection.rb +73 -0
  241. data/lib/aws/rails.rb +195 -0
  242. data/lib/aws/record.rb +116 -0
  243. data/lib/aws/record/abstract_base.rb +645 -0
  244. data/lib/aws/record/attributes.rb +384 -0
  245. data/lib/aws/record/conversion.rb +38 -0
  246. data/lib/aws/record/dirty_tracking.rb +285 -0
  247. data/lib/aws/record/errors.rb +143 -0
  248. data/lib/aws/record/exceptions.rb +48 -0
  249. data/lib/aws/record/hash_model.rb +161 -0
  250. data/lib/aws/record/hash_model/attributes.rb +182 -0
  251. data/lib/aws/record/hash_model/finder_methods.rb +172 -0
  252. data/lib/aws/record/hash_model/scope.rb +108 -0
  253. data/lib/aws/record/model.rb +427 -0
  254. data/lib/aws/record/model/attributes.rb +379 -0
  255. data/lib/aws/record/model/finder_methods.rb +232 -0
  256. data/lib/aws/record/model/scope.rb +213 -0
  257. data/lib/aws/record/naming.rb +31 -0
  258. data/lib/aws/record/scope.rb +199 -0
  259. data/lib/aws/record/validations.rb +694 -0
  260. data/lib/aws/record/validator.rb +237 -0
  261. data/lib/aws/record/validators/acceptance.rb +51 -0
  262. data/lib/aws/record/validators/block.rb +38 -0
  263. data/lib/aws/record/validators/confirmation.rb +43 -0
  264. data/lib/aws/record/validators/count.rb +108 -0
  265. data/lib/aws/record/validators/exclusion.rb +43 -0
  266. data/lib/aws/record/validators/format.rb +57 -0
  267. data/lib/aws/record/validators/inclusion.rb +56 -0
  268. data/lib/aws/record/validators/length.rb +107 -0
  269. data/lib/aws/record/validators/method.rb +33 -0
  270. data/lib/aws/record/validators/numericality.rb +138 -0
  271. data/lib/aws/record/validators/presence.rb +45 -0
  272. data/lib/aws/s3.rb +135 -0
  273. data/lib/aws/s3/access_control_list.rb +250 -0
  274. data/lib/aws/s3/acl_object.rb +264 -0
  275. data/lib/aws/s3/bucket.rb +393 -0
  276. data/lib/aws/s3/bucket_collection.rb +143 -0
  277. data/lib/aws/s3/bucket_lifecycle_configuration.rb +360 -0
  278. data/lib/aws/s3/bucket_version_collection.rb +77 -0
  279. data/lib/aws/s3/client.rb +1184 -0
  280. data/lib/aws/s3/client/xml.rb +177 -0
  281. data/lib/aws/s3/config.rb +26 -0
  282. data/lib/aws/s3/data_options.rb +100 -0
  283. data/lib/aws/s3/errors.rb +81 -0
  284. data/lib/aws/s3/multipart_upload.rb +317 -0
  285. data/lib/aws/s3/multipart_upload_collection.rb +68 -0
  286. data/lib/aws/s3/object_collection.rb +337 -0
  287. data/lib/aws/s3/object_metadata.rb +96 -0
  288. data/lib/aws/s3/object_upload_collection.rb +77 -0
  289. data/lib/aws/s3/object_version.rb +143 -0
  290. data/lib/aws/s3/object_version_collection.rb +89 -0
  291. data/lib/aws/s3/paginated_collection.rb +75 -0
  292. data/lib/aws/s3/policy.rb +74 -0
  293. data/lib/aws/s3/prefix_and_delimiter_collection.rb +47 -0
  294. data/lib/aws/s3/prefixed_collection.rb +81 -0
  295. data/lib/aws/s3/presigned_post.rb +553 -0
  296. data/lib/aws/s3/request.rb +201 -0
  297. data/lib/aws/s3/s3_object.rb +1037 -0
  298. data/lib/aws/s3/tree.rb +118 -0
  299. data/lib/aws/s3/tree/branch_node.rb +68 -0
  300. data/lib/aws/s3/tree/child_collection.rb +104 -0
  301. data/lib/aws/s3/tree/leaf_node.rb +94 -0
  302. data/lib/aws/s3/tree/node.rb +22 -0
  303. data/lib/aws/s3/tree/parent.rb +87 -0
  304. data/lib/aws/s3/uploaded_part.rb +80 -0
  305. data/lib/aws/s3/uploaded_part_collection.rb +84 -0
  306. data/lib/aws/simple_db.rb +217 -0
  307. data/lib/aws/simple_db/attribute.rb +154 -0
  308. data/lib/aws/simple_db/attribute_collection.rb +231 -0
  309. data/lib/aws/simple_db/client.rb +349 -0
  310. data/lib/aws/simple_db/config.rb +20 -0
  311. data/lib/aws/simple_db/consistent_read_option.rb +42 -0
  312. data/lib/aws/simple_db/delete_attributes.rb +62 -0
  313. data/lib/aws/simple_db/domain.rb +121 -0
  314. data/lib/aws/simple_db/domain_collection.rb +113 -0
  315. data/lib/aws/simple_db/domain_metadata.rb +110 -0
  316. data/lib/aws/simple_db/errors.rb +55 -0
  317. data/lib/aws/simple_db/expect_condition_option.rb +45 -0
  318. data/lib/aws/simple_db/item.rb +93 -0
  319. data/lib/aws/simple_db/item_collection.rb +649 -0
  320. data/lib/aws/simple_db/item_data.rb +73 -0
  321. data/lib/aws/simple_db/put_attributes.rb +60 -0
  322. data/lib/aws/simple_db/request.rb +23 -0
  323. data/lib/aws/simple_email_service.rb +426 -0
  324. data/lib/aws/simple_email_service/client.rb +286 -0
  325. data/lib/aws/simple_email_service/config.rb +19 -0
  326. data/lib/aws/simple_email_service/email_address_collection.rb +69 -0
  327. data/lib/aws/simple_email_service/errors.rb +22 -0
  328. data/lib/aws/simple_email_service/identity.rb +91 -0
  329. data/lib/aws/simple_email_service/identity_collection.rb +81 -0
  330. data/lib/aws/simple_email_service/quotas.rb +64 -0
  331. data/lib/aws/simple_email_service/request.rb +29 -0
  332. data/lib/aws/simple_workflow.rb +226 -0
  333. data/lib/aws/simple_workflow/activity_task.rb +173 -0
  334. data/lib/aws/simple_workflow/activity_task_collection.rb +123 -0
  335. data/lib/aws/simple_workflow/activity_type.rb +131 -0
  336. data/lib/aws/simple_workflow/activity_type_collection.rb +93 -0
  337. data/lib/aws/simple_workflow/client.rb +1434 -0
  338. data/lib/aws/simple_workflow/config.rb +18 -0
  339. data/lib/aws/simple_workflow/count.rb +49 -0
  340. data/lib/aws/simple_workflow/decision_task.rb +601 -0
  341. data/lib/aws/simple_workflow/decision_task_collection.rb +225 -0
  342. data/lib/aws/simple_workflow/domain.rb +122 -0
  343. data/lib/aws/simple_workflow/domain_collection.rb +169 -0
  344. data/lib/aws/simple_workflow/errors.rb +20 -0
  345. data/lib/aws/simple_workflow/history_event.rb +276 -0
  346. data/lib/aws/simple_workflow/history_event_collection.rb +76 -0
  347. data/lib/aws/simple_workflow/option_formatters.rb +82 -0
  348. data/lib/aws/simple_workflow/request.rb +36 -0
  349. data/lib/aws/simple_workflow/resource.rb +94 -0
  350. data/lib/aws/simple_workflow/type.rb +89 -0
  351. data/lib/aws/simple_workflow/type_collection.rb +140 -0
  352. data/lib/aws/simple_workflow/workflow_execution.rb +386 -0
  353. data/lib/aws/simple_workflow/workflow_execution_collection.rb +617 -0
  354. data/lib/aws/simple_workflow/workflow_type.rb +177 -0
  355. data/lib/aws/simple_workflow/workflow_type_collection.rb +91 -0
  356. data/lib/aws/sns.rb +74 -0
  357. data/lib/aws/sns/client.rb +371 -0
  358. data/lib/aws/sns/config.rb +18 -0
  359. data/lib/aws/sns/errors.rb +22 -0
  360. data/lib/aws/sns/has_delivery_policy.rb +68 -0
  361. data/lib/aws/sns/policy.rb +47 -0
  362. data/lib/aws/sns/request.rb +23 -0
  363. data/lib/aws/sns/subscription.rb +144 -0
  364. data/lib/aws/sns/subscription_collection.rb +80 -0
  365. data/lib/aws/sns/topic.rb +403 -0
  366. data/lib/aws/sns/topic_collection.rb +67 -0
  367. data/lib/aws/sns/topic_subscription_collection.rb +55 -0
  368. data/lib/aws/sqs.rb +79 -0
  369. data/lib/aws/sqs/client.rb +360 -0
  370. data/lib/aws/sqs/config.rb +18 -0
  371. data/lib/aws/sqs/errors.rb +101 -0
  372. data/lib/aws/sqs/policy.rb +48 -0
  373. data/lib/aws/sqs/queue.rb +725 -0
  374. data/lib/aws/sqs/queue_collection.rb +170 -0
  375. data/lib/aws/sqs/received_message.rb +181 -0
  376. data/lib/aws/sqs/received_sns_message.rb +112 -0
  377. data/lib/aws/sqs/request.rb +43 -0
  378. data/lib/aws/sts.rb +152 -0
  379. data/lib/aws/sts/client.rb +105 -0
  380. data/lib/aws/sts/config.rb +18 -0
  381. data/lib/aws/sts/errors.rb +22 -0
  382. data/lib/aws/sts/federated_session.rb +56 -0
  383. data/lib/aws/sts/policy.rb +30 -0
  384. data/lib/aws/sts/request.rb +29 -0
  385. data/lib/aws/sts/session.rb +48 -0
  386. data/lib/net/http/connection_pool.rb +210 -0
  387. data/lib/net/http/connection_pool/connection.rb +132 -0
  388. data/lib/net/http/connection_pool/session.rb +93 -0
  389. data/lib/user.rb +49 -0
  390. metadata +433 -0
@@ -0,0 +1,18 @@
1
+ # Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License"). You
4
+ # may not use this file except in compliance with the License. A copy of
5
+ # the License is located at
6
+ #
7
+ # http://aws.amazon.com/apache2.0/
8
+ #
9
+ # or in the "license" file accompanying this file. This file is
10
+ # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11
+ # ANY KIND, either express or implied. See the License for the specific
12
+ # language governing permissions and limitations under the License.
13
+
14
+ AWS::Core::Configuration.module_eval do
15
+
16
+ add_service 'SQS', 'sqs', 'sqs.us-east-1.amazonaws.com'
17
+
18
+ end
@@ -0,0 +1,101 @@
1
+ # Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License"). You
4
+ # may not use this file except in compliance with the License. A copy of
5
+ # the License is located at
6
+ #
7
+ # http://aws.amazon.com/apache2.0/
8
+ #
9
+ # or in the "license" file accompanying this file. This file is
10
+ # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11
+ # ANY KIND, either express or implied. See the License for the specific
12
+ # language governing permissions and limitations under the License.
13
+
14
+ module AWS
15
+ class SQS
16
+ module Errors
17
+
18
+ extend Core::LazyErrorClasses
19
+
20
+ # @private
21
+ def self.error_class(code)
22
+ super(code.sub(/^AWS\.SimpleQueueService\./, ''))
23
+ end
24
+
25
+ # Raised when one or more messages fail to delete during a
26
+ # batch delete operation.
27
+ #
28
+ # See {#failures} for a complete list of failures.
29
+ #
30
+ class BatchDeleteError < StandardError
31
+
32
+ def initialize failures
33
+ @failures = failures
34
+ super("Failed to delete #{failures.size} messages")
35
+ end
36
+
37
+ # @return [Array<Hash>] Returns a list of hashes. Each hash
38
+ # contains information about one message that failed to delete.
39
+ # Hash keys include:
40
+ #
41
+ # * +:error_code+
42
+ # * +:error_message+
43
+ # * +:sender_fault+
44
+ # * +:receipt_handle+
45
+ #
46
+ attr_reader :failures
47
+
48
+ end
49
+
50
+ # Raised from a batch change message visibility call when one or more
51
+ # of the updates fail.
52
+ #
53
+ # See {#failures} for a complete list of failures.
54
+ #
55
+ class BatchChangeVisibilityError < StandardError
56
+
57
+ def initialize failures
58
+ @failures = failures
59
+ super("Failed to change visibility for #{failures.size} messages")
60
+ end
61
+
62
+ # @return [Array<Hash>] Returns a list of hashes. Each hash
63
+ # contains information about one message that failed to change
64
+ # visibility. Hash keys include:
65
+ #
66
+ # * +:error_code+
67
+ # * +:error_message+
68
+ # * +:sender_fault+
69
+ # * +:receipt_handle+
70
+ #
71
+ attr_reader :failures
72
+
73
+ end
74
+
75
+ class BatchSendError < StandardError
76
+
77
+ def initialize sent, failures
78
+ @sent = sent
79
+ @failures = failures
80
+ super("Failed to send #{failures.size} messages")
81
+ end
82
+
83
+ # @return [Array<Queue::SentMessage>] Returns a list of
84
+ # {Queue::SentMessage} objects.
85
+ attr_reader :sent
86
+
87
+ # @return [Array<Hash>] Returns a list of hashes. Each hash
88
+ # contains information about one message that failed to change
89
+ # visibility. Hash keys include:
90
+ #
91
+ # * +:error_code+
92
+ # * +:error_message+
93
+ # * +:sender_fault+
94
+ # * +:receipt_handle+
95
+ #
96
+ attr_reader :failures
97
+
98
+ end
99
+ end
100
+ end
101
+ end
@@ -0,0 +1,48 @@
1
+ # Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License"). You
4
+ # may not use this file except in compliance with the License. A copy of
5
+ # the License is located at
6
+ #
7
+ # http://aws.amazon.com/apache2.0/
8
+ #
9
+ # or in the "license" file accompanying this file. This file is
10
+ # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11
+ # ANY KIND, either express or implied. See the License for the specific
12
+ # language governing permissions and limitations under the License.
13
+
14
+ module AWS
15
+ class SQS
16
+
17
+ # (see Core::Policy)
18
+ class Policy < Core::Policy
19
+
20
+ class Statement < Core::Policy::Statement
21
+
22
+ ACTION_MAPPING = {
23
+ :add_permission => 'sqs:AddPermission',
24
+ :change_message_visibility => 'sqs:ChangeMessageVisibility',
25
+ :create_queue => 'sqs:CreateQueue',
26
+ :delete_message => 'sqs:DeleteMessage',
27
+ :delete_queue => 'sqs:DeleteQueue',
28
+ :get_queue_attributes => 'sqs:GetQueueAttributes',
29
+ :list_queues => 'sqs:ListQueues',
30
+ :receive_message => 'sqs:ReceiveMessage',
31
+ :remove_permission => 'sqs:RemovePermission',
32
+ :send_message => 'sqs:SendMessage',
33
+ :set_queue_attributes => 'sqs:SetQueueAttributes',
34
+ }
35
+
36
+ protected
37
+ def resource_arn resource
38
+ case resource
39
+ when Queue then URI.parse(resource.url).path
40
+ else resource.to_s
41
+ end
42
+ end
43
+
44
+ end
45
+
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,725 @@
1
+ # Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License"). You
4
+ # may not use this file except in compliance with the License. A copy of
5
+ # the License is located at
6
+ #
7
+ # http://aws.amazon.com/apache2.0/
8
+ #
9
+ # or in the "license" file accompanying this file. This file is
10
+ # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11
+ # ANY KIND, either express or implied. See the License for the specific
12
+ # language governing permissions and limitations under the License.
13
+
14
+ module AWS
15
+ class SQS
16
+
17
+ # Represents an Amazon SQS Queue.
18
+ #
19
+ # @example Sending a message
20
+ # msg = queue.send_message("HELLO")
21
+ # puts "Sent message: #{msg.id}"
22
+ #
23
+ # @example Polling for messages indefinitely
24
+ # queue.poll do |msg|
25
+ # puts "Got message: #{msg.body}"
26
+ # end
27
+ #
28
+ class Queue
29
+
30
+ # The default number of seconds to wait between polling requests for
31
+ # new messages.
32
+ DEFAULT_POLL_INTERVAL = 1
33
+
34
+ include Core::Model
35
+
36
+ # @return [String] The queue URL.
37
+ attr_reader :url
38
+
39
+ # @private
40
+ def initialize(url, opts = {})
41
+ @url = url
42
+ super
43
+ end
44
+
45
+ # Deletes the queue, regardless of whether it is empty.
46
+ #
47
+ # When you delete a queue, the deletion process takes up to 60
48
+ # seconds. Requests you send involving that queue during the
49
+ # 60 seconds might succeed. For example, calling
50
+ # {#send_message} might succeed, but after the 60 seconds, the
51
+ # queue and that message you sent no longer exist.
52
+ #
53
+ # Also, when you delete a queue, you must wait at least 60 seconds
54
+ # before creating a queue with the same name.
55
+ # @return [nil]
56
+ def delete
57
+ client.delete_queue(:queue_url => url)
58
+ nil
59
+ end
60
+
61
+ # Represents a message sent using {Queue#send_message}.
62
+ class SentMessage
63
+
64
+ # @return [String] Returns the message ID.
65
+ attr_accessor :message_id
66
+
67
+ alias_method :id, :message_id
68
+
69
+ # @return [String] Returns an MD5 digest of the message body
70
+ # string. You can use this to verify that SQS received your
71
+ # message correctly.
72
+ attr_accessor :md5
73
+
74
+ end
75
+
76
+ # Delivers a message to this queue.
77
+ #
78
+ # @param [String] body The message to send. The maximum
79
+ # allowed message size is 64 KB. The message may only
80
+ # contain Unicode characters from the following list,
81
+ # according to the W3C XML specification (for more
82
+ # information, go to
83
+ # http://www.w3.org/TR/REC-xml/#charsets). If you send any
84
+ # characters not included in the list, your request will be
85
+ # rejected.
86
+ #
87
+ # * #x9
88
+ # * #xA
89
+ # * #xD
90
+ # * #x20 to #xD7FF
91
+ # * #xE000 to #xFFFD
92
+ # * #x10000 to #x10FFFF
93
+ #
94
+ # @param [Hash] options
95
+ #
96
+ # @option options [Integer] :delay_seconds The number of seconds to
97
+ # delay the message. The message will become available for
98
+ # processing after the delay time has passed.
99
+ # If you don't specify a value, the default value for the
100
+ # queue applies. Should be from 0 to 900 (15 mins).
101
+ #
102
+ # @return [SentMessage] An object containing information about
103
+ # the message that was sent.
104
+ #
105
+ def send_message body, options = {}
106
+
107
+ client_opts = options.dup
108
+ client_opts[:queue_url] = url
109
+ client_opts[:message_body] = body
110
+
111
+ response = client.send_message(client_opts)
112
+
113
+ msg = SentMessage.new
114
+ msg.message_id = response[:message_id]
115
+ msg.md5 = response[:md5_of_message_body]
116
+ msg
117
+
118
+ end
119
+
120
+ # Retrieves one or more messages. When a block is given, each
121
+ # message is yielded to the block and then deleted as long as
122
+ # the block exits normally. When no block is given, you must
123
+ # delete the message yourself using {ReceivedMessage#delete}.
124
+ #
125
+ # @note Due to the distributed nature of the queue, a weighted
126
+ # random set of machines is sampled on a ReceiveMessage
127
+ # call. That means only the messages on the sampled machines
128
+ # are returned. If the number of messages in the queue is
129
+ # small (less than 1000), it is likely you will get fewer
130
+ # messages than you requested per call to
131
+ # {#receive_message}. If the number of messages in the queue
132
+ # is extremely small, you might not receive any messages.
133
+ # To poll continually for messages, use the {#poll} method,
134
+ # which automatically retries the request after a
135
+ # configurable delay.
136
+ #
137
+ # @param [Hash] opts Options for receiving messages.
138
+ #
139
+ # @option opts [Integer] :limit The maximum number of messages
140
+ # to receive. By default this is 1, and the return value is
141
+ # a single message object. If this options is specified and
142
+ # is not 1, the return value is an array of message objects;
143
+ # however, the array may contain fewer objects than you
144
+ # requested. Valid values: integers from 1 to 10.
145
+ #
146
+ # Not necessarily all the messages in the queue are returned
147
+ # (for more information, see the preceding note about
148
+ # machine sampling).
149
+ #
150
+ # @option opts [Integer] :visibilitiy_timeout The duration (in
151
+ # seconds) that the received messages are hidden from
152
+ # subsequent retrieve requests. Valid values: integer from
153
+ # 0 to 43200 (maximum 12 hours)
154
+ #
155
+ # @option opts [Array<Symbol, String>] :attributes The
156
+ # attributes to populate in each received message. Valid values:
157
+ #
158
+ # * +:all+ (to populate all attributes)
159
+ # * +:sender_id+
160
+ # * +:sent_at+
161
+ # * +:receive_count+
162
+ # * +:first_received_at+
163
+ #
164
+ # See {ReceivedMessage} for documentation on each
165
+ # attribute's meaning.
166
+ #
167
+ # @yieldparam [ReceivedMessage] message Each message that was received.
168
+ #
169
+ # @return [ReceivedMessage] Returns the received message (or messages)
170
+ # only if a block is not given to this method.
171
+ #
172
+ def receive_message(opts = {}, &block)
173
+ resp = client.receive_message(receive_opts(opts))
174
+
175
+ messages = resp[:messages].map do |m|
176
+ ReceivedMessage.new(self, m[:message_id], m[:receipt_handle],
177
+ :body => m[:body],
178
+ :md5 => m[:md5_of_body],
179
+ :attributes => m[:attributes])
180
+ end
181
+
182
+ if block
183
+ call_message_block(messages, block)
184
+ elsif opts[:limit] && opts[:limit] != 1
185
+ messages
186
+ else
187
+ messages.first
188
+ end
189
+ end
190
+ alias_method :receive_messages, :receive_message
191
+
192
+ # Polls continually for messages. For example, you can use
193
+ # this to poll indefinitely:
194
+ #
195
+ # queue.poll { |msg| puts msg.body }
196
+ #
197
+ # Or, to poll indefinitely for the first message and then
198
+ # continue polling until no message is received for a period
199
+ # of at least ten seconds:
200
+ #
201
+ # queue.poll(:initial_timeout => false,
202
+ # :idle_timeout => 10) { |msg| puts msg.body }
203
+ #
204
+ # As with the block form of {#receive_message}, this method
205
+ # automatically deletes the message then the block exits
206
+ # normally.
207
+ #
208
+ # @yieldparam [ReceivedMessage] message Each message that was received.
209
+ #
210
+ # @param [Hash] opts Options for polling.
211
+ #
212
+ # @option opts [Float, Integer] :poll_interval The number of
213
+ # seconds to wait before retrying when no messages are
214
+ # received. The default is 1 second.
215
+ #
216
+ # @option opts [Integer] :idle_timeout The maximum number of
217
+ # seconds to spend polling while no messages are being
218
+ # returned. By default this method polls indefinitely
219
+ # whether messages are received or not.
220
+ #
221
+ # @option opts [Integer] :initial_timeout The maximum number
222
+ # of seconds to spend polling before the first message is
223
+ # received. This option defaults to the value of
224
+ # +:idle_timeout+. You can specify +false+ to poll
225
+ # indefinitely for the first message when +:idle_timeout+ is
226
+ # set.
227
+ #
228
+ # @option opts [Integer] :batch_size The maximum number of
229
+ # messages to retrieve in a single request. By default
230
+ # messages are received one at a time. Valid values:
231
+ # integers from 1 to 10.
232
+ #
233
+ # @option opts [Integer] :visibilitiy_timeout The duration (in
234
+ # seconds) that the received messages are hidden from
235
+ # subsequent retrieve requests. Valid values: integer from
236
+ # 0 to 43200 (maximum 12 hours)
237
+ #
238
+ # @option opts [Array<Symbol, String>] :attributes The
239
+ # attributes to populate in each received message. Valid values:
240
+ #
241
+ # * +:all+ (to populate all attributes)
242
+ # * +:sender_id+
243
+ # * +:sent_at+
244
+ # * +:receive_count+
245
+ # * +:first_received_at+
246
+ #
247
+ # See {ReceivedMessage} for documentation on each
248
+ # attribute's meaning.
249
+ #
250
+ # @return [nil]
251
+ def poll(opts = {}, &block)
252
+ poll_interval = opts[:poll_interval] || DEFAULT_POLL_INTERVAL
253
+ opts[:limit] = opts.delete(:batch_size) if
254
+ opts.key?(:batch_size)
255
+
256
+ last_message_at = Time.now
257
+ got_first = false
258
+ loop do
259
+ got_msg = false
260
+ receive_messages(opts) do |message|
261
+ got_msg = got_first = true
262
+ last_message_at = Time.now
263
+ yield(message)
264
+ end
265
+ unless got_msg
266
+ Kernel.sleep(poll_interval) unless poll_interval == 0
267
+ return if hit_timeout?(got_first, last_message_at, opts)
268
+ end
269
+ end
270
+ nil
271
+ end
272
+
273
+ # @return [Integer] The approximate number of visible messages
274
+ # in a queue. For more information, see {Resources Required
275
+ # to Process
276
+ # Messages}[http://docs.amazonwebservices.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/IntroductionArticle.html#ApproximateNumber]
277
+ # in the Amazon SQS Developer Guide.
278
+ def approximate_number_of_messages
279
+ get_attribute("ApproximateNumberOfMessages").to_i
280
+ end
281
+ alias_method :visible_messages, :approximate_number_of_messages
282
+
283
+ # @return [Integer] The approximate number of messages that
284
+ # are not timed-out and not deleted. For more information,
285
+ # see {Resources Required to Process
286
+ # Messages}[http://docs.amazonwebservices.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/IntroductionArticle.html#ApproximateNumber]
287
+ # in the Amazon SQS Developer Guide.
288
+ def approximate_number_of_messages_not_visible
289
+ get_attribute("ApproximateNumberOfMessagesNotVisible").to_i
290
+ end
291
+ alias_method :invisible_messages, :approximate_number_of_messages_not_visible
292
+
293
+ # @return [Integer] Returns the visibility timeout for the
294
+ # queue. For more information about visibility timeout, see
295
+ # {Visibility
296
+ # Timeout}[http://docs.amazonwebservices.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/IntroductionArticle.html#AboutVT]
297
+ # in the Amazon SQS Developer Guide.
298
+ def visibility_timeout
299
+ get_attribute("VisibilityTimeout").to_i
300
+ end
301
+
302
+ # Sets the visibility timeout for the queue.
303
+ #
304
+ # @param [Integer] timeout The length of time (in seconds)
305
+ # that a message received from a queue will be invisible to
306
+ # other receiving components when they ask to receive
307
+ # messages. Valid values: integers from 0 to 43200 (12
308
+ # hours).
309
+ #
310
+ # @return Returns the value passed as a timeout.
311
+ def visibility_timeout=(timeout)
312
+ set_attribute("VisibilityTimeout", timeout.to_s)
313
+ timeout
314
+ end
315
+
316
+ # @return [Time] The time when the queue was created.
317
+ def created_timestamp
318
+ Time.at(get_attribute("CreatedTimestamp").to_i)
319
+ end
320
+
321
+ # @return [Time] The time when the queue was last changed.
322
+ def last_modified_timestamp
323
+ Time.at(get_attribute("LastModifiedTimestamp").to_i)
324
+ end
325
+
326
+ # @return [Integer] The limit of how many bytes a message can
327
+ # contain before Amazon SQS rejects it.
328
+ def maximum_message_size
329
+ get_attribute("MaximumMessageSize").to_i
330
+ end
331
+
332
+ # Sets the maximum message size for the queue.
333
+ #
334
+ # @param [Integer] size The limit of how many bytes a message
335
+ # can contain before Amazon SQS rejects it. This must be an
336
+ # integer from 1024 bytes (1KB) up to 65536 bytes
337
+ # (64KB). The default for this attribute is 8192 (8KB).
338
+ # @return Retuns the passed size argument.
339
+ def maximum_message_size=(size)
340
+ set_attribute("MaximumMessageSize", size.to_s)
341
+ end
342
+
343
+ # @return [Integer] The number of seconds Amazon SQS retains a
344
+ # message.
345
+ def message_retention_period
346
+ get_attribute("MessageRetentionPeriod").to_i
347
+ end
348
+
349
+ # Sets the message retention period for the queue
350
+ #
351
+ # @param [Integer] period The number of seconds Amazon SQS
352
+ # retains a message. Must be an integer from 3600 (1 hour)
353
+ # to 1209600 (14 days). The default for this attribute is
354
+ # 345600 (4 days).
355
+ # @return Returns the passed period argument.
356
+ def message_retention_period=(period)
357
+ set_attribute("MessageRetentionPeriod", period.to_s)
358
+ period
359
+ end
360
+
361
+ # @return [Integer] Gets the current default delay for messages sent
362
+ # to the queue.
363
+ def delay_seconds
364
+ get_attribute("DelaySeconds").to_i
365
+ end
366
+
367
+ # Sets the default delay for messages sent to the queue.
368
+ # @param [Integer] seconds How many seconds a message will be delayed.
369
+ def delay_seconds= seconds
370
+ set_attribute("DelaySeconds", seconds.to_s)
371
+ end
372
+
373
+ # @return [Integer] Returns an approximate count of messages delayed.
374
+ def approximate_number_of_messages_delayed
375
+ get_attribute("ApproximateNumberOfMessagesDelayed").to_i
376
+ end
377
+
378
+ # @return [String] The queue's Amazon resource name (ARN).
379
+ def arn
380
+ @arn ||= get_attribute("QueueArn")
381
+ end
382
+
383
+ # @return [Boolean] True if the queue exists.
384
+ #
385
+ # @note This may raise an exception if you don't have
386
+ # permission to access the queue attributes. Also, it may
387
+ # return true for up to 60 seconds after a queue has been
388
+ # deleted.
389
+ def exists?
390
+ client.get_queue_attributes(:queue_url => url,
391
+ :attribute_names => ["QueueArn"])
392
+ rescue Errors::NonExistentQueue, Errors::InvalidAddress
393
+ false
394
+ else
395
+ true
396
+ end
397
+
398
+ # @private
399
+ module PolicyProxy
400
+
401
+ attr_accessor :queue
402
+
403
+ def change
404
+ yield(self)
405
+ queue.policy = self
406
+ end
407
+
408
+ def delete
409
+ queue.client.send(:set_attribute, 'Policy', '')
410
+ end
411
+
412
+ end
413
+
414
+ # @return [Policy] Returns the current queue policy if there is one.
415
+ # Returns +nil+ otherwise.
416
+ def policy
417
+ if policy_json = get_attribute('Policy')
418
+ policy = SQS::Policy.from_json(policy_json)
419
+ policy.extend(PolicyProxy)
420
+ policy.queue = self
421
+ policy
422
+ else
423
+ nil
424
+ end
425
+ end
426
+
427
+ # Set the policy on this queue.
428
+ #
429
+ # If you pass nil or an empty string then it will have the same
430
+ # effect as deleting the policy.
431
+ #
432
+ # @param policy The policy to set. This policy can be a {Policy} object,
433
+ # a json policy string, or any other object that responds with a policy
434
+ # string when it received #to_json.
435
+ #
436
+ # @return [nil]
437
+ #
438
+ def policy= policy
439
+ policy_string = case policy
440
+ when nil, '' then ''
441
+ when String then policy
442
+ else policy.to_json
443
+ end
444
+ set_attribute('Policy', policy_string)
445
+ nil
446
+ end
447
+
448
+ # Sends a batch of up to 10 messages in a single request.
449
+ #
450
+ # queue.send_messages('message-1', 'message-2')
451
+ #
452
+ # You can also set an optional delay for all of the messages:
453
+ #
454
+ # # delay all messages 1 hour
455
+ # queue.batch_send(msg1, msg2, :delay_seconds => 3600)
456
+ #
457
+ # If you need to set a custom delay for each message you can pass
458
+ # hashes:
459
+ #
460
+ # messages = []
461
+ # messages << { :message_body => 'msg1', :delay_seconds => 60 }
462
+ # messages << { :message_body => 'msg2', :delay_seconds => 30 }
463
+ #
464
+ # queue.batch_send(messages)
465
+ #
466
+ # @param [String,Hash] messages A list of messages. Each message
467
+ # should be a string, or a hash with a +:message_body+,
468
+ # and optionally +:delay_seconds+.
469
+ #
470
+ # @raise [Errors::BatchSendError] Raises this error when one or more
471
+ # of the messages failed to send, but others did. On the raised
472
+ # object you can access a list of the messages that failed, and
473
+ # a list of messages that succeeded.
474
+ #
475
+ # @return [Array<SentMessage>] Returns an array of sent message objects.
476
+ # Each object responds to #message_id and #md5_of_message_body.
477
+ # The message id is generated by Amazon SQS.
478
+ #
479
+ def batch_send *messages
480
+
481
+ entries = messages.flatten
482
+
483
+ unless entries.first.is_a?(Hash)
484
+ options = entries.last.is_a?(Hash) ? entries.pop : {}
485
+ entries = entries.collect{|msg| { :message_body => msg } }
486
+ if delay = options[:delay_seconds]
487
+ entries.each {|entry| entry[:delay_seconds] = delay }
488
+ end
489
+ end
490
+
491
+ entries.each_with_index {|entry,n| entry[:id] = n.to_s }
492
+
493
+ client_opts = {}
494
+ client_opts[:queue_url] = url
495
+ client_opts[:entries] = entries
496
+
497
+ response = client.send_message_batch(client_opts)
498
+
499
+ failed = batch_failures(entries, response)
500
+
501
+ sent = response[:successful].collect do |sent|
502
+ msg = SentMessage.new
503
+ msg.message_id = sent[:message_id]
504
+ msg.md5 = sent[:md5_of_message_body]
505
+ msg
506
+ end
507
+
508
+ raise Errors::BatchSendError.new(sent, failed) unless failed.empty?
509
+
510
+ sent
511
+
512
+ end
513
+
514
+ # @param [ReceivedMessage,String] messages A list of up to 10 messages
515
+ # to delete. Each message should be a {ReceivedMessage} object
516
+ # or a received message handle (string).
517
+ #
518
+ # @raise [Errors::BatchDeleteSend] Raised when one or more of the
519
+ # messages failed to delete. The raised error has a list
520
+ # of the failures.
521
+ #
522
+ # @return [nil]
523
+ #
524
+ def batch_delete *messages
525
+
526
+ entries = []
527
+ messages.flatten.each_with_index do |msg,n|
528
+ handle = msg.is_a?(ReceivedMessage) ? msg.handle : msg
529
+ entries << { :id => n.to_s, :receipt_handle => handle }
530
+ end
531
+
532
+ response = client.delete_message_batch(
533
+ :queue_url => url, :entries => entries)
534
+
535
+ failures = batch_failures(entries, response)
536
+
537
+ raise Errors::BatchDeleteError.new(failures) unless failures.empty?
538
+
539
+ nil
540
+
541
+ end
542
+
543
+ # @overload batch_change_message_visibility(visibility_timeout, *messages)
544
+ #
545
+ # Accepts a single +:visibility_timeout+ value and a list of
546
+ # messages ({ReceivedMessage} objects or receipt handle strings).
547
+ # This form of the method is useful when you want to set the same
548
+ # timeout value for each message.
549
+ #
550
+ # queue.bacth_change_message_visibility(10, messages)
551
+ #
552
+ # @param [Integer] visibility_timeout The new value for the message's
553
+ # visibility timeout (in seconds).
554
+ #
555
+ # @param [ReceivedMessage,String] message A list of up to 10 messages
556
+ # to change the visibility timeout for.
557
+ #
558
+ # @raise [BatchChangeVisibilityError] Raises this error when one
559
+ # or more of the messages failed the visibility update.
560
+ #
561
+ # @return [nil]
562
+ #
563
+ # @overload batch_change_message_visibility(*messages_with_timeouts)
564
+ #
565
+ # Accepts a list of hashes. Each hash should provide the visibility
566
+ # timeout and message (a {ReceivedMessage} object or the recipt handle
567
+ # string).
568
+ #
569
+ # Use this form when each message needs a different visiblity timeout.
570
+ #
571
+ # messages = []
572
+ # messages << { :message => 'handle1', :visibility_timeout => 5 }
573
+ # messages << { :message => 'handle2', :visibility_timeout => 10 }
574
+ #
575
+ # queue.bacth_change_message_visibility(*messages)
576
+ #
577
+ # @param [Hash] message A list hashes, each with a +:visibility_timeout+
578
+ # and a +:message+.
579
+ #
580
+ # @raise [BatchChangeVisibilityError] Raises this error when one
581
+ # or more of the messages failed the visibility update.
582
+ #
583
+ # @return [nil]
584
+ #
585
+ def batch_change_visibility *args
586
+
587
+ args = args.flatten
588
+
589
+ if args.first.is_a?(Integer)
590
+ timeout = args.shift
591
+ messages = args.collect{|m| [m, timeout] }
592
+ else
593
+ messages = args.collect{|m| [m[:message], m[:visibility_timeout]] }
594
+ end
595
+
596
+ entries = []
597
+ messages.each do |msg,timeout|
598
+ handle = msg.is_a?(ReceivedMessage) ? msg.handle : msg
599
+ entries << {
600
+ :id => entries.size.to_s,
601
+ :receipt_handle => handle,
602
+ :visibility_timeout => timeout,
603
+ }
604
+ end
605
+
606
+ response = client.change_message_visibility_batch(
607
+ :queue_url => url, :entries => entries)
608
+
609
+ failures = batch_failures(entries, response)
610
+
611
+ raise Errors::BatchChangeVisibilityError.new(failures) unless
612
+ failures.empty?
613
+
614
+ nil
615
+
616
+ end
617
+
618
+ # @return [Boolean] Returns true if the other queue has the same
619
+ # url.
620
+ def ==(other)
621
+ other.kind_of?(Queue) and other.url == url
622
+ end
623
+ alias_method :eql?, :==
624
+
625
+ # @private
626
+ def inspect
627
+ "<#{self.class}:#{url}>"
628
+ end
629
+
630
+ protected
631
+ def batch_failures entries, response
632
+ response[:failed].inject([]) do |failures, failure|
633
+
634
+ entry = entries.find{|e| e[:id] == failure[:id] }
635
+
636
+ details = {
637
+ :error_code => failure[:code],
638
+ :error_message => failure[:message],
639
+ :sender_fault => failure[:sender_fault],
640
+ }
641
+
642
+ if handle = entry[:receipt_handle]
643
+ details[:receipt_handle] = handle
644
+ end
645
+
646
+ failures << details
647
+
648
+ end
649
+ end
650
+
651
+ # @private
652
+ protected
653
+ def hit_timeout?(got_first, last_message_at, opts)
654
+ initial_timeout = opts[:initial_timeout]
655
+ idle_timeout = opts[:idle_timeout]
656
+
657
+ timeout = (got_first ||
658
+ # if initial_timeout is false (as opposed
659
+ # to nil) then we skip the branch and poll
660
+ # indefinitely until the first message
661
+ # comes
662
+ (!initial_timeout && initial_timeout != false) ?
663
+ idle_timeout :
664
+ initial_timeout) and
665
+ Time.now - last_message_at > timeout
666
+ end
667
+
668
+ # @private
669
+ protected
670
+ def receive_opts(opts)
671
+ receive_opts = { :queue_url => url }
672
+ receive_opts[:visibility_timeout] = opts[:visibility_timeout] if
673
+ opts[:visibility_timeout]
674
+ receive_opts[:max_number_of_messages] = opts[:limit] if
675
+ opts[:limit]
676
+ if names = opts[:attributes]
677
+ receive_opts[:attribute_names] = names.map do |name|
678
+ name = ReceivedMessage::ATTRIBUTE_ALIASES[name.to_sym] if
679
+ ReceivedMessage::ATTRIBUTE_ALIASES.key?(name.to_sym)
680
+ name = Core::Inflection.class_name(name.to_s) if name.kind_of?(Symbol)
681
+ name
682
+ end
683
+ end
684
+ receive_opts
685
+ end
686
+
687
+ # @private
688
+ protected
689
+ def call_message_block(messages, block)
690
+ result = nil
691
+ messages.each do |message|
692
+ begin
693
+ result = block.call(message)
694
+ rescue Exception => e
695
+ raise
696
+ else
697
+ message.delete
698
+ end
699
+ end
700
+ result
701
+ end
702
+
703
+ # @private
704
+ protected
705
+ def get_attribute(name)
706
+ resp = client.get_queue_attributes(:queue_url => url,
707
+ :attribute_names =>
708
+ [name, "QueueArn"].uniq)
709
+ @arn ||= resp.attributes["QueueArn"]
710
+ resp.attributes[name]
711
+ end
712
+
713
+ # @private
714
+ protected
715
+ def set_attribute(name, value)
716
+ client.set_queue_attributes({
717
+ :queue_url => url,
718
+ :attributes => { name => value },
719
+ })
720
+ end
721
+
722
+ end
723
+
724
+ end
725
+ end