ocean-rails 1.14.0

data/lib/generators/ocean_scaffold/templates/model_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe <%= class_name %> do
+
+
+  describe "attributes" do
+    
+    it "should have a name" do
+      create(:<%= singular_name %>).name.should be_a String
+    end
+
+    it "should have a description" do
+      create(:<%= singular_name %>).description.should be_a String
+    end
+
+     it "should have a creation time" do
+      create(:<%= singular_name %>).created_at.should be_a Time
+    end
+
+    it "should have an update time" do
+      create(:<%= singular_name %>).updated_at.should be_a Time
+    end
+  
+   it "should have a creator" do
+      create(:<%= singular_name %>).created_by.should be_an Integer
+    end
+
+    it "should have an updater" do
+      create(:<%= singular_name %>).updated_by.should be_an Integer
+    end
+
+  end
+
+
+  describe "relations" do
+
+  end
+
+
+
+  describe "search" do
+  
+    describe ".collection" do
+    
+      before :each do
+        create :<%= singular_name %>, name: 'foo', description: "The Foo object"
+        create :<%= singular_name %>, name: 'bar', description: "The Bar object"
+        create :<%= singular_name %>, name: 'baz', description: "The Baz object"
+      end
+      
+    
+      it "should return an array of <%= class_name %> instances" do
+        ix = <%= class_name %>.collection
+        ix.length.should == 3
+        ix[0].should be_a <%= class_name %>
+      end
+    
+      it "should allow matches on name" do
+        <%= class_name %>.collection(name: 'NOWAI').length.should == 0
+        <%= class_name %>.collection(name: 'bar').length.should == 1
+        <%= class_name %>.collection(name: 'baz').length.should == 1
+      end
+      
+      it "should allow searches on description" do
+        <%= class_name %>.collection(search: 'a').length.should == 2
+        <%= class_name %>.collection(search: 'object').length.should == 3
+      end
+      
+      it "key/value pairs not in the index_only array should quietly be ignored" do
+        <%= class_name %>.collection(name: 'bar', aardvark: 12).length.should == 1
+      end
+        
+    end
+  end
+
+end

data/lib/generators/ocean_scaffold/templates/resource_routing_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe <%= class_name.pluralize %>Controller do
+  describe "routing" do
+
+    it "routes to #index" do
+      get("/v1/<%= plural_name %>").should route_to("<%= plural_name %>#index")
+    end
+
+    it "routes to #show" do
+      get("/v1/<%= plural_name %>/1").should route_to("<%= plural_name %>#show", id: "1")
+    end
+
+    it "routes to #create" do
+      post("/v1/<%= plural_name %>").should route_to("<%= plural_name %>#create")
+    end
+
+    it "routes to #update" do
+      put("/v1/<%= plural_name %>/1").should route_to("<%= plural_name %>#update", id: "1")
+    end
+
+    it "routes to #destroy" do
+      delete("/v1/<%= plural_name %>/1").should route_to("<%= plural_name %>#destroy", id: "1")
+    end
+
+  end
+end

data/lib/generators/ocean_scaffold/templates/view_specs/_resource_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe "<%= plural_name %>/_<%= singular_name %>" do
+  
+  before :each do                     # Must be :each (:all causes all tests to fail)
+    render partial: "<%= plural_name %>/<%= singular_name %>", locals: {<%= singular_name %>: create(:<%= singular_name %>)}
+    @json = JSON.parse(rendered)
+    @u = @json['<%= singular_name %>']
+    @links = @u['_links'] rescue {}
+  end
+
+
+  it "has a named root" do
+    @u.should_not == nil
+  end
+
+
+  it "should have three hyperlinks" do
+    @links.size.should == 3
+  end
+
+  it "should have a self hyperlink" do
+    @links.should be_hyperlinked('self', /<%= plural_name %>/)
+  end
+
+  it "should have a creator hyperlink" do
+    @links.should be_hyperlinked('creator', /api_users/)
+  end
+
+  it "should have an updater hyperlink" do
+    @links.should be_hyperlinked('updater', /api_users/)
+  end
+
+
+  it "should have a name" do
+    @u['name'].should be_a String
+  end
+
+  it "should have a description" do
+    @u['description'].should be_a String
+  end
+
+  it "should have a created_at time" do
+    @u['created_at'].should be_a String
+  end
+
+  it "should have an updated_at time" do
+    @u['updated_at'].should be_a String
+  end
+
+  it "should have a lock_version field" do
+    @u['lock_version'].should be_an Integer
+  end
+      
+end

data/lib/generators/ocean_scaffold/templates/views/_resource.json.jbuilder

@@ -0,0 +1,8 @@
+json.<%= singular_name %> do |json|
+	json._links       hyperlinks(self:    <%= singular_name %>_url(<%= singular_name %>),
+	                             creator: api_user_url(<%= singular_name %>.created_by),
+	                             updater: api_user_url(<%= singular_name %>.updated_by))
+	json.(<%= singular_name %>, :lock_version, :name, :description) 
+	json.created_at   <%= singular_name %>.created_at.utc.iso8601
+	json.updated_at   <%= singular_name %>.updated_at.utc.iso8601
+end

data/lib/generators/ocean_setup/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate ocean_setup Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/ocean_setup/ocean_setup_generator.rb

@@ -0,0 +1,93 @@
+class OceanSetupGenerator < Rails::Generators::NamedBase #:nodoc: all
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def remove_unwanted_stuff
+    remove_file "#{Rails.root}/app/assets"
+    remove_file "#{Rails.root}/lib/assets"
+    remove_file "#{Rails.root}/app/views/layouts"
+    remove_file "#{Rails.root}/config/locales"
+    remove_file "#{Rails.root}/public"
+    remove_file "#{Rails.root}/config/initializers/session_store.rb"
+    #remove_file "#{Rails.root}/config/initializers/secret_token.rb"
+    remove_file "#{Rails.root}/test"
+    remove_file "#{Rails.root}/vendor/assets"
+    remove_file "#{Rails.root}/vendor/plugins"
+    remove_file "#{Rails.root}/tmp/cache/assets"
+  end
+
+  def install_application_controller
+    copy_file "application_controller.rb", "#{Rails.root}/app/controllers/application_controller.rb"
+  end
+
+  def install_application_helper
+    copy_file "application_helper.rb", "#{Rails.root}/app/helpers/application_helper.rb"
+  end
+
+  def install_spec_helper_and_support_files
+    copy_file "spec_helper.rb", "#{Rails.root}/spec/spec_helper.rb"
+    copy_file "hyperlinks.rb", "#{Rails.root}/spec/support/hyperlinks.rb"
+  end
+
+  def install_routes_file
+    template "routes.rb", "#{Rails.root}/config/routes.rb"
+  end
+
+  def install_alive_controller_and_specs
+    copy_file "alive_controller.rb", "#{Rails.root}/app/controllers/alive_controller.rb"
+    route 'get "/alive" => "alive#index"'
+    copy_file "alive_routing_spec.rb", "#{Rails.root}/spec/routing/alive_routing_spec.rb"
+    copy_file "alive_spec.rb", "#{Rails.root}/spec/requests/alive_spec.rb"
+  end
+
+  def turn_off_asset_pipeline
+    application "# Disable the asset pipeline
+    config.assets.enabled = false    
+    "
+  end
+
+  def install_error_handling_and_specs
+    application "# Handle our own exceptions internally, so we can return JSON error bodies
+    config.exceptions_app = ->(env) { ErrorsController.action(:show).call(env) }
+    "
+    copy_file "errors_controller.rb", "#{Rails.root}/app/controllers/errors_controller.rb"
+  end
+
+  def turn_off_sessions_and_cookies
+    application "# Turn off sessions
+    config.session_store :disabled
+    config.middleware.delete ActionDispatch::Cookies
+    "
+  end
+
+  def install_generator_defaults
+    application "# Defaults for generators
+    config.generators do |g|
+      g.assets false
+      g.stylesheets false
+      g.helper false
+      g.test_framework :rspec, :fixture => true
+      g.fixture_replacement :factory_girl    
+    end
+    "
+  end
+
+  def install_initializers
+    copy_file "api_constants.rb",   "#{Rails.root}/config/initializers/api_constants.rb"
+    template  "config.yml.example", "#{Rails.root}/config/config.yml.example"
+    template  "config.yml.example", "#{Rails.root}/config/config.yml"
+    copy_file "ocean_constants.rb", "#{Rails.root}/config/initializers/ocean_constants.rb"
+    copy_file "zeromq_logger.rb",   "#{Rails.root}/config/initializers/zeromq_logger.rb"
+  end
+
+  def replace_gemfile
+    remove_file "#{Rails.root}/Gemfile"
+    copy_file "Gemfile", "#{Rails.root}/Gemfile"
+  end
+
+  def setup_git
+    copy_file "gitignore", "#{Rails.root}/.gitignore"
+    git :init
+  end
+
+end

data/lib/generators/ocean_setup/templates/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gem "ocean-rails", git: "git://github.com/OceanDev/ocean-rails.git"
+gem "rails", "~> 4.0"
+gem "mysql2"
+gem "foreigner"
+gem "jbuilder"
+
+group :test, :development do
+  gem "sqlite3"
+  gem "memory_test_fix"
+  gem "rspec-rails", "~> 2.0"
+  gem "simplecov", require: false
+  gem "factory_girl_rails", "~> 4.0"
+  gem "immigrant"
+  gem "annotate", ">=2.5.0"
+end
+
+gem "protected_attributes"

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

@@ -0,0 +1,18 @@
+#
+# The path /alive is implemented solely for the benefit of Varnish,
+# which is set up to use it for health checking. Due to the routing
+# implemented in Varnish, /alive can never be reached from the outside.
+#
+
+class AliveController < ApplicationController
+  
+  skip_before_action :require_x_api_token
+  skip_before_action :authorize_action
+
+
+  def index
+    # If there is a DB, call to it here to ensure it too is healthy
+    render text: "ALIVE", status: 200
+  end
+  
+end

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

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe AliveController do
+  describe "routing" do
+
+    it "routes to #index" do
+      get("/alive").should route_to("alive#index")
+    end
+
+  end
+end

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

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "/alive (for Varnish health checking)" do
+
+  it "should return a 200 with a body of OK" do
+    get "/alive", {}, {'HTTP_ACCEPT' => "application/json"}
+    response.status.should be(200)
+    response.body.should == "ALIVE"
+  end
+  
+
+end

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

@@ -0,0 +1,19 @@
+f = File.join(Rails.root, "config/config.yml")
+unless File.exists?(f)
+  puts
+  puts "-----------------------------------------------------------------------"
+  puts "Constant definition file missing. Please copy config/config.yml.example"
+  puts "to config/config.yml and tailor its contents to suit your dev setup."
+  puts
+  puts "NB: config.yml is excluded from git version control as it will contain"
+  puts "    data private to your Ocean system."
+  puts "-----------------------------------------------------------------------"
+  puts
+  abort
+end
+cfg = YAML.load(File.read(f))
+cfg.merge! cfg.fetch(Rails.env, {}) if cfg.fetch(Rails.env, {})
+cfg.each do |k, v|
+  next if k =~ /[a-z]/
+  eval "#{k} = #{v.inspect}"
+end

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

@@ -0,0 +1,8 @@
+class ApplicationController < ActionController::Base
+
+  include OceanApplicationController
+
+  before_action :require_x_api_token
+  before_action :authorize_action
+    
+end

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

@@ -0,0 +1,34 @@
+module ApplicationHelper
+
+  #
+  # Used in Jbuilder templates to build hyperlinks
+  #
+  def hyperlinks(links={})
+    result = {}
+    links.each do |qi, val|
+      result[qi.to_s] = { 
+                 "href" => val.kind_of?(String) ? val : val[:href], 
+                 "type" => val.kind_of?(String) ? "application/json" : val[:type]
+              }
+    end
+    result
+  end
+  
+
+  #
+  # This is needed everywhere except inside the Auth service to render creator
+  # and updater links correctly.
+  #
+  def api_user_url(x)
+    if x.blank?
+      "#{OCEAN_API_URL}/#{Api.version_for :api_user}/api_users/0"
+    elsif x.is_a?(Integer)
+      "#{OCEAN_API_URL}/#{Api.version_for :api_user}/api_users/#{x}"
+    elsif x.is_a?(String)
+      x
+    else
+      raise "api_user_url takes an integer, a string, or nil"
+    end
+  end
+
+end

data/lib/generators/ocean_setup/templates/config.yml.example

@@ -0,0 +1,57 @@
+##########################################################################################
+# In order for the application to work, a file named config/config.yml must exist.
+# You can use this file as a template: simply copy it, rename it and tailor its
+# contents. All data in this file will be used to define constants in your application
+# namespace. NB: the Chef recipes used to deploy this to the production environment will
+# replace the contents of config/config.yml with an auto-generated file.
+##########################################################################################
+
+
+# This is the application's name
+APP_NAME:     <%= name %>
+
+# Authentication data to use when the app authenticates with the Auth service.
+# You should substitute your own password. Passwords should not be identical
+# between services. Use a unique password in each case.
+API_USER:     <%= name %>
+API_PASSWORD: xxxxxxxxxx
+
+# This is the base domain used for all Ocean calls.
+BASE_DOMAIN:  example.com
+
+# This enumerates the latest versions of all resources in the system, not just the
+# ones defined by this service. You should keep it updated at all times.
+# The special key _default is used as a fallback.
+API_VERSIONS:
+  _default: v1
+
+# This is the list of IP numbers for the Varnish instances. (For PURGE and BAN.)
+LOAD_BALANCERS: []
+
+# This is the list of IP numbers for the ZeroMQ log hosts. (Only used in production.)
+LOG_HOSTS: []
+
+
+##########################################################################################
+# This section allows you to specify values specific for a particular Rails
+# environment. Values defined here will take precedence over the default values.
+# Make sure the declarations in each section are indented properly.
+# NB: these overrides only affect your local development environment (which may run
+#     in any of these three states). In deployment, a generated version of this file
+#     is used.
+##########################################################################################
+
+development:
+
+
+test:
+
+
+production:
+  LOAD_BALANCERS:
+    - 1.1.1.1
+    - 2.2.2.2
+
+  LOG_HOSTS:
+    - 3.3.3.3
+    - 4.4.4.4