sfrest 0.0.30 → 0.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5d935fa06aa4609da0f2a5216400ebc8b88ca7e5d973962f5834b83390ff516
-  data.tar.gz: 2d532f771e96c443e41c0184ff03d2af957a1759ce8207eb99c75fa90cf9e99c
+  metadata.gz: 16898910d9454541990159add8a5ad32b5bf07f0538a8c35c86c0abc448c2f60
+  data.tar.gz: 614c622674db0cbae5bd91db694c71afb526ebcc2d698b10fe845a6366924480
 SHA512:
-  metadata.gz: 0ced957ae4b74d3e968794cc4f7aebd061f278fe30f240fb04dc0fd2c4d3c90d23591972433c17005e923dddbaa2e9e690bf2c164225c60e203718c4b2f47a83
-  data.tar.gz: 3bc8c3d799abbae1467c404b4cab407e7e23fec78fdc4d4651e91e73bedafd335cedc8c9b6a052e4bdf5daf2905f490e274b963bfb67e130d464abccb0a1449f
+  metadata.gz: 29ef2feca8cd6d6bb3a78efa6ebef26cea4c6fd52aad8b05d3a859582047a9f263fca0f58526b28c35b01197d66b3bb7d373aa6a494b08a716040d99bb43f8dc
+  data.tar.gz: 62303e0c264dbddec7652a8d6ab45b75f6ba9bd701bf5e565c74cf9e9048d53c783863472e480cc99772c63e8dc9db5b5592c072524a123cc9e8f9ea4e675d4e

data/lib/sfrest.rb

@@ -17,6 +17,7 @@ require 'sfrest/domains'
 require 'sfrest/error'
 require 'sfrest/group'
 require 'sfrest/info'
+require 'sfrest/profile'
 require 'sfrest/pathbuilder'
 require 'sfrest/role'
 require 'sfrest/site'

data/lib/sfrest/connection.rb

@@ -169,6 +169,7 @@ module SFRest
                       domains
                       group
                       info
+                      profile
                       role
                       site
                       stage

data/lib/sfrest/domains.rb

@@ -61,5 +61,22 @@ module SFRest
       payload = { 'domain_name' => domain_name }.to_json
       @conn.post("/api/v1/domains/#{node_id}/remove", payload)
     end
+
+    # Get domain status
+    # @param [String] domain_name domain to remove. e.g. www.example.com
+    #
+    # @return [Hash] {  "message" => "The domain is associated with the node.",
+    #   "is_domain_associated" => TRUE,
+    #   "node_id" => 123,
+    #   "node_type" => "site",
+    #   "time" => "2016-10-28T09:25:26+00:00",
+    #   "stack_id" => 1,
+    #   "domains" => array(
+    #      "protected_domains" => array('site.example.sfdev.acquia-test.co'),
+    #       "custom_domains" => array('www.abc.com/def', 'www.xyz.com'),
+    #   ) }
+    def status(domain_name)
+      @conn.get("/api/v1/domains/status/#{domain_name}")
+    end
   end
 end

data/lib/sfrest/group.rb

@@ -159,5 +159,13 @@ module SFRest
       end
       nil
     end
+
+    # Returns sites belonging to a specified group id.
+    # @param [Integer] group_id Id of the group to fetch
+    # @return [Hash] {'count' => count, 'sites' => Hash }
+    def sites(group_id = 0)
+      current_path = "/api/v1/groups/#{group_id}/sites"
+      @conn.get(current_path)
+    end
   end
 end

data/lib/sfrest/profile.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module SFRest
+  # Work with installation profiles.
+  class Profile
+    # @param [SFRest::Connection] conn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Gets a list of installation profiles.
+    #
+    # @param [Hash] params Given as URL parameters.
+    # @option params [Integer] :stack_id A stack id to filter by.
+    # @option params [Boolean] :is_enabled True to filter by enabled profiles. False
+    #   to filter by disabled profiles.
+    # @return [Hash] Profile info formatted like so: {
+    #     'profiles' => [{
+    #       'name' => 'testing',
+    #       'description' => 'Some description',
+    #       'stack_id' => 1,
+    #       'rest_api_default' => false,
+    #       'enabled' => true
+    #     }],
+    #     'count' => 1,
+    #     'time' => '2021-03-12T02:26:34+00:00'
+    #   }
+    def profile_list(**params)
+      target_url = '/api/v1/profiles'
+      # Generate a string like "stack_id=3&is_enabled=true"
+      url_params = params.each.map { |k, v| "#{k}=#{v}" }.join('&')
+      target_url += "?#{url_params}" unless url_params.empty?
+
+      # Output is already well-formed, so return it.
+      @conn.get(target_url)
+    end
+
+    # Enables an installation profile.
+    #
+    # @param [String] name
+    # @param [Integer] stack_id Required if the factory is multistack.
+    def enable(name, stack_id: nil)
+      target_url = "/api/v1/profiles/#{name}/enable"
+      target_url += "?stack_id=#{stack_id}" unless stack_id.nil?
+      @conn.post(target_url, '{}')
+    end
+
+    # Disables an installation profile.
+    #
+    # @param [String] name
+    # @param [Integer] stack_id Required if the factory is multistack.
+    def disable(name, stack_id: nil)
+      target_url = "/api/v1/profiles/#{name}/disable"
+      target_url += "?stack_id=#{stack_id}" unless stack_id.nil?
+      @conn.post(target_url, '{}')
+    end
+
+    # Sets the default installation profile for use with other REST endpoints.
+    #
+    # @param [String] name
+    # @param [Integer] stack_id Required if the factory is multistack.
+    def set_default(name, stack_id: nil)
+      target_url = "/api/v1/profiles/#{name}/set_default"
+      target_url += "?stack_id=#{stack_id}" unless stack_id.nil?
+      @conn.post(target_url, '{}')
+    end
+  end
+end

data/lib/sfrest/site.rb

@@ -55,20 +55,21 @@ module SFRest
       res['sites'].first['id']
     end
 
-    # Gets the complete list of sites
-    # Makes multiple requests to the factory to get all the sites on the factory
-    # @param [Boolean] show_incomplete whether to include incomplete sites in
-    #   the list. The default differs from UI/SF to maintain backward compatibility.
+    # Gets the complete list of sites.
+    #
+    # Makes multiple requests to the factory to get all the sites on the
+    # factory.
+    #
+    # @param [Hash] opts query parameters to be used in this request.
     # @return [Hash{'count' => Integer, 'sites' => Hash}]
-    # rubocop: disable Style/OptionalBooleanParameter
-    def site_list(show_incomplete = true)
+    def site_list(**opts)
       page = 1
       not_done = true
       count = 0
       sites = []
       while not_done
-        current_path = '/api/v1/sites?page='.dup << page.to_s
-        current_path <<= '&show_incomplete=true' if show_incomplete
+        opts['page'] = page
+        current_path = "/api/v1/sites?#{URI.encode_www_form(opts)}"
         res = @conn.get(current_path)
         if res['sites'] == []
           not_done = false
@@ -86,7 +87,6 @@ module SFRest
       end
       { 'count' => count, 'sites' => sites }
     end
-    # rubocop: enable Style/OptionalBooleanParameter
 
     # Creates a site.
     # @param [String] sitename The name of the site to create.

data/lib/sfrest/stage.rb

@@ -37,11 +37,11 @@ module SFRest
     # @return [Integer] Id of the staging task created.
     # rubocop:disable Metrics/ParameterLists
     def enhanced_stage(env: 'test',
-                       sites: nil,
+                       sites: [],
                        email_site_status: false,
                        wipe_target_environment: false,
                        synchronize_all_users: true,
-                       wipe_stacks: nil)
+                       wipe_stacks: [])
       raise InvalidApiVersion, staging_versions unless staging_versions.include? 2
 
       payload = { 'to_env' => env, 'sites' => sites,

data/lib/sfrest/version.rb

@@ -2,5 +2,5 @@
 
 module SFRest
   # Just tracks the version of sfrest.
-  VERSION = '0.0.30'
+  VERSION = '0.0.35'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfrest
 version: !ruby/object:Gem::Version
-  version: 0.0.30
+  version: 0.0.35
 platform: ruby
 authors:
 - ACSF Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -111,6 +111,7 @@ files:
 - lib/sfrest/group.rb
 - lib/sfrest/info.rb
 - lib/sfrest/pathbuilder.rb
+- lib/sfrest/profile.rb
 - lib/sfrest/role.rb
 - lib/sfrest/site.rb
 - lib/sfrest/stage.rb
@@ -140,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Acquia Site Factory Rest API.