twilio-ruby 4.6.1 → 6.9.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 open-source@twilio.com. 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/CONTRIBUTING.md

@@ -0,0 +1,163 @@
+# Contributing to `twilio-ruby`
+
+We'd love for you to contribute to our source code and to make `twilio-ruby`
+even better than it is today! Here are the guidelines we'd like you to follow:
+
+ - [Code of Conduct](#coc)
+ - [Question or Problem?](#question)
+ - [Issues and Bugs](#issue)
+ - [Feature Requests](#feature)
+ - [Documentation fixes](#docs)
+ - [Submission Guidelines](#submit)
+ - [Coding Rules](#rules)
+
+
+## <a name="coc"></a> Code of Conduct
+
+Help us keep `twilio-ruby` open and inclusive. Please be kind to and considerate
+of other developers, as we all have the same goal: make `twilio-ruby` as good as
+it can be.
+
+## <a name="question"></a> Got an API/Product Question or Problem?
+
+If you have questions about how to use `twilio-ruby`, please see our
+[docs](./README.md), and if you don't find the answer there, please contact
+[Twilio Support](https://www.twilio.com/help/contact)  with any issues you have.
+
+## <a name="issue"></a> Found an Issue?
+
+If you find a bug in the source code or a mistake in the documentation, you can
+help us by submitting [an issue][issue-link]. If the file in which the error
+exists has this header:
+```
+"""
+This code was generated by
+\ / _    _  _|   _  _
+ | (_)\/(_)(_|\/| |(/_  v1.0.0
+      /       /
+"""
+```
+or
+```
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+```
+then it is a generated file and the change will need to be made by us, but
+submitting an issue will help us track it and keep you up-to-date. If the file
+isn't generated, you can help us out even more by submitting a Pull Request with
+a fix.
+
+**Please see the [Submission Guidelines](#submit) below.**
+
+## <a name="feature"></a> Want a Feature?
+
+You can request a new feature by submitting an issue to our
+[GitHub Repository][github]. If you would like to implement a new feature then
+consider what kind of change it is:
+
+* **Major Changes** that you wish to contribute to the project should be
+  discussed first with `twilio-ruby` contributors in an issue or pull request so
+  that we can develop a proper solution and better coordinate our efforts,
+  prevent duplication of work, and help you to craft the change so that it is
+  successfully accepted into the project.
+* **Small Changes** can be crafted and submitted to the
+  [GitHub Repository][github] as a Pull Request.
+
+## <a name="docs"></a> Want a Doc Fix?
+
+If you want to help improve the docs in the helper library, it's a good idea to
+let others know what you're working on to minimize duplication of effort. Create
+a new issue (or comment on a related existing one) to let others know what
+you're working on.
+
+For large fixes, please build and test the documentation before submitting the
+PR to be sure you haven't accidentally introduced layout or formatting issues.
+
+## <a name="submit"></a> Submission Guidelines
+
+### Submitting an Issue
+Before you submit your issue search the archive, maybe your question was already
+answered.
+
+If your issue appears to be a bug, and hasn't been reported, open a new issue.
+Help us to maximize the effort we can spend fixing issues and adding new
+features by not reporting duplicate issues. Providing the following information
+will increase the chances of your issue being dealt with quickly:
+
+* **Overview of the Issue** - if an error is being thrown a non-minified stack
+  trace helps
+* **Motivation for or Use Case** - explain why this is a bug for you
+* **`twilio-ruby` Version(s)** - is it a regression?
+* **Operating System (if relevant)** - is this a problem with all systems or
+  only specific ones?
+* **Reproduce the Error** - provide an isolated code snippet or an unambiguous
+  set of steps.
+* **Related Issues** - has a similar issue been reported before?
+* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point
+  to what might be causing the problem (line of code or commit)
+
+**If you get help, help others. Good karma rules!**
+
+### Submitting a Pull Request
+Before you submit your pull request consider the following guidelines:
+
+* Search [GitHub][github] for an open or closed Pull Request that relates to
+  your submission. You don't want to duplicate effort.
+* Make your changes in a new git branch:
+
+    ```shell
+    git checkout -b my-fix-branch main
+    ```
+
+* Create your patch, **including appropriate test cases**.
+* Follow our [Coding Rules](#rules).
+* Run the full `twilio-ruby` test suite (aliased by `make test`), and ensure
+  that all tests pass.
+* Commit your changes using a descriptive commit message.
+
+    ```shell
+    git commit -a
+    ```
+  Note: the optional commit `-a` command line option will automatically "add"
+  and "rm" edited files.
+
+* Build your changes locally to ensure all the tests pass:
+
+    ```shell
+    make test
+    ```
+
+* Push your branch to GitHub:
+
+    ```shell
+    git push origin my-fix-branch
+    ```
+
+In GitHub, send a pull request to `twilio-ruby:main`.
+If we suggest changes, then:
+
+* Make the required updates.
+* Re-run the `twilio-ruby` test suite to ensure tests are still passing.
+* Commit your changes to your branch (e.g. `my-fix-branch`).
+* Push the changes to your GitHub repository (this will update your Pull Request).
+
+That's it! Thank you for your contribution!
+
+#### After your pull request is merged
+
+After your pull request is merged, you can safely delete your branch and pull
+the changes from the main (upstream) repository.
+
+## <a name="rules"></a> Coding Rules
+
+To ensure consistency throughout the source code, keep these rules in mind as
+you are working:
+
+* All features or bug fixes **must be tested** by one or more tests.
+* All classes and methods **must be documented**.
+
+[issue-link]: https://github.com/twilio/twilio-ruby/issues/new
+[github]: https://github.com/twilio/twilio-ruby

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

@@ -1,10 +1,3 @@
 source 'https://rubygems.org'
-
+gem 'simplecov', require: false, group: :test
 gemspec
-
-group :test do
-  gem 'rake', '~> 10.1'
-  gem 'rspec', '~> 3.0'
-  gem 'fakeweb', '~> 1.3'
-  gem 'rack', '~> 1.3'
-end

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,30 @@
+<!--
+If this is a feature request, make sure you search Issues for an existing request before creating a new one!
+
+Please utilize the template below to help us resolve your issue.
+
+Note that many issues can be resolved by updating to the latest version.
+-->
+
+### Issue Summary
+A summary of the issue and the environment in which it occurs. If suitable, include the steps required to reproduce the bug. Please feel free to include screenshots, screencasts, or code examples.
+
+### Steps to Reproduce
+1. This is the first step
+2. This is the second step
+3. Further steps, etc.
+
+### Code Snippet
+```ruby
+# paste code here
+```
+
+### Exception/Log
+```
+# paste exception/log here
+```
+
+### Technical details:
+* twilio-ruby version: 
+* ruby version:
+

data/{LICENSE.md → LICENSE}

@@ -1,21 +1,21 @@
-Copyright (c) 2010-2014 Andrew Benton.
+MIT License
 
-The MIT License (MIT)
+Copyright (C) 2023, Twilio, Inc. <https://www.twilio.com/help/contact>
 
-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:
+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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Makefile

@@ -1,15 +1,37 @@
-install:
-	bundle exec rake install
+.PHONY: githooks install test test-docker lint docs docker-build docker-push
+
+githooks:
+	ln -sf ../../githooks/pre-commit .git/hooks/pre-commit
 
-test-install:
-	bundle install
+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
 
-deploy:
-	bundle exec rake build | sed -e 's/.*pkg/pkg/g' | sed -e "s/\.$$//g" | xargs gem push
+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/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,31 @@
+<!--
+We appreciate the effort for this pull request but before that please make sure you read the contribution guidelines, then fill out the blanks below.
+
+Please format the PR title appropriately based on the type of change:
+  <type>[!]: <description>
+Where <type> is one of: docs, chore, feat, fix, test, misc.
+Add a '!' after the type for breaking changes (e.g. feat!: new breaking feature).
+
+**All third-party contributors acknowledge that any contributions they provide will be made under the same open-source license that the open-source project is provided under.**
+
+Please enter each Issue number you are resolving in your PR after one of the following words [Fixes, Closes, Resolves]. This will auto-link these issues and close them when this PR is merged!
+e.g.
+Fixes #1
+Closes #2
+-->
+
+# Fixes #
+
+A short description of what this PR does.
+
+### Checklist
+- [x] I acknowledge that all my contributions will be made under the project's license
+- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
+- [ ] I have read the [Contribution Guidelines](https://github.com/twilio/twilio-ruby/blob/main/CONTRIBUTING.md) and my PR follows them
+- [ ] I have titled the PR appropriately
+- [ ] I have updated my branch with the main branch
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added the necessary documentation about the functionality in the appropriate .md file
+- [ ] I have added inline documentation to the code I modified
+
+If you have questions, please file a [support ticket](https://twilio.com/help/contact), or create a GitHub Issue in this repository.