ocean-rails 7.0.6 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5d602214f6705ec4f0af21ed3adcc1ce63de746e
-  data.tar.gz: e99a2a9a8d7484a8da4b3dc7e52bddb5e65838df
+SHA256:
+  metadata.gz: 430b30591740120543dc702fc4d8913714ef05278b5643bcdb30cf6013aa8ca6
+  data.tar.gz: e83f2f1be2cfcfe3624ad84646fb7a01115e47991fabd846a940784c289afb16
 SHA512:
-  metadata.gz: 67ca3ce19054513e77fb2697668bc659a8813ddc90955573802e9ffff443c6266554701e86fe7116b268c396e35dc157730525e8d10c2c896eeacb41f9be8c5f
-  data.tar.gz: c19110d878f51a4fd403734ea90fe680a79181ff4aecec25718cf8f7f65e1e19a16bc9762ebac8b38edbc015a57efdd04170721d1b3391f61f9bac836aaece9b
+  metadata.gz: a3da705e606f4cf37f3bde01a75cefe0be33e5e3d15cd0d684ff0800967e7f566d7cc334ecf6493a0729d614fd81845eb33849573c4a9a66a0a03a6f60930a3b
+  data.tar.gz: e4eeed6ef60805e502daf224489dcdc597330b4ba34eed5bf00715a316e9c6abe2ec57ccb4b12e1b5ddd866f808b8361369ad6bab659700e93bc3480254444fc

data/README.rdoc

@@ -10,13 +10,12 @@ Ocean requires Ruby 2.2 and Ruby on Rails 4.2.0 or later.
 === 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 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, 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.

data/lib/generators/ocean_setup/ocean_setup_generator.rb

@@ -70,7 +70,7 @@ class OceanSetupGenerator < Rails::Generators::NamedBase #:nodoc: all
       g.stylesheets false
       g.helper false
       g.test_framework :rspec, :fixture => true
-      g.fixture_replacement :factory_girl    
+      g.fixture_replacement :factory_bot    
     end
     "
   end

data/lib/generators/ocean_setup/templates/Gemfile

@@ -14,7 +14,7 @@ group :test, :development do
   gem "memory_test_fix"
   gem "rspec-rails"
   gem "simplecov", require: false
-  gem "factory_girl_rails", "~> 4.0"
+  gem "factory_bot_rails", "~> 4.0"
   gem "immigrant"
   gem "annotate", ">=2.5.0"
 end

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

@@ -16,9 +16,9 @@ Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
 # DynamoDB table cleaner
 OCEAN_ENV = "dev" unless defined?(OCEAN_ENV)
 regexp = Regexp.new("^.+_#{OCEAN_ENV}_[0-9]{1,3}-[0-9]{1,3}-[0-9]{1,3}-[0-9]{1,3}_(test|dev)$")
-cleaner = lambda { 
+cleaner = lambda {
   c = Aws::DynamoDB::Client.new
-  c.list_tables.table_names.each do |t| 
+  c.list_tables.table_names.each do |t|
     begin
       c.delete_table({table_name: t}) if t =~ regexp
     rescue Aws::DynamoDB::Errors::LimitExceededException
@@ -55,9 +55,9 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = "random"
-  
-  # Make "FactoryGirl" superfluous
-  config.include FactoryGirl::Syntax::Methods
+
+  # Make "FactoryBot" superfluous
+  config.include FactoryBot::Syntax::Methods
 
   # Uncomment the following two lines if you're using DynamoDB tables
   #config.before(:suite) { cleaner.call }

data/lib/ocean/api.rb

@@ -10,32 +10,32 @@ class Api
   # in master and staging, as the https URIs aren't available for CronJobs,
   # etc.
   #
-  def self.internalize_uri(uri, ocean_env=OCEAN_ENV)
+  def self.internalize_uri(uri) #, ocean_env=OCEAN_ENV)
     uri.sub(OCEAN_API_URL, INTERNAL_OCEAN_API_URL)
   end
 
-  
+
   #
-  # When given a symbol or string naming a resource, returns a string 
+  # When given a symbol or string naming a resource, returns a string
   # such as +v1+ naming the latest version for the resource.
   #
   def self.version_for(resource_name)
     API_VERSIONS[resource_name.to_s] || API_VERSIONS['_default']
   end
-  
+
 
   #
   # Adds environment info to the basename, so that testing and execution in various combinations
-  # of the Rails env and the Ocean environment can be done without collision. 
+  # of the Rails env and the Ocean environment can be done without collision.
   #
-  # The ocean_env will always be appended to the basename, since we never want to share queues 
-  # between different Ocean environments. 
+  # The ocean_env will always be appended to the basename, since we never want to share queues
+  # between different Ocean environments.
   #
   # If the ocean_env is 'dev' or 'ci', we must separate things as much as
-  # possible: therefore, we add the local IP number and the Rails environment. 
+  # possible: therefore, we add the local IP number and the Rails environment.
   #
-  # We also add the same information if by any chance the Rails environment isn't 'production'. 
-  # This is a precaution; in staging and prod apps should always run in Rails production mode, 
+  # We also add the same information if by any chance the Rails environment isn't 'production'.
+  # 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.
   #
   # If +suffix_only+ is true, the basename will be excluded from the returned string.
@@ -64,7 +64,7 @@ class Api
   # in order to provide lazy evaluation of headers and JSON decoding of the body.
   #
   class Response
-    
+
     def initialize(response)
       @response = response
       @headers = nil
@@ -163,23 +163,23 @@ class Api
   # Automatic retries for GET requests are available:
   #
   # +retries+, if given and > 0, specifies the number of retries to perform for GET requests. Defaults to 0, meaning no retries.
-  # +backoff_time+ (default 1) the initial time to wait between retries. 
+  # +backoff_time+ (default 1) the initial time to wait between retries.
   # +backoff_rate+ (default 0.9) the rate at which the time is increased.
   # +backoff_max+ (default 30) the maximum time to wait between retries.
   #
-  # The backoff time is increased after each wait period by the product of itself and 
+  # The backoff time is increased after each wait period by the product of itself and
   # backoff_rate. The backoff time is capped by backoff_max. The default time and rate
-  # settings will generate the progression 1, 1.9, 3.61, 6.859, 13.0321, 24.76099, 30, 30, 
+  # settings will generate the progression 1, 1.9, 3.61, 6.859, 13.0321, 24.76099, 30, 30,
   # 30, etc. To disable waiting between retries entirely, set +backoff_time+ to zero.
   #
   # If a +postprocessor+ block is given, it will be called with the result of the response;
   # whatever it returns will be returned as the result of the Api request.
-  # 
+  #
   # +Api.request+ can be called inside a +simultaneously+ block.
   #
   def self.request(url, http_method, args: nil, headers: {}, body: nil,
                    credentials: nil,
-                   x_api_token: headers['X-API-Token'], 
+                   x_api_token: headers['X-API-Token'],
                    reauthentication: true,
                    ssl_verifypeer: true, ssl_verifyhost: 2,
                    retries: 0, backoff_time: 1, backoff_rate: 0.9, backoff_max: 30,
@@ -198,7 +198,7 @@ class Api
 
     @hydra ||= Typhoeus::Hydra.hydra
 
-    request = nil   
+    request = nil
     response = nil
     response_getter = lambda { response }
 
@@ -208,10 +208,10 @@ class Api
     enqueue_request = lambda do
       # First construct a request. It will not be sent yet.
       request = Typhoeus::Request.new(url,
-                                      method: http_method, 
+                                      method: http_method,
                                       headers: headers,
-                                      params: args, 
-                                      body: body, 
+                                      params: args,
+                                      body: body,
                                       ssl_verifypeer: ssl_verifypeer,
                                       ssl_verifyhost: ssl_verifyhost,
                                       timeout: timeout)
@@ -243,7 +243,7 @@ class Api
             enqueue_request.call
           else
             nil  # Done, fail
-          end          
+          end
         when 400..499
           nil  # Done, fail
         else
@@ -280,7 +280,7 @@ class Api
   end
 
 
-  # 
+  #
   # Api.simultaneously is used for making requests in parallel. For example:
   #
   #  results = Api.simultaneously do |r|
@@ -298,11 +298,11 @@ class Api
   #
   def self.simultaneously (&block)
     raise "block required" unless block
-    @inside_simultaneously = true   
+    @inside_simultaneously = true
     results = []
-    @hydra = nil 
+    @hydra = nil
     block.call(results)
-    Typhoeus::Config.memoize = true   
+    Typhoeus::Config.memoize = true
     @hydra.run if @hydra
     results.map(&:call)
   ensure
@@ -323,9 +323,9 @@ class Api
   # Makes an internal +PURGE+ call to all Varnish instances. The call is made in parallel.
   # Varnish will only accept +PURGE+ requests coming from the local network.
   #
-  def self.purge(*args)  
+  def self.purge(*args)
     hydra = Typhoeus::Hydra.hydra
-    LOAD_BALANCERS.each do |host| 
+    LOAD_BALANCERS.each do |host|
       url = "http://#{host}#{path}"
       request = Typhoeus::Request.new(url, method: :purge, headers: {})
       hydra.queue request
@@ -338,10 +338,10 @@ class Api
   # Makes an internal +BAN+ call to all Varnish instances. The call is made in parallel.
   # Varnish will only accept +BAN+ requests coming from the local network.
   #
-  def self.ban(path)     
+  def self.ban(path)
     hydra = Typhoeus::Hydra.hydra
     escaped_path = escape(path)
-    LOAD_BALANCERS.each do |host| 
+    LOAD_BALANCERS.each do |host|
       url = "http://#{host}#{escaped_path}"
       request = Typhoeus::Request.new(url, method: :ban, headers: {})
       hydra.queue request
@@ -374,17 +374,17 @@ class Api
     @service_token = nil
   end
 
-  
+
   #
   # Authenticates against the Auth service (which must be deployed and running) with
   # a given +username+ and +password+. If successful, the authentication token is returned.
-  # If the credentials match the service's own, the token is also assigned to the instance variable @service_token. 
+  # If the credentials match the service's own, the token is also assigned to the instance variable @service_token.
   # If not successful, +nil+ is returned.
   #
   def self.authenticate(username=API_USER, password=API_PASSWORD)
     attempts = 3
     loop do
-      response = Typhoeus.post "#{INTERNAL_OCEAN_API_URL}/v1/authentications", 
+      response = Typhoeus.post "#{INTERNAL_OCEAN_API_URL}/v1/authentications",
                    body: "", headers: {'X-API-Authenticate' => credentials(username, password)}
       case response.code
       when 100..199
@@ -397,7 +397,7 @@ class Api
         return token
       when 403
         # Does not authenticate. Don't repeat the request.
-        return nil 
+        return nil
       when 400
         # Malformed credentials. Don't repeat the request.
         return nil
@@ -405,7 +405,7 @@ class Api
         # Client error. Don't repeat the request.
         return nil
       when 500
-        # Error. Don't repeat. 
+        # Error. Don't repeat.
         return nil if attempts < 1
         attempts -= 1
         next
@@ -415,10 +415,10 @@ class Api
       end
     end
   end
-  
+
 
   #
-  # Encodes a username and password for authentication in the format used for standard HTTP 
+  # Encodes a username and password for authentication in the format used for standard HTTP
   # authentication. The encoding can be reversed and is intended only to lightly mask the
   # credentials so that they're not immediately apparent when reading logs.
   #
@@ -428,14 +428,14 @@ class Api
     password ||= API_PASSWORD
     ::Base64.strict_encode64 "#{username}:#{password}"
   end
-  
+
 
   #
   # Takes encoded credentials (e.g. by Api.encode_credentials) and returns a two-element array
   # where the first element is the username and the second is the password. If the encoded
   # credentials are missing or can't be decoded properly, ["", ""] is returned. This allows
   # you to write:
-  #   
+  #
   #   un, pw = Api.decode_credentials(creds)
   #   raise "Please supply your username and password" if un.blank? || pw.blank?
   #
@@ -444,10 +444,10 @@ class Api
     username, password = ::Base64.decode64(encoded).split(':', 2)
     [username || "", password || ""]
   end
-  
+
 
   #
-  # Performs authorisation against the Auth service. The +token+ must be a token received as a 
+  # Performs authorisation against the Auth service. The +token+ must be a token received as a
   # result of a prior authentication operation. The args should be in the form
   #
   #   query: "service:controller:hyperlink:verb:app:context"
@@ -457,18 +457,18 @@ class Api
   #   Api.permitted?(@service_token, query: "cms:texts:self:GET:*:*")
   #
   # Api.authorization_string can be used to produce the query string.
-  # 
+  #
   # Returns the HTTP response as-is, allowing the caller to examine the status code and
   # messages, and also the body.
   #
   def self.permitted?(token, args={})
     raise unless token
     Api.request "/v1/authentications/#{token}", :get, args: args
-  end  
+  end
 
 
   #
-  # Returns an authorisation string suitable for use in calls to Api.permitted?. 
+  # Returns an authorisation string suitable for use in calls to Api.permitted?.
   # The +extra_actions+ arg holds the extra actions as defined in the Ocean controller; it must
   # be included here so that actions can be mapped to the proper hyperlink and verb.
   # The +controller+ and +action+ args are mandatory. The +app+ and +context+ args are optional and will
@@ -485,8 +485,8 @@ class Api
   #
   # These are the default controller actions. The purpose of this constant is to map action
   # names to hyperlink and HTTP method (for authorisation purposes). Don't be alarmed by the
-  # non-standard GET* - it's purely symbolic and is never used as an actual HTTP method. 
-  # We need it to differentiate between a +GET+ of a member and a +GET+ of a collection of members. 
+  # non-standard GET* - it's purely symbolic and is never used as an actual HTTP method.
+  # We need it to differentiate between a +GET+ of a member and a +GET+ of a collection of members.
   # The +extra_actions+ keyword in +ocean_resource_controller+ follows the same format.
   #
   DEFAULT_ACTIONS = {
@@ -515,16 +515,16 @@ class Api
   #
   # Send an email asynchronously. The Mailer role is required.
   #
-  def self.send_mail(from: "nobody@#{BASE_DOMAIN}", to: nil, 
-                     subject: nil, 
+  def self.send_mail(from: "nobody@#{BASE_DOMAIN}", to: nil,
+                     subject: nil,
                      plaintext: nil, html: nil,
                      plaintext_url: nil, html_url: nil, substitutions: nil)
-    Api.request "/v1/mails", :post, 
+    Api.request "/v1/mails", :post,
       x_api_token: Api.service_token, credentials: Api.credentials,
       body: {
-        from: from, to: to, subject: subject, 
+        from: from, to: to, subject: subject,
         plaintext: plaintext, html: html,
-        plaintext_url: plaintext_url, html_url: html_url, 
+        plaintext_url: plaintext_url, html_url: html_url,
         substitutions: substitutions
       }.to_json
   end
@@ -542,14 +542,14 @@ class Api
   #   Api.async_body steps: [{"url" => "#{INTERNAL_OCEAN_API_URL}/v1/foos"}
   #                           "method" => "PUT",
   #                           "body" => {}}]
-  # 
+  #
   # A URL not starting with a / will be internalized.
   #
   def self.async_job_body(href=nil, method=:get, body: {},
-                          credentials: nil, 
+                          credentials: nil,
                           token: nil,
                           steps: nil,
-                          default_step_time: nil, 
+                          default_step_time: nil,
                           default_poison_limit: nil,
                           max_seconds_in_queue: nil,
                           poison_email: nil)
@@ -558,7 +558,7 @@ class Api
       method = method && method.to_s.upcase
       href = href && (href.first == "/" ? "#{INTERNAL_OCEAN_API_URL}#{href}" : Api.internalize_uri(href))
       steps = if href && method
-                if ["POST","PUT"].include? method 
+                if ["POST","PUT"].include? method
                   [{"url" => href, "method" => method, "body" => body}]
                 else
                   [{"url" => href, "method" => method}]
@@ -587,11 +587,11 @@ class Api
   # A block may be given. It will be called with any +TimeoutError+ or +NoResponseError+,
   # which allows +Api.run_async_job+ to be used very tersely in controllers, e.g.:
   #
-  #   Api.run_async_job(...) do |e| 
+  #   Api.run_async_job(...) do |e|
   #     render_api_error 422, e.message
   #     return
   #   end
-  # 
+  #
   def self.run_async_job(href=nil, method=nil, job: nil, **keywords, &block)
     job ||= async_job_body(href, method, **keywords)
     Api.request "/v1/async_jobs", :post,

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "7.0.6"
+  VERSION = "7.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 7.0.6
+  version: 7.1.0
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2018-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl_rails
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -270,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: This gem implements common Ocean behaviour for Ruby and Ruby on Rails.