Merge pull request #77 from sailthru/simplify-push-content

Simplify push content and support updating by custom key

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.2.0
+  - added save_content supporting all fields from updated api
+  - push_content is now deprecated in favour of save_content
+
 ## 4.1.0
   - added get_last_rate_limit_info method call
 

README.md

@@ -5,3 +5,7 @@ An [API client library](https://getstarted.sailthru.com/developers/api-client/li
 For installation instructions, documentation, and examples please visit:
 [https://getstarted.sailthru.com/developers/api-client/ruby/](https://getstarted.sailthru.com/developers/api-client/ruby/)
 
+## Running tests
+
+1. `bundle install`
+2. `bundle exec rake test`

lib/sailthru/client.rb

@@ -235,10 +235,10 @@ def change_email(new_email, old_email, options = {})
       data[:change_email] = old_email
       api_post(:email, data)
     end
-  
+
     # returns:
     #   Hash of response data.
-    # 
+    #
     # Get all templates
     def get_templates(templates = {})
       api_get(:template, templates)
@@ -468,6 +468,7 @@ def stats_send(template = nil, start_date = nil, end_date = nil, options = {})
       api_get(:stats, data)
     end
 
+    # <b>DEPRECATED:</b> Please use save_content
     # params
     #   title, String
     #   url, String
@@ -497,6 +498,21 @@ def push_content(title, url, date = nil, tags = nil, vars = {}, options = {})
       api_post(:content, data)
     end
 
+    # params
+    #   id, String – An identifier for the item (by default, the item’s URL).
+    #   options, Hash - Containing any of the parameters described on
+    #                     https://getstarted.sailthru.com/developers/api/content/#POST_Mode
+    #
+    # Push a new piece of content to Sailthru, triggering any applicable alerts.
+    # http://docs.sailthru.com/api/content
+    def save_content(id, options)
+      data = options
+      data[:id] = id
+      data[:tags] = data[:tags].join(',') if data[:tags].respond_to?(:join)
+
+      api_post(:content, data)
+    end
+
     # params
     #   list, String
     #

lib/sailthru/version.rb

@@ -1,3 +1,3 @@
 module Sailthru
-  VERSION = '4.1.0'
+  VERSION = '4.2.0'
 end

test/sailthru/content_test.rb

@@ -10,27 +10,167 @@ class ContentTest < Minitest::Test
       @api_call_url = sailthru_api_call_url(api_url, 'content')
     end
 
-    it "can push content with title, url, *array* tags and vars" do
-      title = 'unix is awesome'
-      url = 'http://example.com/hello-world'
-      date = nil
-      tags = ['unix', 'linux']
-      vars = {:price => 55, :description => 'Hello World'}
-      stub_post(@api_call_url, 'content_valid.json')
-      response = @sailthru_client.push_content(title, url, date = nil, tags = tags, vars = vars)
-      refute_nil response['content']
-    end
+    describe '#save_content' do
+      describe 'creating a content' do
+        before do
+          id = 'http://example.com/hello-world'
+          options = {
+            keys: {
+              sku: "123abc"
+            },
+            title: "Product Name Here",
+            description: "Product info text goes here.",
+            price: 2099,
+            inventory: 42,
+            date: "2016-06-20 14:30:00 -0400",
+            tags: "blue, jeans, size-m",
+            vars: {
+              var1: "var 1 value"
+            },
+            images: {
+              full: {
+                url: "http://example.com/images/product.jpg"
+              }
+            },
+            site_name: "Store"
+          }
+
+          stub_post(@api_call_url, 'content_valid.json')
+
+          @response = @sailthru_client.save_content(id, options)
+          @last_request_params = CGI::parse(FakeWeb.last_request.body)
+          @expected_form_params = options.merge({id: id})
+        end
+
+        it 'POST to the correct url' do
+          refute_nil @response['content']
+        end
+
+        it 'POST with the correct parameters' do
+          form_data = JSON.parse(@last_request_params["json"][0], symbolize_names: true)
+          assert_equal(form_data, @expected_form_params)
+        end
+      end
+
+      describe 'updating content by url and sending tags as array' do
+        before do
+          id = 'http://example.com/hello-world'
+          options = {
+            tags: ['tag1', 'tag2'],
+          }
+
+          stub_post(@api_call_url, 'content_valid.json')
+
+          @response = @sailthru_client.save_content(id, options)
+          @last_request_params = CGI::parse(FakeWeb.last_request.body)
+          @expected_form_params = options.merge({id: id})
+        end
+
+        it 'POST to the correct url' do
+          refute_nil @response['content']
+        end
+
+        it 'POST form_data tags as string separated by ","' do
+          form_data = JSON.parse(@last_request_params["json"][0], symbolize_names: true)
+          assert_equal(form_data[:tags], 'tag1,tag2')
+        end
+      end
+
+      describe 'updating content searching by sku key instead of url' do
+        before do
+          id = '123abc'
+          options = {
+            key: 'sku',
+            title: "New Product Name Here",
+          }
+
+          stub_post(@api_call_url, 'content_valid.json')
+
+          @response = @sailthru_client.save_content(id, options)
+          @last_request_params = CGI::parse(FakeWeb.last_request.body)
+          @expected_form_params = options.merge({id: id})
+        end
 
-    it "can push content with title, url, *string* tags and vars" do
-      title = 'unix is awesome'
-      url = 'http://example.com/hello-world'
-      date = nil
-      tags = 'unix, linux'
-      vars = {:price => 55, :description => 'Hello World'}
-      stub_post(@api_call_url, 'content_valid.json')
-      response = @sailthru_client.push_content(title, url, date = nil, tags = tags, vars = vars)
-      refute_nil response['content']
+        it 'POST to the correct url' do
+          refute_nil @response['content']
+        end
+
+        it 'POST with the correct parameters' do
+          form_data = JSON.parse(@last_request_params["json"][0], symbolize_names: true)
+          assert_equal(form_data, @expected_form_params)
+        end
+      end
     end
 
+    describe '#push_content: DEPRECATED IN FAVOUR OF save_content' do
+      describe 'create content item' do
+        before do
+          title = 'Product Name here'
+          url = "http://example.com/product"
+          tags = "blue, jeans, size-m"
+          date = nil
+          vars = {
+            var1: 'var 1 value'
+          }
+          options = {
+            keys: {
+              sku: "123abc"
+            },
+            description: "Product info text goes here.",
+            price: 2099,
+            inventory: 42,
+            images: {
+              full: {
+                url: "http://example.com/images/product.jpg"
+              }
+            },
+            site_name: "Store"
+          }
+
+          stub_post(@api_call_url, 'content_valid.json')
+          @response = @sailthru_client.push_content(title, url, date, tags, vars, options)
+
+          @last_request_params = CGI::parse(FakeWeb.last_request.body)
+
+          @expected_form_params = options.merge({
+            title: title,
+            url: url,
+            vars: vars,
+            tags: tags,
+          })
+        end
+
+        it 'POST to the correct url' do
+          refute_nil @response['content']
+        end
+
+        it 'POST with the correct parameters' do
+          form_data = JSON.parse(@last_request_params["json"][0], symbolize_names: true)
+          assert_equal(form_data, @expected_form_params)
+        end
+      end
+
+      describe 'create content item with tags as array' do
+        before do
+          title = 'Product Name here'
+          url = "http://example.com/product"
+          tags = ['blue', 'jeans', 'size-m']
+
+          stub_post(@api_call_url, 'content_valid.json')
+          @response = @sailthru_client.push_content(title, url, nil, tags)
+
+          @last_request_params = CGI::parse(FakeWeb.last_request.body)
+        end
+
+        it 'POST to the correct url' do
+          refute_nil @response['content']
+        end
+
+        it 'POST form_data tags as string separated by ","' do
+          form_data = JSON.parse(@last_request_params["json"][0], symbolize_names: true)
+          assert_equal(form_data[:tags], 'blue,jeans,size-m')
+        end
+      end
+    end
   end
 end