goacoustic 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1be8c3589dd5a04b36baefaf5f1afefa1be1d35bcff0b9aeb9190d1aa7718e65
-  data.tar.gz: 7413c19d7d8a11d8d2a40d1fafdb87ec047f888d7542cf0c71c167e746c6d902
+  metadata.gz: a3f302e81b48776bbc4131a0ef4aea3849f6ecef29c12159460a462a0e45d8da
+  data.tar.gz: 5a85666558b193c66543a6f7631ef3f201770aaa6fdcebe67a8a8a641159352b
 SHA512:
-  metadata.gz: 83b5148cb725a68ab7ba4b8e6224c7947245d43136901f0420b395fdbe9445cd643cc8c9efc9604e97d9183d09a50b4f6fd8f19d6dc6299a5e69bc0f6e2cfc1a
-  data.tar.gz: 9cc297d2abde9fcc6e27d8a5dd68a91771d5faf0c8852b265806a74b8dc9b4c44fd8396630bf02d29b4f58399790acff1c3ab7bc6214d468a89b74980b08ebf0
+  metadata.gz: 4cb24943d0eda6bdc26e3f0f3e9e2ff1edc2c7a9e36e15cfb3d962737d5ec147d9d3116807bae2e29421148212937ad7baf2b7c46864979ab04e7097d74a9abc
+  data.tar.gz: 791dcda134bd270e961e9d6c8505aa34922e0192aa100672d5ec250fff69e38f77458424c5bd027d034cc496643527e8c96514a77baa6bf56371ea0e15fa1587

data/README.md

@@ -11,14 +11,14 @@ A Ruby wrapper for the Acoustic API
 
 
 ## Usage Examples
-    require 'acoustic'
+    require 'goacoustic'
     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"})
+    @client = GoAcoustic.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

data/goacoustic.gemspec

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require File.expand_path('../lib/acoustic/version', __FILE__)
+require File.expand_path('../lib/goacoustic/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.add_dependency 'addressable', '~> 2.7'
@@ -22,5 +22,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.summary     = gem.description
   gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.version     = Acoustic::VERSION
+  gem.version     = GoAcoustic::VERSION
 end

data/lib/client/contact.rb

@@ -1,15 +1,15 @@
-module Acoustic
+module GoAcoustic
   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 fields [Hash] The list of fields to be passed into GoAcoustic.
       # @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 = GoAcoustic::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

data/lib/client/relational_table.rb

@@ -1,4 +1,4 @@
-module Acoustic
+module GoAcoustic
   class Client
     module RelationalTable
       # InsertUpdateRelationalTable - This interface inserts or updates relational data.
@@ -7,7 +7,7 @@ module Acoustic
       # @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 = GoAcoustic.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
@@ -43,7 +43,7 @@ module Acoustic
     # @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 = GoAcoustic.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

data/lib/client/reporting.rb

@@ -1,4 +1,4 @@
-module Acoustic
+module GoAcoustic
   class Client
     module Reporting
 
@@ -9,7 +9,7 @@ module Acoustic
       # @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 = GoAcoustic.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
@@ -36,7 +36,7 @@ module Acoustic
       # @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 = GoAcoustic.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
@@ -79,7 +79,7 @@ module Acoustic
       # @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 = GoAcoustic.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

data/lib/client/user.rb

@@ -1,4 +1,4 @@
-module Acoustic
+module GoAcoustic
   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.
@@ -10,7 +10,7 @@ module Acoustic
       # @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 = GoAcoustic.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

data/lib/{acoustic.rb → goacoustic.rb}

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

data/lib/goacoustic/client.rb

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

data/lib/{acoustic → goacoustic}/connection.rb

@@ -1,12 +1,12 @@
 require 'faraday_middleware'
 
-module Acoustic
+module GoAcoustic
   # @private
   module Connection
     private
 
     def connection(options={})
-      connection = Faraday.new @acoustic_url do |conn|
+      connection = Faraday.new @goacoustic_url do |conn|
         # Uncomment if want to log to stdout
         #conn.response :logger
 

data/lib/{acoustic → goacoustic}/request.rb

@@ -1,4 +1,4 @@
-module Acoustic
+module GoAcoustic
   module Request
     def post(body)
       request(:post, body)
@@ -6,7 +6,7 @@ module Acoustic
 
     private
 
-    # POST the XML to the Acoustic end point.
+    # POST the XML to the GoAcoustic 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

data/lib/goacoustic/version.rb

@@ -0,0 +1,3 @@
+module GoAcoustic
+  VERSION = "0.1.1"
+end

data/spec/client/contact_spec.rb

@@ -1,8 +1,8 @@
 require 'helper'
 
-describe Acoustic::Client::Contact do
+describe GoAcoustic::Client::Contact do
   before do
-    @client = Acoustic::Client.new({access_token: "abc123",url: 'https://api-campaign-us-1.goacoustic.com'})
+    @client = GoAcoustic::Client.new({access_token: "abc123",url: 'https://api-campaign-us-1.goacoustic.com'})
   end
 
   describe "#add_recipient" do

data/spec/client/relational_table_spec.rb

@@ -1,8 +1,8 @@
 require 'helper'
 
-describe Acoustic::Client::RelationalTable do
+describe GoAcoustic::Client::RelationalTable do
   before do
-    @client = Acoustic.new access_token: 'abc123', url: 'https://api-campaign-us-1.goacoustic.com'
+    @client = GoAcoustic.new access_token: 'abc123', url: 'https://api-campaign-us-1.goacoustic.com'
   end
 
   describe '.insert_update_relational_table' do

data/spec/client/reporting_spec.rb

@@ -1,8 +1,8 @@
 require 'helper'
 
-describe Acoustic::Client::Reporting do
+describe GoAcoustic::Client::Reporting do
   before do
-    @client = Acoustic.new({access_token: "abc123",url: 'https://api-campaign-us-1.goacoustic.com'})
+    @client = GoAcoustic.new({access_token: "abc123",url: 'https://api-campaign-us-1.goacoustic.com'})
   end
 
   describe ".get_sent_mailings_for_org" do

data/spec/client/user_spec.rb

@@ -1,8 +1,8 @@
 require 'helper'
 
-describe Acoustic::Client::User do
+describe GoAcoustic::Client::User do
   before do
-    @client = Acoustic.new({access_token: "abc123",url: 'https://api-campaign-us-1.goacoustic.com'})
+    @client = GoAcoustic.new({access_token: "abc123",url: 'https://api-campaign-us-1.goacoustic.com'})
   end
 
   describe ".export_list" do

data/spec/goacoustic_spec.rb

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

data/spec/helper.rb

@@ -4,13 +4,13 @@ unless ENV['CI']
     add_filter 'spec'
   end
 end
-require 'acoustic'
+require 'goacoustic'
 require 'rspec'
 require 'webmock/rspec'
 require 'pry'
 
 def stub_post(url)
-  stub_request(:post, acoustic_url(url))
+  stub_request(:post, goacoustic_url(url))
 end
 
 def fixture_path
@@ -21,6 +21,6 @@ def fixture(file)
   File.new(fixture_path + '/' + file)
 end
 
-def acoustic_url(url)
+def goacoustic_url(url)
   "https://api-campaign-us-1.goacoustic.com#{url}"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goacoustic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adam Anderson, Upworthy
@@ -152,16 +152,15 @@ files:
 - 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
+- lib/goacoustic.rb
+- lib/goacoustic/client.rb
+- lib/goacoustic/connection.rb
+- lib/goacoustic/request.rb
+- lib/goacoustic/version.rb
 - spec/client/contact_spec.rb
 - spec/client/relational_table_spec.rb
 - spec/client/reporting_spec.rb
@@ -170,6 +169,7 @@ files:
 - spec/fixtures/relational_table.xml
 - spec/fixtures/reporting.xml
 - spec/fixtures/sent_mailings_org.xml
+- spec/goacoustic_spec.rb
 - spec/helper.rb
 homepage: http://www.github.com/harman-signal-processing/goacoustic
 licenses:
@@ -195,7 +195,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
@@ -204,4 +203,5 @@ test_files:
 - spec/fixtures/relational_table.xml
 - spec/fixtures/reporting.xml
 - spec/fixtures/sent_mailings_org.xml
+- spec/goacoustic_spec.rb
 - spec/helper.rb

data/lib/acoustic/client.rb

@@ -1,23 +0,0 @@
-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/version.rb

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

data/spec/acoustic_spec.rb

@@ -1,15 +0,0 @@
-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