ocean-rails 6.0.1 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b293b0bc6aea7b3f4dfb8be54347c3bc4edc4ab
-  data.tar.gz: d9bc449a6991f8da2d6190e21843ae8a9dae7a5e
+  metadata.gz: f3c466d14a4377353e6066a920473a01bfab2ae6
+  data.tar.gz: bbe416f156a3ceb38c99d3b7d7f8f3034778d9f4
 SHA512:
-  metadata.gz: f519f38524ec7a2d2b60558e30ba9c0c3e1077e3c1f5abd5ee2eacc7600c3efdb0c1e45af279e95101d6aa2a0e32b4e58937297e2a1b8d832c4cf5b9f5f62dd9
-  data.tar.gz: 14da6157c34aa3031ee4399674d22c6618e2ed3ecbb0b5c50aa1932396918694010a9649f04f8bfd0778fd74cb319c0d266d59c253dea8d635515d77a9380157
+  metadata.gz: e9ecd343b2596ddcd880671a4c4b3a000dcb61549700bccbcb195aa5e35529a16264593c30809d0b453e15973070ab848bb4d5ad294c39ac823e85b5fc2b89f7
+  data.tar.gz: 28d9e635e2dc146d360a048daa5f60612ce4e7740fc4616cb755e41d975eed76fc4de7f3bb407847bf780d757448137f49eb506c01911bfb06ccd7bbda2d3fe1

data/README.rdoc

@@ -3,10 +3,24 @@
 This repository contains the Ocean ruby gem, containing common framework functionality
 for the Ruby on Rails part of the architecture. 
 
-Ocean requires Ruby 2.0 and Ruby on Rails 4.0.0 or later.
+Ocean requires Ruby 2.2 and Ruby on Rails 4.2.0 or later.
 
 {<img src="https://badge.fury.io/rb/ocean-rails.png" alt="Gem Version" />}[http://badge.fury.io/rb/ocean-rails]
 
+=== What does ocean-rails provide?
+
+* base classes for Ocean controllers and models (both SQL and DynamoDB).
+* the Api class, which encapsulates all logic for calling other API services. This includes authentication, authorisation, support for BAN and PURGE, making HTTP requests with retries and backoff, sequentially and in parallel, helpers for running AsyncJobs, sending mail, raising Ocean Semaphores, and much more. Many of these are very useful even outside of the Ocean context.
+* the RemoteResource class, which allows you to use a remote Ocean resource as if it were local, with full abstraction of hyperlinks and attributes.
+* classes which implement Ocean's aggressive caching for controllers and models, and which provide abstractions for collections, matching, searches, grouping, and paging.
+* controller renderers for collections and errors of various kinds.
+* the AliveController, which is inherited by all Ocean services. Its only action, +index+, is called by Varnish to determine that the service is operational. Fail-over is performed automatically as a result.
+* the ErrorController, which intercepts all errors and converts them to the standard Ocean JSON format in the response body.
+* the logger for the aggregated ZeroMQ Ocean log.
+* templates and generators to set up new Ocean applications and Ocean resources.
+
+Thus, the +ocean-rails+ gem provides all the abstractions you need for creating very terse and powerful controller and model code. It's a good idea to browse the documentation.
+
 
 === Documentation
 * Ocean gem on Rubygems: https://rubygems.org/gems/ocean-rails
@@ -18,58 +32,7 @@ Ocean requires Ruby 2.0 and Ruby on Rails 4.0.0 or later.
 
 === Creating an Ocean Rails app
 
-The ocean gem provides an application template and generator to quickly and easily set up 
-a complete Rails application for Ocean. Simply execute the following in your terminal:
-
- rails new the_app_name -m https://raw.github.com/OceanDev/ocean-rails/master/template.rb
-
-Answer yes to all overwrite queries. 
-
-There is only one piece of manual setup to perform. You must supply the Ocean app with
-your site-specific data: the base domain name, the password for Auth, etc. To do this,
-simply edit <code>config/config.yml</code>. 
-
-There is also a file called <code>config.yml.example</code> in the
-same directory for reference. Don't change it: it is under version control. The file
-you should change, <code>config/config.yml</code>, isn't, as it will contain site-specific and/or
-confidential data.
-
-There are no specs to run at this point: all functionality provided by the +ocean-rails+
-gem already is exhaustively tested in the +ocean-rails+ spec suite.
-
-
-=== Creating an Ocean Resource
-
-To create an aggressively cached Ocean resource based on an SQL model, do the following:
-
- rails g scaffold quux name:string description:string \ 
-                       lock_version:integer created_by:string updated_by:string
-
-This will create the basic model and associated model and controller scaffolding code, 
-which we will modify shortly. Now run
-
- rake db:migrate
-
-This will create the SQL table for the resource. Next, we need to replace the HTML-centric
-scaffold code generated above with RESTful JSON scaffold code for Ocean:
-
- rails g ocean_scaffold quux
-
-Answer yes to all overwrite queries. Now examine +config/routes.rb+. You will find a new resource
-declaration for quuxes. Move it inside the versioned scope and add and +except:+ clause to exclude
-the Rails controller actions not used in a REST Api:
-
- scope "v1" do
-   resource :quuxes, except: [:new, :edit]
- end
-
-To verify that everything works as it should, run the tests:
-
- rspec
-
-All tests should pass. The test coverage should be very close to 100%. A FactoryGirl factory for the new model will be created, there will be model unit tests to check for the presence of all attributes and to verify collection searches, routing tests, controller tests for each action, and view tests to verify that the JSON representation is complete and correct.   
-
-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.
+Cf. the tutorial at http://wiki.oceanframework.net/index.php/Tutorial for information on about how to set up an Ocean Rails app and create Ocean Resources for it. 
 
 
 === Running the specs
@@ -112,35 +75,6 @@ With DynamoDB Local running, you should now be able to do
 All tests should pass.
 
 
-=== Cleaning up the DB
-
-You might want to add the following to your spec_helper.rb file, before the +RSpec.configure+
-block:
-
-  # DynamoDB table cleaner
-  CHEF_ENV = "master" unless defined?(CHEF_ENV)
-  regexp = Regexp.new("^.+_#{CHEF_ENV}_[0-9]{1,3}-[0-9]{1,3}-[0-9]{1,3}-[0-9]{1,3}_(test|dev)$")
-  cleaner = lambda { 
-    c = Aws::DynamoDB::Client.new
-    c.list_tables.table_names.each do |t| 
-      begin
-        c.delete_table({table_name: t}) if t =~ regexp
-      rescue Aws::DynamoDB::Errors::LimitExceededException
-        sleep 1
-        retry
-      end
-    end
-  }
-
-Then, inside the +RSpec.configure+ block:
-
-  config.before(:suite) { cleaner.call }
-  config.after(:suite) { cleaner.call }
-
-This will remove only those tables created by the specs on this particular machine and
-environment. This is safe even on AWS and for parallel testing.
-
-
 === Rails console
 
 The Rails console is available from the built-in dummy application:
@@ -159,14 +93,6 @@ To enable HTTP traffic:
 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/ocean_setup_generator.rb

@@ -85,6 +85,10 @@ class OceanSetupGenerator < Rails::Generators::NamedBase #:nodoc: all
     template  "aws.yml.example", "#{Rails.root}/config/aws.yml"
   end
 
+  def install_default_cache_time_file
+    template  "default_cache_time.rb", "#{Rails.root}/config/initializers/default_cache_time.rb"
+  end
+
   def replace_gemfile
     remove_file "#{Rails.root}/Gemfile"
     copy_file "Gemfile", "#{Rails.root}/Gemfile"

data/lib/generators/ocean_setup/templates/default_cache_time.rb

@@ -0,0 +1 @@
+DEFAULT_CACHE_TIME = 1.week

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "6.0.1"
+  VERSION = "6.1.0"
 end

data/lib/templates/rails/scaffold_controller/controller.rb

@@ -5,7 +5,7 @@ require_dependency "<%= namespaced_file_path %>/application_controller"
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < ApplicationController
 
-  ocean_resource_controller required_attributes: [:lock_version, :name, :description]
+  ocean_resource_controller required_attributes: [:lock_version]
 
   before_action :find_<%= singular_table_name %>, :only => [:show, :update, :destroy]
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.1.0
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -254,6 +254,7 @@ files:
 - lib/generators/ocean_setup/templates/application_controller.rb
 - lib/generators/ocean_setup/templates/aws.yml.example
 - lib/generators/ocean_setup/templates/config.yml.example
+- lib/generators/ocean_setup/templates/default_cache_time.rb
 - lib/generators/ocean_setup/templates/gitignore
 - lib/generators/ocean_setup/templates/hyperlinks.rb
 - lib/generators/ocean_setup/templates/routes.rb