oci_config_reader 0.0.4 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e3b5fb4f78faaadc5381c354c396c6a335c08f2ebe4d18796dd45971ef14da2
-  data.tar.gz: 26366d52b1695f201cd8a7113d094cad2f050fd74fba2116172f33008a92d67b
+  metadata.gz: e5bedcdf788e14ef6eae5a6a14c0a16fccac84dda5cade87d780a61a8850e62a
+  data.tar.gz: fe7c7a53a84cf1e00fbc1d7ad7fc11be73e23ecfc537ff297fe59ab2f0430562
 SHA512:
-  metadata.gz: 27c3f0017b67049c0e6036f7d71b93eed96c85b1cba9e588afb9fdba47e2c35574dc509377315031e2eec4027561676556c404d51368be40646f27e6b19e8672
-  data.tar.gz: 87faaa69e6461b355f7780c045e1485d40e2c94865511f4d903f45331c31345a1b9fca755cc8bda8ecfa1e5cfb0d7307fc9a05e6b036cba259085cdb118a2749
+  metadata.gz: 03d43091dada9c53dc7e598340826444ee4b90a069ea78d77f54d2c9c64b797a8333966618b7cc46079f338bb31ac76e539de96ba5900cb153e02acf88761eb6
+  data.tar.gz: 74a341d441e26962f16aae02506773700adbff1bead48d71996544a2163ee58423940fd27969f313788ddf304f23859cabdfc784131b4ed96aacc93e69537126

data/README.md

@@ -1,4 +1,4 @@
-# OciConfigReader
+# OCIConfigReader
 
 A simple gem to read data from oci config file. So in Ruby sample codes you don't need to write down/copy-paste the same information again-and-again.
 
@@ -21,7 +21,14 @@ Or install it yourself as:
 
 ## Usage
 
-OciConfigReader.oci_config_data["user/fingerprint/key_file/tenancy/region"]
+The gem will try to read the data from: ```~/.oci/config```
+```ruby
+user = OciConfigReader.oci_config_data["user"]
+fingerprint = OciConfigReader.oci_config_data["fingerprint"]
+key_file = OciConfigReader.oci_config_data["key_file"]
+tenancy = OciConfigReader.oci_config_data["tenancy"]
+```
+
 
 
 ## Contributing

data/examples/example1.rb

@@ -0,0 +1,159 @@
+#
+#
+# Origin of the file: https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/signingrequests.htm#RubySigningSample
+#
+#
+
+require 'base64'
+require 'digest'
+require 'openssl'
+require 'time'
+require 'uri'
+require 'json'
+
+# gem 'oci_config_reader'
+require 'oci_config_reader'
+
+# gem 'terminal-table'
+require 'terminal-table'
+
+# gem 'httparty', '~> 0.13.0'
+require 'httparty'
+
+user = OciConfigReader.oci_config_data["user"]
+fingerprint = OciConfigReader.oci_config_data["fingerprint"]
+key_file = OciConfigReader.oci_config_data["key_file"]
+tenancy = OciConfigReader.oci_config_data["tenancy"]
+
+# Version 1.0.1
+class Client
+    include HTTParty
+    attr_reader :signer
+
+    def initialize(key_id, private_key)
+        @signer = Signer.new(key_id, private_key)
+    end
+
+    # nothing to sign for :options
+
+    [:get, :head, :delete].each do |method|
+        define_method(method) do |uri, headers: {}|
+            self.signer.sign(method, uri, headers, body: nil)
+            self.class.send(method, uri, :headers => headers)
+        end
+    end
+
+    [:put, :post].each do |method|
+        define_method(method) do |uri, headers: {}, body: ""|
+            self.signer.sign(method, uri, headers, body)
+            self.class.send(method, uri, :headers => headers, :body => body)
+        end
+    end
+end
+
+
+class Signer
+    class << self
+        attr_reader :headers
+    end
+
+    attr_reader :key_id, :private_key
+
+    generic_headers = [:"date", :"(request-target)", :"host"]
+    body_headers = [
+        :"content-length", :"content-type", :"x-content-sha256"]
+    @headers = {
+        get: generic_headers,
+        head: generic_headers,
+        delete: generic_headers,
+        put: generic_headers + body_headers,
+        post: generic_headers + body_headers
+    }
+
+    def initialize(key_id, private_key)
+        @key_id = key_id
+        @private_key = private_key
+    end
+
+    def sign(method, uri, headers, body)
+        uri = URI(uri)
+        path = uri.query.nil? ? uri.path : "#{uri.path}?#{uri.query}"
+        self.inject_missing_headers(headers, method, body, uri)
+        signature = self.compute_signature(headers, method, path)
+        unless signature.nil?
+            self.inject_authorization_header(headers, method, signature)
+        end
+    end
+
+    def inject_missing_headers(headers, method, body, uri)
+        headers["content-type"] ||= "application/json"
+        headers["date"] ||= Time.now.utc.httpdate
+        headers["accept"] ||= "*/*"
+        headers["host"] ||= uri.host
+        if method == :put or method == :post
+            body ||= ""
+            headers["content-length"] ||= body.length.to_s
+            headers["x-content-sha256"] ||= Digest::SHA256.base64digest(body)
+        end
+    end
+
+    def inject_authorization_header(headers, method, signature)
+        signed_headers = self.class.headers[method].map(&:to_s).join(" ")
+        headers["authorization"] = [
+            %(Signature version="1"),
+            %(headers="#{signed_headers}"),
+            %(keyId="#{self.key_id}"),
+            %(algorithm="rsa-sha256"),
+            %(signature="#{signature}")
+        ].join(",")
+    end
+
+    def compute_signature(headers, method, path)
+        return if self.class.headers[method].empty?
+        signing_string = self.class.headers[method].map do |header|
+            if header == :"(request-target)"
+                "#{header}: #{method.downcase} #{path}"
+            else
+                "#{header}: #{headers[header.to_s]}"
+            end
+        end.join("\n")
+        signature = self.private_key.sign(
+            OpenSSL::Digest::SHA256.new,
+            signing_string.encode("ascii"))
+        Base64.strict_encode64(signature)
+    end
+end
+
+
+api_key = [tenancy, user, fingerprint].join("/")
+private_key = OpenSSL::PKey::RSA.new(File.read(key_file))
+client = Client.new(api_key, private_key)
+
+headers = {
+    # Uncomment to use a fixed date
+    # "date" => "Thu, 05 Jan 2014 21:31:40 GMT"
+}
+
+# GET with query parameters
+uri = "https://iaas.eu-frankfurt-1.oraclecloud.com/20160918/instances?compartmentId=%{compartment_id}"
+uri = uri % {
+    :compartment_id => "ocid1.compartment.oc1..aaaaaaaa4ifadwjtf3uez2sawspmre5yartoh3jq6afwvihv3zddug3m3nda".sub(":", "%3A")
+}
+response = client.get(uri, headers: headers)
+
+# Create a table
+response_data = JSON.parse(response&.body || "{}")
+AD = response_data[0]["availabilityDomain"]
+server_name = response_data[0]["displayName"]
+fault_domain = response_data[0]["faultDomain"]
+region = response_data[0]["region"]
+shape = response_data[0]["shape"]
+ocpus = response_data[0]["shapeConfig"]["ocpus"]
+memory = response_data[0]["shapeConfig"]["memoryInGBs"]
+cpu_type = response_data[0]["shapeConfig"]["processorDescription"]
+
+rows = []
+rows << [server_name, fault_domain, region, shape, ocpus, cpu_type, memory]
+table = Terminal::Table.new :title => AD, :headings => ["Server name", "Fault domain", "Region", "Shape", "OCPU", "OCPU type", "Memory in GB"], :rows => rows
+
+puts table

data/lib/oci_config_reader/version.rb

@@ -1,3 +1,3 @@
 module OciConfigReader
-  VERSION = "0.0.4"
+  VERSION = "0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oci_config_reader
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: '0.1'
 platform: ruby
 authors:
 - Szabolcs Toth
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2023-03-30 00:00:00.000000000 Z
 dependencies: []
 description: A simple gem to read data from oci config file. So in Ruby sample codes
   you don't need to write down/copy-paste the same information again-and-again.
@@ -26,6 +26,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/example1.rb
 - lib/oci_config_reader.rb
 - lib/oci_config_reader/version.rb
 - oci_config_reader.gemspec
@@ -36,7 +37,7 @@ metadata:
   homepage_uri: https://github.com/kicsipixel/oci_config_reader
   source_code_uri: https://github.com/kicsipixel/oci_config_reader
   changelog_uri: https://github.com/kicsipixel/oci_config_reader
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,8 +52,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: A Ruby gem to read out oci config data.
 test_files: []