verb-rb 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8bb90c53a78be4172cbe7b83653b962c115f689e
+  data.tar.gz: 53afa05216045bec3b20c17b7f49dac7d7f0f517
+SHA512:
+  metadata.gz: 8a5eab9b5332016b5324a1d57be2fe9223c11bd78eadd033e612950db273067ec651ac578f0988105014444bc5deb9665a71760cc5a55a94128a9b3e92b5117b
+  data.tar.gz: 0144dd4bee086b97a3d7cbaf2131c73dea07ab443f00315533b4b602816f49703fdbace5d4aab494ce64e0c78fe92cc81d3b00670a5e10c12bac948f119044a9

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+.vagrant
+test.rb
+*.gem

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    verb-sh (0.0.1)
+      bundler (~> 1.7)
+      minitest (~> 5.7, >= 5.7.0)
+      rake (~> 10.4, >= 10.4.2)
+      rest-client (~> 2.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    minitest (5.10.3)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  verb-sh!
+
+BUNDLED WITH
+   1.15.4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 craaft.co
+
+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,153 @@
+# verb.sh [Ruby Client]
+
+The official Ruby Client for the [Verb](https://verb.sh) messaging platform.
+
+## Installation
+
+```sh
+gem install verb-rb
+```
+
+#### Requirements
+
+- *[Ruby 2.3.0+](https://www.ruby-lang.org/)*
+
+### Configuration
+
+```ruby
+Verb.configure(token: '<Project API Key>')
+```
+
+The API is non-blocking so you can simply send and forget. The processing happens in the background on a highly efficient queue system.
+
+### Sending Email Messages
+
+```ruby
+msg = Verb.email({
+  to: 'me@me.com', text: 'Email Text', html: 'Email HTML'
+})
+
+msg.send
+```
+
+### Attaching Files
+
+Files can only be attached to email messages (this is also dependent on the service you are using to send the emails). Only pass the path to the file.
+
+```ruby
+msg = Verb.email({
+  to: 'me@me.com', text: 'Email Text', html: 'Email HTML'
+})
+
+msg.attach('file.pdf')
+
+# OR
+
+msg.attach(['file1.pdf', 'file2.pdf'])
+
+# OR
+
+msg.attach('file1.pdf')
+msg.attach('file2.pdf')
+msg.attach('file3.pdf')
+
+msg.send
+
+```
+
+### Restricted File Types:
+
+These file types are generally not allowed and will be blocked.
+
+```
+vbs, exe, bin, bat, chm, com, cpl,
+crt, hlp, hta, inf, ins, isp, jse,
+lnk, mdb, pcd, pif, reg, scr, sct,
+shs, vbe, vba, wsf, wsh, wsl, msc,
+msi, msp, mst
+```
+
+### Scheduling Messages
+
+Verb has a built-in scheduler that allows you schedule messages to be delivered in the future. These are quite useful in the sense that you can target future user behavior or events.
+
+```ruby
+msg = Verb.email({
+  to: 'me@me.com', text: 'Email Text', html: 'Email HTML'
+})
+
+msg.send(in: '1h')
+```
+
+There is no limit to how far in the future a message can be scheduled for. 
+
+Schedule Examples:
+
+- `'1h'    # 1 hour`
+- `'1h20m' # 1 hour 20 minutes`
+- `'3Y2W'  # 3 years 2 weeks`
+
+Available Date Tokens:
+
+- 's' seconds
+- 'h' hours
+- 'm' minutes
+- 'D' days
+- 'M' months
+- 'W' weeks
+- 'Y' years
+
+### Sending SMS Messages
+
+```ruby
+msg = Verb.sms({
+  to: '+20830000000', text: 'SMS Text'
+})
+
+msg.send(in: '1h')
+```
+
+### Re-usable Templates
+
+Templates are a powerful way to add reusable message (SMS / Email) templates on the server side where you can edit content without requiring direct access to source code or perform re-deployments.
+
+Templates are available for the following message types:
+
+- Email Messages
+- SMS Messages
+
+Example: 
+
+```ruby
+msg = Verb.sms({
+  template: 'welcome-sms-template', to: '+20830000000', data: { name: 'My Name', other: 'More data' }
+})
+
+msg.send(in: '20m')
+```
+
+Templates are created in the [Verb](https://verb.sh) admin dashboard using Text, HTML or [Mustache](https://mustache.github.io/). If your template contains variables, you can specify these by adding a `data: {}` field into the parameters list.
+
+### Other API/SDK Methods
+
+The SDK has purposely been kept simple to use in attempt to keep code as minimal as possible. There are however two additional methods that can be used to determine if messages were sent successfully.
+
+```ruby
+puts msg.status  # Integer, the response code from the API
+puts msg.sent?   # Boolean, based on if the message was sent or not
+puts msg.error   # Hash, contains all the error details from the API if a message was not delivered
+```
+
+#### Running the tests
+
+To test the current stable version of verb-sh, simply run:
+
+    rake test
+
+#### License
+
+Please see [LICENSE](https://github.com/apollo-black/verb-ruby/blob/master/LICENSE) for licensing details.
+
+#### Author
+
+Sean Nieuwoudt, [@seannieuwoudt](https://twitter.com/seannieuwoudt)

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/Vagrantfile

@@ -0,0 +1,16 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "apolloblack/ruby"
+  config.vm.box_check_update = false
+  config.vm.synced_folder ".", "/vagrant_data"
+
+  config.vm.provider "virtualbox" do |vb|
+    vb.memory = "1024"
+  end
+
+  config.vm.provision "shell", privileged: false, inline: <<-SHELL
+    ln -s /vagrant_data ~/app
+  SHELL
+end

data/lib/verb.rb

@@ -0,0 +1,159 @@
+require 'rubygems'
+require 'net/http'
+require 'json'
+require 'uri'
+require 'rest_client'
+
+module Verb
+  def self.configure(api_key = nil, debug = false)
+    pieces = api_key.split('-')
+
+    raise ArgumentError, 'The provided API Token is invalid' if pieces.count != 2
+
+    @api_key = api_key
+    @debug = debug
+  end
+
+  def self.email(params = {})
+    Email.new(@api_key, params, @debug)
+  end
+
+  def self.sms(params = {})
+    SMS.new(@api_key, params, @debug)
+  end
+
+  private
+
+  class Message
+    API_URL = ENV['VERB_API'] || 'https://verb.sh/api/v1/message'
+
+    attr_reader :context
+    attr_reader :files
+
+    def initialize(params = {}, debug = false)
+      @context = {}
+      @files = []
+      @context[:tags] = []
+      @debug = debug
+      @api_key = nil
+
+      params.each do |k, v|
+        if k != :api_key
+          @context[k] = v
+        else 
+          @context[:pid] = v.split('-').last # We add the project ID to the ctx
+
+          @api_key = v.split('-').first
+        end
+      end
+    end
+
+    # Attach files to the message (if possible)
+    def attach(files)
+      if @context[:type] == :sms
+        raise 'This message type cannot have file attachments'
+      end
+
+      parsed_files(files).each do |f|
+        @files << f
+      end
+    end
+
+    # Add tags to the internal tag array
+    def tag(tags)
+      if tags.is_a? Array
+        tags.each do |t|
+          @context[:tags] << t
+        end
+      else
+        @context[:tags] << tags
+      end
+    end
+
+    # Send the message to the Verb API
+    def send(args = {})
+      payload = {
+        files: []
+      }
+
+      payload.merge!(args)
+      payload.merge!(@context)
+
+      # Attach Files
+
+      @files.each_with_index do |f, idx|
+        payload[:files] << File.open(f)
+      end
+
+      log(payload)
+
+      begin
+        RestClient.post API_URL, payload, {
+          'x-api-key': @api_key
+        }
+      rescue RestClient::ExceptionWithResponse => e
+        e.response
+      end
+    end
+
+    private
+
+    # Parse the files and return an array of files that exist
+    def parsed_files(files)
+      buffer = []
+
+      if files.kind_of?(Array)
+        files.each do |f|
+          buffer << canonical_path(f)
+        end
+      else
+        buffer << canonical_path(files)
+      end
+
+      buffer.compact
+    end
+
+    # Ensure that we get the path to the file instead of the File objects
+    def canonical_path(f)
+      buffer = nil
+
+      if f.kind_of?(String)
+        if File.exist?(f)
+          buffer = f
+        end
+      end
+
+      if f.kind_of?(File)
+        buffer = f.path
+      end
+
+      buffer
+    end
+
+    # Perform the message logging
+    def log(s)
+      if @debug
+        require 'logger'
+        Logger.new(STDOUT).debug(s)
+      end
+    end
+  end
+
+  public
+
+  class Email < Message
+    def initialize(api_key, params = {}, debug = false)
+      params[:api_key] = api_key
+      params[:type] = :email
+      super(params, debug)
+    end
+  end
+
+  class SMS < Message
+    def initialize(api_key, params = {}, debug = false)
+      params[:api_key] = api_key
+      params[:type] = :sms
+      super(params, debug)
+    end
+  end
+end

data/test/test_verb.rb

@@ -0,0 +1,7 @@
+require 'minitest/autorun'
+require '../lib/verb'
+
+class VerbTest < Minitest::Test
+  def setup
+  end
+end

data/verb-sh.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = 'verb-rb'
+  s.version     = '1.0.1'
+  s.date        = Time.now.strftime('%Y-%m-%e').to_s
+  s.summary     = 'A simple messaging API for web and mobile applications'
+  s.description = 'Verb gives you a simple & consistent way to send messages from web and mobile applications using any backing services'
+  s.authors     = ['Sean Nieuwoudt']
+  s.email       = 'hi@verb.sh'
+  s.files       = `git ls-files -z`.split("\x0")
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/apollo-black/verb-ruby'
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'minitest', '~> 5.7'
+  s.add_runtime_dependency 'rake', '~> 10.4'
+  s.add_runtime_dependency 'bundler', '~> 1.7'
+  s.add_runtime_dependency 'rest-client', '~> 2.0'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: verb-rb
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Sean Nieuwoudt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Verb gives you a simple & consistent way to send messages from web and
+  mobile applications using any backing services
+email: hi@verb.sh
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- Vagrantfile
+- lib/verb.rb
+- test/test_verb.rb
+- verb-sh.gemspec
+homepage: https://github.com/apollo-black/verb-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A simple messaging API for web and mobile applications
+test_files: []