delighted 2.0.0 → 2.1.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b2ab9c1649cd662512a80f7259a1058563dd3d2fa1dcd3d00f8b1839d83db3d
-  data.tar.gz: d5d610d96c21c25886c1b2b9d48a6194ebd86dd3ad31d098bbc89cb753e9843c
+  metadata.gz: 3ce86b0edf1b9df5dab8e46ba0fc4213c6c14667b7a4fe28d441e03fbf1b747e
+  data.tar.gz: 9eee58a5c861c75a0e7b33e6aacf54648da80fd8969ebeadac75e1d418fb95dc
 SHA512:
-  metadata.gz: 36f4c851d012b0938cb61ce6df3d134921a058527bf9167b7d91c46da52015ca81e6c7e76fe2b7a2a6ddcce46616fa5ad1dcfa6b0bcccc077d3fe5ef85993121
-  data.tar.gz: 23529a8c285db0c0f477af3cc9a3d624747cadafa55ffb8a575d890bf25ee3293bdc60368138f977779d4055d414c3eaf90700e96243c8d07a3d68c5e3bdb471
+  metadata.gz: f759a34fe7d102ae00aa9e1b048cdebc9c5731c3fad3bd502af77db8e16b311d4782465a5a47d4885c883435e930433b24b4972676cd72ecf85f5f37b954f1f8
+  data.tar.gz: cc905c3739263c36fdf92ccf62407c814721828e70ae50e36d1d7e79218abb58fbfd73209b21b56585c553915e86db53dfab54e17bcfa407c146ed4fa630b903

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 2.1.0rc1 (unreleased)
+
+Features:
+
+- Add `Delighted::AutopilotConfiguration.retrieve`
+- Add `Delighted::AutopilotMembership.list`
+- Add `Delighted::AutopilotMembership.create`
+- Add `Delighted::AutopilotMembership.delete`
+
+Compatibility changes:
+
+- Replace deprecated `URI::regexp` with `URI::DEFAULT_PARSER.make_regexp`
+
 ## 2.0.0 (2020-03-18)
 
 Features:

data/README.md

@@ -171,6 +171,80 @@ filtered_survey_responses = Delighted::SurveyResponse.all(:page => 5,
   :until => Time.utc(2013, 11, 01))
 ```
 
+Getting Autopilot state:
+
+```ruby
+email_autopilot_state = Delighted::AutopilotConfiguration.retrieve("email")
+sms_autopilot_state = Delighted::AutopilotConfiguration.retrieve("sms")
+```
+
+Listing Autopilot members:
+
+```ruby
+email_autopilot_members = Delighted::AutopilotMembership::Email.list
+begin
+  email_autopilot_members.auto_paging_each do |membership|
+    # Do something with membership
+  end
+rescue Delighted::RateLimitError => e
+  # Indicates how long to wait before making this request again
+  e.retry_after
+  retry
+end
+
+# For convenience, this method can use a sleep to automatically handle rate limits
+email_autopilot_members.auto_paging_each({ auto_handle_rate_limits: true }) do |membership|
+  # Do something with membership
+end
+```
+
+Look up specific Autopilot member:
+
+```ruby
+Delighted::AutopilotMembership::Email
+  .list(person_email: "foo+test1@delighted.com") # or person_id or person_phone_number
+  .auto_paging_each({ auto_handle_rate_limits: true }) do |membership|
+    # Do something with membership. If no membership for this person exists, 
+    # this block will never be called.
+end
+```
+
+Add a person to Autopilot:
+
+```ruby
+props = {
+  "Shoe Type" => "Sneaker",
+  "Handedness" => "Left"
+}
+result = Delighted::AutopilotMembership::Email.create(
+  person_email: "foo+test1@delighted.com", 
+  properties: props
+)
+```
+
+Update a person in Autopilot:
+
+```ruby
+props = {
+  "Shoe Type" => "Sandal",
+  "Handedness" => "Left"
+}
+result = Delighted::AutopilotMembership::Email.create(
+  person_email: "foo+test1@delighted.com", 
+  properties: props
+)
+```
+
+Remove a person from Autopilot:
+
+```ruby
+result = Delighted::AutopilotMembership::Sms.delete(
+  person_phone_number: "+15555551212"
+)
+
+result = Delighted::AutopilotMembership::Sms.delete(person_id: "433523")
+```
+
 Retrieving metrics:
 
 ```ruby

data/lib/delighted.rb

@@ -26,6 +26,9 @@ require 'delighted/resources/survey_request'
 require 'delighted/resources/survey_response'
 require 'delighted/resources/unsubscribe'
 
+require 'delighted/resources/autopilot_configuration'
+require 'delighted/resources/autopilot_membership'
+
 require 'delighted/errors'
 require 'delighted/http_response'
 require 'delighted/http_adapter'

data/lib/delighted/client.rb

@@ -87,7 +87,7 @@ module Delighted
     end
 
     def is_full_url(url)
-      !!(URI::regexp(%w(http https)) =~ url)
+      !!(URI::DEFAULT_PARSER.make_regexp(%w(http https)) =~ url)
     end
   end
 end

data/lib/delighted/resources/autopilot_configuration.rb

@@ -0,0 +1,7 @@
+module Delighted
+  class AutopilotConfiguration < Resource
+    self.path = "/autopilot"
+
+    include Operations::Retrieve
+  end
+end

data/lib/delighted/resources/autopilot_membership.rb

@@ -0,0 +1,28 @@
+module Delighted
+  class AutopilotMembership < Resource
+    # This is a class purely so that Sms and Email share a common semantic base class
+
+    class << self
+      def delete(person_id_hash, client = Delighted.shared_client)
+        json = client.delete_json(path, person_id_hash)
+        json.merge(:person => Person.new(json[:person]))
+      end
+    end
+
+    class Sms < AutopilotMembership
+      self.path = "/autopilot/sms/memberships"
+      self.expandable_attributes = { :person => Person, :next_survey_request => SurveyRequest }
+
+      include Operations::List
+      include Operations::Create
+    end
+
+    class Email < AutopilotMembership
+      self.path = "/autopilot/email/memberships"
+      self.expandable_attributes = { :person => Person, :next_survey_request => SurveyRequest }
+
+      include Operations::List
+      include Operations::Create
+    end
+  end
+end

data/lib/delighted/version.rb

@@ -1,3 +1,3 @@
 module Delighted
-  VERSION = "2.0.0"
+  VERSION = "2.1.0rc1"
 end

data/test/delighted_test.rb

@@ -387,3 +387,211 @@ class Delighted::BouncesTest < Delighted::TestCase
   end
 end
 
+class Delighted::AutopilotConfigurationsTest < Delighted::TestCase
+  def test_getting_sms_autopilot_configuration
+    uri = URI.parse("https://api.delightedapp.com/v1/autopilot/sms")
+    headers = { 'Authorization' => @auth_header, "Accept" => "application/json", 'User-Agent' => "Delighted RubyGem #{Delighted::VERSION}" }
+    response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ :platform_id => 'sms', :active => true, :frequency => 7776000, :created_at => 1611253998, :updated_at => 1618421598 }))
+    mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
+
+    configuration = Delighted::AutopilotConfiguration.retrieve('sms')
+    assert_kind_of Delighted::AutopilotConfiguration, configuration
+    assert_equal({ :platform_id => 'sms', :active => true, :frequency => 7776000, :created_at => 1611253998, :updated_at => 1618421598 }, configuration.to_hash)
+    assert_equal 'sms', configuration.platform_id
+    assert_equal true, configuration.active
+    assert_equal 7776000, configuration.frequency
+    assert_equal 1611253998, configuration.created_at
+    assert_equal 1618421598, configuration.updated_at
+  end
+end
+
+class Delighted::AutopilotMembershipsTest < Delighted::TestCase
+  def test_listing_autopilot_memberships
+    first_membership = {
+      :created_at => 1611253998,
+      :updated_at => 1618421598,
+      :person => {
+        :id => "34",
+        :name => "Leslie",
+        :email => "leslie@example.com",
+        :created_at => 1611365037,
+        :phone_number => "+1555555112",
+        :last_sent_at => nil
+      },
+      :next_survey_request => {
+        :id => "42",
+        :created_at => 1614043237,
+        :survey_scheduled_at => 1620087437,
+        :properties => { :"Purchase Experience" => "Web", :"State" => "OR" }
+      }
+    }
+    second_membership = {
+      :created_at => 1611243998,
+      :updated_at => 1618420598,
+      :person => {
+        :id => "42",
+        :name => "Taylor",
+        :email => "taylor@example.com",
+        :created_at => 1611242998,
+        :phone_number => "+1555551212",
+        :last_sent_at => 1611242998
+      },
+      :next_survey_request => {
+        :id => "3445",
+        :created_at => 1614043437,
+        :survey_scheduled_at => 1620087837,
+        :properties => { :"Purchase Experience" => "Mobile", :"State" => "CA" }
+      }
+    }
+    third_membership = {
+      :created_at => 1611143998,
+      :updated_at => 1618320598,
+      :person => {
+        :id => "47",
+        :name => "Casey",
+        :email => "casey@example.com",
+        :created_at => 1610242998,
+        :phone_number => "+1555551234",
+        :last_sent_at => 1610242998
+      },
+      :next_survey_request => {
+        :id => "3449",
+        :created_at => 1614063437,
+        :survey_scheduled_at => 1620097837,
+        :properties => { :"Purchase Experience" => "Store", :"State" => "WA" }
+      }
+    }
+    uri = URI.parse("https://api.delightedapp.com/v1/autopilot/sms/memberships")
+    uri_next = URI.parse("https://api.delightedapp.com/v1/autopilot/sms/memberships?page_info=123456789")
+    headers = { "Authorization" => @auth_header, "Accept" => "application/json", "User-Agent" => "Delighted RubyGem #{Delighted::VERSION}" }
+
+    # First request mock
+    response = Delighted::HTTPResponse.new(200, {"Link" => "<#{uri_next}>; rel=\"next\""}, Delighted::JSON.dump([first_membership, second_membership]))
+    mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
+
+    # Next request mock
+    response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump([third_membership]))
+    mock_http_adapter.expects(:request).with(:get, uri_next, headers).once.returns(response)
+
+    memberships = []
+    Delighted::AutopilotMembership::Sms.list.auto_paging_each do |membership|
+      memberships << membership
+    end
+
+    assert_equal 3, memberships.size
+    assert_kind_of Delighted::AutopilotMembership::Sms, memberships[0]
+    assert_kind_of Delighted::Person, memberships[0].person
+    assert_kind_of Delighted::SurveyRequest, memberships[0].next_survey_request
+    assert_equal 1611253998, memberships[0].created_at
+    assert_equal "34", memberships[0].person.id
+    assert_nil memberships[0].person.last_sent_at
+    assert_equal first_membership[:person].reject { |k,_| k == :id }, memberships[0].person.to_hash
+    assert_equal "+1555555112", memberships[0].person.phone_number
+    assert_equal 1620087437, memberships[0].next_survey_request.survey_scheduled_at
+    assert_equal first_membership[:next_survey_request][:properties], memberships[0].next_survey_request.properties
+    assert_kind_of Delighted::AutopilotMembership, memberships[1]
+    assert_equal 1611242998, memberships[1].person.last_sent_at
+  end
+
+  def test_listing_specific_autopilot_memberships
+    specific_membership = {
+      :created_at => 1611253998,
+      :updated_at => 1618421598,
+      :person => {
+        :id => "34",
+        :name => "Leslie",
+        :email => "leslie@example.com",
+        :created_at => 1611365037,
+        :phone_number => "+1555555112",
+        :last_sent_at => nil
+      },
+      :next_survey_request => {
+        :id => "42",
+        :created_at => 1614043237,
+        :survey_scheduled_at => 1620087437,
+        :properties => {
+          :"Purchase Experience" => "Web",
+          :"State" => "OR"
+        }
+      }
+    }
+    uri = URI.parse("https://api.delightedapp.com/v1/autopilot/sms/memberships?person_id=34")
+    headers = { "Authorization" => @auth_header, "Accept" => "application/json", "User-Agent" => "Delighted RubyGem #{Delighted::VERSION}" }
+    response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump([specific_membership]))
+    mock_http_adapter.expects(:request).with(:get, uri, headers).once.returns(response)
+
+    memberships = []
+    Delighted::AutopilotMembership::Sms.list(person_id: 34).auto_paging_each do |membership|
+      memberships << membership
+    end
+
+    assert_equal 1, memberships.size
+    assert_kind_of Delighted::AutopilotMembership::Sms, memberships[0]
+    assert_kind_of Delighted::Person, memberships[0].person
+    assert_kind_of Delighted::SurveyRequest, memberships[0].next_survey_request
+    assert_equal 1, memberships.size
+  end
+
+  def test_adding_autopilot_membership
+    params = {
+      person_email: "leslie@example.com",
+      person_name: "Leslie",
+      properties: {
+        :"Purchase Experience" => "Web",
+        :"State" => "OR"
+      }
+    }
+    uri = URI.parse("https://api.delightedapp.com/v1/autopilot/email/memberships")
+    headers = { "Authorization" => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', "User-Agent" => "Delighted RubyGem #{Delighted::VERSION}" }
+    response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ person: { id: "333", name: params[:person_name], email: params[:person_email] }, properties: params[:properties] }))
+    mock_http_adapter.expects(:request).with(:post, uri, headers, Delighted::JSON.dump(params)).once.returns(response)
+
+    result = Delighted::AutopilotMembership::Email.create(params)
+
+    assert_kind_of Delighted::AutopilotMembership::Email, result
+    assert_kind_of Delighted::Person, result.person
+    assert_equal params[:properties], result.properties
+    assert_equal params[:person_email], result.person.email
+    assert_equal params[:person_name], result.person.name
+    assert result.person.id
+    assert_equal params[:properties], result.properties
+  end
+
+  def test_updating_autopilot_membership
+    params = {
+      person_id: "333",
+      properties: {
+        :"Purchase Experience" => "Web",
+        :"State" => "OR"
+      }
+    }
+    uri = URI.parse("https://api.delightedapp.com/v1/autopilot/sms/memberships")
+    headers = { "Authorization" => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', "User-Agent" => "Delighted RubyGem #{Delighted::VERSION}" }
+    response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ person: { id: "333", name: "Leslie", email: "leslie@example.com", phone_numer: "+15555551212" }, properties: params[:properties] }))
+    mock_http_adapter.expects(:request).with(:post, uri, headers, Delighted::JSON.dump(params)).once.returns(response)
+
+    result = Delighted::AutopilotMembership::Sms.create(params)
+
+    assert_kind_of Delighted::AutopilotMembership::Sms, result
+    assert_kind_of Delighted::Person, result.person
+    assert_equal params[:properties], result.properties
+    assert_equal "leslie@example.com", result.person.email
+    assert_equal "Leslie", result.person.name
+    assert_equal "333", result.person.id
+    assert_equal params[:properties], result.properties
+  end
+
+  def test_removing_autopilot_membership
+    uri = URI.parse("https://api.delightedapp.com/v1/autopilot/sms/memberships")
+    headers = { "Authorization" => @auth_header, "Accept" => "application/json", 'Content-Type' => 'application/json', "User-Agent" => "Delighted RubyGem #{Delighted::VERSION}" }
+    response = Delighted::HTTPResponse.new(200, {}, Delighted::JSON.dump({ person: { id: "333", name: "Leslie", email: "leslie@example.com"} }))
+    mock_http_adapter.expects(:request).with(:delete, uri, headers, Delighted::JSON.dump({person_id: "455"})).once.returns(response)
+
+    result = Delighted::AutopilotMembership::Sms.delete(:person_id => "455")
+
+    assert_kind_of Hash, result
+    assert_equal "leslie@example.com", result[:person].email
+    assert_equal "Leslie", result[:person].name
+    assert_equal "333", result[:person].id
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delighted
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0rc1
 platform: ruby
 authors:
 - Mark Dodwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2021-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -96,6 +96,8 @@ files:
 - lib/delighted/operations/retrieve.rb
 - lib/delighted/operations/update.rb
 - lib/delighted/resource.rb
+- lib/delighted/resources/autopilot_configuration.rb
+- lib/delighted/resources/autopilot_membership.rb
 - lib/delighted/resources/bounce.rb
 - lib/delighted/resources/metrics.rb
 - lib/delighted/resources/person.rb
@@ -122,11 +124,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Delighted is the fastest and easiest way to gather actionable feedback from