ruby-ray 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32e31e8a75b2b169c02c85493474c4760e695a4e4977dbccab922aab2c98f3d8
-  data.tar.gz: f3458605cc94471d819bebb06e0b9a89a0508ee7191951ca4f648b1c722f686b
+  metadata.gz: 3fa98312ac698f1368bcdba806e12551eefde2b21f1a4bfcf817c08e73b42628
+  data.tar.gz: f8b61fe51c4ed5aa22ec12be7b28cd9bf6be9ad4e367c49e12b343969e53a41d
 SHA512:
-  metadata.gz: 0c0ccef669e62bdc8500f4d4476c60d8672b5de19a17e22830877d86675ee549e153aa1f7488be98ec414e7695029f7e1d4f19713669104b5f8cd08af5159d19
-  data.tar.gz: 4c4096120a9b00e6e5efafdad103ebbb5567c9f55ba5d93b4f5e4eca59e0155f111b4f12eceb56cffb029ad62785a9838f7c41f3120305c3ab5186b13da67041
+  metadata.gz: c3d87dd7beea1015e61a589089195749b812e7197fe1333c934682afa581140d23a0bde99853ef0ac9a40ce99b68d2452436158438e347a4e7775a162c6759ed
+  data.tar.gz: '048da58bfdf3d105083cb9e7feb532ee37e29ac3f2ab94f5b670950a4b0eb35e1b827f8eec0ef2378d31f410f1bd3dfe78c41cc14662a1200fffcdac65281627'

data/.github/SECURITY.md

@@ -0,0 +1,3 @@
+# Security Policy
+
+If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

data/.github/workflows/main.yml

@@ -5,14 +5,17 @@ on: [push,pull_request]
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.7', '3.0']
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.0
-    - name: Run the default task
+        ruby-version: ${{ matrix.ruby }}
+        bundler: default
+        bundler-cache: true
+    - name: Run tests
       run: |
-        gem install bundler -v 2.2.8
-        bundle install
         bundle exec rake

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## [Unreleased]
+## [0.2.0] - 2021-02-11
+
+- Relax activesupport dependency
+- Test against Ruby 2.7 and 3.0 in CI
+- Add more payloads
 
 ## [0.1.0] - 2021-02-10
 

data/README.md

@@ -1,43 +1,39 @@
-# Ray
+# Debug with Ray to fix problems faster
 
-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/ray`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem can be installed in any Ruby application to send messages to [the Ray app](https://myray.app).
 
-TODO: Delete this and the text above, and describe your gem
+## Documentation
 
-## Installation
+You can find the full documentation on [our documentation site](https://spatie.be/docs/ray).
 
-Add this line to your application's Gemfile:
+## Changelog
 
-```ruby
-gem 'ray'
-```
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
-And then execute:
+## Contributing
 
-    $ bundle install
+Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
 
-Or install it yourself as:
+## Contributing
 
-    $ gem install ray
+Bug reports and pull requests are welcome on GitHub at https://github.com/spatie/ray. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/spatie/ray/blob/master/CODE_OF_CONDUCT.md).
 
-## Usage
+## Contributing
 
-TODO: Write usage instructions here
+Please see [CODE_OF_CONDUCT](.github/CODE_OF_CONDUCT.md) for details.
 
-## Development
+## Security Vulnerabilities
 
-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.
+Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Credits
 
-## Contributing
+- [Chris Oliver](https://github.com/excid3)
+- [Freek Van der Herten](https://github.com/freekmurze)
+- [All Contributors](../../contributors)
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ray. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ray/blob/master/CODE_OF_CONDUCT.md).
+A big thank you to Chris Oliver for teaching us the basics of Ruby development. You can see the initial development of this package [in this video](https://freek.dev/1904-creating-a-ruby-gem-for-ray).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Ray project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ray/blob/master/CODE_OF_CONDUCT.md).
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

data/examples/colors.rb

@@ -0,0 +1,12 @@
+require_relative "../lib/ray"
+
+# ray.new_screen('Colors')
+
+ray('this is green').green
+ray('this is orange').orange
+ray('this is red').red
+ray('this is purple').purple
+ray('this is blue').blue
+ray('this is gray').gray
+
+

data/examples/custom.rb

@@ -0,0 +1,5 @@
+require_relative "../lib/ray"
+
+ray.new_screen('Custom')
+
+ray.send_custom('my value', 'my label')

data/examples/general.rb

@@ -0,0 +1,10 @@
+require_relative "../lib/ray"
+
+ray.new_screen('General')
+
+ray(nil)
+ray(1234)
+ray(true)
+ray(false)
+
+ray('multiple', 'in', 1, 'go')

data/examples/newScreen.rb

@@ -0,0 +1,9 @@
+require_relative "../lib/ray"
+
+ray.new_screen('New screen')
+
+ray('will clear in two seconds')
+
+sleep(2)
+
+ray.new_screen('this is the new screen')

data/examples/notify.rb

@@ -0,0 +1,5 @@
+require_relative "../lib/ray"
+
+ray.new_screen('Notify')
+
+ray.notify('This is a notification')

data/examples/pause.rb

@@ -0,0 +1,7 @@
+require_relative "../lib/ray"
+
+ray.new_screen('Pause')
+
+ray.pause
+
+ray('After the pause')

data/examples/visibility.rb

@@ -0,0 +1,21 @@
+require_relative "../lib/ray"
+
+ray.new_screen('Visibility')
+
+ray('collapsed by default').hide
+
+ray = ray('updating this message in two seconds')
+sleep(2)
+ray.send('updated message');
+
+ray = ray('removing this item in two seconds')
+sleep(2)
+ray.remove
+
+sleep(1)
+ray('hiding the app window for two seconds...')
+sleep(1)
+ray.hide_app
+sleep(2)
+ray.show_app
+ray('Hi again!')

data/lib/ray.rb

@@ -5,37 +5,145 @@ require "active_support/all"
 
 require_relative "ray/version"
 require_relative "ray/request"
+require_relative "ray/client"
 require_relative "ray/payload_factory"
 require_relative "ray/payloads/payload"
 require_relative "ray/payloads/bool_payload"
+require_relative "ray/payloads/color_payload"
 require_relative "ray/payloads/int_payload"
 require_relative "ray/payloads/null_payload"
 require_relative "ray/payloads/string_payload"
+require_relative "ray/payloads/new_screen_payload"
+require_relative "ray/payloads/hide_payload"
+require_relative "ray/payloads/hide_app_payload"
+require_relative "ray/payloads/remove_payload"
+require_relative "ray/payloads/show_app_payload"
+require_relative "ray/payloads/custom_payload"
+require_relative "ray/payloads/notify_payload"
+require_relative "ray/payloads/create_lock_payload"
 
 module Ray
-  mattr_accessor :settings
-  @@settings = { host: "http://localhost", port: 23517 }
-
   class Ray
-    attr_reader :settings
+    def initialize(settings, client = nil)
+      @uuid = SecureRandom.uuid
+      @client = client || Client.new(settings[:port], settings[:host])
+    end
+
+    def green
+      color 'green'
+    end
+
+    def orange
+      color 'orange'
+    end
+
+    def red
+      color 'red'
+    end
+
+    def purple
+      color 'purple'
+    end
+
+    def blue
+      color 'blue'
+    end
+
+    def gray
+      color 'gray'
+    end
+
+    def new_screen(name = '')
+      payload = Payloads::NewScreenPayload.new(name)
+
+      send_request payload
+    end
+
+    def clear_screen
+      self.new_screen
+    end
+
+    def notify(text)
+      payload = Payloads::NotifyPayload.new(text)
+
+      send_request payload
+    end
+
+    def hide
+      payload = Payloads::HidePayload.new
+
+      send_request payload
+    end
+
+    def remove
+      payload = Payloads::RemovePayload.new
+
+      send_request payload
+    end
+
+    def hide_app
+      payload = Payloads::HideAppPayload.new
+
+      send_request payload
+    end
+
+    def show_app
+      payload = Payloads::ShowAppPayload.new
+
+      send_request payload
+    end
+
+    def color(color)
+      payload = Payloads::ColorPayload.new(color)
+
+      send_request payload
+    end
+
+    def pause
+      lockName = rand(10 ** 12).to_s
+
+      payload = Payloads::CreateLockPayload.new(lockName)
+
+      send_request payload
+
+      loop do
+        sleep(1)
+        if (!@client.lock_exists lockName)
+          break
+        end
+      end
+
+      return self
+    end
 
-    class Error < StandardError; end
-    # Your code goes here...
+    def send_custom(content, label = '')
+      payload = Payloads::CustomPayload.new(content, label)
 
-    def initialize(settings)
-      @settings = settings
+      send_request payload
     end
 
-    def send(args)
+    def send(*args)
       send_request PayloadFactory.create_for_values(args)
     end
 
     def send_request(payloads)
-      Request.new(payloads, settings).send
+      payloads = Array(payloads)
+
+      meta = {
+        ruby_ray_version: 'ray version here'
+      }
+
+      request = Request.new(@uuid, payloads, meta)
+
+      @client.send(request)
+
+      return self
     end
   end
 end
 
 def ray(*args)
-  Ray::Ray.new(Ray.settings).send(args)
+  settings = { host: 'http://localhost', port: 23517 }
+
+  Ray::Ray.new(settings).send(*args)
 end

data/lib/ray/client.rb

@@ -0,0 +1,48 @@
+require_relative "errors/stop_execution_requested"
+
+
+module Ray
+  class Client
+    def initialize(port = 23517, host = 'localhost')
+      @port = port
+      @host = host
+    end
+
+    def send(request)
+      req = Net::HTTP::Post.new(uri, { 'Content-Type' => 'application/json' })
+      req.body = request.to_json
+
+      begin
+        Net::HTTP.start(uri.hostname, uri.port) do |http|
+          http.request(req)
+        end
+      rescue StandardError
+        # Ignore any errors
+      end
+    end
+
+    def lock_exists(lockName)
+      req = Net::HTTP::Get.new("/locks/#{lockName}", { 'Content-Type' => 'application/json' })
+
+      begin
+        response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+          http.request(req)
+        end
+      rescue StandardError
+        return false
+      end
+
+      result = JSON.parse(response.body)
+
+      if (result['stop_execution'])
+        raise new StopExecutionRequested
+      end
+
+      return result['active'] || false
+    end
+
+    def uri
+      @uri ||= URI("#{@host}:#{@port}")
+    end
+  end
+end

data/lib/ray/errors/stop_execution_requested.rb

@@ -0,0 +1,9 @@
+module Ray
+  module Payloads
+    class StopExecutionRequested < StandardError
+      def initialize
+        super("This error is raised because you requested to stop the execution in Ray.")
+      end
+    end
+  end
+end

data/lib/ray/payloads/bool_payload.rb

@@ -3,17 +3,17 @@ module Ray
     class BoolPayload < Payload
 
       def initialize(bool)
-        @bool = bool
+        @name = bool
       end
 
       def type
-        "custom"
+        'custom'
       end
 
       def content
         {
-          content: @bool,
-          label: "Boolean"
+          content: @name,
+          label: 'Boolean'
         }
       end
 

data/lib/ray/payloads/color_payload.rb

@@ -0,0 +1,21 @@
+module Ray
+  module Payloads
+    class ColorPayload < Payload
+
+      def initialize(color)
+        @color = color
+      end
+
+      def type
+        'color'
+      end
+
+      def content
+        {
+          color: @color,
+        }
+      end
+
+    end
+  end
+end

data/lib/ray/payloads/create_lock_payload.rb

@@ -0,0 +1,21 @@
+module Ray
+  module Payloads
+    class CreateLockPayload < Payload
+
+      def initialize(name)
+        @name = name
+      end
+
+      def type
+        'create_lock'
+      end
+
+      def content
+        {
+          name: @name,
+        }
+      end
+
+    end
+  end
+end

data/lib/ray/payloads/custom_payload.rb

@@ -0,0 +1,22 @@
+module Ray
+  module Payloads
+    class CustomPayload < Payload
+
+      def initialize(content, label = '')
+        @content = content
+        @label = label
+      end
+
+      def type
+        'custom'
+      end
+
+      def content
+        {
+          content: @content,
+          label: @label
+        }
+      end
+    end
+  end
+end

data/lib/ray/payloads/hide_app_payload.rb

@@ -0,0 +1,9 @@
+module Ray
+  module Payloads
+    class HideAppPayload < Payload
+      def type
+        'hide_app'
+      end
+    end
+  end
+end

data/lib/ray/payloads/hide_payload.rb

@@ -0,0 +1,9 @@
+module Ray
+  module Payloads
+    class HidePayload < Payload
+      def type
+        'hide'
+      end
+    end
+  end
+end

data/lib/ray/payloads/int_payload.rb

@@ -7,13 +7,13 @@ module Ray
       end
 
       def type
-        "custom"
+        'custom'
       end
 
       def content
         {
           content: @int,
-          label: "Integer"
+          label: 'Integer'
         }
       end
 

data/lib/ray/payloads/new_screen_payload.rb

@@ -0,0 +1,21 @@
+module Ray
+  module Payloads
+    class NewScreenPayload < Payload
+
+      def initialize(screenName)
+        @screenName = screenName
+      end
+
+      def type
+        'new_screen'
+      end
+
+      def content
+        {
+          name: @screenName,
+        }
+      end
+
+    end
+  end
+end

data/lib/ray/payloads/notify_payload.rb

@@ -0,0 +1,19 @@
+module Ray
+  module Payloads
+    class NotifyPayload < Payload
+      def initialize(text)
+        @text = text
+      end
+
+      def type
+        'notify'
+      end
+
+      def content
+        {
+          value: @text,
+        }
+      end
+    end
+  end
+end

data/lib/ray/payloads/null_payload.rb

@@ -3,13 +3,13 @@ module Ray
     class NullPayload < Payload
 
       def type
-        "custom"
+        'custom'
       end
 
       def content
         {
           content: nil,
-          label: "Integer"
+          label: 'Integer'
         }
       end
 

data/lib/ray/payloads/payload.rb

@@ -2,15 +2,15 @@ module Ray
   module Payloads
     class Payload
 
-      def initialize(value)
+      def initialize(*args)
       end
 
       def type
-        raise NotImplementedError, "You must define the `type` method in your Payload"
+        raise NotImplementedError, 'You must define the `type` method in your Payload'
       end
 
       def content
-        raise NotImplementedError, "You must define the `content` method in your Payload"
+        {}
       end
 
     end

data/lib/ray/payloads/remove_payload.rb

@@ -0,0 +1,9 @@
+module Ray
+  module Payloads
+    class RemovePayload < Payload
+      def type
+        'remove'
+      end
+    end
+  end
+end

data/lib/ray/payloads/show_app_payload.rb

@@ -0,0 +1,9 @@
+module Ray
+  module Payloads
+    class ShowAppPayload < Payload
+      def type
+        'show_app'
+      end
+    end
+  end
+end

data/lib/ray/payloads/string_payload.rb

@@ -7,13 +7,13 @@ module Ray
       end
 
       def type
-        "custom"
+        'custom'
       end
 
       def content
         {
           content: @str,
-          label: "String"
+          label: 'String'
         }
       end
 

data/lib/ray/request.rb

@@ -1,34 +1,23 @@
 module Ray
   class Request
-    attr_reader :payloads, :settings
-
-    def initialize(payloads, settings)
+    def initialize(uuid, payloads, meta = {})
+      @uuid = uuid
       @payloads = payloads
-      @settings = settings
-    end
-
-    def send
-      req = Net::HTTP::Post.new(uri, {'Content-Type' => 'application/json'})
-      req.body = { uuid: SecureRandom.uuid, payloads: payloads_content, meta: {} }.to_json
-      res = Net::HTTP.start(uri.hostname, uri.port) do |http|
-        http.request(req)
-      end
-    #rescue StandardError
-      # Ignore any errors
+      @meta = meta
     end
 
-    def uri
-      @uri ||= URI("#{settings[:host]}:#{settings[:port]}")
+    def to_json
+      {uuid:@uuid, payloads:payload_contents, meta: @meta}.to_json
     end
 
-    def payloads_content
-      payloads.map do |payload|
+    def payload_contents
+      return @payloads.map do |payload|
         {
           type: payload.type,
           content: payload.content,
           origin: {
             file: "the file",
-            line_number: "123"
+            line_number: "123",
           },
         }
       end

data/lib/ray/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ray
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/ray.gemspec

@@ -5,8 +5,8 @@ require_relative "lib/ray/version"
 Gem::Specification.new do |spec|
   spec.name          = "ruby-ray"
   spec.version       = Ray::VERSION
-  spec.authors       = ["Chris Oliver"]
-  spec.email         = ["excid3@gmail.com"]
+  spec.authors       = ["Freek Van der Herten", "Chris Oliver"]
+  spec.email         = ["freek@spatie.be"]
 
   spec.summary       = "Debug with Ray to fix problems faster"
   spec.homepage      = "https://myray.app"
@@ -29,8 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "active_support", "~> 6.1"
-
+  spec.add_dependency "activesupport", ">= 4.2"
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
 end

metadata

@@ -1,36 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: ruby-ray
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
+- Freek Van der Herten
 - Chris Oliver
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: active_support
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '4.2'
 description:
 email:
-- excid3@gmail.com
+- freek@spatie.be
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/SECURITY.md"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - CHANGELOG.md
@@ -41,13 +43,30 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- example.rb
+- examples/colors.rb
+- examples/custom.rb
+- examples/general.rb
+- examples/newScreen.rb
+- examples/notify.rb
+- examples/pause.rb
+- examples/visibility.rb
 - lib/ray.rb
+- lib/ray/client.rb
+- lib/ray/errors/stop_execution_requested.rb
 - lib/ray/payload_factory.rb
 - lib/ray/payloads/bool_payload.rb
+- lib/ray/payloads/color_payload.rb
+- lib/ray/payloads/create_lock_payload.rb
+- lib/ray/payloads/custom_payload.rb
+- lib/ray/payloads/hide_app_payload.rb
+- lib/ray/payloads/hide_payload.rb
 - lib/ray/payloads/int_payload.rb
+- lib/ray/payloads/new_screen_payload.rb
+- lib/ray/payloads/notify_payload.rb
 - lib/ray/payloads/null_payload.rb
 - lib/ray/payloads/payload.rb
+- lib/ray/payloads/remove_payload.rb
+- lib/ray/payloads/show_app_payload.rb
 - lib/ray/payloads/string_payload.rb
 - lib/ray/request.rb
 - lib/ray/version.rb

data/example.rb

@@ -1,7 +0,0 @@
-require_relative "lib/ray"
-
-ray("hello world")
-ray(nil)
-ray(1234)
-ray(true)
-ray(false)