sailthru-client 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 861a575aa56944d027c0cc7e3fbd52a9c266abc0
-  data.tar.gz: 55d80097eb3dc65651a27c90e27d2a481f113019
+  metadata.gz: 4cdd3ac1402c2254ff33c683caca69b2d8b6b0de
+  data.tar.gz: 53c72b791956befc9626a4c9ce7cbe3a817ccca2
 SHA512:
-  metadata.gz: a4d39c922e39970f6bcf10063efdf015b513da719fef606092e69e594603d3a3e83f2631a2b491b7bcd463bd50867b23200c9f87b7ded646b1dc8b969f832f90
-  data.tar.gz: 7b30e7fc8563837c3176de48bc6edc2674d21b240085a6314510a3138811dab377e6e8a0fa6b7b135239a78a3f53a6281f652604c81b9ecda7f8f04cebdf627c
+  metadata.gz: 9570a75d2271b75789efafa77c8a61b4baa7028ed7541dcabb9d660671ecce031808454df337660772d9eeb087a9061b2d676176fd04c9dd37b4941b737fdac6
+  data.tar.gz: 6c38603b1bd381729b0913571e20d5c873c7e4f7c9fec0eaa3c5d6ff0d944b2752db651a41c58f0c004fa2b0242e1c87da31293455c8884286fe9fbb6f0e120f

data/.gitignore

@@ -5,3 +5,4 @@
 .loadpath
 rdoc
 Gemfile.lock
+.idea

data/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
 

data/README.md

@@ -1,51 +1,11 @@
-# sailthru-ruby-client
+# Sailthru Ruby Library
 
-For installation instructions, documentation, and examples please visit:
-[http://getstarted.sailthru.com/new-for-developers-overview/api-client-library/ruby-gem](http://getstarted.sailthru.com/new-for-developers-overview/api-client-library/ruby-gem/)
-
-A simple client library to remotely access the `Sailthru REST API` as per [http://getstarted.sailthru.com/api](http://getstarted.sailthru.com/api)
-
-By default, it will make requests in `JSON` format.
-
-## Installation
-
-    $ gem install sailthru-client
-
-## Requirements
-
-This gem supports Ruby 1.9.3 and up.
-
-## Optional parameters for connection/read timeout settings
+An [API client library](https://getstarted.sailthru.com/developers/api-client/libraries-overview/) that enables you to access the `Sailthru API` using Ruby.
 
-Increase timeout from 10 (default) to 30 seconds.
-
-```ruby
-sailthru = Sailthru::Client.new("api-key", "api-secret", "https://api.sailthru.com", nil, nil, 
-			          {:http_read_timeout => 30, :http_ssl_timeout => 30, :http_open_timeout => 30})
-```
-
-## Rate Limit Information
-
-The library allows inspection of the 'X-Rate-Limit-*' headers returned by the Sailthru API. The `get_last_rate_limit_info(endpoint, method)` function allows you to retrieve the last known rate limit information for the given endpoint / method combination. It must follow an API call. For example, if you do a `/send POST`, you can follow up with a call to `get_last_rate_limit_info(:send, :post)` as shown below:
-
-``` ruby
-# make API call as normal
-response = sailthru.send_email template_name, email, {foo: "bar"}
-
-# check rate limit information
-rate_limit_info = sailthru.get_last_rate_limit_info :send, :post
-```
-
-The return type will be `nil` if there is no rate limit information for the given endpoint / method combination (e.g. if you have not yet made a request to that endpoint). Otherwise, it will be a hash in the following format:
-
-``` ruby
-{
-    limit: 1234, # <Number representing the limit of requests/minute for this action / method combination>
-    remaining: 1230, # <Number representing how many requests remain in the current minute>
-    reset: 1459381680 # <Number representing the UNIX epoch timestamp of when the next minute starts, and when the rate limit resets>
-}
-```
+For installation instructions, documentation, and examples please visit:
+[https://getstarted.sailthru.com/developers/api-client/ruby/](https://getstarted.sailthru.com/developers/api-client/ruby/)
 
-## License
+## Running tests
 
-Please see MIT-LICENSE for license.
+1. `bundle install`
+2. `bundle exec rake test`

data/lib/sailthru/client.rb

@@ -235,10 +235,10 @@ module Sailthru
       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)
@@ -366,7 +366,7 @@ module Sailthru
 
     # params:
     #   email, String
-    #   items, String
+    #   items, Array of Hashes
     #   incomplete, Integer
     #   message_id, String
     #   options, Hash
@@ -468,6 +468,7 @@ module Sailthru
       api_get(:stats, data)
     end
 
+    # <b>DEPRECATED:</b> Please use save_content
     # params
     #   title, String
     #   url, String
@@ -497,6 +498,21 @@ module Sailthru
       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
     #

data/lib/sailthru/version.rb

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

data/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sailthru-client
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Prajwal Tuladhar
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-05 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json