sasswillio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1dc88f07f2fb3da77ffae1f287f4e82e5eea22143d78dc937cc8c7dba99ee554
+  data.tar.gz: 9ec23a849d765dbfcdca1d71dc9e6bb9592b5c9f1b416bcf6a5587ac40eabdf6
+SHA512:
+  metadata.gz: 7963585429ee068f8c7fdf5cfcad63f1a48a47d17b18fc010b5dfad47a1c8f2eea77dd97515b1475b7fc0183b17565cd81f7a206fd38909ce9bc21c21f388abf
+  data.tar.gz: 72362e01bfa3754296020f6aa57af308379838f07e7a295522c66453db54f2ce07c0c56f7140a73ef2ff69db88ade859d9085ac6e68fa195dc3ffefc30a8314d

data/lib/sasswillio.rb

@@ -0,0 +1,196 @@
+require 'twilio-ruby'
+# usage 
+# require 'sasswillio'
+# @client = Sasswillio.init
+# nums = Sasswillio.list_sms_enabled_phone_numbers_for(@client)
+# sms_pricing = Sasswillio.get_sms_pricing_for(@client)
+# phone_number_pricing = Sasswillio.get_phone_number_pricing_for(@client)
+# subaccount = Sasswillio.create_subaccount(@client, '423')
+
+module Sasswillio
+
+  def self.get_credentials
+    if ENV['TWILIO_ACCOUNT_SID'] && ENV['TWILIO_ACCOUNT_AUTH_TOKEN']
+      return {
+        sid: ENV['TWILIO_ACCOUNT_SID'],
+        token: ENV['TWILIO_ACCOUNT_AUTH_TOKEN']
+      }
+    else
+      return {
+        sid: 'AC7fbd312e3dbfc2a44499e7ef59d5b303',
+        token: '1df1dbcdac772278cc7091a0584d3858'
+      }
+    end
+  end
+
+  def self.init
+    credentials = Sasswillio.get_credentials
+    begin
+      return Twilio::REST::Client.new credentials[:sid], credentials[:token]
+    rescue Twilio::REST::TwilioError => e
+      return {
+        error: true,
+        errors: [e.message],
+        context: 'client initialization'
+      }
+    end
+  end
+
+  def self.get_sms_pricing_for(twilio_client, country = 'CA')
+    begin
+      return twilio_client.pricing.v1.messaging.countries(country).fetch
+    rescue Twilio::REST::TwilioError => e
+      return {
+        error: true,
+        errors: [e.message],
+        context: 'sms pricing for country'
+      }
+    end
+  end
+
+  def self.get_phone_number_pricing_for(twilio_client, country = 'CA')
+    begin
+      return twilio_client.pricing.v1.phone_numbers.countries(country).fetch
+    rescue Twilio::REST::TwilioError => e
+      return {
+        error: true,
+        errors: [e.message],
+        context: 'monthly cost for local & toll free numbers'
+      }
+    end
+  end
+
+  def self.provision_sms_number_for_subaccount(twilio_client, sid, options)
+    begin
+      return Sasswillio.fetch_subaccount(twilio_client, sid).incoming_phone_numbers.create(
+        phone_number: options[:phone_number],
+        sms_method: 'POST',
+        sms_url: options[:sms_path],
+        status_callback: options[:sms_status_path],
+        status_callback_method: 'POST',
+      )
+    rescue Twilio::REST::TwilioError => e
+      return {
+        error: true,
+        errors: [e.message],
+        context: 'provision sms number for subaccount'
+      }
+    end
+  end
+
+  def self.list_sms_enabled_phone_numbers_for(twilio_client, options = {country_code: 'CA', region: 'ON', contains: '647'})
+    begin
+      numbers = twilio_client.available_phone_numbers(options[:country_code]).local.list(
+        sms_enabled: true,
+        in_region: options[:region],
+        contains: "#{options[:contains]}*******"
+      )
+      return numbers.map{|n| {number: n.phone_number, capabilities: {**n.capabilities.transform_keys(&:to_sym)}}}
+    rescue Twilio::REST::TwilioError => e
+      return {
+        error: true,
+        errors: [e.message],
+        context: 'list sms enable phone numbers'
+      }
+    end
+  end
+
+  def self.create_subaccount(twilio_client, options)
+    begin
+      # save the sid + token and associate it with your Saas user. This will be used to buy phone numbers and send messages on their behalf
+      return twilio_client.api.accounts.create(
+        friendly_name: options[:reference],
+      )
+    rescue Twilio::REST::TwilioError => e
+      return {
+        error: true,
+        errors: [e.message],
+        context: 'create subaccount'
+      }
+    end
+  end
+
+  def self.fetch_subaccount(twilio_client, sid)
+    begin
+      return twilio_client.api.accounts(sid).fetch
+    rescue Twilio::REST::TwilioError => e
+      return {
+        error: true,
+        errors: [e.message],
+        context: 'fetch subaccount'
+      }
+    end
+  end
+
+  def self.suspend_subaccount(twilio_client, sid)
+    # sending and recieving messages is disabled when suspended
+    begin
+      return Sasswillio.fetch_subaccount(twilio_client, sid).update(status: 'suspended')
+    rescue Twilio::REST::TwilioError => e
+      return {
+        error: true,
+        errors: [e.message],
+        context: 'suspend subaccount'
+      }
+    end
+  end
+
+  def self.close_subaccount(twilio_client, sid)
+    # when closed owned numbers are released back to twilio
+    begin
+      return Sasswillio.fetch_subaccount(twilio_client, sid).update(status: 'closed')
+    rescue Twilio::REST::TwilioError => e
+      return {
+        error: true,
+        errors: [e.message],
+        context: 'close subaccount'
+      }
+    end
+  end
+
+  def self.activate_subaccount(twilio_client, sid)
+    # sending and recieving messages is possible when activated
+    begin
+      return Sasswillio.fetch_subaccount(twilio_client, sid).update(status: 'active')
+    rescue Twilio::REST::TwilioError => e
+      return {
+        error: true,
+        errors: [e.message],
+        context: 'activate subaccount'
+      }
+    end
+  end
+    
+  def self.get_subaccount_usage(subaccount_sid, subaccount_token, options)
+    begin
+      sub_account_client = Twilio::REST::Client.new subaccount_sid, subaccount_token
+      return sub_account_client.usage.records.list(
+        category: 'totalprice',
+        start_date: options[:start_date],
+        end_date: options[:end_date]
+      )
+    rescue Twilio::REST::TwilioError => e
+      return {
+        error: true,
+        errors: [e.message],
+        context: 'subaccount usage query'
+      }
+    end
+  end
+
+  def self.send_text_message(twilio_client, body, to_number, from_number = "+15005550006")
+    begin
+      return twilio_client.messages.create(
+        body: body, 
+        to: to_number,
+        from: from_number
+      )
+    rescue Twilio::REST::TwilioError => e
+      return {
+        error: true,
+        errors: [e.message],
+        context: 'send message'
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: sasswillio
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shashike J
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '5.34'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '5.34'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: twilio_mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+description: a simple ruby gem that wraps around the twilio API allowing you to build
+  an SMS enabled SaaS product more erganomically.
+email: shashikejayatunge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sasswillio.rb
+homepage: https://github.com/donrestarone/sasswillio
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: a thin twillio API wrapper
+test_files: []