knowtify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7fd8df5495b4a47cb7d73d672be7283ae7e30a6
+  data.tar.gz: 3af370340767f44fc7bb7b96df97dff3b023321f
+SHA512:
+  metadata.gz: 9a8393daac5214815e6c4e79071eb2764adb9f46f064d62807cba9598818821648dfb61e76554349c53bac6ba29afad02617fbc9f3ca78c3498fb5f5beefb560
+  data.tar.gz: 08cb1455787f0799e1d6347355b290b6d74370235e78aa1f1638e495bb13f78ab85142ea420b1ede1ae947d6ef3110d3c1f1590de6f37fad2034ad9ce6a0eee2

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Joshua Mckinney
+
+MIT License
+
+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,55 @@
+# Knowtify
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'knowtify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knowtify
+
+## Usage
+
+    require 'knowtify'
+
+    ENV['KNOWTIFY_API_TOKEN'] = 'MySuperSecretKey'
+  
+    new_contacts = [{
+                        "name" => "John",
+                        "email" => "john@test.com",
+                        "data" => {
+                          "category" => "sports",
+                          "followers" => 300
+                        }
+                      },
+                      {
+                        "name" => "Samuel",
+                        "email" => "sam@test.com",
+                        "data" => {
+                          "category" => "sports",
+                          "followers" => 32,
+                          "comments" => 54,
+                          "role" => "Editor"
+                        }
+              }]
+    client = Knowtify::Client.new
+    resp = client.contacts_upsert(new_contacts) # <Knowtify::Response:0x007fdb629e5c10>
+    resp.successful? # true
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/knowtify/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/knowtify.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knowtify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knowtify"
+  spec.version       = Knowtify::VERSION
+  spec.authors       = ["Joshua Mckinney","Dane Lyons"]
+  spec.email         = ["joshmckin@gmail.com","dane@knowtify.io"]
+  spec.summary       = "Smart emails to engage your users"
+  spec.description   = "Knowtify helps you design and deliver transactional, behavioral and digest emails to engage your users."
+  spec.homepage      = "http://www.knowtify.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "excon"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-autotest"
+  spec.add_development_dependency "autotest"
+end

data/lib/knowtify.rb

@@ -0,0 +1,16 @@
+require "knowtify/version"
+require "knowtify/handlers/excon_handler"
+require "knowtify/config"
+require "knowtify/client"
+require "knowtify/request"
+require "knowtify/response"
+
+
+module Knowtify
+  # Your code goes here...
+  class << self
+    def config
+      @config ||= Knowtify::Config.new
+    end
+  end
+end

data/lib/knowtify/client.rb

@@ -0,0 +1,115 @@
+module Knowtify
+  class Client
+    attr_accessor :handler
+
+    # TODO: Refactor to separate classes for each method
+    def initialize
+      @handler = config.handler.new
+    end
+
+    # POST /contacts/upsert
+    # Sends a request to create or update
+    # contacts with the supplied data.
+    # Example contacts:
+    # [
+    #   {
+    #     "name":"John",
+    #     "email":"john@test.com",
+    #     "data":{
+    #       "category":"sports",
+    #       "followers":300
+    #     }
+    #   },
+    #   {
+    #     "name":"Samuel",
+    #     "email":"sam@test.com",
+    #     "data":{
+    #       "category":"sports",
+    #       "followers":32,
+    #       "comments":54,
+    #       "role":"Editor"
+    #     }
+    #   }
+    # ]
+    def contacts_upsert(contacts=[],request_options={},api_key=nil)
+      options = {
+        :path => "#{config.base_path}/contacts/upsert",
+        :params => {:contacts => contacts},
+        :request_options => request_options,
+        :api_key => api_key
+      }
+      request = Knowtify::Request.new(options)
+      handler.post(request)
+    end
+
+    # POST /contacts/delete
+    # Sends a request to delete contacts whose 
+    # emails match those provided.
+    # Example contacts:
+    # [
+    #   "john@test.com",
+    #   "sam@test.com",
+    #   "sarah@test.com",
+    #   "mike@test.com",
+    #   "jill@test.com",
+    #   "ashley@test.com",
+    #   "frank@test.com",
+    #   "bill@test.com"
+    # ]
+    def contacts_delete(contacts=[],http_request_options={},api_key=nil)
+      options = {
+        :path => "#{config.base_path}/contacts/delete",
+        :params => {:contacts => contacts},
+        :http_request_options => http_request_options,
+        :api_key => api_key
+      }
+      request = Knowtify::Request.new(options)
+      handler.post(request)
+    end
+
+    # POST /data/edit
+    # Updates global data based on the data provided
+    # Example data:
+    # {
+    #   "users":890,
+    #   "comments":994,
+    #   "top_story_url":"test.com/story",
+    #   "top_story_title":"Article!"
+    # }
+    def global_edit(data={},http_request_options={},api_key=nil)
+      options = {
+        :path => "#{config.base_path}/data/edit",
+        :params => {:data => data},
+        :http_request_options => http_request_options,
+        :api_key => api_key
+      }
+      request = Knowtify::Request.new(options)
+      handler.post(request)
+    end
+
+    # POST contacts/upsert
+    # Sends a transaction email with the event and contacts provided
+    # {
+    #   "event":"purchase",
+    #   "contacts": [
+    #     {
+    #       "email":"dane@knowtify.io"
+    #     }
+    #   ]
+    # }
+    def transactional_email(event, contacts=[],http_request_options={},api_key=nil)
+      options = {
+        :path => "#{config.base_path}/data/edit",
+        :params => {:data => contacts},
+        :http_request_options => http_request_options,
+        :api_key => api_key
+      }
+      request = Knowtify::Request.new(options)
+      handler.post(request)
+    end
+
+    def config
+      Knowtify.config
+    end
+  end
+end

data/lib/knowtify/config.rb

@@ -0,0 +1,39 @@
+module Knowtify
+  class Config
+    attr_accessor :api_key, # String  - API key to override ENV['KNOWTIFY_API_TOKEN']
+      :base_url,            # String  - Base url to build requests from
+      :api_version,         # String  - API version uses for requests
+      :max_retries,         # FixNum  - number of times to retry requests
+      :http_client_options, # Hash    - Additional options to pass to the HTTP client
+      :debug,               # Boolean - Default is false
+      :handler              # Symbol  - Default is :excon
+
+
+    HANDLERS = {
+      :excon => Knowtify::ExconHandler
+    }.freeze
+
+    def initialize
+      @api_key              = ENV['KNOWTIFY_API_TOKEN']
+      @base_url             = "http://www.knowtify.io"
+      @api_version          = "v1"
+      @http_client_options  = {}
+      @max_retries          = 2
+      @debug                = false
+      @handler              = :excon
+    end
+
+    def base_path
+      "/api/#{@api_version}"
+    end
+
+    def debug?
+      @debug == true
+    end
+
+    # Until there are more handler options just return Excon
+    def handler
+      HANDLERS[@handler]
+    end
+  end
+end

data/lib/knowtify/handlers/excon_handler.rb

@@ -0,0 +1,38 @@
+require 'excon'
+require 'json'
+module Knowtify
+  class ExconHandler
+    attr_accessor :http_client
+
+    def initialize
+      opts = {
+        :idempotent => true,
+        :retry_limit => config.max_retries
+      }.merge(config.http_client_options)
+      opts[:instrumentor] = Excon::StandardInstrumentor if config.debug? # output full request data if debugging
+      @http_client = Excon.new(config.base_url,opts)
+    end
+
+    def request_options(request)
+      {:path => request.path,
+       :body => request.params.to_json,
+       :headers => request.headers}.merge(request.http_request_options)
+    end
+
+    def post(request,count=0)
+      resp = Knowtify::Response.new(count)
+      resp.raw_response = http_client.post(request_options(request))
+      resp.body = resp.raw_response.body
+      resp.http_code = resp.raw_response.status
+      if resp.retry?
+        post(request,count + 1)
+      else
+        resp
+      end
+    end
+
+    def config
+      Knowtify.config
+    end
+  end
+end

data/lib/knowtify/request.rb

@@ -0,0 +1,25 @@
+module Knowtify
+  # A generic request object to be passed to handlers
+  class Request
+    attr_accessor :api_key, # API key for request; defaults to config.api_key
+      :path,				# Path for HTTP HTTP request
+      :params,				# Parameters for HTTP request
+      :http_request_options # Additional options pass to HTTP client during the request action
+
+    def initialize(options={})
+      @api_key = options[:api_key] || config.api_key
+      @path = options[:path]
+      @params = options[:params]
+      @http_request_options = options[:http_request_options] || {}
+    end
+
+    def headers
+      {"Content-Type" => "application/json",
+       'Authorization' => "Token token=\"#{api_key}\""}
+    end
+
+    def config
+    	Knowtify.config
+    end
+  end
+end

data/lib/knowtify/response.rb

@@ -0,0 +1,24 @@
+module Knowtify
+  class Response
+    attr_accessor :body, :http_code, :raw_response, :count
+
+    ERROR_HTTP_CODES = [500,501,502,503,504,505,429,0]
+
+    def initialize(count=0)
+      @count = count || 0
+    end
+
+    def retry?
+      (((count + 1) <= Knowtify.config.max_retries) && ERROR_HTTP_CODES.include?(http_code))
+    end
+
+    def retried?
+      count != 0
+    end
+
+    def successful?
+      http_code == 200
+    end
+
+  end
+end

data/lib/knowtify/version.rb

@@ -0,0 +1,3 @@
+module Knowtify
+  VERSION = "0.0.1"
+end

data/spec/lib/knowtify/client_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Knowtify::Client do
+	
+  let(:client) {Knowtify::Client.new}
+
+  it { expect(client.handler).to be_a(Knowtify::ExconHandler) }
+
+  context "integration tests" do
+    # tests assume ENV['KNOWTIFY_API_TOKEN'] is valid
+    describe '#contacts_upsert' do
+
+      it "should work" do
+        resp = client.contacts_upsert([{
+                                         "name" => "John",
+                                         "email" => "john@test.com",
+                                         "data" => {
+                                           "category" => "sports",
+                                           "followers" => 300
+                                         }
+                                       },
+                                       {
+                                         "name" => "Samuel",
+                                         "email" => "sam@test.com",
+                                         "data" => {
+                                           "category" => "sports",
+                                           "followers" => 32,
+                                           "comments" => 54,
+                                           "role" => "Editor"
+                                         }
+        }])
+        expect(resp.body).to eql("{\"status\":\"received\",\"contacts\":2,\"successes\":2,\"errors\":0}")
+      end
+
+    end
+
+    describe '#contacts_delete' do
+
+      it "should work" do
+        resp = client.contacts_delete(["john@test.com",
+                                       "sam@test.com"
+                                       ])
+        expect(resp.body).to eql("{\"status\":\"received\",\"contacts\":2,\"successes\":2,\"errors\":0}")
+      end
+
+    end
+
+    describe '#global_edit' do
+
+      it "should work" do
+        resp = client.global_edit({"users"=>890, "comments"=>994, "top_story_url"=>"test.com/story", "top_story_title"=>"Article!"})
+        expect(resp.body).to eql("{\"status\":\"received\",\"success\":true}")
+      end
+
+    end
+
+  end
+end

data/spec/lib/knowtify/config_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+describe Knowtify::Config do
+
+  describe '#api_key' do
+
+    context "default to ENV['KNOWTIFY_API_TOKEN']" do
+
+      it "should work" do
+        ENV['KNOWTIFY_API_TOKEN'] ||= "TEST API KEY"
+        config = Knowtify::Config.new
+        expect(config.api_key).to eql(ENV['KNOWTIFY_API_TOKEN'])
+      end
+
+    end
+    
+  end
+
+  describe '#handler' do
+
+    it {expect(Knowtify::Config.new.handler).to eql(Knowtify::ExconHandler)}
+
+  end
+
+end

data/spec/lib/knowtify_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Knowtify do
+  describe '#config' do
+    it { expect(Knowtify.config).to be_a(Knowtify::Config) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+require 'rubygems'
+require 'rspec'
+require 'rspec/autotest'
+require 'knowtify'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: knowtify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joshua Mckinney
+- Dane Lyons
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-autotest
+  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: autotest
+  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: Knowtify helps you design and deliver transactional, behavioral and digest
+  emails to engage your users.
+email:
+- joshmckin@gmail.com
+- dane@knowtify.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- knowtify.gemspec
+- lib/knowtify.rb
+- lib/knowtify/client.rb
+- lib/knowtify/config.rb
+- lib/knowtify/handlers/excon_handler.rb
+- lib/knowtify/request.rb
+- lib/knowtify/response.rb
+- lib/knowtify/version.rb
+- spec/lib/knowtify/client_spec.rb
+- spec/lib/knowtify/config_spec.rb
+- spec/lib/knowtify_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.knowtify.io
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Smart emails to engage your users
+test_files:
+- spec/lib/knowtify/client_spec.rb
+- spec/lib/knowtify/config_spec.rb
+- spec/lib/knowtify_spec.rb
+- spec/spec_helper.rb