whoosh-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a8e69af09aa3d2d0d9573ceebe9ca7a6c70e2822c70d122dd4f1e7039e4f266
-  data.tar.gz: 972a7197113aef604e06dfdefad5f1e9bc34b1a099540f8e79d90de6933196a3
+  metadata.gz: ce50286aabd3835af1ee9883a1c33902664f1a2630758c602d7972b5ce4c2a33
+  data.tar.gz: 188ae951c50c790ccfbb01a7ae96281e77ebc2366fc93175ff854ef50905d2e1
 SHA512:
-  metadata.gz: ac8b386c2535458066f9568aa88daa73be2adc62f6706967452a0ff493a0b9836e06cd28829eae1e7eea7c5fc13f1fde909df24c37f09ff8fac5c2073fa1dc21
-  data.tar.gz: c641a4d014f387f2be60a9234436b3dec4f9de94ea63be1161d55dad8883b75e3fbeacb750d767f0fe39244872634a414a3efa6ad89561aacfdb5a20d704ebdb
+  metadata.gz: 65e5c7626038ff4603a4b2f3601111834e76c780706b7059077922bf73fa77815a7b429145c2f1092cc7f75a13bbbe64abbf43055a9bdcc0225a7731b3b94093
+  data.tar.gz: fb1ffc9999d64d17dba74ca8fdd711e5eca603879fc0471231c08d66dbd126a9fa0deb48f22fbe87f4b8bd73f3a06425c4dfac1e9c4fb390a6251ef2c2802314

data/.dockerignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.github/workflows/pr-lint.yml

@@ -0,0 +1,21 @@
+name: Lint PR
+on:
+  pull_request_target:
+    types: [ opened, edited, synchronize, reopened ]
+
+jobs:
+  validate:
+    name: Validate title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        with:
+          types: |
+            chore
+            docs
+            fix
+            feat
+            misc
+            test
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -0,0 +1,21 @@
+*~
+!.rubocop_todo.yml
+!.rubocop.yml
+!.travis.yml
+!.dockerignore
+pkg/*
+doc/*
+Gemfile.lock
+*.gem
+bin
+docs/_build
+*.bak
+*.iml
+.bundle
+.rakeTasks
+.yardoc
+.openapi-generator*
+.idea/
+
+
+coverage

data/.rubocop.yml

@@ -0,0 +1,58 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'lib/twilio-ruby/rest/**/*'
+    - 'spec/integration/**/*'
+    - 'lib/twilio-ruby/version.rb'
+    - 'lib/twilio-ruby/util/configuration.rb'
+    - 'vendor/**/*'
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - twilio-ruby.gemspec
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 175
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ParameterLists:
+  Max: 20
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,261 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-01-13 21:45:15 UTC using RuboCop version 1.24.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'twilio-ruby.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'twilio-ruby.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterGuardClause:
+  Exclude:
+    - 'lib/rack/twilio_webhook_authentication.rb'
+    - 'lib/twilio-ruby/framework/serialize.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'spec/jwt/client_capability_spec.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'spec/jwt/access_token_spec.rb'
+    - 'spec/jwt/client_capability_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/jwt/client_capability_spec.rb'
+    - 'spec/rest/client_spec.rb'
+
+# Offense count: 1
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/twilio-ruby/framework/rest/error.rb'
+
+# Offense count: 1
+Lint/SelfAssignment:
+  Exclude:
+    - 'lib/twilio-ruby/framework/rest/version.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'spec/rack/twilio_webhook_authentication_spec.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/twilio-ruby.rb'
+    - 'lib/twilio-ruby/framework/rest/page.rb'
+    - 'spec/holodeck/holodeck.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: ContextCreatingMethods, MethodCreatingMethods.
+Lint/UselessAccessModifier:
+  Exclude:
+    - 'lib/twilio-ruby/jwt/access_token.rb'
+
+# Offense count: 14
+Lint/UselessAssignment:
+  Exclude:
+    - 'spec/rack/twilio_webhook_authentication_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: Max, CountKeywordArgs.
+Metrics/ParameterLists:
+  MaxOptionalParameters: 6
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/twilio-ruby.rb'
+
+# Offense count: 2
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/twilio-ruby/security/request_validator.rb'
+
+# Offense count: 19
+# Configuration parameters: EnforcedStyle, AllowedIdentifiers.
+# SupportedStyles: snake_case, camelCase
+Naming/VariableName:
+  Exclude:
+    - 'spec/jwt/client_capability_spec.rb'
+    - 'spec/jwt/task_router_spec.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/CaseLikeIf:
+  Exclude:
+    - 'lib/twilio-ruby/framework/serialize.rb'
+    - 'lib/twilio-ruby/jwt/task_router.rb'
+
+# Offense count: 40
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Encoding:
+  Exclude:
+    - 'twilio-ruby.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'spec/spec_helper.rb'
+    - 'twilio-ruby.gemspec'
+
+# Offense count: 24
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/GlobalStdStream:
+  Exclude:
+    - 'spec/rest/client_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/twilio-ruby/framework/rest/page.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+# SupportedShorthandSyntax: always, never
+Style/HashSyntax:
+  Exclude:
+    - 'Gemfile'
+    - 'spec/jwt/access_token_spec.rb'
+
+# Offense count: 13
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/twilio-ruby/framework/rest/page.rb'
+    - 'lib/twilio-ruby/framework/rest/version.rb'
+    - 'lib/twilio-ruby/jwt/access_token.rb'
+    - 'lib/twilio-ruby/jwt/client_capability.rb'
+    - 'lib/twilio-ruby/jwt/jwt.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/RedundantAssignment:
+  Exclude:
+    - 'lib/twilio-ruby/jwt/access_token.rb'
+    - 'lib/twilio-ruby/jwt/client_capability.rb'
+    - 'lib/twilio-ruby/jwt/task_router.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantFileExtensionInRequire:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/RedundantFreeze:
+  Exclude:
+    - 'lib/twilio-ruby/jwt/task_router.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/twilio-ruby/framework/serialize.rb'
+
+# Offense count: 16
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'lib/twilio-ruby/framework/rest/domain.rb'
+    - 'lib/twilio-ruby/framework/rest/helper.rb'
+    - 'lib/twilio-ruby/framework/rest/version.rb'
+    - 'spec/rack/twilio_webhook_authentication_spec.rb'
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'examples/print_call_log.rb'
+    - 'lib/twilio-ruby/framework/request.rb'
+    - 'lib/twilio-ruby/framework/rest/error.rb'
+    - 'lib/twilio-ruby/framework/serialize.rb'
+    - 'lib/twilio-ruby/http/http_client.rb'
+    - 'lib/twilio-ruby/jwt/client_capability.rb'
+    - 'spec/framework/request_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Gemfile'
+    - 'spec/framework/serialize_spec.rb'
+
+# Offense count: 15
+# Cop supports --auto-correct.
+# Configuration parameters: AllowNamedUnderscoreVariables.
+Style/TrailingUnderscoreVariable:
+  Exclude:
+    - 'spec/jwt/access_token_spec.rb'
+    - 'spec/jwt/client_capability_spec.rb'
+    - 'spec/jwt/task_router_spec.rb'
+
+# Offense count: 16
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize, WordRegex.
+# SupportedStyles: percent, brackets
+Style/WordArray:
+  EnforcedStyle: brackets

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:2.4
+
+RUN mkdir /twilio
+WORKDIR /twilio
+
+COPY . .
+
+RUN bundle install
+RUN bundle exec rake install

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Makefile

@@ -0,0 +1,37 @@
+.PHONY: githooks install test test-docker lint docs docker-build docker-push
+
+githooks:
+	ln -sf ../../githooks/pre-commit .git/hooks/pre-commit
+
+install:
+	bundle install --with development; bundle exec rake install
+
+test:
+	bundle exec rake spec
+
+test-docker:
+	docker build -t twilio/twilio-ruby .
+	docker run twilio/twilio-ruby bundle exec rake spec
+
+docs:
+	bundle exec yard doc --output-dir ./doc
+
+authors:
+	echo "Authors\n=======\n\nA huge thanks to all of our contributors:\n\n" > AUTHORS.md
+	git log --raw | grep "^Author: " | cut -d ' ' -f2- | cut -d '<' -f1 | sed 's/^/- /' | sort | uniq >> AUTHORS.md
+
+API_DEFINITIONS_SHA=$(shell git log --oneline | grep Regenerated | head -n1 | cut -d ' ' -f 5)
+CURRENT_TAG=$(shell expr "${GITHUB_TAG}" : ".*-rc.*" >/dev/null && echo "rc" || echo "latest")
+docker-build:
+	docker build -t twilio/twilio-ruby .
+	docker tag twilio/twilio-ruby twilio/twilio-ruby:${GITHUB_TAG}
+	docker tag twilio/twilio-ruby twilio/twilio-ruby:apidefs-${API_DEFINITIONS_SHA}
+	docker tag twilio/twilio-ruby twilio/twilio-ruby:${CURRENT_TAG}
+
+docker-push:
+	docker push twilio/twilio-ruby:${GITHUB_TAG}
+	docker push twilio/twilio-ruby:apidefs-${API_DEFINITIONS_SHA}
+	docker push twilio/twilio-ruby:${CURRENT_TAG}
+
+cluster-test:
+	bundle exec rspec ./cluster_spec.rb

data/README.md

@@ -1,15 +1,5 @@
 # twilio-ruby
 
-[![Tests](https://github.com/twilio/twilio-ruby/actions/workflows/test-and-deploy.yml/badge.svg)][github-actions]
-[![Gem Version](https://img.shields.io/gem/v/twilio-ruby.svg)](https://rubygems.org/gems/twilio-ruby)
-[![Learn with TwilioQuest](https://img.shields.io/static/v1?label=TwilioQuest&message=Learn%20to%20contribute%21&color=F22F46&labelColor=1f243c&style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAAASFBMVEUAAAAZGRkcHBwjIyMoKCgAAABgYGBoaGiAgICMjIyzs7PJycnMzMzNzc3UoBfd3d3m5ubqrhfrMEDu7u739/f4vSb/3AD///9tbdyEAAAABXRSTlMAAAAAAMJrBrEAAAKoSURBVHgB7ZrRcuI6EESdyxXGYoNFvMD//+l2bSszRgyUYpFAsXOeiJGmj4NkuWx1Qeh+Ekl9DgEXOBwOx+Px5xyQhDykfgq4wG63MxxaR4ddIkg6Ul3g84vCIcjPBA5gmUMeXESrlukuoK33+33uID8TWeLAdOWsKpJYzwVMB7bOzYSGOciyUlXSn0/ABXTosJ1M1SbypZ4O4MbZuIDMU02PMbauhhHMHXbmebmALIiEbbbbbUrpF1gwE9kFfRNAJaP+FQEXCCTGyJ4ngDrjOFo3jEL5JdqjF/pueR4cCeCGgAtwmuRS6gDwaRiGvu+DMFwSBLTE3+jF8JyuV1okPZ+AC4hDFhCHyHQjdjPHUKFDlHSJkHQXMB3KpSwXNGJPcwwTdZiXlRN0gSp0zpWxNtM0beYE0nRH6QIbO7rawwXaBYz0j78gxjokDuv12gVeUuBD0MDi0OQCLvDaAho4juP1Q/jkAncXqIcCfd+7gAu4QLMACCLxpRsSuQh0igu0C9Svhi7weAGZg50L3IE3cai4IfkNZAC8dfdhsUD3CgKBVC9JE5ABAFzg4QL/taYPAAWrHdYcgfLaIgAXWJ7OV38n1LEF8tt2TH29E+QAoDoO5Ve/LtCQDmKM9kPbvCEBApK+IXzbcSJ0cIGF6e8gpcRhUDogWZ8JnaWjPXc/fNnBBUKRngiHgTUSivSzDRDgHZQOLvBQgf8rRt+VdBUUhwkU6VpJ+xcOwQUqZr+mR0kvBUgv6cB4+37hQAkXqE8PwGisGhJtN4xAHMzrsgvI7rccXqSvKh6jltGlrOHA3Xk1At3LC4QiPdX9/0ndHpGVvTjR4bZA1ypAKgVcwE5vx74ulwIugDt8e/X7JgfkucBMIAr26ndnB4UCLnDOqvteQsHlgX9N4A+c4cW3DXSPbwAAAABJRU5ErkJggg==)](https://twil.io/learn-open-source)
-
-## Documentation
-
-The documentation for the Twilio API can be found [here][apidocs].
-
-The individual releases [here][refdocs].
-
 ## Versions
 
 `twilio-ruby` uses a modified version of [Semantic Versioning](https://semver.org) for all changes. [See this document](VERSIONS.md) for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task test: :spec