se-realtime 0.0.0.beta0 → 0.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 712132141551c830aa22ec30a8c73bd689d860e2
-  data.tar.gz: b4ccff6e2106244445eb633177870e8802d8b938
+  metadata.gz: 99186f6f66fdcc6578e58711019984ec0fd9911e
+  data.tar.gz: 5f92c4c7cbcde8e943b79165eeec8722ad4eb415
 SHA512:
-  metadata.gz: 4e591185c80ea2836d5b0a7c371c44883a81ca6328f364b1888c720b492f333d920d9b3b06e6c72dcceb3f67eaa498d5528fb06f0e3586ebe0b7629f52e6c061
-  data.tar.gz: 86ffbf8259c9d7ffcc4e2caea6c107f734d4da0146c3cb7d16ab7af287e9a6c55cefeef3813ad557fa9af20c49cf4f538249837424d1030a45b0a3f8c5f14cad
+  metadata.gz: 0a7bc67b138ac70d88044fb55e42e37fba688e95de796f39d8ffb0e331540168ddad382bb531ae0a71490f396ef5283bb3a139ef403e5e981778f0dd4df91777
+  data.tar.gz: 0610f196988de9099cb0f09849b101d78276e6e9a43d0886ee9ab4cea94617b45be2411a285e677bcc026cdd707cd57e557d4489ad047963e928a0f9a60887d6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    se-realtime (0.0.0.beta0)
+    se-realtime (0.0.0.beta1)
       mechanize (~> 2.7)
       nokogiri (~> 1.8)
       permessage_deflate (~> 0.1)

data/README.md

@@ -1,8 +1,6 @@
-# Se::Realtime
+# SE Realtime
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/se/realtime`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+SE Realtime is a ruby API for the [Stack Exchange real time questions feed](https://stackexchange.com/questions?realtime). It allows various methods of retrieving questions from that page.
 
 ## Installation
 
@@ -22,7 +20,66 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First of all, require it with `require 'se/realtime'`.
+
+Then, pick a retrevial method:
+
+### Retrieveal methods
+
+#### Raw
+
+To simply get exactly what the websocket is spitting out, use the raw retrevial method:
+
+```ruby
+
+SE::Realtime.ws do |data|
+  puts data
+end
+```
+
+This will print out exactly what comes out of the websocket (`JSON.parse`d).
+
+> **Warning:**
+>
+> The only relevant part here is the data field of the json, which has a string value (because reasons), and so you must `JSON.parse(data['data'])` to get the real data.
+
+#### JSON
+
+To get a neatly formatted version of the post with nicer keys, use this method. The keys are all symbols:
+
+- site: The simple name of the site
+- body: A truncated version of the body of the post (with "..." appended)
+- title: The title of the post
+- last_active: The timestamp from SE of the last activity.
+- site_url: The base url of the site that the post came from
+- url: The url of the post
+- owner_url: The url of the profile of the owner
+- owner_display_name: The display name of the owner
+- id: The ID of the post
+
+Syntax:
+
+```ruby
+SE::Realtime.json do |data|
+  puts data
+end
+```
+
+This also accepts a `site: 'sitename'` parameter to filter by site.
+
+#### Batched
+
+This is identical to the JSON method, except it takes a batch size and returns an array of Hashes of the size passed. It passes all hash parameters on to json, so you can use filters such as `site: 'sitename'`.
+
+Syntax:
+
+```ruby
+SE::Realtime.batch 10, site: 'stackoverflow' do |data|
+  puts data
+end
+```
+
+This will return arrays of 10 stackoverflow posts every time 10 have been retrieved.
 
 ## Development
 
@@ -32,7 +89,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/se-realtime.
+Bug reports and pull requests are welcome on GitHub at https://github.com/izwick-schachter/se-realtime.
 
 ## License
 

data/lib/se/realtime.rb

@@ -5,14 +5,55 @@ module SE
   module Realtime
     class << self
       def on_post(&handler)
-        WSClient.new("https://qa.sockets.stackexchange.com", cookies) do |e|
+        ws do |e|
           data = JSON.parse e['data']
           handler.call(data)
         end
       end
 
+      def json(site: nil, &handler)
+        ws do |e|
+          data = clean_keys(JSON.parse(e['data']))
+          handler.call(data) if data[:site] == site || site.nil?
+        end
+      end
+
+      def batch(size, **opts, &handler)
+        posts = []
+        json(**opts) do |e|
+          posts << e
+          if posts.length >= size
+            handler.call(posts)
+            posts = []
+          end
+        end
+      end
+
+      def ws(&block)
+        WSClient.new("https://qa.sockets.stackexchange.com", cookies, &block)
+      end
+
       private
 
+      def clean_keys(json)
+        {
+          'apiSiteParameter' => :site,
+          'titleEncodedFancy' => :title,
+          'bodySummary' => :body,
+          'lastActivityDate' => :last_active,
+          'siteBaseHostAddress' => :site_url
+        }.each do |old_key, new_key|
+          json[new_key] = json.delete(old_key) if json.key?(old_key)
+        end
+        json.map do |k,v|
+          if k.is_a? String
+            [k.gsub(/([a-z\d])([A-Z])/,'\1_\2').downcase.to_sym,v]
+          else
+            [k.to_sym,v]
+          end
+        end.to_h
+      end
+
       def cookies
         agent = Mechanize.new
         agent.get("https://stackexchange.com/questions?realtime")

data/lib/se/realtime/version.rb

@@ -1,5 +1,5 @@
 module SE
   module Realtime
-    VERSION = "0.0.0.beta0".freeze
+    VERSION = "0.0.0.beta1".freeze
   end
 end

data/lib/se/realtime/websocket.rb

@@ -17,6 +17,7 @@ module SE
         @driver = WebSocket::Driver.client(self)
         @socket = TCPSocket.new(@uri.host, 80)
         @handler = handler
+        @logger = Logger.new "realtime-#{DateTime.now.strftime('%Q')}.log"
 
         @driver.add_extension PermessageDeflate
         @driver.set_header "Cookies", cookies if cookies
@@ -30,7 +31,13 @@ module SE
         end
 
         @driver.on :message do |e|
-          @handler.call(JSON.parse(e.data))
+          @logger.info("Read:  #{e.data}")
+          data = JSON.parse(e.data)
+          if data["action"] == "hb"
+            send "hb"
+          else
+            @handler.call(data)
+          end
         end
 
         @driver.on :close, ->(_e) { puts "WebSocket is closed!"}
@@ -57,6 +64,8 @@ module SE
       end
 
       def send(message)
+        puts "Lub dub" if message == "hb"
+        @logger.info("Wrote: #{message}")
         @driver.text(message)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: se-realtime
 version: !ruby/object:Gem::Version
-  version: 0.0.0.beta0
+  version: 0.0.0.beta1
 platform: ruby
 authors:
 - thesecretmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-10 00:00:00.000000000 Z
+date: 2017-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler