unresponsys 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81c6829cb73e851171e77c2a870038cd8c98d9ee
-  data.tar.gz: 048c2fcc64e0456265a3f4e013974b74325a579f
+  metadata.gz: 9ab97914beb02ad40643f37e22de5b06a9e7070d
+  data.tar.gz: e0926c1dfbf45986635cc7933f4b5712da8f3d8c
 SHA512:
-  metadata.gz: 2056c1232ea19785931b7b92abf1cb5a682fba123cd7617dcab252fa6e6846e9a86731c97aa544d31c7c4005b3a8ba86283aee33e73bfec0c06856679de6d771
-  data.tar.gz: bf075cce79a98a385c8e960c46cbe09442eaab7a3a2670471656d259d37f82a2c9aa1f306ad63f08c75a2bc2daacccb0cc819b990fd3150896fba022a427b54e
+  metadata.gz: 9b7130d8de52d61196231af0db584e5ef2c661c5c2877e70605df10fb54aaf80e28d205993bb05a8b2add846bcf9d038f5d90fa0882f46ed6409304599c3b1f0
+  data.tar.gz: a71246553a866bc3ceada31664ff8bbd7f257485d360f03c6b095e6a51a8187dc0e7959ed2397763b4b014924e1e85b5e3690fec4e5f67bce35e51ad08e0a639

data/lib/unresponsys.rb

@@ -0,0 +1,12 @@
+require 'active_support'
+require 'active_support/all'
+require 'unresponsys/client'
+require 'unresponsys/event'
+require 'unresponsys/errors'
+require 'unresponsys/folder'
+require 'unresponsys/helpers'
+require 'unresponsys/list'
+require 'unresponsys/member'
+require 'unresponsys/row'
+require 'unresponsys/table'
+require 'unresponsys/version'

data/lib/unresponsys/client.rb

@@ -0,0 +1,70 @@
+require 'httparty'
+
+class Unresponsys
+  class Client
+    include HTTParty
+
+    def initialize(options = {})
+      @@username ||= options[:username]
+      @@password ||= options[:password]
+      raise Unresponsys::Error, 'Could not authenticate' unless authenticate
+      self.class.debug_output($stdout) if options[:debug]
+    end
+
+    def self.get(path, options = {}, &block)
+      begin
+        r = perform_request Net::HTTP::Get, path, options, &block
+        handle_error(r)
+      rescue Unresponsys::Retry
+        r = perform_request Net::HTTP::Get, path, options, &block
+        handle_error(r)
+      end
+    end
+
+    def self.post(path, options = {}, &block)
+      begin
+        r = perform_request Net::HTTP::Post, path, options, &block
+        handle_error(r)
+      rescue Unresponsys::Retry
+        r = perform_request Net::HTTP::Post, path, options, &block
+        handle_error(r)
+      end
+    end
+
+    def self.delete(path, options = {}, &block)
+      begin
+        r = perform_request Net::HTTP::Delete, path, options, &block
+        handle_error(r)
+      rescue Unresponsys::Retry
+        r = perform_request Net::HTTP::Delete, path, options, &block
+        handle_error(r)
+      end
+    end
+
+    private
+
+    def self.handle_error(response)
+      if response.is_a?(Hash) && response.keys.include?('errorCode')
+        if response['title'].include?('token expired')
+          self.new
+          raise Unresponsys::Retry
+        end
+        if response['title'].include?('not found')
+          raise Unresponsys::NotFoundError, response['detail']
+        end
+        raise Unresponsys::Error, "#{response['title']} - #{response['detail']}"
+      end
+      response
+    end
+
+    def authenticate
+      self.class.headers('Content-Type' => 'application/x-www-form-urlencoded')
+      body = { user_name: @@username, password: @@password, auth_type: 'password' }
+      r = self.class.post('https://login2.responsys.net/rest/api/v1/auth/token', body: body)
+      return false unless r.success?
+      self.class.headers('Authorization' => r['authToken'], 'Content-Type' => 'application/json')
+      self.class.base_uri("#{r['endPoint']}/rest/api/v1")
+      true
+    end
+  end
+end

data/lib/unresponsys/errors.rb

@@ -0,0 +1,6 @@
+class Unresponsys
+  class ArgumentError < StandardError; end
+  class Error < StandardError; end
+  class NotFoundError < StandardError; end
+  class Retry < StandardError; end
+end

data/lib/unresponsys/event.rb

@@ -0,0 +1,35 @@
+class Unresponsys
+  class Event
+
+    def initialize(options = {})
+      @event_name = options[:event]
+      @member     = options[:member]
+      @properties = options[:properties]
+    end
+
+    def save
+      body = {
+        customEvent: {},
+        recipientData: [{
+          recipient: {
+            listName:     { objectName: @member.list },
+            recipientId:  @member.riid,
+          }
+        }]
+      }
+
+      # API throws an non-descriptive error if optionalData is present but empty
+      if @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
+
+      r = Unresponsys::Client.post("/events/#{@event_name}", body: body.to_json)
+      return false if r.first['errorMessage'].present?
+      true
+    end
+
+  end
+end

data/lib/unresponsys/folder.rb

@@ -0,0 +1,27 @@
+class Unresponsys
+  class Folder
+    attr_reader :name
+
+    def self.find(name)
+      self.new(name)
+    end
+
+    def initialize(name)
+      @name = name
+    end
+
+    def tables
+      @tables ||= Tables.new(self)
+    end
+
+    class Tables
+      def initialize(folder)
+        @folder = folder
+      end
+
+      def find(table_name)
+        Unresponsys::Table.new(@folder, table_name)
+      end
+    end
+  end
+end

data/lib/unresponsys/helpers.rb

@@ -0,0 +1,76 @@
+class Object
+  def to_responsys
+    self.to_s
+  end
+
+  def to_ruby
+    self
+  end
+end
+
+class String
+  def is_i?
+    return false if self.include?('.')
+    !!Integer(self) rescue false
+  end
+
+  def is_f?
+    !!Float(self) rescue false
+  end
+
+  def is_time?
+    return false if /[[:alpha:]]/.match(self).present?
+    !!Time.parse(self) rescue false
+  end
+
+  def to_time
+    Time.parse(self)
+  end
+
+  def is_bool?
+    return false unless self.length == 1
+    %w(T F).include?(self)
+  end
+
+  def to_bool
+    self == 'T'
+  end
+
+  def to_ruby
+    return self.to_i if self.is_i?
+    return self.to_f if self.is_f?
+    return self.to_time if self.is_time?
+    return self.to_bool if self.is_bool?
+    self
+  end
+end
+
+class Date
+  def to_responsys
+    self.strftime('%Y-%m-%d %H:%M:%S')
+  end
+end
+
+class DateTime
+  def to_responsys
+    self.strftime('%Y-%m-%d %H:%M:%S')
+  end
+end
+
+class Time
+  def to_responsys
+    self.strftime('%Y-%m-%d %H:%M:%S')
+  end
+end
+
+class TrueClass
+  def to_responsys
+    'T'
+  end
+end
+
+class FalseClass
+  def to_responsys
+    'F'
+  end
+end

data/lib/unresponsys/list.rb

@@ -0,0 +1,39 @@
+class Unresponsys
+  class List
+    attr_reader :name
+
+    def self.find(name)
+      self.new(name)
+    end
+
+    def initialize(name)
+      @name = name
+    end
+
+    def members
+      @members ||= Members.new(self)
+    end
+
+    class Members
+      def initialize(list)
+        @list = list
+      end
+
+      def find(email)
+        options = { query: { qa: 'e', id: email.to_responsys, fs: 'all' } }
+        r = Unresponsys::Client.get("/lists/#{@list.name}/members", options)
+
+        fields = {}
+        r['recordData']['fieldNames'].each_with_index do |field, index|
+          fields[field] = r['recordData']['records'][0][index]
+        end
+
+        Unresponsys::Member.new(@list, fields)
+      end
+
+      def new(email)
+        Unresponsys::Member.new(@list, { 'EMAIL_ADDRESS_' => email })
+      end
+    end
+  end
+end

data/lib/unresponsys/member.rb

@@ -0,0 +1,132 @@
+class Unresponsys
+  class Member
+    DEFAULT_FIELDS = {
+      'RIID_'                     => '',
+      'EMAIL_ADDRESS_'            => '',
+      'MOBILE_NUMBER_'            => '',
+      'CUSTOMER_ID_'              => '',
+      'EMAIL_PERMISSION_STATUS_'  => '',
+      'EMAIL_PERMISSION_REASON_'  => '',
+      'POSTAL_STREET_1_'          => '',
+      'POSTAL_STREET_2_'          => '',
+      'CITY_'                     => '',
+      'STATE_'                    => '',
+      'POSTAL_CODE_'              => '',
+      'COUNTRY_'                  => '',
+      'EMAIL_MD5_HASH_'           => '',
+      'EMAIL_SHA256_HASH_'        => ''
+    }
+
+    IMMUTABLE_FIELDS = %w(
+      RIID_
+      EMAIL_ADDRESS_
+      MOBILE_NUMBER_
+      EMAIL_MD5_HASH_
+      EMAIL_SHA256_HASH_
+    )
+
+    MERGE_RULE = {
+      insertOnNoMatch:            true,
+      updateOnMatch:              'REPLACE_ALL',
+      matchColumnName1:           'EMAIL_ADDRESS_',
+      matchColumnName2:           nil,
+      matchOperator:              nil,
+      optinValue:                 'I',
+      optoutValue:                'O',
+      defaultPermissionStatus:    'OPTIN',
+      htmlValue:                  'H',
+      textValue:                  'T',
+      rejectRecordIfChannelEmpty: nil,
+    }
+
+    def initialize(list, fields)
+      @fields     = DEFAULT_FIELDS.merge(fields)
+      @list       = list
+      @changed    = ['EMAIL_ADDRESS_']
+
+      @fields.each_pair do |key, val|
+        str = key.downcase.chomp('_')
+        var = "@#{str}".to_sym
+        val = val.to_ruby
+        self.instance_variable_set(var, val)
+
+        # getter
+        self.class.send(:attr_reader, str)
+
+        # setter
+        next if IMMUTABLE_FIELDS.include?(key)
+        self.class.send(:define_method, "#{str}=") do |val|
+          @changed << key
+          val = val.to_ruby
+          self.instance_variable_set(var, val)
+        end
+      end
+    end
+
+    def email
+      email_address
+    end
+
+    def list
+      @list.name
+    end
+
+    def save
+      record_data = { fieldNames: [], records: [[]], mapTemplateName: nil }
+      @fields.each_pair do |key, val|
+        # can't send unless val changed or API breaks
+        next unless @changed.include?(key)
+
+        record_data[:fieldNames] << key
+        var = "@#{key.downcase.chomp('_')}".to_sym
+        val = self.instance_variable_get(var)
+        val = val.to_responsys
+        record_data[:records][0] << val
+      end
+
+      options = { body: { recordData: record_data, mergeRule: MERGE_RULE.dup }.to_json }
+      r = Unresponsys::Client.post("/lists/#{@list.name}/members", options)
+      return false if r['recordData']['records'][0][0].include?('MERGEFAILED')
+      @changed = ['EMAIL_ADDRESS_']
+      self.instance_variable_set(:@riid, r['recordData']['records'][0][0])
+      true
+    end
+
+    def delete
+      self.email_permission_status = 'O'
+      self.save
+    end
+
+    # allow to access custom fields on new record
+    def method_missing(sym, *args, &block)
+      setter  = sym.to_s.include?('=')
+      str     = sym.to_s.chomp('=')
+      var     = "@#{str}".to_sym
+      val     = args.first
+
+      if setter
+        field_name = str.upcase
+        @fields[field_name] = ''
+        @changed << field_name
+        val = val.to_ruby
+        self.instance_variable_set(var, val)
+      else
+        self.instance_variable_get(var)
+      end
+    end
+
+    def events
+      @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
+  end
+end

data/lib/unresponsys/row.rb

@@ -0,0 +1,62 @@
+class Unresponsys
+  class Row
+    def initialize(table, fields)
+      @table  = table
+      @fields = fields
+
+      @fields.each_pair do |key, val|
+        str = key.downcase.chomp('_')
+        var = "@#{str}".to_sym
+        val = val.to_ruby
+        self.instance_variable_set(var, val)
+
+        if key == 'ID_'
+          self.class.send(:attr_reader, str)
+        else
+          self.class.send(:define_method, "#{str}=") do |val|
+            val = val.to_ruby
+            self.instance_variable_set(var, val)
+          end
+        end
+      end
+    end
+
+    def save
+      record_data = { fieldNames: [], records: [[]], mapTemplateName: nil }
+      @fields.each_pair do |key, val|
+        record_data[:fieldNames] << key
+        var = "@#{key.downcase.chomp('_')}".to_sym
+        val = self.instance_variable_get(var)
+        val = val.to_responsys
+        record_data[:records][0] << val
+      end
+
+      options = { body: { recordData: record_data, insertOnNoMatch: true, updateOnMatch: 'REPLACE_ALL' }.to_json }
+      r = Unresponsys::Client.post("/folders/#{@table.folder.name}/suppData/#{@table.name}/members", options)
+      r['recordData']['records'][0][0].exclude?('MERGEFAILED')
+    end
+
+    def delete
+      options = { query: { qa: 'ID_', id: @fields.primary_key } }
+      r = Unresponsys::Client.delete("/folders/#{@table.folder.name}/suppData/#{@table.name}/members", options)
+      r['recordData']['records'][0][0].exclude?('DELETEFAILED')
+    end
+
+    # allow to access custom fields on new record
+    def method_missing(sym, *args, &block)
+      setter  = sym.to_s.include?('=')
+      str     = sym.to_s.chomp('=')
+      var     = "@#{str}".to_sym
+      val     = args.first
+
+      if setter
+        field_name = str.upcase
+        @fields[field_name] = ''
+        val = val.to_ruby
+        self.instance_variable_set(var, val)
+      else
+        self.instance_variable_get(var)
+      end
+    end
+  end
+end

data/lib/unresponsys/table.rb

@@ -0,0 +1,36 @@
+class Unresponsys
+  class Table
+    attr_reader :folder, :name
+
+    def initialize(folder, table_name)
+      @folder = folder
+      @name   = table_name
+    end
+
+    def rows
+      @rows ||= Rows.new(self)
+    end
+
+    class Rows
+      def initialize(table)
+        @table = table
+      end
+
+      def find(primary_key)
+        options = { query: { qa: 'ID_', id: primary_key.to_responsys, fs: 'all' } }
+        r = Unresponsys::Client.get("/folders/#{@table.folder.name}/suppData/#{@table.name}/members", options)
+
+        fields = {}
+        r['recordData']['fieldNames'].each_with_index do |field, index|
+          fields[field] = r['recordData']['records'][0][index]
+        end
+
+        Unresponsys::Row.new(@table, fields)
+      end
+
+      def new(primary_key)
+        Unresponsys::Row.new(@table, { 'ID_' => primary_key })
+      end
+    end
+  end
+end

data/lib/unresponsys/version.rb

@@ -0,0 +1,3 @@
+class Unresponsys
+  VERSION = '0.0.5'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unresponsys
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Kevin Kimball
@@ -114,24 +114,25 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/unresponsys.rb
+- lib/unresponsys/client.rb
+- lib/unresponsys/errors.rb
+- lib/unresponsys/event.rb
+- lib/unresponsys/folder.rb
+- lib/unresponsys/helpers.rb
+- lib/unresponsys/list.rb
+- lib/unresponsys/member.rb
+- lib/unresponsys/row.rb
+- lib/unresponsys/table.rb
+- lib/unresponsys/version.rb
 homepage: 
 licenses: []
 metadata: {}
 post_install_message: responsys sucks :(
 rdoc_options: []
 require_paths:
-- lib/unresponsys
-- lib/unresponsys/client
-- lib/unresponsys/errors
-- lib/unresponsys/event
-- lib/unresponsys/folder
-- lib/unresponsys/helpers
-- lib/unresponsys/list
-- lib/unresponsys/member
-- lib/unresponsys/row
-- lib/unresponsys/table
-- lib/unresponsys/version
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="