talkable 1.0.3 → 1.0.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +3 -1
- data/TUTORIAL.md +7 -37
- data/lib/talkable/generators/install_generator.rb +1 -0
- data/lib/talkable/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e3fbd60d272672f462b414e27367089db71bb4a9aaad907cfcaa8f54051c22ad
|
4
|
+
data.tar.gz: a4883171c255a0b69fd381378c5a4b83cee47904f971dbacd53c4caf73bc8e97
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6d47cdd3cfd41cc753be0b37300e227ca59b7a9b8c8a4819f4eef7868abaced41f02e90b82a196336c4d3f824cf61992bedcd84c2e6f9f913baea2b6e4f4f837
|
7
|
+
data.tar.gz: cde0da734dd43e88f74d75dcd25b98a4e5fc20f58a15d8b07c3d3984e8c504725526309470024d0174e597ad5dd9e268540702a11418798906d7a6d4fd29eec9
|
data/README.md
CHANGED
@@ -3,6 +3,8 @@
|
|
3
3
|
|
4
4
|
Referral marketing is one of the most powerful strategies for ecommerce sales growth. [Talkable]( https://www.talkable.com) provides a rich platform for referral marketing. You can integrate sophisticated referral marketing into your own ecommerce site using the Talkable Ruby gem for a Rails or Sinatra application.
|
5
5
|
|
6
|
+
Here you can create Talkable account https://admin.talkable.com/register?self_serve
|
7
|
+
|
6
8
|
## Demo
|
7
9
|
|
8
10
|
See an example application at http://github.com/talkable/talkable-spree-example.
|
@@ -272,7 +274,7 @@ Talkable::API::Person.update(email, unsubscribed: true)
|
|
272
274
|
Talkable::API::Reward.find(visitor_uuid: '8fdf75ac-92b4-479d-9974-2f9c64eb2e09')
|
273
275
|
```
|
274
276
|
|
275
|
-
For more information see the tests.
|
277
|
+
For more information see the tests.
|
276
278
|
|
277
279
|
## Questions? Need Help? Found a bug?
|
278
280
|
|
data/TUTORIAL.md
CHANGED
@@ -2,47 +2,21 @@
|
|
2
2
|
|
3
3
|
## Introduction
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
Read the [first tutorial](https://railsapps.github.io/talkable-referral-marketing-basics/) to grasp the basic concepts you'll need to know to use the Talkable platform. This tutorial shows how to build an application with the same functionality as the first tutorial application, but instead of using the JavaScript integration library you'll use the Ruby gem and the Talkable API.
|
8
|
-
|
9
|
-
The [second tutorial](https://railsapps.github.io/talkable-referral-marketing-gem/) is an older version of this one before we added an example campaign on account creation and corresponding generators in the gem. The second tutorial has more details about what happens under the hood and could still be interesting for this reason.
|
10
|
-
|
11
|
-
This third tutorial will mature partly into self-serve users landing page and partly into our documentation in a course of several next releases.
|
5
|
+
You may read the [first tutorial](https://railsapps.github.io/talkable-referral-marketing-basics/) to grasp the basic concepts you'll need to know to use the Talkable platform. This tutorial shows how to build an application with the same functionality as the first tutorial application, but instead of using the JavaScript integration library you'll use the Ruby gem and the Talkable API.
|
12
6
|
|
13
7
|
## Requirements
|
14
8
|
|
15
|
-
|
16
|
-
You'll need only beginner skills as a Rails developer to follow this tutorial.
|
9
|
+
Ruby 2.3+ and Rails 5.0+ (if you're using Rails).
|
17
10
|
|
18
11
|
## Create an Account
|
19
12
|
|
20
|
-
First
|
21
|
-
|
22
|
-
When asked to choose a platform, choose "other" for Rails integration. Then you can provide details such as email address and password.
|
23
|
-
|
24
|
-
Your site name can be the name of your website, brand or company. You'll be able to add additional sites to your account after you create the first site.
|
25
|
-
|
26
|
-
For this tutorial, set the Site URL to `http://localhost:3000/` so you can develop and test the application locally.
|
13
|
+
First [create a Talkable account](https://admin.talkable.com/register?self_serve).
|
14
|
+
When asked to choose a platform, choose "Other" for plain Rails integration. In order to be able to develop and test the application locally set the Site URL to `http://localhost:3000/`.
|
27
15
|
|
28
16
|
![talkable-create-account](tutorial_images/talkable-create-account.png)
|
29
17
|
|
30
18
|
**An example campaign is created automatically for you.**
|
31
19
|
|
32
|
-
## Fraud Settings
|
33
|
-
|
34
|
-
This part of the tutorial won't be needed in a few days as we will be setting different default fraud settings, but it is needed for now.
|
35
|
-
|
36
|
-
Talkable prevents common (and not-so-common) referral fraud like self-referrals. For example, for product sales sites, referral marketing isn't profitable if shoppers can give themselves discounts by entering their own alternative email addresses.
|
37
|
-
|
38
|
-
For our tutorial, we'll want to enter our own alternative email addresses and visit the application using the same web browser and the same IP address. We'll change the Fraud Settings to allow this.
|
39
|
-
|
40
|
-
![talkable-menu-fraud](tutorial_images/talkable-menu-fraud.png)
|
41
|
-
|
42
|
-
Set the "Fraud Profiles" (in the upper left corner) to "Low." Then set each individual fraud rule for Advocate and Friend to "Skip," specifically "Matching Email or Cookie on Friend Purchase" and "Matching Cookie on Friend Claim Page." This will allow self-referrals for testing the tutorial application in your local development environment.
|
43
|
-
|
44
|
-
Be sure to click the "Save Changes" button to save the fraud settings.
|
45
|
-
|
46
20
|
## Launch the Campaign
|
47
21
|
|
48
22
|
You are done with the Talkable administrative interface for now and can launch your example campaign, even though your web application isn't ready yet.
|
@@ -61,7 +35,7 @@ Ignore any warnings, accept the defaults, and click the orange "Launch campaign"
|
|
61
35
|
|
62
36
|
You'll see a warning, "No Integration Found." Ignore the warning. Talkable checks if an Integration script is present on a production site but our development site is not running or accessible to Talkable. Click the green "Launch Now" button.
|
63
37
|
|
64
|
-
|
38
|
+
Your campaign will be live and waiting for events triggered by advocates (recommendations) or friends (claiming rewards). All events generated by the Talkable JavaScript integration library will be tracked and captured by Talkable for analysis and optimization.
|
65
39
|
|
66
40
|
Next, we will set up the tutorial application to use the Talkable campaign. After that, we can return to the Talkable site to see reports of all activity.
|
67
41
|
|
@@ -71,15 +45,11 @@ You can use the [Talkable Ruby Gem](https://github.com/talkable/talkable-ruby) t
|
|
71
45
|
|
72
46
|
Add the gem to the project *Gemfile* and run `bundle install`.
|
73
47
|
|
74
|
-
`gem 'talkable'
|
75
|
-
|
76
|
-
`$ bundle install`
|
77
|
-
|
78
|
-
Your gem is installed. Let's configure your application.
|
48
|
+
`gem 'talkable'`
|
79
49
|
|
80
50
|
## Get Your Site Slug and API Key
|
81
51
|
|
82
|
-
The Talkable gem provides a
|
52
|
+
The Talkable gem provides a Rails generator for basic configuration of the gem.
|
83
53
|
|
84
54
|
### Site Slug
|
85
55
|
|
@@ -9,6 +9,7 @@ module Talkable
|
|
9
9
|
class_option :slim, type: :boolean, default: false
|
10
10
|
|
11
11
|
def ask_config_values
|
12
|
+
puts "If you don't have Talkable account yet, create one here: \e]8;;https://admin.talkable.com/register?self_serve\ahttps://admin.talkable.com/register?self_serve\e]8;;\a"
|
12
13
|
@site_slug = ask("Your Talkable site slug:")
|
13
14
|
@api_key = ask("Your Talkable API Key:")
|
14
15
|
if yes?('Do you have a custom domain? [Y/n]')
|
data/lib/talkable/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: talkable
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Talkable
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-09-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rack
|