yext-api 0.1.5 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b00aa1601c943ccd86176b00dbd9d0dc2cfe62ba
-  data.tar.gz: 3dc9545705404a5c812be0d70e77d57f6f61e8e2
+SHA256:
+  metadata.gz: 79f491a325f8a7fe9babafb710683b254203480cf0079778fb4bc95f27f782f1
+  data.tar.gz: 2895fbcf074a7426a08fd774493fe99c629e66752b6a1ae24cccc471761d6007
 SHA512:
-  metadata.gz: 55c0f57e48913eddf4ae516022b76ecc9a44ff5b257280b1aa56d4c28e66df12f8023128ea8d2de1443a07e6713b5a43a0ab16e6ab0bbc7157ee6ad6cf9331bf
-  data.tar.gz: 01d6deaaaaedac4668c22ad2808c1d39fa7ad5e6f6bc7478c144b34e0726811229f0b84b8cbc83c4628eafbdb6f1e2795882c3c9e2b7f8bcf9a2717722ac7411
+  metadata.gz: 865eca22ad249420077c5e765a8aae0547b8940db876c78b81a20b37c006da8564332bf1906143ac50d4d913eed4845308165f407bd1e4121122b2ef9bdb9871
+  data.tar.gz: 9eea3c5b24427bca7eebb971e4f3acb117db6a7d2b81f16a9e2dc7b0e49563aea99f13e76d065b34253b401865bd687481169e4e296fe338220dedaf6b5cad7c

data/.circleci/config.yml

@@ -0,0 +1,53 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.6.3-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem install bundler
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - save_cache:
+          paths:
+            - ./venv
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.6.3

data/Gemfile

@@ -7,6 +7,4 @@ git_source(:github) { |_repo_name| "https://github.com/CardTapp/yext-api" }
 # Specify your gem's dependencies in yext-api.gemspec
 gemspec
 
-gem "codecov"
 gem "gem-release"
-gem "simplecov"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yext-api (0.1.5)
+    yext-api (0.1.11)
       memoist (~> 0)
       rails (> 4)
       spyke (~> 5)
@@ -10,46 +10,50 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.1.4)
-      actionpack (= 5.1.4)
+    actioncable (5.2.0)
+      actionpack (= 5.2.0)
       nio4r (~> 2.0)
-      websocket-driver (~> 0.6.1)
-    actionmailer (5.1.4)
-      actionpack (= 5.1.4)
-      actionview (= 5.1.4)
-      activejob (= 5.1.4)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.0)
+      actionpack (= 5.2.0)
+      actionview (= 5.2.0)
+      activejob (= 5.2.0)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.1.4)
-      actionview (= 5.1.4)
-      activesupport (= 5.1.4)
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.4)
-      activesupport (= 5.1.4)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.1.4)
-      activesupport (= 5.1.4)
+    activejob (5.2.0)
+      activesupport (= 5.2.0)
       globalid (>= 0.3.6)
-    activemodel (5.1.4)
-      activesupport (= 5.1.4)
-    activerecord (5.1.4)
-      activemodel (= 5.1.4)
-      activesupport (= 5.1.4)
-      arel (~> 8.0)
-    activesupport (5.1.4)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activestorage (5.2.0)
+      actionpack (= 5.2.0)
+      activerecord (= 5.2.0)
+      marcel (~> 0.3.1)
+    activesupport (5.2.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
-    arel (8.0.0)
+    arel (9.0.0)
     builder (3.2.3)
     codecov (0.1.10)
       json
@@ -60,64 +64,70 @@ GEM
       activesupport
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    crass (1.0.3)
+    crass (1.0.4)
     diff-lcs (1.3)
     docile (1.1.5)
-    erubi (1.7.0)
-    faraday (0.14.0)
+    erubi (1.7.1)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.12.2)
-      faraday (>= 0.7.4, < 1.0)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
     gem-release (1.0.0)
-    globalid (0.4.1)
+    globalid (0.4.2)
       activesupport (>= 4.2.0)
     hashdiff (0.3.7)
     hashie (3.5.7)
-    i18n (0.9.1)
+    i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
-    loofah (2.1.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mail (2.7.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
       mini_mime (>= 0.1.1)
-    memoist (0.16.0)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    memoist (0.16.2)
     method_source (0.9.0)
-    mini_mime (1.0.0)
-    mini_portile2 (2.3.0)
-    minitest (5.11.1)
-    multipart-post (2.0.0)
-    nio4r (2.2.0)
-    nokogiri (1.8.1)
-      mini_portile2 (~> 2.3.0)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    multipart-post (2.1.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.8)
+      mini_portile2 (~> 2.4.0)
     public_suffix (3.0.1)
-    rack (2.0.3)
-    rack-test (0.8.2)
+    rack (2.0.8)
+    rack-test (1.0.0)
       rack (>= 1.0, < 3)
-    rails (5.1.4)
-      actioncable (= 5.1.4)
-      actionmailer (= 5.1.4)
-      actionpack (= 5.1.4)
-      actionview (= 5.1.4)
-      activejob (= 5.1.4)
-      activemodel (= 5.1.4)
-      activerecord (= 5.1.4)
-      activesupport (= 5.1.4)
+    rails (5.2.0)
+      actioncable (= 5.2.0)
+      actionmailer (= 5.2.0)
+      actionpack (= 5.2.0)
+      actionview (= 5.2.0)
+      activejob (= 5.2.0)
+      activemodel (= 5.2.0)
+      activerecord (= 5.2.0)
+      activestorage (= 5.2.0)
+      activesupport (= 5.2.0)
       bundler (>= 1.3.0)
-      railties (= 5.1.4)
+      railties (= 5.2.0)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (5.1.4)
-      actionpack (= 5.1.4)
-      activesupport (= 5.1.4)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0)
+      actionpack (= 5.2.0)
+      activesupport (= 5.2.0)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.4.2)
+    rake (13.0.1)
     rspec (3.6.0)
       rspec-core (~> 3.6.0)
       rspec-expectations (~> 3.6.0)
@@ -139,6 +149,8 @@ GEM
       rspec-mocks (~> 3.6.0)
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     safe_yaml (1.0.4)
     simplecov (0.15.1)
       docile (~> 1.1.0)
@@ -147,22 +159,22 @@ GEM
     simplecov-html (0.10.2)
     simplecov-rcov (0.2.3)
       simplecov (>= 0.4.1)
-    sprockets (3.7.1)
+    sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.1)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    spyke (5.3.0)
-      activemodel (>= 4.0.0, < 6.0)
-      activesupport (>= 4.0.0, < 6.0)
+    spyke (5.3.4)
+      activemodel (>= 4.0.0)
+      activesupport (>= 4.0.0)
       addressable (>= 2.5.2)
       faraday (>= 0.9.0, < 2.0)
       faraday_middleware (>= 0.9.1, < 2.0)
     thor (0.20.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.4)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
     url (0.3.2)
     valid (1.2.0)
@@ -171,9 +183,9 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
-    websocket-driver (0.6.5)
+    websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
+    websocket-extensions (0.1.4)
 
 PLATFORMS
   ruby
@@ -184,9 +196,10 @@ DEPENDENCIES
   cornucopia
   gem-release
   hashie
-  rake (~> 10)
+  rake (~> 13)
   rspec
   rspec-rails
+  rspec_junit_formatter (~> 0.4.1)
   simplecov
   simplecov-rcov
   vcr
@@ -194,4 +207,4 @@ DEPENDENCIES
   yext-api!
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/README.md

@@ -91,6 +91,39 @@ 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 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.knowledge_manager.yext", AddRequestChanged
+
+# with a block:
+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.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
@@ -141,6 +174,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 +196,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

@@ -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:
@@ -19,59 +22,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.knowledge_manager.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