yext-api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8053aa37eff876ce5e19ea3adfc1cc612ba75e33
+  data.tar.gz: 5a2c361a2c6765727896f5d3dfe5cbda88d91ae0
+SHA512:
+  metadata.gz: 2a37ebb7efc5e369d9e379f9268be0129ab1c3ba85b735a0b1e130cc6c4995dd6b1ce741a80c59314e0416cdda6118e54b511fb8b46cbe3f005e6a377e52257e
+  data.tar.gz: e328357997e34cc2ff3620377e8b4d38a17c52210bf945ecceaff13f1f0fe6bcf9600287549ca8c007f57474a9c9db941e8d78a4b3bb0ed413c39cbcb3d00648

data/.gitignore

@@ -0,0 +1,25 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# spec dummy project
+log/*.log
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+
+# RubyMine IDE
+.idea/
+
+# Cornucopia
+/spec/dummy/cornucopia_report/
+/cornucopia_report/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,100 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+  # If `true`, strings which span multiple lines using `\` for continuation must
+  # use the same type of quotes on each line.
+  ConsistentQuotesInMultiline: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+  SupportedStyles:
+    # `when_needed` will add the frozen string literal comment to files
+    # only when the `TargetRubyVersion` is set to 2.3+.
+    - when_needed
+    # `always` will always add the frozen string literal comment to a file
+    # regardless of the Ruby version or if `freeze` or `<<` are called on a
+    # string literal. If you run code against multiple versions of Ruby, it is
+    # possible that this will create errors in Ruby 2.3.0+.
+    - always
+    # `never` will enforce that the frozen string literal comment does not
+    # exist in a file.
+    - never
+
+Layout/ExtraSpacing:
+  # When true, allows most uses of extra spacing if the intent is to align
+  # things with the previous or next line, not counting empty lines or comment
+  # lines.
+  AllowForAlignment: true
+  # When true, forces the alignment of `=` in assignments on consecutive lines.
+  ForceEqualSignAlignment: true
+
+Metrics/LineLength:
+  Max: 150
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+  # The IgnoreCopDirectives option causes the LineLength rule to ignore cop
+  # directives like '# rubocop: enable ...' when calculating a line's length.
+  IgnoreCopDirectives: false
+  # The IgnoredPatterns option is a list of !ruby/regexp and/or string
+  # elements. Strings will be converted to Regexp objects. A line that matches
+  # any regular expression listed in this option will be ignored by LineLength.
+  IgnoredPatterns: []
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  SupportedStyles:
+    - aligned
+    - indented
+    - indented_relative_to_receiver
+  # By default, the indentation width from Layout/IndentationWidth is used
+  # But it can be overridden by setting this parameter
+  IndentationWidth: 4
+
+# Multi-line method chaining should be done with leading dots.
+Layout/DotPosition:
+  EnforcedStyle: trailing
+  SupportedStyles:
+    - leading
+    - trailing
+
+# Checks the indentation of the first key in a hash literal.
+Layout/IndentHash:
+  # The value `special_inside_parentheses` means that hash literals with braces
+  # that have their opening brace on the same line as a surrounding opening
+  # round parenthesis, shall have their first key indented relative to the
+  # first position inside the parenthesis.
+  #
+  # The value `consistent` means that the indentation of the first key shall
+  # always be relative to the first position of the line where the opening
+  # brace is.
+  #
+  # The value `align_braces` means that the indentation of the first key shall
+  # always be relative to the position of the opening brace.
+  EnforcedStyle: special_inside_parentheses
+  SupportedStyles:
+    - special_inside_parentheses
+    - consistent
+    - align_braces
+  # By default, the indentation width from `Layout/IndentationWidth` is used
+  # But it can be overridden by setting this parameter
+  IndentationWidth: 4
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+  SupportedStyles:
+    - aligned
+    - indented
+  # By default, the indentation width from `Layout/IndentationWidth` is used
+  # But it can be overridden by setting this parameter
+  IndentationWidth: 2

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at RealNobody1@cox.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |_repo_name| "https://github.com/RealNobody/yext-api" }
+
+# Specify your gem's dependencies in yext-api.gemspec
+gemspec
+
+gem "gem-release"

data/Gemfile.lock

@@ -0,0 +1,187 @@
+PATH
+  remote: .
+  specs:
+    yext-api (0.1.0)
+      rails (~> 5.1.2)
+      spyke (~> 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.4)
+      actionpack (= 5.1.4)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      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)
+      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)
+      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)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    arel (8.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    cornucopia (0.1.40)
+      activesupport
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    crass (1.0.3)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    erubi (1.7.0)
+    faraday (0.13.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    gem-release (1.0.0)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    hashdiff (0.3.7)
+    hashie (3.5.7)
+    i18n (0.9.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)
+      mini_mime (>= 0.1.1)
+    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)
+    public_suffix (3.0.1)
+    rack (2.0.3)
+    rack-test (0.8.2)
+      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)
+      bundler (>= 1.3.0)
+      railties (= 5.1.4)
+      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)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-rails (3.6.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    safe_yaml (1.0.4)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    spyke (5.2.0)
+      activemodel (>= 4.0.0, < 6.0)
+      activesupport (>= 4.0.0, < 6.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)
+      thread_safe (~> 0.1)
+    vcr (4.0.0)
+    webmock (3.2.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  cornucopia
+  gem-release
+  hashie
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-rails
+  simplecov
+  simplecov-rcov
+  vcr
+  webmock
+  yext-api!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 RealNobody
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,206 @@
+# Yext::Api
+
+This gem provides a Rails interface with the Yext API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yext-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yext-api
+
+## Usage
+
+This gem uses the [Spyke gem](https://github.com/balvig/spyke) to simplify the HTML calls and create
+a familiar ActiveRecord type interface with Yext and the Yext objects.  Please refer to that gem for
+details on making calls, passing paraemters etc. if the documentation here is not sufficient.
+
+### Configuration
+
+To use the Yext API, you need to specify certain options like the account ID, the application ID, etc.
+These options can be set to global defaults or set on a per-call basis.
+
+A configuration option is avalable through `Yext::Api.configuration`.  All configuration options can
+be set through here.  To confugure multiple items you can use `Yext::Api.configure`:
+
+```ruby
+Yext::Api.configure do |configuration|
+  configuration.account_id  = "your account_id"
+  configuration.api_key     = "your application key"
+  configuration.api_version = "20161012"
+end
+```
+
+The global configurations can be initialized with ENV values.  The following configurations are available:
+
+* `account_id` - `ENV["YEXT_ACCOUNT_ID"]`
+  This is the Account ID that is used in the path to API endpoints that require an account ID.  This
+  value will default to `"me"` if not specified.
+
+  You can specify this on a per-call basis using `with_account("new account_id")`.  This option is only
+  available for objects that require an account ID for all calls.
+
+* `api_key` - `ENV["YEXT_API_KEY"]`
+  This is the API_KEY from the Yext Application that you are using.
+
+  You can specify this on a per-call basis using `with_application("new application key")`.
+
+* `api_version` - `ENV["YEXT_API_VERSION"]`
+  This is the version number of the `v2` API endpoint to be used.  This value be defaulted to the most
+  recent version of the API that the gem is aware of or `"2016101"`
+
+  You can specify this on a per-call basis using `with_version("new version")`.
+
+* `yext_username` - `ENV["YEXT_USERNAME"]`
+  This is the username to be associated with changes in Yext.  This option is available on all calls but
+  will only be used for `PUT`, `PATCH`, `CREATE`, and `DELETE` calls.
+
+  You can specify this on a per-call basis using `yext_username("your username")`.
+
+* `yext_user_id` - `ENV["YEXT_USER_ID"]`
+  This is the ID of the user to be associated with changes in Yext.  This option is available on all calls but
+  will only be used for `PUT`, `PATCH`, `CREATE`, and `DELETE` calls.
+
+  You can specify this on a per-call basis using `yext_user_id("your user_id")`.
+
+* `validation_level` - `ENV["YEXT_VALIDATION_LEVEL"]`
+  The validation level to be used on the call.  This value can only be `strict` or `lenient`.
+  Yext will default this if not specified to "strict" if you do not specify a value.
+
+  You can specify this on a per-call basis using:
+  * `validate(true)` (for strict)
+  * `validate(false)` (for lenient)
+  * `validate(Yext::Api::Enumerations::Validation::LENIENT)`
+
+* `sandbox` - `!Rails.env.production?`
+  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.
+
+### General Usage
+
+The API namespaces are setup to mimic the structure of the Yext API documentation to make it easier.
+to find or guess at an objects name.  Objects are defined based on the routes for those objects.  The
+following classes are planned based on that structure:
+
+* 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
+
+#### Fetching a list of objects
+
+Use `all`:
+
+```ruby
+Yext::Api::AdministrativeApi::Account.all.each do |account|
+  sku_match?(account.sku)
+end
+```
+
+#### Fetching a single object
+
+Use `find`
+
+```ruby
+account = Yext::Api::AdministrativeApi::Account.find("my-id")
+```
+
+#### Overriding configuration options
+
+```ruby
+other_account_services = Yext::Api::AdministrativeApi::Service.with_account("6664444").with_application("777821019292928").to_a
+```
+
+#### Using custom actions
+
+```ruby
+available_services = Yext::Api::AdministrativeApi::Service.available.to_a
+```
+
+#### API Rate Limits
+
+Yext returns rate limit information for each call.  This information is different for each category of
+API call, so it is stored in the base Namespace for each call.
+
+NOTE:  Accounts are listed in the API documentation in both the `AdministrativeApi` and the `KnowledgeApi`
+namespaces.  The `index` and `get` options are available in both locations, but the rate limites are
+ONLY recorded in `KnowledgeApi`.
+
+```ruby
+Yext::Api::AdministrativeApi::Service.all.to_a
+
+# Now the following values are set based on the response.
+Yext::Api::AdministrativeApi.rate_limit_limit
+Yext::Api::AdministrativeApi.rate_limit_remaining
+Yext::Api::AdministrativeApi.rate_limit_reset_at
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the
+tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version,
+update the version number in `version.rb`, and then run `bundle exec rake release`, which will create
+a git tag for the version, push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yext-api. This
+project is intended to be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Yext::Api project’s codebases, issue trackers, chat rooms and mailing lists
+is expected to follow the [code of conduct](https://github.com/[USERNAME]/yext-api/blob/master/CODE_OF_CONDUCT.md).