beeline-rb 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e249c6436484ce2d8c39b13459e8b9de1efb88328e2855f52e0f9abc34462e8f
-  data.tar.gz: ef04c49732843fa6dc5edb4abb4e6300ded0472a5e935e92e5106de39694a88f
+  metadata.gz: 3c8246a0606de7f3d8c8e1096d6460493652304ebc5b751d43b120b8e319e3d6
+  data.tar.gz: 600690db2274d7a6013e5c7b59fe31d184f7b407a90838d9bba2dbc90cb7fb5e
 SHA512:
-  metadata.gz: a63a7990d697520bb59ced2c8d71caf813bc0f1a805cebbbaa3cb22cebaf1d6fbf0f623c3b2d4aa770c3347c211860f35652aebd4388aaaa34a3bb08fc763985
-  data.tar.gz: ee3966e55f683cf1667447de4a343cfe42abae522d9ed0344d7e8c997c29a21cbb7a98cd06d807ed8e917060c0fa1a30e6340c31e7f692882bee7cf43d53bb6a
+  metadata.gz: 5dc559c796937ae9247a467f8dc5974231481b67a48024f827cfcfd8e46438f06ed4dccef3caee2fc1edc26ad780fc04277005c0ed3b153d3a781d2b8cd030b2
+  data.tar.gz: 72590503e8c7d7b45c7fd654141d3e9360c2dcbaa00c833dbb20fbbe15da5ca49e2dfb3017396ffbebd49f3dac3386ac3401fd457a99e3cde9f4427fc858eab4

data/README.md

@@ -1,7 +1,7 @@
 [beeline](https://github.com/inertia186/beeline-rb)
 =======
 
-BeeLine is a [BeeChat](https://beechat.hive-engine.com/) Client Framework for Ruby.
+BeeLine is a [BeeChat](https://beechat.hive-engine.com/) Client Framework for Ruby.  BeeChat has been designed by [@reazuliqbal](https://hive.blog/@reazuliqbal).  BeeLine provides abstraction to for ruby developers to interact through the BeeChat [API](https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md).
 
 #### Installation
 

data/beeline-rb.gemspec

@@ -33,6 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rb-readline', '~> 0.5', '= 0.5.5'
 
   spec.add_dependency 'hive-ruby', '~> 1.0', '= 1.0.0'
-  spec.add_dependency 'faye-websocket', '~> 0.11', '= 0.11.0'
+  spec.add_dependency 'faye-websocket', '~> 0.10'
   spec.add_dependency 'permessage_deflate', '~> 0.1', '= 0.1.4'
 end

data/lib/beeline/bot.rb

@@ -20,22 +20,24 @@ module Beeline
     
     def process_chat_message(payload)
       from = payload['from']
+      
+      cooldown(from)
+      
+      conversation_id = payload['conversation_id']
       content = payload['content'].to_s
       command_key = content.split(' ').first.split(prefix).last.to_sym
       reply = if commands.keys.include? command_key
         args = (content.split(' ') - ["#{prefix}#{command_key}"]).join(' ')
         args = args.empty? ? nil : args
         
-        commands[command_key][:block].call(args, from)
+        commands[command_key][:block].call(args, from, conversation_id)
       elsif (matching_messages = messages.select{|k| Regexp.new(k).match?(content)}).any?
         message = matching_messages.values.first # match in order of declaration
         
-        message[:block].call(content, from)
+        message[:block].call(content, from, conversation_id)
       end
       
       if !!reply
-        conversation_id = payload['conversation_id']
-        
         chat_message(conversation_id, from, reply)
       end
     end
@@ -45,5 +47,27 @@ module Beeline
       
       accept_pending_friend_requests
     end
+  private
+    MIN_COOLDOWN = 0.25
+    BASE_COOLDOWN = 0.1
+    MAX_COOLDOWN = 90.0
+    
+    # Exponential backoff for key.  This will apply a rate-limit for each key
+    # that depends on how often the key is used.
+    # 
+    # @private
+    def cooldown(key)
+      @cooldown ||= {}
+      @cooldown[key] ||= Time.now
+      elapsed = Time.now - @cooldown[key]
+      
+      if elapsed > MAX_COOLDOWN
+        @cooldown[key] = nil
+      else
+        interval = [BASE_COOLDOWN * elapsed, MIN_COOLDOWN].max
+        
+        sleep interval
+      end
+    end
   end
 end

data/lib/beeline/session.rb

@@ -5,6 +5,9 @@ require 'net/http'
 require 'digest/sha2'
 
 module Beeline
+  
+  # Manages the http and websockets session for the bot.  Also interacts with
+  # the http API.
   class Session
     include Config
     include Hive::Utils
@@ -40,6 +43,9 @@ module Beeline
       end
     end
     
+    # Logs in the bot.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#get-userslogin GET /users/login}
     def login
       return @beeline_session if !!@beeline_session
       
@@ -61,6 +67,9 @@ module Beeline
       end
     end
     
+    # Verifies if the current access token is valid.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#get-usersverify GET /users/verify}
     def verify
       raise "Unable to verify before logging in" unless !!@beeline_session
       
@@ -76,6 +85,9 @@ module Beeline
       end
     end
     
+    # Requests a new access token.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#get-usersrefresh-token GET /users/refresh-token}
     def refresh_token
       raise "Unable to refresh token before logging in" unless !!@beeline_session
       
@@ -95,6 +107,9 @@ module Beeline
       end
     end
     
+    # Generalized get method.
+    # 
+    # @param resource [String] Resource to get, including query parameters.
     def get(resource)
       raise "Unable to request #{resource} before logging in" unless !!@beeline_session
       
@@ -110,10 +125,28 @@ module Beeline
       end
     end
     
+    # Returns bot's friends and blocked list.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#get-usersfriends GET /users/friends}
     def friends; get('/users/friends'); end
+    
+    # Returns an array of bot's pending friend requests.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#get-usersfriend-requests GET /users/friend-requests}
     def friend_requests; get('/users/friend-requests'); end
+    
+    # Returns bot's settings.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#get-userssettings GET /users/settings}
     def settings; get('/users/settings'); end
     
+    # Updates the bot's settings.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#post-userssettings POST /users/settings}
+    # 
+    # @param new_settings [Hash]
+    # @option new_settings [Hash] :dm
+    #   * :only_from_friends (Boolean) Only allow direct messages from friends.
     def settings=(new_settings)
       raise "Unable to post settings before logging in" unless !!@beeline_session
       
@@ -131,16 +164,24 @@ module Beeline
       end
     end
     
+    # Returns an array of bot-created channels.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#get-userschannels GET /users/channels}
     def channels; get('/users/channels'); end
     
-    def channels=(new_channels)
+    # Creates a new channel.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#post-userschannels POST /users/channels}
+    # 
+    # @param name [String]
+    def channels=(name)
       raise "Unable to post channels before logging in" unless !!@beeline_session
       
       resource = "#{base_uri.path}/users/channels"
       
       http do |http|
         request = Net::HTTP::Post.new resource
-        request.body = new_channels.to_json
+        request.body = name
         request['Content-Type'] = 'application/json; charset=UTF-8'
         request['User-Agent'] = AGENT_ID
         request['Authorization'] = "Bearer #{token}"
@@ -149,10 +190,22 @@ module Beeline
         JSON[response.body]
       end
     end
-
+    
+    # Logs out the bot.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#get-userslogout GET /users/logout}
     def logout; get('/users/logout'); end
+    
+    # Returns details of a conversation.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#get-messagesconversation GET /messages/conversation}
     def conversations; get('/messages/conversations'); end
     
+    # Returns details of a conversation.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#get-messagesconversation GET /messages/conversation}
+    # 
+    # @param id [String] (or Array<String>) Conversation id or array of ids.
     def conversation(*id)
       raise "Unable to get conversation before logging in" unless !!@beeline_session
       
@@ -169,8 +222,14 @@ module Beeline
       end
     end
     
+    # Return an array of unread messages.
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#get-messagesnew GET /messages/new}
     def new_conversations; get('/messages/new'); end
     
+    # Query chat messages by id, \
+    # 
+    # See: {https://github.com/hive-engine/beechat-frontend/blob/master/DOCUMENTATION.md#get-messageschats GET /messages/chats}
     def chats(id, before = nil, limit = nil)
       raise "Unable to get conversation before logging in" unless !!@beeline_session
       
@@ -188,6 +247,8 @@ module Beeline
       end
     end
     
+    # Calls #new_conversations and dumps all messages.
+    # 
     def dump_conversations
       new_conversations.map{|c| "#{c['timestamp']} :: #{c['conversation_id']} :: #{c['from']}: #{c['content']}"}
     end

data/lib/beeline/version.rb

@@ -1,4 +1,4 @@
 module Beeline
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
   AGENT_ID = "beeline/#{VERSION}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beeline-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Anthony Martin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2020-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -314,22 +314,16 @@ dependencies:
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.11.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.11.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: permessage_deflate
   requirement: !ruby/object:Gem::Requirement