yext-api 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d1170885002e5072f44f0f873aa18f25e3d6419
-  data.tar.gz: 3b4ba378a817f1a787585bbd5b1457c76aa04b50
+  metadata.gz: b00aa1601c943ccd86176b00dbd9d0dc2cfe62ba
+  data.tar.gz: 3dc9545705404a5c812be0d70e77d57f6f61e8e2
 SHA512:
-  metadata.gz: ef7ae532a5fe16b3d5857404da8ef200377aadaffb5c7394228c02761186d3ee9ef7d72e2bfc04c288723a142059c10492333f762e5d2480f6b16a8962b4005b
-  data.tar.gz: a8002cc64bd89449bb34ad92a1a8e7820a34179e8683fcaa1ff12f6474c7e49750d098ade37ea2d8edd0369eb202a6202a7f8a9d1c59a49ca14936615fc6dc82
+  metadata.gz: 55c0f57e48913eddf4ae516022b76ecc9a44ff5b257280b1aa56d4c28e66df12f8023128ea8d2de1443a07e6713b5a43a0ab16e6ab0bbc7157ee6ad6cf9331bf
+  data.tar.gz: 01d6deaaaaedac4668c22ad2808c1d39fa7ad5e6f6bc7478c144b34e0726811229f0b84b8cbc83c4628eafbdb6f1e2795882c3c9e2b7f8bcf9a2717722ac7411

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    yext-api (0.1.4)
+    yext-api (0.1.5)
       memoist (~> 0)
       rails (> 4)
       spyke (~> 5)
+      valid (~> 1)
 
 GEM
   remote: https://rubygems.org/
@@ -164,6 +165,7 @@ GEM
     tzinfo (1.2.4)
       thread_safe (~> 0.1)
     url (0.3.2)
+    valid (1.2.0)
     vcr (4.0.0)
     webmock (3.2.1)
       addressable (>= 2.3.6)

data/config/initializers/valid.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "validation"
+require "validation/rule/not_empty"

data/lib/config/api.yml

@@ -793,6 +793,8 @@
             :default_version: 20161012
             :documentation: http://developer.yext.com/docs/api-reference/#operation/getOptimizationTasks
             :sandbox_only: false
+      :optimization_link:
+        :actions:
           - :action: :show
             :method: :get
             :endpoint: https://api.yext.com/v2/accounts/{accountId}/optimizationlink

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

@@ -37,7 +37,7 @@ module Yext
         # Furthermore, the account_id cannot be changed by the partner, but only by the customer
         # themselves.
         def save
-          return unless accountId?
+          return unless Yext::Api::Validators::AccountValidator.new(self).valid?
 
           updates             = { account_id: account_id, accountName: accountName }
           updates[:accountId] = accountId if accountId != account_id

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

@@ -29,8 +29,8 @@ module Yext
               next if account_class.association?(klass)
 
               klass_uri = klass.instance_variable_get(:@uri)
-              helper_warnings(account_class, klass, klass_uri)
               klass_uri ||= klass.send(:default_uri)
+              helper_warnings(account_class, klass, klass_uri)
 
               add_has_many_relation(account_class, klass, klass_uri)
             end

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

@@ -26,6 +26,14 @@ module Yext
           has_many :users, class_name: "Yext::Api::KnowledgeApi::AccountSettings::User"
           has_many :roles, class_name: "Yext::Api::KnowledgeApi::AccountSettings::Role"
 
+          # KnowledgeApi::OptimizationTasks
+          has_many :optimization_tasks,
+                   class_name: "Yext::Api::KnowledgeApi::OptimizationTasks::OptimizationTask",
+                   uri:        Yext::Api::Concerns::AccountChild.with_account_path("optimizationtasks/(:id)")
+          has_many :optimization_links,
+                   class_name: "Yext::Api::KnowledgeApi::OptimizationTasks::OptimizationLink",
+                   uri:        Yext::Api::Concerns::AccountChild.with_account_path("optimizationlink")
+
           # LiveApi
           has_many :live_locations, class_name: "Yext::Api::LiveApi::Location"
         end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Enumerations
+      class OptimizationLinkMode
+        include Yext::Api::Concerns::EnumAll
+
+        PENDING_ONLY = "PENDING_ONLY"
+        ALL_TASKS    = "ALL_TASKS"
+        RESET        = "RESET"
+      end
+    end
+  end
+end

data/lib/yext/api/knowledge_api/optimization_tasks/optimization_link.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module KnowledgeApi
+      module OptimizationTasks
+        # :knowledge_api:
+        #   :knowledge_manager:
+        #     :optimization_link:
+        #       - :action: :show
+        #         :method: :get
+        #         :endpoint: https://api.yext.com/v2/accounts/{accountId}/optimizationlink
+        #         :path_regex: v2/accounts/[^/]+?/optimizationlink
+        #         :default_version: 20161012
+        #         :documentation: http://developer.yext.com/docs/api-reference/#operation/getLinkOptimizationTask
+        #         :sandbox_only: false
+        class OptimizationLink < Yext::Api::Utils::ApiBase
+          uri "optimizationlink"
+
+          include Yext::Api::Concerns::AccountChild
+
+          scope :location, ->(location_id) { where(locationId: location_id) }
+
+          scope :task, ->(task_id) { tasks(task_id) }
+          scope :tasks, ->(*task_id_array) { where(taskIds: Array.wrap(task_id_array).join(",")) }
+
+          scope :mode, ->(mode) { where(mode: mode) }
+        end
+      end
+    end
+  end
+end

data/lib/yext/api/knowledge_api/optimization_tasks/optimization_task.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module KnowledgeApi
+      module OptimizationTasks
+        # :knowledge_api:
+        #   :knowledge_manager:
+        #     :optimization_task:
+        #       - :action: :index
+        #         :method: :get
+        #         :endpoint: https://api.yext.com/v2/accounts/{accountId}/optimizationtasks
+        #         :path_regex: v2/accounts/[^/]+?/optimizationtasks
+        #         :default_version: 20161012
+        #         :documentation: http://developer.yext.com/docs/api-reference/#operation/getOptimizationTasks
+        #         :sandbox_only: false
+        class OptimizationTask < Yext::Api::Utils::ApiBase
+          uri default_uri.delete("_")
+
+          include Yext::Api::Concerns::AccountChild
+
+          scope :location, ->(location_id) { locations(location_id) }
+          scope :locations, ->(*location_id_array) { where(locationIds: Array.wrap(location_id_array).join(",")) }
+
+          scope :task, ->(task_id) { tasks(task_id) }
+          scope :tasks, ->(*task_id_array) { where(taskIds: Array.wrap(task_id_array).join(",")) }
+        end
+      end
+    end
+  end
+end

data/lib/yext/api/validators/account_validator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Validators
+      # A Validator for account updates to verify that the update is valid.
+      class AccountValidator < Validation::Validator
+        include Validation
+
+        def initialize(obj)
+          # Ensure that the accountId field exists by cloning the Account and setting it.
+          obj           = Yext::Api::AdministrativeApi::Account.new(obj.attributes)
+          obj.accountId = obj[:accountId]
+
+          super(obj)
+        end
+
+        rule :accountId, :not_empty
+      end
+    end
+  end
+end

data/lib/yext/api/version.rb

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

data/yext-api.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "memoist", "~> 0"
   spec.add_dependency "rails", "> 4"
   spec.add_dependency "spyke", "~> 5"
+  spec.add_dependency "valid", "~> 1"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "codecov"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yext-api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - CardTapp
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2018-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memoist
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: valid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -231,6 +245,7 @@ files:
 - bin/setup
 - config/initializers/memoist.rb
 - config/initializers/spyke.rb
+- config/initializers/valid.rb
 - config/routes.rb
 - lib/config/api.yml
 - lib/yext/api.rb
@@ -263,6 +278,7 @@ files:
 - lib/yext/api/enumerations/error_codes/suppression_errors.rb
 - lib/yext/api/enumerations/error_codes/users_errors.rb
 - lib/yext/api/enumerations/location_type.rb
+- lib/yext/api/enumerations/optimization_link_mode.rb
 - lib/yext/api/enumerations/validation.rb
 - lib/yext/api/knowledge_api.rb
 - lib/yext/api/knowledge_api/account_settings/account.rb
@@ -271,6 +287,8 @@ files:
 - lib/yext/api/knowledge_api/health_check/health.rb
 - lib/yext/api/knowledge_api/knowledge_manager/category.rb
 - 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/live_api.rb
 - lib/yext/api/live_api/location.rb
 - lib/yext/api/utils/api_base.rb
@@ -281,6 +299,7 @@ files:
 - 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
 - yext-api.gemspec