sfrest 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 503e0513bc735d120e86fa1c89bf6f5679af9b47
-  data.tar.gz: 217003f9137d9c8e9ef375183c155d7f09dc9d15
+  metadata.gz: 9e5a68209a45ec0dc81e36535e276889ff2f86b6
+  data.tar.gz: 02797d6219680639b0f6669a57af3ffec251839c
 SHA512:
-  metadata.gz: 8e0052781a7ceb063ffc24b081d5f8d838d974bfcfbdc7a1d1b5a0e48bfd1f37cf710f9348f586f705606ac271b346a94886868d9b6384e7cd7ebddc911ba86f
-  data.tar.gz: 41ac61ab6a027c9fe7ce8a8a82b7ffa20e9de0272993fda29f3d79e5d870f70482a3d089092c87e8d6aa55714439262e66e88ce94c400fd7a76fab224a4601f4
+  metadata.gz: 447e1cf3621ca1f9d343a773a2e3ac8a701bdbd0de352421399b859c7388f3fc68c3e5d6f7e0575ddb024faef73ef07056b17b17429c3307b5171981d82a55a7
+  data.tar.gz: f860b23a28e13c26faa939b2b6f44b088a4508d35e5efefd07f81946a8e1413187995b49db57a6c8ec6125d142cb24c6333b59d108d1249fead3b65335f2f47e

data/lib/sfrest/collection.rb

@@ -0,0 +1,159 @@
+module SFRest
+  # Find colletions, return their data.
+  class Collection
+    # @param [SFRest::Connection] conn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # gets the site ID for the site named sitename
+    # will page through all the sites available searching for the site
+    # @param [String] name the name of the site
+    # @return [Integer] the id of sitename
+    def get_collection_id(name)
+      pglimit = 100
+      res = @conn.get('/api/v1/collections&limit=' + pglimit.to_s)
+      count = res['count'].to_i
+      id = collection_data_from_results(res, name, 'id')
+      return id if id
+      pages = (count / pglimit) + 1
+      2.upto(pages) do |i|
+        res = @conn.get('/api/v1/collections&limit=' + pglimit.to_s + '?page=' + i.to_s)
+        id = collection_data_from_results(res, name, 'id')
+        return id if id
+      end
+      nil
+    end
+
+    # Extract the site data for 'key' based on the site result object
+    # @param [Hash] res result from a request to /collections
+    # @param [String] name
+    # @param [String] key one of the user data returned (id, name, domain...)
+    # @return [Object] Integer, String, Array, Hash depending on the collection data
+    def collection_data_from_results(res, name, key)
+      collections = res['collections']
+      collections.each do |collection|
+        return collection[key] if collection['name'] == name
+      end
+      nil
+    end
+
+    # Gets the site data for a specific id
+    # @param [Integer] id the site id
+    # @return [Hash]
+    def get_collection_data(id)
+      @conn.get('/api/v1/collections/' + id.to_s)
+    end
+
+    # gets the site id of the 1st one found using the api
+    # @return [Integer] the site id
+    def first_collection_id
+      res = @conn.get('/api/v1/collections')
+      res['collections'].first['id']
+    end
+
+    # Gets the complete list of collections
+    # Makes multiple requests to the factory to get all the collections on the factory
+    # @return [Hash{'count' => Integer, 'sites' => Hash}]
+    def collection_list
+      page = 1
+      not_done = true
+      count = 0
+      while not_done
+        current_path = '/api/v1/collections?page=' << page.to_s
+        res = @conn.get(current_path)
+        if res['collections'] == []
+          not_done = false
+        elsif !res['message'].nil?
+          return { 'message' => res['message'] }
+        elsif page == 1
+          count = res['count']
+          collections = res['collections']
+        else
+          res['collections'].each do |collection|
+            collections << collection
+          end
+        end
+        page += 1
+      end
+      { 'count' => count, 'collections' => collections }
+    end
+
+    # create a site collection
+    # @param [String] name site collection name
+    # @param [int|Array] sites nid or array of site nids. First nid is primary
+    # @param [int|Array] groups gid or array of group ids.
+    # @param [String] internal_domain_prefix optional the prefix for the internal domain
+    #                                 defaults to name
+    # @return [Hash { "id" => Integer, "name" => String,
+    #                 "time" => "2016-11-25T13:18:44+00:00",
+    #                 "internal_domain" => String }]
+    def create(name, sites, groups, internal_domain_prefix = nil)
+      sites = Array(sites)
+      groups = Array(groups)
+      current_path = '/api/v1/collections'
+      payload = { 'name' => name, 'site_ids' => sites, 'group_ids' => groups,
+                  'internal_domain_prefix' => internal_domain_prefix }.to_json
+      @conn.post(current_path, payload)
+    end
+
+    # deletes a site collection
+    # performs the same action as deleting in the UI
+    # @param [Integer] id the id of the site collection to delete
+    # @return [Hash{ "id" => Integer,
+    #                "time" => "2016-10-28T09:25:26+00:00",
+    #                "deleted" => Boolean,
+    #                "message" => String }]
+    def delete(id)
+      current_path = "/api/v1/collections/#{id}"
+      @conn.delete(current_path)
+    end
+
+    # adds site(s) to a site collection
+    # @param [int] id of the collection to which to add sites
+    # @param [int|Array] sites nid or array of site nids.
+    # @return [Hash{ "id" => Integer,
+    #                "name" => String,
+    #                "time" => "2016-10-28T09:25:26+00:00",
+    #                "site_ids_added" => Array,
+    #                "added" => Boolean,
+    #                "message" => String }]
+    def add_sites(id, sites)
+      sites = Array(sites)
+      payload = { 'site_ids' => sites }.to_json
+      current_path = "/api/v1/collections/#{id}/add"
+      @conn.post(current_path, payload)
+    end
+
+    # removes site(s) from a site collection
+    # @param [int] id of the collection from which to remove sites
+    # @param [int|Array] sites nid or array of site nids.
+    # @return [Hash{ "id" => Integer,
+    #                "name" => String,
+    #                "time" => "2016-10-28T09:25:26+00:00",
+    #                "site_ids_removed" => Array,
+    #                "removed" => Boolean,
+    #                "message" => String }]
+    def remove_sites(id, sites)
+      sites = Array(sites)
+      payload = { 'site_ids' => sites }.to_json
+      current_path = "/api/v1/collections/#{id}/remove"
+      @conn.post(current_path, payload)
+    end
+
+    # sets a site to be a primary site in a site collection
+    # @param [int] id of the collection where the primary site is being changed
+    # @param [int] site nid to become the primary site
+    # @return [Hash{ "id" => Integer,
+    #                "name" => String,
+    #                "time" => "2016-10-28T09:25:26+00:00",
+    #                "primary_site_id": Integer,
+    #                "switched" => Boolean,
+    #                "message" => String }]
+    def set_primary_site(id, site)
+      payload = { 'site_id' => site }.to_json
+      current_path = "/api/v1/collections/#{id}/set-primary"
+      @conn.post(current_path, payload)
+    end
+  end
+end

data/lib/sfrest/connection.rb

@@ -26,7 +26,7 @@ module SFRest
                       password: password,
                       ssl_verify_peer: false)
       begin
-        access_check JSON(res.body)
+        access_check JSON(res.body), res.status
       rescue JSON::ParserError
         res.body
       end
@@ -45,7 +45,7 @@ module SFRest
                       password: password,
                       ssl_verify_peer: false)
       begin
-        data = access_check JSON(res.body)
+        data = access_check JSON(res.body), res.status
         return res.status, data
 
       rescue JSON::ParserError
@@ -67,7 +67,7 @@ module SFRest
                        ssl_verify_peer: false,
                        body: payload)
       begin
-        access_check JSON(res.body)
+        access_check JSON(res.body), res.status
       rescue JSON::ParserError
         res.body
       end
@@ -87,7 +87,7 @@ module SFRest
                       ssl_verify_peer: false,
                       body: payload)
       begin
-        access_check JSON(res.body)
+        access_check JSON(res.body), res.status
       rescue JSON::ParserError
         res.body
       end
@@ -106,7 +106,7 @@ module SFRest
                          password: password,
                          ssl_verify_peer: false)
       begin
-        access_check JSON(res.body)
+        access_check JSON(res.body), res.status
       rescue JSON::ParserError
         res.body
       end
@@ -114,17 +114,32 @@ module SFRest
 
     # Throws an SFRest exception for requests that have problems
     # @param [Object] data JSON parsed http reponse of the SFApi
+    # @param [int] http_status the request's HTTP status
     # @return [Object] the data object if there are no issues
     # @raise [SFRest::AccessDeniedError] if Authentication fails
     # @raise [SFRest::ActionForbiddenError] if the users role cannot perform the request
     # @raise [SFRest::BadRequestError]  if there is something malformed in the request
+    # @raise [SFRest::UnprocessableEntity] if there is an unprocessable entity in the request
+    # @raise [SFRest::SFError] if the response HTTP status indicates an error but without the above qualifiers
     #
-    def access_check(data)
-      return data unless data.is_a?(Hash) # if there is an error message, it will be in a hash.
-      unless data['message'].nil?
-        raise SFRest::AccessDeniedError, data['message'] if data['message'] =~ /Access denied/
-        raise SFRest::ActionForbiddenError, data['message'] if data['message'] =~ /Forbidden: /
-        raise SFRest::BadRequestError, data['message'] if data['message'] =~ /Bad Request:/
+    # The cyclomatic complexity check is being ignored here because we are
+    # collecting all the possible exception raising cases.
+    def access_check(data, http_status) # rubocop:disable Metrics/CyclomaticComplexity
+      if data.is_a?(Hash) && !data['message'].nil?
+        case data['message']
+        when /Access denied|Access Denied/
+          raise SFRest::AccessDeniedError, data['message']
+        when /Forbidden: /
+          raise SFRest::ActionForbiddenError, data['message']
+        when /Bad Request:/
+          raise SFRest::BadRequestError, data['message']
+        when /Unprocessible Entity: |Unprocessable Entity: /
+          raise SFRest::UnprocessableEntity, data['message']
+        end
+        if http_status >= 400 && http_status <= 599
+          sf_err_message = "Status: #{http_status}, Message: #{data['message']}"
+          raise SFRest::SFError, sf_err_message
+        end
       end
       data
     end
@@ -151,9 +166,10 @@ module SFRest
     # NOTE: accessor == Class_name.to_lower
     REST_METHODS = %w(audit
                       backup
-                      collections
+                      collection
                       domains
                       group
+                      info
                       role
                       site
                       stage

data/lib/sfrest/error.rb

@@ -14,6 +14,12 @@ module SFRest
   # the factory
   class BadRequestError < SFRest::SFError; end
 
+  # Throw this when the request contains unprocessable entity.
+  class UnprocessableEntity < SFRest::SFError; end
+
   # Throw when a task appears to be running too long
   class TaskNotDoneError < SFRest::SFError; end
+
+  # if you get in valid data
+  class InvalidDataError < SFRest::SFError; end
 end

data/lib/sfrest/info.rb

@@ -0,0 +1,16 @@
+module SFRest
+  # Retrieve Site Factory info.
+  class Info
+    # @param [SFRest::Connection] conn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Gets information about the Site Factory.
+    # @return [Hash{ "factory_version" => String,
+    #                "time" => "2016-10-28T09:25:26+00:00"}]
+    def sfinfo
+      @conn.get('/api/v1/sf-info')
+    end
+  end
+end

data/lib/sfrest/task.rb

@@ -191,12 +191,17 @@ module SFRest
 
     # Gets the value of a vairable
     # @TODO: this is missnamed becasue it does not check the global paused variable
-    # @param [String] variable_name
-    # @return [Object]
-    def globally_paused?(variable_name)
-      current_path = "/api/v1/variables?name=#{variable_name}"
-      res = @conn.get(current_path)
-      res[variable_name]
+    # @return [Boolean]
+    def globally_paused?
+      paused = false
+      current_path = '/api/v1/variables?name=wip_pause_global'
+      begin
+        res = @conn.get(current_path)
+        paused = res['wip_pause_global']
+      rescue SFRest::SFError => error
+        paused = false if error.message =~ /Variable not found/
+      end
+      paused
     end
 
     # Pauses a specific task identified by its task id.

data/lib/sfrest/version.rb

@@ -1,4 +1,4 @@
 module SFRest
   # Just tracks the version of sfrest.
-  VERSION = '0.0.11'.freeze
+  VERSION = '0.0.12'.freeze
 end

data/lib/sfrest.rb

@@ -8,11 +8,12 @@ require 'json'
 
 require 'sfrest/audit'
 require 'sfrest/backup'
-require 'sfrest/collections'
+require 'sfrest/collection'
 require 'sfrest/connection'
 require 'sfrest/domains'
 require 'sfrest/error'
 require 'sfrest/group'
+require 'sfrest/info'
 require 'sfrest/pathbuilder'
 require 'sfrest/role'
 require 'sfrest/site'
@@ -42,4 +43,21 @@ module SFRest
       @conn = SFRest::Connection.new(@base_url, @user, @password)
     end
   end
+
+  # Extract the return data for 'key' based on the result object
+  # @param [Hash] res result from a request to /collections or /site
+  # @param [String] field data field to search
+  # @param [String] datapat regex-like pattern to match to the data field
+  # @param [String] key one of the user data returned (id, name, domain...)
+  # @return [Object] Integer, String, Array, Hash depending on the collection data
+  def self.find_data_from_results(res, field, datapat, key)
+    data = res.select { |k| !k.to_s.match(/time|count/) }
+    raise InvalidDataError('The data you are searching is not a hash') unless data.is_a?(Hash)
+    data.each_value do |datum|
+      datum.each do |dat|
+        return dat[key] if dat[field].to_s =~ /#{datapat}/
+      end
+    end
+    nil
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfrest
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - ACSF Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -89,11 +103,12 @@ files:
 - lib/sfrest.rb
 - lib/sfrest/audit.rb
 - lib/sfrest/backup.rb
-- lib/sfrest/collections.rb
+- lib/sfrest/collection.rb
 - lib/sfrest/connection.rb
 - lib/sfrest/domains.rb
 - lib/sfrest/error.rb
 - lib/sfrest/group.rb
+- lib/sfrest/info.rb
 - lib/sfrest/pathbuilder.rb
 - lib/sfrest/role.rb
 - lib/sfrest/site.rb
@@ -125,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Acquia Site Factory Rest API.

data/lib/sfrest/collections.rb

@@ -1,82 +0,0 @@
-module SFRest
-  # Find colletions, return their data.
-  class Collections
-    # @param [SFRest::Connection] conn
-    def initialize(conn)
-      @conn = conn
-    end
-
-    # gets the site ID for the site named sitename
-    # will page through all the sites available searching for the site
-    # @param [String] name the name of the site
-    # @return [Integer] the id of sitename
-    def get_collection_id(name)
-      pglimit = 100
-      res = @conn.get('/api/v1/collections&limit=' + pglimit.to_s)
-      count = res['count'].to_i
-      id = collection_data_from_results(res, name, 'id')
-      return id if id
-      pages = (count / pglimit) + 1
-      2.upto(pages) do |i|
-        res = @conn.get('/api/v1/collections&limit=' + pglimit.to_s + '?page=' + i.to_s)
-        id = collection_data_from_results(res, name, 'id')
-        return id if id
-      end
-      nil
-    end
-
-    # Extract the site data for 'key' based on the site result object
-    # @param [Hash] res result from a request to /collections
-    # @param [String] name
-    # @param [String] key one of the user data returned (id, name, domain...)
-    # @return [Object] Integer, String, Array, Hash depending on the collection data
-    def collection_data_from_results(res, name, key)
-      collections = res['collections']
-      collections.each do |collection|
-        return collection[key] if collection['name'] == name
-      end
-      nil
-    end
-
-    # Gets the site data for a specific id
-    # @param [Integer] id the site id
-    # @return [Hash]
-    def get_collection_data(id)
-      @conn.get('/api/v1/collections/' + id.to_s)
-    end
-
-    # gets the site id of the 1st one found using the api
-    # @return [Integer] the site id
-    def first_collection_id
-      res = @conn.get('/api/v1/collections')
-      res['collections'].first['id']
-    end
-
-    # Gets the complete list of collections
-    # Makes multiple requests to the factory to get all the collections on the factory
-    # @return [Hash{'count' => Integer, 'sites' => Hash}]
-    def collection_list
-      page = 1
-      not_done = true
-      count = 0
-      while not_done
-        current_path = '/api/v1/collections?page=' << page.to_s
-        res = @conn.get(current_path)
-        if res['collections'] == []
-          not_done = false
-        elsif !res['message'].nil?
-          return { 'message' => res['message'] }
-        elsif page == 1
-          count = res['count']
-          collections = res['collections']
-        else
-          res['collections'].each do |collection|
-            collections << collection
-          end
-        end
-        page += 1
-      end
-      { 'count' => count, 'collections' => collections }
-    end
-  end
-end