yext-api 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b00aa1601c943ccd86176b00dbd9d0dc2cfe62ba
-  data.tar.gz: 3dc9545705404a5c812be0d70e77d57f6f61e8e2
+  metadata.gz: f99917453bea7720f49022c02cf64fd132944d33
+  data.tar.gz: 89289aa7c0dbcf44ac8d10864ee995c71f0a3d24
 SHA512:
-  metadata.gz: 55c0f57e48913eddf4ae516022b76ecc9a44ff5b257280b1aa56d4c28e66df12f8023128ea8d2de1443a07e6713b5a43a0ab16e6ab0bbc7157ee6ad6cf9331bf
-  data.tar.gz: 01d6deaaaaedac4668c22ad2808c1d39fa7ad5e6f6bc7478c144b34e0726811229f0b84b8cbc83c4628eafbdb6f1e2795882c3c9e2b7f8bcf9a2717722ac7411
+  metadata.gz: c43378a81d8ef44bfafdab12deb9fcc05c632dbac4ff9b29d1abb9d0d1f50b5d1aceb7b90975268001b99ca3cbac15fec08177ee1a7fbdc1f299e002f91d17ea
+  data.tar.gz: 7d83de65e7fc052f52d129e73ae988359eacc34528e3f460f8483aa0793adb2d7be1e6cfe47785ec119fd2d0dae29d425300dd6dc5c898d33fbc808cc9ec1732

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yext-api (0.1.5)
+    yext-api (0.1.7)
       memoist (~> 0)
       rails (> 4)
       spyke (~> 5)

data/README.md

@@ -91,6 +91,35 @@ The global configurations can be initialized with ENV values.  The following con
   Wether or not to use the Sandbox API endpoint or the API endpoint.  This option cannot be set on a
   per-call basis.  This option is ignored for all objects under the `LiveApi` namespace.
 
+### Events
+
+Webhooks are implimented as ActiveSupport::Notifications.
+
+You can hook into notifications in multiple ways:
+
+```ruby
+# with a class:
+class AddRequestChanged
+  def call(name, started, finished, unique_id, data)
+    params_hash = { name: name, started: started, finished: finished, unique_id: unique_id, data: data }
+    Rails.logger.error "add_request_changed called: #{params_hash}"
+  end
+end
+
+ActiveSupport::Notifications.subscribe "add_request.changed.yext", AddRequestChanged.new
+
+# with a block:
+ActiveSupport::Notifications.subscribe "add_request.changed.yext" do |name, started, finished, unique_id, data|
+end
+```
+
+The following notifications will be
+instrumented with the indicated parameters:
+
+* add_request.changed.yext
+    * **meta** - The meta information for the webhook
+    * **add_request** - A Yext::Api::AdministrativeApi::AddRequest object of the changed AddRequest.
+
 ### General Usage
 
 The API namespaces are setup to mimic the structure of the Yext API documentation to make it easier
@@ -141,6 +170,7 @@ The following classes are planned based on that structure:
 * KnowledgeApi::AccountSettings::User
 * KnowledgeApi::AccountSettings::Account
 * KnowledgeApi::OptimizationTasks::OptimizationTask
+* KnowledgeApi::OptimizationTasks::OptimizationLink
 * LiveApi::Menu
 * LiveApi::Bio
 * LiveApi::Product
@@ -162,12 +192,18 @@ end
 
 #### Fetching a single object
 
-Use `find`
+Use `find` if you want to raise an exception if it cannot be found
 
 ```ruby
 account = Yext::Api::AdministrativeApi::Account.find("my-id")
 ```
 
+Use `where(id: id).get` if you do not want an exception to be raised:
+
+```ruby
+account = Yext::Api::AdministrativeApi::Account.where(id: "my-id").get
+```
+
 #### Overriding configuration options
 
 ```ruby

data/app/controllers/yext/api/agreements/add_request_controller.rb

@@ -19,59 +19,44 @@ module Yext
         extend Memoist
 
         def create
-          process_add_request_changed
+          add_request = Yext::Api::AdministrativeApi::AddRequest.new(add_request_hash[:addRequest])
+
+          ActiveSupport::Notifications.instrument "add_request.changed.yext",
+                                                  meta:        add_request_hash[:meta],
+                                                  add_request: add_request do
+            # do your custom stuff here
+          end
 
           head :ok
         end
 
         private
 
-        def process_add_request_changed
-          processor = Yext::Api.configuration.get_callback_processor(:add_request_changed)
-
-          return if processor.blank?
-
-          processor.new(processor_args[:meta],
-                        Yext::Api::AdministrativeApi::AddRequest.new(processor_args[:addRequest]),
-                        nil).
-              add_request_changed
-        end
-
-        def processor_args
-          params_hash.convert_epoch :meta, :timestamp
-          params_hash.convert_time :addRequest, :dateSubmitted
-          params_hash.convert_time :addRequest, :dateCompleted
-
-          params_hash.params
-        end
-
         # rubocop:disable MethodLength
 
-        def params_hash
-          Yext::Api::Utils::Params.
-              new(params.
-                  permit(meta:       %i[eventType uuid timestamp accountId actor appSpecificAccountId],
-                         addRequest: [:id,
-                                      :locationMode,
-                                      :existingLocationId,
-                                      :newLocationId,
-                                      :newLocationAccountId,
-                                      :newAccountParentAccountId,
-                                      :newLocationData,
-                                      { skus: [] },
-                                      :agreementId,
-                                      :status,
-                                      :dateSubmitted,
-                                      :dateCompleted,
-                                      :statusDetail]).
-                  to_hash.
-                  with_indifferent_access)
+        def add_request_hash
+          params.
+              permit(meta:       %i[eventType uuid timestamp accountId actor appSpecificAccountId],
+                     addRequest: [:id,
+                                  :locationMode,
+                                  :existingLocationId,
+                                  :newLocationId,
+                                  :newLocationAccountId,
+                                  :newAccountParentAccountId,
+                                  :newLocationData,
+                                  { skus: [] },
+                                  :agreementId,
+                                  :status,
+                                  :dateSubmitted,
+                                  :dateCompleted,
+                                  :statusDetail]).
+              to_hash.
+              with_indifferent_access
         end
 
         # rubocop:enable MethodLength
 
-        memoize :processor_args,
-                :params_hash
+        memoize :add_request_hash
       end
     end
   end

data/lib/yext/api/administrative_api/account.rb

@@ -30,8 +30,6 @@ module Yext
       class Account < Yext::Api::Utils::ApiBase
         include Yext::Api::Concerns::AccountRelations
 
-        after_save :save_account_id
-
         # The save action only allows the saving of the account_id and the accountName
         #
         # Furthermore, the account_id cannot be changed by the partner, but only by the customer
@@ -48,24 +46,6 @@ module Yext
 
           save_account_id
         end
-
-        # rubocop:disable Naming/MethodName
-
-        # Yext field names don't match the Ruby naming standard, this is the field name they use.
-        # Because I use `account_id` in the route, I need that attribute defined.  Because
-        # Yext uses accountId, when it is set, I need to set `account_id` so they will match.
-        def accountId=(value)
-          super
-          attributes[:account_id] ||= value
-        end
-
-        # rubocop:enable Naming/MethodName
-
-        private
-
-        def save_account_id
-          attributes[:account_id] = accountId
-        end
       end
     end
   end

data/lib/yext/api/administrative_api/add_request.rb

@@ -47,6 +47,19 @@ module Yext
 
         include Yext::Api::Concerns::AccountChild
 
+        # rubocop:disable Naming/MethodName
+
+        # helper function to extract the affected location ID based on the locationMode
+        def locationId
+          if locationMode == Yext::Api::Enumerations::AddRequestLocationMode::NEW
+            newLocationId
+          else
+            existingLocationId
+          end
+        end
+
+        # rubocop:enable Naming/MethodName
+
         # This is a helper method to try to simplify changing the status of an AddRequest if you
         # don't have an AddRequest object.
         #
@@ -89,6 +102,8 @@ module Yext
               post
         end)
 
+        # After successfully creating a new add request, the object attributes will be updated/
+        # changed to the values of the created add request.
         def save
           if persisted?
             change_status
@@ -104,6 +119,12 @@ module Yext
               with(Yext::Api::Concerns::AccountChild.with_account_path("newlocationaddrequests")).
               where(attributes.reverse_merge(account_id: Yext::Api.configuration.param_account_id)).
               post
+
+          if Yext::Api::AdministrativeApi.last_status.between?(200, 299)
+            self.attributes = Yext::Api::AdministrativeApi.last_data.dup
+          else
+            self
+          end
         end
 
         def change_status

data/lib/yext/api/concerns/account_child.rb

@@ -29,6 +29,7 @@ module Yext
               next if account_class.association?(klass)
 
               klass_uri = klass.instance_variable_get(:@uri)
+
               klass_uri ||= klass.send(:default_uri)
               helper_warnings(account_class, klass, klass_uri)
 
@@ -79,6 +80,8 @@ module Yext
           end)
 
           Yext::Api::Concerns::AccountChild.ensure_relation(self)
+
+          after_save :save_account_id
         end
 
         class_methods do
@@ -110,11 +113,31 @@ module Yext
 
             args[:account_id] ||= Yext::Api.configuration.param_account_id
 
+            # account_scope means that the scope will be applied to an Account rather than a
+            # relation off of an Account.
             args[:id] = args.delete(:account_id) if account_scope
 
             args
           end
         end
+
+        # rubocop:disable Naming/MethodName
+
+        # Yext field names don't match the Ruby naming standard, this is the field name they use.
+        # Because I use `account_id` in the route, I need that attribute defined.  Because
+        # Yext uses accountId, when it is set, I need to set `account_id` so they will match.
+        def accountId=(value)
+          super
+          attributes[:account_id] = value
+        end
+
+        # rubocop:enable Naming/MethodName
+
+        private
+
+        def save_account_id
+          attributes[:account_id] = attributes[:accountId] if attributes.key?(:accountId)
+        end
       end
     end
   end

data/lib/yext/api/concerns/account_relations.rb

@@ -36,6 +36,26 @@ module Yext
 
           # LiveApi
           has_many :live_locations, class_name: "Yext::Api::LiveApi::Location"
+
+          after_save :save_account_id
+        end
+
+        # rubocop:disable Naming/MethodName
+
+        # Yext field names don't match the Ruby naming standard, this is the field name they use.
+        # Because I use `account_id` in the route, I need that attribute defined.  Because
+        # Yext uses accountId, when it is set, I need to set `account_id` so they will match.
+        def accountId=(value)
+          super
+          attributes[:account_id] ||= value
+        end
+
+        # rubocop:enable Naming/MethodName
+
+        private
+
+        def save_account_id
+          attributes[:account_id] = accountId
         end
 
         class_methods do

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Enumerations
+      # The type of the location in an AddRequest
+      class AddRequestLocationMode
+        include Yext::Api::Concerns::EnumAll
+
+        EXISTING = "EXISTING"
+        NEW      = "NEW"
+      end
+    end
+  end
+end

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

@@ -3,6 +3,7 @@
 module Yext
   module Api
     module Enumerations
+      # The possible modes to search for when looking up Optimization Links
       class OptimizationLinkMode
         include Yext::Api::Concerns::EnumAll
 

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

@@ -46,6 +46,30 @@ module Yext
         class Location < Yext::Api::Utils::ApiBase
           include Yext::Api::Concerns::AccountChild
 
+          scope(:search, lambda do |*filters|
+            args           = scope_args true
+            args[:filters] = Array.wrap(filters).to_json
+
+            Yext::Api::AdministrativeApi::Account.
+                where(args).
+                with(:locationsearch).
+                get
+          end)
+
+          def save(*fields_to_update)
+            return super if fields_to_update.blank?
+
+            # To save only certain fields, slice those fields into a new Location so that everything
+            # is sent (which is only the fields we want)
+            location = Yext::Api::KnowledgeApi::KnowledgeManager::Location.
+                new(attributes.with_indifferent_access.slice(*fields_to_update))
+
+            location.id        = id
+            location.accountId = accountId
+
+            location.save
+          end
+
           # 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 }

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

@@ -55,23 +55,6 @@ 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
 
@@ -100,80 +83,8 @@ module Yext
           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?
 

data/lib/yext/api/version.rb

@@ -2,6 +2,6 @@
 
 module Yext
   module Api
-    VERSION = "0.1.5"
+    VERSION = "0.1.7"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yext-api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - CardTapp
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2018-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memoist
@@ -260,6 +260,7 @@ files:
 - lib/yext/api/concerns/faraday_connection.rb
 - lib/yext/api/concerns/rate_limits.rb
 - lib/yext/api/engine.rb
+- lib/yext/api/enumerations/add_request_location_mode.rb
 - lib/yext/api/enumerations/add_request_status.rb
 - lib/yext/api/enumerations/error_codes.rb
 - lib/yext/api/enumerations/error_codes/agreements_errors.rb
@@ -298,7 +299,6 @@ files:
 - lib/yext/api/utils/middleware/default_parameters.rb
 - lib/yext/api/utils/middleware/response_parser.rb
 - lib/yext/api/utils/middleware/uri_cleanup.rb
-- lib/yext/api/utils/params.rb
 - lib/yext/api/validators/account_validator.rb
 - lib/yext/api/version.rb
 - lib/yext/include_rails.rb

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

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module Yext
-  module Api
-    module Utils
-      # A utility class for performing normal modifications to webhooks to convert/normalize data
-      # before passing it along so that the receiver doesn't have to worry/thnk about it.
-      class Params
-        attr_reader :params
-
-        def initialize(params)
-          @params = params
-        end
-
-        # Converts an integer epoch date value into a Time.
-        #
-        # The param_names is a list of nodes which ends with a leaf node that is the epoch value
-        # to be converted to a Time.
-        #
-        # If any node along the way cannot be found, the function exits without errors or changing any values.
-        def convert_epoch(*param_names)
-          return unless param_names.present?
-
-          param_name  = param_names[-1]
-          param_level = find_value(*param_names)
-
-          return unless param_level.present?
-
-          param_level[param_name] = Time.at(param_level[param_name].to_i / 1_000.0)
-        end
-
-        # Converts time string into a Time.
-        #
-        # The param_names is a list of nodes which ends with a leaf node that is the time string
-        # to be converted to a Time.
-        #
-        # If any node along the way cannot be found, the function exits without errors or changing any values.
-        def convert_time(*param_names)
-          return unless param_names.present?
-
-          param_name  = param_names[-1]
-          param_level = find_value(*param_names)
-
-          return unless param_level.present?
-
-          param_level[param_name] = param_level[param_name].to_time(:utc)
-        end
-
-        private
-
-        def find_value(*param_names)
-          param_level = params
-          found_param = param_names[0..-2].each do |param_name|
-            break unless param_level.key?(param_name)
-
-            param_level = param_level[param_name]
-          end
-
-          return if found_param.nil?
-
-          param_name = param_names[-1]
-          return unless param_level.key?(param_name) && param_level[param_name].present?
-
-          param_level
-        end
-      end
-    end
-  end
-end