send_with_us 1.10.2 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5021ab6ee37c8f3b1d4be8ab74cfbfe91b20c173
-  data.tar.gz: abc9a8e4320ff642bc7c468e4b5523d111926359
+  metadata.gz: e0648a9da5af356483eb9a6ca360af1e0a6c93e1
+  data.tar.gz: 4f4541298cc6e6bdb25381b59c723242c6909d4a
 SHA512:
-  metadata.gz: 26fde0be9902431e523a578ecae187fc0b5ee1c86fcc63a498f213000ca045b79abc392bf53de57d8e8ad25c3a20bbfee82e838e9be63050c63a9da9aac56f30
-  data.tar.gz: 9f662b934c66196d03b31b451b4c6335eac3122ba1e94ea267b0f164967cb8db4c6c7286093259f4bb45650f27f7c30ddf33cd011ae21a60f8c1d9d4e8f9519f
+  metadata.gz: 37e8146dc953959ed5d1271894150be499a2fabbc8f5cf7e2b2c1bfd49a0f1e4c5d8f35d80ebe5ceaae52d4f08473538a996654f754c8325e5395b201134d677
+  data.tar.gz: 38ad2b4a9707127d48c3f7beba1f57dc2e1c550477fb80545111aafd2d26e64d8671e29e50e86b4464c5e15b6e0358eb07ca316333bc02f8fdf3ae7434ddb6b9

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+1.11.0 - add template create/update methods as well as group create/update methods
 1.10.2 - include render parameter on locale
 1.10.1 - tag support, error base class, logs method
 1.9.0 - Locale support.  Introduce send\_email().  Deprecate send\_with().

data/README.md

@@ -225,7 +225,7 @@ rescue => e
 end
 ```
 
-### Using Drips 2.0
+### Using Drip Campaigns
 
 ```ruby
 require 'rubygems'
@@ -269,6 +269,18 @@ 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)
+```
+
 ### Customer Conversion Event
 You can use the Conversion API to track conversion and revenue data events against your sent emails
 
@@ -282,6 +294,52 @@ obj.customer_conversion('customer@example.com', 10050)
 obj.customer_conversion('customer@example.com')
 ```
 
+## Templates
+
+```ruby
+
+# List Templates
+obj.list\_templates() # Alternatively, obj.emails()
+
+# Create Template
+obj.create\_template(name, subject, html, text)
+
+# Delete Template
+obj.delete\_template(template\_id)
+
+# List Template Versions
+obj.list\_template\_versions(template\_id)
+
+# Update Template Version
+obj.update\_template\_version(template\_id, version\_id, name, subject, html, text)
+
+# Create Template Version
+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_group(group_id)
+
+```
+
 ## Rails
 
 For a Rails app, create `send_with_us.rb` in `/config/initializers/`

data/lib/send_with_us/api.rb

@@ -149,6 +149,8 @@ module SendWithUs
       SendWithUs::ApiRequest.new(@configuration).get(:emails)
     end
 
+    alias list_templates emails
+
     def render(template_id, version_id = nil, template_data = {})
       locale = template_data.delete(:locale)
 
@@ -255,8 +257,20 @@ module SendWithUs
       SendWithUs::ApiRequest.new(@configuration).post(endpoint, payload)
     end
 
-    def customer_delete(email)
-      endpoint = "customers/#{email}"
+    def customer_delete(email_address)
+      endpoint = "customers/#{email_address}"
+      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()
+      endpoint = "customers/#{email_address})/groups/#{group_id}"
       SendWithUs::ApiRequest.new(@configuration).delete(endpoint)
     end
 
@@ -285,5 +299,74 @@ module SendWithUs
 
       SendWithUs::ApiRequest.new(@configuration).get(endpoint)
     end
+
+    def delete_template(template_id)
+      endpoint = "templates/#{template_id}"
+      SendWithUs::ApiRequest.new(@configuration).delete(endpoint)
+    end
+
+    def list_template_versions(template_id)
+      endpoint = "templates/#{template_id}/versions"
+      SendWithUs::ApiRequest.new(@configuration).get(endpoint)
+    end
+
+    def get_template_version(template_id, version_id)
+      endpoint = "templates/#{template_id}/versions/#{version_id}"
+      SendWithUs::ApiRequest.new(@configuration).get(endpoint)
+    end
+
+    def update_template_version(template_id, version_id, name, subject, html, text)
+      payload = {
+        name: name,
+        subject: subject,
+        html: html,
+        text: text
+      }
+
+      endpoint = "templates/#{template_id}/versions/#{version_id}"
+      SendWithUs::ApiRequest.new(@configuration).put(endpoint, payload.to_json)
+    end
+
+    def create_template_version(template_id, name, subject, html, text)
+      payload = {
+        name: name,
+        subject: subject,
+        html: html,
+        text: text
+      }
+
+      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/api_request.rb

@@ -26,6 +26,11 @@ module SendWithUs
       request(Net::HTTP::Delete, request_path(endpoint))
     end
 
+    def put(endpoint, payload)
+      request(Net::HTTP::Put, request_path(endpoint), payload)
+    end
+
+
     private
 
       def request_path(end_point)

data/lib/send_with_us/version.rb

@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '1.10.2'
+  VERSION = '1.11.0'
 end

data/test/lib/send_with_us/api_request_test.rb

@@ -7,8 +7,25 @@ class TestApiRequest < Minitest::Test
     @api = SendWithUs::Api.new( api_key: 'THIS_IS_A_TEST_API_KEY', debug: false)
     @config  = SendWithUs::Config.new( api_version: '1_0', api_key: 'THIS_IS_A_TEST_API_KEY', debug: false )
     @request = SendWithUs::ApiRequest.new(@config)
-    @drip_campaign = { :drip_campaign_id => 'dc_Rmd7y5oUJ3tn86sPJ8ESCk', :drip_campaign_step_id => 'dcs_yaAMiZNWCLAEGw7GLjBuGY' }
-    @customer = { :email => "steve@sendwithus.com" }
+    @drip_campaign = {
+      :drip_campaign_id => 'dc_Rmd7y5oUJ3tn86sPJ8ESCk',
+      :drip_campaign_step_id => 'dcs_yaAMiZNWCLAEGw7GLjBuGY'
+    }
+    @customer = { :email => 'steve@sendwithus.com',
+                  :groups => ['grp_wnCdAjBWGeBGDUzNwGiTKc']
+                }
+    @template = {
+      :html => '<html><head></head><body>TEST</body></html>',
+      :subject  => 'A test template',
+      :name => 'Test Template',
+      :id => 'test_fixture_1'
+    }
+  end
+
+  def get_first_template_version_id(template_id)
+    templates = @api.list_template_versions(template_id)
+    version = JSON.parse(templates.body)[0]["id"]
+    return version
   end
 
   def test_payload
@@ -57,9 +74,8 @@ class TestApiRequest < Minitest::Test
 
   def test_send_with_with_attachment
     build_objects
-    email_id = 'test_fixture_1'
     result = @api.send_with(
-      email_id,
+      @template[:id],
       {name: 'Ruby Unit Test', address: 'matt@example.com'},
       {data: 'I AM DATA'},
       {name: 'sendwithus', address: 'matt@example.com'},
@@ -183,6 +199,55 @@ class TestApiRequest < Minitest::Test
     assert_instance_of( Net::HTTPOK, result )
   end
 
+  def test_list_template_versions
+    build_objects
+    result = @api.list_template_versions(@template[:id])
+
+    assert_instance_of( Net::HTTPOK, result )
+  end
+
+  def test_update_template_version
+    build_objects
+    version_id = get_first_template_version_id(@template[:id])
+
+    result = @api.update_template_version(
+      @template[:id],
+      version_id,
+      @template[:name],
+      @template[:subject],
+      @template[:html],
+      ''
+    )
+
+    assert_instance_of( Net::HTTPOK, result )
+  end
+
+  def test_create_template_version
+    build_objects
+    result = @api.create_template_version(
+      @template[:id],
+      @template[:name],
+      @template[:subject],
+      @template[:html],
+      ''
+    )
+
+    assert_instance_of( Net::HTTPOK, result )
+  end
+
+  def test_delete_template
+    build_objects
+    template = JSON.parse @api.create_template(
+      "test create",
+      "test subject",
+      @template[:html],
+      ''
+    ).body
+
+    result = @api.delete_template(template["id"])
+    assert_instance_of( Net::HTTPOK, result )
+  end
+
   def test_emails
     build_objects
     Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
@@ -236,34 +301,78 @@ class TestApiRequest < Minitest::Test
     assert_equal( true, @request.send(:request_path, :send) == '/api/v1_0/send' )
   end
 
-  def test_add_user_event()
+  def test_add_user_event
     build_objects
     Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
     assert_instance_of( Net::HTTPSuccess, @request.post(:'customers/test@sendwithus.com/conversions', @payload))
   end
 
-  def test_conversion_event()
+  def test_conversion_event
     build_objects
     Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
     assert_instance_of( Net::HTTPSuccess, @request.post(:'customers/test@sendwithus.com/conversions', @payload))
   end
 
-  def test_customer_create()
+  def test_customer_create
     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))
   end
 
-  def test_customer_delete()
+  def test_customer_delete
     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]}'))
   end
 
-  def test_logs_with_options()
+  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.10.2
+  version: 1.11.0
 platform: ruby
 authors:
 - Matt Harris
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: SendWithUs.com Ruby Client