jaguar 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e294a1b3d67966f240fd926099649caa808d90f3de5928875066588421641a1b
-  data.tar.gz: 8c2e055452e77b1cebaacb892a6bf5c3c83eef1ff5d41046f5d391f90a6799e5
+  metadata.gz: e1a3277e51f9c13b9ea0a9c211538fe0421ea29a43c274fd190251e322647793
+  data.tar.gz: 87f4b67695bfd3b4b59b68b7d9ad29416d2b0e7ec0393f535a25bd126bdbada6
 SHA512:
-  metadata.gz: 57eadd9107c6e04303e082a5bb7b86c4c8302f17c022063ad7f8181f77d5d95d5c689af3074ea8399f75d60338b8173dfb9417e0ebb25f7ea3afa260d4f33346
-  data.tar.gz: fd5f6fe3a95412d58b53a7acc2ba0d780122a90fea74f711e77d558042effee0b34dd737548543403d7301e252dbe169b9590d0fd7b1a2343a9e7162088bd419
+  metadata.gz: db2b7295bada2ed2e1725c59d7f041e876fd04b96675a847e0ce0163f15e01765be4bdfa1b239f5d8eeca6e86da253e47de1685a1326a9fba160106b40850537
+  data.tar.gz: 840e816d31d623dbf19e13daab534f119a4b65fb38e9461d14fbee8992a6c4897a5a388b17ecda33eaf3177a47b4d86ed50b901b83df1a5b1b3bf8e8ba9f5507

data/.ruby-gemset

@@ -0,0 +1 @@
+jaguar

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/Gemfile

@@ -4,3 +4,7 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in jaguar.gemspec
 gemspec
+
+unless ENV['JAGUAR_USE_RUBYGEMS'] == "yes"
+  gem "delirium", path: "../delirium"
+end

data/Gemfile.lock

@@ -1,12 +1,25 @@
+PATH
+  remote: ../delirium
+  specs:
+    delirium (0.2.0)
+
 PATH
   remote: .
   specs:
-    jaguar (0.1.0)
+    jaguar (0.1.1)
+      contracts
+      pry
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.2)
+    contracts (0.16.0)
     diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -26,7 +39,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 1.16)
+  delirium!
   jaguar!
   rake (~> 10.0)
   rspec (~> 3.0)

data/e2e/main.rb

@@ -0,0 +1,14 @@
+require "jaguar/dsl"
+include Jaguar::DSL
+
+did_receive_ctrl_c = false
+
+Signal.trap("INT") {
+  puts "
+ctrl+c received!"
+  did_receive_ctrl_c = true
+}
+
+Mouse.move(10,10)
+Keyboard.type "hello", :enter, [:ctrl, "c"]
+Keyboard.type [:cmd, [:tab]], [:cmd, [:tab]]

data/exe/jaguar

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# add lib to libpath (only needed when running from the sources)
+require 'pathname'
+lib_path = File.expand_path('../../lib', Pathname.new(__FILE__).realpath)
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
+
+STDOUT.sync = true
+
+require 'jaguar'
+require 'jaguar/cli'
+
+eval_string = if ARGV.any?
+  ARGV.join " "
+else
+  nil
+end
+
+Jaguar::CLI::RootCommand.run eval_string: eval_string

data/jaguar.gemspec

@@ -21,7 +21,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_dependency "pry"
+  spec.add_dependency "contracts"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/jaguar.rb

@@ -1,6 +1,45 @@
-require "jaguar/version"
+require "delirium"
+require "contracts"
 
 module Jaguar
+  include Contracts::Core
+  include Contracts::Builtin
+  C = Contracts
+
   class Error < StandardError; end
-  # Your code goes here...
+
+  @@driver = Delirium::Platform.class_for_current_platform.new
+
+  Contract nil => Delirium::Platform::Base
+  def self.driver
+    @@driver
+  end
+
+  Contract Delirium::Platform::Base => nil
+  def self.driver=(d)
+    @@driver = d
+    nil
+  end
+
+  Contract Jaguar::C::Args[Any] => nil
+  def self.debug(*args)
+    return unless ENV["JAGUAR_DEBUG"] == "yes"
+
+    print "JAGUAR DEBUG: "
+    for arg in args
+      arg_formatted = case arg
+      when String
+        arg
+      else
+        arg.inspect
+      end
+      print arg_formatted
+      print " "
+    end
+    puts ""
+    nil
+  end
 end
+
+require_relative "jaguar/version"
+require_relative "jaguar/helpers"

data/lib/jaguar/cli.rb

@@ -0,0 +1,25 @@
+require_relative "../jaguar" # if required only "jaguar/cli"
+require_relative "dsl"
+require "pry"
+
+module Jaguar
+  module CLI
+    class RootCommand
+      include Contracts::Core
+
+      Contract ({ eval_string: Jaguar::C::Maybe[String] }) => nil
+      def self.run(eval_string:nil)
+        TOPLEVEL_BINDING.eval """
+          include Jaguar::DSL
+        """
+        if eval_string
+          TOPLEVEL_BINDING.eval eval_string
+        else
+          TOPLEVEL_BINDING.eval "Pry.start"
+        end
+        nil
+      end
+    end
+  end
+end
+

data/lib/jaguar/dsl.rb

@@ -0,0 +1,9 @@
+require_relative "../jaguar" # if required only "jaguar/dsl"
+
+module Jaguar
+  module DSL
+  end
+end
+
+require_relative "dsl/mouse"
+require_relative "dsl/keyboard"

data/lib/jaguar/dsl/keyboard.rb

@@ -0,0 +1,15 @@
+module Jaguar
+  module DSL
+    module Keyboard
+      include Contracts::Core
+
+      Contract Jaguar::C::Args[Jaguar::C::Or[String,Array,Symbol,Hash]] => self.class
+      def self.type(*string_or_arrays_or_symbol_or_hashes)
+        Type.type *string_or_arrays_or_symbol_or_hashes
+        self
+      end
+    end
+  end
+end
+
+require_relative "keyboard/type"

data/lib/jaguar/dsl/keyboard/type.rb

@@ -0,0 +1,118 @@
+module Jaguar
+  module DSL
+    module Keyboard
+      module Type
+        include Contracts::Core
+
+        Contract Jaguar::C::Args[Jaguar::C::Or[String,Array,Symbol,Hash]] => self.class
+        def self.type(*string_or_arrays_or_symbol_or_hashes)
+          opts, type_sequence = parse_type_args_to_opts_and_type_sequence string_or_arrays_or_symbol_or_hashes
+
+          sequence = unpack_type_sequence type_sequence
+          delay = opts[:delay]
+
+          Jaguar.debug "sequence", sequence, "delay", delay
+
+          sequence.each do |s|
+            already_delayed = false
+
+            case s
+            when String
+              Jaguar.debug "direct_write_instead_of_key_presses?(delay)", direct_write_instead_of_key_presses?(delay)
+
+              if direct_write_instead_of_key_presses?(delay)
+                Jaguar.driver.do device: :keyboard, action: :write, params: {string: s}
+              else
+                s.split('').each do |k|
+                  Jaguar.driver.do device: :keyboard, action: :write, params: {string: s}
+                  Jaguar::Helpers.delay delay if delay
+                  already_delayed = true
+                end
+              end
+            when Array
+              non_mods = s.pop
+              Jaguar.debug "non_mods", non_mods
+              for mod in s do
+                Jaguar.driver.do device: :keyboard, action: :key_down, params: {key: mod}
+              end
+
+              case non_mods
+              when String,Symbol
+                # [:alt, "d"]
+                # [:cmd, :tab]
+                Jaguar.driver.do device: :keyboard, action: :key_press, params: {key: non_mods}
+              when Array
+                # [:alt, [:tab, :tab]]
+                non_mods.each do |non_mod|
+                  Jaguar.driver.do device: :keyboard, action: :key_press, params: {key: non_mod}
+                  Jaguar::Helpers.delay delay if delay
+                  already_delayed = true
+                end
+              end
+
+              for mod in s do
+                Jaguar.driver.do device: :keyboard, action: :key_up, params: {key: mod}
+              end
+            when Symbol
+              Jaguar.driver.do device: :keyboard, action: :key_press, params: {key: s}
+            end
+
+            unless already_delayed
+              Jaguar::Helpers.delay delay if delay
+            end
+          end
+
+          self
+        end
+
+        private
+
+        Contract Jaguar::C::Args[Jaguar::C::Or[String,Array,Symbol,Hash]] => Array[Hash,Array]
+        def self.parse_type_args_to_opts_and_type_sequence(args)
+          opts = {}
+          type_sequence = []
+          args.each do |string_or_array_or_symbol_or_hash|
+            case string_or_array_or_symbol_or_hash.class.name
+            when "String", "Array", "Symbol"
+              type_sequence << string_or_array_or_symbol_or_hash
+            when "Hash"
+              opts.merge!(string_or_array_or_symbol_or_hash)
+            end
+          end
+          [opts, type_sequence]
+        end
+
+        Contract Jaguar::C::Or[Integer,Float,Range,NilClass] => Jaguar::C::Bool
+        def self.direct_write_instead_of_key_presses?(delay)
+          case delay
+          when Integer
+            delay == 0
+          when Float
+            delay == 0.0
+          when Range
+            delay.first == 0 && delay.last == 0
+          when NilClass
+            true
+          end
+        end
+
+        Contract Jaguar::C::Or[String,Array,Symbol] => Array
+        def self.unpack_type_sequence(type_sequence)
+          case type_sequence
+          when String
+            # type "hello"
+            type_sequence.split ''
+          when Array
+            # type "hello", :enter
+            # type [:ctrl, :c]
+            # type [:alt, [:tab, :tab]]
+            type_sequence
+          when Symbol
+            # type :enter
+            [type_sequence]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jaguar/dsl/mouse.rb

@@ -0,0 +1,24 @@
+module Jaguar
+  module DSL
+    module Mouse
+      include Contracts::Core
+
+      Contract Jaguar::C::KeywordArgs[
+        x: Integer, y: Integer
+      ] => self.class
+      def self.move(x:nil, y:nil)
+        Jaguar.driver.do({
+          device: :mouse,
+          action: :move,
+          params: { x: x, y: y }
+        })
+        self
+      end
+
+      Contract Integer, Integer => self.class
+      def self.move(x,y)
+        move x:x, y:y
+      end
+    end
+  end
+end

data/lib/jaguar/helpers.rb

@@ -0,0 +1,15 @@
+module Jaguar
+  module Helpers
+    include Contracts::Core
+    Contract Jaguar::C::Or[Range,Integer,Float] => self.class
+    def self.delay(d=0.0..0.0)
+      case d
+      when Range
+        sleep rand(d) # gotta love ruby
+      when Integer, Float
+        sleep d
+      end
+      self
+    end
+  end
+end

data/lib/jaguar/version.rb

@@ -1,3 +1,3 @@
 module Jaguar
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: jaguar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Superbot HQ
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-12 00:00:00.000000000 Z
+date: 2018-12-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -54,12 +82,15 @@ dependencies:
         version: '3.0'
 description: 
 email: 
-executables: []
+executables:
+- jaguar
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -68,8 +99,16 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- e2e/main.rb
+- exe/jaguar
 - jaguar.gemspec
 - lib/jaguar.rb
+- lib/jaguar/cli.rb
+- lib/jaguar/dsl.rb
+- lib/jaguar/dsl/keyboard.rb
+- lib/jaguar/dsl/keyboard/type.rb
+- lib/jaguar/dsl/mouse.rb
+- lib/jaguar/helpers.rb
 - lib/jaguar/version.rb
 homepage: https://github.com/superbothq/jaguar
 licenses:
@@ -91,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: jaguar eats capybaras