yext-api 0.1.1 → 0.1.3

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.16.0

data/app/assets/config/yext_api_manifest.js

@@ -1,2 +0,0 @@
-//= link_directory ../javascripts/yext/api .js
-//= link_directory ../stylesheets/yext/api .css

data/app/assets/javascripts/yext/api/application.js

@@ -1,13 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file. JavaScript code in this file should be added after the last require_* statement.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree .

data/app/assets/stylesheets/yext/api/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/docs/notes.txt

@@ -1,45 +0,0 @@
-Other
-  Date/time: Time.now.iso8601
-  Date: Time.now.to_date.iso8601
-
-Classes examples:
-  AdministrativeApi::Account
-  AdministrativeApi::AddRequest
-  AdministrativeApi::Service
-  KnowledgeApi::HealthCheck::Health
-  KnowledgeApi::KnowledgeManager::Location
-  KnowledgeApi::KnowledgeManager::Folder
-  KnowledgeApi::KnowledgeManager::Menu
-  KnowledgeApi::KnowledgeManager::Bio
-  KnowledgeApi::KnowledgeManager::Product
-  KnowledgeApi::KnowledgeManager::Event
-  KnowledgeApi::KnowledgeManager::Category
-  KnowledgeApi::KnowledgeManager::GoogleField
-  KnowledgeApi::KnowledgeManager::CustomField
-  KnowledgeApi::KnowledgeManager::LanguageProfile
-  KnowledgeApi::KnowledgeManager::Asset
-  KnowledgeApi::PowerListings::Publisher
-  KnowledgeApi::PowerListings::Listing
-  KnowledgeApi::PowerListings::PublisherSuggestion
-  KnowledgeApi::Analytics::MaxDate
-  KnowledgeApi::Analytics::Report
-  KnowledgeApi::Analytics::Activity
-  KnowledgeApi::Reviews::Review
-  KnowledgeApi::Reviews::Comment
-  KnowledgeApi::Reviews::ReviewInvitation
-  KnowledgeApi::Reviews::ReviewGenerationSetting
-  KnowledgeApi::Social::Post
-  KnowledgeApi::Social::Comment
-  KnowledgeApi::Social::LinkedAccount
-  KnowledgeApi::AccountSettings::Role
-  KnowledgeApi::AccountSettings::User
-  KnowledgeApi::AccountSettings::Account
-  KnowledgeApi::OptimizationTasks::OptimizationTask
-  LiveApi::Menu
-  LiveApi::Bio
-  LiveApi::Product
-  LiveApi::Event
-  LiveApi::LanguageProfile
-  LiveApi::LanguageProfileSchema
-  LiveApi::Location
-  LiveApi::LocationSchema

data/app/helpers/yext/api/application_helper.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-# :nocov:
-module Yext
-  module Api
-    # The base module for the Engines helpers.
-    module ApplicationHelper
-    end
-  end
-end
-# :nocov:

data/app/jobs/yext/api/application_job.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-# module Yext
-#   module Api
-#     class ApplicationJob < ActiveJob::Base
-#     end
-#   end
-# end

data/app/mailers/yext/api/application_mailer.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-# module Yext
-#   module Api
-#     # The base class for mailers in the Engine.
-#     class ApplicationMailer < ActionMailer::Base
-#       default from: "from@example.com"
-#       layout "mailer"
-#     end
-#   end
-# end

data/app/models/yext/api/application_record.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-# Unused
-# module Yext
-#   module Api
-#     class ApplicationRecord < ActiveRecord::Base
-#       self.abstract_class = true
-#     end
-#   end
-# end

data/app/views/layouts/yext/api/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Yext Api</title>
-  <%= stylesheet_link_tag    "yext/api/application", media: "all" %>
-  <%= javascript_include_tag "yext/api/application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/lib/tasks/yext/api_tasks.rake

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-# desc "Explaining what the task does"
-# task :yext_api do
-#   # Task goes here
-# end

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

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module Yext
-  module Api
-    module Concerns
-      # This module add the `find_api` method to a class to allow the searching of the base
-      # api category module for a particular route.
-      module ApiFinder
-        def find_api(url, method)
-          return if url.nil? || method.nil?
-          return Yext::Api::LiveApi if url.host.include?("liveapi")
-
-          hash = YAML.load_file(Yext::Api::Engine.root.join("lib/config/api.yml"))
-
-          hash.each_key do |hash_key|
-            guess_api = api_from_key(hash_key)
-
-            next if guess_api.blank?
-
-            return guess_api if found_route?(hash[hash_key], url.path, method.to_s)
-          end
-
-          nil
-        end
-
-        private
-
-        def found_route?(hash, path, method)
-          hash.each do |key_name, sub_hash|
-            if sub_hash.is_a?(Hash)
-              return true if found_route?(sub_hash, path, method)
-            elsif key_name == :actions
-              return true if found_action?(sub_hash, path, method)
-            end
-          end
-
-          false
-        end
-
-        def found_action?(actions, path, method)
-          actions.each do |action|
-            next if action[:path_regex].blank?
-            next if action[:method].to_s != method
-
-            return true if Regexp.new("#{action[:path_regex]}$").match(path)
-          end
-
-          false
-        end
-
-        def api_from_key(hash_key)
-          "Yext::Api::#{hash_key.to_s.classify}".constantize
-        rescue NameError
-          # :nocov:
-          nil
-          # :nocov:
-        end
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Yext
-  module Api
-    module Utils
-      # Faraday Middleware for extracting API limits from call responses.
-      class ApiRateLimits < Faraday::Response::Middleware
-        include Yext::Api::Concerns::ApiFinder
-
-        def call(env)
-          @app.call(env).on_complete do |environment|
-            save_rates(environment, find_api(env[:url], env[:method].to_s))
-
-            env.response
-          end
-        end
-
-        private
-
-        def save_rates(environment, api_module)
-          return if api_module.blank?
-
-          api_module.last_status = environment[:status]
-
-          response_headers = environment[:response_headers]
-
-          return unless response_headers.key?("rate-limit-remaining")
-
-          api_module.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

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

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module Yext
-  module Api
-    module Utils
-      # 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.
-      #
-      # 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.
-      class DefaultParameters < Faraday::Response::Middleware
-        attr_reader :configuration
-
-        def call(request_env)
-          @configuration = Yext::Api.configuration
-          url            = request_env[:url]
-          params         = Rack::Utils.parse_nested_query(url.query).with_indifferent_access
-
-          add_username_headers(request_env, configuration, params)
-          add_default_query_params(configuration, params)
-          save_query_params(url, params)
-
-          @app.call(request_env)
-        end
-
-        private
-
-        def add_default_query_params(configuration, params)
-          params.reverse_merge!(api_key: configuration.api_key,
-                                v:       configuration.api_version || "20161012")
-
-          params[:validation] ||= configuration.validation_level if configuration.validation_level.present?
-        end
-
-        def save_query_params(url, params)
-          url.query = params.to_query
-        end
-
-        def add_username_headers(request_env, configuration, params)
-          username = params.delete(:yext_username) || configuration.yext_username
-          user_id  = params.delete(:yext_user_id) || configuration.yext_user_id
-
-          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
-      end
-    end
-  end
-end

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

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-module Yext
-  module Api
-    module Utils
-      # 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
-        include Yext::Api::Concerns::ApiFinder
-
-        def call(env)
-          @parse_env = env
-
-          @app.call(env).on_complete do |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 }]}
-
-          # yext_response_json = MultiJson.load(body, symbolize_keys: true)
-          return {} if body.starts_with?("<html")
-          return { data: [{ response_string: body }], metadata: {}, errors: {} } unless body.starts_with?("{")
-
-          yext_response_json = JSON.parse(body, symbolize_names: true)
-
-          data = extract_data_value(yext_response_json)
-
-          save_meta_data(find_api(parse_env[:url], parse_env[:method].to_s), yext_response_json[:meta])
-
-          { data:     data,
-            metadata: yext_response_json[:meta],
-            errors:   {} }
-        end
-
-        private
-
-        def extract_data_value(yext_response_json)
-          data = yext_response_json[:response]
-          data = data[(data.keys - [:count]).first] if data.is_a?(Hash) && (data.key?(:count) || data.length <= 2)
-
-          data
-        end
-
-        attr_reader :parse_env
-
-        def save_meta_data(api_module, metadata)
-          return if api_module.blank?
-
-          api_module.last_meta = metadata
-        end
-      end
-    end
-  end
-end