hack3rnews 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82e9fe3f6cc5f6fa373cae0c63a4058114bb417de0d91a0c55fad23fb1de445a
-  data.tar.gz: 4e696613d05b3b9682e131d4a0b1f494549ba2a0a7c89be06301b6c3ff063ec6
+  metadata.gz: 70c46de84b63ecf71765ff736548f9000fef25183e42dbe0e80fa1388d0bc12b
+  data.tar.gz: 11c449b1017188a3a9670c2bf3013294b5c421d0c0e3499b16ba176ef9faa8f6
 SHA512:
-  metadata.gz: f528de6bcafaaff9da60e90d2ce4392af3446ca819942d24f7b62d5a8cd1fc8f832b44f65f7f42bbb17c7fc921bff2ae880535fd92262957e187a476eb5217c9
-  data.tar.gz: 8458a45c5e0dbf386da32bc42aa8ced08b8397a106467002cef97e6354230de05cccbcdfc9fc9031a0e2c4c912655c30c49820d0ab632ff054850ce9dc1f95e5
+  metadata.gz: 5eaecfdbaf0962f968cd69a8d61b1782977f8d980e78bf33ec8a3b037fe2cbc27d0f363b24740184be242609f1a72a2c4657fbb2f0cf724c0bc493d3afa8e3ba
+  data.tar.gz: 5cf662da4570b9bccbc5de5fcd7da324a16def2c9bb100b4371909c41df62f12b7cd58e986df124dbd3b1bd65c6166f74fdef3f0b47413643af66b2fce81a95f

data/README.md

@@ -9,3 +9,31 @@ Information for the API: [HackerNewsAPI](https://github.com/HackerNews/API)
 * Get the last 10 stories for a specific user (you will need to know his/her username)
 * Get all the comments of a specific story
 * Get the last 20 hihghest-rated score job stories
+
+## How to use
+
+### Installation
+First be sure to install the gem: `gem install hack3rnews`
+
+Once installed you have to require the gem in order to use it.
+At the top of your ruby file where you need to use the gem write: `require 'hack3rnews'`
+
+### Avalilable methods
+
+- Newest stories:
+  - Returns the newest stories, the last 5 by default. This method accepts an argument to specify as many as you need (based on availavility):
+  - example: `newest_stories = HackerNew.new_stories(40)`
+- Top stories:
+  - Returns the highest rated stories, the last 5 by default. It also accepts an argument to specify how many stories you need.
+  - example: `top_stories = HackerNew.top_stories(25)`
+- User stories:
+  - Returns the stories written by an specified user, the last 5 by default. It also accepts an argument to specify the amount that you need.
+  - example: `user_stories = HackerNew.top_stories(17)`
+- Story comments:
+  - Returns all the comments of a specified story. 
+  - example: `story_comments = HackerNew.story_comments(story_id)`
+- Top job stories:
+  - Returns the highest rated job stories, the last 5 by default. The method also accepts an argument to ask for certain amount of stories.
+  - example: `top_job_stories = HackerNew.top_job_stories(33)`
+
+

data/lib/hack3rnews.rb

@@ -1,76 +1,60 @@
-require 'rest-client'
-require 'json'
+require_relative 'hack3rnews/request'
 
 class HackerNew
   URL = 'https://hacker-news.firebaseio.com/v0/'.freeze
   JSON_FORMAT = '/.json?print=pretty'.freeze
 
+  @@request = Request.new
+
   class << self
     def new_stories(num = 5)
-      capture_stories('newstories', num)
+      stories('newstories', num)
     end
 
     def top_stories(num = 5)
-      capture_stories('topstories', num)
+      stories('topstories', num)
     end
 
-    def user_stories(user, num = 5)
-      capture_item_kids('user', num: num, item_id: user, kind: 'submitted')
+    def user_stories(user_id, num = 5)
+      user = item('user', user_id)
+      items(user['submitted'].first(num) || [])
     end
 
-    def story_comments(story)
-      capture_item_kids('item', item_id: story, kind: 'kids')
+    def story_comments(story_id)
+      story = item('item', story_id)
+      items(story['kids'] || [])
     end
 
     def top_job_stories(num = 5)
-      job_scores = []
-      request_bunch('jobstories').each do |job_id|
-        job_scores << request_item('item', job_id)
-      end
-      job_scores.sort_by! { |hsh| hsh["score"] }
-      job_scores.last(num).reverse
+      top_items(stories('jobstories'), 'score').last(num)
     end
 
   private
-    def capture_item_kids(type, opt = {})
-      item = request_item(type, opt[:item_id])
-      kid_ids = capture_ids(item, opt)
-      capture_items(kid_ids)
-    end
-
-    def capture_ids(item, opt)
-      num = opt[:num]
-      return (item[opt[:kind]].first(num) || [nil]) if num
-      item[opt[:kind]] || [nil]
+    def stories(type, num = nil)
+      story_ids = request.item(url(type))
+      story_ids = story_ids.first(num) if num
+      items(story_ids)
     end
 
-    def capture_stories(type, num)
-      story_ids = request_bunch(type, num)
-      capture_items(story_ids)
+    def top_items(items, field)
+      items.sort_by! { |hsh| hsh[field] }.reverse
     end
 
-    def capture_items(item_ids)
-      items = []
-      while item_id = item_ids.shift
-        items << request_item('item', item_id)
-      end
-      items
+    def items(item_ids)
+      item_ids.map {|item_id| item('item', item_id)}
     end
 
-    def request(url)
-      response = RestClient.get(url)
-      JSON.parse(response)
+    def item(type, item_id)
+      request.item(url(type, item_id))
     end
 
-    def request_item(type, id)
-      url = URL + type + '/' + id.to_s + JSON_FORMAT
-      request(url)
+    def url(type, id = nil)
+      return URL + type + '/' + id.to_s + JSON_FORMAT if id
+      URL + type + JSON_FORMAT
     end
 
-    def request_bunch(type, num = nil)
-      url = URL + type + JSON_FORMAT
-      response = request(url)
-      num ? response.first(num) : response
+    def request
+      @@request
     end
   end
 end

data/lib/hack3rnews/request.rb

@@ -0,0 +1,9 @@
+require 'rest-client'
+require 'json'
+
+class Request
+  def item(url)
+    response = RestClient.get(url)
+    JSON.parse(response)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hack3rnews
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alvaro Padilla
@@ -46,8 +46,9 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/hack3rnews.rb
+- lib/hack3rnews/request.rb
 - spec/hack3rnews_spec.rb
-homepage: https://github.com/ese-varo
+homepage: https://github.com/GregVaz/hackernews-gem
 licenses:
 - MIT
 metadata: {}