azure_app_config 1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca31d8def3eb4908170c40b02bcf288cb3ba1a6d27d1be782c18e47e1065d468
-  data.tar.gz: e41cff20281b14a61eec5374eeea7f03db5deb9cd1d51cfc36c16e081509feee
+  metadata.gz: 6d51b12b4038acbf9c955079b82f38ee1176b6a4e68d6f2e84a5d8a9cf0b3aca
+  data.tar.gz: cb6225e1f74f7f76382d1940c6aa273168e11a974e2c8c059815d0d543d686a3
 SHA512:
-  metadata.gz: 301e730cc2910c2af53ce757aaedc10de4d39a7e441653d243388d0a66916149378096a0672515cd964b153b909f5c17c83bba1bf40925714f1fb1040f661fba
-  data.tar.gz: 6ce71b81c891c4124591285ff9e3360a5dffa0cf3f5fd6f989ca7d1550aae095e0f00b608d9e9ea00285c21794fe28e0409a075df6cbd1020d74600067e9c36c
+  metadata.gz: 4aa6ab1cce31d0664a70d4fe06d247f1390870ed5b51f827895ca84312bc680469e47e30cca046f2e0f1439961760cf5ca8db971da660bebaaaed554c4a48f1a
+  data.tar.gz: ad6a927d2d8e1d97ef98fc08316382f93fc92c85855ce95c6d749aadfe3d26d100a26e49d1282496c65866701f4ed8f73c2bdbe5b72667e83b8c83d3df5ff6ef

data/README.md

@@ -1,34 +1,81 @@
 # AzureAppConfig
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/azure_app_config`. To experiment with that code, run `bin/console` for an interactive prompt.
+An unofficial Ruby library for Azure App Configuration.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add azure_app_config
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install azure_app_config
 
 ## Usage
 
-TODO: Write usage instructions here
+### Setup
+
+You'll need to first set up some environment variables in order to use the gem.
+
+```ENV
+AZURE_APP_CONFIG_STORE_NAME = "somestore" // The name of the store to use. This would be used to build the url to the store (https://somestore.azconfig.io)
+AZURE_APP_CONFIG_CREDENTIAL = "Id" // The credential (ID) to use. (Find this in App Configuration > Settings > Access Keys).
+AZURE_APP_CONFIG_SECRET = "some_secret" // The secret to use. (Find this in App Configuration > Settings > Access Keys).
+AZURE_APP_CONFIG_API_VERSION = "1.0" // The API version to use. Defaults to 1.0.
+AZURE_APP_CONFIG_KEY_PREFIX = ".appconfig.featureflag/" // The key prefix to use. Defaults to ".appconfig.featureflag/"
+```
+
+### Examples
+
+```ruby
+require "azure_app_config"
+
+# Fetch all keys
+
+AzureAppConfig::Base.keys # => ["key1", "key2", "key3", "key4", "key12"]
+AzureAppConfig::Base.keys(name: ["key1", "key2"]) # => ["key1", "key2"]
+AzureAppConfig::Base.keys(name: "key1*") # => ["key1", "key12"]
+
+# Fetch a single key-value pair
+
+AzureAppConfig::Base.fetch("key1") # => { etag: "...", id: ".appconfig.featureflag/key1", label: nil, value: { enabled: true, ...}, ...}
+AzureAppConfig::Base.fetch("key1", label: 'prod') # => { etag: "...", id: ".appconfig.featureflag/key1", label: "prod", value: { enabled: true, ...}, ...}
+AzureAppConfig::Base.fetch("non_existent", label: 'prod') # => AzureAppConfig::NotFoundError
+
+# Fetches all key-value pairs
+
+AzureAppConfig::Base.all # => [{ etag: "...", id: ".appconfig.featureflag/key1", label: nil, value: { enabled: true, ...}, ...}, { etag: "...", id: ".appconfig.featureflag/key2", label: nil, value: { enabled: true, ...}, ...}, ...]
+AzureAppConfig::Base.all(name: "key1*") # => [{ etag: "...", id: ".appconfig.featureflag/key1", label: nil, value: { enabled: true, ...}, ...}, ...]
+AzureAppConfig::Base.all(name: "key1*", label: "prod") # => [{ etag: "...", id: ".appconfig.featureflag/key1", label: "prod", value: { enabled: true, ...}, ...}, { etag: "...", id: ".appconfig.featureflag/key12", label: "prod", value: { enabled: true, ...}, ...}, ...]
+AzureAppConfig::Base.all(name: ["key1", "key2"], label: "prod") # => [{ etag: "...", id: ".appconfig.featureflag/key1", label: "prod", value: { enabled: true, ...}, ...}, { etag: "...", id: ".appconfig.featureflag/key2", label: "prod", value: { enabled: true, ...}, ...}, ...]
+
+# Fetches all labels
+AzureAppConfig::Base.labels # => [null, "prod", "test"] # null indicates the default (blank) label.
+AzureAppConfig::Base.labels(name: "p*") # => ["prod"]
+AzureAppConfig::Base.labels(name: ["prod", "test"]) # => ["prod", "test"]
+
+
+# Check if a key is enabled
+
+AzureAppConfig::Base.enabled?("key1") # => true
+AzureAppConfig::Base.enabled?("key2", label: 'prod') # => false (even if the key is non-existent)
+
+# Check if a key is disabled
+
+AzureAppConfig::Base.disabled?("key1") # => false
+AzureAppConfig::Base.disabled?("key2", label: 'prod') # => true (even if the key is non-existent)
+```
 
 ## 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/azure_app_config. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/azure_app_config/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/shettytejas/azure_app_config. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/shettytejas/azure_app_config/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +83,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the AzureAppConfig project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/azure_app_config/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the AzureAppConfig project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shettytejas/azure_app_config/blob/master/CODE_OF_CONDUCT.md).

data/fixtures/vcr_cassettes/labels/with_name_param_as_array.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://inbox.azconfig.io/labels?api-version=1.0&name=prod,test
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Ms-Date:
+      - Tue, 09 Jan 2024 18:07:42 GMT
+      X-Ms-Content-Sha256:
+      - 47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=
+      Authorization:
+      - HMAC-SHA256 Credential=TjvF&SignedHeaders=x-ms-date;host;x-ms-content-sha256&Signature=BT7vCF9rfrZpCsRXR7m2QyQxWhq0q92nlIJgujpTuPM=
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - inbox.azconfig.io
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 09 Jan 2024 18:07:42 GMT
+      Content-Type:
+      - application/vnd.microsoft.appconfig.labelset+json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Sync-Token:
+      - zAJw6V16=NjoxMyM1NDI0NTQ2;sn=5424546
+      X-Ms-Request-Id:
+      - 78a45bb3-131a-4128-882d-64afbd2a0da6
+      X-Ms-Correlation-Request-Id:
+      - 78a45bb3-131a-4128-882d-64afbd2a0da6
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '{"items":[{"name":"prod"},{"name":"test"}]}'
+  recorded_at: Tue, 09 Jan 2024 18:07:42 GMT
+recorded_with: VCR 6.2.0

data/fixtures/vcr_cassettes/labels/with_name_param_as_string.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://inbox.azconfig.io/labels?api-version=1.0&name=p*
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Ms-Date:
+      - Tue, 09 Jan 2024 18:07:17 GMT
+      X-Ms-Content-Sha256:
+      - 47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=
+      Authorization:
+      - HMAC-SHA256 Credential=TjvF&SignedHeaders=x-ms-date;host;x-ms-content-sha256&Signature=tZLdY/9jghuYIThY9JyEc5mQuPfI2pSiEfyjtAdhrr4=
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - inbox.azconfig.io
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 09 Jan 2024 18:07:17 GMT
+      Content-Type:
+      - application/vnd.microsoft.appconfig.labelset+json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Sync-Token:
+      - zAJw6V16=NjoxMyM1NDI0NTQ2;sn=5424546
+      X-Ms-Request-Id:
+      - 17520fc2-db00-4a52-8e1e-1ca89c30ce32
+      X-Ms-Correlation-Request-Id:
+      - 17520fc2-db00-4a52-8e1e-1ca89c30ce32
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '{"items":[{"name":"prod"}]}'
+  recorded_at: Tue, 09 Jan 2024 18:07:17 GMT
+recorded_with: VCR 6.2.0

data/fixtures/vcr_cassettes/labels/without_name_param.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://inbox.azconfig.io/labels?api-version=1.0&name=*
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Ms-Date:
+      - Tue, 09 Jan 2024 18:03:48 GMT
+      X-Ms-Content-Sha256:
+      - 47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=
+      Authorization:
+      - HMAC-SHA256 Credential=TjvF&SignedHeaders=x-ms-date;host;x-ms-content-sha256&Signature=N9CYXeOBBH17GWPlFtWGDYvMSocSlHH6uMTVZZ+CbnE=
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - inbox.azconfig.io
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 09 Jan 2024 18:03:49 GMT
+      Content-Type:
+      - application/vnd.microsoft.appconfig.labelset+json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Sync-Token:
+      - zAJw6V16=NjoxMyM1NDI0NTQ2;sn=5424546
+      X-Ms-Request-Id:
+      - 59a9f83f-cd5d-48d9-9e55-d8740c3fc7c0
+      X-Ms-Correlation-Request-Id:
+      - 59a9f83f-cd5d-48d9-9e55-d8740c3fc7c0
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '{"items":[{"name":null},{"name":"prod"},{"name":"test"}]}'
+  recorded_at: Tue, 09 Jan 2024 18:03:49 GMT
+recorded_with: VCR 6.2.0

data/lib/azure_app_config/base.rb

@@ -37,6 +37,14 @@ module AzureAppConfig
       parse_fetch_response response
     end
 
+    def labels(name: nil)
+      name, _ = normalise_parameters(name: name, label: nil)
+      path = "/labels"
+
+      query_params = URI.encode_www_form(name: name.join(","))
+      parse_labels_response client.get(path, query_params)
+    end
+
     def keys(name: nil)
       name, = normalise_parameters(name: name, label: nil)
       path = "/keys"
@@ -120,5 +128,9 @@ module AzureAppConfig
       data = JSON.parse(response.body)
       data["items"].map { |item| item["name"].gsub(key_prefix, "") }
     end
+
+    def parse_labels_response(response)
+      JSON.parse(response.body)["items"].map { |item| item["name"] }
+    end
   end
 end

data/lib/azure_app_config.rb

@@ -3,7 +3,7 @@
 require_relative "azure_app_config/base"
 
 module AzureAppConfig
-  VERSION = "1.0"
+  VERSION = "1.1.0"
 
   class InvalidTypeError < StandardError; end
   class ExceededLimitError < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure_app_config
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.1.0
 platform: ruby
 authors:
 - Tejas Shetty
@@ -38,6 +38,9 @@ files:
 - fixtures/vcr_cassettes/keys/with_name_param_as_array.yml
 - fixtures/vcr_cassettes/keys/with_name_param_as_string.yml
 - fixtures/vcr_cassettes/keys/without_name_param.yml
+- fixtures/vcr_cassettes/labels/with_name_param_as_array.yml
+- fixtures/vcr_cassettes/labels/with_name_param_as_string.yml
+- fixtures/vcr_cassettes/labels/without_name_param.yml
 - lib/azure_app_config.rb
 - lib/azure_app_config/base.rb
 - lib/azure_app_config/client.rb