talkable 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e94689a0311b0f5980c51d6c3b3c59eeaad486cd
+  data.tar.gz: 2c75680682ea43977ec09be2593777b26a0b73b7
+SHA512:
+  metadata.gz: 832d25a3e582759ee9805ea37aae94c4c4d86dedf42b9da87a21020f4908930ae55eb5bb224a886ad637787449b5c452a69914575f9dcadf6aa1f699141984b9
+  data.tar.gz: 604b1781a85154c1f744bcdd7c607927ed0ca9fa74972196eb8ea93c22709d3c5b8b0a6975148d5a6a2b0810e0ac37a39a0fe53231a5446e5c0dfebcc21d056d

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/README.md

@@ -0,0 +1,245 @@
+# Talkable Referral Programe API Gem
+
+Talkable Ruby Gem to make your own referral program in Sinatra or Rails application
+
+
+
+## Demo
+
+Take a spree demo app and intall Talkable
+
+## Intallation
+
+``` ruby
+gem "talkable"
+```
+
+## Using Generator
+
+``` sh
+rails generate talkable:install
+Your talkable site slug (http://talkable.com): 
+You API token (http://talkable.com/sites/zz/edit):
+Do you want a different site to be used for non-production env? (y/n)
+Your staging site slug:
+Your staging site API token:
+
+
+create config/initializers/talkable.rb
+update app/controllers/application_controller.rb
+
+create app/controllers/talkable_invite.rb
+create app/views/talkable_invite/show.html.erb
+update app/layouts/application.html.erb # floating widget install
+update app/layouts/_talkable_floating_widget.html.erb
+update config/routes.rb
+```
+
+## Configuration
+
+``` ruby
+Talkable.configure do |c|
+  # required
+  c.site_slug = 'hello'
+  # or
+  c.site_slug = Rails.env.production? ? "hello" : "hello-staging"
+  # required
+  c.api_token = Rails.env.production? ? "1235" : "6789" 
+  # required
+  c.server = 'http://invite.site.com' # fetched from site settings automatically using generator
+  # optional
+  c.js_integration_library = 'http://d2jj/integration/hello.js'  # default
+end
+```
+
+
+
+``` ruby
+class ApplicationController < ActionController::Base
+
+  initialize_talkable_api
+
+end
+
+# GEM internals
+class Talkable
+  module ActionControllerExtension
+    def self.initialize_talkable_api
+      before_action :talkable_before_request
+    end
+
+    def talkable_before_request
+      cookies[:talkable_visitor_uuid] = params[:talkable_visitor_uuid] || talkable_visitor_uuid
+      Talkable.with_uuid(talkable_visitor_uuid) do
+        yield
+      end
+    end
+
+    def talkable_visitor_uuid
+      cookies[:talkable_visitor_uuid] ||= Talkable.find_or_generate_uuid
+    end
+  end
+end
+```
+
+
+
+
+## API
+
+Full API support according to DOC
+
+
+``` ruby
+origin = Talkable::API.register_purchase(
+    {
+      email: 'a@b.com',
+      subtotal: 100.53,
+      coupon_codes: [],
+      traffic_source: 'zz'
+    },
+    )
+origin = Talkable::API.register_event()
+origin = Talkable::API.register_affiliate_member(
+offer = origin.offer
+    {
+      email: '...'
+      sharing_channels: ['facebook', 'embedded_email', 'sms', 'other']
+    }
+    )
+
+offer.claim_links # =>
+                  # {
+                  #   twitter: "http://invite.site.com/x/12356"
+                  #   facebook: "http://invite.site.com/x/12356"
+                  #   embedded_email: "http://invite.site.com/x/12356"
+                  #   twitter: "http://invite.site.com/x/12356"
+                  # }
+```
+
+## AD Offer Share page
+
+
+
+User facing GEM API
+
+``` erb
+<%= offer.advocate_share_iframe %>
+
+```
+
+Generated code:
+
+
+```  html
+<div class='talkable-offer-xxx'>
+  <!-- result of the JS evaluation - not ruby evaluation -->
+  <iframe src="https://invite.site.com/x/38828?current_visitor_uuid=<uuid>"></iframe>
+</div>
+
+<script>
+_talkableq.push(['init', {
+  server: '...',
+  site_id: '...',
+  visitor_uuid: '...'
+}])
+_talkableq.push(['show_offer'], "https://invite.site.com/x/38828", {container: 'talkable-offer-xxx'})
+</script>
+```
+
+## integration.js extension
+
+`integration.js` additions. Suppose to be never used directly if using talkable gem
+
+``` js
+talkable.showOffer(offer.show_url)
+```
+
+
+## Self-Serve UI
+
+
+``` ruby
+offer.configure(
+  facebook: {
+    title: ['An offer for all my friends', 'Claim your reward'], # AB test
+    description: 'Click this link and get #{campaign.friend_incentive.description} off on the merchant.com'
+    image: "http://merchant.com/assets/fb_image.jpg"
+  },
+  twitter: {
+    message: 'Click #{offer.claim_links.twitter} and get {{friend_incentive.description}} off on the merchant.com'
+  },
+)
+
+
+offer.configure(
+  twitter: {
+    message: 'Click #{offer.claim_links.twitter} and get {{friend_incentive.description}} off on the merchant.com'
+  },
+
+)
+```
+
+
+
+
+``` js
+
+offer = Talkable.offer(<%= offer.to_json %>)
+$('.js-share-via-facebook').click(
+    offer.shareViaFacebook()
+)
+$('.js-share-via-twitter').click(
+    offer.shareViaTwitter()
+)
+$('.js-share-via-sms').click(
+    offer.shareViaSms()
+)
+offer.bindClickLink($('.js-plain-offer-link'))
+```
+
+
+``` haml
+%h1= offer.localize('offer_title')
+%h1= offer.ab_test("Share with friends", "Get yourself a discount %{advocate_amount}", advocate_amount: campaign.advocate_incentive.description)
+%p
+  Share this offer with friends and get <%= campaign.advocate_incentive.description %>
+
+
+%a.js-share-via-facebook Facebook
+%a.js-share-via-twitter Twitter
+%a.js-share-via-sms Twitter
+```
+
+
+``` ruby
+# routes.rb
+mount Talkable::Rack => 'talkable'
+```
+
+
+## TODO
+
+Functionality:
+
+* [ ] Gem infrustructure
+* [ ] Configuration
+* [ ] API
+  * Custom Traffic Source
+  * Custom User Agent
+  * Visitors
+  * Origins
+  * Shares
+  * Rewards
+* [ ] Controller uuid hook
+* [ ] Offer Share Iframe
+  * [ ] Integration JS additions
+  * [ ] Ruby iframe generation method
+* [ ] Generator
+* [ ] Documentation
+  * Post-Checkout integration instructions
+  * Events integration instructions
+* [ ] Setup demo with the most popular ruby shopping cart gem
+
+Caveats:
+* [ ] Prevent API call to create visitor on first request. Delay until user interacts with RAF.

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: talkable
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Talkable
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-11 00:00:00.000000000 Z
+dependencies: []
+description: Talkable Ruby Gem to make your own referral program in Sinatra or Rails
+  application
+email: dev@talkable.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+homepage: https://github.com/talkable/talkable-ruby
+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.7
+signing_key: 
+specification_version: 4
+summary: Talkable Referral Programe API
+test_files: []
+has_rdoc: