send_sonar 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 476f08ec59419ef64eacb5231bb79ebcb295b75f
-  data.tar.gz: 4b88361e84d2fe3b96779dd831315deb3baa4c58
+  metadata.gz: bac118203bd847590ed9e476d8a925e11a5e62e6
+  data.tar.gz: 1de02c5eae8e19502632dfc4ff8fd7b73cdb91e1
 SHA512:
-  metadata.gz: a5d67356fb0e828950c788a4ffdc7665559473caee492b647c60b49650a5bb9b0cb6c3b408b0d8ecf609d98057f204f91bde47a3f601e3559d703c37ed045e93
-  data.tar.gz: ab3a82a0ac0e0eea7ff9d4aeb45ff1b77c844cba244f4641c10eac6f676da405c2b37e5145ba10f5998aae4da6a2612e4655d50a7ff537e35cc9db9367146156
+  metadata.gz: 94d13650e4fc278ba73b6677ace1a8dbbfa874c857a0991c7abde7caf2edad629a6bee84cecc77217c38f93fa7fbd896bb6e635dc7113bc60ad292f76be21751
+  data.tar.gz: b721dff6b9620be05daa6eeccb319509f6a249e05fe149717abadd1a7772debea94cb19f3bc2e24d86c7d017bbe11436260fdf4be3eb5a97627937052aa4a90f

data/.travis.yml

@@ -1,9 +1,6 @@
 language: ruby
-matrix:
-  include:
-    - rvm: "2.1.3"
-      gemfile: Gemfile
-    - rvm: "1.9.3"
-      gemfile: Gemfile
-    - rvm: "1.8.7"
-      gemfile: Gemfile.ruby-18
+before_install: gem install bundler
+rvm:
+  - "2.4.2"
+  - "2.2.8"
+  - "2.0.0"

data/README.md

@@ -1,8 +1,5 @@
 [![Build Status](https://travis-ci.org/sendsonar/send_sonar_gem.svg)](https://travis-ci.org/sendsonar/send_sonar_gem)
 
-# Upgrading from SimpleDesk Gem
-Be sure to change your initializer and API calls from `SimpleDesk` to `SendSonar`.
-
 # SendSonar
 
 [Sonar](https://www.sendsonar.com) is an SMS customer engagement platform that allows companies to have 2-way conversations with their customers over SMS - whether it's for sales, customer service, funnel abandonment, or transactional messages.
@@ -20,21 +17,22 @@ And then execute:
     $ bundle
 
 ## Compatibility
-Works with Ruby 1.8.7 or greater
+Works with Ruby 2.0.0 or greater
 
 ## Changes
 See RELEASE.md
 
-* Configuration is now done through an initializer
-* Support for sandbox server
-* When creating a customer, properties is no longer a separate param (see readme)
+* Ruby 2.0.0 or greater is now required
+* Included `publishable_key` in configuration
+* Added support for 5 new API endpoints
+* `add_customer` has been aliased to `add_update_customer`
 
 
 ## Setup
 Initialize the gem by creating an initializer.
 
-* Your production token can be found at https://www.sendsonar.com/api_info.
-* Your sandbox token can be found at https://sandbox.sendsonar.com/api_info
+* Your production token can be found if you log into https://sendsonar.com, click the left menu and select Settings, then Company Settings
+* Your sandbox token can be found if you log into or sign up at https://sandbox.sendsonar.com/, click on the left menu and select Settings, then Company Settings
 
 ```ruby
 # config/initializers/send_sonar.rb
@@ -43,61 +41,138 @@ SendSonar.configure do |config|
   if Rails.env.production?
     config.env = :live
     config.token = ENV['SONAR_PRODUCTION_TOKEN'] || 'YOUR_PRODUCTION_TOKEN'
+    config.publishable_key = ENV['SONAR_PRODUCTION_PUBLISHABLE_KEY'] || 'YOUR_PRODUCTION_PUBLISHABLE_KEY'
 
   elsif Rails.env.staging?
     config.env = :sandbox
-    config.token = ENV['SONAR_SANDBOX_TOKEN'] || 'YOUR_PRODUCTION_TOKEN'
+    config.token = ENV['SONAR_SANDBOX_TOKEN'] || 'YOUR_SANDBOX_TOKEN'
+    config.publishable_key = ENV['SONAR_SANDBOX_PUBLISHABLE_KEY'] || 'YOUR_SANDBOX_PUBLISHABLE_KEY'
   end
 end
 ```
 
-
-
 ## Usage
+The gem offers connections to the following API endpoints:
+  * [Send Message](#send-message "Send Message")
+  * [Add / Update Customer](#add--update-customer "Add Update Customer")
+  * [Send Campaign](#send-campaign "Send Campaign")
+  * [Delete Customer Property](#delete-customer-property "Delete Customer Property")
+  * [Close Customer](#close-customer "Close Customer")
+  * [Get Customer](#get-customer "Get Customer")
+  * [Available Phone Number](#available-phone-number "Available Phone Number")
 
-The API currently allows sending messages and adding customers.
+**Note:** Please include a country code for phone numbers (such as +1 for US) in all API calls to us.
 
-**Sending Messages**
+### [Send Message](http://docs.sendsonar.com/docs/send-message)
+---
+[Visit Documentation](http://docs.sendsonar.com/docs/send-message)
 
 ```ruby
-SendSonar.message_customer(text: 'message text', to: '1234567890')
+SendSonar.message_customer(
+  text: 'message text',
+  to: '+12234567890',
+  tag_names: ["attribution"],
+  media_url: "http://where_the_pics_live.com/the_bermanator.png"
+)
 ```
-The response is a `SendSonar::Message` object with the following accessors:
-
-  * to (phone number as string)
-  * text
-  * status
-
-Status is one of "queued" or "unsubscribed". Messages with "queued" status are usually sent within seconds. Messages with "unsubscribed" status will not be sent, as customer has previously unsubscribed from API messages.
 
-If you send a message to a new phone number the API will automatically create a new user.
+The response is a `SendSonar::Message` object with accessors for the parameters listed in the [documentation](http://docs.sendsonar.com/docs/send-message).
 
-#<Sonar::Message to="1234567890", text="content!", status="queued">
+Important Notes:
+  1. If you send a message to a new phone number the API will automatically create a new user.
+  2. We prevent companies from sending the exact same message to customers within 7 seconds to prevent spamming and to preserve the great SMS experience.
+  3. In the response, "status" will either be "queued" or "unsubscribed". A "queued" status is a successful response, and means that the message should be sent within seconds. An "unsubscribed" status means that the message will not be sent, as the customer has previously unsubscribed from messages from your business.
 
-**Adding Customers**
-
-If a customer already exists with the given phone number, that customer will be updated.
+### [Add / Update Customer](http://docs.sendsonar.com/docs/addupdate-customer)
+---
+[Visit Documentation](http://docs.sendsonar.com/docs/addupdate-customer)
 
 ```ruby
-SendSonar.add_customer(
+SendSonar.add_update_customer(
   phone_number: "5555555555",
   email: "user@example.com",
   first_name: "john",
   last_name: "doe",
+  picture_url: "http://where_the_pics_live.com/the_bermanator.png",
   properties: { great_customer: "true" }
 )
 ```
-You can send an unlimited number of properties with arbitrary keys and values.
 
-The response is a `SendSonar::Customer` object with the following accessors:
+Important Notes:
+  1. You can send an unlimited number of properties with arbitrary keys and values.
+  2. If a customer already exists with the given phone number, that customer will be updated.
+  3. The old `add_customer` method continues to work but was aliased to `add_update_customer` for clarity.
+
+The response is a `SendSonar::Customer` object with accessors for the parameters listed in the [documentation](http://docs.sendsonar.com/docs/addupdate-customer).
+
+### [Send Campaign](http://docs.sendsonar.com/docs/send-campaign)
+---
+[Visit Documentation](http://docs.sendsonar.com/docs/send-campaign)
+
+```ruby
+SendSonar.send_campaign(
+  to: "+15555555555",
+  campaign_id: "XXXXXXXX_XXXX_XXXX"
+)
+```
+
+The response is a `SendSonar::Response` object with accessors for the parameters listed in the [documentation](http://docs.sendsonar.com/docs/send-campaign).
+
+### [Delete Customer Property](http://docs.sendsonar.com/docs/delete-customer-pro---perties)
+
+[Visit Documentation](http://docs.sendsonar.com/docs/delete-customer-properties)
+
+```ruby
+SendSonar.delete_customer_property(
+  phone_number: "+15555555555",
+  property_name: "delete_me"
+)
+```
+
+The customer's `email` can be used instead of `phone_number`, so the following is also valid:
+
+```ruby
+SendSonar.delete_customer_property(
+  email: "user@example.com",
+  property_name: "delete_me"
+)
+```
+
+The response is a `SendSonar::Response` object with accessors for the parameters listed in the [documentation](http://docs.sendsonar.com/docs/delete-customer-properties)
+
+### [Close Customer](http://docs.sendsonar.com/docs/close-customer)
+---
+[Visit Documentation](http://docs.sendsonar.com/docs/close-customer)
+
+```ruby
+SendSonar.close_customer(
+  phone_number: "+15555555555"
+)
+```
+
+The response is a `SendSonar::Response` object with accessors for the parameters listed in the [documentation](http://docs.sendsonar.com/docs/close-customer)
+
+### [Get Customer](http://docs.sendsonar.com/docs/get-customer)
+---
+[Visit Documentation](http://docs.sendsonar.com/docs/get-customer)
+
+```ruby
+SendSonar.get_customer(
+  phone_number: "+15555555555"
+)
+```
+
+The response is a `SendSonar::Customer` object with accessors for the parameters listed in the [documentation](http://docs.sendsonar.com/docs/get-customer)
+
+### [Available Phone Number](http://docs.sendsonar.com/docs/available-phone-number)
+---
+[Visit Documentation](http://docs.sendsonar.com/docs/available-phone-number)
+
+```ruby
+SendSonar.available_phone_number
+```
 
-  * id
-  * phone_number (string)
-  * email
-  * first_name
-  * last_name
-  * subscribed (boolean)
-  * properties (hash)
+The response is a `SendSonar::Response` object with accessors for the parameters listed in the [documentation](http://docs.sendsonar.com/docs/available-phone-number)
 
 ## Errors
 There are many reasons why requests can fail. There are custom error classes to help you figure out what went wrong.
@@ -105,6 +180,7 @@ There are many reasons why requests can fail. There are custom error classes to
 Note, all request errors inherit from `SendSonar::RequestException`. Therefore you can rescue all request errors with `rescue SendSonar::RequestException`. The current supported error classes are:
 
   * SendSonar::BadToken
+  * SendSonar::TokenOrPublishableKeyNotFound
   * SendSonar::NoActiveSubscription
   * SendSonar::ApiDisabledForCompany
   * SendSonar::RequestTimeout

data/RELEASE.md

@@ -1,37 +1,44 @@
+v 2.0.0
+-------
+* Ruby 2.0.0 or greater is now required
+* Included `publishable_key` in configuration
+* Added support for 5 new API endpoints (`send_campaign`, `close_customer`, `delete_customer_property`, `get_customer`, and `available_phone_number`)
+* `add_customer` has been aliased to `add_update_customer`
+
 v 1.1.0
 -------
-Added invalid phone number error and tests for it.
+* Added invalid phone number error and tests for it.
 
 v 1.0.9
 -------
-Temporary solution giving more information about why a request failed.
+* Temporary solution giving more information about why a request failed.
 
 v 1.0.0
 -------
-Configuration is now done through an initializer
-Support for sandbox server
-When creating a customer, properties is no longer a separate param (see readme)
+* Configuration is now done through an initializer
+* Support for sandbox server
+* When creating a customer, properties is no longer a separate param (see readme)
 
 v 0.3.4
 -------
-Added ability to send properties
+* Added ability to send properties
 
 v 0.3.3
 -------
-Remove item from to do list in readme
+* Remove item from to do list in readme
 
 v 0.3.2
 -------
-Restructure readme
+* Restructure readme
 
 v 0.3.1
 -------
-Update the readme to note the dynamic token assignment
+* Update the readme to note the dynamic token assignment
 
 v 0.3.0
 -------
-Make dynamic for API token
+* Make dynamic for API token
 
 v 0.2.0
 -------
-Add documentation
+* Add documentation

data/lib/send_sonar.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'send_sonar/version'
 require 'send_sonar/configuration'
 require 'send_sonar/exceptions'
@@ -14,22 +13,57 @@ module SendSonar
     yield @config ||= Configuration.new
   end
 
-  def add_customer(params)
+  def add_customer params
     resp = Client.post url_for(:customers), params, headers
     Customer.new(JSON.parse(resp))
   end
 
-  def message_customer(params)
+  alias_method :add_update_customer, :add_customer
+
+  def message_customer params
     resp = Client.post url_for(:messages), params, headers
     Message.new(JSON.parse(resp))
   end
 
+  def send_campaign params
+    resp = Client.post url_for(:campaigns), params, headers
+    Response.new(JSON.parse(resp))
+  end
+
+  def close_customer params
+    resp = Client.post url_for(:close_customer), params, headers
+    Response.new(JSON.parse(resp))
+  end
+
+  def delete_customer_property params
+    resp = Client.delete url_for(:delete_customer_property), params, headers
+    Response.new(JSON.parse(resp))
+  end
+
+  def get_customer params
+    query = params.merge({ :token => config.token })
+    # RestClient forms the GET query string from the params field of the header
+    # Set the query hash above to the params field of the header hash below
+    resp = Client.get url_for(:customers), { params: query }
+    Customer.new(JSON.parse(resp))
+  end
+
+  def available_phone_number
+    keys_in_header = { :publishable_key => true, :token => false }
+    resp = Client.get url_for(:available_phone_number), headers(keys_in_header)
+    Response.new(JSON.parse(resp))
+  end
+
   private
 
   attr_reader :config
 
-  def headers
-    { :token => config.token, :client => "rubygem #{SendSonar::VERSION}" }
+  def headers include_headers={}
+    include_headers = include_headers.merge({:token => true}) unless include_headers.key? :token
+    headers = { :client => "rubygem #{SendSonar::VERSION}" }
+    headers = headers.merge({ :token => config.token }) if include_headers[:token]
+    headers = headers.merge({ :x_publishable_key => config.publishable_key }) if include_headers[:publishable_key]
+    headers
   end
 
   def url_for(key)

data/lib/send_sonar/client.rb

@@ -1,26 +1,40 @@
 module SendSonar
   module Client
+
     def self.post(url, payload, headers={}, &block)
-      RestClient::Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers, &block)
-
-    rescue Errno::ECONNREFUSED => e
-      raise ConnectionRefused.new(e)
-
-    rescue RestClient::RequestTimeout => e
-      raise RequestTimeout.new(e)
-
-    rescue RestClient::Exception => e
-      if e.http_code == 400
-        raise BadRequest.new(e)
-      else
-        response = e.response && JSON.parse(e.response) || {}
-        error = response["error"]
-        if exception_class = Exceptions::EXCEPTIONS_MAP[error]
-          raise exception_class.new(e)
+      execute_with_exceptions { RestClient::Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers, &block) }
+    end
+
+    def self.delete(url, payload, headers={}, &block)
+      execute_with_exceptions { RestClient::Request.execute(:method => :delete, :url => url, :payload => payload, :headers => headers, &block) }
+    end
+
+    def self.get(url, headers={}, &block)
+      execute_with_exceptions { RestClient::Request.execute(:method => :get, :url => url, :headers => headers, &block) }
+    end
+
+    def self.execute_with_exceptions
+      yield
+
+      rescue Errno::ECONNREFUSED => e
+        raise ConnectionRefused.new(e)
+
+      rescue RestClient::RequestTimeout => e
+        raise RequestTimeout.new(e)
+
+      rescue RestClient::Exception => e
+        if e.http_code == 400
+          raise BadRequest.new(e)
         else
-          raise "SONAR ERROR: #{e.response} - #{e.message}"
+          response = e.response && JSON.parse(e.response) || {}
+          error = response["error"]
+          if exception_class = Exceptions::EXCEPTIONS_MAP[error]
+            raise exception_class.new(e)
+          else
+            raise "SONAR ERROR: #{e.response} - #{e.message}"
+          end
         end
-      end
     end
+
   end
 end

data/lib/send_sonar/configuration.rb

@@ -5,7 +5,7 @@ module SendSonar
     ENV_URLS = YAML.load_file(File.expand_path('../endpoints.yml', __FILE__))
     ALLOWED_ENVS = ENV_URLS.keys
 
-    attr_writer :token
+    attr_writer :token, :publishable_key
 
     def env
       @env || :sandbox
@@ -15,6 +15,10 @@ module SendSonar
       @token || raise(SendSonar::ConfigurationError.new('You need to set your token, see SendSonar Readme'))
     end
 
+    def publishable_key
+      @publishable_key || raise(SendSonar::ConfigurationError.new('You need to set your publishable key, see SendSonar Readme'))
+    end
+
     def env=(env_sym)
       if ALLOWED_ENVS.include?(env_sym.to_s)
         @env = env_sym.to_s

data/lib/send_sonar/endpoints.yml

@@ -1,15 +1,31 @@
 local:
   messages: http://localhost:3000/api/v1/messages
   customers: http://localhost:3000/api/v1/customers
+  campaigns: http://localhost:3000/api/v1/campaigns
+  close_customer: http://localhost:3000/api/v1/customers/close
+  delete_customer_property: http://localhost:3000/api/v1/customers/properties
+  available_phone_number: http://localhost:3000/api/v1/phone_numbers/available
 
 staging:
   messages: https://staging.sendsonar.com/api/v1/messages
   customers: https://staging.sendsonar.com/api/v1/customers
+  campaigns: https://staging.sendsonar.com/api/v1/campaigns
+  close_customer: https://staging.sendsonar.com/api/v1/customers/close
+  delete_customer_property: https://staging.sendsonar.com/api/v1/customers/properties
+  available_phone_number: https://staging.sendsonar.com/api/v1/phone_numbers/available
 
 sandbox:
   messages: https://sandbox.sendsonar.com/api/v1/messages
   customers: https://sandbox.sendsonar.com/api/v1/customers
+  campaigns: https://sandbox.sendsonar.com/api/v1/campaigns
+  close_customer: https://sandbox.sendsonar.com/api/v1/customers/close
+  delete_customer_property: https://sandbox.sendsonar.com/api/v1/customers/properties
+  available_phone_number: https://sandbox.sendsonar.com/api/v1/phone_numbers/available
 
 live:
   messages: https://www.sendsonar.com/api/v1/messages
   customers: https://www.sendsonar.com/api/v1/customers
+  campaigns: https://www.sendsonar.com/api/v1/campaigns
+  close_customer: https://www.sendsonar.com/api/v1/customers/close
+  delete_customer_property: https://www.sendsonar.com/api/v1/customers/properties
+  available_phone_number: https://www.sendsonar.com/api/v1/phone_numbers/available