telnyx 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16c98a1dc79356b27c3c8155c14fd316000665e4316aa528d519c3e14ab12396
+  data.tar.gz: c174b8954c79aae466162c0ce0f3507ec627ca91571f482d962254e03b367548
+SHA512:
+  metadata.gz: b3c9c49a9e5442607f606237cbb03465f311590668457eded220a7516d4a7e1cae0a3d26268d19d656eb7f0b6d94cd48538a2513cb2ce19aeaddd67416e353e7
+  data.tar.gz: 1aaa22d941afd491b3a5be114c0cab65b594a79b0d929f224a701618e53c782dd9a1b0357c2b92faf57198223c4ee20b0dd689b29b8ee77c05ab0b335f86fbf6

data/.gitattributes

@@ -0,0 +1,4 @@
+# may be useful in hiding large schema changes in pull request diffs (but not
+# using it for now)
+spec/*.json binary
+spec/*.yaml binary

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,5 @@
+Please only file issues here that you believe represent actual bugs or feature requests for the Telnyx Ruby library.
+
+If you're having general trouble with your Telnyx integration, please reach out to support using the form at https://support.telnyx.com/ (preferred) or via email to support@telnyx.com.
+
+If you are reporting a bug, please include your Ruby version and the version of the Telnyx Ruby library you're using, as well as any other details that may be helpful in reproducing the problem.

data/.gitignore

@@ -0,0 +1,9 @@
+/telnyx-*.gem
+/Gemfile.lock
+.rvmrc
+Gemfile.lock
+tags
+/.bundle/
+coverage/
+.idea/
+.vscode/

data/.rubocop.yml

@@ -0,0 +1,32 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.0
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Metrics/MethodLength:
+  # There's ~2 long methods in `TelnyxClient`. If we want to truncate those a
+  # little, we could move this to be closer to ~30 (but the default of 10 is
+  # probably too short).
+  Max: 50
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.rubocop_todo.yml

@@ -0,0 +1,50 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-07-19 14:22:24 +0200 using RuboCop version 0.50.0.
+# 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: 19
+Metrics/AbcSize:
+  Max: 52
+
+# Offense count: 27
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 498
+
+# Offense count: 8
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 659
+
+# Offense count: 11
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+# Offense count: 278
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 310
+
+# Offense count: 6
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 7
+
+# Offense count: 5
+Metrics/PerceivedComplexity:
+  Max: 17
+
+# Offense count: 2
+Style/ClassVars:
+  Exclude:
+    - 'lib/telnyx/telnyx_object.rb'
+    - 'test/telnyx/api_resource_test.rb'
+
+# Offense count: 56
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,42 @@
+language: ruby
+
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - jruby-9.0.5.0
+
+notifications:
+  email:
+    on_success: never
+
+sudo: false
+
+env:
+  global:
+    # If changing this number, please also change it in `test/test_helper.rb`.
+    - TELNYX_MOCK_VERSION=0.40.1
+
+cache:
+  directories:
+    - telnyx-mock
+
+before_install:
+  # Install bundler 1.x, because we need to support Ruby 2.1 for now
+  - gem install bundler -v "~> 1.0"
+  # Unpack and start telnyx-mock so that the test suite can talk to it
+  - |
+    if [ ! -d "telnyx-mock/telnyx-mock_${TELNYX_MOCK_VERSION}" ]; then
+      mkdir -p telnyx-mock/telnyx-mock_${TELNYX_MOCK_VERSION}/
+      curl -L "https://github.com/telnyx/telnyx-mock/releases/download/v${TELNYX_MOCK_VERSION}/telnyx-mock_${TELNYX_MOCK_VERSION}_linux_amd64.tar.gz" -o "telnyx-mock/telnyx-mock_${TELNYX_MOCK_VERSION}_linux_amd64.tar.gz"
+      tar -zxf "telnyx-mock/telnyx-mock_${TELNYX_MOCK_VERSION}_linux_amd64.tar.gz" -C "telnyx-mock/telnyx-mock_${TELNYX_MOCK_VERSION}/"
+    fi
+  - |
+    telnyx-mock/telnyx-mock_${TELNYX_MOCK_VERSION}/telnyx-mock > /dev/null &
+    TELNYX_MOCK_PID=$!
+  - export PATH="${PATH}:${PWD}/telnyx-mock/telnyx-mock_${TELNYX_MOCK_VERSION}"
+
+script:
+  - bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# Changelog
+

data/Gemfile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "coveralls", require: false
+  gem "mocha", "~> 0.13.2"
+  gem "rake"
+  gem "shoulda-context"
+  gem "test-unit"
+  gem "timecop"
+  gem "webmock"
+
+  # Rubocop changes pretty quickly: new cops get added and old cops change
+  # names or go into new namespaces. This is a library and we don't have
+  # `Gemfile.lock` checked in, so to prevent good builds from suddenly going
+  # bad, pin to a specific version number here. Try to keep this relatively
+  # up-to-date, but it's not the end of the world if it's not.
+  gem "guard"
+  gem "guard-rake"
+  gem "rubocop", "0.50.0"
+  gem "solargraph"
+
+  # Rack 2.0+ requires Ruby >= 2.2.2 which is problematic for the test suite on
+  # older Ruby versions. Check Ruby the version here and put a maximum
+  # constraint on Rack if necessary.
+  if RUBY_VERSION >= "2.2.2"
+    gem "rack", ">= 2.0.6"
+  else
+    gem "rack", ">= 1.6.11", "< 2.0" # rubocop:disable Bundler/DuplicatedGem
+  end
+
+  platforms :mri do
+    gem "byebug"
+    gem "pry"
+    gem "pry-byebug"
+  end
+end

data/Guardfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+directories(%w[lib test]) \
+  .select { |d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist") }
+
+guard "rake", task: "test" do
+  watch(/.*/)
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2019- Telnyx, Inc. (https://www.telnyx.com)
+Copyright (c) 2011-2019 Stripe, Inc. (https://stripe.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

@@ -0,0 +1,173 @@
+# Telnyx Ruby Library
+
+[![Build Status](https://travis-ci.org/team-telnyx/telnyx-ruby.svg?branch=master)](https://travis-ci.org/telnyx/telnyx-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/team-telnyx/telnyx-ruby/badge.svg?branch=master)](https://coveralls.io/github/telnyx/telnyx-ruby?branch=master)
+
+The Telnyx Ruby library provides convenient access to the Telnyx API from
+applications written in the Ruby language. It includes a pre-defined set of
+classes for API resources that initialize themselves dynamically from API
+responses.
+
+The library also provides other features. For example:
+
+* Easy configuration path for fast setup and use.
+* Helpers for pagination.
+* Tracking of "fresh" values in API resources so that partial updates can be
+  executed.
+* Built-in mechanisms for the serialization of parameters according to the
+  expectations of Telnyx's API.
+
+## Documentation
+
+See the [API docs](https://developers.telnyx.com/docs/v2/overview).
+
+## Installation
+
+You don't need this source code unless you want to modify the gem. If you just
+want to use the package, just run:
+
+    gem install telnyx
+
+If you want to build the gem from source:
+
+    gem build telnyx.gemspec
+
+### Requirements
+
+* Ruby 2.0+.
+
+### Bundler
+
+If you are installing via bundler, you should be sure to use the https rubygems
+source in your Gemfile, as any gems fetched over http could potentially be
+compromised in transit and alter the code of gems fetched securely over https:
+
+``` ruby
+source 'https://rubygems.org'
+
+gem 'telnyx'
+```
+
+## Usage
+
+The library needs to be configured with your account's secret key which is
+available in your [Telnyx Portal][api-keys]. Set `Telnyx.api_key` to its
+value:
+
+``` ruby
+require "telnyx"
+Telnyx.api_key = "super-secret-key"
+
+# list messaging profiles
+Telnyx::MessagingProfile.list()
+
+# retrieve single messaging profile
+Telnyx::MessagingProfile.retrieve("123")
+```
+
+### Configuring a Client
+
+While a default HTTP client is used by default, it's also possible to have the
+library use any client supported by [Faraday][faraday] by initializing a
+`Telnyx::TelnyxClient` object and giving it a connection:
+
+``` ruby
+conn = Faraday.new
+client = Telnyx::TelnyxClient.new(conn)
+connection, resp = client.request do
+  Telnyx::MessagingProfile.retrieve(
+    "123",
+  )
+end
+puts resp.request_id
+```
+
+### Configuring Automatic Retries
+
+The library can be configured to automatically retry requests that fail due to
+an intermittent network problem:
+
+    Telnyx.max_network_retries = 2
+
+### Configuring Timeouts
+
+Open and read timeouts are configurable:
+
+```ruby
+Telnyx.open_timeout = 30 # in seconds
+Telnyx.read_timeout = 80
+```
+
+Please take care to set conservative read timeouts. Some API requests can take
+some time, and a short timeout increases the likelihood of a problem within our
+servers.
+
+### Logging
+
+The library can be configured to emit logging that will give you better insight
+into what it's doing. The `info` logging level is usually most appropriate for
+production use, but `debug` is also available for more verbosity.
+
+There are a few options for enabling it:
+
+1. Set the environment variable `TELNYX_LOG_LEVEL` to the value `debug` or `info`:
+   ```
+   $ export TELNYX_LOG_LEVEL=info
+   ```
+
+2. Set `Telnyx.log_level`:
+   ``` ruby
+   Telnyx.log_level = Telnyx::LEVEL_INFO
+   ```
+
+## Development
+
+The test suite depends on [telnyx-mock], so make sure to fetch and run it from a
+background terminal ([telnyx-mock's README][telnyx-mock] also contains
+instructions for installing via Homebrew and other methods):
+
+    go get -u github.com/telnyx/telnyx-mock
+    telnyx-mock
+
+Run all tests:
+
+    bundle exec rake test
+
+Run a single test suite:
+
+    bundle exec ruby -Ilib/ test/telnyx/util_test.rb
+
+Run a single test:
+
+    bundle exec ruby -Ilib/ test/telnyx/util_test.rb -n /should.convert.names.to.symbols/
+
+Run the linter:
+
+    bundle exec rake rubocop
+
+Run guard:
+
+    bundle exec guard
+
+Update the bundled [telnyx-mock] by editing the version number found in
+`.travis.yml`.
+
+### Adding a new resource
+
+To add a new resource:
+
+1. Add the class for the resource under `lib/telnyx/`.
+2. Require the new class in `lib/telnyx.rb`.
+3. Add the association between `OBJECT_NAME` and class name in the `object_classes` hash in `lib/telnyx/util.rb`.
+4. Add tests to validate the behaviour of the new class.
+
+## Acknowledgements
+
+The contributors and maintainers of Telnyx Ruby would like to extend their deep gratitude to the
+authors of [Stripe Ruby](https://github.com/stripe/stripe-ruby), upon which
+this project is based. Thank you for developing such elegant, usable, extensible code
+and for sharing it with the community.
+
+[api-keys]: https://portal.telnyx.com/#/app/auth/v2
+[faraday]: https://github.com/lostisland/faraday
+[telnyx-mock]: https://github.com/telnyx/telnyx-mock

data/Rakefile

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rake/testtask"
+require "rubocop/rake_task"
+
+task default: %i[test rubocop]
+
+Rake::TestTask.new do |t|
+  t.pattern = "./test/**/*_test.rb"
+end
+
+RuboCop::RakeTask.new
+
+#
+# helpers
+#
+
+def fetch_file(url, dest)
+  ::File.open(dest, "w") do |file|
+    resp = Faraday.get(url)
+    unless resp.status == 200
+      abort("bad response when fetching: #{url}\n" \
+        "Status #{resp.status}: #{resp.body}")
+    end
+    file.write(resp.body)
+    puts "Successfully fetched: #{url}"
+  end
+end