addons-api 1.0.5 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a4081270b247ebcecee38930b50eb35c55b6e9232d7af621662500dfd88f172
-  data.tar.gz: cb5b079d9661d102ed5806556554fc8e8907bff70682cabed733343d31dd1088
+  metadata.gz: 00a56abad0f35243e4cdb784c6cc2002aa08280fbaa578cf5f370389abbc37d1
+  data.tar.gz: 49efbe2bca086b8b5a41904a77c60cb441f55800b25e1fe286757c1667649464
 SHA512:
-  metadata.gz: 46a81fb7b5b76c567c72ecaf9b849c250fa7699cb3e4d4086d0cc14737fc75f1389e8222e20c5e5bb62541f135027750d5697073699b08b641afd5a296561dc3
-  data.tar.gz: a467fc67ee16b66d97ddf5746e48bdbded81f61e68bcf492ab096584c2daa47fe40117227bec72c48f9993dbc294a212d3786e4811cc833f05ac8a87191e3796
+  metadata.gz: c91634a84c28abd7484a99073319c2db23e866e6ae2c7c67c9745461f260c0b4e3228848429c4ac74605c20cbcb493c7cd7a05c09fcd3c102595fb3bb68d99ea
+  data.tar.gz: 040e96fda608dd0fbfb0a5802051001cac96e0a1203bc512e066ff8c8f21db582aec8878656ec7a56b59d683f3526548a8d29ccbe43a179331797fd16f5c1cb8

data/.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    versioning-strategy: increase
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    labels:
+      - "dependencies"
+    open-pull-requests-limit: 100
+    pull-request-branch-name:
+      separator: "-"
+    ignore:
+      - dependency-name: "fs-extra"
+      - dependency-name: "*"
+        update-types: ["version-update:semver-major"]

data/.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: release-ruby
+
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  release-please:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+    - uses: google-github-actions/release-please-action@v4
+      id: release
+      with:
+        token: ${{secrets.RELEASE_PLEASE_GITHUB_TOKEN}}
+        config-file: release-please-config.json
+    
+    # Checkout code if release was created
+    - uses: actions/checkout@v3
+      if: ${{ steps.release.outputs.release_created }}
+    
+    # Set up Ruby if a release was created
+    - name: Set up Ruby 3.2
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2
+      if: ${{ steps.release.outputs.release_created }}
+    
+    # Bundle install if a release was created
+    - run: bundle install
+      if: ${{ steps.release.outputs.release_created }}
+    
+    # Publish to RubyGems if a release was created
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+      if: ${{ steps.release.outputs.release_created }}

data/.gitignore

@@ -1 +1,2 @@
 Gemfile.lock
+*.gem

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.0.9"
+}

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## [1.0.9](https://github.com/addonsio/addons-ruby/compare/addons-api-v1.0.8...addons-api/v1.0.9) (2024-02-08)
+
+
+### Bug Fixes
+
+* initial commit ([46c3542](https://github.com/addonsio/addons-ruby/commit/46c3542a2b9dc6ab87490b63aa790a159e37191a))
+* Publish to RubyGems with GH actions ([df667cc](https://github.com/addonsio/addons-ruby/commit/df667ccbbaab96c80bbe8ddf59ee03a79a350c43))
+
+## [1.0.8](https://github.com/addonsio/ruby-sdk/compare/v1.0.7...v1.0.8) (2023-04-03)
+
+
+### Bug Fixes
+
+* Publish to RubyGems with GH actions ([df667cc](https://github.com/addonsio/ruby-sdk/commit/df667ccbbaab96c80bbe8ddf59ee03a79a350c43))
+
+## 1.0.7 (2023-04-03)
+
+
+### Bug Fixes
+
+* initial commit ([46c3542](https://github.com/addonsio/ruby-sdk/commit/46c3542a2b9dc6ab87490b63aa790a159e37191a))

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Addons.io, INC
+
+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

@@ -1,7 +1,7 @@
 # Addons.io API Ruby SDK
 
-Ruby HTTP client for the Addons API.
+Ruby HTTP client for the Addons.io API.
 
 ## Similarity to other PaaS
 
-- The [Heroku](https://heroku.com) API. Add-ons will find that they need little modifications to their code when switching to the Addons.io platform.
+- The [Heroku](https://heroku.com) API. Addons will find that they need little modifications to their code when switching to the Addons.io platform.

data/addons-api.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['moty@crazyantlabs.com']
   spec.description   = 'Ruby HTTP client for the Addons.io API.'
   spec.summary       = 'Ruby HTTP client for the Addons.io API. Learn more on https://addons.io'
-  spec.homepage      = 'https://github.com/addonsio/sdk/ruby'
+  spec.homepage      = 'https://github.com/addonsio/addons-ruby'
   spec.license       = 'MIT'
 
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', "~> 0.9"
   spec.add_development_dependency 'pry', "~> 0.13"
   spec.add_development_dependency 'netrc', "~> 0.11"
-  spec.add_development_dependency 'rspec', "~> 3.10"
+  spec.add_development_dependency 'rspec', "~> 3.12"
 
   spec.add_dependency "oj", "~> 3.14"
   spec.add_dependency "rest-client", "~> 2.1"

data/lib/addons-api/client.rb

@@ -100,13 +100,18 @@ module AddonsApi
         @oauth_resource ||= OAuth.new(self)
       end
 
+      # AddonService resource
+      def addon_service
+        @addon_service_resource ||= AddonService.new(self)
+      end
+
       # Team resource
       def team
         @team_resource ||= Team.new(self)
       end
     end
 
-    # Add-on services represent add-ons that may be provisioned for apps.
+    # Addon services represent addons that may be provisioned for apps.
     class OAuth
       BASE_PATH = "oauth" 
 
@@ -148,6 +153,58 @@ module AddonsApi
       end
     end
 
+    class AddonService
+      BASE_PATH = "addon-services"
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list()
+       @client.request(:get, "#{BASE_PATH}")
+      end
+
+      def info(addon_service_id)
+        @client.request(:get, "#{BASE_PATH}/#{addon_service_id}")
+      end
+
+      def plan
+        @plan_resource ||= AddonServicePlan.new(@client)
+      end
+
+      def field
+        @field_resource ||= AddonServiceField.new(@client)
+      end
+
+      class AddonServicePlan
+        def initialize(client)
+          @client = client
+        end
+
+        def list(addon_service_id)
+          @client.request(:get, "#{BASE_PATH}/#{addon_service_id}/plans")
+        end
+
+        def info(addon_service_id, addon_service_plan_id)
+          @client.request(:get, "#{BASE_PATH}/#{addon_service_id}/plans/#{addon_service_plan_id}")
+        end
+      end
+
+      class AddonServiceField
+        def initialize(client)
+          @client = client
+        end
+
+        def list(addon_service_id)
+          @client.request(:get, "#{BASE_PATH}/#{addon_service_id}/fields")
+        end
+
+        def info(addon_service_id, addon_service_field_id)
+          @client.request(:get, "#{BASE_PATH}/#{addon_service_id}/fields/#{addon_service_plan_id}")
+        end
+      end
+    end
+
     class Team
       BASE_PATH = "teams"
 
@@ -167,7 +224,7 @@ module AddonsApi
         @member_resource ||= Member.new(@client)
       end
 
-      # Add-on resource
+      # Addon resource
       def addon
         @addon_resource ||= Addon.new(@client)
       end
@@ -184,7 +241,7 @@ module AddonsApi
         end
       end
       
-      # Add-on
+      # Addon
       class Addon
         def initialize(client)
           @client = client
@@ -206,56 +263,68 @@ module AddonsApi
           @client.request(:get, "", base_url: callback_url)
         end
 
-        # Configuration of an Add-on
+        def create(team_id, body = {})
+          @client.request(:post, "#{BASE_PATH}/#{team_id}/addons", body: body)
+        end
+
+        def delete(team_id, addon_id)
+          @client.request(:delete, "#{BASE_PATH}/#{team_id}/addons/#{addon_id}")
+        end
+
+        def update(team_id, addon_id, body = {})
+          @client.request(:patch, "#{BASE_PATH}/#{team_id}/addons/#{addon_id}", body: body)
+        end
+
+        # Configuration of an Addon
         class Config
           def initialize(client)
             @client = client
           end
 
-          # Get the configuration of an add-on.
+          # Get the configuration of an addon.
           def list(team_id, addon_id)
             @client.request(:get, "#{BASE_PATH}/#{team_id}/addons/#{addon_id}/config")
           end
 
-          # Get the configuration of an add-on with callback URL.
+          # Get the configuration of an addon with callback URL.
           def list_with_callback_url(callback_url)
             @client.request(:get, "config", base_url: callback_url)
           end
 
-          # Update the configuration of an add-on.
+          # Update the configuration of an addon.
           def update(team_id, addon_id, body = {})
             @client.request(:patch, "#{BASE_PATH}/#{team_id}/addons/#{addon_id}/config", body: body)
           end
 
-          # Update the configuration of an add-on with callback URL.
+          # Update the configuration of an addon with callback URL.
           def update_with_callback_url(callback_url, body = {})
             @client.request(:patch, "config", base_url: callback_url, body: body)
           end
         end
 
-        # Add-on Actions are lifecycle operations for add-on provisioning and deprovisioning. 
-        # They allow add-on providers to (de)provision add-ons in the background and then report back when (de)provisioning is complete.
+        # Addon Actions are lifecycle operations for addon provisioning and deprovisioning. 
+        # They allow addon providers to (de)provision addons in the background and then report back when (de)provisioning is complete.
         class Action
           def initialize(client)
             @client = client
           end
 
-          # Mark an add-on as provisioned.
+          # Mark an addon as provisioned.
           def provision(team_id, addon_id)
             @client.request(:post, "#{BASE_PATH}/#{team_id}/addons/#{addon_id}/actions/provision")
           end
 
-          # Mark an add-on as provisioned with callback URL.
+          # Mark an addon as provisioned with callback URL.
           def provision_with_callback_url(callback_url)
             @client.request(:post, "actions/provision", base_url: callback_url)
           end
 
-          # Mark an add-on as deprovisioned.
+          # Mark an addon as deprovisioned.
           def deprovision(team_id, addon_id)
             @client.request(:post, "#{BASE_PATH}/#{team_id}/addons/#{addon_id}/actions/deprovision")
           end
 
-          # Mark an add-on as deprovisioned with callback URL.
+          # Mark an addon as deprovisioned with callback URL.
           def deprovision_with_callback_url(callback_url)
             @client.request(:post, "actions/deprovision", base_url: callback_url)
           end

data/lib/addons-api/version.rb

@@ -1,3 +1,3 @@
 module AddonsApi
-  VERSION = '1.0.5'
+  VERSION = '1.0.9'
 end

data/release-please-config.json

@@ -0,0 +1,15 @@
+{
+  "packages": {
+    ".": {
+      "package-name": "addons-api",
+      "changelog-path": "CHANGELOG.md",
+      "release-type": "ruby",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": false,
+      "draft": false,
+      "prerelease": false,
+      "version-file": "lib/addons-api/version.rb"
+    }
+  },
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: addons-api
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.9
 platform: ruby
 authors:
 - motymichaely
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-02 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -129,18 +129,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
+- ".release-please-manifest.json"
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - addons-api.gemspec
 - lib/addons-api.rb
 - lib/addons-api/client.rb
 - lib/addons-api/version.rb
-homepage: https://github.com/addonsio/sdk/ruby
+- release-please-config.json
+homepage: https://github.com/addonsio/addons-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -155,8 +161,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.4.19
+signing_key: 
 specification_version: 4
 summary: Ruby HTTP client for the Addons.io API. Learn more on https://addons.io
 test_files: []