ocean-rails 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b07c48320b0fb3b254c5fb015b1dbc170459c61
-  data.tar.gz: 9523c8b17736174826d5a6e56c5b9fa27ef8f76e
+  metadata.gz: 50269a89296e4a7050a83b8974d2d6548124d29e
+  data.tar.gz: 3d2c4ae053e1f1d005025c7fd8c35bcf63165ebb
 SHA512:
-  metadata.gz: dd8728127e2c3ab22ed3ef365b4773a70a8cba8a50847f4b67de195dea89dff948bc471f183627f89f320bca4ed1b8de832a3f4ab382dddf986c2bf2cb210a18
-  data.tar.gz: a707f37e89bf9a56e1efba51b8a50cf33af207026daf4d254906cf9b9dd476f1ac1b33595156c3b1dd052d3f445cb72e90e4418ef8be2f66759d051dc48eee8d
+  metadata.gz: 460830b63eed3b25ba396d957fe9355ae61766bae29843a5f54d9ea092d8e8c434235780d53d8ed486cb7f83645a55b6b133e7227e7b94d09b2c4df287177a4b
+  data.tar.gz: 8dc3b4d2e2fb6a6c3d183e9283829ee45c6c15bf5e10b1d40d229036c57f65b2174b6255f45736b18328bf127899a55880d70b95c0f3a1f2fd5356a2a0b25bdb

data/README.rdoc

@@ -72,3 +72,87 @@ All tests should pass. The test coverage should be very close to 100%. A Factory
 You can now proceed to tailor the new resource to your needs. You will want to add other attributes to the model or remove some or all of the default ones; you can change the JSON representation by modifying the view; and you might want to add or remove controller actions, e.g. to support secondary collections and relations to other resources. And as you no doubt are a responsible, informed developer, you will of course do all this using TDD and/or BDD techniques.
 
 
+=== Running the specs
+
+To run the specs for the ocean-rails gem, you must first install the bundle. It will download
+a gem called +fake_dynamo+, which runs a local, in-memory functional clone of Amazon DynamoDB.
+We use +fake_dynamo+ during development and testing.
+
+First of all, copy the AWS configuration file from the template:
+
+ cp spec/dummy/config/aws.yml.example spec/dummy/config/aws.yml
+
+NB: +aws.yml+ is excluded from source control. This allows you to enter your AWS credentials
+safely. Note that +aws.yml.example+ is under source control: don't edit it.
+
+Make sure your have version 0.1.3 of the +fake_dynamo+ gem. It implements the +2011-12-05+ version
+of the DynamoDB API. We're not yet using the +2012-08-10+ version, as the +aws-sdk+ ruby gem
+doesn't fully support it. We'll make the change as soon as +aws-sdk+ is updated. Reportedly,
+it's in the works.
+
+Next, start +fake_dynamo+:
+
+  fake_dynamo --port 4567
+
+If this returns errors, make sure that <tt>/usr/local/var/fake_dynamo</tt> exists and
+is writable:
+
+ sudo mkdir -p /usr/local/var/fake_dynamo
+ sudo chown peterb:staff /usr/local/var/fake_dynamo
+
+When +fake_dynamo+ runs normally, open another window and issue the following command:
+
+ curl -X DELETE http://localhost:4567
+
+This will reset the +fake_dynamo+ database. It's not a required operation when starting
++fake_dynamo+; we're just using it here as a test that the installation works. It will
+be issued automatically as part of the test suite, so don't expect test data to survive
+between runs.
+
+Next, copy the +config.yml+ file from its template:
+
+  cp spec/dummy/config/config.yml.example spec/dummy/config/config.yml
+
+Edit the contents of +config.yml+ to suit your setup.
+
+You must now generate the SQLite databases:
+
+ rake db:migrate
+ RAILS_ENV=test rake db:migrate
+
+With +fake_dynamo+ running, you should now be able to do
+
+ rspec
+
+All tests should pass.
+
+
+=== Rails console
+
+The Rails console is available from the built-in dummy application:
+
+ cd spec/dummy
+ rails console
+
+You're now in a sandbox environment (thanks to +webmock+): HTTP accesses are disallowed;
+each HTTP access you make will be intercepted with a message describing exactly how to
+mock it away.
+
+To enable HTTP traffic:
+
+ WebMock.allow_net_connect!
+
+Please refer to the +webmock+ gem documentation for full information. It's possible to
+prevent traffic only to specific hosts (e.g. +localhost+).
+
+You may also need to initialise the table connection:
+
+ CloudModel.establish_db_connection
+
+This will, amongst other things, also create the CloudModel table if it doesn't already
+exist. On Amazon, this will take a little while. With +fake_dynamo+, it's practically
+instant.
+
+When you leave the console, you must navigate back to the Rails directory (<tt>cd ../..</tt>)
+in order to be able to run RSpec again.
+

data/lib/generators/ocean_setup/templates/gitignore

@@ -33,5 +33,8 @@
 # Ignore the tailored config.yml file
 config/config.yml
 
+# Ignore any tailored aws.yml file
+config/aws.yml
+
 # Ignore the Tork config dir
 /.tork

data/lib/ocean-rails.rb

@@ -10,6 +10,7 @@ require "ocean/zeromq_logger"
 require "ocean/selective_rack_logger"
 require "ocean/flooding"
 
+
 INVALIDATE_MEMBER_DEFAULT =     ["($|/|\\?)"]
 INVALIDATE_COLLECTION_DEFAULT = ["($|\\?)"]
 

data/lib/ocean/api.rb

@@ -62,8 +62,11 @@ class Api
   # This is a precaution; in staging and prod apps should always run in Rails production mode, 
   # but if by mistake they don't, we must prevent the production queues from being touched.
   #
-  def self.adorn_basename(basename, chef_env: "dev", rails_env: "development")
-    fullname = "#{basename}_#{chef_env}"
+  # If +suffix_only+ is true, the basename will be excluded from the returned string.
+  #
+  def self.adorn_basename(basename, chef_env: "dev", rails_env: "development",
+                          suffix_only: false)
+    fullname = suffix_only ? "_#{chef_env}" : "#{basename}_#{chef_env}"
     if rails_env != 'production' || chef_env == 'dev' || chef_env == 'ci'
       local_ip = UDPSocket.open {|s| s.connect("64.233.187.99", 1); s.addr.last}.gsub('.', '-')
       fullname += "_#{local_ip}_#{rails_env}"
@@ -72,6 +75,14 @@ class Api
   end
 
 
+  #
+  # Like +adorn_basename+, but returns only the suffix. Uses CHEF_ENV and Rails.env.
+  #
+  def self.basename_suffix
+    adorn_basename '', suffix_only: true, chef_env: CHEF_ENV, rails_env: Rails.env
+  end
+
+
   #
   # Makes a HTTP request to +host_url+ using the HTTP method +method+. The +resource_name+
   # is used to obtain the latest version string of the resource. The arg +path+ is the

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "1.19.0"
+  VERSION = "1.20.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-02 00:00:00.000000000 Z
+date: 2013-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -108,6 +108,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ocean-dynamo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +206,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: fake_dynamo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 description: "== Ocean\n\nOcean is an architecture for creating server-oriented architectures
   (SOAs) in the cloud. \nIt consists of two separate parts which can be used separately
   or in conjunction: Ocean and OceanFront.\n\nOcean is a complete and very scalable