yext-api 0.1.1 → 0.1.3

data/lib/yext/api/utils/middleware/api_rate_limits.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Utils
+      module Middleware
+        # Faraday Middleware for extracting API limits from call responses.
+        class ApiRateLimits < Faraday::Response::Middleware
+          def call(env)
+            @app.call(env).on_complete do |environment|
+              save_rates(environment, Yext::Api::Utils::ApiFinder.new(env[:url], env[:method]).find_api)
+
+              env.response
+            end
+          end
+
+          private
+
+          def save_rates(environment, api_module)
+            return if api_module.blank?
+
+            response_headers = environment[:response_headers]
+
+            return unless response_headers.key?("rate-limit-remaining")
+
+            api_module.send(:update_rates,
+                            remaining: response_headers["rate-limit-remaining"].to_i,
+                            limit:     response_headers["rate-limit-limit"].to_i,
+                            reset_at:  Time.at(response_headers["rate-limit-reset"].to_i))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yext/api/utils/middleware/default_parameters.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Utils
+      module Middleware
+        # Faraday Middleware for adding Configuration default values to API calls as needed.
+        #
+        # Most options can be set via scopes and the soped values will be kept if they are used.
+        # i.e. the existing query string values will be kept if they exist.
+        #
+        # Because Spyke puts `where` options into the body OR the query depending on the type of
+        # request being made, we have to move the Yext query options out of the body into the query
+        # if there is a body.
+        #
+        # The following configuration options are defaulted:
+        #   validation_level: Added to query parameters if not already there and is not nil
+        #   api_key:          Added to query parameters if not already there
+        #   api_version:      Added to qeury parameters if not already there
+        #   account_id:       Inserted into the path if the path includes the Account default URI and no
+        #                     account_id was specified.
+        #
+        # The following values will be moved out of the body into the query string if they are found:
+        #   account_id      * Not used if in body.  If set it will already be in the path.
+        #   v
+        #   api_key
+        #   validation
+        #   yext_username
+        #   yext_user_id
+        class DefaultParameters < Faraday::Response::Middleware
+          extend Memoist
+
+          attr_reader :configuration,
+                      :url,
+                      :params,
+                      :body_json,
+                      :request_env
+
+          def call(call_env)
+            get_attribute_values(call_env)
+
+            body_json.delete(:account_id)
+            add_username_headers
+            add_default_query_params
+            save_query_params
+            save_body
+
+            @app.call(request_env)
+          end
+
+          private
+
+          def get_attribute_values(call_env)
+            @request_env   = call_env
+            @configuration = Yext::Api.configuration
+            @url           = request_env[:url]
+            @params        = Rack::Utils.parse_nested_query(url.query).with_indifferent_access
+            @body_json     = parse_body
+          end
+
+          def parse_body
+            if request_env.body.present?
+              JSON.parse(request_env.body, symbolize_names: true)
+            else
+              {}
+            end
+          end
+
+          def add_default_query_params
+            params.reverse_merge!(api_key: api_key, v: version)
+
+            params[:validation] ||= validation if validation.present?
+          end
+
+          def validation
+            return body_json.delete(:validation) if body_json.key?(:validation)
+
+            configuration.validation_level if configuration.validation_level.present?
+          end
+
+          def version
+            body_json.delete(:v) || configuration.api_version || "20161012"
+          end
+
+          def api_key
+            body_json.delete(:api_key) || configuration.api_key
+          end
+
+          def save_query_params
+            url.query = params.to_query
+          end
+
+          def save_body
+            extract_rooted_body
+
+            return if request_env.body.blank?
+
+            body_json[:id] = body_json.delete(:create_id) if body_json.key?(:create_id)
+
+            request_env.body = body_json.to_json
+          end
+
+          def extract_rooted_body
+            return unless body_json.keys.length == 1
+
+            sub_json   = body_json[body_json.keys.first]
+            @body_json = sub_json if sub_json.is_a?(Hash)
+          end
+
+          def add_username_headers
+            user_id, username = extract_header_values
+
+            return unless %w[put post patch delete].include?(request_env[:method].to_s)
+
+            request_headers                  = request_env[:request_headers]
+            request_headers["Yext-Username"] = username if username.present?
+            request_headers["Yext-User-Id"]  = user_id if user_id.present?
+          end
+
+          def extract_header_values
+            username = extract_defaulted_value(:yext_username, configuration.yext_username)
+            user_id  = extract_defaulted_value(:yext_user_id, configuration.yext_user_id)
+
+            [user_id, username]
+          end
+
+          def extract_defaulted_value(param_name, default_value)
+            params.delete(param_name) || body_json.delete(param_name) || default_value
+          end
+
+          memoize :validation,
+                  :version,
+                  :api_key
+        end
+      end
+    end
+  end
+end

data/lib/yext/api/utils/middleware/response_parser.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Utils
+      module Middleware
+        # The default response parser for Faraday to get the results from Yext into the structure
+        # that is needed by Spyke.
+        class ResponseParser < Faraday::Response::Middleware
+          def call(env)
+            @parse_env = env
+
+            @app.call(env).on_complete do |environment|
+              @response_env = environment
+              on_complete(environment)
+            end
+          end
+
+          def parse(body)
+            # Yext Response:
+            #   http://developer.yext.com/docs/api-reference/#section/Policies-and-Conventions
+            #
+            #   Example response format:
+            #   {
+            #       "meta":     {
+            #           "uuid":   "bb0c7e19-4dc3-4891-bfa5-8593b1f124ad",
+            #           "errors": [
+            #                         {
+            #                             "code": ...error code...,
+            #                             "type": ...error, fatal error, non fatal error, or warning...,
+            #                             "message": ...explanation of the issue...
+            #                         }
+            #                     ]
+            #       },
+            #       "response": {
+            #           ...results...
+            #       }
+            #   }
+            #
+            # Spyke Expected Response Format:
+            #   https://github.com/balvig/spyke#configuration
+            #
+            #   { data: { id: 1, name: 'Bob' }, metadata: {}, errors: {} }
+            #
+            #   Errors:
+            #   https://github.com/balvig/spyke#api-side-validations
+            #
+            #   { title: [{ error: 'blank'}, { error: 'too_short', count: 10 }]}
+
+            if body.starts_with?("<html")
+              save_meta_data(parse_env, {}, response_env[:status], body: body)
+
+              return {}
+            end
+
+            @yext_response_json = {}
+
+            data      = data_value(body)
+            meta_data = meta_data_value
+
+            save_meta_data(parse_env, meta_data, response_env[:status], data)
+
+            { data: data, metadata: meta_data, errors: {} }
+          end
+
+          private
+
+          def data_value(body)
+            return [{ response_string: body }] unless body.starts_with?("{")
+
+            @yext_response_json = JSON.parse(body, symbolize_names: true)
+
+            extract_data_value
+          end
+
+          def meta_data_value
+            yext_response_json[:meta]
+          end
+
+          def extract_data_value
+            data = yext_response_json[:response]
+
+            if data.is_a?(Hash) && (data.key?(:count) || data.length <= 2)
+              array_data = data[(data.keys - [:count]).first]
+              if array_data.is_a?(Array)
+                data = array_data
+              elsif data.blank?
+                data = nil
+              end
+            end
+
+            data
+          end
+
+          attr_reader :parse_env,
+                      :yext_response_json,
+                      :response_env
+
+          def save_meta_data(environment, metadata, status, data)
+            api_module = Yext::Api::Utils::ApiFinder.new(environment[:url], environment[:method]).find_api
+            return if api_module.blank?
+
+            api_module.send(:last_data=, data)
+            api_module.send(:last_status=, status)
+            api_module.send(:last_meta=, metadata)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yext/api/utils/middleware/uri_cleanup.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    module Utils
+      module Middleware
+        # Faraday Middleware for cleaning up after Spyke.
+        #
+        # I consider this a primary failing of Spyke.  The use of a global "current_scope" and
+        # associations being stored in instance variables that are re-used in every single use
+        # of the association creates the potential and reality of leaks between calls because
+        # scopes don't represent a filter as much as they represent the class itself.
+        #
+        # Because of this and because there aren't normal hooks on the models, I had to figure out
+        # a way to cleanup and reset associations between calls in a reliable manner.
+        #
+        # Because we're using Faraday, I am using Faraday middleware to hook into the API call
+        # and after we get a response, making a call on the class associated with the call that was
+        # made and telling that class to clean itself up.
+        class UriCleanup < Faraday::Response::Middleware
+          def call(env)
+            @app.call(env).on_complete do |_environment|
+              reset_class_uri(env)
+
+              env.response
+            end
+          end
+
+          private
+
+          def reset_class_uri(env)
+            klass = Yext::Api::Utils::ApiFinder.new(env[:url], env[:method]).find_class_name
+
+            return unless klass.present?
+
+            klass = klass.constantize
+
+            klass.reset_uri if klass.respond_to?(:reset_uri)
+          rescue StandardError => error
+            return unless Object.const_defined?("Rails")
+
+            Rails.logger.error error
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# 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

data/lib/yext/api/version.rb

@@ -2,6 +2,6 @@
 
 module Yext
   module Api
-    VERSION = "0.1.1"
+    VERSION = "0.1.3"
   end
 end

data/yext-api.gemspec

@@ -28,19 +28,18 @@ Gem::Specification.new do |spec|
   end
 
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", "~> 5.1.2"
+  spec.add_dependency "memoist", "~> 0"
+  spec.add_dependency "rails", "> 4"
   spec.add_dependency "spyke", "~> 5"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "codecov"
   spec.add_development_dependency "cornucopia"
-  # spec.add_development_dependency "dotenv", "~> 2.0"
-  # spec.add_development_dependency "dotenv-rails"
   spec.add_development_dependency "hashie"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-rcov"

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: yext-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - CardTapp
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: memoist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.2
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: spyke
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +56,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cornucopia
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -189,31 +217,22 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- PULL_REQUEST_TEMPLATE.md
 - README.md
 - Rakefile
-- app/assets/config/yext_api_manifest.js
-- app/assets/images/yext/api/.keep
-- app/assets/javascripts/yext/api/application.js
-- app/assets/stylesheets/yext/api/application.css
+- app/controllers/yext/api/agreements/add_request_controller.rb
 - app/controllers/yext/api/application_controller.rb
-- app/docs/notes.txt
-- app/helpers/yext/api/application_helper.rb
-- app/jobs/yext/api/application_job.rb
-- app/mailers/yext/api/application_mailer.rb
-- app/models/yext/api/application_record.rb
-- app/views/layouts/yext/api/application.html.erb
 - bin/console
 - bin/rails
 - bin/setup
+- config/initializers/memoist.rb
 - config/initializers/spyke.rb
 - config/routes.rb
 - lib/config/api.yml
-- lib/tasks/yext/api_tasks.rake
 - lib/yext/api.rb
 - lib/yext/api/administrative_api.rb
 - lib/yext/api/administrative_api/account.rb
@@ -221,25 +240,31 @@ files:
 - lib/yext/api/administrative_api/service.rb
 - lib/yext/api/concerns/account_child.rb
 - lib/yext/api/concerns/account_relations.rb
-- lib/yext/api/concerns/api_finder.rb
 - lib/yext/api/concerns/default_scopes.rb
 - lib/yext/api/concerns/enum_all.rb
 - 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_status.rb
+- lib/yext/api/enumerations/location_type.rb
 - lib/yext/api/enumerations/validation.rb
 - lib/yext/api/knowledge_api.rb
 - lib/yext/api/knowledge_api/account_settings/account.rb
+- lib/yext/api/knowledge_api/account_settings/role.rb
+- lib/yext/api/knowledge_api/account_settings/user.rb
 - 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/live_api.rb
 - lib/yext/api/live_api/location.rb
 - lib/yext/api/utils/api_base.rb
-- lib/yext/api/utils/api_rate_limits.rb
+- lib/yext/api/utils/api_finder.rb
 - lib/yext/api/utils/configuration.rb
-- lib/yext/api/utils/default_parameters.rb
-- lib/yext/api/utils/response_parser.rb
+- lib/yext/api/utils/middleware/api_rate_limits.rb
+- 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/version.rb
 - lib/yext/include_rails.rb
 - yext-api.gemspec