goacoustic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1be8c3589dd5a04b36baefaf5f1afefa1be1d35bcff0b9aeb9190d1aa7718e65
+  data.tar.gz: 7413c19d7d8a11d8d2a40d1fafdb87ec047f888d7542cf0c71c167e746c6d902
+SHA512:
+  metadata.gz: 83b5148cb725a68ab7ba4b8e6224c7947245d43136901f0420b395fdbe9445cd643cc8c9efc9604e97d9183d09a50b4f6fd8f19d6dc6299a5e69bc0f6e2cfc1a
+  data.tar.gz: 9cc297d2abde9fcc6e27d8a5dd68a91771d5faf0c8852b265806a74b8dc9b4c44fd8396630bf02d29b4f58399790acff1c3ab7bc6214d468a89b74980b08ebf0

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.emacs.desktop
+.emacs.desktop.lock
+.redcar
+.yardoc
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,9 @@
+bundler_args: --without development
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+before_install:
+  - gem update bundler

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+LICENSE.md

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :development, :test do
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov', :require => false
+  gem 'webmock'
+  gem 'yardstick'
+end
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,12 @@
+Copyright (c) 2013, Cloud Tiger Media d.b.a. Upworthy
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the Cloud Tiger Media d.b.a Upworthy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,82 @@
+# Acoustic API
+A Ruby wrapper for the Acoustic API
+
+## Installation
+
+    $ gem install goacoustic
+
+## Documentation
+
+[http://rdoc.info/gems/goacoustic](http://rdoc.info/gems/goacoustic)
+
+
+## Usage Examples
+    require 'acoustic'
+    require 'oauth2'
+
+    #Generate your OAuth2 access token
+    client = OAuth2::Client.new(ACOUSTIC_CLIENT_ID, ACOUSTIC_CLIENT_SECRET, site: "https://api-campaign-us-1.goacoustic.com/oauth/token")
+    access_token = OAuth2::AccessToken.from_hash(client, refresh_token: ACOUSTIC_REFRESH_TOKEN).refresh!
+
+    @client = Acoustic.new({access_token: access_token.token, url: "https://api-campaign-us-1.goacoustic.com"})
+
+    #add_recipeint
+    #pass in user variables, database contact list, and contact list id
+    a = @client.add_recipient({email:"test@example.com"}, 123, [456])
+    resp.Envelope.Body.RESULT.SUCCESS # => "TRUE"
+
+## Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help improve
+this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up
+  inconsistent whitespace)
+* by refactoring code
+* by fixing [issues][]
+* by reviewing patches
+
+[issues]: http://github.com/harman-signal-processing/goacoustic/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Run `bundle exec rake yard`. If your changes are not 100% documented, go
+   back to step 8.
+10. Add, commit, and push your changes.
+11. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/
+
+## Copyright
+Copyright (c) 2020 Harman. See [LICENSE][] for details.
+
+[license]: https://github.com/harman-signal-processing/goacoustic/blob/master/LICENSE.md
+

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/goacoustic.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require File.expand_path('../lib/acoustic/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'addressable', '~> 2.7'
+  gem.add_dependency 'faraday', '~> 1.0'
+  gem.add_dependency 'faraday_middleware', '~> 1.0'
+  gem.add_dependency 'hashie', '~> 4.0'
+  gem.add_dependency 'builder', '~> 3.2'
+  gem.add_dependency 'multi_xml', '~> 0.6'
+  gem.add_development_dependency 'oauth2'
+  gem.add_development_dependency 'rdiscount'
+  gem.add_development_dependency 'yard'
+  gem.author      = "Adam Anderson, Upworthy"
+  gem.description = %q{A Ruby wrapper for the Acoustic API}
+  gem.email       = 'adam.anderson@harman.com'
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.files       = `git ls-files`.split("\n")
+  gem.homepage    = 'http://www.github.com/harman-signal-processing/goacoustic'
+  gem.licenses    = ['BSD-3-Clause']
+  gem.name        = 'goacoustic'
+  gem.require_paths = ['lib']
+  gem.summary     = gem.description
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.version     = Acoustic::VERSION
+end

data/lib/acoustic.rb

@@ -0,0 +1,23 @@
+require 'acoustic/client'
+
+module Acoustic
+  class << self
+    # Alias for Acoustic::Client.new
+    #
+    # @return [Acoustic::Client]
+    def new(options={})
+      Acoustic::Client.new(options)
+    end
+
+    # Delegate to Acoustic::Client.new
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end
+

data/lib/acoustic/client.rb

@@ -0,0 +1,23 @@
+require 'builder'
+require 'acoustic/connection'
+require 'acoustic/request'
+require 'client/contact'
+require 'client/reporting'
+require 'client/user'
+require 'client/relational_table'
+
+module Acoustic
+  class Client
+    def initialize(options={})
+      @access_token = options[:access_token]
+      @acoustic_url = options[:url]
+    end
+
+    include Acoustic::Connection
+    include Acoustic::Request
+    include Acoustic::Client::Contact
+    include Acoustic::Client::Reporting
+    include Acoustic::Client::User
+    include Acoustic::Client::RelationalTable
+  end
+end

data/lib/acoustic/connection.rb

@@ -0,0 +1,23 @@
+require 'faraday_middleware'
+
+module Acoustic
+  # @private
+  module Connection
+    private
+
+    def connection(options={})
+      connection = Faraday.new @acoustic_url do |conn|
+        # Uncomment if want to log to stdout
+        #conn.response :logger
+
+        conn.request :oauth2, @access_token, token_type: :bearer
+        conn.request :url_encoded
+        conn.response :mashify
+
+        conn.response :xml, :content_type => /\bxml$/
+        conn.adapter Faraday.default_adapter
+      end
+      connection
+    end
+  end
+end

data/lib/acoustic/request.rb

@@ -0,0 +1,22 @@
+module Acoustic
+  module Request
+    def post(body)
+      request(:post, body)
+    end
+
+    private
+
+    # POST the XML to the Acoustic end point.
+    #
+    # @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)
+      response = connection.send(method) do |request|
+        request.url "/XMLAPI"
+        request.headers['Content-type'] = "text/xml"
+        request.body = body
+      end
+      response.body
+    end
+  end
+end

data/lib/acoustic/version.rb

@@ -0,0 +1,3 @@
+module Acoustic
+  VERSION = "0.1.0"
+end

data/lib/client/contact.rb

@@ -0,0 +1,47 @@
+module Acoustic
+  class Client
+    module Contact
+
+      # Adds one new contact to an existing database.
+      #
+      # @param fields [Hash] The list of fields to be passed into Acoustic.
+      # @param list_id [Integer] The ID of the database which you are adding the contact
+      # @param contact_list_id [Array] The id of the contact list.
+      # @return [Mash] Mashify body from the API call
+      # @example Add a new email to the database and contact list
+      #   s = Acoustic::Client.new(access_token)
+      #   s.add_recipient({email: "test@example.com", firstname: "Hello"}, 12345, [4567])
+      def add_recipient(fields, list_id, contact_list_id=nil, created_from=1, options={})
+        builder = Builder::XmlMarkup.new
+        xml = builder.Envelope {
+          builder.Body {
+            builder.AddRecipient {
+              builder.LIST_ID list_id
+              builder.CREATED_FROM  created_from
+              if contact_list_id
+                builder.CONTACT_LISTS {
+                  contact_list_id.each do |id|
+                    builder.CONTACT_LIST_ID  id
+                  end
+                }
+              end
+              unless options.empty?
+                options.each do |opt|
+                  builder.tag! opt[0], opt[1]
+                end
+              end
+              fields.each do |field|
+                builder.COLUMN {
+                  builder.NAME field[0].to_s
+                  builder.VALUE field[1]
+                }
+              end
+              }
+            }
+          }
+        response = post(xml)
+      end
+
+    end
+  end
+end

data/lib/client/relational_table.rb

@@ -0,0 +1,66 @@
+module Acoustic
+  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 = Acoustic.new access_token: 'abc123', url: 'https://api-campaign-us-1.goacoustic.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 = Acoustic.new({access_token: "abc123", url: "https://api-campaign-us-1.goacoustic.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/reporting.rb

@@ -0,0 +1,98 @@
+module Acoustic
+  class Client
+    module Reporting
+
+      # GetSentMailingsForOrg - This interface extracts a listing of mailings sent for an organization for a specified date range.
+      #
+      # @param date_start [String]  Starting Date in the format “mm/dd/yyyy hh:mm:ss”
+      # @param date_end [String] Required Ending Date in the format “mm/dd/yyyy hh:mm:ss”
+      # @param options [Hash] Optional parameters to send
+      # @return [Mash] Mashify body from the API call
+      # @example Get sent mailing for organization for 1/1/2014 to 1/2/2014
+      #   s = Acoustic.new({access_token: "abc123", url: "https://api-campaign-us-1.goacoustic.com"})
+      #   s.get_sent_mailings_for_org("1/1/2014", "1/2/2014)
+      def get_sent_mailings_for_org(date_start, date_end, options={})
+        builder = Builder::XmlMarkup.new
+        xml = builder.Envelope {
+          builder.Body {
+            builder.GetSentMailingsForOrg {
+              unless options.empty?
+                options.each do |o|
+                    builder.tag! o[0], o[1]
+                end
+              end
+              builder.DATE_START date_start
+              builder.DATE_END date_end
+              }
+            }
+          }
+        post(xml)
+      end
+
+      # RawRecipientDataExport - Allows exporting unique contact-level events and creates a .zip file containing a single flat file with all metrics
+      #
+      # @param query_params [Hash] The list of fields to run the query against MAILING_ID, REPORT_ID, etc.
+      # @param options [Hash] The various options on how to export the data EXPORT_FORMAT, FILE_ENCODING, etc.
+      # @param columns [Array] Optional list of columns to limit the flat file.
+      # @return [Mash] Mashify body from the API call
+      # @example Export raw data events for mailing id
+      #   s = Acoustic.new({access_token: "abc123", url: "https://api-campaign-us-1.goacoustic.com"})
+      #   s.raw_recipient_data_export({MAILING_ID: 1234},{MOVE_TO_FTP: nil})
+      def raw_recipient_data_export(query_params={}, options={}, columns=[])
+        builder = Builder::XmlMarkup.new
+        xml = builder.Envelope {
+          builder.Body {
+            builder.RawRecipientDataExport {
+              unless query_params.empty?
+                query_params.each do |q|
+                  if q[0] == :MAILING_ID || q[0] == :REPORT_ID
+                    builder.MAILING {
+                      builder.tag! q[0], q[1]
+                    }
+                  else
+                    builder.tag! q[0], q[1]
+                  end
+                end
+              end
+              unless options.empty?
+                options.each do |opt|
+                  builder.tag! opt[0], opt[1]
+                end
+              end
+              unless columns.empty?
+                builder.COLUMNS {
+                  columns.each do |column|
+                    builder.COLUMN {
+                      builder.NAME column
+                    }
+                  end
+                }
+              end
+              }
+            }
+          }
+        post(xml)
+      end
+
+      # GetJobStatus - After initiating a data job, you can monitor the status of the job using this operation.
+      #
+      # @param job_id [Integer] The Job ID of the data job
+      # @return [Mash] Mashify body from the API call
+      # @example Get Job Status for JOB_ID 1234
+      #   s = Acoustic.new({access_token: "abc123", url: "https://api-campaign-us-1.goacoustic.com"})
+      #   s.get_job_status(1234)
+      def get_job_status(job_id)
+        builder = Builder::XmlMarkup.new
+        xml = builder.Envelope {
+          builder.Body {
+            builder.GetJobStatus {
+              builder.JOB_ID job_id
+              }
+            }
+          }
+        post(xml)
+      end
+
+    end
+  end
+end

data/lib/client/user.rb

@@ -0,0 +1,44 @@
+module Acoustic
+  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.
+      # @param export_type [String] Specifies which contacts to export.
+      # @param export_format [String] Specifies the format (file type) for the exported data.
+      # @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 list 12345 for 1/1/2014 to 1/2/2014
+      #   s = Acoustic.new({access_token: "abc123", url: "https://api-campaign-us-1.goacoustic.com"})
+      #   s.export_list('12345', 'ALL', 'CSV", {DATE_START: "1/1/2014", DATE_END:"1/2/2014"})
+      def export_list(list_id, export_type, export_format, options={}, export_columns=[])
+        builder = Builder::XmlMarkup.new
+        xml = builder.Envelope {
+          builder.Body {
+            builder.ExportList {
+              builder.LIST_ID list_id
+              builder.EXPORT_TYPE export_type
+              builder.EXPORT_FORMAT export_format
+              unless options.empty?
+                options.each do |o|
+                  builder.tag! o[0], o[1]
+                end
+              end
+              unless export_columns.empty?
+                builder.EXPORT_COLUMNS {
+                  export_columns.each do |e|
+                    builder.COLUMN e
+                  end
+                }
+              end
+              }
+            }
+          }
+        post(xml)
+      end
+    end
+  end
+end
+
+

data/spec/acoustic_spec.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+describe Acoustic do
+  describe ".new" do
+    it "should be a new Acoustic::Client" do
+      expect(Acoustic.new).to be_a Acoustic::Client
+    end
+  end
+
+  describe ".respond_to?" do
+    pending it "should be true if method exists" do
+      expect(Acoustic.respond_to?(:new, true)).to be_true
+    end
+  end
+end

data/spec/client/contact_spec.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+describe Acoustic::Client::Contact do
+  before do
+    @client = Acoustic::Client.new({access_token: "abc123",url: 'https://api-campaign-us-1.goacoustic.com'})
+  end
+
+  describe "#add_recipient" do
+    it "should add a recipient to an existing database" do
+      stub_post("/XMLAPI").
+        with(:body => "<Envelope><Body><AddRecipient><LIST_ID>123</LIST_ID><CREATED_FROM>1</CREATED_FROM><CONTACT_LISTS><CONTACT_LIST_ID>456</CONTACT_LIST_ID></CONTACT_LISTS><COLUMN><NAME>email</NAME><VALUE>test@example.com</VALUE></COLUMN></AddRecipient></Body></Envelope>").
+          to_return(:status => 200, :body => fixture("contact.xml"), :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+      resp = @client.add_recipient({email:"test@example.com"}, 123, [456])
+      expect(resp.Envelope.Body.RESULT.SUCCESS).to eql "TRUE"
+    end
+
+    it "should add a recipient to an existing database with options" do
+      stub_post("/XMLAPI").
+        with(:body => "<Envelope><Body><AddRecipient><LIST_ID>123</LIST_ID><CREATED_FROM>1</CREATED_FROM><CONTACT_LISTS><CONTACT_LIST_ID>456</CONTACT_LIST_ID></CONTACT_LISTS><UPDATE_IF_FOUND>true</UPDATE_IF_FOUND><COLUMN><NAME>email</NAME><VALUE>test@example.com</VALUE></COLUMN></AddRecipient></Body></Envelope>").
+          to_return(:status => 200, :body => fixture("contact.xml"), :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+      resp = @client.add_recipient({email:"test@example.com"}, 123, [456], 1, {UPDATE_IF_FOUND: "true"})
+      expect(resp.Envelope.Body.RESULT.SUCCESS).to eql "TRUE"
+    end
+
+  end
+end

data/spec/client/relational_table_spec.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+describe Acoustic::Client::RelationalTable do
+  before do
+    @client = Acoustic.new access_token: 'abc123', url: 'https://api-campaign-us-1.goacoustic.com'
+  end
+
+  describe '.insert_update_relational_table' do
+    it 'returns the success as true' do
+      stub_post('/XMLAPI')
+      .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', 'Authorization' => 'Bearer abc123' }
+
+      resp = @client.insert_update_relational_table '86767', [{'Record Id' => 'GHbjh73643hsdiy'}]
+
+      expect(resp.Envelope.Body.RESULT.SUCCESS).to eq('true')
+    end
+  end
+end

data/spec/client/reporting_spec.rb

@@ -0,0 +1,104 @@
+require 'helper'
+
+describe Acoustic::Client::Reporting do
+  before do
+    @client = Acoustic.new({access_token: "abc123",url: 'https://api-campaign-us-1.goacoustic.com'})
+  end
+
+  describe ".get_sent_mailings_for_org" do
+    it "returns the mailingId for the given dates" do
+      stub_post("/XMLAPI").
+        with(:body => "<Envelope><Body><GetSentMailingsForOrg><DATE_START>1/1/2014 00:00:00</DATE_START><DATE_END>1/2/2014 23:59:59</DATE_END></GetSentMailingsForOrg></Body></Envelope>").
+        to_return(:status => 200, :body => fixture('sent_mailings_org.xml'), :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+      resp = @client.get_sent_mailings_for_org("1/1/2014 00:00:00", "1/2/2014 23:59:59")
+      expect(resp.Envelope.Body.RESULT.Mailing[0].MailingId).to eql "5758"
+    end
+
+    it "returns the mailingId for the given dates when passing an option" do
+      stub_post("/XMLAPI").
+        with(:body => "<Envelope><Body><GetSentMailingsForOrg><PRIVATE/><DATE_START>1/1/2014 00:00:00</DATE_START><DATE_END>1/2/2014 23:59:59</DATE_END></GetSentMailingsForOrg></Body></Envelope>").
+        to_return(:status => 200, :body => fixture('sent_mailings_org.xml'), :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+      resp = @client.get_sent_mailings_for_org("1/1/2014 00:00:00", "1/2/2014 23:59:59", {PRIVATE: nil})
+      expect(resp.Envelope.Body.RESULT.Mailing[0].MailingId).to eql "5758"
+    end
+
+    it "returns the SentMailingCount" do
+      stub_post("/XMLAPI").
+        with(:body => "<Envelope><Body><GetSentMailingsForOrg><MAILING_COUNT_ONLY/><DATE_START>1/1/2014 00:00:00</DATE_START><DATE_END>1/2/2014 23:59:59</DATE_END></GetSentMailingsForOrg></Body></Envelope>").
+        to_return(:status => 200, :body => "<Envelope><Body><RESULT><SUCCESS>TRUE</SUCCESS><SentMailingsCount>5758</SentMailingsCount></RESULT></Body></Envelope>", :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+      resp = @client.get_sent_mailings_for_org("1/1/2014 00:00:00", "1/2/2014 23:59:59", {MAILING_COUNT_ONLY: nil})
+      expect(resp.Envelope.Body.RESULT.SentMailingsCount).to eql "5758"
+    end
+
+  end
+
+  describe ".raw_recipient_data_export" do
+    it "should return true when passing a MAILING_ID" do
+      stub_post("/XMLAPI").
+        with(:body => "<Envelope><Body><RawRecipientDataExport><MAILING><MAILING_ID>1234</MAILING_ID></MAILING></RawRecipientDataExport></Body></Envelope>").
+          to_return(:status => 200, :body => fixture("reporting.xml"), :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+
+      resp = @client.raw_recipient_data_export({MAILING_ID: 1234})
+      expect(resp.Envelope.Body.RESULT.SUCCESS).to eql "TRUE"
+    end
+
+    it "should return true when passing a REPORT_ID" do
+      stub_post("/XMLAPI").
+        with(:body => "<Envelope><Body><RawRecipientDataExport><MAILING><REPORT_ID>5678</REPORT_ID></MAILING></RawRecipientDataExport></Body></Envelope>").
+          to_return(:status => 200, :body => fixture("reporting.xml"), :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+
+      resp = @client.raw_recipient_data_export({REPORT_ID: 5678})
+      expect(resp.Envelope.Body.RESULT.SUCCESS).to eql "TRUE"
+    end
+
+    it "should return true when passing a EVENT_DATE_START and EVENT_DATE_END" do
+      stub_post("/XMLAPI").
+         with(:body => "<Envelope><Body><RawRecipientDataExport><EVENT_DATE_START>1/1/2013</EVENT_DATE_START><EVENT_DATE_END>7/1/2013</EVENT_DATE_END></RawRecipientDataExport></Body></Envelope>").
+          to_return(:status => 200, :body => fixture("reporting.xml"), :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+
+      resp = @client.raw_recipient_data_export({EVENT_DATE_START: "1/1/2013", EVENT_DATE_END: "7/1/2013"})
+      expect(resp.Envelope.Body.RESULT.SUCCESS).to eql "TRUE"
+    end
+
+    it "should return true when passing options" do
+      stub_post("/XMLAPI").
+        with(:body => "<Envelope><Body><RawRecipientDataExport><MAILING><MAILING_ID>1234</MAILING_ID></MAILING><MOVE_TO_FTP/></RawRecipientDataExport></Body></Envelope>").
+          to_return(:status => 200, :body => fixture("reporting.xml"), :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+      resp = @client.raw_recipient_data_export({MAILING_ID: 1234},{MOVE_TO_FTP: nil})
+      expect(resp.Envelope.Body.RESULT.SUCCESS).to eql "TRUE"
+    end
+
+    it "should return true when passing extra columns to export" do
+      stub_post("/XMLAPI").
+        with(:body => "<Envelope><Body><RawRecipientDataExport><MAILING><MAILING_ID>1234</MAILING_ID></MAILING><COLUMNS><COLUMN><NAME>CustomerID</NAME></COLUMN><COLUMN><NAME>Address</NAME></COLUMN></COLUMNS></RawRecipientDataExport></Body></Envelope>").
+          to_return(:status => 200, :body => fixture("reporting.xml"), :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+      resp = @client.raw_recipient_data_export({MAILING_ID: 1234},{}, ["CustomerID", "Address"])
+      expect(resp.Envelope.Body.RESULT.SUCCESS).to eql "TRUE"
+    end
+  end
+
+  describe ".get_job_status" do
+    it "returns the job_status for the given job_id" do
+      stub_post("/XMLAPI").
+        with(:body => "<Envelope><Body><GetJobStatus><JOB_ID>1234</JOB_ID></GetJobStatus></Body></Envelope>").
+          to_return(:status => 200, :body => '<Envelope><Body><RESULT><SUCCESS>TRUE</SUCCESS>
+                    <JOB_ID>1234</JOB_ID><JOB_STATUS>COMPLETE</JOB_STATUS>
+                    <JOB_DESCRIPTION> Creating new contact source, Master Database</JOB_DESCRIPTION>
+                    <PARAMETERS><PARAMETER><NAME>NOT_ALLOWED</NAME><VALUE>0</VALUE></PARAMETER></PARAMETERS>
+                    </RESULT></Body></Envelope>', :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+
+      resp = @client.get_job_status(1234)
+      expect(resp.Envelope.Body.RESULT.JOB_STATUS).to eql "COMPLETE"
+    end
+  end
+
+end

data/spec/client/user_spec.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+describe Acoustic::Client::User do
+  before do
+    @client = Acoustic.new({access_token: "abc123",url: 'https://api-campaign-us-1.goacoustic.com'})
+  end
+
+  describe ".export_list" do
+    it 'returns the job_id' do
+      stub_post("/XMLAPI").
+          with(:body => "<Envelope><Body><ExportList><LIST_ID>59294</LIST_ID><EXPORT_TYPE>ALL</EXPORT_TYPE><EXPORT_FORMAT>CSV</EXPORT_FORMAT></ExportList></Body></Envelope>").
+          to_return(:status => 200, :body => "<Envelope><Body><RESULT><SUCCESS>TRUE</SUCCESS><JOB_ID>499600</JOB_ID><FILE_PATH>file.CSV</FILE_PATH></RESULT></Body></Envelope>", :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+      resp = @client.export_list('59294', 'ALL', 'CSV')
+      expect(resp.Envelope.Body.RESULT.JOB_ID).to eql "499600"
+    end
+
+    it 'returns the job_id when passing options' do
+      stub_post("/XMLAPI").
+          with(:body => "<Envelope><Body><ExportList><LIST_ID>59294</LIST_ID><EXPORT_TYPE>ALL</EXPORT_TYPE><EXPORT_FORMAT>CSV</EXPORT_FORMAT><ADD_TO_STORED_FILES/><DATE_START>07/25/2011 12:12:11</DATE_START><DATE_END>09/30/2011 14:14:11</DATE_END><EXPORT_COLUMNS><COLUMN>FIRST_NAME</COLUMN><COLUMN>INITIAL</COLUMN><COLUMN>LAST_NAME</COLUMN></EXPORT_COLUMNS></ExportList></Body></Envelope>").
+          to_return(:status => 200, :body => "<Envelope><Body><RESULT><SUCCESS>TRUE</SUCCESS><JOB_ID>499600</JOB_ID><FILE_PATH>file.CSV</FILE_PATH></RESULT></Body></Envelope>", :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+      resp = @client.export_list('59294', 'ALL', 'CSV', {ADD_TO_STORED_FILES: nil, DATE_START: "07/25/2011 12:12:11", DATE_END: "09/30/2011 14:14:11"}, ["FIRST_NAME","INITIAL","LAST_NAME"])
+      expect(resp.Envelope.Body.RESULT.JOB_ID).to eql "499600"
+    end
+  end
+
+  describe ".export_table" do
+    it 'returns the job_id of the relational table' do
+      stub_post("/XMLAPI").
+        with(:body => "<Envelope><Body><ExportTable><TABLE_NAME>59294</TABLE_NAME><EXPORT_FORMAT>CSV</EXPORT_FORMAT><ADD_TO_STORED_FILES/><DATE_START>07/25/2011 12:12:11</DATE_START><DATE_END>09/30/2011 14:14:11</DATE_END></ExportTable></Body></Envelope>").
+        to_return(:status => 200, :body => "<Envelope><Body><RESULT><SUCCESS>TRUE</SUCCESS><JOB_ID>499600</JOB_ID><FILE_PATH>file.CSV</FILE_PATH></RESULT></Body></Envelope>", :headers => {'Content-type' => "text/xml", 'Authorization' => 'Bearer abc123'})
+
+      resp = @client.export_table('59294','CSV',{ADD_TO_STORED_FILES: nil,  DATE_START: "07/25/2011 12:12:11", DATE_END:"09/30/2011 14:14:11"})
+      expect(resp.Envelope.Body.RESULT.JOB_ID).to eql "499600"
+    end
+  end
+end

data/spec/fixtures/contact.xml

@@ -0,0 +1,10 @@
+<Envelope>
+  <Body>
+    <RESULT>
+      <SUCCESS>TRUE</SUCCESS>
+      <RecipientId>12345</RecipientId>
+      <ORGANIZATION_ID>xyz257</ORGANIZATION_ID>
+    </RESULT>
+  </Body>
+</Envelope>
+

data/spec/fixtures/relational_table.xml

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

data/spec/fixtures/reporting.xml

@@ -0,0 +1,14 @@
+<Envelope>
+  <Body>
+    <RESULT>
+      <SUCCESS>TRUE</SUCCESS>
+      <MAILING>
+        <JOB_ID>72649</JOB_ID>
+        <FILE_PATH>15167_20041213100410_track.zip</FILE_PATH>
+      </MAILING>
+    </RESULT>
+  </Body>
+</Envelope>
+
+
+

data/spec/fixtures/sent_mailings_org.xml

@@ -0,0 +1,33 @@
+<Envelope>
+  <Body>
+    <RESULT>
+      <SUCCESS>TRUE</SUCCESS>
+      <Mailing>
+        <MailingId>5758</MailingId>
+        <ReportId>109118</ReportId>
+        <ScheduledTS>2011-06-14 10:54:06.0</ScheduledTS>
+        <MailingName><![CDATA[This is the mailing name]]></MailingName>
+        <ListName><![CDATA[This is the database name]]></ListName>
+        <ListId>4615</ListId>
+        <UserName> John Doe </UserName>
+        <SentTS/>
+        <NumSent>0</NumSent>
+        <Subject><![CDATA[Summer Sale]]></Subject>
+        <Visibility>Private</Visibility>
+      </Mailing>
+      <Mailing>
+        <MailingId>5758</MailingId>
+        <ReportId>109118</ReportId>
+        <ScheduledTS>2011-06-14 10:54:06.0</ScheduledTS>
+        <MailingName><![CDATA[My Mailing 2]]></MailingName>
+        <ListName><![CDATA[This is the database name 2]]></ListName>
+        <ListId>4616</ListId>
+        <UserName>John Doe</UserName>
+        <SentTS/>
+        <NumSent>0</NumSent>
+        <Subject><![CDATA[Summer Sale]]></Subject>
+        <Visibility>Private</Visibility>
+      </Mailing>
+    </RESULT>
+  </Body>
+</Envelope>

data/spec/helper.rb

@@ -0,0 +1,26 @@
+unless ENV['CI']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'spec'
+  end
+end
+require 'acoustic'
+require 'rspec'
+require 'webmock/rspec'
+require 'pry'
+
+def stub_post(url)
+  stub_request(:post, acoustic_url(url))
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+def acoustic_url(url)
+  "https://api-campaign-us-1.goacoustic.com#{url}"
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: goacoustic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Anderson, Upworthy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for the Acoustic API
+email: adam.anderson@harman.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gemtest"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- goacoustic.gemspec
+- lib/acoustic.rb
+- lib/acoustic/client.rb
+- lib/acoustic/connection.rb
+- lib/acoustic/request.rb
+- lib/acoustic/version.rb
+- lib/client/contact.rb
+- lib/client/relational_table.rb
+- lib/client/reporting.rb
+- lib/client/user.rb
+- spec/acoustic_spec.rb
+- 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
+homepage: http://www.github.com/harman-signal-processing/goacoustic
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Acoustic API
+test_files:
+- spec/acoustic_spec.rb
+- 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