oso-oso 0.2.2

data/lib/oso/polar/predicate.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Oso
+  module Polar
+    # Polar predicate.
+    class Predicate
+      attr_reader :name, :args
+
+      # @param name [String]
+      # @param args [Array<Object>]
+      def initialize(name, args:)
+        @name = name
+        @args = args
+      end
+
+      # @param other [Predicate]
+      # @return [Boolean]
+      def ==(other)
+        name == other.name && args == other.args
+      end
+
+      # @see #==
+      alias eql? ==
+    end
+  end
+end

data/lib/oso/polar/query.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Oso
+  module Polar
+    # A single Polar query.
+    class Query
+      attr_reader :results
+
+      # @param ffi_instance [FFI::Query]
+      # @param polar [Polar]
+      def initialize(ffi_instance, polar:)
+        @ffi_instance = ffi_instance
+        @polar = polar
+        @results = start
+      end
+
+      private
+
+      # @return [FFI::Query]
+      attr_reader :ffi_instance
+      # @return [Polar]
+      attr_reader :polar
+
+      # Send next result of Ruby method call across FFI boundary.
+      #
+      # @param result [String]
+      # @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)
+      end
+
+      # 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_instance.question_result(result, call_id: call_id)
+      end
+
+      # Fetch the next result from calling a Ruby method and prepare it for
+      # transmission across the FFI boundary.
+      #
+      # @param method [#to_sym]
+      # @param args [Array<Hash>]
+      # @param call_id [Integer]
+      # @param instance_id [Integer]
+      # @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))
+        call_result(result, call_id: call_id)
+      rescue InvalidCallError, 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.
+      #
+      # @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
+        Enumerator.new do |yielder| # rubocop:disable Metrics/BlockLength
+          loop do # rubocop:disable Metrics/BlockLength
+            event = ffi_instance.next_event
+            case event.kind
+            when 'Done'
+              break
+            when 'Result'
+              yielder << event.data['bindings'].transform_values { |v| polar.to_ruby(v) }
+            when 'MakeExternal'
+              id = event.data['instance_id']
+              raise DuplicateInstanceRegistrationError, id if polar.instance? id
+
+              cls_name = event.data['instance']['tag']
+              fields = event.data['instance']['fields']['fields']
+              polar.make_instance(cls_name, fields: fields, id: id)
+            when 'ExternalCall'
+              call_id = event.data['call_id']
+              instance = event.data['instance']
+              method = event.data['attribute']
+              args = event.data['args']
+              handle_call(method, 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)
+              question_result(answer, call_id: event.data['call_id'])
+            when 'ExternalIsa'
+              instance_id = event.data['instance_id']
+              class_tag = event.data['class_tag']
+              answer = polar.isa?(instance_id, 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)
+              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)
+            else
+              raise "Unhandled event: #{JSON.dump(event.inspect)}"
+            end
+          end
+        end.lazy
+      end
+    end
+  end
+end

data/lib/oso/polar/query_event.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Oso
+  module Polar
+    # A query event received across the FFI boundary.
+    class QueryEvent
+      # @return [String]
+      attr_reader :kind
+      # @return [Hash<String, Object>]
+      attr_reader :data
+
+      # @overload initialize(event_data)
+      #   @param event_data [Hash<String, Object>]
+      # @overload initialize(event_data)
+      #   @param event_data [String]
+      def initialize(event_data)
+        event_data = { event_data => nil } if event_data == 'Done'
+        @kind, @data = event_data.first
+      end
+    end
+  end
+end

data/lib/oso/polar/variable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Oso
+  module Polar
+    # Polar variable.
+    class Variable
+      attr_reader :name
+
+      # @param name [String]
+      def initialize(name)
+        @name = name
+      end
+
+      # @return [String]
+      def to_s
+        name
+      end
+    end
+  end
+end

data/lib/oso/version.rb

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

data/oso-oso.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/oso/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'oso-oso'
+  spec.version       = Oso::VERSION
+  spec.authors       = ['Oso Security']
+  spec.email         = ['support@osohq.com']
+
+  spec.summary       = 'Oso authorization API.'
+  spec.homepage      = 'https://www.osohq.com/'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+
+  # 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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Runtime dependencies
+  spec.add_runtime_dependency 'ffi', '~> 1.0'
+
+  # Development dependencies
+  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 'yard', '~> 0.9.25'
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: oso-oso
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Oso Security
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.8
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+description: 
+email:
+- support@osohq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".solargraph.yml"
+- Gemfile
+- Gemfile.lock
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/oso-oso/lib/libpolar.dylib
+- ext/oso-oso/lib/libpolar.so
+- lib/oso.rb
+- lib/oso/http.rb
+- lib/oso/oso.rb
+- lib/oso/path_mapper.rb
+- lib/oso/polar.rb
+- lib/oso/polar/errors.rb
+- lib/oso/polar/ffi.rb
+- lib/oso/polar/ffi/error.rb
+- lib/oso/polar/ffi/polar.rb
+- lib/oso/polar/ffi/query.rb
+- lib/oso/polar/ffi/query_event.rb
+- lib/oso/polar/polar.rb
+- lib/oso/polar/predicate.rb
+- lib/oso/polar/query.rb
+- lib/oso/polar/query_event.rb
+- lib/oso/polar/variable.rb
+- lib/oso/version.rb
+- oso-oso.gemspec
+homepage: https://www.osohq.com/
+licenses: []
+metadata:
+  homepage_uri: https://www.osohq.com/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Oso authorization API.
+test_files: []