yext-api 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f99917453bea7720f49022c02cf64fd132944d33
-  data.tar.gz: 89289aa7c0dbcf44ac8d10864ee995c71f0a3d24
+  metadata.gz: 231f74310029474a04fbd38792855a4fe2062ab6
+  data.tar.gz: 011a274982d38ae9da9014915f97ddf11c617650
 SHA512:
-  metadata.gz: c43378a81d8ef44bfafdab12deb9fcc05c632dbac4ff9b29d1abb9d0d1f50b5d1aceb7b90975268001b99ca3cbac15fec08177ee1a7fbdc1f299e002f91d17ea
-  data.tar.gz: 7d83de65e7fc052f52d129e73ae988359eacc34528e3f460f8483aa0793adb2d7be1e6cfe47785ec119fd2d0dae29d425300dd6dc5c898d33fbc808cc9ec1732
+  metadata.gz: 278829385446794d3fe4d9d59b34c9a21389996634c7e23629e5401a6f28cfb9bbef96d0d18c19b8e71454916b54c5134f85950eb95d9c8c4e6f2d7c48045dd1
+  data.tar.gz: 80a0f5606e80f15db7d90b89e0214cf482c340e0f3aa712f542f346705eb9e525fa8fe6070f25de4d6ccc7b1eeb23d395eb979a32e27d06b7dbf6d27cc451e71

data/Gemfile.lock

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

data/README.md

@@ -100,26 +100,30 @@ You can hook into notifications in multiple ways:
 ```ruby
 # with a class:
 class AddRequestChanged
-  def call(name, started, finished, unique_id, data)
+  def self.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
+ActiveSupport::Notifications.subscribe "add_request.knowledge_manager.yext", AddRequestChanged
 
 # with a block:
-ActiveSupport::Notifications.subscribe "add_request.changed.yext" do |name, started, finished, unique_id, data|
+ActiveSupport::Notifications.subscribe "add_request.knowledge_manager.yext" do |name, started, finished, unique_id, data|
 end
 ```
 
 The following notifications will be
 instrumented with the indicated parameters:
 
-* add_request.changed.yext
+* add_request.knowledge_manager.yext
     * **meta** - The meta information for the webhook
     * **add_request** - A Yext::Api::AdministrativeApi::AddRequest object of the changed AddRequest.
 
+* listing.powerlistings.yext
+    * **meta** - The meta information for the webhook
+    * **listing** - A Yext::Api::KnowledgeApi::Powerlistings::Listing object of the changed Listing.
+
 ### General Usage
 
 The API namespaces are setup to mimic the structure of the Yext API documentation to make it easier

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

@@ -5,8 +5,11 @@ module Yext
     module Agreements
       # This controller processes Yext add_request webhook callbacks.
       #
-      # The controller will call the add_request_changed function on the configured class
-      # for the add_request_changed function.
+      # The controller will instrument the "add_request.knowledge_manager.yext" ActiveSupport Notification.
+      # The params hash will include:
+      #   * meta        - the `meta` value of the webhook.
+      #   * add_request - a Yext::Api::AdministrativeApi::AddRequest object that is the AddRequest
+      #                   being reported on.
 
       # :webhooks:
       #   :agreements:
@@ -21,7 +24,7 @@ module Yext
         def create
           add_request = Yext::Api::AdministrativeApi::AddRequest.new(add_request_hash[:addRequest])
 
-          ActiveSupport::Notifications.instrument "add_request.changed.yext",
+          ActiveSupport::Notifications.instrument "add_request.knowledge_manager.yext",
                                                   meta:        add_request_hash[:meta],
                                                   add_request: add_request do
             # do your custom stuff here

data/app/controllers/yext/api/powerlistings/listing_controller.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Powerlistings
+      # This controller processes Yext listing webhook callbacks.
+      #
+      # The controller will instrument the "listing.powerlistings.yext" ActiveSupport Notification.
+      # The params hash will include:
+      #   * meta    - the `meta` value of the webhook.
+      #   * listing - a Yext::Api::KnowledgeApi::Powerlistings::Listing object that is the Listing
+      #               being reported on.
+
+      # :webhooks:
+      #   :listing:
+      #     :endpoint: https://[your_hostname]/[your_listings_webhook_path]
+      #     :default_version: 20161012
+      #     :documentation: http://developer.yext.com/docs/webhooks/#operation/listingsWebhook
+      #     :sandbox_only: false
+      class ListingController < Yext::Api::ApplicationController
+        extend Memoist
+
+        def create
+          listing = Yext::Api::KnowledgeApi::Powerlistings::Listing.new(listing_hash[:listing])
+
+          ActiveSupport::Notifications.instrument "listing.powerlistings.yext",
+                                                  meta:    listing_hash[:meta],
+                                                  listing: listing do
+            # do your custom stuff here
+          end
+
+          head :ok
+        end
+
+        private
+
+        # rubocop:disable MethodLength
+
+        def listing_hash
+          params.
+              permit(meta:    %i[eventType uuid timestamp accountId actor appSpecificAccountId],
+                     listing: [:id,
+                               :locationId,
+                               :publisherId,
+                               :status,
+                               :additionalStatus,
+                               :listingUrl,
+                               :loginUrl,
+                               :screenshotUrl,
+                               { statusDetails: %i[code message type] },
+                               { alternateBrands: %i[brandName listingUrl] }]).
+              to_hash.
+              with_indifferent_access
+        end
+
+        # rubocop:enable MethodLength
+
+        memoize :listing_hash
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -4,4 +4,8 @@ Yext::Api::Engine.routes.draw do
   scope :agreements, module: :agreements do
     resources :add_request, only: %i[create]
   end
+
+  scope :powerlistings, module: :powerlistings do
+    resources :listing, only: %i[create]
+  end
 end

data/lib/config/api.yml

@@ -420,7 +420,7 @@
             :documentation: http://developer.yext.com/docs/api-reference/#operation/deleteAsset
             :sandbox_only: false
   :power_listings:
-    :module_name: PowerListings
+    :module_name: Powerlistings
     :objects:
       :publishser:
         :actions:

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

@@ -34,6 +34,14 @@ module Yext
                    class_name: "Yext::Api::KnowledgeApi::OptimizationTasks::OptimizationLink",
                    uri:        Yext::Api::Concerns::AccountChild.with_account_path("optimizationlink")
 
+          # KnowledgeApi::Powerlistings
+          has_many :listings,
+                   class_name: "Yext::Api::KnowledgeApi::Powerlistings::Listing",
+                   uri:        Yext::Api::Concerns::AccountChild.with_account_path("powerlistings/listings/(:id)")
+          has_many :publishers,
+                   class_name: "Yext::Api::KnowledgeApi::Powerlistings::Publisher",
+                   uri:        Yext::Api::Concerns::AccountChild.with_account_path("powerlistings/publishers/(:id)")
+
           # LiveApi
           has_many :live_locations, class_name: "Yext::Api::LiveApi::Location"
 

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Enumerations
+      # An enumeration class to contain the possible status values for a listing.
+      class ListingStatus
+        include Yext::Api::Concerns::EnumAll
+
+        WAITING_ON_YEXT      = "WAITING_ON_YEXT"
+        WAITING_ON_CUSTOMER  = "WAITING_ON_CUSTOMER"
+        WAITING_ON_PUBLISHER = "WAITING_ON_PUBLISHER"
+        LIVE                 = "LIVE"
+        UNAVAILABLE          = "UNAVAILABLE"
+        OPTED_OUT            = "OPTED_OUT"
+      end
+    end
+  end
+end

data/lib/yext/api/knowledge_api/powerlistings/listing.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module KnowledgeApi
+      module Powerlistings
+        # :knowledge_api:
+        #   :powerlistings:
+        #     :listing:
+        #       - :action: :index
+        #         :method: :get
+        #         :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/listings
+        #         :path_regex: v2/accounts/[^/]+?/powerlistings/listings
+        #         :default_version: 20161012
+        #         :documentation: http://developer.yext.com/docs/api-reference/#operation/listListings
+        #         :sandbox_only: false
+        #       - :action: :opt_in
+        #         :method: :put
+        #         :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/listings/optin
+        #         :path_regex: v2/accounts/[^/]+?/powerlistings/listings/optin
+        #         :default_version: 20161012
+        #         :documentation: http://developer.yext.com/docs/api-reference/#operation/optInListings
+        #         :sandbox_only: false
+        #       - :action: :opt_out
+        #         :method: :put
+        #         :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/listings/optout
+        #         :path_regex: v2/accounts/[^/]+?/powerlistings/listings/optout
+        #         :default_version: 20161012
+        #         :documentation: http://developer.yext.com/docs/api-reference/#operation/optOutListings
+        #         :sandbox_only: false
+        class Listing < Yext::Api::Utils::ApiBase
+          uri "powerlistings/#{default_uri}"
+
+          include Yext::Api::Concerns::AccountChild
+
+          # rubocop:disable Style/Lambda
+
+          scope(:opt_in!, ->(location_ids: nil, publisher_ids: nil) do
+            params                = {}
+            params[:locationIds]  = Array.wrap(location_ids).join(",") if location_ids.present?
+            params[:publisherIds] = Array.wrap(publisher_ids).join(",") if publisher_ids.present?
+
+            where(params).with(:optin).put
+          end)
+
+          scope(:opt_out!, ->(location_ids: nil, publisher_ids: nil) do
+            params                = {}
+            params[:locationIds]  = Array.wrap(location_ids) if location_ids.present?
+            params[:publisherIds] = Array.wrap(publisher_ids) if publisher_ids.present?
+
+            where(params).with(:optout).put
+          end)
+
+          # rubocop:enable Style/Lambda
+        end
+      end
+    end
+  end
+end

data/lib/yext/api/knowledge_api/powerlistings/publisher.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module KnowledgeApi
+      module Powerlistings
+        # :knowledge_api:
+        #   :powerlistings:
+        #     :listing:
+        #       - :action: :index
+        #         :method: :get
+        #         :endpoint: https://api.yext.com/v2/accounts/{accountId}/powerlistings/publishers
+        #         :path_regex: v2/accounts/[^/]+?/powerlistings/publishers
+        #         :default_version: 20161012
+        #         :documentation: http://developer.yext.com/docs/api-reference/#operation/listPublishers
+        #         :sandbox_only: false
+        class Publisher < Yext::Api::Utils::ApiBase
+          uri "powerlistings/#{default_uri}"
+
+          include Yext::Api::Concerns::AccountChild
+        end
+      end
+    end
+  end
+end

data/lib/yext/api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yext-api
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - CardTapp
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memoist
@@ -240,6 +240,7 @@ files:
 - Rakefile
 - app/controllers/yext/api/agreements/add_request_controller.rb
 - app/controllers/yext/api/application_controller.rb
+- app/controllers/yext/api/powerlistings/listing_controller.rb
 - bin/console
 - bin/rails
 - bin/setup
@@ -278,6 +279,7 @@ files:
 - lib/yext/api/enumerations/error_codes/subscriptions_errors.rb
 - lib/yext/api/enumerations/error_codes/suppression_errors.rb
 - lib/yext/api/enumerations/error_codes/users_errors.rb
+- lib/yext/api/enumerations/listing_status.rb
 - lib/yext/api/enumerations/location_type.rb
 - lib/yext/api/enumerations/optimization_link_mode.rb
 - lib/yext/api/enumerations/validation.rb
@@ -290,6 +292,8 @@ files:
 - lib/yext/api/knowledge_api/knowledge_manager/location.rb
 - lib/yext/api/knowledge_api/optimization_tasks/optimization_link.rb
 - lib/yext/api/knowledge_api/optimization_tasks/optimization_task.rb
+- lib/yext/api/knowledge_api/powerlistings/listing.rb
+- lib/yext/api/knowledge_api/powerlistings/publisher.rb
 - lib/yext/api/live_api.rb
 - lib/yext/api/live_api/location.rb
 - lib/yext/api/utils/api_base.rb