send_with_us 1.13.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd68ba634d4a5e56d9191ea1d8db8180cf47aa79
-  data.tar.gz: 5cea81fa62102ca3698e846c4ea00aef8d3e1230
+  metadata.gz: 3c84fc4a3e66e9b6695c0a3511271dc310216955
+  data.tar.gz: 1708ead51ac8402101d7109cab68b2b98fa9687f
 SHA512:
-  metadata.gz: c6df92e12c6d1d3191fe042d8d18d115c38722084ad7125684e925fd5f4cbccd2eadecbb216a674d5de03a5de80e32e1356d3ce6b739970172fcb8d32d918c14
-  data.tar.gz: 715b5bf40c68b413141012c82b0f70e0ba5333345289cb7aed64c2c4de51a886f158c48d30eb11b98dc6bcc74df57a8a46c4090446a8be31e57b7d1b0c6dcd53
+  metadata.gz: de2168223aa09f4b9f3229946262a44ffb288c94263936115910c131849f54f1700f7bbd537a54617047e73046e6c8d09b20a9f8dfa2d272a0f669ce5d80bdc4
+  data.tar.gz: 67d28bd38f57e27ea39b92dd99959798517ed1159f7714ec00a2e814cf93fe19b5a835ab9e6832e34afe34f302f13bff49baab78d31e5a1dfd78be6943beb5b6

data/.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,28 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+<!--- Describe your changes in detail if necessary -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style of this project.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+2.0.0 - Deprecate Customer Groups API
 1.13.0 - Add support to get customer details
 1.12.0 - Customer logs endpoint added and optional parameters for logs fixed when no options sent
 1.11.5 - Added tags to drip campaign activations

data/README.md

@@ -283,18 +283,6 @@ result = obj.customer_create("visha@example.com", customer_data)
 result = obj.customer_delete("visha@example.com")
 ```
 
-### Add customer to group
-
-```ruby
-obj.customer_add_to_group(email_address, group_id)
-```
-
-### Remove customer from group
-
-```ruby
-obj.customer_remove_from_group(email_address, group_id)
-```
-
 ### Get logs for customer
 This will retrieve email logs for a customer.
 
@@ -346,26 +334,6 @@ obj.create_template_version(template_id, name, subject, html, text)
 ```
 
 
-## Groups
-
-Groups are another way to "tag" customers in sendwithus. They can be thought of as lists.
-
-
-```ruby
-# List groups
-obj.get_groups()
-
-# Create group
-obj.create_customer_group(name, description)
-
-# Update group
-obj.update_customer_group(group_id, new_name, new_description)
-
-# Delete group
-obj.delete_customer_group(group_id)
-
-```
-
 ## Rails
 
 For a Rails app, create `send_with_us.rb` in `/config/initializers/`
@@ -389,7 +357,7 @@ rescue => e
 end
 ```
 
-Take a look at our Mailer that you can use to replace ActionMailer
+Take a look at our Mailer that you can use similarly to ActionMailer
 
 [sendwithus_ruby_action_mailer](https://github.com/sendwithus/sendwithus_ruby_action_mailer)
 
@@ -420,6 +388,43 @@ SendWithUs::ApiConnectionRefused - the target URI is probably incorrect
 SendWithUs::ApiUnknownError - an unhandled HTTP error occurred
 ```
 
+## Running tests
+Use [rake](https://github.com/ruby/rake) to run the tests:
+
+```sh
+$: rake
+```
+
+## Troubleshooting
+
+### General Troubleshooting
+
+-   Enable debug mode
+-   Make sure you're using the latest Ruby client
+-   Capture the response data and check your logs — often this will have the exact error
+
+### Enable Debug Mode
+
+Debug mode prints out the underlying request information as well as the data payload that gets sent to sendwithus. You will most likely find this information in your logs. To enable it, simply put `debug: true` as a parameter when instantiating the API object. Use the debug mode to compare the data payload getting sent to [sendwithus' API docs](https://www.sendwithus.com/docs/api "Official Sendwithus API Docs").
+
+```php
+obj = SendWithUs::Api.new( api_key: 'YOUR API KEY', debug: true )
+```
+
+### Response Ranges
+
+Sendwithus' API typically sends responses back in these ranges:
+
+-   2xx – Successful Request
+-   4xx – Failed Request (Client error)
+-   5xx – Failed Request (Server error)
+
+If you're receiving an error in the 400 response range follow these steps:
+
+-   Double check the data and ID's getting passed to Sendwithus
+-   Ensure your API key is correct
+-   Log and check the body of the response
+
 
 ## Internal
 Build gem with

data/lib/send_with_us/api.rb

@@ -252,12 +252,11 @@ module SendWithUs
       SendWithUs::ApiRequest.new(@configuration).get("customers/#{email}")
     end
 
-    def customer_create(email, data = {}, locale = nil, groups = [])
+    def customer_create(email, data = {}, locale = nil)
       payload = {email: email}
 
       payload[:data] = data if data && data.any?
       payload[:locale] = locale if locale
-      payload[:groups] = groups if groups && groups.any?
 
       payload = payload.to_json
       endpoint = "customers"
@@ -269,18 +268,6 @@ module SendWithUs
       SendWithUs::ApiRequest.new(@configuration).delete(endpoint)
     end
 
-    def customer_add_to_group(email_address, group_id)
-      payload = nil
-
-      endpoint = "customers/#{email_address}/groups/#{group_id}"
-      SendWithUs::ApiRequest.new(@configuration).post(endpoint, payload)
-    end
-
-    def customer_remove_from_group(email_address, group_id)
-      endpoint = "customers/#{email_address}/groups/#{group_id}"
-      SendWithUs::ApiRequest.new(@configuration).delete(endpoint)
-    end
-
     def customer_email_log(email_address, options = {})
       endpoint = "customers/#{email_address}/logs"
       params   = {}
@@ -360,35 +347,5 @@ module SendWithUs
       endpoint = "templates/#{template_id}/versions"
       SendWithUs::ApiRequest.new(@configuration).post(endpoint, payload.to_json)
     end
-
-    def get_groups()
-      endpoint = "groups"
-      SendWithUs::ApiRequest.new(@configuration).get(endpoint)
-    end
-
-    def create_customer_group(name, description = '')
-      payload = {
-        name: name,
-        description: description
-      }
-
-      endpoint = "groups"
-      SendWithUs::ApiRequest.new(@configuration).post(endpoint, payload.to_json)
-    end
-
-    def update_customer_group(group_id, name = '', description = '')
-      payload = {
-        name: name,
-        description: description
-      }
-
-      endpoint = "groups/#{group_id}"
-      SendWithUs::ApiRequest.new(@configuration).put(endpoint, payload.to_json)
-    end
-
-    def delete_customer_group(group_id)
-      endpoint = "groups/#{group_id}"
-      SendWithUs::ApiRequest.new(@configuration).delete(endpoint)
-    end
   end
 end

data/lib/send_with_us/version.rb

@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '1.13.0'
+  VERSION = '2.0.0'
 end

data/test/lib/send_with_us/api_request_test.rb

@@ -11,9 +11,9 @@ class TestApiRequest < Minitest::Test
       :drip_campaign_id => 'dc_Rmd7y5oUJ3tn86sPJ8ESCk',
       :drip_campaign_step_id => 'dcs_yaAMiZNWCLAEGw7GLjBuGY'
     }
-    @customer = { :email => 'steve@sendwithus.com',
-                  :groups => ['grp_wnCdAjBWGeBGDUzNwGiTKc']
-                }
+    @customer = {
+      :email => 'steve@sendwithus.com'
+    }
     @template = {
       :html => '<html><head></head><body>TEST</body></html>',
       :subject  => 'A test template',
@@ -325,54 +325,9 @@ class TestApiRequest < Minitest::Test
     assert_instance_of( Net::HTTPSuccess, @request.delete(:'customers/#{@customer[:email]}'))
   end
 
-  def test_customer_add_to_group
-    build_objects
-    Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
-    assert_instance_of( Net::HTTPSuccess, @request.post(:"customers/#{@customer[:email]})/groups/#{@customer[:email][0]}", @customer))
-  end
-
-  def test_customer_remove_from_group
-    build_objects
-    Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
-    assert_instance_of( Net::HTTPSuccess, @request.delete(:"customers/#{@customer[:email]})/groups/#{@customer[:email][0]}"))
-  end
-
   def test_logs_with_options
     build_objects
     Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
     assert_instance_of( Net::HTTPSuccess, @request.get(:'logs?count=2&offset=10'))
   end
-
-  def test_get_groups
-    build_objects
-    result = @api.get_groups()
-
-    assert_instance_of( Net::HTTPOK, result )
-  end
-
-  def test_create_customer_group
-    build_objects
-    result = @api.create_customer_group('testing')
-    result_id = JSON.parse(result.body)["group"]["id"]
-
-    # clean up
-    @api.delete_customer_group(result_id)
-
-    assert_instance_of( Net::HTTPOK, result )
-  end
-
-  def test_update_customer_group
-    build_objects
-    result = @api.update_customer_group(@customer[:groups][0], 'test')
-    assert_instance_of( Net::HTTPOK, result )
-  end
-
-  def delete_customer_group
-    build_objects
-    new_group =  @api.create_customer_group('deleteme')
-    new_group_id = JSON.parse(new_group.body)["group"]["id"]
-    result = @api.delete_customer_group(new_group_id)
-
-    assert_instance_of( Net::HTTPOK, result )
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: send_with_us
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Matt Harris
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2017-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -64,6 +64,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE"
+- ".github/PULL_REQUEST_TEMPLATE"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md