whoosh-ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce50286aabd3835af1ee9883a1c33902664f1a2630758c602d7972b5ce4c2a33
-  data.tar.gz: 188ae951c50c790ccfbb01a7ae96281e77ebc2366fc93175ff854ef50905d2e1
+  metadata.gz: 819bccd0dea782a7d16d73cfe5b84a3d522c035a1a982b78b54f3e0a699df21a
+  data.tar.gz: c4f7e0c57d13ba915512b4679858f012a874a72e93451b7293d2cca557352b88
 SHA512:
-  metadata.gz: 65e5c7626038ff4603a4b2f3601111834e76c780706b7059077922bf73fa77815a7b429145c2f1092cc7f75a13bbbe64abbf43055a9bdcc0225a7731b3b94093
-  data.tar.gz: fb1ffc9999d64d17dba74ca8fdd711e5eca603879fc0471231c08d66dbd126a9fa0deb48f22fbe87f4b8bd73f3a06425c4dfac1e9c4fb390a6251ef2c2802314
+  metadata.gz: 30c8468349989cb39f41ae6f7b4294effe2aaa79c3d6b53a962f3eb867d317284dc60874ff6b9adec5be50083b91d1af693291d323c9b2eb50a5ca162d724a3b
+  data.tar.gz: c3a899d0bc0aefabc187531cb1bffe7ef066505c883d85e4f56c0d1dd604861949c3863224a6249d78bcf0feb8af7fe1d8f98968fcc59d90e41122721a5940d0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2023, Totogi LLC. <help@totogi.com>
+
+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

@@ -1,8 +1,4 @@
-# twilio-ruby
-
-## Versions
-
-`twilio-ruby` uses a modified version of [Semantic Versioning](https://semver.org) for all changes. [See this document](VERSIONS.md) for details.
+# whoosh-ruby
 
 ### Supported Ruby Versions
 
@@ -20,36 +16,24 @@ This library supports the following Ruby implementations:
 * JRuby 9.3
 * JRuby 9.4
 
-### Migrating from 5.x
-
-[Upgrade Guide][upgrade]
-
 ## Installation
 
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 6.0.0'
-```
-
-To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
-
-```bash
-gem install twilio-ruby -v 6.0.0
+gem 'whoosh-ruby', '~> 0.1.0'
 ```
 
-To build and install the development branch yourself from the latest source:
+To manually install `whoosh-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-git clone git@github.com:twilio/twilio-ruby.git
-cd twilio-ruby
-make install
+gem install whoosh-ruby -v 0.1.0
 ```
 
 > **Info**
 > If the command line gives you an error message that says Permission Denied, try running the above commands with sudo.
 >
-> For example: `sudo gem install twilio-ruby`
+> For example: `sudo gem install whoosh-ruby`
 
 ### Test your installation
 
@@ -58,7 +42,7 @@ To make sure the installation was successful, try sending yourself an SMS messag
 ```rb
 require "twilio-ruby"
 
-# Your Account SID and Auth Token from console.twilio.com
+# Your Account SID and Auth Token from console.whoosh.totogidemos.com
 account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
 auth_token = "your_auth_token"
 
@@ -66,7 +50,7 @@ auth_token = "your_auth_token"
 message = @client.messages.create(
   body: "Hello from Ruby",
   to: "+12345678901",  # Text this number
-  from: "+15005550006", # From a valid Twilio number
+  from: "+15005550006", # From a valid Whoosh number
 )
 
 puts message.sid
@@ -90,48 +74,6 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 @client = Twilio::REST::Client.new account_sid, auth_token
 ```
 
-### Use An API Key
-
-```ruby
-require 'twilio-ruby'
-
-# Your Account SID from console.twilio.com
-account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
-# API Key from twilio.com/console/project/api-keys
-api_key_sid = 'zzzzzzzzzzzzzzzzzzzzzz'
-api_key_secret = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
-
-# set up a client to talk to the Twilio REST API using an API Key
-@client = Twilio::REST::Client.new api_key_sid, api_key_secret, account_sid
-```
-
-### Specify a Region and/or Edge
-
-To take advantage of Twilio's [Global Infrastructure](https://www.twilio.com/docs/global-infrastructure), specify the target Region and/or Edge for the client:
-
-```ruby
-# set up a client to talk to the Twilio REST API over a specific region and edge
-@client = Twilio::REST::Client.new account_sid, auth_token, nil, 'au1'
-@client.edge = 'sydney'
-
-# you may also specify the region and/or edge after client creation
-@client = Twilio::REST::Client.new account_sid, auth_token
-@client.region = 'au1'
-@client.edge = 'sydney'
-```
-
-This will result in the `hostname` transforming from `api.twilio.com` to `api.sydney.au1.twilio.com`.
-
-### Make a Call
-
-```ruby
-@client.calls.create(
-  from: '+14159341234',
-  to: '+16105557069',
-  url: 'http://example.com'
-)
-```
-
 ### Send an SMS
 
 ```ruby
@@ -158,45 +100,15 @@ message_sid = 'SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 
 ### Iterate through records
 
-The library automatically handles paging for you. Collections, such as `calls` and `messages`, have `list` and stream methods that page under the hood. With both `list` and `stream`, you can specify the number of records you want to receive (`limit`) and the maximum size you want each page fetch to be (`page_size`). The library will then handle the task for you.
+The library automatically handles paging for you. Collections, such as `messages`, have `list` and stream methods that page under the hood. With both `list` and `stream`, you can specify the number of records you want to receive (`limit`) and the maximum size you want each page fetch to be (`page_size`). The library will then handle the task for you.
 
 `list` eagerly fetches all records and returns them as a list, whereas `stream` returns an enumerator and lazily retrieves pages of records as you iterate over the collection. You can also page manually using the `page` method.
 
 For more information about these methods, view the [auto-generated library docs](https://www.twilio.com/docs/libraries/reference/twilio-ruby).
 
-```rb
-require 'twilio-ruby'
-
-account_sid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
-auth_token = 'your_auth_token'
-
-@client = Twilio::REST::Client.new(account_sid, auth_token)
-
-@client.calls.list
-       .each do |call|
-         puts call.direction
-       end
-```
-
-### Enable Debug logging
-
-In order to enable debug logging, pass in a 'logger' instance to the client with the level set to at least 'DEBUG'
-
-```ruby
-@client = Twilio::REST::Client.new account_sid, auth_token
-myLogger = Logger.new(STDOUT)
-myLogger.level = Logger::DEBUG
-@client.logger = myLogger
-
-@client = Twilio::REST::Client.new account_sid, auth_token
-myLogger = Logger.new('my_log.log')
-myLogger.level = Logger::DEBUG
-@client.logger = myLogger
-```
-
 ### Handle Exceptions {#exceptions}
 
-If the Twilio API returns a 400 or a 500 level HTTP response, the `twilio-ruby`
+If the Twilio API returns a 400 or a 500 level HTTP response, the `whoosh-ruby`
 library will throw a `Twilio::REST::RestError`. 400-level errors are normal
 during API operation (`“Invalid number”`, `“Cannot deliver SMS to that number”`,
 for example) and should be handled appropriately.
@@ -244,7 +156,7 @@ puts @client.http_client.last_response.status_code
 
 ### Customize your HTTP Client
 
-`twilio-ruby` uses [Faraday][faraday] to make HTTP requests. You can tell `Twilio::REST::Client` to use any of the Faraday adapters like so:
+`whoosh-ruby` uses [Faraday][faraday] to make HTTP requests. You can tell `Twilio::REST::Client` to use any of the Faraday adapters like so:
 
 ```ruby
 @client.http_client.adapter = :typhoeus
@@ -260,86 +172,8 @@ To apply customizations such as middleware, you can use the `configure_connectio
 end
 ```
 
-### Get started With Client Capability Tokens
-
-If you just need to generate a Capability Token for use with Twilio Client, you can do this:
-
-```ruby
-require 'twilio-ruby'
-
-# put your own account credentials here:
-account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
-auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
-
-# set up
-capability = Twilio::JWT::ClientCapability.new account_sid, auth_token
-
-# allow outgoing calls to an application
-outgoing_scope = Twilio::JWT::ClientCapability::OutgoingClientScope.new 'AP11111111111111111111111111111111'
-capability.add_scope(outgoing_scope)
-
-# allow incoming calls to 'andrew'
-incoming_scope = Twilio::JWT::ClientCapability::IncomingClientScope.new 'andrew'
-capability.add_scope(incoming_scope)
-
-# generate the token string
-@token = capability.to_s
-```
-
-There is a slightly more detailed document in the [Capability][capability] section of the wiki.
-
-### Generate TwiML
-
-To control phone calls, your application needs to output [TwiML][twiml].
-
-You can construct a TwiML response like this:
-
-```ruby
-require 'twilio-ruby'
-
-response = Twilio::TwiML::VoiceResponse.new do |r|
-  r.say(message: 'hello there', voice: 'alice')
-  r.dial(caller_id: '+14159992222') do |d|
-    d.client 'jenny'
-  end
-end
-
-# print the result
-puts response.to_s
-```
-
-This will print the following (except for the whitespace):
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<Response>
-  <Say voice="alice">hello there</Say>
-  <Dial callerId="+14159992222">
-    <Client>jenny</Client>
-  </Dial>
-</Response>
-```
-
-## Docker Image
-
-The `Dockerfile` present in this repository and its respective `twilio/twilio-ruby` Docker image are currently used by Twilio for testing purposes only.
-
 ## Getting help
 
-If you need help installing or using the library, please check the [Twilio Support Help Center](https://support.twilio.com) first, and [file a support ticket](https://twilio.com/help/contact) if you don't find an answer to your question.
-
-If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
-
-[apidocs]: https://www.twilio.com/docs/api
-[twiml]: https://www.twilio.com/docs/api/twiml
-[libdocs]: https://www.twilio.com/docs/libraries/reference/twilio-ruby/
-[refdocs]: https://twilio.github.io/twilio-ruby
-[capability]: https://github.com/twilio/twilio-ruby/wiki/JWT-Tokens
-[wiki]: https://github.com/twilio/twilio-ruby/wiki
-[bundler]: https://bundler.io
-[rubygems]: https://rubygems.org
-[gem]: https://rubygems.org/gems/twilio
-[github-actions]: https://github.com/twilio/twilio-ruby/actions/workflows/test-and-deploy.yml
-[upgrade]: https://github.com/twilio/twilio-ruby/wiki/Ruby-Version-5.x-Upgrade-Guide
-[issues]: https://github.com/twilio/twilio-ruby/issues
-[faraday]: https://github.com/lostisland/faraday
+If you've found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
+
+[docs]: https://docs.whoosh.totogidemos.com

data/lib/twilio-ruby/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whoosh-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Totogi
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2023-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -189,7 +189,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.4.2
 description: The official library for communicating with the Whoosh REST API
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -202,6 +202,7 @@ files:
 - ".rubocop_todo.yml"
 - Dockerfile
 - Gemfile
+- LICENSE
 - Makefile
 - README.md
 - Rakefile
@@ -833,7 +834,7 @@ licenses:
 - MIT
 metadata:
   yard.run: yri
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--line-numbers"
 - "--inline-source"
@@ -854,8 +855,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: The official library for communicating with the Whoosh REST API
 test_files: []