unresponsys 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a350c5273bc6ce627b267a064861def986886f0
-  data.tar.gz: 4fdd7c8eb7cc221c4d6aa1c3d78d27a98ab40635
+  metadata.gz: 7ad00b0e458c1b1740c500dc74c84619d32eefe6
+  data.tar.gz: c8154f6112c4b87fca895b4343b63bd47ed1369f
 SHA512:
-  metadata.gz: 1f2e0a734df43f365dc9bcf2f6a01ae9409539a05ba013f15eabab9226a66b7c2533d7c8a06e63e151d45f96219be5e502f2848e337e437f0937275cf0c80d47
-  data.tar.gz: 7df6e15a7f97a32291421ecc878a7ade06aea657dd3181bdec97a44480cc3e4ec1d492951240490088fc558bcf402f6f593220927be512e030a5677cc6044e4e
+  metadata.gz: defb91efe2c2e71087fc4d7863a49a83d173a6a4a451489852c8c8a96b6e6823b051fd263466fafe7cc35ee85f47374bd9a1682fb0b1ac7e005f9121ec868d69
+  data.tar.gz: e5efb7ac81fb4fc38d6e55ae83fff871206420ede771c4a5fc0a2061801a8a75d7922d556e2d21c1c0f24063a70e746cf5be8c67b6a2e1857452b71d4cd5c000

data/lib/unresponsys.rb

@@ -1,12 +1,16 @@
 require 'unresponsys/client'
 require 'unresponsys/event'
+require 'unresponsys/events'
 require 'unresponsys/extension_table'
+require 'unresponsys/extension_tables'
 require 'unresponsys/errors'
 require 'unresponsys/folder'
 require 'unresponsys/helpers'
 require 'unresponsys/list'
 require 'unresponsys/member'
 require 'unresponsys/merge_rule'
+require 'unresponsys/message'
+require 'unresponsys/messages'
 require 'unresponsys/row'
 require 'unresponsys/supplemental_table'
 require 'unresponsys/version'

data/lib/unresponsys/event.rb

@@ -7,19 +7,36 @@ class Unresponsys
     def initialize(options = {})
       @event_name = options[:event]
       @member     = options[:member]
+      @properties = options[:properties]
     end
 
     def save
-      body = {
+      build_body
+      build_properties
+      response = client.post("/events/#{@event_name}", body: @body.to_json)
+      response.first['errorMessage'].blank?
+    end
+
+    private
+
+    def build_body
+      @body = {
         customEvent: {},
         recipientData: [{
-          recipient: { listName: { objectName: @member.list.name }, recipientId:  @member.riid }
+          recipient: {
+            listName: { objectName: @member.list.name },
+            recipientId: @member.riid
+          }
         }]
       }
+    end
 
-      r = client.post("/events/#{@event_name}", body: body.to_json)
-      return false if r.first['errorMessage'].present?
-      true
+    def build_properties
+      return unless @properties.present?
+      @body[:recipientData].first[:optionalData] = []
+      @properties.each_pair do |key, val|
+        @body[:recipientData].first[:optionalData] << { name: key.to_s, value: val.to_s }
+      end
     end
   end
 end

data/lib/unresponsys/events.rb

@@ -0,0 +1,11 @@
+class Unresponsys
+  class Events
+    def initialize(member)
+      @member = member
+    end
+
+    def new(event, properties = {})
+      Event.new(member: @member, event: event, properties: properties)
+    end
+  end
+end

data/lib/unresponsys/extension_tables.rb

@@ -0,0 +1,11 @@
+class Unresponsys
+  class ExtensionTables
+    def initialize(member)
+      @member = member
+    end
+
+    def find(name)
+      ExtensionTable.new(@member, name)
+    end
+  end
+end

data/lib/unresponsys/member.rb

@@ -67,28 +67,12 @@ class Unresponsys
       @events ||= Events.new(self)
     end
 
-    class Events
-      def initialize(member)
-        @member = member
-      end
-
-      def new(event, properties = {})
-        Event.new(member: @member, event: event, properties: properties)
-      end
-    end
-
     def extension_tables
       @extension_tables ||= ExtensionTables.new(self)
     end
 
-    class ExtensionTables
-      def initialize(member)
-        @member = member
-      end
-
-      def find(name)
-        Unresponsys::ExtensionTable.new(@member, name)
-      end
+    def messages
+      @messages ||= Messages.new(self)
     end
 
     def to_h

data/lib/unresponsys/message.rb

@@ -0,0 +1,41 @@
+class Unresponsys
+  class Message
+    extend Forwardable
+    delegate [:client] => :member
+    attr_reader :member
+
+    def initialize(options = {})
+      @message_name = options[:message]
+      @member       = options[:member]
+      @properties   = options[:properties]
+    end
+
+    def save
+      build_body
+      build_properties
+      response = client.post("/campaigns/#{@message_name}/email", body: @body.to_json)
+      response.first['errorMessage'].blank?
+    end
+
+    private
+
+    def build_body
+      @body = {
+        recipientData: [{
+          recipient: {
+            listName: { objectName: @member.list.name },
+            recipientId: @member.riid
+          }
+        }]
+      }
+    end
+
+    def build_properties
+      return unless @properties.present?
+      @body[:recipientData].first[:optionalData] = []
+      @properties.each_pair do |key, val|
+        @body[:recipientData].first[:optionalData] << { name: key.to_s, value: val.to_s }
+      end
+    end
+  end
+end

data/lib/unresponsys/messages.rb

@@ -0,0 +1,11 @@
+class Unresponsys
+  class Messages
+    def initialize(member)
+      @member = member
+    end
+
+    def new(message, properties = {})
+      Message.new(member: @member, message: message, properties: properties)
+    end
+  end
+end

data/lib/unresponsys/version.rb

@@ -1,3 +1,3 @@
 class Unresponsys
-  VERSION = '0.3.5'
+  VERSION = '0.4.0'
 end

data/spec/event_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Unresponsys::Event do
+
+  before(:each) do
+    @client = Unresponsys::Client.new(username: ENV['R_USER'], password: ENV['R_PASS'])
+    allow(@client).to receive(:authenticate).and_return(true)
+
+    VCR.use_cassette('get_existing_member') do
+      list = @client.lists.find('TestDataList')
+      @member = list.members.find('kwkimball@gmail.com')
+    end
+  end
+
+  describe '#save' do
+    before(:each) do
+      @event = @member.events.new('Sign_Up')
+    end
+
+    it 'posts to Responsys' do
+      VCR.use_cassette('save_new_event') do
+        expect(@client).to receive(:post).and_call_original
+        @event.save
+      end
+    end
+
+    it 'returns true' do
+      VCR.use_cassette('save_new_event') do
+        expect(@event.save).to eq(true)
+      end
+    end
+
+    context 'with undefined event' do
+      it 'returns an error' do
+        VCR.use_cassette('save_new_event_undefined') do
+          @event = @member.events.new('MyEvent')
+          expect { @event.save }.to raise_error(Unresponsys::NotFound)
+        end
+      end
+    end
+  end
+
+end

data/spec/extension_table_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Unresponsys::ExtensionTable do
+
+  before :each do
+    @client = Unresponsys::Client.new(username: ENV['R_USER'], password: ENV['R_PASS'])
+    allow(@client).to receive(:authenticate).and_return(true)
+
+    VCR.use_cassette('get_existing_member') do
+      list = @client.lists.find('TestDataList')
+      @member = list.members.find('kwkimball@gmail.com')
+    end
+
+    @table = @member.extension_tables.find('TestExtensionTable')
+  end
+
+  describe '#update' do
+    context 'existing record' do
+      it 'posts to Responsys' do
+        VCR.use_cassette('update_existing_extension_row') do
+          expect(@client).to receive(:post).and_call_original
+          @table.update(title: 'My New Title')
+        end
+      end
+
+      it 'returns true' do
+        VCR.use_cassette('update_existing_extension_row') do
+          expect(@table.update(title: 'My New Title')).to eq(true)
+        end
+      end
+    end
+
+    context 'new record' do
+
+    end
+  end
+
+end

data/spec/folder_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Unresponsys::Folder do
+
+  before(:each) do
+    @client = Unresponsys::Client.new(username: ENV['R_USER'], password: ENV['R_PASS'])
+    allow(@client).to receive(:authenticate).and_return(true)
+  end
+
+  it '.find returns an instance of Folder' do
+    folder = @client.folders.find('TestData')
+    expect(folder).to be_an_instance_of(Unresponsys::Folder)
+  end
+
+  context do
+    before :each do
+      @folder = @client.folders.find('TestData')
+    end
+
+    it '#supplemental_tables.find returns an instance of SupplementalTable' do
+      table = @folder.supplemental_tables.find('MyTable')
+      expect(table).to be_an_instance_of(Unresponsys::SupplementalTable)
+    end
+  end
+
+end

data/spec/helpers_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe 'Monkey patches' do
+  describe Object do
+    it 'converts to responsys' do
+      obj = Object.new
+      expect(obj.to_responsys).to eq obj.to_s
+    end
+  end
+
+  describe String do
+    it 'converts to int' do
+      expect('123'.to_ruby).to eq 123
+    end
+
+    it 'doesnt convert hex strings to int' do
+      expect('1e9993'.to_ruby).to eq '1e9993'
+    end
+
+    it 'converts to float' do
+      expect('1.23'.to_ruby).to eq 1.23
+    end
+
+    it 'doesnt convert hex strings to float' do
+      expect('1e9993'.to_ruby).to eq '1e9993'
+    end
+  end
+end

data/spec/list_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Unresponsys::List do
+
+  before :each do
+    @client = Unresponsys::Client.new(username: ENV['R_USER'], password: ENV['R_PASS'])
+    allow(@client).to receive(:authenticate).and_return(true)
+
+    list    = @client.lists.find('TestDataList')
+    member  = list.members.new('kwkimball@gmail.com')
+    member.save
+  end
+
+  it '.find returns an instance of List' do
+    list = @client.lists.find('TestDataList')
+    expect(list).to be_an_instance_of(Unresponsys::List)
+  end
+
+  context do
+    before :each do
+      @list = @client.lists.find('TestDataList')
+    end
+
+    it '#members.find returns an instance of Member when a member exists' do
+      VCR.use_cassette('find_member_exists') do
+        member = @list.members.find('kwkimball@gmail.com')
+        expect(member).to be_an_instance_of(Unresponsys::Member)
+      end
+    end
+
+    it '#members.find raises an error when a member doesnt exist' do
+      VCR.use_cassette('find_member_doesnt_exist') do
+        expect {
+          @list.members.find('kwkimball+foo@gmail.com')
+        }.to raise_error(Unresponsys::NotFound)
+      end
+    end
+
+    it '#members.new returns an instance of Member' do
+      member = @list.members.new('kwkimball@gmail.com')
+      expect(member).to be_an_instance_of(Unresponsys::Member)
+    end
+  end
+
+end

data/spec/member_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+describe Unresponsys::Member do
+
+  before :each do
+    @client = Unresponsys::Client.new(username: ENV['R_USER'], password: ENV['R_PASS'])
+    allow(@client).to receive(:authenticate).and_return(true)
+  end
+
+  context 'when an existing member' do
+    before :each do
+      VCR.use_cassette('get_existing_member') do
+        @list = @client.lists.find('TestDataList')
+        @member = @list.members.find('kwkimball@gmail.com')
+      end
+    end
+
+    it 'Responsys attributes can be changed' do
+      @member.city = 'San Francisco'
+      expect(@member.city).to eq('San Francisco')
+    end
+
+    it 'custom attributes can be changed' do
+      @member.first_name = 'Kevin'
+      expect(@member.first_name).to eq('Kevin')
+    end
+
+    describe '#save' do
+      it 'posts to Responsys' do
+        VCR.use_cassette('save_existing_member') do
+          expect(@client).to receive(:post).and_call_original
+          @member.save
+        end
+      end
+
+      it 'returns true' do
+        VCR.use_cassette('save_existing_member') do
+          expect(@member.save).to eq(true)
+        end
+      end
+
+      it 'custom text attributes can be saved' do
+        VCR.use_cassette('save_existing_member_with_text') do
+          @member.last_name = 'Kimball'
+          @member.save
+          @member = @list.members.find('kwkimball@gmail.com')
+          expect(@member.last_name).to eq('Kimball')
+        end
+      end
+
+      it 'custom number attributes can be saved' do
+        VCR.use_cassette('save_existing_member_with_number') do
+          @member.total_revenue = 101.23
+          @member.save
+          @member = @list.members.find('kwkimball@gmail.com')
+          expect(@member.total_revenue).to eq(101.23)
+        end
+      end
+
+      it 'custom integer attributes can be saved' do
+        VCR.use_cassette('save_existing_member_with_integer') do
+          @member.age = 30
+          @member.save
+          @member = @list.members.find('kwkimball@gmail.com')
+          expect(@member.age).to eq(30)
+        end
+      end
+
+      it 'custom timestamp attributes can be saved' do
+        VCR.use_cassette('save_existing_member_with_timestamp') do
+          time = Time.new(2015, 10, 7, 5, 00, 00, '-07:00')
+          @member.last_purchase = time
+          @member.save
+          @member = @list.members.find('kwkimball@gmail.com')
+          expect(@member.last_purchase).to eq(time)
+        end
+      end
+
+      it 'custom boolean attributes can be saved' do
+        VCR.use_cassette('save_existing_member_with_boolean') do
+          @member.mom = false
+          @member.save
+          @member = @list.members.find('kwkimball@gmail.com')
+          expect(@member.mom).to eq(false)
+        end
+      end
+    end
+
+    it '#events.new returns an instance of Event' do
+      expect(@member.events.new('MyEvent')).to be_an_instance_of(Unresponsys::Event)
+    end
+
+    it '#extension_tables.find returns an instance of ExtensionTable' do
+      table = @member.extension_tables.find('MyTable')
+      expect(table).to be_an_instance_of(Unresponsys::ExtensionTable)
+    end
+  end
+
+  context 'when a new member' do
+    before :each do
+      list = @client.lists.find('TestDataList')
+      @member = list.members.new('kwkimball+bar@gmail.com')
+    end
+
+    it 'Responsys attributes can be changed' do
+      @member.city = 'San Francisco'
+      expect(@member.city).to eq('San Francisco')
+    end
+
+    it 'custom attributes can be changed' do
+      @member.first_name = 'Kevin'
+      expect(@member.first_name).to eq('Kevin')
+    end
+
+    describe '#save' do
+      it 'posts to Responsys' do
+        VCR.use_cassette('save_new_member') do
+          expect(@client).to receive(:post).and_call_original
+          @member.save
+        end
+      end
+
+      it 'returns true' do
+        VCR.use_cassette('save_new_member') do
+          expect(@member.save).to eq(true)
+        end
+      end
+    end
+
+    describe '#to_h' do
+      it 'returns the correct hash' do
+        @member.city = 'San Francisco'
+        @member.first_name = 'Kevin'
+        hash = {
+          'EMAIL_ADDRESS_' => 'kwkimball+bar@gmail.com',
+          'CITY_' => 'San Francisco',
+          'FIRST_NAME' => 'Kevin'
+        }
+        expect(@member.to_h).to include(hash)
+      end
+    end
+  end
+
+end

data/spec/message_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Unresponsys::Message do
+
+  before(:each) do
+    @client = Unresponsys::Client.new(username: ENV['R_USER'], password: ENV['R_PASS'])
+    allow(@client).to receive(:authenticate).and_return(true)
+
+    VCR.use_cassette('get_existing_member') do
+      list = @client.lists.find('TestDataList')
+      @member = list.members.find('kwkimball@gmail.com')
+    end
+  end
+
+  describe '#save' do
+    before(:each) do
+      @message = @member.messages.new('KevinTest')
+    end
+
+    it 'posts to Responsys' do
+      VCR.use_cassette('save_new_message') do
+        expect(@client).to receive(:post).and_call_original
+        @message.save
+      end
+    end
+
+    it 'returns true' do
+      VCR.use_cassette('save_new_message') do
+        expect(@message.save).to eq(true)
+      end
+    end
+
+    context 'with optional data' do
+      it 'returns true' do
+        VCR.use_cassette('save_new_message_optional_data') do
+          @message = @member.messages.new('KevinTest', testdata: 'success')
+          expect(@message.save).to eq(true)
+        end
+      end
+    end
+
+    context 'with undefined campaign' do
+      it 'returns an error' do
+        VCR.use_cassette('save_new_message_undefined') do
+          @message = @member.messages.new('MyMessage')
+          expect { @message.save }.to raise_error(Unresponsys::NotFound)
+        end
+      end
+    end
+  end
+
+end

data/spec/row_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Unresponsys::Row do
+
+  before :each do
+    @client = Unresponsys::Client.new(username: ENV['R_USER'], password: ENV['R_PASS'])
+    allow(@client).to receive(:authenticate).and_return(true)
+  end
+
+  context 'when a new row' do
+    before :each do
+      folder  = @client.folders.find('TestData')
+      @table  = folder.supplemental_tables.find('TestTable')
+      @row    = @table.rows.new(1)
+
+      # at least one field must be set
+      @row.title = 'My Title'
+    end
+
+    describe '#save' do
+      it 'posts to Responsys' do
+        VCR.use_cassette('save_new_row') do
+          expect(@client).to receive(:post).and_call_original
+          @row.save
+        end
+      end
+
+      it 'returns true' do
+        VCR.use_cassette('save_new_row') do
+          expect(@row.save).to eq(true)
+        end
+      end
+    end
+
+    describe '#to_h' do
+      it 'returns the correct hash' do
+        hash = {
+          'ID_' => '1',
+          'TITLE' => 'My Title'
+        }
+        expect(@row.to_h).to include(hash)
+      end
+    end
+  end
+
+  context 'when an existing row' do
+    before :each do
+      VCR.use_cassette('get_existing_row') do
+        folder  = @client.folders.find('TestData')
+        @table  = folder.supplemental_tables.find('TestTable')
+        @row    = @table.rows.find(1)
+      end
+    end
+
+    describe '#destroy' do
+      it 'deletes to Responsys' do
+        VCR.use_cassette('delete_existing_row') do
+          expect(@client).to receive(:delete).and_call_original
+          @row.destroy
+        end
+      end
+
+      it 'returns true' do
+        VCR.use_cassette('delete_existing_row') do
+          expect(@row.destroy).to eq(true)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+require 'dotenv'
+require 'unresponsys'
+require 'rspec'
+require 'vcr'
+require 'webmock'
+require 'byebug'
+
+Dotenv.load
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.allow_http_connections_when_no_cassette = true
+end

data/spec/supplemental_table_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Unresponsys::SupplementalTable do
+
+  before :each do
+    @client = Unresponsys::Client.new(username: ENV['R_USER'], password: ENV['R_PASS'])
+    allow(@client).to receive(:authenticate).and_return(true)
+
+    folder  = @client.folders.find('TestData')
+    @table  = folder.supplemental_tables.find('TestTable')
+  end
+
+  it '#rows.find returns an instance of Row when a row exists' do
+    VCR.use_cassette('find_row_exists') do
+      row = @table.rows.find(1)
+      expect(row).to be_an_instance_of(Unresponsys::Row)
+    end
+  end
+
+  it '#rows.find raises an error when a row does not exist' do
+    VCR.use_cassette('find_row_doesnt_exist') do
+      expect {
+        @table.rows.find(2)
+      }.to raise_error(Unresponsys::NotFound)
+    end
+  end
+
+  it '#rows.new returns an instance of Row' do
+    row = @table.rows.new(2)
+    expect(row).to be_an_instance_of(Unresponsys::Row)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unresponsys
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Kevin Kimball
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -141,15 +141,29 @@ files:
 - lib/unresponsys/client.rb
 - lib/unresponsys/errors.rb
 - lib/unresponsys/event.rb
+- lib/unresponsys/events.rb
 - lib/unresponsys/extension_table.rb
+- lib/unresponsys/extension_tables.rb
 - lib/unresponsys/folder.rb
 - lib/unresponsys/helpers.rb
 - lib/unresponsys/list.rb
 - lib/unresponsys/member.rb
 - lib/unresponsys/merge_rule.rb
+- lib/unresponsys/message.rb
+- lib/unresponsys/messages.rb
 - lib/unresponsys/row.rb
 - lib/unresponsys/supplemental_table.rb
 - lib/unresponsys/version.rb
+- spec/event_spec.rb
+- spec/extension_table_spec.rb
+- spec/folder_spec.rb
+- spec/helpers_spec.rb
+- spec/list_spec.rb
+- spec/member_spec.rb
+- spec/message_spec.rb
+- spec/row_spec.rb
+- spec/spec_helper.rb
+- spec/supplemental_table_spec.rb
 homepage: 
 licenses: []
 metadata: {}
@@ -173,4 +187,14 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: an opinionated Ruby wrapper for Responsys REST API
-test_files: []
+test_files:
+- spec/event_spec.rb
+- spec/extension_table_spec.rb
+- spec/folder_spec.rb
+- spec/helpers_spec.rb
+- spec/list_spec.rb
+- spec/member_spec.rb
+- spec/message_spec.rb
+- spec/row_spec.rb
+- spec/spec_helper.rb
+- spec/supplemental_table_spec.rb