addons-api 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a4081270b247ebcecee38930b50eb35c55b6e9232d7af621662500dfd88f172
+  data.tar.gz: cb5b079d9661d102ed5806556554fc8e8907bff70682cabed733343d31dd1088
+SHA512:
+  metadata.gz: 46a81fb7b5b76c567c72ecaf9b849c250fa7699cb3e4d4086d0cc14737fc75f1389e8222e20c5e5bb62541f135027750d5697073699b08b641afd5a296561dc3
+  data.tar.gz: a467fc67ee16b66d97ddf5746e48bdbded81f61e68bcf492ab096584c2daa47fe40117227bec72c48f9993dbc294a212d3786e4811cc833f05ac8a87191e3796

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,7 @@
+# Addons.io API Ruby SDK
+
+Ruby HTTP client for the Addons 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.

data/addons-api.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'addons-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'addons-api'
+  spec.version       = AddonsApi::VERSION
+  spec.authors       = ['motymichaely']
+  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.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', "~> 2.3"
+  spec.add_development_dependency 'rake', "~> 13.0"
+  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_dependency "oj", "~> 3.14"
+  spec.add_dependency "rest-client", "~> 2.1"
+
+end

data/lib/addons-api/client.rb

@@ -0,0 +1,267 @@
+require 'addons-api/version'
+require 'rest-client'
+require 'oj'
+require 'open-uri'
+
+module AddonsApi
+  class Client
+
+    # Get a Client configured to use Token authentication.
+    def self.connect(options=nil)
+      options = sanitize_options(options)
+      Wrapper.new(options)
+    end
+
+    # Get a Client configured to use Token authentication.
+    def self.connect_with_token(token, options=nil)
+      options = sanitize_options(options)
+      options[:token] = token
+      Wrapper.new(options)
+    end
+
+    def self.sanitize_options(options)
+      return {} if options.nil?
+
+      final_options = {}
+      final_options[:auto_paginate] = options[:auto_paginate] if options[:auto_paginate]
+      final_options[:headers] = options[:headers] if options[:headers]
+      final_options[:timeout] = options[:timeout] if options[:timeout]
+      final_options[:token] = options[:token] if options[:token]
+      final_options[:base_url] = options[:base_url] if options[:base_url]
+      final_options
+    end
+
+    #
+    # Addons.io API wrapper
+    #
+    class Wrapper
+      BASE_URL = %(https://api.addons.io/).freeze
+      API_VERSION = %(2022-12-01).freeze
+
+      HEADERS = {
+        'X-Addons-Api-Version' => API_VERSION,
+        'Accept'          => 'application/json',
+        'Content-Type'    => 'application/json',
+        'User-Agent'      => "addons-api/#{AddonsApi::VERSION}"
+      }.freeze
+
+      OPTIONS = {
+        :auto_paginate  => true,
+        :headers => {},
+        :logger  => Logger.new(STDERR),
+        :timeout => 10 # seconds
+      }.freeze
+
+      def initialize(options={})
+        @options = OPTIONS.merge(options)
+
+        @token = @options.delete(:token)
+        @base_url = @options.delete(:base_url) || BASE_URL
+
+        @options[:headers] = HEADERS
+        if @token
+          @options[:headers] = @options[:headers].merge({
+            'Authorization' => "Bearer #{@token}",
+          }).merge(@options[:headers])
+        end
+      end
+
+      def request(method, path, body: {}, query: {}, base_url: nil)
+
+        base_url = base_url || @base_url
+        url = "#{base_url.chomp('/')}/#{path}"
+        query_string = URI.encode_www_form(query)
+
+        unless query_string.empty?
+          if url.include?('?')
+            url = url + '&' + query_string
+          else
+            url = url + '?' + query_string
+          end
+        end
+
+        # TODO: How do we paginate these requests??
+        result = RestClient::Request.execute(
+          method:   method, 
+          url:      url,
+          params:   query,
+          payload:  Oj.dump(body, mode: :compat),
+          headers:  @options[:headers],
+          timeout:  @options[:timeout],
+          log:      @options[:logger]
+        )
+        Oj.load(result.body, symbol_keys: true)
+      rescue RestClient::BadRequest => e
+        raise
+      end
+
+      # OAuth resource
+      def oauth
+        @oauth_resource ||= OAuth.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.
+    class OAuth
+      BASE_PATH = "oauth" 
+
+      def initialize(client)
+        @client = client
+      end
+
+      def token
+        @token_resource ||= Token.new(@client)
+      end
+
+      # Token
+      class Token
+        def initialize(client)
+          @client = client
+        end
+
+        def create(client, code)
+          path =  "#{BASE_PATH}/token"
+          token = @client.request(:post, path, body: { 
+            code: code,
+            grant_type: "authorization_code",
+            client_id: client[:id],
+            client_secret: client[:secret],
+          })
+          token
+        end
+
+        def refresh(client, refresh_token)
+          path =  "#{BASE_PATH}/token"
+          token = @client.request(:post, path, body: { 
+            refresh_token: refresh_token,
+            grant_type: "refresh_token",
+            client_id: client[:id],
+            client_secret: client[:secret],
+          })
+          token
+        end
+      end
+    end
+
+    class Team
+      BASE_PATH = "teams"
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list()
+       @client.request(:get, "#{BASE_PATH}")
+      end
+
+      def info(team_id)
+        @client.request(:get, "#{BASE_PATH}/#{team_id}")
+      end
+
+      def member
+        @member_resource ||= Member.new(@client)
+      end
+
+      # Add-on resource
+      def addon
+        @addon_resource ||= Addon.new(@client)
+      end
+
+      # A member is a user with access to a team.
+      class Member
+        def initialize(client)
+          @client = client
+        end
+
+        # List members of the team
+        def list(team_id)
+          @client.request(:get, "#{BASE_PATH}/#{team_id}/members")
+        end
+      end
+      
+      # Add-on
+      class Addon
+        def initialize(client)
+          @client = client
+        end
+
+        def action
+          @action_resource ||= Action.new(@client)
+        end
+
+        def config
+          @config_resource ||= Config.new(@client)
+        end
+
+        def info(team_id, addon_id)
+          @client.request(:get, "#{BASE_PATH}/#{team_id}/addons/#{addon_id}")
+        end
+
+        def info_by_callback_url(callback_url)
+          @client.request(:get, "", base_url: callback_url)
+        end
+
+        # Configuration of an Add-on
+        class Config
+          def initialize(client)
+            @client = client
+          end
+
+          # Get the configuration of an add-on.
+          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.
+          def list_with_callback_url(callback_url)
+            @client.request(:get, "config", base_url: callback_url)
+          end
+
+          # Update the configuration of an add-on.
+          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.
+          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.
+        class Action
+          def initialize(client)
+            @client = client
+          end
+
+          # Mark an add-on 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.
+          def provision_with_callback_url(callback_url)
+            @client.request(:post, "actions/provision", base_url: callback_url)
+          end
+
+          # Mark an add-on 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.
+          def deprovision_with_callback_url(callback_url)
+            @client.request(:post, "actions/deprovision", base_url: callback_url)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/addons-api/version.rb

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

data/lib/addons-api.rb

@@ -0,0 +1,6 @@
+# Ruby HTTP client for the Addons.io API.
+module AddonsApi
+end
+
+require 'addons-api/client'
+require 'addons-api/version'

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: addons-api
+version: !ruby/object:Gem::Version
+  version: 1.0.5
+platform: ruby
+authors:
+- motymichaely
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: netrc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Ruby HTTP client for the Addons.io API.
+email:
+- moty@crazyantlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- 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
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Ruby HTTP client for the Addons.io API. Learn more on https://addons.io
+test_files: []