sendgrid-threads 0.1.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.2.1
+  - 2.2.2
+  - 2.2.3
+
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+group :development, :test do
+  gem 'activesupport', "~> 4.0"
+  gem "rspec", "~> 3.0"
+  gem "rdoc", "~> 4.2"
+  gem "bundler", "~> 1.10"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov"
+  gem "pry-byebug"
+  gem "webmock"
+  gem "timecop"
+  gem "codeclimate-test-reporter", require: nil
+end

data/Gemfile.lock

@@ -0,0 +1,117 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    builder (3.2.2)
+    byebug (8.2.1)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.13.0)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.6)
+      oauth2
+    hashdiff (0.2.3)
+    hashie (3.4.3)
+    highline (1.7.8)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.2)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    minitest (5.8.3)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.4)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.3.0)
+      byebug (~> 8.0)
+      pry (~> 0.10)
+    rack (1.6.4)
+    rake (10.4.2)
+    rdoc (4.2.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    timecop (0.8.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.22.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 4.0)
+  bundler (~> 1.10)
+  codeclimate-test-reporter
+  jeweler (~> 2.0.1)
+  pry-byebug
+  rdoc (~> 4.2)
+  rspec (~> 3.0)
+  simplecov
+  timecop
+  webmock
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 David Paluy
+
+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,66 @@
+# Sendgrid Threads
+
+Ruby Gem for the SendGrid Threads API https://threads.io/
+
+This Gem allows you to send Threads events using native Ruby. For more details, read: https://docs.threads.io/
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/sendgrid-threads.png)](http://badge.fury.io/rb/sendgrid-threads)
+[![Build Status](https://secure.travis-ci.org/dpaluy/sendgrid-threads.png)](http://travis-ci.org/dpaluy/sendgrid-threads)
+[![Code Climate](https://codeclimate.com/github/dpaluy/sendgrid-threads/badges/gpa.svg)](https://codeclimate.com/github/dpaluy/sendgrid-threads)
+[![Dependency Status](https://gemnasium.com/dpaluy/sendgrid-threads.svg)](https://gemnasium.com/dpaluy/sendgrid-threads)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+`gem 'sendgrid-threads'`
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself using:
+
+`$ gem install sendgrid-threads`
+
+## Usage
+
+```
+# config/initializers/sendgrid_threads.rb
+SendgridThreads.configure do |config|
+  config.key = 'my_api_key'
+end
+```
+
+```
+api = SendgridThreads::Api.new
+
+# identify user
+api.identify("unique_user_id", {email: "user@example.com", other: "parameters"})
+
+# track event
+api.track("unique_user_id", "Event name", {any: "custom", user: "properties"})
+
+# track page view
+api.page_view("unique_user_id", "Page name", {any: "custom", user: "properties"})
+
+# remove user
+api.remove("unique_user_id")
+
+```
+
+## Contributing to sendgrid-threads
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2015 David Paluy. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "sendgrid-threads"
+  gem.homepage = "http://github.com/dpaluy/sendgrid-threads"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby Gem for the SendGrid Threads API https://threads.io/ }
+  gem.description = %Q{This Gem allows you to send Threads events using native Ruby https://docs.threads.io/}
+  gem.email = "dpaluy@gmail.com"
+  gem.authors = ["David Paluy"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sendgrid-threads #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/sendgrid-threads.rb

@@ -0,0 +1,13 @@
+require_relative 'sendgrid_threads/config'
+require_relative 'sendgrid_threads/exceptions'
+require_relative 'sendgrid_threads/client'
+require_relative 'sendgrid_threads/api'
+require_relative 'sendgrid_threads/engine' if defined?(Rails)
+
+module SendgridThreads
+  VERSION = File.read(File.expand_path('../../VERSION', __FILE__)).strip.freeze
+
+  def self.logger
+    config.logger
+  end
+end

data/lib/sendgrid_threads/api.rb

@@ -0,0 +1,35 @@
+module SendgridThreads
+  class Api
+    attr_reader :connection
+
+    def initialize( params = {} )
+      @connection = SendgridThreads::Client.new(params)
+    end
+
+    def identify(user_id, traits = {}, timestamp = Time.now )
+      body = {userId: user_id, traits: traits, timestamp: utc_iso8601(timestamp)}
+      @connection.post("identify", body)
+    end
+
+    def track(user_id, event, properties = {}, timestamp = Time.now)
+      body = {userId: user_id, event: event, timestamp: utc_iso8601(timestamp), properties: properties}
+      @connection.post("track", body)
+    end
+
+    def page_view(user_id, name, properties = {}, timestamp = Time.now)
+      body = {userId: user_id, name: name, timestamp: utc_iso8601(timestamp), properties: properties}
+      @connection.post("page", body)
+    end
+
+    def remove(user_id, timestamp = Time.now)
+      body = {userId: user_id, timestamp: utc_iso8601(timestamp)}
+      @connection.post("remove", body)
+    end
+
+    private
+
+    def utc_iso8601(timestamp)
+      timestamp.utc.iso8601.gsub(/Z$/, '.000Z')
+    end
+  end
+end

data/lib/sendgrid_threads/client.rb

@@ -0,0 +1,51 @@
+require 'faraday'
+
+module SendgridThreads
+  class Client
+    VERSION = "v1".freeze
+    URL     = 'https://input.threads.io'.freeze
+    HEADERS = {'Content-Type' => 'application/json', 'Accept' => 'application/json'}.freeze
+
+    attr_reader :key, :secret, :url, :user_agent, :raise_exceptions
+    attr_writer :adapter, :conn
+
+    def initialize( params = {} )
+      @key    = params.fetch(:key,    SendgridThreads.config.key)
+      @secret = params.fetch(:secret, SendgridThreads.config.secret)
+      @url    = params.fetch(:url,    SendgridThreads.config.url || URL)
+      @raise_exceptions = params.fetch(:raise_exceptions,
+                                SendgridThreads.config.raise_exceptions || true)
+      @adapter    = params.fetch(:adapter, adapter)
+      @conn       = params.fetch(:conn, conn)
+      @user_agent = params.fetch(:user_agent, "sendgrid-threads/#{SendgridThreads::VERSION};ruby")
+      yield self if block_given?
+    end
+
+    def post(endpoint, body = nil)
+      endpoint_with_version = "/#{VERSION}/#{endpoint}"
+      response = conn.post(endpoint_with_version) do |req|
+        req.headers = HEADERS.merge('User-Agent' => @user_agent)
+        req.body = JSON(body) if body
+      end
+      fail SendgridThreads::Exception, response.body if raise_exceptions? && response.status != 200
+
+      response
+    end
+
+    def conn
+      @conn ||= Faraday.new(url: @url) do |conn|
+        conn.request :url_encoded
+        conn.request :basic_auth, @key, @secret
+        conn.adapter adapter
+      end
+    end
+
+    def adapter
+      @adapter ||= Faraday.default_adapter
+    end
+
+    def raise_exceptions?
+      @raise_exceptions
+    end
+  end
+end

data/lib/sendgrid_threads/config.rb

@@ -0,0 +1,21 @@
+require 'logger'
+
+module SendgridThreads
+
+  class Config
+    attr_accessor :key, :secret, :url, :logger, :raise_exceptions
+
+    def logger
+      @logger ||= Logger.new(STDERR)
+    end
+  end
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+end

data/lib/sendgrid_threads/engine.rb

@@ -0,0 +1,5 @@
+module SendgridThreads
+  class Engine < Rails::Engine
+    isolate_namespace SendgridThreads
+  end
+end

data/lib/sendgrid_threads/exceptions.rb

@@ -0,0 +1,7 @@
+module SendgridThreads
+  class Exception < StandardError
+    def initialize(message)
+      super(message)
+    end
+  end
+end

data/sendgrid-threads.gemspec

@@ -0,0 +1,89 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: sendgrid-threads 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "sendgrid-threads"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["David Paluy"]
+  s.date = "2015-11-28"
+  s.description = "This Gem allows you to send Threads events using native Ruby https://docs.threads.io/"
+  s.email = "dpaluy@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".codeclimate.yml",
+    ".document",
+    ".rspec",
+    ".rubocop.yml",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/sendgrid-threads.rb",
+    "lib/sendgrid_threads/api.rb",
+    "lib/sendgrid_threads/client.rb",
+    "lib/sendgrid_threads/config.rb",
+    "lib/sendgrid_threads/engine.rb",
+    "lib/sendgrid_threads/exceptions.rb",
+    "sendgrid-threads.gemspec",
+    "spec/sendgrid-threads_spec.rb",
+    "spec/sendgrid_threads/api_spec.rb",
+    "spec/sendgrid_threads/client_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/dpaluy/sendgrid-threads"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5.1"
+  s.summary = "Ruby Gem for the SendGrid Threads API https://threads.io/"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<activesupport>, ["~> 4.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.2"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.10"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<pry-byebug>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<timecop>, [">= 0"])
+      s.add_development_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, ["~> 4.0"])
+      s.add_dependency(%q<rspec>, ["~> 3.0"])
+      s.add_dependency(%q<rdoc>, ["~> 4.2"])
+      s.add_dependency(%q<bundler>, ["~> 1.10"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<pry-byebug>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<timecop>, [">= 0"])
+      s.add_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["~> 4.0"])
+    s.add_dependency(%q<rspec>, ["~> 3.0"])
+    s.add_dependency(%q<rdoc>, ["~> 4.2"])
+    s.add_dependency(%q<bundler>, ["~> 1.10"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<pry-byebug>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<timecop>, [">= 0"])
+    s.add_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+  end
+end
+