oso-oso 0.2.5 → 0.5.0

data/lib/oso/polar/query.rb

@@ -3,23 +3,61 @@
 module Oso
   module Polar
     # A single Polar query.
-    class Query
+    class Query # rubocop:disable Metrics/ClassLength
+      # @return [Enumerator]
       attr_reader :results
 
-      # @param ffi_instance [FFI::Query]
-      # @param polar [Polar]
-      def initialize(ffi_instance, polar:)
-        @ffi_instance = ffi_instance
-        @polar = polar
+      # @param ffi_query [FFI::Query]
+      # @param host [Oso::Polar::Host]
+      def initialize(ffi_query, host:)
+        @calls = {}
+        @ffi_query = ffi_query
+        @host = host
         @results = start
       end
 
       private
 
+      # @return [Hash<Integer, Enumerator>]
+      attr_reader :calls
       # @return [FFI::Query]
-      attr_reader :ffi_instance
-      # @return [Polar]
-      attr_reader :polar
+      attr_reader :ffi_query
+      # @return [Host]
+      attr_reader :host
+
+      # Send result of predicate check across FFI boundary.
+      #
+      # @param result [Boolean]
+      # @param call_id [Integer]
+      # @raise [Error] if the FFI call raises one.
+      def question_result(result, call_id:)
+        ffi_query.question_result(result, call_id: call_id)
+      end
+
+      # Register a Ruby method call, wrapping the call result in a generator if
+      # it isn't already one.
+      #
+      # @param method [#to_sym]
+      # @param call_id [Integer]
+      # @param instance [Hash<String, Object>]
+      # @param args [Array<Hash>]
+      # @raise [InvalidCallError] if the method doesn't exist on the instance or
+      #   the args passed to the method are invalid.
+      def register_call(attribute, call_id:, instance:, args:) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        return if calls.key?(call_id)
+
+        instance = host.to_ruby(instance)
+        if args.nil?
+          result = instance.__send__(attribute)
+        else
+          args = args.map { |a| host.to_ruby(a) }
+          result = instance.__send__(attribute, *args)
+        end
+        result = [result].to_enum unless result.is_a? Enumerator # Call must be a generator.
+        calls[call_id] = result.lazy
+      rescue ArgumentError, NoMethodError
+        raise InvalidCallError
+      end
 
       # Send next result of Ruby method call across FFI boundary.
       #
@@ -27,16 +65,24 @@ module Oso
       # @param call_id [Integer]
       # @raise [Error] if the FFI call raises one.
       def call_result(result, call_id:)
-        ffi_instance.call_result(result, call_id: call_id)
+        ffi_query.call_result(result, call_id: call_id)
       end
 
-      # Send result of predicate check across FFI boundary.
+      # Retrieve the next result from a registered call and pass it to {#to_polar_term}.
       #
-      # @param result [Boolean]
-      # @param call_id [Integer]
+      # @param id [Integer]
+      # @return [Hash]
+      # @raise [StopIteration] if the call has been exhausted.
+      def next_call_result(id)
+        host.to_polar_term(calls[id].next)
+      end
+
+      # Send application error across FFI boundary.
+      #
+      # @param message [String]
       # @raise [Error] if the FFI call raises one.
-      def question_result(result, call_id:)
-        ffi_instance.question_result(result, call_id: call_id)
+      def application_error(message)
+        ffi_query.application_error(message)
       end
 
       # Fetch the next result from calling a Ruby method and prepare it for
@@ -45,16 +91,17 @@ module Oso
       # @param method [#to_sym]
       # @param args [Array<Hash>]
       # @param call_id [Integer]
-      # @param instance_id [Integer]
+      # @param instance [Hash<String, Object>]
       # @raise [Error] if the FFI call raises one.
-      def handle_call(method, call_id:, instance:, args:)
-        polar.register_call(method, call_id: call_id, instance: instance, args: args)
-        result = JSON.dump(polar.next_call_result(call_id))
+      def handle_call(attribute, call_id:, instance:, args:)
+        register_call(attribute, call_id: call_id, instance: instance, args: args)
+        result = JSON.dump(next_call_result(call_id))
         call_result(result, call_id: call_id)
-      rescue InvalidCallError, StopIteration
+      rescue InvalidCallError => e
+        application_error(e.message)
+        call_result(nil, call_id: call_id)
+      rescue StopIteration
         call_result(nil, call_id: call_id)
-        # @TODO: polar line numbers in errors once polar errors are better.
-        # raise PolarRuntimeError(f"Error calling {attribute}")
       end
 
       # Create a generator that can be polled to advance the query loop.
@@ -62,50 +109,63 @@ module Oso
       # @yieldparam [Hash<String, Object>]
       # @return [Enumerator]
       # @raise [Error] if any of the FFI calls raise one.
-      def start # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      def start # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
         Enumerator.new do |yielder| # rubocop:disable Metrics/BlockLength
           loop do # rubocop:disable Metrics/BlockLength
-            event = ffi_instance.next_event
+            event = ffi_query.next_event
             case event.kind
             when 'Done'
               break
             when 'Result'
-              yielder << event.data['bindings'].transform_values { |v| polar.to_ruby(v) }
+              yielder << event.data['bindings'].transform_values { |v| host.to_ruby(v) }
             when 'MakeExternal'
               id = event.data['instance_id']
-              raise DuplicateInstanceRegistrationError, id if polar.instance? id
+              raise DuplicateInstanceRegistrationError, id if host.instance? id
 
-              cls_name = event.data['instance']['tag']
-              fields = event.data['instance']['fields']['fields']
-              polar.make_instance(cls_name, fields: fields, id: id)
+              constructor = event.data['constructor']['value']
+              if constructor.key? 'InstanceLiteral'
+                cls_name = constructor['InstanceLiteral']['tag']
+                fields = constructor['InstanceLiteral']['fields']['fields']
+                initargs = Hash[fields.map { |k, v| [k.to_sym, host.to_ruby(v)] }]
+              elsif constructor.key? 'Call'
+                cls_name = constructor['Call']['name']
+                initargs = constructor['Call']['args'].map { |arg| host.to_ruby(arg) }
+              else
+                raise InvalidConstructorError
+              end
+              host.make_instance(cls_name, initargs: initargs, id: id)
             when 'ExternalCall'
               call_id = event.data['call_id']
               instance = event.data['instance']
-              method = event.data['attribute']
+              attribute = event.data['attribute']
               args = event.data['args']
-              handle_call(method, call_id: call_id, instance: instance, args: args)
+              handle_call(attribute, call_id: call_id, instance: instance, args: args)
             when 'ExternalIsSubSpecializer'
               instance_id = event.data['instance_id']
               left_tag = event.data['left_class_tag']
               right_tag = event.data['right_class_tag']
-              answer = polar.subspecializer?(instance_id, left_tag: left_tag, right_tag: right_tag)
+              answer = host.subspecializer?(instance_id, left_tag: left_tag, right_tag: right_tag)
               question_result(answer, call_id: event.data['call_id'])
             when 'ExternalIsa'
-              instance_id = event.data['instance_id']
+              instance = event.data['instance']
               class_tag = event.data['class_tag']
-              answer = polar.isa?(instance_id, class_tag: class_tag)
+              answer = host.isa?(instance, class_tag: class_tag)
               question_result(answer, call_id: event.data['call_id'])
             when 'ExternalUnify'
               left_instance_id = event.data['left_instance_id']
               right_instance_id = event.data['right_instance_id']
-              answer = polar.unify?(left_instance_id, right_instance_id)
+              answer = host.unify?(left_instance_id, right_instance_id)
               question_result(answer, call_id: event.data['call_id'])
             when 'Debug'
               puts event.data['message'] if event.data['message']
-              print '> '
-              input = $stdin.gets.chomp!
-              command = JSON.dump(polar.to_polar_term(input))
-              ffi_instance.debug_command(command)
+              print 'debug> '
+              begin
+                input = $stdin.readline.chomp.chomp(';')
+              rescue EOFError
+                next
+              end
+              command = JSON.dump(host.to_polar_term(input))
+              ffi_query.debug_command(command)
             else
               raise "Unhandled event: #{JSON.dump(event.inspect)}"
             end

data/lib/oso/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Oso
-  VERSION = '0.2.5'
+  VERSION = '0.5.0'
 end

data/oso-oso.gemspec

@@ -5,24 +5,26 @@ require_relative 'lib/oso/version'
 Gem::Specification.new do |spec|
   spec.name          = 'oso-oso'
   spec.version       = Oso::VERSION
-  spec.authors       = ['Oso Security']
+  spec.authors       = ['Oso Security, Inc.']
   spec.email         = ['support@osohq.com']
-
-  spec.summary       = 'Oso authorization API.'
+  spec.licenses      = ['Apache-2.0']
+  spec.summary       = 'oso authorization library.'
   spec.homepage      = 'https://www.osohq.com/'
+
   spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/osohq/oso'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-    files += Dir['ext/oso-oso/lib/*']
+    files + Dir['ext/oso-oso/lib/*']
   end
 
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   # Runtime dependencies
@@ -32,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-byebug', '~> 3.9.0'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'solargraph', '~> 0.39.8'
+  spec.add_development_dependency 'rubocop', '~> 0.89.1'
+  spec.add_development_dependency 'solargraph', '~> 0.39.14'
   spec.add_development_dependency 'yard', '~> 0.9.25'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oso-oso
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.5.0
 platform: ruby
 authors:
-- Oso Security
+- Oso Security, Inc.
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -66,20 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
 - !ruby/object:Gem::Dependency
   name: solargraph
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.8
+        version: 0.39.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.8
+        version: 0.39.14
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -97,20 +111,21 @@ dependencies:
 description: 
 email:
 - support@osohq.com
-executables: []
+executables:
+- oso
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".solargraph.yml"
 - Gemfile
 - Gemfile.lock
 - Makefile
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- bin/oso
 - ext/oso-oso/lib/libpolar.dylib
 - ext/oso-oso/lib/libpolar.so
 - ext/oso-oso/lib/polar.dll
@@ -122,9 +137,11 @@ files:
 - lib/oso/polar/errors.rb
 - lib/oso/polar/ffi.rb
 - lib/oso/polar/ffi/error.rb
+- lib/oso/polar/ffi/message.rb
 - lib/oso/polar/ffi/polar.rb
 - lib/oso/polar/ffi/query.rb
 - lib/oso/polar/ffi/query_event.rb
+- lib/oso/polar/host.rb
 - lib/oso/polar/polar.rb
 - lib/oso/polar/predicate.rb
 - lib/oso/polar/query.rb
@@ -133,9 +150,11 @@ files:
 - lib/oso/version.rb
 - oso-oso.gemspec
 homepage: https://www.osohq.com/
-licenses: []
+licenses:
+- Apache-2.0
 metadata:
   homepage_uri: https://www.osohq.com/
+  source_code_uri: https://github.com/osohq/oso
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -155,5 +174,5 @@ rubyforge_project:
 rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
-summary: Oso authorization API.
+summary: oso authorization library.
 test_files: []

data/bin/console

@@ -1,33 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'oso'
-
-polar = Oso::Polar.new.tap do |p| # rubocop:disable Lint/UselessAssignment
-  p.load_str('f(1); f(2); g(1); g(2); h(2); k(x) := f(x), h(x), g(x);')
-  puts 'f(x)', p.send(:query_str, 'f(x)').to_a
-  puts 'k(x)', p.send(:query_str, 'k(x)').to_a
-
-  p.load_str('foo(1, 2); foo(3, 4); foo(5, 6);')
-  expected = [{ 'x' => 1, 'y' => 2 }, { 'x' => 3, 'y' => 4 }, { 'x' => 5, 'y' => 6 }]
-  raise 'AssertionError' if p.send(:query_str, 'foo(x, y)').to_a != expected
-
-  class TestClass # rubocop:disable Style/Documentation
-    def my_method
-      1
-    end
-  end
-
-  p.register_class(TestClass)
-
-  p.load_str('external(x, 3) := x = new TestClass{}.my_method;')
-  results = p.send(:query_str, 'external(1, x)')
-  p results.next
-
-  # p.load_str('testDebug() := debug(), foo(x, y), k(y);')
-  # p.send(:query_str, 'testDebug()').next
-end
-
-require 'pry'
-Pry.start

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install