yext-api 0.1.1 → 0.1.3

data/lib/yext/api/enumerations/add_request_status.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Enumerations
+      # An enumeration class to contain the allowable values for the status of an AddRequest
+      class AddRequestStatus
+        include Yext::Api::Concerns::EnumAll
+
+        SUBMITTED  = "SUBMITTED"
+        PROCESSING = "PROCESSING"
+        COMPLETE   = "COMPLETE"
+        CANCELED   = "CANCELED"
+        REVIEW     = "REVIEW"
+        FAILED     = "FAILED"
+      end
+    end
+  end
+end

data/lib/yext/api/enumerations/location_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Enumerations
+      # An enumeration class to contain the allowable values for the status of an AddRequest
+      class LocationType
+        include Yext::Api::Concerns::EnumAll
+
+        LOCATION                = "LOCATION"
+        HEALTHCARE_PROFESSIONAL = "HEALTHCARE_PROFESSIONAL"
+        HEALTHCARE_FACILITY     = "HEALTHCARE_FACILITY"
+        RESTAURANT              = "RESTAURANT"
+        ATM                     = "ATM"
+      end
+    end
+  end
+end

data/lib/yext/api/knowledge_api/account_settings/account.rb

@@ -14,7 +14,6 @@ module Yext
         #           :path_regex: v2/accounts
         #           :default_version: 20161012
         #           :documentation: http://developer.yext.com/docs/administrative-api/#operation/listAccounts
-        #           :comment: List all accounts that you have access to. Unless you are in Partner Portal mode, this will only be your own account.
         #           :sandbox_only: false
         #         - :action: :show
         #           :method: :get
@@ -22,7 +21,6 @@ module Yext
         #           :path_regex: v2/accounts/\w+
         #           :default_version: 20161012
         #           :documentation: http://developer.yext.com/docs/administrative-api/#operation/getAccount
-        #           :comment: Get details for an account.
         #           :sandbox_only: false
         class Account < Yext::Api::Utils::ApiBase
           include Yext::Api::Concerns::AccountRelations

data/lib/yext/api/knowledge_api/account_settings/role.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module KnowledgeApi
+      module AccountSettings
+        # :administrative_api:
+        #   :account_settings:
+        #     :role:
+        #       :actions:
+        #        - :action: :index
+        #          :method: :get
+        #          :endpoint: https://api.yext.com/v2/accounts/{accountId}/roles
+        #          :path_regex: v2/accounts/[^/]+?/roles
+        #          :default_version: 20161012
+        #          :documentation: http://developer.yext.com/docs/api-reference/#operation/getRoles
+        #          :sandbox_only: false
+        class Role < Yext::Api::Utils::ApiBase
+          include Yext::Api::Concerns::AccountChild
+        end
+      end
+    end
+  end
+end

data/lib/yext/api/knowledge_api/account_settings/user.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module KnowledgeApi
+      module AccountSettings
+        # :administrative_api:
+        #   :account_settings:
+        #     :user:
+        #       :actions:
+        #         - :action: :index
+        #           :method: :get
+        #           :endpoint: https://api.yext.com/v2/accounts/{accountId}/users
+        #           :path_regex: v2/accounts/[^/]+?/users
+        #           :default_version: 20161012
+        #           :documentation: http://developer.yext.com/docs/api-reference/#operation/getUsers
+        #           :sandbox_only: false
+        #         - :action: :create
+        #           :method: :post
+        #           :endpoint: https://api.yext.com/v2/accounts/{accountId}/users
+        #           :path_regex: v2/accounts/[^/]+?/users
+        #           :default_version: 20161012
+        #           :documentation: http://developer.yext.com/docs/api-reference/#operation/createUser
+        #           :sandbox_only: false
+        #         - :action: :show
+        #           :method: :get
+        #           :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}
+        #           :path_regex: v2/accounts/[^/]+?/users/[^/]+?
+        #           :default_version: 20161012
+        #           :documentation: http://developer.yext.com/docs/api-reference/#operation/getUser
+        #           :sandbox_only: false
+        #         - :action: :update
+        #           :method: :put
+        #           :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}
+        #           :path_regex: v2/accounts/[^/]+?/users/[^/]+?
+        #           :default_version: 20161012
+        #           :documentation: http://developer.yext.com/docs/api-reference/#operation/updateUser
+        #           :sandbox_only: false
+        #         - :action: :destroy
+        #           :method: :delete
+        #           :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}
+        #           :path_regex: v2/accounts/[^/]+?/users/[^/]+?
+        #           :default_version: 20161012
+        #           :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteUser
+        #           :sandbox_only: false
+        #         - :action: :change_password
+        #           :method: :put
+        #           :endpoint: https://api.yext.com/v2/accounts/{accountId}/users/{userId}/password
+        #           :path_regex: v2/accounts/[^/]+?/users/[^/]+?/password
+        #           :default_version: 20161012
+        #           :documentation: http://developer.yext.com/docs/api-reference/#operation/updateUserPassword
+        #           :sandbox_only: false
+        class User < Yext::Api::Utils::ApiBase
+          include Yext::Api::Concerns::AccountChild
+
+          # Helper method to change password without a User object.
+          #
+          # Some example ways to change a password:
+          #   Yext::Api::KnowledgeApi::AccountSettings::User.account(account_id).where(id: user_id).change_password!(new_password)
+          #   Yext::Api::KnowledgeApi::AccountSettings::User.new(id: user_id, account_id: account_id).change_password!(new_password)
+          #   user = Yext::Api::KnowledgeApi::AccountSettings::User.account(account_id).find(user_id)
+          #     user.change_password!(new_password)
+          scope(:change_password!, lambda do |new_password|
+            args = scope_args
+
+            args[:newPassword] = new_password
+
+            Yext::Api::KnowledgeApi::AccountSettings::User.
+                where(args).
+                with(:password).
+                put
+          end)
+
+          def change_password!(new_password)
+            self.class.where(id: id, account_id: account_id).change_password!(new_password)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yext/api/knowledge_api/health_check/health.rb

@@ -14,7 +14,6 @@ module Yext
         #           :path_regex: v2/healthy
         #           :default_version: 20161012
         #           :documentation: http://developer.yext.com/docs/api-reference/#operation/healthCheck
-        #           :comment: The Health Check endpoint allows you to monitor the status of Yext's systems.
         #           :sandbox_only: false
         class Health < Yext::Api::Utils::ApiBase
           uri("healthy")

data/lib/yext/api/knowledge_api/knowledge_manager/category.rb

@@ -13,7 +13,6 @@ module Yext
         #           :endpoint: https://api.yext.com/v2/categories
         #           :default_version: 20161012
         #           :documentation: http://developer.yext.com/docs/api-reference/#operation/getBusinessCategories
-        #           :comment: Get available Categories.
         #           :sandbox_only: false
         #
         # Class for fetching categories

data/lib/yext/api/knowledge_api/knowledge_manager/location.rb

@@ -14,7 +14,6 @@ module Yext
         #         :path_regex: v2/accounts/[^/]+?/locations
         #         :default_version: 20161012
         #         :documentation: http://developer.yext.com/docs/api-reference/#operation/getLocations
-        #         :comment: Get multiple Locations (primary profiles only).
         #         :sandbox_only: false
         #       - :action: :create
         #         :method: :post
@@ -22,7 +21,6 @@ module Yext
         #         :path_regex: v2/accounts/[^/]+?/locations
         #         :default_version: 20161012
         #         :documentation: http://developer.yext.com/docs/api-reference/#operation/createLocation
-        #         :comment: Create a new Location.
         #         :sandbox_only: false
         #       - :action: :search
         #         :method: :get
@@ -30,7 +28,6 @@ module Yext
         #         :path_regex: v2/accounts/[^/]+?/locationsearch
         #         :default_version: 20161012
         #         :documentation: http://developer.yext.com/docs/api-reference/#operation/searchLocations
-        #         :comment: Get multiple Locations (primary profiles only) that match provided filters.
         #         :sandbox_only: false
         #       - :action: :show
         #         :method: :get
@@ -38,7 +35,6 @@ module Yext
         #         :path_regex: v2/accounts/[^/]+?/locations/[^/]+??
         #         :default_version: 20161012
         #         :documentation: http://developer.yext.com/docs/api-reference/#operation/getLocation
-        #         :comment: Gets the primary profile for a single Location.
         #         :sandbox_only: false
         #       - :action: :update
         #         :method: :put
@@ -46,12 +42,28 @@ module Yext
         #         :path_regex: v2/accounts/[^/]+?/locations/[^/]+??
         #         :default_version: 20161012
         #         :documentation: http://developer.yext.com/docs/api-reference/#operation/updateLocation
-        #         :comment: Updates the primary profile for a Location.
         #         :sandbox_only: false
         class Location < Yext::Api::Utils::ApiBase
           include Yext::Api::Concerns::AccountChild
 
-          # TODO: Custom endpoints
+          # http://developer.yext.com/docs/administrative-api/#operation/createExistingLocationAddRequest
+          def add_services!(skus:, agreement_id: nil, force_review: false)
+            args               = { existingAccountId: account_id, existingLocationId: id }
+            args[:skus]        = skus if skus.present?
+            args[:agreementId] = agreement_id if agreement_id.present?
+            args[:forceReview] = force_review if force_review.present?
+
+            Yext::Api::AdministrativeApi::AddRequest.add_services!(args)
+          end
+
+          # http://developer.yext.com/docs/administrative-api/#operation/cancelServices
+          def cancel_services!(agreement_id: nil, skus: nil)
+            args               = { locationId: id }
+            args[:agreementId] = agreement_id if agreement_id.present?
+            args[:skus]        = skus if skus.present?
+
+            Yext::Api::AdministrativeApi::Service.cancel_services!(args)
+          end
         end
       end
     end

data/lib/yext/api/live_api/location.rb

@@ -15,9 +15,6 @@ module Yext
       #           :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations
       #           :default_version: 20161012
       #           :documentation: http://developer.yext.com/docs/live-api/#operation/locationsList
-      #           :comment: >
-      #             Get multiple Locations (primary profile only). Filters are evaluated against all language
-      #             profiles as well as the primary profile.
       #           :sandbox_only: false
       #         - :action: :show
       #           :method: :get
@@ -25,7 +22,6 @@ module Yext
       #           :path_regex: https://liveapi.yext.com/v2/accounts/[^/]+?/locations/[^/]+??
       #           :default_version: 20161012
       #           :documentation: http://developer.yext.com/docs/live-api/#operation/getLocation
-      #           :comment: Gets the primary profile for a single Location.
       #           :sandbox_only: false
       class Location < Yext::Api::Utils::ApiBase
         include Yext::Api::Concerns::AccountChild

data/lib/yext/api/utils/api_base.rb

@@ -7,6 +7,14 @@ module Yext
       class ApiBase < Spyke::Base
         include Yext::Api::Concerns::FaradayConnection
         include Yext::Api::Concerns::DefaultScopes
+
+        before_save :ensure_create_id
+
+        private
+
+        def ensure_create_id
+          attributes[:create_id] ||= attributes[:id]
+        end
       end
     end
   end

data/lib/yext/api/utils/api_finder.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Utils
+      # This module add the `find_api` method to a class to allow the searching of the base
+      # api category module for a particular route.
+      class ApiFinder
+        class << self
+          def api_hash
+            @api_hash ||= YAML.load_file(Yext::Api::Engine.root.join("lib/config/api.yml"))
+          end
+        end
+
+        def initialize(uri_path, uri_method)
+          uri       = URI.parse(uri_path.to_s)
+          uri.query = nil
+
+          @uri_path   = uri.to_s
+          @uri_method = uri_method.to_s
+        end
+
+        def find_api
+          api = find_class_name.to_s.split("::")
+
+          return nil if api.length < 3
+
+          "Yext::Api::#{api[2]}".constantize
+        end
+
+        def find_class_name
+          api_hash = Yext::Api::Utils::ApiFinder.api_hash
+
+          return build_class_name("Yext::Api::LiveApi", api_hash[:live_api]) if uri_path.include?("//liveapi.")
+
+          api_hash.each do |api_class, module_details|
+            next if api_class == :webhooks
+
+            found_class = build_class_name("Yext::Api::#{api_class.to_s.classify}", module_details)
+
+            return found_class if found_class.present?
+          end
+
+          nil
+        end
+
+        private
+
+        attr_accessor :uri_path,
+                      :uri_method
+
+        def build_class_name(built_name, module_details)
+          module_details.each do |sub_detail_name, sub_detail|
+            found_class = find_class_in_module(built_name, sub_detail_name, sub_detail)
+
+            return found_class unless found_class.nil?
+          end
+
+          nil
+        end
+
+        def find_class_in_module(built_name, sub_detail_name, sub_detail)
+          possible_name = construct_build_name(built_name, sub_detail_name, sub_detail)
+
+          if sub_detail_name == :objects
+            sub_detail.each do |class_name, class_actions|
+              return "#{possible_name}::#{class_name.to_s.classify}" if action_found?(class_actions[:actions])
+            end
+
+            nil
+          elsif sub_detail.is_a?(Hash)
+            build_class_name(possible_name, sub_detail)
+          end
+        end
+
+        def construct_build_name(built_name, sub_detail_name, sub_detail)
+          return built_name if %i[documentation objects].include?(sub_detail_name)
+
+          name = sub_detail_name.to_s.classify
+          name = sub_detail[:module_name] if sub_detail.is_a?(Hash) && sub_detail[:module_name].present?
+
+          "#{built_name}::#{name}"
+        end
+
+        def action_found?(actions)
+          return false if actions.blank?
+
+          actions.each do |action|
+            next if action[:path_regex].blank?
+            next if action[:method].to_s != uri_method
+
+            return true if Regexp.new("#{action[:path_regex]}$").match(uri_path)
+          end
+
+          false
+        end
+      end
+    end
+  end
+end

data/lib/yext/api/utils/configuration.rb

@@ -55,6 +55,23 @@ module Yext
       #
       # sandbox
       #   Boolean that indicates if the gem should use the production or sandbox URL.
+      #
+      # default_callback_processor
+      #   The default class to be used to process webhook messages that are called.
+      #   The code will warn about any missing webhook messages in a default processor.
+      # set_callback_processor(callback_function_name, processor)
+      #   The class to be used to process webhook messages for a specific callback.
+      #   If the method callback_function_name is not a public instance method for processor, an error
+      #   will be raised.
+      #
+      #   The processor class must be able to be instanciated with the following arguments:
+      #     * meta              - a hash of metadata for the webhook
+      #     * object            - a Spyke::Base object that represents the object that ws updated or changed
+      #                           to cause the hook event.
+      #     * language_profiles - (optional) An array of objects.
+      #
+      #   The functions that can be called for the webhooks are:
+      #     * add_request_changed
       class Configuration
         include Singleton
 
@@ -79,8 +96,84 @@ module Yext
           @validation_level = value
         end
 
+        def param_account_id
+          account_id || "me"
+        end
+
+        def default_callback_processor=(value)
+          callback_names.each do |callback_name|
+            verify_method(value, callback_name)
+          end
+
+          callback_processors[:default] = value
+        end
+
+        def default_callback_processor
+          callback_processors[:default]
+        end
+
+        def set_callback_processor(callback_function_name, processor)
+          callback_function_name = callback_function_name.downcase.to_sym
+
+          validate_arguments(callback_function_name, processor)
+
+          if processor.present?
+            callback_processors[callback_function_name.downcase.to_sym] = processor
+          else
+            callback_processors.delete(callback_function_name.downcase.to_sym)
+          end
+        end
+
+        def get_callback_processor(callback_function_name)
+          callback_function_name = callback_function_name.downcase.to_sym
+
+          callback_processors.fetch(callback_function_name, callback_processors[:default])
+        end
+
         private
 
+        def validate_arguments(callback_function_name, processor)
+          raise ArgumentError, "invalid callback function #{callback_function_name}" unless callback_names.include?(callback_function_name)
+
+          return if verify_method(processor, callback_function_name)
+
+          raise ArgumentError, "#{processor.name} does not have a valid #{callback_function_name} function"
+        end
+
+        def callback_processors
+          @callback_processors ||= {}
+        end
+
+        def callback_names
+          %i[add_request_changed].dup
+        end
+
+        def verify_method(callback_class, method_name)
+          return true if callback_class.blank?
+          return true if valid_method_definition?(callback_class, method_name)
+
+          warning_messsage = "The callback_processor does not include a valid #{method_name} method."
+          if Object.const_defined?("Rails")
+            Rails.logger.warn warning_messsage
+          else
+            # :nocov:
+            puts warning_messsage
+            # :nocov:
+          end
+
+          false
+        end
+
+        def valid_method_definition?(callback_class, method_name)
+          return false if callback_class.public_instance_methods.grep(method_name).blank?
+
+          method = callback_class.instance_method(method_name)
+
+          return true if method.parameters.length.zero?
+
+          method.parameters.count { |param_details| %i[keyreq req].include?(param_details.first) }.zero?
+        end
+
         def read_from_environment_variables
           @sandbox = !Rails.env.production?