twizo 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0c45a74332fda987fc6aa8aae79d0aae5b0eb2a
+  data.tar.gz: 40e1ddc80715533d0389df0a905067e496f854b5
+SHA512:
+  metadata.gz: d5cdd29be65081bafc79656905c741b1506f0d71a6c3dfe82387267c11b7151c2f89433074af3c455af32da6a164b979f03b51f4defb52bbb74faab836504e4c
+  data.tar.gz: f4a459eb0bbb4ba040a7716083ca4481a0bfbdfe37968f64130e013cb9a9cf185f29b90a0afa84b93d6b22183b81b45a5c7d00ef5244d8adecf6f89674ff407d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test/credentials.rb
+/examples/credentials.rb

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in twizo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Twizo
+
+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,126 @@
+![Twizo](https://www.twizo.com/wp-content/themes/twizo/_/images/twizo-logo-0474ce6f.png) 
+
+# Twizo Ruby API
+
+Connect to the Twizo API using the Ruby library. This API includes functions to send verifications (2FA), SMS and Number Lookup.
+
+## Requirements ##
+* Ruby >= ???
+
+## Get application secret and api host ##
+To use the Twizo API client, the following things are required:
+
+* Create a [Twizo account](https://register.twizo.com/)
+* Login on the Twizo portal
+* Find your [application](https://portal.twizo.com/applications/) secret
+* Find your nearest api [node](https://www.twizo.com/developers/documentation/#introduction_api-url)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twizo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twizo
+
+## Usage
+
+Require the Twizo gem first:
+
+```ruby
+require 'twizo'
+```
+
+Initializing the Twizo Api using your api secret and api host
+
+```ruby
+twizo = Twizo::Twizo.new('api_key', 'api_host')
+```
+
+
+Create a verification
+
+```ruby
+verification = twizo.create_verification('610123456789')
+verification = verification.send
+```
+
+Verify token
+
+```ruby
+begin
+  verify_token = twizo.verify_token(verification.messageId, '12345')
+  puts verify_token
+rescue Twizo::TwizoException => e
+  puts e.body
+end
+```
+
+
+Create a number lookup, you can specify a single number or multiple numbers 
+in an array.
+
+```ruby
+number_lookup = twizo.create_number_lookup('610123456789')
+number_lookup = number_lookup.send
+```
+
+Create an sms, you can specify a single recipient or multiple recipients 
+in an array.
+
+```ruby
+sms = twizo.create_sms('body', '610123456789', 'Sender')
+sms = sms.send_simple
+```
+
+When you want to configure the dcs or udh, simply use sms.send. For more information about sending concatenated messages, visit https://www.twizo.com/developers/tutorials/#concat.
+
+
+Create a widget
+
+```ruby
+widget = twizo.create_widget('610123456789')
+widget = widget.send
+```
+
+Get the status of a widget
+
+```ruby
+status = twizo.get_widget_status(widget.sessionToken, widget.recipient)
+```
+
+
+## Examples
+In the examples directory you can find a collection of cli examples of how to use the api. When first running an example you will be asked for a host name and secret; this will be written to a credentials file.
+
+## Testing
+In the test directory you can find a collection of tests. When first running a test you will be asked for a host name and secret; this will be written to a credentials file.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. `bin/setup` requires the bundler gem to be installed. You can do this by running `gem install bundler` in the console.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/twizoapi/lib-api-ruby. 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.
+
+You can also contact support@silverstreet.com for issues.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Twizo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/twizo/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "twizo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/backup_codes.rb

@@ -0,0 +1,31 @@
+require_relative 'examples_init'
+
+=begin
+
+ This file is part of the Twizo php api
+
+ (c) Twizo <info@twizo.com>
+
+ For the full copyright and license information, please view the LICENSE
+ File that was distributed with this source code.
+
+=end
+
+twizo = Twizo::Twizo.new(API_KEY, API_HOST)
+
+print 'Enter number: '
+number = gets.chomp
+
+backup_code = twizo.create_backup_codes(number)
+
+begin
+
+  backup_code = backup_code.send
+
+rescue Twizo::TwizoError => e
+
+  puts "#{e}: #{e.body}"
+
+end
+
+puts backup_code.inspect

data/examples/backup_codes_check.rb

@@ -0,0 +1,29 @@
+require_relative 'examples_init'
+
+=begin
+
+ This file is part of the Twizo php api
+
+ (c) Twizo <info@twizo.com>
+
+ For the full copyright and license information, please view the LICENSE
+ File that was distributed with this source code.
+
+=end
+
+twizo = Twizo::Twizo.new(API_KEY, API_HOST)
+
+print 'Enter identifier: '
+identifier = gets.chomp
+
+begin
+
+  check = twizo.get_backup_code(identifier)
+
+rescue Twizo::TwizoError => e
+
+  puts "#{e}: #{e.body}"
+
+end
+
+puts check.inspect

data/examples/backup_codes_delete.rb

@@ -0,0 +1,31 @@
+require_relative 'examples_init'
+
+=begin
+
+ This file is part of the Twizo php api
+
+ (c) Twizo <info@twizo.com>
+
+ For the full copyright and license information, please view the LICENSE
+ File that was distributed with this source code.
+
+=end
+
+twizo = Twizo::Twizo.new(API_KEY, API_HOST)
+
+print 'Enter identifier: '
+identifier = gets.chomp
+
+backup_code = twizo.create_backup_codes(identifier)
+
+begin
+
+  backup_code = backup_code.delete
+
+rescue Twizo::TwizoError => e
+
+  puts "#{e}: #{e.body}"
+
+end
+
+puts 'success' if backup_code.code == '204'

data/examples/backup_codes_update.rb

@@ -0,0 +1,31 @@
+require_relative 'examples_init'
+
+=begin
+
+ This file is part of the Twizo php api
+
+ (c) Twizo <info@twizo.com>
+
+ For the full copyright and license information, please view the LICENSE
+ File that was distributed with this source code.
+
+=end
+
+twizo = Twizo::Twizo.new(API_KEY, API_HOST)
+
+print 'Enter identifier: '
+identifier = gets.chomp
+
+backup_code = twizo.create_backup_codes(identifier)
+
+begin
+
+  backup_code = backup_code.update
+
+rescue Twizo::TwizoError => e
+
+  puts "#{e}: #{e.body}"
+
+end
+
+puts backup_code.inspect

data/examples/backup_codes_verify.rb

@@ -0,0 +1,34 @@
+require_relative 'examples_init'
+
+=begin
+
+ This file is part of the Twizo php api
+
+ (c) Twizo <info@twizo.com>
+
+ For the full copyright and license information, please view the LICENSE
+ File that was distributed with this source code.
+
+=end
+
+twizo = Twizo::Twizo.new(API_KEY, API_HOST)
+
+print 'Enter identifier: '
+identifier = gets.chomp
+
+print 'Enter backup code: '
+code = gets.chomp
+
+backup_code = twizo.create_backup_codes(identifier)
+
+begin
+
+  backup_code = backup_code.verify(code)
+
+rescue Twizo::TwizoError => e
+
+  puts "#{e}: #{e.body}"
+
+end
+
+puts backup_code.inspect

data/examples/balance.rb

@@ -0,0 +1,18 @@
+require_relative 'examples_init'
+
+=begin
+
+ This file is part of the Twizo php api
+
+ (c) Twizo <info@twizo.com>
+
+ For the full copyright and license information, please view the LICENSE
+ File that was distributed with this source code.
+
+=end
+
+twizo = Twizo::Twizo.new(API_KEY, API_HOST)
+
+balance = twizo.get_balance
+
+puts balance.inspect

data/examples/examples_init.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+require 'twizo'
+
+=begin
+
+ Run examples from the comman line
+ -> ruby foo.rb
+
+ This file is part of the Twizo php api
+
+ (c) Twizo <info@twizo.com>
+
+ For the full copyright and license information, please view the LICENSE
+ File that was distributed with this source code.
+
+=end
+
+class ExamplesInit
+
+  def load_config
+    filename = 'credentials.rb'
+
+    unless File.exist?("#{File.dirname(__FILE__)}/#{filename}")
+      print 'Enter api key: '
+      api_key = gets.chomp
+
+      print 'Enter api host: '
+      api_host = gets.chomp
+
+      file = File.new("#{File.dirname(__FILE__)}/#{filename}", 'w')
+      file.puts("API_KEY = '#{api_key}'")
+      file.puts("API_HOST = '#{api_host}'")
+      file.close
+    end
+
+    require_relative filename
+  end
+
+end
+
+examples = ExamplesInit.new
+examples.load_config

data/examples/number_lookup.rb

@@ -0,0 +1,32 @@
+require_relative 'examples_init'
+
+=begin
+
+ This file is part of the Twizo php api
+
+ (c) Twizo <info@twizo.com>
+
+ For the full copyright and license information, please view the LICENSE
+ File that was distributed with this source code.
+
+=end
+
+twizo = Twizo::Twizo.new(API_KEY, API_HOST)
+
+print 'Enter number: '
+number = gets.chomp
+
+number_lookup = twizo.create_number_lookup(number)
+number_lookup.params.result_type = Twizo::NumberLookup::RESULT_TYPE_POLL
+
+begin
+
+  number_lookup = number_lookup.send
+
+rescue Twizo::TwizoError => e
+
+  puts "#{e}: #{e.body}"
+
+end
+
+puts number_lookup.inspect