outbound 0.1.0

data/lib/outbound.rb

@@ -0,0 +1,183 @@
+require 'logger'
+
+module Outbound
+  VERSION = '0.1.0'
+  BASE_URL = 'https://api.outbound.io/v2'
+
+  ERROR_USER_ID = "User ID must be a string or number."
+  ERROR_EVENT_NAME = "Event name must be a string."
+  ERROR_CONNECTION = "Outbound connection error"
+  ERROR_INIT = "Must call init() before identify() or track()."
+
+  @ob = nil
+  @logger = Logger.new $stdout
+  @logger.progname = "Outbound"
+  @logger.level = Logger::ERROR
+
+  module Defaults
+    HEADERS = {
+      'Content-type' => 'application/json',
+      'X-Outbound-Client' => 'ruby',
+      'X-Outbound-Client-Version' => Outbound::VERSION,
+    }
+  end
+
+  def Outbound.init api_key, log_level=Logger::ERROR
+    @logger.level = log_level
+    @ob = Outbound::Client.new api_key, @logger
+  end
+
+  def Outbound.identify user_id, info={}, attributes={}
+    if @ob == nil
+      res = Result.new Outbound::ERROR_INIT, false
+      @logger.error res.error
+      return res
+    end
+
+    return @ob.identify user_id, info, attributes
+  end
+
+  def Outbound.track user_id, event, properties={}, user_info={}, user_attributes={}
+    if @ob == nil
+      res = Result.new Outbound::ERROR_INIT, false
+      @logger.error res.error
+      return res
+    end
+    return @ob.track user_id, event, properties, user_info, user_attributes
+  end
+
+  class Result
+    include Defaults
+
+    def initialize error, received_call
+      @error = error
+      @received_call = received_call
+    end
+
+    attr_accessor :error
+    attr_accessor :received_call
+
+    def success?
+      return @received_call && @error == nil
+    end
+
+    def user_id_error?
+      return @error == Outbound::ERROR_USER_ID
+    end
+
+    def event_name_error?
+      return @error == Outbound::ERROR_EVENT_NAME
+    end
+
+    def connection_error?
+      return @error == Outbound::ERROR_CONNECTION
+    end
+
+    def init_error?
+      return @error == Outbound::ERROR_INIT
+    end
+  end
+
+  class Client
+    include Defaults
+
+    def initialize api_key, logger
+      @api_key = api_key
+      @logger = logger
+    end
+
+    def identify user_id, info={}, attributes={}
+      unless user_id.is_a? String or user_id.is_a? Numeric
+        res = Result.new Outbound::ERROR_USER_ID, false
+        @logger.error res.error
+        return res
+      end
+
+      user_data = {:user_id => user_id}
+      begin
+        user = user(info, attributes)
+        user_data = user_data.merge user
+      rescue
+        @logger.error "Could not use user info (#{info}) and/or user attributes #{attributes} given to identify call."
+      end
+
+      return post(@api_key, '/identify', user_data)
+    end
+
+    def track user_id, event, properties={}, user_info={}, user_attributes={}
+      unless user_id.is_a? String or user_id.is_a? Numeric
+        res = Result.new Outbound::ERROR_USER_ID, false
+        @logger.error res.error
+        return res
+      end
+
+      unless event.is_a? String
+        res = Result.new Outbound::ERROR_EVENT_NAME, false
+        @logger.error res.error
+        return res
+      end
+
+      data = {:user_id => user_id, :event => event}
+
+      begin
+        user = user(user_info, user_attributes)
+        if user.length > 0
+          data[:user] = user
+        end
+      rescue
+        @logger.error "Could not use user info (#{user_info}) and/or user attributes #{user_attributes} given to track call."
+      end
+
+      if properties.is_a? Hash
+        if properties.length > 0
+          data[:properties] = properties
+        end
+      else
+        @logger.error "Could not use event properties (#{properties}) given to track call."
+      end
+
+      return post(@api_key, '/track', data)
+    end
+
+    private
+
+    def post api_key, path, data
+      begin
+        headers = HEADERS
+        headers['X-Outbound-Key'] = api_key
+        payload = JSON.generate data
+        request = Net::HTTP::Post.new("#{BASE_URL}#{path}", headers)
+
+        res = @http.request(request, payload)
+        status = res.code.to_i
+      rescue Exception => e
+        res = Result.new Outbound::ERROR_CONNECTION, false
+        @logger.error res.error
+        return res
+      end
+
+      err = nil
+      if status < 200 or status >= 400
+        err = "#{status} - #{res.body}" if res.response_body_permitted? else nil
+      end
+      return err, true
+    end
+
+    def user info={}, attributes={}
+      unless info.is_a? Hash and attributes.is_a? Hash
+        raise
+      end
+
+      user = {
+        :first_name => info[:first_name],
+        :last_name => info[:last_name],
+        :email => info[:email],
+        :phone_number => info[:phone_number],
+        :apns_tokens => info[:apns_tokens],
+        :gcm_tokens => info[:gcm_tokens],
+        :attributes => attributes,
+      }
+      return user.delete_if { |k, v| v.nil? || v.empty? }
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: outbound
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Travis Beauvais
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-07 00:00:00.000000000 Z
+dependencies: []
+description: ! 'Outbound sends automated email, SMS, phone calls and push notifications
+  based on the actions users take or do not take in your app. The Outbound API has
+  two components:
+
+
+  Identify each of your users and their attributes using an identify API call.
+
+  Track the actions that each user takes in your app using a track API call.
+
+  Because every message is associated with a user (identify call) and a specific trigger
+  action that a user took or should take (track call), Outbound is able to keep track
+  of how each message affects user actions in your app. These calls also allow you
+  to target campaigns and customize each message based on user data.
+
+
+  Example: When a user in San Francisco(user attribute) does signup(event) but does
+  not upload a picture(event) within 2 weeks, send them an email about how they''ll
+  benefit from uploading a picture.'
+email: support@outbound.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/outbound.rb
+homepage: https://outbound.io
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Outbound sends automated email, SMS, phone calls and push notifications based
+  on the actions users take (or do not take) in your app.
+test_files: []