wreddit 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c5e1463a3c29c16c0a2fb0a26a9d92bf19f9e58
-  data.tar.gz: 5d68542ef815f44636c76860e2268149771584e1
+  metadata.gz: 7baadbacdc155586c41211dcc1d043832e7ef30c
+  data.tar.gz: 5c4fca23befb9658860583b47c1b4534e71062fd
 SHA512:
-  metadata.gz: b1c8860b8e8ec1022bc52225ef70ab15ea8d411a2682d1e5fb20c8c760421a1a57e98b2930696d53f02d815e3b9485327b924d11edc90e8793c4b75b018dacb7
-  data.tar.gz: 51cc2ba2ad0505894e4689845dfa1d60c0631c9552996efcbe4645b353a0176eb63f94d530808092daa785057e0d3d69f448a38780450c2326e7dfa578b0bec6
+  metadata.gz: f6dc0d37f1ab45cc6db10c272eaf8045d0e9669b046a8b4bb8b8f217c9eac646bd8e864df81f21c4c86872ba69d70d933be5b8b626df5ca4678c747adfd70829
+  data.tar.gz: 22868bab14fa9d22607dd4ae1b88841706f42eaea8874e3a454c28870bc3cd1996996693327f512914a92f0ca31e34ab64037526d879fe3d22c900a544ed1178

data/README.md

@@ -5,7 +5,7 @@ WReddit: Reddit API wrapper for Ruby
 A Reddit API Wrapper built in Ruby to play with my own Gem. It really only helps you grab subreddit information and user information.
 
 ##### What makes this special?
-It's utilizing Reddit's free API resources. You can't make a lot of requests, but if you cache them using Redis, you could probably use this on a small toy app for yourself. It's a good way to quickly grab Reddit subreddits, comments, articles, and user profiles for your application. 
+It's utilizing Reddit's free API resources. That means you don't need any authorization to make requests. You can't make a lot of requests, but if you cache them using Redis, you could probably use this on a small toy app for yourself. It's a good way to quickly grab Reddit subreddits, comments, articles, and user profiles for your application.
 
 ## Install
 add this to your Gemfile:
@@ -16,21 +16,52 @@ gem 'wreddit'
 run ```bundle install``` in your app
 
 ## How to use
-###### Reserved Keywords
-<b>User, Subreddit, Comments, Title, Parser</b>
-<br>Yes, I realize that this would be inconvenient in a real-world application. This is simply my own project that taught me basic API wrapping skills. In the future, I will likely update everything including the lack of a Class to help OOP
+As of v.1.0.2 we are using the Wreddit class.
 ###### Example of basic usage
 ```
-    @reddit_user = user('username').parser
+    wreddit = Wreddit.new #wreddit will be a standard variable for future examples
+    @reddit_user = wreddit.user('username').parse
 ```
-user    -> checks for a username on Reddit.com. If the user doesn't exist, their API handles that. 
-parser  -> will parse the response in JSON format by default. If you'd like to parse XML or HTTP, you can do that like this:
+<b>user</b>      -> checks for a username on Reddit.com. If the user doesn't exist, their API handles that.<br>
+<b>subreddit</b> -> checks for subreddit. If left empty, it'll default to /r/all.<br>
+<b>parse</b>     -> will parse the response in JSON format by default. If you'd like to parse XML or HTTP, you can do that like this:
 ```
-...parser('xml') or parser('html')
+...parse('xml') or parse('html') or parse('json')
 ```
 
 ###### Example of advanced usage
+In this example, we'd be grabbing the subreddit and its comments in a specific thread
+```
+    @reddit_comments = wreddit.subreddit('learnprogramming').comments('specific_article_id').parse
+```
+If you just quickly want to get the links, titles, or descriptions for articles/comments, I made some snappy methods.
+You don't have to parse them. For now, it assumes that you want an array from the JSON object. Getting top links to articles in subreddit
+```
+    @reddit_links = wreddit.subreddit('learnprogramming').links
+```
+Getting top titles of articles in subreddit
+```
+    @reddit_titles  = wreddit.subreddit('learnprogramming').titles
+```
+Getting top descriptions of articles in subreddit
+```
+    @reddit_descriptions = wreddit.subreddit('learnprogramming').descriptions
+```
+
+##### Hazards
+You cannot assume that any of these methods together will provide some response. Logically, some of these will render nil arrays. However, you'd be surprised by some things you can do. Like:
 In this example, we'd be grabbing the subreddit, its comments in a specific thread
 ```
-    @reddit_comment = subreddit('learnprogramming').comments('specific_article_id').parser
+    @stuff = wreddit.user('myusername').links #provides valid links to user submitted threads
+
+    @stuff = wreddit.user('myusername').descriptions #provides valid descriptions to commments
+```
+
+But you would <b>NOT</b> be able to write something like:
 ```
+    @invalid_response = wreddit.user('myusername').subreddit('learnprogramming').parse
+```
+
+The API will response with 404.
+
+Email me with any questions at seanjhulse@gmail.com

data/lib/wreddit/version.rb

@@ -1,3 +1,3 @@
 class Wreddit
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wreddit
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Sean Hulse