openlayer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 255305d0ee35d06cd50f6243adece29a13abcd94e39cd72eeaafa0ad9ef64818
+  data.tar.gz: afc2292d13f5bfd99e136c805c300c43d46cbecad09dacfac5c60c5a8f7eadf7
+SHA512:
+  metadata.gz: e819098a710660d080afd35ac2de37efcc5259cadb2b9ff446325b7ee5f924f44f68b514816252ca28825c7301caf99a897a4c37b0e2cd505fbd66a8c2f6a82b
+  data.tar.gz: 1f242e2ba0bb14f5a1123aed04b0a8f7f2723641ca9c41a67072b2603f71dd772c866563d3f507a2d1ddb7e2d8642f78f3412722ed8be711d4ce6953ef16eb09

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Telos Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Openlayer
+Openlayer is a Ruby gem that provides a wrapper for the Openlayer HTTP API. It allows you to connect to Openlayer and interact with its features. Please note that this gem is currently in the early stages of development.
+
+
+## Installation
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add openlayer
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install openlayer
+
+## Usage
+
+```ruby
+client = OpenLayer::Client.new(api_key: "YOUR_OPENLAYER_API_KEY")
+inference_pipeline = client.inference_pipeline("YOUR_INFERENCE_PIPELINE_ID")
+inferencce_pipeline.stream_data(
+    {
+        rows: [...],
+        config: {...}
+    }
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TelosLabs/openlayer.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/openlayer/client.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+
+module Openlayer
+  class Client
+    BASE_URL = "https://api.openlayer.com/v1/"
+
+    attr_reader :api_key, :adapter
+
+    def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
+      @api_key = api_key
+      @adapter = adapter
+      @stubs = stubs
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = BASE_URL
+        conn.request :authorization, "Bearer", api_key
+        conn.request :json
+        conn.response :json, content_type: "application/json"
+        conn.adapter adapter, @stubs
+      end
+    end
+
+    def inference_pipeline(inference_pipeline_id)
+      InferencePipeline.new(self, inference_pipeline_id)
+    end
+  end
+end

data/lib/openlayer/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Openlayer
+  class Error < StandardError; end
+end

data/lib/openlayer/inference_pipeline.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Openlayer
+  class InferencePipeline
+    attr_reader :client, :inference_pipeline_id
+
+    def initialize(client, inference_pipeline_id)
+      @client = client
+      @inference_pipeline_id = inference_pipeline_id
+    end
+
+    def stream_data(**attributes)
+      handle_response client.connection.post("inference-pipelines/#{inference_pipeline_id}/data-stream", attributes)
+      true
+    end
+
+    def handle_response(response)
+      message = response.body["error"]
+      case response.status
+      when 200
+        response.body
+      when 401
+        raise Error, message
+      when 404
+        raise Error, message
+      when 422
+        raise Error, message
+      when 500
+        raise Error, message
+      else
+        raise Error, message
+      end
+      response
+    end
+  end
+end

data/lib/openlayer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Openlayer
+  VERSION = "0.1.1"
+end

data/lib/openlayer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "openlayer/version"
+
+module Openlayer
+  autoload :Client, "openlayer/client"
+  autoload :Error, "openlayer/error"
+  autoload :InferencePipeline, "openlayer/inference_pipeline"
+
+  # Your code goes here...
+end

data/openlayer.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/openlayer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "openlayer"
+  spec.version = Openlayer::VERSION
+  spec.authors = ["Jose Fernando Davila"]
+  spec.email = ["davila.jose23@gmail.com"]
+
+  spec.summary = "Openlayer api wrapper"
+  spec.description = "Openlayer api wrapper"
+  spec.homepage = "https://github.com/TelosLabs/openlayer"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "faraday", "~> 2.9.0"
+  spec.add_dependency "faraday_middleware", "~> 1.2.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/openlayer.rbs

@@ -0,0 +1,4 @@
+module Openlayer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: openlayer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jose Fernando Davila
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Openlayer api wrapper
+email:
+- davila.jose23@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- Rakefile
+- lib/openlayer.rb
+- lib/openlayer/client.rb
+- lib/openlayer/error.rb
+- lib/openlayer/inference_pipeline.rb
+- lib/openlayer/version.rb
+- openlayer.gemspec
+- sig/openlayer.rbs
+homepage: https://github.com/TelosLabs/openlayer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/TelosLabs/openlayer
+  source_code_uri: https://github.com/TelosLabs/openlayer
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Openlayer api wrapper
+test_files: []