Skip to content

Commit c5c748d

Browse files
eatmycodeeatmycode
committed
Restructured.
0 parents  commit c5c748d

File tree

5 files changed

+421
-0
lines changed

5 files changed

+421
-0
lines changed

‎.gitattributes

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Automatically normalize line endings for all text-based files
2+
* text=auto

‎.gitignore

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Folder view configuration files
2+
.DS_Store
3+
Desktop.ini
4+
5+
# Thumbnail cache files
6+
._*
7+
Thumbs.db
8+
9+
# Files that might appear on external disks
10+
.Spotlight-V100
11+
.Trashes

‎LICENSE.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
3+
Copyright (C) 2014, Terrence Harvey [[email protected]]
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

+170
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
`stweet` (aka. `ShellTweet`)
2+
---
3+
4+
A simple shell script to post tweets to your timeline using Twitter's v1.1 API.
5+
6+
* Do you live in your CLI?
7+
* Rather not switch to a browser or other device to broadcast to the world?
8+
* Wanna automate tweets of whatever gibberish via cron?
9+
10+
If yes to any of the above, then `stweet`!
11+
12+
So, this is just the beginning! `ShellTweet` suggestions and pull requests are welcome and encouraged.
13+
14+
## Requirements
15+
16+
Linux Based OS/Virtual Environment
17+
18+
`AND`
19+
20+
PHP >= 5.3.x
21+
22+
`OR`
23+
24+
OpenSSL
25+
26+
---
27+
28+
Why PHP or OpenSSL?
29+
30+
Well, the signature for authorizing and posting the status update is calculated by passing the signature base string and signing key to the HMAC-SHA1 hashing algorithm. The details of the algorithm are explained in depth [HERE](http://en.wikipedia.org/wiki/HMAC), but thankfully there are implementations of HMAC-SHA1 available for every popular language. For example, PHP has the [hash_hmac function](http://php.net/manual/en/function.hash-hmac.php) and HMAC-SHA1 hashing can easily be generated on almost any modern Unix-like system using [OpenSSL](http://www.openssl.org/docs/apps/dgst.html).
31+
32+
---
33+
34+
* Hashing defaults to PHP if both are installed.
35+
36+
* On a production webserver, typically both would already be installed (see your host if you are unsure).
37+
38+
* If using on your local box and you dont have a l/a/n/mp stack or stand-alone PHP install or OpenSSL, then get one.
39+
40+
* A quick check:
41+
42+
# Open up a linux terminal and type:
43+
44+
~$ which php openssl
45+
46+
# If you have 1 or both installed, you should see something similar to:
47+
48+
~$ which php openssl
49+
/usr/local/bin/php
50+
/usr/bin/openssl
51+
52+
# If you get nothing in return or see somthing like /usr/bin/which: no {SOFTWARE_NAME} in (/usr/local/bin:.....
53+
# for both php AND openssl, then you dont have either installed.
54+
55+
56+
## Configuration
57+
58+
The goal of `stweet` is simplicity `PAUSE` You do however need to make yourself a twitter app!
59+
60+
So basically, you need to:
61+
62+
1. First, [go and create yourself a twitter app on the twitter developer site](https://dev.twitter.com/apps/).
63+
2. After creation, click the `Settings` tab, scroll down and enable read/write access for your twitter app. (This will take a min.)
64+
3. Now, click the `Details` tab, scroll down and click `Create my access token` (This will also take a min.)
65+
4. Lastly, click the `OAuth tool` tab and grab your consumer key/secret and access token/secret:
66+
67+
![twitter/developers](http://api.marquelmedia.net/ss/OAuth_tool.png)
68+
69+
Ok, got all that?
70+
71+
Now, open up `stweet` in your preferred editor and add your app access tokens (lines 132-135).
72+
73+
124
74+
125 #############
75+
126 # TWITTER API
76+
127 #
77+
128 # Your application's OAuth settings.
78+
129 ##### [EDIT THIS TO YOUR APPLICATION'S VALUES]
79+
130
80+
131
81+
132 app_key="YOUR_CONSUMER_KEY"
82+
133 app_secret="YOUR_CONSUMER_SECRET"
83+
134 access_token="YOUR_ACCESS_TOKEN"
84+
135 access_secret="YOUR_ACCESS_SECRET"
85+
136
86+
87+
88+
All that's left is to just place `stweet` in your scripts, bin, or executable dir:
89+
90+
~$ cd /place/to/where/you/downloaded/stweet
91+
~$ mv stweet /path/to/your/executable/scripts/
92+
93+
...or create a symlink to `stweet` in your scripts, bin, or executable dir:
94+
95+
~$ cd /path/to/your/executable/scripts/
96+
~$ ln -s /place/to/where/you/downloaded/stweet ./stweet
97+
98+
**Done!**
99+
100+
## How To `stweet`
101+
102+
1. Tweet It. (A tweet oneliner)
103+
104+
~$ stweet this is pretty dope!
105+
106+
# NOTE: ONLY if using this option (Option 1. - Direct tweet),
107+
# all "hastags" must be escaped with a '\'
108+
109+
~$ stweet \#money on my \#mind.
110+
111+
# WHY: Linux will see it as a comment and ignore everything after the first "#"
112+
113+
114+
2. Prompt It. (Prompts you for your message)
115+
116+
~$ stweet
117+
What Are You Tweetin' [140 pls]: yep this is very simple #bashery
118+
119+
120+
3. Pipe It. (Feed stweet the stdout from another command or series of commands)
121+
122+
~$ cat somefile | stweet
123+
124+
125+
4. Cron It. (Automate your tweets)
126+
127+
*/5 * * * * PATH=PATH:/path/to/your/executable/scripts/; curl -s http://something.from/somewhere | stweet > /dev/null 2>&1
128+
129+
130+
Yep. Pretty `stweet` right?
131+
132+
If successful, you will see something like:
133+
134+
~$ stweet Ok. I can do this. \#osohappy
135+
136+
Tweeted It!
137+
138+
139+
If an error occurs, it will be displayed in un-pretty (sorry) JSON: o_o
140+
141+
~$ stweet This is some text that is really long and not less than 140 characters. But it is something I really want to get off of my chest because it is important for me to say it!
142+
143+
Error: [ {"errors":[{"code":186,"message":"Status is over 140 characters."}]} ]
144+
145+
## Limitations
146+
147+
This is a simple CLI tool. Nothing real extravagant here.
148+
149+
It's primarily for text only tweets <= 140 characters and nothing more (at least currently).
150+
151+
However, it's use can be expanded upon as you wish... ([Check the Twitter API docs](https://dev.twitter.com/docs/api/1.1/)).
152+
153+
I'd love to see/merge what other `stweet` things you do with it.
154+
155+
## OS's
156+
157+
Tested and confirmed working on:
158+
159+
* Mac OSX 10.9.1
160+
* CentOS 6.4
161+
* CentOS 5.10
162+
* More to come...
163+
164+
If working for you (or not) and your OS is not mentioned, please drop me a line with your OS/Environment.
165+
166+
## License
167+
168+
[MIT License](http://api.marquelmedia.net/lic/LICENSE.md)
169+
170+

0 commit comments

Comments
 (0)