silverpop 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0cbf7fb5b1742d246ec1fc7c99a658934c02976
-  data.tar.gz: 11120fe410729c6435173020423c209a3e7fc252
+  metadata.gz: 45f524f4b6b2ebf46c451d7a0bbf417fd6dcd87c
+  data.tar.gz: da1439794e0aed35c78f5b9340f701826e5503c6
 SHA512:
-  metadata.gz: 2dd9822b4be36314bf889cf1570a255d7a39f818a66c0bc5d9ea7f61975816b2c7d2e1cff105fb20799230509dd7ab7c0da45ce0495e24b2637966244f25f8d8
-  data.tar.gz: 1e71a3643a849f13181d65e909d3539b8999050b915853e19b77aa16ebc45cc4179c52a6eb8581b541461cdcc6fc3013809458f48acf2763502ea6d9f58f02d7
+  metadata.gz: b303e169d6e97ffcf05edd75d605499615d96f47150736067a1d2e88268c902b2b94d835039cb60610dec345702a25c90db4e3cbd75fd8ba351e65bb7f9130d5
+  data.tar.gz: 398052c50efb1b2bbb427b1824c0d3d6370c0189b568964c9e209d2905bbc1abaaf68df065ddf68b867db377d9c0ed8f2feec940166a73c7ccb49cd008e88c35

data/.travis.yml

@@ -1,8 +1,9 @@
 bundler_args: --without development
 language: ruby
 rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.1.5
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+before_install:
+  - gem update bundler

data/Gemfile

@@ -2,6 +2,10 @@ source 'https://rubygems.org'
 
 gem 'rake'
 
+group :development, :test do
+  gem 'pry'
+end
+
 group :test do
   gem 'rspec'
   gem 'simplecov', :require => false

data/lib/client/contact.rb

@@ -37,7 +37,7 @@ module SilverPop
               }
             }
           }
-        response = post(xml, options)
+        response = post(xml)
       end
 
     end

data/lib/client/relational_table.rb

@@ -0,0 +1,66 @@
+module SilverPop
+  class Client
+    module RelationalTable
+      # InsertUpdateRelationalTable - This interface inserts or updates relational data.
+      #
+      # @param table_id [String] Required parameter to specify the ID of the Relational Table you are interacting with. Either TABLE_NAME or TABLE_ID is required.
+      # @param rows [Array]
+      # @return [Mash] Mashify body from the API call
+      # @example Insert into table 86767 a row with one column
+      #   s = SilverPop.new access_token: 'abc123', url: 'https://api1.silverpop.com'
+      #   s.insert_update_relational_table '86767', [{'Record Id' => 'GHbjh73643hsdiy'}]
+      def insert_update_relational_table table_id, rows
+        builder = Builder::XmlMarkup.new
+
+        xml = builder.Envelope {
+          builder.Body {
+            builder.InsertUpdateRelationalTable {
+              builder.TABLE_ID table_id
+              builder.ROWS {
+                rows.each do |row|
+                  builder.ROW {
+                    row.each do |key, value|
+                      builder.COLUMN(name: key) {
+                        builder.cdata!(value)
+                      }
+                    end
+                  }
+                end
+              }
+            }
+          }
+        }
+
+        post(xml)
+      end
+    end
+
+    # ExportTable - This interface supports programmatically exporting Relational Table data from Engage into a CSV file, which Engage uploads to the FTP account or to the Stored Files directory associated with the session.
+    #
+    # @param table_id [String] Optional parameter to specify the ID of the Relational Table you are exporting. Either TABLE_NAME or TABLE_ID is required.
+    # @param export_format [String] Specifies the format (file type) for the exported data, CSV, TAB, PIPE.
+    # @param options [Hash] Optional parameters to send
+    # @param export_colums [Array] XML node used to request specific custom database columns to export for each contact.
+    # @return [Mash] Mashify body from the API call
+    # @example Export Table 12345 for 1/1/2014 to 1/2/2014
+    #   s = SilverPop.new({access_token: "abc123", url: "https://api1.silverpop.com"})
+    #   s.export_table('12345', 'CSV', {DATE_START: "1/1/2014", DATE_END:"1/2/2014"})
+    def export_table(table_id, export_format, options={})
+      builder = Builder::XmlMarkup.new
+      xml = builder.Envelope {
+        builder.Body {
+          builder.ExportTable {
+            builder.TABLE_NAME table_id
+            builder.EXPORT_FORMAT export_format
+            unless options.empty?
+              options.each do |o|
+                builder.tag! o[0], o[1]
+              end
+            end
+            }
+          }
+      }
+      post(xml)
+    end
+  end
+end

data/lib/client/user.rb

@@ -1,7 +1,6 @@
 module SilverPop
   class Client
     module User
-
       # ExportList - This interface exports contact data from a database, query, or contact list. Engage exports the results to a CSV file, then adds that file to the FTP account associated with the current session.
       #
       # @param list_id [String] Unique identifier for the database, query, or contact list Engage is exporting.
@@ -23,7 +22,7 @@ module SilverPop
               builder.EXPORT_FORMAT export_format
               unless options.empty?
                 options.each do |o|
-                    builder.tag! o[0], o[1]
+                  builder.tag! o[0], o[1]
                 end
               end
               unless export_columns.empty?
@@ -38,37 +37,7 @@ module SilverPop
           }
         post(xml)
       end
-
-    end
-
-    # ExportTable - This interface supports programmatically exporting Relational Table data from Engage into a CSV file, which Engage uploads to the FTP account or to the Stored Files directory associated with the session.
-    #
-    # @param table_id [String] Optional parameter to specify the ID of the Relational Table you are exporting. Either TABLE_NAME or TABLE_ID is required.
-    # @param export_format [String] Specifies the format (file type) for the exported data, CSV, TAB, PIPE.
-    # @param options [Hash] Optional parameters to send
-    # @param export_colums [Array] XML node used to request specific custom database columns to export for each contact.
-    # @return [Mash] Mashify body from the API call
-    # @example Export Table 12345 for 1/1/2014 to 1/2/2014
-    #   s = SilverPop.new({access_token: "abc123", url: "https://api1.silverpop.com"})
-    #   s.export_table('12345', 'CSV', {DATE_START: "1/1/2014", DATE_END:"1/2/2014"})
-    def export_table(table_id, export_format, options={})
-      builder = Builder::XmlMarkup.new
-      xml = builder.Envelope {
-        builder.Body {
-          builder.ExportTable {
-            builder.TABLE_NAME table_id
-            builder.EXPORT_FORMAT export_format
-            unless options.empty?
-              options.each do |o|
-                builder.tag! o[0], o[1]
-              end
-            end
-            }
-          }
-      }
-      post(xml)
     end
-
   end
 end
 

data/lib/silverpop/client.rb

@@ -4,6 +4,7 @@ require 'silverpop/request'
 require 'client/contact'
 require 'client/reporting'
 require 'client/user'
+require 'client/relational_table'
 
 module SilverPop
   class Client
@@ -17,5 +18,6 @@ module SilverPop
     include SilverPop::Client::Contact
     include SilverPop::Client::Reporting
     include SilverPop::Client::User
+    include SilverPop::Client::RelationalTable
   end
 end

data/lib/silverpop/request.rb

@@ -1,7 +1,7 @@
 module SilverPop
   module Request
-    def post(path, options={})
-      request(:post, path, options)
+    def post(body)
+      request(:post, body)
     end
 
     private
@@ -10,7 +10,7 @@ module SilverPop
     #
     # @param body [String] The formatted XML of the API call make sure to call builder.to_xml.
     # @return [XML] XML Body from the API call
-    def request(method, body, options)
+    def request(method, body)
       response = connection.send(method) do |request|
         request.url "/XMLAPI"
         request.headers['Content-type'] = "text/xml"

data/lib/silverpop/version.rb

@@ -1,3 +1,3 @@
 module SilverPop
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/spec/client/relational_table_spec.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+describe SilverPop::Client::RelationalTable do
+  before do
+    @client = SilverPop.new access_token: 'abc123', url: 'https://api1.silverpop.com'
+  end
+
+  describe '.insert_update_relational_table' do
+    it 'returns the success as true' do
+      stub_post('/XMLAPI?access_token=abc123')
+      .with(body: '<Envelope><Body><InsertUpdateRelationalTable><TABLE_ID>86767</TABLE_ID><ROWS><ROW><COLUMN name="Record Id"><![CDATA[GHbjh73643hsdiy]]></COLUMN></ROW></ROWS></InsertUpdateRelationalTable></Body></Envelope>')
+      .to_return status: 200,
+                 body: fixture('relational_table.xml'),
+                 headers: { 'Content-type' => 'text/xml' }
+
+      resp = @client.insert_update_relational_table '86767', [{'Record Id' => 'GHbjh73643hsdiy'}]
+
+      expect(resp.Envelope.Body.RESULT.SUCCESS).to eq('true')
+    end
+  end
+end

data/spec/fixtures/relational_table.xml

@@ -0,0 +1,7 @@
+<Envelope>
+  <Body>
+    <RESULT>
+      <SUCCESS>true</SUCCESS>
+    </RESULT>
+  </Body>
+</Envelope>

data/spec/helper.rb

@@ -7,6 +7,7 @@ end
 require 'silverpop'
 require 'rspec'
 require 'webmock/rspec'
+require 'pry'
 
 def stub_post(url)
   stub_request(:post, silverpop_url(url))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: silverpop
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Upworthy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
+date: 2016-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -152,6 +152,7 @@ files:
 - README.md
 - Rakefile
 - lib/client/contact.rb
+- lib/client/relational_table.rb
 - lib/client/reporting.rb
 - lib/client/user.rb
 - lib/silverpop.rb
@@ -161,9 +162,11 @@ files:
 - lib/silverpop/version.rb
 - silverpop.gemspec
 - spec/client/contact_spec.rb
+- spec/client/relational_table_spec.rb
 - spec/client/reporting_spec.rb
 - spec/client/user_spec.rb
 - spec/fixtures/contact.xml
+- spec/fixtures/relational_table.xml
 - spec/fixtures/reporting.xml
 - spec/fixtures/sent_mailings_org.xml
 - spec/helper.rb
@@ -194,11 +197,12 @@ specification_version: 4
 summary: A Ruby wrapper for the SilverPop API
 test_files:
 - spec/client/contact_spec.rb
+- spec/client/relational_table_spec.rb
 - spec/client/reporting_spec.rb
 - spec/client/user_spec.rb
 - spec/fixtures/contact.xml
+- spec/fixtures/relational_table.xml
 - spec/fixtures/reporting.xml
 - spec/fixtures/sent_mailings_org.xml
 - spec/helper.rb
 - spec/silverpop_spec.rb
-has_rdoc: