pnut 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeeda2c2c3813e67bd8446308e0688fc7949fa15c2fabe79f36b37f96a7f9c93
-  data.tar.gz: 2e5372cdd14dde4c2282993558e4e3c7aad38ed4d71e49ebf0a3190e2c1a3872
+  metadata.gz: df8ddb8b8afd3f309b107e75077557f702b9aac158517cd27a17fa68c183fd77
+  data.tar.gz: 53baea2c228eea35f677943f635a229d320ce9bdc5c9535bbada3f8f29c28131
 SHA512:
-  metadata.gz: 4c985932c944530094910d7b143b49bbad0afe29c989ba36c66d53ea15baf7d9ddd692d761ad837c948111b561634f738e292f21dd9593497d52af32083bcee5
-  data.tar.gz: 94472f946a9caaae19758e332e0308227a28be77b42194f940c4c11081410f4fc85dd7ca53d500c032abcd0e7c307fcfbf21b579b4b1999b7678596a695190d5
+  metadata.gz: d5a7ef1a212fe9fa8d6b2aa5b8d97787b5ae0cde08fca84786926a4ea93262a1577c2a9beb39c775d620812d034817c395bdcac7d1b93eae79ac66c2f080081b
+  data.tar.gz: df5548a115f2a0219815c4e015e16dcd6ffefe586776d15ecdc8af80a092a2ea78446e529667600548d062a256b0b14a2b4fc39360fadedfc329c7c508657e53

data/Gemfile.lock

@@ -1,9 +1,11 @@
 PATH
   remote: .
   specs:
-    pnut (0.1.2)
+    pnut (0.2.0)
       addressable (~> 2.5)
+      eventmachine (~> 1.2)
       faraday
+      faye-websocket (~> 0.10)
       webmock (~> 3.4)
 
 GEM
@@ -14,8 +16,12 @@ GEM
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
+    eventmachine (1.2.7)
     faraday (0.15.2)
       multipart-post (>= 1.2, < 3)
+    faye-websocket (0.10.7)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
     hashdiff (0.3.7)
     method_source (0.9.0)
     minitest (5.11.3)
@@ -30,6 +36,9 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
 
 PLATFORMS
   ruby

data/README.md

@@ -48,7 +48,7 @@ pnut = Pnut::Client.new
 pnut.request("/posts/streams/global")
 ```
 
-For POST, DELETE, etc. request, the method signature provides the following:
+For POST, DELETE, etc. request, the method signature provides the following, with the data parameter defaulting to JSON:
 
 ```ruby
 pnut.request(
@@ -60,6 +60,48 @@ pnut.request(
 )
 ```
 
+As a more thorough example, one can request an AppStream access token (where the endpoint expects form-data instead of JSON) and get the body of the response unparsed as a string like this:
+
+```ruby
+pnut.request(
+  "/oauth/access_token",
+  json: false,
+  method: "POST",
+  raw_response: true,
+  data: {
+    client_id: "YOUR_CLIENT_ID",
+    client_secret: "YOUR_CLIENT_SECRET",
+    grant_type: "client_credentials"
+  }
+)
+```
+
+## App Streams
+
+We support a light abstraction over pnut's App Streams, standing on the shoulders of EventMachine and faye-websocket. Given you already have a valid app access token and created a stream with corresponding stream key, you can start it like this:
+
+```ruby
+require "pnut/app_stream"
+
+Pnut::AppStream.start(access_token: "…", stream_key: "…")
+```
+
+Having every stream message printed to STDOUT is not that useful in itself, therefor you can provide a custom handler to react to them yourself:
+
+```ruby
+require "pnut/app_stream"
+
+def my_handler(msg)
+  p JSON.parse(msg)
+end
+
+Pnut::AppStream.start(
+  access_token: "…",
+  stream_key: "…",
+  handler: method(my_handler)
+)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/console

@@ -2,6 +2,7 @@
 
 require "bundler/setup"
 require "pnut"
+require "pnut/app_stream"
 
 @pnut = Pnut::Client.new(authorization_token: ENV["PNUT_TOKEN"])
 

data/lib/pnut/app_stream.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require "eventmachine"
+require "faye/websocket"
+
+module Pnut
+  module AppStream
+    extend self
+
+    def start(access_token: nil, stream_key: nil, handler: method(:puts))
+      EM.run do
+        ws = Faye::WebSocket::Client.new(
+          "wss://stream.pnut.io/v0/app/stream?access_token=#{access_token}&key=#{stream_key}"
+        )
+
+        EM.add_periodic_timer 45 do
+          ws.ping "ping"
+        end
+
+        ws.on :open do |event|
+          p [:open]
+          ws.send("Hello, pnut!")
+        end
+
+        ws.on :message do |event|
+          handler.call(event.data)
+        end
+
+        ws.on :close do |event|
+          p [:close, event.code, event.reason]
+
+          ws = nil
+        end
+      end
+    end
+  end
+end

data/lib/pnut/version.rb

@@ -1,3 +1,3 @@
 module Pnut
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/pnut.gemspec

@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday"
   spec.add_dependency "webmock", "~> 3.4"
   spec.add_dependency "addressable", "~> 2.5"
+  spec.add_dependency "eventmachine", "~> 1.2"
+  spec.add_dependency "faye-websocket", "~> 0.10"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnut
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kai Wood
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2018-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +153,7 @@ files:
 - bin/console
 - bin/setup
 - lib/pnut.rb
+- lib/pnut/app_stream.rb
 - lib/pnut/posts.rb
 - lib/pnut/version.rb
 - pnut.gemspec