iterable-api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42bb2967ea2ef08f5cc93822d27af65b36d0b440
+  data.tar.gz: 750faebd5fe328830223b5618c8c8cc3da28e4a3
+SHA512:
+  metadata.gz: a0d1cdf1e7041b5bdc8d28860283d2e1a8caf8da169b4f92565727af42ac1e953f13e8f7dc0b64484162eeda84d4f0e7fff7726015d276430262152e69000e50
+  data.tar.gz: 1d626042d1471182ab013508a722a52914caac7262b78c4d41a905f5e31ab20094b4c9381e31c6334653122f95d758cc4aefde208555889022e0fbe6f5a4e95e

data/lib/iterable/api.rb

@@ -0,0 +1,59 @@
+#
+# api.rb
+# Iterable
+#
+# Copyright (c) 2017 Kyle Schutt. All rights reserved.
+
+module Iterable
+  class Api
+    # Class constructor
+    # @param [String] api_key - Iterable API Key
+    # @return
+    def initialize(api_key = nil)
+      Services::BaseService.api_key = api_key || Util::Config.get('auth.api_key')
+      if Services::BaseService.api_key.nil? || Services::BaseService.api_key == ''
+        raise ArgumentError.new(Util::Config.get('errors.api_key_missing'))
+      end
+    end
+
+    # 
+    # List Services
+    # 
+    def lists
+      Services::ListService.all
+    end
+
+    def lists_subscribe(list_id, subscribers)
+      Services::ListService.subscribe(list_id, subscribers)
+    end
+
+    def list_by_id(list_id)
+      Services::ListService.find_by_id(list_id)
+    end
+
+    # 
+    # User Services
+    # 
+    def user_by_email(email)
+      Services::UserService.find_by_email(email)
+    end
+
+    def user_by_id(id)
+      Services::UserService.find_by_id(id)
+    end
+
+    def user_update(user)
+      Services::UserService.update(user)
+    end
+
+    def user_subscriptions_update
+    end
+
+    # 
+    # Commerce Services
+    # 
+    def track_purchase(track_purchase_request)
+      Services::CommerceService.track_purchase(track_purchase_request)
+    end
+  end
+end

data/lib/iterable/exceptions/service_exception.rb

@@ -0,0 +1,11 @@
+#
+# service_exception.rb
+# Iterable
+#
+# Copyright (c) 2017 Kyle Schutt. All rights reserved.
+
+module Iterable
+  module Exceptions
+    class ServiceException < Exception; end
+  end
+end

data/lib/iterable/models/base.rb

@@ -0,0 +1,11 @@
+module Iterable
+  class Base < Hashie::Dash
+    include Hashie::Extensions::Dash::Coercion
+    include Hashie::Extensions::Dash::PropertyTranslation
+
+    def initialize(hash = {})
+      # ensure we symbolize keys 
+      super(Hashie.symbolize_keys!(hash))
+    end
+  end
+end

data/lib/iterable/models/commerce_item.rb

@@ -0,0 +1,30 @@
+# {
+#   "id": "",
+#   "sku": "",
+#   "name": "",
+#   "description": "",
+#   "categories": [
+#     ""
+#   ],
+#   "price": 0,
+#   "quantity": 0,
+#   "imageUrl": "",
+#   "url": "",
+#   "dataFields": "Map[string, object]"
+# }
+module Iterable
+  class CommerceItem < Iterable::Base
+    property :id, required: true, coerce: String
+    property :name, required: true
+    property :price, required: true, coerce: Float
+    property :quantity, required: true, coerce: Integer
+
+    property :sku
+    property :description
+    property :imageUrl
+    property :url
+
+    property :categories, coerce: Array[String]
+    property :dataFields, coerce: DataFields
+  end
+end

data/lib/iterable/models/data_fields.rb

@@ -0,0 +1,4 @@
+module Iterable
+  class DataFields < Hashie::Mash
+  end
+end

data/lib/iterable/models/list_details.rb

@@ -0,0 +1,8 @@
+module Iterable
+  class ListDetails < Iterable::Base
+    property :id, coerce: Integer
+    property :name
+    property :createdAt
+    property :listType
+  end
+end

data/lib/iterable/models/requests/subscribe.rb

@@ -0,0 +1,19 @@
+# Example request
+# {  
+#   listId": 0,
+#   "subscribers": [
+#     {
+#       "email": "",
+#       "dataFields": "Map[string, object]",
+#       "userId": ""
+#     }
+#   ]
+# }
+module Iterable
+  module Requests
+    class Subscribe < Iterable::Base
+      property :listId, coerce: Integer, required: true
+      property :subscribers, coerce: Array[Iterable::User]
+    end
+  end
+end

data/lib/iterable/models/requests/track_purchase.rb

@@ -0,0 +1,43 @@
+# Example request
+# {
+#   "user": {
+#     "email": "",
+#     "dataFields": "Map[string, object]",
+#     "userId": "",
+#     "mergeNestedObjects": false
+#   },
+#   "items": [
+#     {
+#       "id": "",
+#       "sku": "",
+#       "name": "",
+#       "description": "",
+#       "categories": [
+#         ""
+#       ],
+#       "price": 0,
+#       "quantity": 0,
+#       "imageUrl": "",
+#       "url": "",
+#       "dataFields": "Map[string, object]"
+#     }
+#   ],
+#   "campaignId": 0,
+#   "templateId": 0,
+#   "total": 0,
+#   "createdAt": 0,
+#   "dataFields": "Map[string, object]"
+# }
+module Iterable
+  module Requests
+    class TrackPurchase < Iterable::Base
+      property :user, coerce: Iterable::Requests::UserUpdate, required: true
+      property :items, coerce: Array[Iterable::CommerceItem], required: true
+      property :campaignId
+      property :templateId
+      property :total, required: true
+      property :createdAt
+      property :dataFields, coerce: DataFields
+    end
+  end
+end

data/lib/iterable/models/requests/user_update.rb

@@ -0,0 +1,18 @@
+# Example request
+# {  
+#   listId": 0,
+#   "subscribers": [
+#     {
+#       "email": "",
+#       "dataFields": "Map[string, object]",
+#       "userId": ""
+#     }
+#   ]
+# }
+module Iterable
+  module Requests
+    class UserUpdate < Iterable::User
+      property :mergeNestedObjects, default: false
+    end
+  end
+end

data/lib/iterable/models/responses/error.rb

@@ -0,0 +1,10 @@
+module Iterable
+  module Responses
+    class Error < Iterable::Base
+      property :msg
+      property :code
+      property :response
+      property :params, coerce: Hashie::Mash
+    end
+  end
+end

data/lib/iterable/models/responses/general.rb

@@ -0,0 +1,9 @@
+module Iterable
+  module Responses
+    class General < Iterable::Base
+      property :msg
+      property :code
+      property :params, coerce: Hashie::Mash
+    end
+  end
+end

data/lib/iterable/models/responses/lists.rb

@@ -0,0 +1,7 @@
+module Iterable
+  module Responses
+    class Lists < Iterable::Base
+      property :lists, coerce: Array[Iterable::ListDetails]
+    end
+  end
+end

data/lib/iterable/models/responses/subscribe.rb

@@ -0,0 +1,9 @@
+module Iterable
+  module Responses
+    class Subscribe < Iterable::Base
+      property :successCount
+      property :failCount
+      property :invalidEmails, coerce: Array[String]
+    end
+  end
+end

data/lib/iterable/models/responses/user.rb

@@ -0,0 +1,7 @@
+module Iterable
+  module Responses
+    class User < Iterable::Base
+      property :user, coerce: Iterable::User
+    end
+  end
+end

data/lib/iterable/models/user.rb

@@ -0,0 +1,9 @@
+module Iterable
+  class User < Iterable::Base
+    property :email, required: true, coerce: String
+
+    property :userId, coerce: String
+    
+    property :dataFields, coerce: DataFields
+  end
+end

data/lib/iterable/services/base_service.rb

@@ -0,0 +1,79 @@
+#
+# base_service.rb
+# Iterable
+#
+# Copyright (c) 2017 Kyle Schutt. All rights reserved.
+
+module Iterable
+  module Services
+    class BaseService
+      class << self
+        attr_accessor :api_key
+
+        protected
+
+        def get(path, params = {}, response_type = Iterable::Responses::General)
+          url = URI::join(Util::Config.get('endpoints.base_url'), path).to_s
+          url = build_url(url, params)
+          response = RestClient.get(url, get_headers())
+          begin
+            response_type.new JSON.parse(response.body)
+          rescue
+            Hashie::Mash.new JSON.parse(response.body)
+          end
+        rescue RestClient::BadRequest => e
+          Iterable::Responses::Error.new(response: e.response.body, msg: e.message, code: 400)
+        end
+
+        def post(path, body = {}, params = {}, response_type = Iterable::Responses::General)
+          url = URI::join(Util::Config.get('endpoints.base_url'), path).to_s
+          url = build_url(url, params)
+          response = RestClient.post(url, body.to_json, get_headers())
+          begin
+            response_type.new JSON.parse(response.body)
+          rescue
+            Hashie::Mash.new JSON.parse(response.body)
+          end
+        rescue RestClient::BadRequest => e
+          Iterable::Responses::Error.new(response: e.response.body, msg: e.message, code: 400)
+        end
+
+        # Return required headers for making an http request with Iterable
+        # @param [String] content_type - The MIME type of the body of the request, default is 'application/json'
+        # @return [Hash] - authorization headers
+        def get_headers(content_type = 'application/json')
+          {
+            :content_type           => content_type,
+            :accept                 => 'application/json',
+            :user_agent             => "Iterable Ruby SDK v#{Iterable::VERSION} (#{RUBY_DESCRIPTION})",
+            :x_ctct_request_source  => "sdk.ruby.#{Iterable::VERSION}",
+            'Api-Key'               => BaseService.api_key
+          }
+        end
+
+        # Build a url from the base url and query parameters hash. Query parameters
+        # should not be URL encoded because this method will handle that
+        # @param [String] url - The base url
+        # @param [Hash] params - A hash with query parameters
+        # @return [String] - the url with query parameters hash 
+        def build_url(url, params = nil)
+          if params.respond_to? :each
+            params.each do |key, value|
+              # Convert dates to CC date format
+              if value.respond_to? :iso8601
+                params[key] = value.iso8601
+              end
+
+              if key.to_s == 'next' && value.match(/^.*?next=(.*)$/)
+                params[key] = $1
+              end
+            end
+          else
+            params ||= {}
+          end
+          url + '?' + Util::Helpers.http_build_query(params)
+        end
+      end
+    end
+  end
+end

data/lib/iterable/services/commerce_service.rb

@@ -0,0 +1,18 @@
+#
+# commerce_service.rb
+# Iterable
+#
+# Copyright (c) 2017 Kyle Schutt. All rights reserved.
+
+module Iterable
+  module Services
+    class CommerceService < BaseService
+      class << self
+        def track_purchase(request)
+          raise Exceptions::ServiceException, "Must be a Iterable::Requests::TrackPurchase" unless request.is_a?(Iterable::Requests::TrackPurchase)
+          post(Util::Config.get('endpoints.track_purchase'), request)
+        end
+      end
+    end
+  end
+end

data/lib/iterable/services/list_service.rb

@@ -0,0 +1,27 @@
+#
+# list_service.rb
+# Iterable
+#
+# Copyright (c) 2017 Kyle Schutt. All rights reserved.
+
+module Iterable
+  module Services
+    class ListService < BaseService
+      class << self
+        def all
+          get(Util::Config.get('endpoints.lists'), nil, Iterable::Responses::Lists)
+        end
+
+        def find_by_id(id)
+          # iterate over all lists to find the id
+          all.lists.select{|x| x.id == id.to_i}.first
+        end
+
+        def subscribe(list_id, subscribers)
+          request = Iterable::Requests::Subscribe.new(listId: list_id, subscribers: subscribers)
+          post(Util::Config.get('endpoints.lists_subscribe'), request, nil, Iterable::Responses::Subscribe)
+        end
+      end
+    end
+  end
+end

data/lib/iterable/services/user_service.rb

@@ -0,0 +1,34 @@
+#
+# user_service.rb
+# Iterable
+#
+# Copyright (c) 2017 Kyle Schutt. All rights reserved.
+
+module Iterable
+  module Services
+    class UserService < BaseService
+      class << self
+        def find_by_email(email)
+          raise Exceptions::ServiceException, "Email is required." if email.nil?
+          find_by((Util::Config.get('endpoints.user_by_email') % [email]))
+        end
+
+        def find_by_id(id)
+          raise Exceptions::ServiceException, "Id is required." if id.nil?
+          find_by((Util::Config.get('endpoints.user_by_id') % [id]))
+        end
+
+        def update(user)
+          raise Exceptions::ServiceException, "Must be a Iterable::Requests::UserUpdate" unless user.is_a?(Iterable::Requests::UserUpdate)
+          post(Util::Config.get('endpoints.user_update'), user)
+        end
+
+        private 
+
+        def find_by(path)
+          get(path, nil, Iterable::Responses::User)
+        end
+      end
+    end
+  end
+end

data/lib/iterable/util/config.rb

@@ -0,0 +1,74 @@
+#
+# config.rb
+# Iterable
+#
+# Copyright (c) 2017 Kyle Schutt. All rights reserved.
+
+module Iterable
+  module Util
+    class Config
+
+      # Return a hash of configuration strings
+      # @return [Hash] - hash of configuration properties
+      @props = {
+        # REST endpoints
+        :endpoints => {
+          :base_url                       => 'https://api.iterable.com:443/api/',
+
+          # subscribers (users)
+          :user_by_email                  => 'users/%s',
+          :user_by_id                     => 'users/byUserId/%s',
+          :user_update                    => 'users/update',
+          :user_subscriptions_update      => 'users/updateSubscriptions',
+
+          # subscriptions (lists)
+          :lists                          => 'lists',
+          :lists_subscribe                => 'lists/subscribe',
+
+          # purchases (commerce)
+          :track_purchase                 => 'commerce/trackPurchase',
+        },
+
+        # Authorization related configuration options
+        :auth => {
+          :api_key                       => ''
+        },
+
+        # Errors to be returned for various exceptions
+        :errors => {
+          :api_key_missing      => 'api_key required either explicitly or in configuration.',
+        }
+      }
+
+      class << self
+        attr_accessor :props
+
+        def configure 
+          yield props if block_given?
+        end
+
+        # Get a configuration property given a specified location, example usage: Config::get('auth.token_endpoint')
+        # @param [String] index - location of the property to obtain
+        # @return [String]
+        def get(index)
+          properties = index.split('.')
+          get_value(properties, props)
+        end
+
+        private
+
+        # Navigate through a config array looking for a particular index
+        # @param [Array] index The index sequence we are navigating down
+        # @param [Hash, String] value The portion of the config array to process
+        # @return [String]
+        def get_value(index, value)
+          index = index.is_a?(Array) ? index : [index]
+          key = index.shift.to_sym
+          value.is_a?(Hash) and value[key] and value[key].is_a?(Hash) ?
+          get_value(index, value[key]) :
+          value[key]
+        end
+      end
+    end
+  end
+end

data/lib/iterable/util/helpers.rb

@@ -0,0 +1,27 @@
+#
+# helpers.rb
+# Iterable
+#
+# Copyright (c) 2017 Kyle Schutt. All rights reserved.
+
+module Iterable
+  module Util
+    class Helpers
+      class << self
+
+        # Build the HTTP query from the given parameters
+        # @param [Hash] params
+        # @return [String] query string
+        def http_build_query(params)
+          params.collect{ |k,v| "#{k}=#{encode(v)}" }.reverse.join('&')
+        end
+
+        # Escape special characters
+        # @param [String] str
+        def encode(str)
+          CGI.escape(str).gsub('.', '%2E').gsub('-', '%2D')
+        end
+      end
+    end
+  end
+end

data/lib/iterable/version.rb

@@ -0,0 +1,3 @@
+module Iterable
+  VERSION = "0.2.0".freeze
+end

data/lib/iterable.rb

@@ -0,0 +1,49 @@
+
+require 'rubygems'
+require 'rest_client'
+require 'json'
+require 'hashie'
+require 'openssl'
+require 'base64'
+
+module Iterable
+  autoload :Api, 'iterable/api'
+  autoload :VERSION, 'iterable/version'
+
+  # Models
+  autoload :Base, 'iterable/models/base'
+  autoload :User, 'iterable/models/user'
+  autoload :DataFields, 'iterable/models/data_fields'
+  autoload :ListDetails, 'iterable/models/list_details'
+  autoload :CommerceItem, 'iterable/models/commerce_item'
+
+  module Responses
+    autoload :Error, 'iterable/models/responses/error'
+    autoload :General, 'iterable/models/responses/general'
+    autoload :Lists, 'iterable/models/responses/lists'
+    autoload :Subscribe, 'iterable/models/responses/subscribe'
+    autoload :User, 'iterable/models/responses/user'
+  end
+
+  module Requests
+    autoload :Subscribe, 'iterable/models/requests/subscribe'
+    autoload :TrackPurchase, 'iterable/models/requests/track_purchase'
+    autoload :UserUpdate, 'iterable/models/requests/user_update'
+  end
+
+  module Services
+    autoload :BaseService, 'iterable/services/base_service'
+    autoload :CommerceService, 'iterable/services/commerce_service'
+    autoload :ListService, 'iterable/services/list_service'
+    autoload :UserService, 'iterable/services/user_service'
+  end  
+
+  module Exceptions
+    autoload :ServiceException, 'iterable/exceptions/service_exception'
+  end  
+
+  module Util
+    autoload :Config, 'iterable/util/config'
+    autoload :Helpers, 'iterable/util/helpers'
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: iterable-api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Iterable
+- Revv
+- Kyle Schutt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- info@revv.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/iterable.rb
+- lib/iterable/api.rb
+- lib/iterable/exceptions/service_exception.rb
+- lib/iterable/models/base.rb
+- lib/iterable/models/commerce_item.rb
+- lib/iterable/models/data_fields.rb
+- lib/iterable/models/list_details.rb
+- lib/iterable/models/requests/subscribe.rb
+- lib/iterable/models/requests/track_purchase.rb
+- lib/iterable/models/requests/user_update.rb
+- lib/iterable/models/responses/error.rb
+- lib/iterable/models/responses/general.rb
+- lib/iterable/models/responses/lists.rb
+- lib/iterable/models/responses/subscribe.rb
+- lib/iterable/models/responses/user.rb
+- lib/iterable/models/user.rb
+- lib/iterable/services/base_service.rb
+- lib/iterable/services/commerce_service.rb
+- lib/iterable/services/list_service.rb
+- lib/iterable/services/user_service.rb
+- lib/iterable/util/config.rb
+- lib/iterable/util/helpers.rb
+- lib/iterable/version.rb
+homepage: https://github.com/revvco/iterable-api
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Library for interactions with the Iterable API
+test_files: []