buttplugrb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c5d05ba327fa3c5eec041b8115fde4dbfd7ff0b
+  data.tar.gz: be8dec539e6079430e47ed6f0514ea74c65b13ed
+SHA512:
+  metadata.gz: 986d6327dcb9614b469715eabb5216db660c6f71cf4e2d4afa990465d47ac241d72b72ce74da2fe3ffcb995bcda5b5e5a36b1e0f635bf938e398128f075ff6b2
+  data.tar.gz: f19225ad6ac973613fa066b08ff4860b08c79a8c75999fc786f2227c6006539b842e9111f6ad1971d0c2c08e9dfc1a18fd635577b8011b33790825d58e74660d

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,72 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at eva@rigel.moe. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -0,0 +1,34 @@
+# Buttplugrb - Shove Ruby up your ass!
+
+Welp ... You have wandered into probably one of the silliest things I set up ... This is a gem to make your ruby app act as a client for a buttplug.io server ... 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'buttplugrb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install buttplugrb
+
+## Usage
+
+You can get client up and running like this:
+
+```ruby
+require "buttplugrb"
+client=Buttplug::Client.new("wss://localhost:12345/buttplug")
+``` 
+
+You can view some additional examples in the Examples Folder!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/examples/Vibrate.rb

@@ -0,0 +1,56 @@
+require "buttplugrb"
+LOCATION="wss://localhost:12345/buttplug"           #where our server is located, more than likely going to be on localhost:12345/buttplug
+def pattern1(controller)
+    controller.vibrateAll(0.25)
+    sleep (3)
+    controller.vibrateAll(1)
+    sleep (1)  
+    controller.vibrateAll(0.3)
+    sleep 2
+    controller.vibrateAll 1
+    sleep 2
+    controller.vibrateAll 0.6
+    sleep 5
+    controller.vibrateAll 0.5
+    sleep 0.5
+    controller.vibrateAll 1
+    sleep 20
+end
+def pulsePattern(controller)
+    controller.vibrateAll(0)
+    sleep 0.5
+    controller.vibrateAll(1)
+    sleep 0.5
+end
+def lickPattern(controller)
+    controller.vibrateAll 0
+    sleep 0.25
+    controller.vibrateAll 0.5
+    sleep 0.25
+end
+def randomPattern(controller)
+    controller.vibrateAll(rand(0.0..1.0))   #Set our vibration somewhere in the range of valid numbers
+    sleep(rand(5..60))                     #and sleep for a random period of time
+end
+client=Buttplug::Client.new(LOCATION)               #initalizing our client 
+sleep 0.1                                           #Giving our client a moment to wake up
+client.startScanning();                             #Telling the server to start scanning for new devices, ble or otherwise
+sleep 1                                             #Giving it a moment to find our device
+devices=[]
+while devices==[] do 
+  devices=client.listDevices()                        #Grabing our device list
+  sleep 1
+end
+client.stopScanning()                               #No sense in tying up the server ... not just yet~
+controller=Buttplug::Device.new(client,devices[0])  #and generating a new device from the first client on the list
+#ok we are gonna make a few assumptions here ... primarily that you are using an xbox controller
+if(controller.methods.include? :vibrateAll)         #Ok due to metaprogramming bs we have to check to see if the device in question supports vibration
+  (0..20000).each{|i|
+    (0..5).each{|j|
+    lickPattern(controller)
+    }
+    controller.vibrateAll 1
+    sleep 10
+  }
+  controller.vibrateAll(0.0)                #and shutting off the lights~
+end

data/lib/buttplugrb.rb

@@ -0,0 +1,312 @@
+require 'faye/websocket'
+require 'eventmachine'
+require 'json'
+
+=begin rdoc
+Our Module for containg the functions and classes relating to the Buttplugrb gem
+=end
+module Buttplug
+=begin rdoc
+Our Client for a buttplug.io server
+=end
+  class Client
+=begin rdoc
+Creates a new client for buttplug.io
+
+Arguments:
+* serverLocation (string) - Where our buttplug.io server is hosted. this will tend to be: <code>"wss://localhost:12345/buttplug"</code>
+
+Returns:
+* A shiney new buttplug client ready for some action
+=end
+    def initialize(serverLocation)
+      @location=serverLocation
+      #Ok Explanation time!
+      # * @EventQueue - The events we are triggering on the server, Expected to be an array, with the first element being the message Id, and the second being the message itself!
+      @eventQueue=EM::Queue.new
+      @eventMachine=Thread.new{EM.run{
+        eventQueue=@eventQueue 
+        messageWatch={}
+        ws = Faye::WebSocket::Client.new(@location)
+        tickLoop=EM.tick_loop do #Should improve response times~
+          eventQueue.pop{|msg|
+            ws.send msg[1]
+            messageWatch[msg[0]]=msg
+            p [Time.now, :message_send, msg[1]] 
+          }
+        end
+        ws.on :open do |event|
+          p [Time.now, :open]
+          ws.send '[{"RequestServerInfo": {"Id": 1, "ClientName": "roboMegumin", "MessageVersion": 1}}]'
+        end
+        ws.on :message do |event|
+          message=JSON::parse(event.data)[0]
+          message.each{|key,value|
+            #We don't really care about the key just yet ... We are going to just care about finding our ID
+            if(messageWatch.keys.include?(value["Id"]))
+              messageWatch[value["Id"]]<<{key => value}#And now we care about our key!
+              puts messageWatch[value["Id"]].object_id
+              messageWatch.delete(value["Id"])
+              p [Time.now, :message_recieved, [{key => value}]]
+              next
+            elsif(key=="ServerInfo")
+              p [Time.now, :server_info, value]
+            end
+          }
+        end
+        ws.on :close do |event|
+          p [Time.now, :close, event.code, event.reason]
+          ws = nil
+        end
+        EM.add_periodic_timer(0.5){
+          ws.send "[{\"Ping\": {\"Id\": #{generateID()}}}]"
+        }
+      }}
+      @eventMachine.run
+    end
+=begin rdoc
+Tells our server to start scanning for new devices
+=end
+    def startScanning()
+      id=generateID()
+      @eventQueue.push([id,"[{\"StartScanning\":{\"Id\":#{id}}}]"])
+    end
+=begin rdoc
+Tells our server to stop scanning for new devices
+=end
+    def stopScanning()
+      id=generateID()
+      @eventQueue.push([id,"[{\"StopScanning\":{\"Id\":#{id}}}]"])
+    end
+=begin rdoc
+Lists all devices available to the server
+
+Returns:
+* An array of available devices from the server
+
+Example:
+    client.listDevices()
+       [{"DeviceName"=>"XBox Compatible Gamepad (XInput)", "DeviceIndex"=>1, "DeviceMessages"=>{"SingleMotorVibrateCmd"=>{}, "VibrateCmd"=>{"FeatureCount"=>2}, "StopDeviceCmd"=>{}}}]
+=end  
+    def listDevices()
+      id=generateID()
+      deviceRequest=[id,"[{\"RequestDeviceList\": {\"Id\":#{id}}}]"]
+      @eventQueue.push(deviceRequest)
+      while(deviceRequest.length<3) do
+        sleep 0.01#Just so we arn't occupying all the time on the system while we are waiting for our device list to come back.
+      end
+      return deviceRequest[2]["DeviceList"]["Devices"]
+    end
+=begin rdoc
+Stops all devices currently controlled by the server
+=end
+    def stopAllDevices()
+      id=generateID()
+      deviceRequest=[id,"[{\"StopAllDevices\": {\"ID\":#{id}}}]"]
+      @eventQueue.push(deviceRequest)
+    end
+=begin rdoc
+Sends a message to our buttplug server
+
+Arguments:
+* message (JSON formatted string) - The message we are sending to our server
+
+Returns:
+* the Response from our server 
+=end
+    def sendMessage(message)
+      @eventQueue.push(message)
+      while(message.length<3) do
+        sleep 0.01
+      end
+      return message[3]
+    end
+=begin rdoc
+Does exactly what it says on the tin, generates a random id for our messages
+
+Returns:
+* a number between 2 and 4294967295
+=end
+    def generateID()
+      return rand(2..4294967295)
+    end
+  end
+=begin rdoc
+This class creates a Wrapper for your various devices you fetched from listDevices for your controlling pleasure!
+=end
+  class Device
+=begin rdoc
+Creates our Device wrapper for our client
+
+Note: This does create a few functions on the fly. you should check to see if they are available using  .methods.include
+
+Arguments:
+* client (Buttplug::Client) - Our buttplugrb client that we are gonna use to control our device
+* deviceInfo (Hash) - Our information that we should have fetched from the list_devices() instance method ... should look like:
+     {"DeviceName"=>"XBox Compatible Gamepad (XInput)", "DeviceIndex"=>1, "DeviceMessages"=>{"SingleMotorVibrateCmd"=>{}, "VibrateCmd"=>{"FeatureCount"=>2}, "StopDeviceCmd"=>{}}}
+
+Returns:
+* Our nicely bundled up device ready to be domminated~
+=end
+    def initialize(client, deviceInfo)
+      #Ok we are gonna expect our deviceInfo to be a Hash so we can do some ... fun things ...
+      #{"DeviceName"=>"XBox Compatible Gamepad (XInput)", "DeviceIndex"=>1, "DeviceMessages"=>{"SingleMotorVibrateCmd"=>{}, "VibrateCmd"=>{"FeatureCount"=>2}
+      @deviceName=deviceInfo["DeviceName"]
+      @deviceIndex=deviceInfo["DeviceIndex"]
+      @client=client
+      #Ok so we are starting our weird metaProgramming BS here
+
+      if(deviceInfo["DeviceMessages"].keys.include? "VibrateCmd")
+        @vibeMotors=deviceInfo["DeviceMessages"]["VibrateCmd"]["FeatureCount"]
+        define_singleton_method(:vibrate){|speeds|
+          #And now the real fun, we are gonna craft our message!
+          id=client.generateID()
+          cmd=[{"VibrateCmd"=>{"Id"=>id,"DeviceIndex"=>@deviceIndex,"Speeds"=>[]}}]
+          #Ok we arn't gonna really care about how many speeds we are fed in here, we are gonna make sure that our total array isn't empty.
+          (0..@vibeMotors-1).each{|i|
+            if speeds[i].nil?
+              speeds[i]=0
+            end 
+            cmd[0]["VibrateCmd"]["Speeds"]<<{"Index"=>i,"Speed"=>speeds[i]}
+          }
+          client.sendMessage([id,cmd.to_json])
+        }
+        generateActivateAllCommand(:vibrate,@vibeMotors,:vibrateAll)
+      end
+      if(deviceInfo["DeviceMessages"].keys.include? "LinearCmd")
+        @linearActuators=deviceInfo["DeviceMessages"]["LinearCmd"]["FeatureCount"]
+        generateArrayedHashCommand({"Duration"=>0, "Position"=>0.0},@linearActuators,"LinearCmd","Vectors",:stroke)
+        generateActivateAllCommand(:stroke,@linearActuators,:strokeAll)
+      end
+      if(deviceInfo["DeviceMessages"].keys.include? "RotateCmd")
+        @rotationMotors=deviceInfo["DeviceMessages"]["RotateCmd"]["FeatureCount"]
+        generateArrayedHashCommand({"Speed"=>0.0,"Clockwise"=>true},@rotationMotors,"RotateCmd","Rotations",:rotate)
+        generateActivateAllCommand(:rotate,@rotationMotors,:rotateAll)
+      end
+      if(deviceInfo["DeviceMessages"].keys.include? "RawCmd")
+      #TODO: Do some stuff here with RawCmd? ... Honestly I don't know what devices would support this ... possibly estim but at the moment 🤷 I have no idea. 🤷 
+      #To implement: https://metafetish.github.io/buttplug/generic.html#rawcmd
+      end
+    end
+=begin rdoc
+Stops the Device from any current actions that it might be taking. 
+=end
+    def stopDevice
+      id=@client.generateID()
+      cmd="[{\"StopDeviceCmd\": {\"ID\":#{id},\"DeviceIndex\":#{@deviceIndex}}}]"
+      @client.sendMessage([id,cmd])
+    end
+##
+# :method: vibrate
+#
+# Vibrates the motors on the device! (⁄ ⁄•⁄ω⁄•⁄ ⁄)
+#
+# Arguments:
+# * speeds (Array - Float) - Array of speeds, any extra speeds will be dropped, and any ommitted speeds will be set to 0
+#
+# example:
+#       device.vibrate([0.2,0.3,1])
+
+##
+# :method: vibrateAll
+#
+# Vibrates all motors on the device (⁄ ⁄>⁄ ▽ ⁄<⁄ ⁄)
+#
+# Arguments:
+# * speed (Float) - The speed that all motors on the device to be set to
+#
+# example:
+#       device.vibrateAll(0.2)
+
+##
+# :method: stroke
+# Sends a command to well ... Actuate the linear motors of the device („ಡωಡ„)
+#
+# Arguments:
+# * vectors (Array - Hash) - Array of Vectors, any extra will be dropped, and any ommited will be set to a duration of 0 and a posision of 0.0.
+#
+# example:
+#       device.stroke([{"Duration"=>300, "Position"=>0.2},{"Duration"=>1000, "Position"=>0.8}])
+
+##
+# :method: strokeAll
+#
+# Sends a command to all linear actuators to respond to a vector (ง ื▿ ื)ว
+#
+# Arguments:
+# * vector (Hash) - A single vector. 
+# 
+# example: 
+#       device.strokeAll({"Duration"=>300, "Position"=>0.2})
+
+##
+# :method: rotate
+# Spins whatever feature rotates right round ... baby right round~ (ノ*°▽°*)
+#
+# Arguments:
+# * rotations (Array - Hash) - Array of Vectors, any extra will be dropped, and any ommited will be set to a duration of 0 and a posision of 0.0.
+#
+# example:
+#       device.rotate([{"Speed"=>0.5,"Clockwise"=>true},{"Speed=>1, "Clockwise"=>false}])
+
+##
+# :method: rotateAll
+# Spins All the features Right round like a record, baby Right round round round (*ﾉωﾉ)
+#
+# Arguments:
+# * rotation (Hash) - Our single rotation we are sending to all the features
+#
+# example:
+#       device.rotateAll({"Speed"=>0.5,"Clockwise"=>true})
+
+##
+#
+    protected
+=begin rdoc
+Helper Function to generate Metaprogrammed Methods for various buttplug stuff
+
+Arguments:
+* blankHash (Hash) - An example of a Nilled out hash so the newly minted function knows what 0 looks like
+* featureCount (Int) - How many features are we talking about here? I've heard rumors of a dildo with 10 vibrators~ 
+* controlName (String) - And what command are we exactly sending to our server? 
+# arrayName (String) - What Buttplug.io is expecting the array to be called
+* cmdName (Method) - Annnnd what are we gonna call our newly minted method?
+
+example:
+     generateArrayedHashCommand({"Speed"=>0.0,"Clockwise"=>true},@rotationMotors,"RotateCmd",:rotate)  
+=end
+    def generateArrayedHashCommand(blankHash, featureCount, controlName, arrayName ,cmdName) #AKA I have a feeling that if we get a dedicated function for estim boxes I feel like I'd have to rewrite this code again... so let's dry it the fuck up!
+      define_singleton_method(cmdName){|hash|
+        id=@client.generateID()
+        cmd=[{controlName=>{"Id"=>id,"DeviceIndex"=>@deviceIndex,arrayName=>[]}}]
+        (0..featureCount-1).each{|i|
+          if hash[i].nil?
+            hash[i]=blankHash
+          end
+          hash[i]["Index"]=i
+          cmd[0][controlName][arrayName]<<hash[i]
+        }
+        @client.sendMessage([id,cmd.to_json])
+      }
+    end
+=begin rdoc
+Helper Function to generate Metaprogrammed methods to set all instances of a feature to the same value
+
+Arguments:
+* cmdToAll (Method) - The command we are gonna call when we want to send our DO ALL THE THINGS signal
+* featureCount (Int) - How many features are we controlling?
+* cmdName (Method) - Annnnd what are we gonna call our newly minted command?
+=end
+    def generateActivateAllCommand(cmdToAll, featureCount, cmdName)
+      define_singleton_method(cmdName){|var|
+        vars=[]
+        (0..featureCount-1).each{|i|
+          vars<<var
+        }
+        self.public_send(cmdToAll, vars)
+      }
+    end
+  end
+end
+#And loading in any other things that might help (including debug ...)
+Dir["#{File.dirname(__FILE__)}/buttplugrb/*.rb"].each {|file| require file }

data/lib/buttplugrb/VERSION

@@ -0,0 +1,3 @@
+module Buttplug
+    VERSION="1.0.0"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: buttplugrb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nora Maguire
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.7
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: 
+email: eva@rigel.moe
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- README.md
+- Rakefile
+- examples/Vibrate.rb
+- lib/buttplugrb.rb
+- lib/buttplugrb/VERSION
+homepage: http://rubygems.org/gems/buttplugrb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- bin
+- examples
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Buttplug Client Library
+test_files: []