smartlist_push_api 0.1.13

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b47169a3ba69b2c338c2335ce397cd492f13525
+  data.tar.gz: 6b5595ebf954eac27764859406190fd3b0228185
+SHA512:
+  metadata.gz: 4403e960567adde50c633cc8bde86356521f0bd1126adf3401ba04da4a6e428b1b1efca7d46dda58beed9bf7b43c05f04754a0555470933b2499d5de8e7cfbab
+  data.tar.gz: 8946649e944635b593eff11e99e90df050e7e3318c7cd6e8e6737873429ede66f5b15cf3a65cda1ad60dc2fad07e9f631d6104b9670faae9f4cc8fe0fc82ccb5

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at bajalovic@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smartlist_push_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ivan Bajalovic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# Smartlist Push API
+
+THe Smartlist Push API allows you to send your user activity to Smartlist to drive analytics and automated messaging through the Smartlist application. The data that you send to Smartlist  is used to set up filters that enable the creation of segments and targeting for automated messaging to users.
+
+## Installation
+
+To get started, add this line to your application's Gemfile:
+
+```ruby 
+    gem 'smartlist_push_api'
+```
+
+And then execute:
+
+```
+   $ bundle
+```
+
+Or install it yourself as:
+
+```
+   $ gem install smartlist_push_api
+```
+
+## Enabling Push API
+
+First, you will need an account at [Smartlist](http://smartlisthq.com). After you create an account, you can enable the Push API from your [profile settings](http://smartlisthq.com/app/profile/push-api) where you can get an access token.
+
+Create initializer `smartlist_push_api.rb` and put
+
+```ruby   
+    SmartlistPushApi.access_token = 'your-access-token'
+```
+
+## Usage
+
+#### User Account
+
+Once a user registers within your app, you can send that information to Smartlist via the following:
+
+```ruby  
+    SmartlistPushApi::User.create({
+     email: 'user@example.com',              # required
+     ref_id: 'ref_user_102',                 # required
+     first_name: 'John',                     # optional
+     last_name: 'Doe',                       # optional
+     display_name: 'John Doe',               # optional
+     company_name: 'ABC Corp',               # optional
+     ref_created_at: '2016-07-26 20:28:37',  # required
+     ref_updated_at: '2016-07-27 18:08:37'   # required
+    })
+```
+
+The field `ref_id` is required and should be unique for each user from your app. You will use that field to create or update a user’s information.  
+
+When a user changes their data, you can sync information with Smartlist with the following method:
+
+```ruby 
+    SmartlistPushApi::User.update('ref_user_102', {first_name: 'Joana'})
+```
+
+The first attribute is a `ref_id` and the second attribute is the object that has any of the previously mentioned user attributes, as well as the attribute `unsubscribed`. Setting `unsubscribed` to false will prevent this user from receiving emails. If user leaves your app, you should remove them from Smartlist with the following:
+
+```ruby 
+    SmartlistPushApi::User.destroy('ref_user_102')
+```
+The above method will remove user who has `ref_id` set to `ref_user_102` from Smartlist.
+
+
+#### Login Activity
+
+Every time user logs in in your app, you can update Smartlist (as a way to track user activity):
+
+```ruby 
+    SmartlistPushApi::User.signed_in('ref_user_102', Time.current)
+```
+This method receive two attributes: user's `ref_id` and a `datetime` object. 
+
+
+#### Subscription Activity
+
+If your app has subscription plans, you can send that to Smartlist to filter users by subscription type.. In addition, we recognize four different subscription event types: **signed_up**, **canceled**, **upgraded** and **downgraded**.
+
+- **signed_up** should be sent when user start using a plan for the first time (after first registering with your app);
+- **canceled** should be sent when user cancels a plan;
+- **upgraded** when user upgrades to a higher plan;
+- **downgrade** when user downgrades to a lower plan.
+
+```ruby
+ # ref_id, plan name, datetime object when subscription started
+ SmartlistPushApi::User.started_subscription('ref_user_102', 'Freemium', 1.week.ago)
+ # ref_id, from plan name, to plan name, datetime object when subscription was upgraded
+ SmartlistPushApi::User.upgraded_subscription('ref_user_102', 'Freemium', 'Pro', 1.week.ago)
+ # ref_id, from plan name, to plan name, datetime object when subscription was downgraded
+ SmartlistPushApi::User.downgraded_subscription('ref_user_102', 'Pro', 'Freemium', 2.days.ago)
+ # ref_id, plan name that was canceled, datetime object when subscription was cancelled
+ SmartlistPushApi::User.canceled_subscription('ref_user_102', 'Pro', 2.days.ago)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "smartlist_push_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/smartlist_push_api/http/http_client.rb

@@ -0,0 +1,30 @@
+module SmartlistPushApi
+  module Http
+    class HttpClient
+
+      def initialize()
+        @default_headers = {
+            'x-access-token' => SmartlistPushApi.access_token,
+            'Accept' => 'application/json'
+        }
+      end
+
+      def post_request(url, data)
+        HTTParty.post("#{SmartlistPushApi.base_uri}#{url}", {body: data, headers: @default_headers})
+      end
+
+      def patch_request(url, data)
+        HTTParty.patch("#{SmartlistPushApi.base_uri}#{url}", {body: data, headers: @default_headers})
+      end
+
+      def get_request(url)
+        HTTParty.get("#{SmartlistPushApi.base_uri}#{url}", {headers: @default_headers})
+      end
+
+      def delete_request(url)
+        HTTParty.delete("#{SmartlistPushApi.base_uri}#{url}", {headers: @default_headers})
+      end
+
+    end
+  end
+end

data/lib/smartlist_push_api/user.rb

@@ -0,0 +1,70 @@
+module SmartlistPushApi
+  class User
+
+    def self.create(data)
+      SmartlistPushApi.make_post_request('/users/', data)
+    end
+
+    def self.update(user_id, data)
+      SmartlistPushApi.make_patch_request("/users/#{user_id}/", data)
+    end
+
+    def self.destroy(user_id)
+      SmartlistPushApi.make_delete_request("/users/#{user_id}/")
+    end
+
+    def self.started_subscription(user_id, plan_name, started_at)
+      raise InvalidDataException if plan_name.blank?
+      raise InvalidDataException if started_at.blank?
+
+      SmartlistPushApi.make_post_request("/users/#{user_id}/subscription/", {
+          type: :signed_up,
+          plan_name: plan_name,
+          event_at: started_at.utc.strftime('%Y-%m-%d %H:%M:%S')
+      })
+    end
+
+    def self.canceled_subscription(user_id, plan_name, canceled_at)
+      raise InvalidDataException if plan_name.blank?
+      raise InvalidDataException if canceled_at.blank?
+
+      SmartlistPushApi.make_post_request("/users/#{user_id}/subscription/", {
+          type: :canceled,
+          plan_name: plan_name,
+          event_at: canceled_at.utc.strftime('%Y-%m-%d %H:%M:%S')
+      })
+    end
+
+    def self.upgraded_subscription(user_id, from_plan, to_plan, conversion_at)
+      raise InvalidDataException if from_plan.blank?
+      raise InvalidDataException if to_plan.blank?
+      raise InvalidDataException if conversion_at.blank?
+
+      SmartlistPushApi.make_post_request("/users/#{user_id}/subscription/", {
+          type: :upgraded,
+          plan_name: to_plan,
+          from_plan: from_plan,
+          event_at: conversion_at.utc.strftime('%Y-%m-%d %H:%M:%S')
+      })
+    end
+
+    def self.downgraded_subscription(user_id, from_plan, to_plan, conversion_at)
+      raise InvalidDataException if from_plan.blank?
+      raise InvalidDataException if to_plan.blank?
+      raise InvalidDataException if conversion_at.blank?
+
+      SmartlistPushApi.make_post_request("/users/#{user_id}/subscription/", {
+          type: :downgraded,
+          plan_name: to_plan,
+          from_plan: from_plan,
+          event_at: conversion_at.utc.strftime('%Y-%m-%d %H:%M:%S')
+      })
+    end
+
+    def self.signed_in(user_id, date)
+      raise InvalidDataException if date.blank?
+
+      SmartlistPushApi.make_post_request("/users/#{user_id}/login/", {date: date.utc.strftime('%Y-%m-%d %H:%M:%S')})
+    end
+  end
+end

data/lib/smartlist_push_api/version.rb

@@ -0,0 +1,3 @@
+module SmartlistPushApi
+  VERSION = "0.1.13"
+end

data/lib/smartlist_push_api.rb

@@ -0,0 +1,58 @@
+require 'smartlist_push_api/version'
+require 'smartlist_push_api/http/http_client'
+require 'smartlist_push_api/user'
+
+module SmartlistPushApi
+  class InvalidDataException < StandardError;
+  end
+
+  @base_uri = 'http://smartlisthq.com/push'
+  @access_token = ''
+
+  class << self
+    attr_accessor :base_uri, :access_token
+  end
+
+  def self.make_post_request(url, data)
+    SmartlistPushApi.make_request(:POST, url, data)
+  end
+
+  def self.make_patch_request(url, data)
+    SmartlistPushApi.make_request(:PATCH, url, data)
+  end
+
+  def self.make_get_request(url)
+    SmartlistPushApi.make_request(:GET, url)
+  end
+
+  def self.make_delete_request(url)
+    SmartlistPushApi.make_request(:GET, url)
+  end
+
+  def self.make_request(request_method, url, data = nil)
+
+    http_client = Http::HttpClient.new
+    if request_method == :POST
+      raise InvalidDataException if data.nil?
+
+      response = http_client.post_request(url, data)
+      return response.code == 200
+    elsif request_method == :PATCH
+      raise InvalidDataException if data.nil?
+
+      response = http_client.patch_request(url, data)
+      return response.code == 200
+    elsif request_method == :GET
+      response = http_client.get_request(url)
+      return response.code == 200
+    elsif request_method == :DELETE
+      response = http_client.delete_request(url)
+      return response.code == 204
+    end
+
+    return false
+  rescue => e
+    return false
+  end
+
+end

data/smartlist_push_api.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smartlist_push_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smartlist_push_api"
+  spec.version       = SmartlistPushApi::VERSION
+  spec.authors       = ["Ivan Bajalovic"]
+  spec.email         = ["bajalovic@gmail.com"]
+
+  spec.summary       = %q{Smartlist Push API}
+  spec.description   = %q{Log events from your app to Smartlist so you can create customer segments and campaigns.}
+  spec.homepage      = "http://smartlisthq.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "httparty"
+  spec.add_development_dependency "railties"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: smartlist_push_api
+version: !ruby/object:Gem::Version
+  version: 0.1.13
+platform: ruby
+authors:
+- Ivan Bajalovic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Log events from your app to Smartlist so you can create customer segments
+  and campaigns.
+email:
+- bajalovic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smartlist_push_api.rb
+- lib/smartlist_push_api/http/http_client.rb
+- lib/smartlist_push_api/user.rb
+- lib/smartlist_push_api/version.rb
+- smartlist_push_api.gemspec
+homepage: http://smartlisthq.com
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Smartlist Push API
+test_files: []