sailthru-client 3.0.0 → 4.0.0

data/lib/sailthru/helpers.rb

@@ -0,0 +1,76 @@
+require 'digest/md5'
+
+module Sailthru
+  module Helpers
+    # params:
+    #   params, Hash
+    # returns:
+    #   Array, values of each item in the Hash (and nested hashes)
+    #
+    # Extracts the values of a set of parameters, recursing into nested assoc arrays.
+    def extract_param_values(params)
+      values = []
+      params.each do |k, v|
+        if v.class == Hash
+          values.concat extract_param_values(v)
+       elsif v.class == Array
+          temp_hash = {}
+          v.each_with_index do |v_,i_|
+            temp_hash[i_.to_s] = v_
+          end
+          values.concat extract_param_values(temp_hash)
+        else
+          values.push v.to_s
+        end
+      end
+      return values
+    end
+
+    # params:
+    #   params, Hash
+    #   secret, String
+    # returns:
+    #   String
+    #
+    # Returns the unhashed signature string (secret + sorted list of param values) for an API call.
+    def get_signature_string(params, secret)
+      return secret + extract_param_values(params).sort.join("")
+    end
+
+    # params:
+    #   params, Hash
+    #   secret, String
+    # returns:
+    #   String
+    #
+    # Returns an MD5 hash of the signature string for an API call.
+    def get_signature_hash(params, secret)
+      Digest::MD5.hexdigest(get_signature_string(params, secret)).to_s
+    end
+
+    # Flatten nested hash for GET / POST request.
+    def flatten_nested_hash(hash, brackets = true)
+      f = {}
+      hash.each do |key, value|
+        _key = brackets ? "[#{key}]" : key.to_s
+        if value.class == Hash
+          flatten_nested_hash(value).each do |k, v|
+            f["#{_key}#{k}"] = v
+          end
+        elsif value.class == Array
+          temp_hash = {}
+          value.each_with_index do |v, i|
+             temp_hash[i.to_s] = v
+          end
+          flatten_nested_hash(temp_hash).each do |k, v|
+            f["#{_key}#{k}"] = v
+          end
+
+        else
+          f[_key] = value
+        end
+      end
+      return f
+    end
+  end
+end

data/lib/sailthru/version.rb

@@ -0,0 +1,3 @@
+module Sailthru
+  VERSION = '4.0.0'
+end

data/sailthru-client.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/sailthru', __FILE__)
+require File.expand_path('../lib/sailthru/version', __FILE__)
 require 'date'
 
 Gem::Specification.new do |s|
@@ -20,7 +20,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency(%q<json>, [">= 0"])
   s.add_dependency(%q<multipart-post>, [">= 0"])
+  s.add_development_dependency(%q<rake>, [">= 0"])
   s.add_development_dependency(%q<fakeweb>, [">= 0"])
-  s.add_development_dependency(%q<shoulda>, [">= 0"])
+  s.add_development_dependency(%q<minitest>, [">= 5"])
   s.add_development_dependency(%q<mocha>, [">= 0"])
 end

data/test/sailthru/blast_test.rb

@@ -6,7 +6,7 @@ class BlastTest < Minitest::Test
       api_url = 'http://api.sailthru.com'
       @secret = 'my_secret'
       @api_key = 'my_api_key'
-      @sailthru_client = Sailthru::SailthruClient.new(@api_key, @secret, api_url)
+      @sailthru_client = Sailthru::Client.new(@api_key, @secret, api_url)
       @api_call_url = sailthru_api_call_url(api_url, 'blast')
     end
 

data/test/sailthru/content_test.rb

@@ -6,7 +6,7 @@ class ContentTest < Minitest::Test
       api_url = 'http://api.sailthru.com'
       @secret = 'my_secret'
       @api_key = 'my_api_key'
-      @sailthru_client = Sailthru::SailthruClient.new(@api_key, @secret, api_url)
+      @sailthru_client = Sailthru::Client.new(@api_key, @secret, api_url)
       @api_call_url = sailthru_api_call_url(api_url, 'content')
     end
 

data/test/sailthru/email_test.rb

@@ -6,7 +6,7 @@ class EmailTest < Minitest::Test
       api_url = 'http://api.sailthru.com'
       @api_key = 'my_api_key'
       @secret = 'my_secret'
-      @sailthru_client = Sailthru::SailthruClient.new(@api_key, @secret, api_url)
+      @sailthru_client = Sailthru::Client.new(@api_key, @secret, api_url)
       @api_call_url = sailthru_api_call_url(api_url, 'email')
     end
 

data/test/sailthru/error_test.rb

@@ -6,13 +6,13 @@ class ErrorTest < Minitest::Test
       api_url = 'http://api.sailthru.com'
       @secret = 'my_secret'
       @api_key = 'my_api_key'
-      @sailthru_client = Sailthru::SailthruClient.new(@api_key, @secret, api_url)
+      @sailthru_client = Sailthru::Client.new(@api_key, @secret, api_url)
       @api_call_url = sailthru_api_call_url(api_url, 'blast')
     end
 
     it "raises an error when server misbehaves" do
       stub_exception(@api_call_url, 'blast_post_update_valid.json')
-      assert_raises Sailthru::SailthruClientException do
+      assert_raises Sailthru::ClientError do
         @sailthru_client.cancel_blast(123)
       end
     end
@@ -21,8 +21,9 @@ class ErrorTest < Minitest::Test
       stub_exception(@api_call_url, 'blast_post_update_valid.json')
       begin
         @sailthru_client.cancel_blast(123)
-      rescue Exception => e
-        assert(e.message =~ /Exception from FakeWeb/)
+      rescue => e
+        assert_match /Exception from FakeWeb/, e.message
+        assert_match /Exception from FakeWeb/, e.cause.message if e.respond_to?(:cause) # Ruby 2.1
       end
     end
   end

data/test/sailthru/file_upload_test.rb

@@ -8,7 +8,7 @@ class FileUploadTest < Minitest::Test
     before do
       @secret = 'my_secret'
       @api_key = 'my_api_key'
-      @sailthru_client = Sailthru::SailthruClient.new(
+      @sailthru_client = Sailthru::Client.new(
         @api_key, @secret, 'http://api.sailthru.com'
       )
       @api_call_url = sailthru_api_call_url(

data/test/sailthru/list_test.rb

@@ -6,14 +6,14 @@ class ListTest < Minitest::Test
       api_url = 'http://api.sailthru.com'
       @secret = 'my_secret'
       @api_key = 'my_api_key'
-      @sailthru_client = Sailthru::SailthruClient.new(@api_key, @secret, api_url)
+      @sailthru_client = Sailthru::Client.new(@api_key, @secret, api_url)
       @api_call_url = sailthru_api_call_url(api_url, 'list')
     end
 
     it "can get all lists meta data" do
       query_string = create_json_payload(@api_key, @secret, {})
       stub_get(@api_call_url + '?' + query_string, 'list_get_all.json')
-      response = @sailthru_client.get_lists()
+      response = @sailthru_client.get_lists
       assert_equal(response['lists'].length, 2)
       refute_nil(response['lists'][0]['name'])
     end
@@ -41,7 +41,7 @@ class ListTest < Minitest::Test
       list = 'new-list2'
       primary = 1
       options = {
-          'primary' => primary
+        'primary' => primary
       }
       stub_post(@api_call_url, 'list_save_valid.json')
       response = @sailthru_client.save_list(list, options)

data/test/sailthru/purchase_test.rb

@@ -4,7 +4,7 @@ class PurchaseTest < Minitest::Test
   describe "API Call: purchase" do
     before do
       api_url = 'http://api.sailthru.com'
-      @sailthru_client = Sailthru::SailthruClient.new("my_api_key", "my_secret", api_url)
+      @sailthru_client = Sailthru::Client.new("my_api_key", "my_secret", api_url)
       @api_call_url = sailthru_api_call_url(api_url, 'purchase')
     end
 

data/test/sailthru/send_test.rb

@@ -6,7 +6,7 @@ class SendTest < Minitest::Test
       api_url = 'http://api.sailthru.com'
       @secret = 'my_secret'
       @api_key = 'my_api_key'
-      @sailthru_client = Sailthru::SailthruClient.new("my_api_key", "my_secret", api_url)
+      @sailthru_client = Sailthru::Client.new("my_api_key", "my_secret", api_url)
       @api_call_url = sailthru_api_call_url(api_url, 'send')
     end
 
@@ -30,22 +30,6 @@ class SendTest < Minitest::Test
       assert_equal 12, response['error']
     end
 
-    it "can post send with valid template name and email using deprecated 'send' method" do
-      template_name = 'default'
-      email = 'example@example.com'
-      stub_post(@api_call_url, 'send_get_valid.json')
-      response = @sailthru_client.send template_name, email, {"name" => "Unix",  "myvar" => [1111,2,3], "mycomplexvar" => {"tags" => ["obama", "aaa", "c"]}}
-      assert_equal template_name, response['template']
-    end
-
-    it "cannot post send with invalid template name and/or email using deprecated 'send' method" do
-      template_name = 'invalid-template'
-      email = 'example@example.com'
-      stub_post(@api_call_url, 'send_post_invalid.json')
-      response = @sailthru_client.send template_name, email, {"name" => "Unix",  "myvar" => [1111,2,3], "mycomplexvar" => {"tags" => ["obama", "aaa", "c"]}}
-      assert_equal 14, response['error']
-    end
-
     it "can post send with valid template name and email" do
       template_name = 'default'
       email = 'example@example.com'

data/test/sailthru/stats_test.rb

@@ -6,7 +6,7 @@ class StatsTest < Minitest::Test
       api_url = 'http://api.sailthru.com'
       @secret = 'my_secret'
       @api_key = 'my_api_key'
-      @sailthru_client = Sailthru::SailthruClient.new(@api_key, @secret, api_url)
+      @sailthru_client = Sailthru::Client.new(@api_key, @secret, api_url)
       @api_call_url = sailthru_api_call_url(api_url, 'stats')
     end
 
@@ -34,7 +34,7 @@ class StatsTest < Minitest::Test
       params = {'stat' => 'list'}
       query_string = create_json_payload(@api_key, @secret, params)
       stub_get(@api_call_url + '?' + query_string, 'stats_lists_valid.json')
-      response = @sailthru_client.stats_list()
+      response = @sailthru_client.stats_list
       refute_nil response['lists_signup_count']
     end
 

data/test/sailthru/template_test.rb

@@ -6,7 +6,7 @@ class TemplateTest < Minitest::Test
       api_url = 'http://api.sailthru.com'
       @secret = 'my_secret'
       @api_key = 'my_api_key'
-      @sailthru_client = Sailthru::SailthruClient.new(@api_key, @secret, api_url)
+      @sailthru_client = Sailthru::Client.new(@api_key, @secret, api_url)
       @api_call_url = sailthru_api_call_url(api_url, 'template')
     end
 

data/test/test_helper.rb

@@ -49,7 +49,7 @@ class Minitest::Test
   end
 
   def stub_exception(url, filename)
-    FakeWeb.register_uri(:any, URI.parse(url), :exception => Exception)
+    FakeWeb.register_uri(:any, URI.parse(url), :exception => StandardError)
   end
 
   def create_query_string(secret, params)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sailthru-client
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Prajwal Tuladhar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -40,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakeweb
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -67,6 +67,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -91,11 +105,13 @@ files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
 - lib/sailthru.rb
+- lib/sailthru/client.rb
+- lib/sailthru/helpers.rb
+- lib/sailthru/version.rb
 - sailthru-client.gemspec
 - test/fixtures/blast_delete_invalid.json
 - test/fixtures/blast_delete_valid.json

data/Gemfile.lock

@@ -1,22 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    fakeweb (1.3.0)
-    json (1.8.1)
-    metaclass (0.0.4)
-    minitest (5.3.4)
-    mocha (0.14.0)
-      metaclass (~> 0.0.1)
-    multipart-post (2.0.0)
-    rake (10.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  fakeweb
-  json
-  minitest
-  mocha
-  multipart-post
-  rake