talkable 0.0.0 → 0.9.0

data/lib/talkable/generators/templates/app/views/invite/show.html.erb

@@ -0,0 +1,2 @@
+<div id="talkable-inline-offer-container"></div>
+<%= render 'shared/talkable_offer', offer: @invite_offer, options: {iframe: {container: 'talkable-inline-offer-container'}} %>

data/lib/talkable/generators/templates/app/views/invite/show.html.haml

@@ -0,0 +1,2 @@
+#talkable-inline-offer-container
+= render 'shared/talkable_offer', offer: @invite_offer, options: {iframe: {container: 'talkable-inline-offer-container'}}

data/lib/talkable/generators/templates/app/views/invite/show.html.slim

@@ -0,0 +1,2 @@
+#talkable-inline-offer-container
+= render 'shared/talkable_offer', offer: @invite_offer, options: {iframe: {container: 'talkable-inline-offer-container'}}

data/lib/talkable/generators/templates/app/views/shared/_talkable_offer.html.erb

@@ -0,0 +1,4 @@
+<%- options ||= {} %>
+<%- if offer %>
+  <%== offer.advocate_share_iframe(options) %>
+<% end -%>

data/lib/talkable/generators/templates/app/views/shared/_talkable_offer.html.haml

@@ -0,0 +1,3 @@
+- options ||= {}
+- if offer
+  != offer.advocate_share_iframe(options)

data/lib/talkable/generators/templates/app/views/shared/_talkable_offer.html.slim

@@ -0,0 +1,3 @@
+- options ||= {}
+- if offer
+  == offer.advocate_share_iframe(options)

data/lib/talkable/generators/templates/config/initializers/talkable.rb

@@ -0,0 +1,13 @@
+Talkable.configure do |config|
+  # site slug is taken takes form ENV["TALKABLE_SITE_SLUG"]
+  config.site_slug  = <%= @site_slug.inspect %>
+
+  # api key is taken from ENV["TALKABLE_API_KEY"]
+  config.api_key    = <%= @api_key.inspect %>
+  <%- if defined?(@server) && @server.present? %>
+  config.server     = <%= @server.inspect %>
+  <%- else %>
+  # custom server address - by default <%= Talkable::Configuration::DEFAULT_SERVER %>
+  # config.server   =
+  <%- end %>
+end

data/lib/talkable/integration.rb

@@ -0,0 +1,41 @@
+module Talkable
+  DEFAULT_CAMPAIGN_TAGS = {
+    Talkable::API::Origin::AFFILIATE_MEMBER => 'invite'.freeze,
+    Talkable::API::Origin::PURCHASE         => 'post-purchase'.freeze,
+    Talkable::API::Origin::EVENT            => nil,
+  }.freeze
+
+  class << self
+    def register_affiliate_member(params)
+      register_origin(Talkable::API::Origin::AFFILIATE_MEMBER, params)
+    end
+
+    def register_purchase(params)
+      register_origin(Talkable::API::Origin::PURCHASE, params)
+    end
+
+    def register_event(params)
+      register_origin(Talkable::API::Origin::EVENT, params)
+    end
+
+    private
+
+    def register_origin(origin_type, params)
+      origin_params = default_params(origin_type).merge(params)
+      result = Talkable::API::Origin.create(origin_type, origin_params)
+      origin = Talkable::Origin.parse(result)
+      if offer = origin.offer
+        # make sure that explicitly specified tags will be listed first
+        tags = Array(origin_params[:campaign_tags]) | Array(offer.campaign_tags)
+        offer.campaign_tags = tags.map(&:to_s).uniq
+      end
+      origin
+    end
+
+    def default_params(origin_type)
+      {
+        campaign_tags: DEFAULT_CAMPAIGN_TAGS[origin_type]
+      }
+    end
+  end
+end

data/lib/talkable/middleware.rb

@@ -0,0 +1,147 @@
+require 'cgi'
+require 'rack/request'
+
+module Talkable
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      uuid = talkable_visitor_uuid(env)
+
+      result = Talkable.with_uuid(uuid) do
+        @app.call(env)
+      end
+
+      inject_uuid_in_cookie(uuid, result)
+      modify_response_content(result) do |content|
+        content = inject_uuid_in_body(uuid, content)
+        inject_integration_js_in_head(content)
+      end
+
+    end
+
+    protected
+
+    def talkable_visitor_uuid(env)
+      req = Rack::Request.new(env)
+      req.params[UUID] || req.cookies[UUID] || Talkable.find_or_generate_uuid
+    end
+
+    def inject_uuid_in_cookie(uuid, result)
+      Rack::Utils.set_cookie_header!(result[1], UUID, {value: uuid, path: '/', expires: cookies_expiration})
+    end
+
+    def modify_response_content(result)
+      return result unless modifiable?(result)
+
+      status, header, body = result
+      response_content = collect_content(body)
+      body.close if body.respond_to?(:close)
+
+      response_content = yield(response_content) if block_given?
+
+      if response_content
+        response = Rack::Response.new(response_content, status, header)
+        response.finish
+      else
+        result
+      end
+    end
+
+    def inject_uuid_in_body(uuid, content)
+      if injection_index = body_injection_position(content)
+        content = inject_in_content(content, sync_uuid_content(uuid), injection_index)
+      end
+      content
+    end
+
+    def inject_integration_js_in_head(content)
+      if injection_index = head_injection_position(content)
+        content = inject_in_content(content, integration_content, injection_index)
+      end
+      content
+    end
+
+    def inject_in_content(content, injection, position)
+      content[0...position] << injection << content[position..-1]
+    end
+
+    def cookies_expiration
+      Time.now + (20 * 365 * 24 * 60 * 60) # 20 years
+    end
+
+    def sync_uuid_url(uuid)
+      Furi.update("https://www.talkable.com/public/1x1.gif", query: {current_visitor_uuid: uuid})
+    end
+
+    def sync_uuid_content(uuid)
+      src = CGI.escape_html(sync_uuid_url(uuid))
+      %Q{
+<img src="#{src}" style="position:absolute; left:-9999px;" alt="" />
+      }
+    end
+
+    def integration_content
+      integration_init_content + integration_script_content
+    end
+
+    def integration_init_content
+      %Q{
+<script>
+  window._talkableq = window._talkableq || [];
+  _talkableq.push(['init', #{init_parameters.to_json}]);
+</script>
+      }
+    end
+
+    def init_parameters
+      {
+        site_id: Talkable.configuration.site_slug,
+        server: Talkable.configuration.server,
+      }
+    end
+
+    def integration_script_content
+      src = CGI.escape_html(Talkable.configuration.js_integration_library)
+      %Q{
+<script src="#{src}" type="text/javascript"></script>
+      }
+    end
+
+    def modifiable?(result)
+      status, headers = result
+      status == 200 && html?(headers) && !attachment?(headers)
+    end
+
+    def collect_content(chunks)
+      ''.tap do |content|
+        chunks.each { |chunk| content << chunk.to_s }
+      end
+    end
+
+    def body_injection_position(content)
+      pattern = /<\s*body[^>]*>/im
+      match = pattern.match(content)
+      match.end(0) if match
+    end
+
+    def head_injection_position(content)
+      pattern = /<\s*\/\s*head[^>]*>/im
+      match = pattern.match(content)
+      match.begin(0) if match
+    end
+
+    def html?(headers)
+      content_type = headers['Content-Type']
+      content_type && content_type.include?('text/html')
+    end
+
+    def attachment?(headers)
+      content_disposition = headers['Content-Disposition']
+      content_disposition && content_disposition.include?('attachment')
+    end
+
+  end
+end

data/lib/talkable/railtie.rb

@@ -0,0 +1,11 @@
+module Talkable
+  class Railtie < Rails::Railtie
+    generators do
+      require 'talkable/generators/install_generator'
+    end
+
+    initializer "talkable.add_middleware" do |app|
+      app.middleware.use Talkable::Middleware
+    end
+  end
+end

data/lib/talkable/resources.rb

@@ -0,0 +1,3 @@
+require 'hashie'
+require 'talkable/resources/origin'
+require 'talkable/resources/offer'

data/lib/talkable/resources/offer.rb

@@ -0,0 +1,49 @@
+module Talkable
+  class Offer < Hashie::Mash
+    def self.parse(result_hash)
+      offer = self.new(result_hash[:offer])
+      offer.claim_links ||= Hashie::Mash.new(result_hash[:claim_links])
+      offer
+    end
+
+    def advocate_share_iframe(options = {})
+      show_trigger = !options[:ignore_trigger]
+      tag = campaign_tags.first
+      iframe_options = default_iframe_options(tag).merge(options[:iframe] || {})
+      url = show_trigger ? Furi.merge(show_url, query: {trigger_enabled: 1}) : show_url
+
+      snippets = []
+      if !options[:iframe] || !options[:iframe][:container]
+        snippets << render_container_snipet(iframe_options[:container])
+      end
+      snippets << render_share_snipet({
+        url: url,
+        iframe: iframe_options,
+      })
+
+      snippets.join("\n")
+    end
+
+    protected
+
+    def default_iframe_options(tag = nil)
+      tag ||= SecureRandom.hex(3)
+      {
+        container: "talkable-offer-#{tag}",
+      }
+    end
+
+    def render_container_snipet(name)
+      "<div id='#{CGI.escape(name)}'></div>"
+    end
+
+    def render_share_snipet(show_options)
+      %Q{
+<script>
+_talkableq.push(['show_offer', #{show_options.to_json}])
+</script>
+      }
+    end
+
+  end
+end

data/lib/talkable/resources/origin.rb

@@ -0,0 +1,22 @@
+require 'time'
+
+module Talkable
+  class Origin < Hashie::Mash
+    def self.parse(result_hash)
+      origin_hash = result_hash[:origin]
+      order_date = (origin_hash ? origin_hash[:order_date] : nil)
+
+      if order_date
+        origin_hash[:order_date] = begin
+          Time.iso8601(order_date)
+        rescue ArgumentError
+          order_date
+        end
+      end
+
+      origin = self.new(origin_hash)
+      origin.offer ||= Talkable::Offer.parse(result_hash)
+      origin
+    end
+  end
+end

data/lib/talkable/version.rb

@@ -0,0 +1,3 @@
+module Talkable
+  VERSION = "0.9.0".freeze
+end

data/solano.yml

@@ -0,0 +1,20 @@
+---
+timeout: 900
+timeout_hook: 900
+bundler_version: 1.12.5
+ruby_version:
+  SPLIT:
+    - "1.9.3"
+    - "2.0.0"
+    - "2.1.0"
+    - "2.2.0"
+    - "2.3.0"
+test_pattern:
+  - spec/**_spec.rb
+hooks:
+  pre_setup: bundle install
+cache:
+  nocache: true
+coverage:
+  version: 2
+  enabled: true

data/talkable.gemspec

@@ -0,0 +1,37 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'talkable/version'
+
+Gem::Specification.new do |s|
+  s.name        = "talkable"
+  s.version     = Talkable::VERSION
+  s.date        = Date.today.to_s
+  s.summary     = "Talkable Referral Programe API"
+  s.description = "Talkable Ruby Gem to make your own referral program in Sinatra or Rails application"
+  s.authors     = ["Talkable"]
+  s.email       = "dev@talkable.com"
+  s.homepage    = "https://github.com/talkable/talkable-ruby"
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = ">= 1.9.3"
+
+  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.2')
+    s.add_dependency "rack", ">= 1.5.2", "< 2"
+  else
+    s.add_dependency "rack", ">= 1.5.2"
+  end
+
+  s.add_dependency "furi", "~> 0.2"
+  s.add_dependency "hashie", "~> 3.4"
+
+  s.add_development_dependency "bundler", "~> 1.12"
+  s.add_development_dependency "rake", "~> 11.2"
+  s.add_development_dependency "rspec", "~> 3.4"
+  s.add_development_dependency "simplecov", "~> 0.12"
+  s.add_development_dependency "json", "~> 1.8.3" if RUBY_VERSION < '2.0'
+  s.add_development_dependency "webmock", "~> 2.1"
+  s.add_development_dependency "ammeter" # specs for generators
+  s.add_development_dependency "haml" # check haml syntex in generators
+end

metadata

@@ -1,15 +1,175 @@
 --- !ruby/object:Gem::Specification
 name: talkable
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Talkable
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
-dependencies: []
+date: 2016-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: furi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !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: '11.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  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: haml
+  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: Talkable Ruby Gem to make your own referral program in Sinatra or Rails
   application
 email: dev@talkable.com
@@ -17,8 +177,42 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
 - README.md
+- Rakefile
+- lib/talkable.rb
+- lib/talkable/api.rb
+- lib/talkable/api/base.rb
+- lib/talkable/api/offer.rb
+- lib/talkable/api/origin.rb
+- lib/talkable/api/person.rb
+- lib/talkable/api/referral.rb
+- lib/talkable/api/reward.rb
+- lib/talkable/api/share.rb
+- lib/talkable/api/visitor.rb
+- lib/talkable/configuration.rb
+- lib/talkable/generators/install_generator.rb
+- lib/talkable/generators/templates/app/controllers/invite_controller.rb
+- lib/talkable/generators/templates/app/views/invite/show.html.erb
+- lib/talkable/generators/templates/app/views/invite/show.html.haml
+- lib/talkable/generators/templates/app/views/invite/show.html.slim
+- lib/talkable/generators/templates/app/views/shared/_talkable_offer.html.erb
+- lib/talkable/generators/templates/app/views/shared/_talkable_offer.html.haml
+- lib/talkable/generators/templates/app/views/shared/_talkable_offer.html.slim
+- lib/talkable/generators/templates/config/initializers/talkable.rb
+- lib/talkable/integration.rb
+- lib/talkable/middleware.rb
+- lib/talkable/railtie.rb
+- lib/talkable/resources.rb
+- lib/talkable/resources/offer.rb
+- lib/talkable/resources/origin.rb
+- lib/talkable/version.rb
+- solano.yml
+- talkable.gemspec
 homepage: https://github.com/talkable/talkable-ruby
 licenses:
 - MIT
@@ -29,19 +223,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Talkable Referral Programe API
 test_files: []
-has_rdoc: