yext-api 0.1.1

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

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

data/lib/yext/api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yext
+  module Api
+    VERSION = "0.1.1"
+  end
+end

data/lib/yext/include_rails.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Code in this file is copied from `require "rails/all"`
+
+RAILS_ALL = %w[active_record/railtie
+               action_controller/railtie
+               action_view/railtie
+               action_mailer/railtie
+               active_job/railtie
+               action_cable/engine
+               rails/test_unit/railtie
+               sprockets/railtie].freeze
+
+# Yext is not using these elements of Rails yet.  Remove them.
+RAILS_USED = RAILS_ALL - %w[active_record/railtie
+                            action_view/railtie
+                            action_mailer/railtie
+                            active_job/railtie
+                            action_cable/engine
+                            rails/test_unit/railtie
+                            sprockets/railtie].freeze
+
+RAILS_USED.each do |railtie|
+  begin
+    require railtie
+  rescue LoadError => e
+    # :nocov:
+    Rails.logger.error e
+    # :nocov:
+  end
+end

data/yext-api.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# rubocop:disable BlockLength
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yext/api/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "yext-api"
+  spec.version = Yext::Api::VERSION
+  spec.authors = ["CardTapp"]
+  spec.email   = ["dustin@cardtapp.com"]
+
+  spec.summary     = "An interface gem to the Yext API."
+  spec.description = "A straightforward simple interface with the Yext API v2."
+  spec.homepage    = "https://github.com/CardTapp/yext-api"
+  spec.license     = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  raise "RubyGems 2.0 or newer is required to protect against public gem pushes." unless spec.respond_to?(:metadata)
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  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 "spyke", "~> 5"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  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 "rspec-rails"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-rcov"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end
+
+# rubocop:enable BlockLength

metadata

@@ -0,0 +1,271 @@
+--- !ruby/object:Gem::Specification
+name: yext-api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- CardTapp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+- !ruby/object:Gem::Dependency
+  name: spyke
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: cornucopia
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A straightforward simple interface with the Yext API v2.
+email:
+- dustin@cardtapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- 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/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/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
+- lib/yext/api/administrative_api/add_request.rb
+- 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/validation.rb
+- lib/yext/api/knowledge_api.rb
+- lib/yext/api/knowledge_api/account_settings/account.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/configuration.rb
+- lib/yext/api/utils/default_parameters.rb
+- lib/yext/api/utils/response_parser.rb
+- lib/yext/api/version.rb
+- lib/yext/include_rails.rb
+- yext-api.gemspec
+homepage: https://github.com/CardTapp/yext-api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: An interface gem to the Yext API.
+test_files: []