stability_sdk 0.2.12 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5aac33cb8d504aab26b515dc2fa6bd9d76c70829a0aa706eabc6be39043b143
-  data.tar.gz: ca6a3cd1cd24763a9f9427132a4e8fde4c688d9bc9d3409ef921139fa62fa232
+  metadata.gz: 3e707d41b381676dfbc958975bae028b82a52a7828529c52db7809db125791e9
+  data.tar.gz: 9e7aafbd1c0e5638ad2bc860312e55a0b2973ec3c8423fa050730cfa15887efa
 SHA512:
-  metadata.gz: 95b76f6caf8e5a32af792cc0d284f81b76c7e38c682b24a5fc91204b3373096a47a98ab1ee6f0e32cbbd2039ad6b57c920c262661cda221c54eac529bd54e51a
-  data.tar.gz: f196c8b879b36e69c84d40c2528fd9fbf7f07e1ae6eec9c4a996a66a8a73841ea50d73d8ca941b7813ca9d5fbada94140143619bdb841de4ce9f71316af1303e
+  metadata.gz: 37cb8a18a1accb3cf30f6dc780781f71dfe75ad648713a2c335d1b2be41f7546c0450d88ec0ae833354db24a3d3659fe0ac8163d1f3a1a076f08e8e344282c9c
+  data.tar.gz: aa66ce05d53d3d5bd6aa661f752a5d71f61c9835804d69f38834e07bc4e5259d971816eb4d4061264cfadc9a825a425b0469c794369eb48c1080cdbf1d1342d3

data/README.md

@@ -107,23 +107,29 @@ client.generate(prompt, options) do |answer|
 end
 ```
 
-### [Unstable] Dashboard API
-
-**This feature is in a very early stage of development.**
+### Dashboard API
 
 Dashboard API is a way to interact with DreamStudio Web UIs, such as getting user info, payment info, etc.
 
-Currently, there is no canonical way to get the API key for the Dashboard API. You can retrieve the key by logging in to the [DreamStudio Web page](https://beta.dreamstudio.ai/dream) and inspect request the authorization header with Chrome Developer Tool. Please be aware that how to refresh the key or an expiration period is unknown. See also https://github.com/Stability-AI/stability-sdk/issues/23
+Currently, the API key is only allowed as read-only. And this client supports only GetMe and GetOrganization actions. See also https://github.com/Stability-AI/stability-sdk/issues/23
 
 ```sh
 # get user info
-STABILITY_SDK_DASHBOARD_API_KEY=YOUR_API_KEY stability-dashboard-client-unstable get_me
+STABILITY_SDK_DASHBOARD_API_KEY=YOUR_API_KEY stability-dashboard-client get_me
 
 # get organization info
-STABILITY_SDK_DASHBOARD_API_KEY=YOUR_API_KEY stability-dashboard-client-unstable get_organization
+STABILITY_SDK_DASHBOARD_API_KEY=YOUR_API_KEY stability-dashboard-client get_organization
 
 # i.e, get remaining balance
-STABILITY_SDK_DASHBOARD_API_KEY=YOUR_API_KEY stability-dashboard-client-unstable get_organization | jq .paymentInfo.balance
+STABILITY_SDK_DASHBOARD_API_KEY=YOUR_API_KEY stability-dashboard-client get_organization | jq .paymentInfo.balance
+```
+
+```ruby
+require "stability_sdk"
+
+client = StabilitySDK::DashboardClient.new(api_key: "your api key")
+res = client.get_organization
+p res.payment_info.balance  # prints a remaining balance
 ```
 
 ## Development

data/exe/{stability-dashboard-client-unstable → stability-dashboard-client}

@@ -33,7 +33,7 @@ class CLI < Thor
     api_key = ENV["STABILITY_SDK_DASHBOARD_API_KEY"] if ENV["STABILITY_SDK_DASHBOARD_API_KEY"]
     raise StabilitySDK::InsufficientParameter, "api key is required" if api_key.nil?
 
-    return StabilitySDK::Unstable::DashboardClient.new(api_key: api_key)
+    return StabilitySDK::DashboardClient.new(api_key: api_key)
   end
 end
 

data/lib/stability_sdk/{unstable/dashboard_client.rb → dashboard_client.rb}

@@ -1,7 +1,7 @@
 require "grpc"
 require "dashboard_services_pb"
 
-module StabilitySDK::Unstable
+module StabilitySDK
   class DashboardClient
     DEFAULT_API_HOST = "grpc.stability.ai:443"
 

data/lib/stability_sdk/version.rb

@@ -1,3 +1,3 @@
 module StabilitySDK
-  VERSION = "0.2.12"
+  VERSION = "0.3.0"
 end

data/lib/stability_sdk.rb

@@ -1,7 +1,7 @@
 require "stability_sdk/version"
 require "stability_sdk/client"
 require "stability_sdk/cli"
-require "stability_sdk/unstable/dashboard_client"
+require "stability_sdk/dashboard_client"
 
 module StabilitySDK
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stability_sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 0.3.0
 platform: ruby
 authors:
 - Kosei Moriyama
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-31 00:00:00.000000000 Z
+date: 2022-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -92,7 +92,7 @@ email:
 - cou929@gmail.com
 executables:
 - stability-client
-- stability-dashboard-client-unstable
+- stability-dashboard-client
 extensions: []
 extra_rdoc_files: []
 files:
@@ -106,7 +106,7 @@ files:
 - bin/console
 - bin/setup
 - exe/stability-client
-- exe/stability-dashboard-client-unstable
+- exe/stability-dashboard-client
 - lib/dashboard_pb.rb
 - lib/dashboard_services_pb.rb
 - lib/generation_pb.rb
@@ -114,7 +114,7 @@ files:
 - lib/stability_sdk.rb
 - lib/stability_sdk/cli.rb
 - lib/stability_sdk/client.rb
-- lib/stability_sdk/unstable/dashboard_client.rb
+- lib/stability_sdk/dashboard_client.rb
 - lib/stability_sdk/version.rb
 - stability_sdk.gemspec
 homepage: https://github.com/cou929/stability-sdk-ruby