infrawrench-bulk_instances 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d923efcb8b07fa8334b16dc8ecc899b7cd7f47f9ec31a393f589d1565bf5c6b
-  data.tar.gz: 83dfaa42f5798bd85d7b4e9b829a43a47566d2684ce8caa6edcd0cd645afc462
+  metadata.gz: 35025be8d677ed34cdfea296faca613c02d6ffe5c88d35266ad33fc36947d704
+  data.tar.gz: 3035dee6a0a3f8f86923ab7fb1b1c16c02fbc0e2aff9798a18d4640b4518138c
 SHA512:
-  metadata.gz: 92fd23d69988cad7b8d3c83d2e1118eb3820c843fa533b56ae3d9ecf72de448aada9ff6b86b7916d242fb4b9353bf172353addf3ef6d87bc43fec4d1f33a567d
-  data.tar.gz: 407c205234c2ab52905ebb3a7fb8a304b92d8a3e73cfbbd8fb5907dd4457348c92d95ef032609244fc713a8afdd418a12079d6a6dfe610811aa04fc54cae5c8c
+  metadata.gz: fd9380c0871c15a34ebe92328f868d6347f6a3b6ce3722a137318d44c48b70cc22573fc38d696a9f66584ea604e97feacfeeecd3772bf87d6285ba93167d11fe
+  data.tar.gz: 33c0e9e0a4e9855840c34f2a93d4d4903a8f813d495daadf782e0057ba3b9df45f34c2f17699f155a7dd509ad62629cf603f046c07f9f9dea9c1510a684da852

data/README.md

@@ -69,6 +69,21 @@ variant fields. On other platforms they are `""`, unless the platform has a fiel
 Requires Ruby 3.2 or later, and liblzma (part of macOS and of practically every
 Linux distribution; `xz-utils`/`xz` otherwise) to decompress downloads.
 
+## One instance
+
+`Infrawrench::BulkInstances.fetch_aws_instance(platform, instance_type, ...)` fetches a single
+instance from the Infrawrench API instead of downloading the platform's whole bundle. It returns
+the same `AWSInstance` that `get` does, or `nil` if the platform has no instance with that name:
+
+```ruby
+m5 = Infrawrench::BulkInstances.fetch_aws_instance("ec2", "m5.large")
+m5&.pricing&.on_demand&.length
+```
+
+It takes `token:` like the bundle download, and `base_url:` for where the API is served from
+(`https://app.infrawrench.com` by default). Nothing is cached. The API syncs each new bundle within
+about half an hour of it being published, so it can briefly trail `download_aws_pricing_data`.
+
 ## Caching
 
 The bundle is downloaded xz-compressed (about 20 MB) and kept decompressed (about

data/lib/infrawrench/bulk_instances/version.rb

@@ -2,6 +2,6 @@
 
 module Infrawrench
   module BulkInstances
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/lib/infrawrench/bulk_instances.rb

@@ -17,6 +17,7 @@ module Infrawrench
   # AWS instance attributes and pricing (EC2, RDS, ElastiCache and more), with full history, from Infrawrench.
   module BulkInstances
     DEFAULT_BASE_URL = "https://instances-bundles.infrawrench.com"
+    DEFAULT_API_URL = "https://app.infrawrench.com"
     USER_AGENT = "infrawrench/bulk-instances, ruby, 1.0"
 
     # What Net::HTTP raises when the server cannot be reached or the connection breaks.
@@ -128,10 +129,53 @@ module Infrawrench
         AWSPricingData.new(JSON.parse(json, freeze: true))
       end
 
+      # Fetches one instance from the Infrawrench API, without downloading the platform's bundle.
+      # Nothing is cached.
+      #
+      # The result is the same as <tt>download_aws_pricing_data(platform).get(instance_type)</tt>, from
+      # whichever bundle the API last synced, which can trail the newest bundle by up to half an hour.
+      #
+      # @param platform [String, Symbol] One of AWS_PLATFORMS, e.g. +"rds"+, or any other lowercase platform name.
+      # @param instance_type [String] The instance type, e.g. +"m5.large"+.
+      # @param token [String, nil] Your Infrawrench API token. Defaults to the +INFRAWRENCH_API_KEY+ environment variable.
+      # @param base_url [String, nil] Where the Infrawrench API is served from. Defaults to https://app.infrawrench.com
+      # @return [AWSInstance, nil] +nil+ if the platform has no instance with that name.
+      # @raise [AWSPricingDataError]
+      def fetch_aws_instance(platform, instance_type, token: nil, base_url: nil)
+        unless (platform.is_a?(String) || platform.is_a?(Symbol)) && platform.match?(/\A[a-z0-9]+\z/)
+          raise AWSPricingDataError, %("#{platform}" is not a platform name.)
+        end
+        raise AWSPricingDataError, "The instance type is empty." if instance_type.to_s.empty?
+
+        token = ENV.fetch("INFRAWRENCH_API_KEY", nil) if token.nil?
+        if token.nil? || token.empty?
+          raise AWSPricingDataError, "No Infrawrench API token: pass `token:` or set INFRAWRENCH_API_KEY."
+        end
+
+        base_url = (base_url || DEFAULT_API_URL).sub(%r{/+\z}, "")
+        # Percent-encoded, with spaces as %20: a + in a path is a plus.
+        name = URI.encode_www_form_component(instance_type.to_s).gsub("+", "%20")
+        begin
+          json = download("#{base_url}/api/v1/aws-bulk-pricing/#{platform}/#{name}", token, &:read_body)
+        rescue AWSPricingDataError => e
+          return nil if e.status == 404
+
+          raise
+        end
+
+        # The bundle's tables cut down to what this instance uses, and its row renumbered to match.
+        value = JSON.parse(json.to_s.dup.force_encoding(Encoding::UTF_8), freeze: true)
+        bundle = value.slice("offer", "compression_table", "regions", "variant_keys", "variants", "reserved_terms")
+        bundle["snapshots"] = []
+        bundle["instances"] = { value["name"] => value["instance"] }
+        AWSPricingData.new(bundle).get(value["name"])
+      end
+
       private
 
       # GETs +url+ and yields the successful response, retrying the 503 the bundles Worker
-      # answers when it cannot reach the Infrawrench API.
+      # answers when it cannot reach the Infrawrench API (and the API answers when it cannot
+      # reach its store).
       def download(url, token)
         uri = URI(url)
         (1..).each do |attempt|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: infrawrench-bulk_instances
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Infrawrench LLC