https://github.com/gaiterjones/magento-tweetproducts

Magento Product Tweet v0.5x

1. Introduction
2. Prerequisites
3. Installation
4. Configuration
5. Usage

Introduction

Magento Product Tweet is an object oriented PHP script that integrates with a Magento installation to automatically tweet product information for new products set with the New From date attribute in the Magento database.

Magento Product Tweet works with Magento Community Edition version 1.4 or greater and requires PHP 5.3 or greater.

Prerequisites

This application requires a configured Twitter Account and configured Twitter application for the account as well as a Bitly API key to generate short urls.

To configure a Twitter App visit https://dev.twitter.com/

To configure a bitly account visit http://bit.ly

Installation

Extract the source files to a folder on your system i.e. /home/php/magento

A new folder producttweet will be created.

Make sure the subfolders cache, and log are writeable by your current and crontab users.

Configuration

Edit the file applicationConfig.php in /producttweet/config.

Edit

const PATH_TO_MAGENTO_INSTALLATION = ‘/home/www/dev/magento/’;

With the actual path to your Magento installation.

Edit

const FILE_CACHE_FOLDER = ‘/home/php/producttweet/cache/’;

With the full path to the producttweet cache folder.

Edit the Twitter and Bitly api authentication details.

Edit the application configuration settings:

tweetsPerSession – this is the number of products that will be Tweeted each time the script runs.

tweetHeadline – this is the prefix to the Tweet text.

tweetFromHour – Time range to tweet between – from hour between 00 and 23

tweetToHour – Time range to tweet between – to hour between 00 and 23

e.g. to only tweet between 0900 and 2200 set the From hour to 09 and the To hour to 23.

useDecriptionText – set this to short or long to use either the short or long product description for the tweet text.

Save the file.

Usage

To run the script for the first time to check functionality change to the scripts working directory and type

php tweetproduct.php notweet

The script will execute normally but with tweeting disabled. If there are errors with your main configuration you will see them reported now. If no errors are reported the script will return a summary of all products in your Magento database with a New From date that matches todays date.

If no products are returned check that you have set the new from date attribute correctly on a product.

If products are found a summary of each products will be shown including an example of the Tweet text and URL e.g.

Session started – 2012-10-22 18:12:33

//–>

135 – Anashria Womens Premier Leather Sandal / ana

NEW TODAY! Anashria Womens Premier Leather Sandal, Buckle embellished contrasting straps adorn both the heel and… http://bit.ly/VrhMwA – 136

Cache file /root/Dropbox/paj/www/dev/magento/tweetproducts/cache/2012-10-22-9ac43d1842fd2477f500d028b158b496 created.

<–//

//–>

132 – SLR Camera Tripod / ac674

NEW TODAY! SLR Camera Tripod, Sturdy, lightweight tripods are designed to meet the needs of amateur and professional… http://bit.ly/VtXzX1 – 140

Session tweet limit (1) reached, ending session.

2 product/s found.

1 product/s tweeted this session.

1 product/s tweeted today – 2012-10-22.

If the results and Tweet examples are correct run the script again with the flushcache swith to delete the cache files :

php tweetproducts.php flushcache

And then run the script without the notweet switch to test live tweeting.

A tweet success or failure message will be displayed for each product, and the tweets should appear in your twitter feed.

Script activity will be logged in the ./log folder. You can delete the log files with the flushlogs switch.

To automate tweeting completely add the script to your crontab, e.g. to run the script every 5 minutes use

*/5 * * * * /usr/bin/php -f /home/php/magento/tweetproducts.php silent

Note the silent switch disables all script output.

If the script detects errors use the showtrace switch for more information and email the log file to extensions@gaiterjones.com for assistance.

PAJ 22.10.2012

How it Works

The code in the module is called at checkout and a random product is selected from products in  the customers cart. The information from this random “Top Seller” product is used to create a product marketing post, including a headline, short description and short Bit.ly URL to link to the product page. The built in Magento scheduling system is then used to regularly check for new marketing posts and send them to Twitter and Facebook.

To use this module you must enable the Magento scheduling system and will need a Twitter  account, and configured Twitter application, a Facebook account and configured Facebook application and a Bit.ly account, further information for setting these accounts up is detailed below.

Tested with Magento CE 1.6.1

I am looking for extension testers, download BETA version 0.26 (last updated 09-12-2011) of the extension here

Updates

If you use this extension be sure to update to the latest version.

*  0.22 – First beta release. 15.09.2011
*  0.23 – Developed Facebook integration and duplicate post control logic. 16.09.2011
* 0.24 – Improved Facebook posting, added logic to exclude posts for products in specified categories. 19.09.2011
* 0.25 – Added time range to stop being too spammy by restricting posts to specific hours of the day. 04.11.2011
* 0.26 – Fixed grouped products not being posted due to hidden child simple products of the parent group product.

Wishlist

Implement logic to control the duplication of product Tweets. Done – v0.23
Extend to other Social Media platforms, Facebook, etc. Facebook Support in v0.23
Implement hash tags for Twitter.
Add to Cart link in Facebook posts
Add option to use Short or Long description text.

Installation

Prerequisites :

Enable Magento scheduling system
Twitter Account
Twitter Application
Facebook Account
Authorised Facebook Application

Bit.ly Account (optional)

To install this extension:

1. Unzip the module and copy the contents of the modules app folder to the app folder of your Magento store installation.

2. Ensure that the module /cache and /cache/Bitly folders have write permissions set to allow the WWW user group write access. The module stores the product Tweets and caches the Bit.ly short URLs in this folder.

3. Refresh the Magento Store cache

4. Logout and login back into the admin backend, goto System – Configuration and locate the configuration settings under My Extensions – Social Media Marketing.

Configuration

1. Configure the Twitter, Facebook and Bit.ly account, authorisation and API keys. See below for further information. If you do not want to use the Bit.ly short URL service set the enable option to no.

Twitter is enabled by default, Facebook is disabled by default.

2. Define a headline prefix for the product marketing text, the default if left blank is “Top Seller:” To disable this prefix enter NONE. For Facebook you can define the text to use for the post header. Define the “uniqueness” value for posts, this value will be used to check for if a product has already been posted in the last X posts, where X is the value you define here. This will help prevent duplicate posts. You can also configure a time range so that Social Media Marketing posts will only be made during the times selected.

3. Configure Google UTM tags for traffic tracking in Google analytics.e.g. ?utm_source=SocialMediaMarketing&utm_medium=Top-Seller&utm_campaign=MyCampaig

4. Enable email alerts which will help you debug the module during testing.

5. Save the extension configuration settings and test.

Testing

Make a test order in your store to test the extension. Upon checkout completion the product marketing information will be written to the modules cache folder. At the next scheduled Magento task execution the text will be posted to Twitter (and Facebook if enabled) and the cached file deleted.

To force the Magento scheduler to run navigate to http://www.yourwebshop.com/cron.php. Check your Twitter and Facebook pages to confirm the marketing post has been submitted. Any errors that occur during this process will be emailed to the default store email address if you set email alerts enabled to YES in the configuration.

ENABLE MAGENTO SCHEDULING

Magento uses a single file named cron.php to execute all its scheduled tasks –  cron.php should be executed regularly to allow configured background tasks in Magento to run and is also used by this module to check for marketing information to post. For example to run cron.php every 5 minutes add the following or similar to your crontab (crontab -e):

*/5 * * * * /usr/bin/php -f  /PATH-TO-MAGENTO/cron.php

Alternatively for testing you can execute cron.php from your browser by browsing to

http://www.yourstore.com/cron.php

TWITTER Configuration

Folow the steps below to create a Twitter application that will be used by the module to access your Twitter account and post product marketing Tweets.

1. If you do not already have a Twitter account, create an account at http://www.tiwtter.com

2. Go to https://dev.twitter.com/ and login with your Twitter credentials.

3. Click the Create an App link.

4. Complete the first page of the application form with your application name, description and website address. A Callback URL is not required. Click the “Create your twitter app” button to continue.

5. Goto the application settings tab and ensure your application is set to Read and Write and click Update Setting to continue.

6. Click on the details tab and scroll down to the Create my access Token button, click it to create access tokens for the application. You will see the four main authentication tokens listed CONSUMER KEY, CONSUMER SECRET, ACCESS TOKEN and ACCESS TOKEN SECRET. Ensure that the access tokens have READ and WRITE access.

7. Copy each authentication token into the configuration settings of the module and click save.

If you do not want to use Bit.ly to shorten URLs in the marketing tweets you have the option of enabling t.co shortlinks in the application settings and you can disable Bit.ly in the extension settings.

You can confirm your application is enabled and has access to your Twitter account by going to account settings -> applications in Twitter.

FACEBOOK CONFIGURATION

Login to Facebook and then browse to

http://developers.facebook.com/

Create an application that will be used to post marketing information to your Facebook page, this can be a normal profile page or a Business/Fan page. When complete note the application ID and application secret.

The application must be authorised for your Facebook page to work.

To authorise the application for your page edit the following URL and paste to your browser, replaceing YOURAPIKEY and YOURPAGEID..

facebook.com/connect/prompt_permissions.php?api_key=YOURAPIKEY&v=1.0&next=http://www.facebook.com/connect/login_success.html?xxRESULTTOKENxx&display=popup&ext_perm=publish_stream&enable_profile_selector=1&profile_selector_ids=YOURPAGEID

BIT.LY CONFIGURATION

To create a Bit.ly account goto http://bit.ly and register an account. Once registered obtain your API key by clicking on Account -> Settings. Configure your bit.ly username and API key in the configuration settings of the extension and save them.Bit.ly is enabled by default in the extension, If you do not want to use bit.ly you can disable it in the configuration settings.