kc-sdk-app 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de3af01fb20a50fbc26e6d78cb0d95693cca7deede1563146bdc4b03cae69de0
+  data.tar.gz: c743a784bc692abbf836afb0f3a2cceb8489df71255c994b593704d5c4382921
+SHA512:
+  metadata.gz: e42c164217f055843665eefc440e28d30ef5a039c43ffed613b7619af65665987c83479de62b53012176f1dc7d6cd242c94bdb62a0524daef38fdc4f714c2eb7
+  data.tar.gz: 75a5228b41710399b51ff61805528a0ccbb7a9c344dfee40d3b9d77f741c649e419c10ddd83ba62be25bca8c3e8cd2dcb3c9c6cc2c0529e8f4ca0f4d27dc84f8

data/.drone.yml

@@ -0,0 +1,90 @@
+---
+kind: pipeline
+name: publish
+
+clone:
+  depth: 1
+
+steps:
+- name: restore-bundle-cache
+  image: meltwater/drone-cache:latest
+  environment:
+    AWS_ACCESS_KEY_ID:
+      from_secret: CI_AWS_ACCESS_KEY_ID
+    AWS_SECRET_ACCESS_KEY:
+      from_secret: CI_AWS_SECRET_ACCESS_KEY
+  settings:
+    restore: true
+    cache_key: '{{ checksum "Gemfile.lock" }}'
+    bucket: drone-ci-cache-bucket
+    region: ap-northeast-1
+    mount:
+      - 'vendor/bundle'
+
+- name: build
+  image: ruby:2-alpine
+  commands:
+  - apk add --no-cache build-base git
+  - gem install bundler:2.3.14
+  - bundle install -j4
+  - rake build
+
+- name: rebuild-bundle-cache
+  image: meltwater/drone-cache:latest
+  environment:
+    AWS_ACCESS_KEY_ID:
+      from_secret: CI_AWS_ACCESS_KEY_ID
+    AWS_SECRET_ACCESS_KEY:
+      from_secret: CI_AWS_SECRET_ACCESS_KEY
+  settings:
+    rebuild: true
+    cache_key: '{{ checksum "Gemfile.lock" }}'
+    bucket: drone-ci-cache-bucket
+    region: ap-northeast-1
+    mount:
+      - 'vendor/bundle'
+  when:
+    status:
+    - success
+    - failure
+
+- name: deployment
+  image: ruby:alpine
+  environment:
+    PUSH_KEY:
+      from_secret: PUSH_KEY
+  commands:
+  - mkdir -p ~/.gem
+  - touch ~/.gem/credentials
+  - echo -e "$PUSH_KEY" > ~/.gem/credentials
+  - chmod 0600 ~/.gem/credentials
+  - gem push --key push_key pkg/*.gem
+
+trigger:
+  event:
+  - tag
+
+---
+kind: pipeline
+name: after
+
+clone:
+  disable: true
+
+steps:
+- name: notify
+  image: plugins/slack
+  settings:
+    icon_emoji: ":rocket:"
+    webhook:
+      from_secret: SLACK_WEBHOOK
+
+depends_on:
+- publish
+
+trigger:
+  event:
+  - tag
+  status:
+  - success
+  - failure

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# rbenv
+.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+
+## v0.2.0 / 2022-09-12
+### Added
+- Add apps api
+
+## v0.1.0 / 2022-08-21
+### Added
+- Create project

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kc-sdk-app.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    kc-sdk-app (0.2.0)
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  kc-sdk-app!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-its
+  simplecov (~> 0.21.2)
+
+BUNDLED WITH
+   2.3.14

data/README.md

@@ -0,0 +1,81 @@
+[![Build Status](https://ci.kabob.io/api/badges/kabobcompany/kc-sdk-app-ruby/status.svg)](https://ci.kabob.io/kabobcompany/kc-sdk-app-ruby)
+# kc-sdk-app
+Provides kabob cloud app api client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kc-sdk-app'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kc-sdk-app
+
+For rails, create config `config/initializers/kc_sdk_app.rb`
+
+```ruby
+KcSdkApp.configure do |config|
+  # kabob cloud api url, default: https://cloud.kabob.io
+  config.api_url = 'https://cloud.kabob.io'
+
+  # you have to set your app access token
+  config.access_token = 'YOUR_APP_ACCESS_TOKEN'
+
+  # you can set a logger if you want logging api request
+  # config.logger = Rails.logger
+end
+```
+
+## Usage
+
+[Api](#api)
+
+### Api
+#### Apps
+##### current
+Get current app
+```ruby
+result = KcSdkApp.api.apps.current
+# { "uid": 'kabob.lookr' }
+```
+
+
+#### Orders
+##### surplus
+Get surplus
+```ruby
+result = KcSdkApp.api.orders.surplus(company_id: 1, plan: 'go', scope: 'point')
+# { "data": 10, is_trial: false }
+```
+
+```ruby
+result = KcSdkApp.api.orders.surplus(company_id: 1, plan: 'go', scope: 'license')
+# { "data": 10, is_trial: false, active_until: '2030-01-01 00:00:00' }
+```
+
+##### consuming
+Consume order balance
+```ruby
+result = KcSdkApp.api.orders.consuming(company_id: 1, plan: 'go', scope: 'point', quantity: 1, taken_at: '2020-12-25 00:00:00 UTC', uid: 'uid')
+# { "meta": { "code": 0 } }
+```
+
+#### Switch App
+The default app access token is the one defined in configuration.
+
+If you want to request data as other apps, new an api instance with other access_token.
+```ruby
+kc_api = KcSdkApp::Api.new(access_token: 'OTHER_APP_ACCESS_TOKEN')
+kc_api.apps.current
+# { "uid": 'kabob.other_app' }
+```
+
+## Contact
+The project's website is located at https://github.com/kabobcompany/kc-sdk-app-ruby

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kabob/cloud/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kc-sdk-app.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kc-sdk-app/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kc-sdk-app"
+  spec.version       = KcSdkApp::VERSION
+  spec.authors       = ["Yi-Cyuan Chen"]
+  spec.email         = ["emn178@gmail.com"]
+
+  spec.summary       = %q{Kabob cloud client library.}
+  spec.description   = %q{Kabob cloud client library.}
+  spec.homepage      = "https://github.com/kabobcompany/kc-sdk-app-ruby"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/kabobcompany/kc-sdk-app-ruby"
+    spec.metadata["changelog_uri"] = "https://github.com/kabobcompany/kc-sdk-app-ruby/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|tmp)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "simplecov", "~> 0.21.2"
+end

data/lib/kc-sdk-app/api/apps.rb

@@ -0,0 +1,10 @@
+module KcSdkApp
+  class Api
+    class Apps < Base
+      def current
+        resp = resource['v1/apps/current'].get
+        JSON.parse(resp.body)
+      end
+    end
+  end
+end

data/lib/kc-sdk-app/api/base.rb

@@ -0,0 +1,19 @@
+module KcSdkApp
+  class Api
+    class Base
+      def initialize(api)
+        @api = api
+      end
+
+      def resource
+        @api.resource
+      end
+
+      def validate_keys!(hash, keys)
+        keys.each do |k|
+          raise ArgumentError, "required keywords: #{keys.join(', ')}" unless hash.key?(k)
+        end
+      end
+    end
+  end
+end

data/lib/kc-sdk-app/api/orders.rb

@@ -0,0 +1,17 @@
+module KcSdkApp
+  class Api
+    class Orders < Base
+      def surplus(query)
+        validate_keys!(query, %i[company_id plan scope])
+        resp = resource['v1/orders/surplus'].get({ params: query })
+        JSON.parse(resp.body)
+      end
+
+      def consuming(data)
+        validate_keys!(data, %i[company_id plan scope quantity taken_at uid])
+        resp = resource['v1/orders/consuming'].post(data)
+        JSON.parse(resp.body)
+      end
+    end
+  end
+end

data/lib/kc-sdk-app/api.rb

@@ -0,0 +1,25 @@
+require 'kc-sdk-app/api/base'
+require 'kc-sdk-app/api/orders'
+require 'kc-sdk-app/api/apps'
+
+module KcSdkApp
+  class Api
+    attr_accessor :access_token
+    attr_accessor :orders
+    attr_accessor :apps
+
+    def initialize(access_token: KcSdkApp.configuration.access_token)
+      self.access_token = access_token
+      self.orders = KcSdkApp::Api::Orders.new(self)
+      self.apps = KcSdkApp::Api::Apps.new(self)
+    end
+
+    def resource
+      @resource ||= RestClient::Resource.new(
+        "#{KcSdkApp.configuration.api_url}/api/app",
+        log: KcSdkApp.configuration.logger,
+        headers: { 'Authorization': "Bearer #{self.access_token}" }
+      )
+    end
+  end
+end

data/lib/kc-sdk-app/configuration.rb

@@ -0,0 +1,12 @@
+module KcSdkApp
+  class Configuration
+    attr_accessor :api_url, :access_token, :logger
+
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      @api_url ||= 'https://cloud.kabob.io'
+    end
+  end
+end

data/lib/kc-sdk-app/engine.rb

@@ -0,0 +1,4 @@
+module KcSdkApp
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/kc-sdk-app/version.rb

@@ -0,0 +1,3 @@
+module KcSdkApp
+  VERSION = '0.2.0'.freeze
+end

data/lib/kc-sdk-app.rb

@@ -0,0 +1,20 @@
+require 'rest-client'
+require 'kc-sdk-app/version'
+require 'kc-sdk-app/configuration'
+require 'kc-sdk-app/api'
+
+require 'kc-sdk-app/engine' if defined?(::Rails)
+
+module KcSdkApp
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.api
+    @api ||= Api.new
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: kc-sdk-app
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Yi-Cyuan Chen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+description: Kabob cloud client library.
+email:
+- emn178@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".drone.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kc-sdk-app.gemspec
+- lib/kc-sdk-app.rb
+- lib/kc-sdk-app/api.rb
+- lib/kc-sdk-app/api/apps.rb
+- lib/kc-sdk-app/api/base.rb
+- lib/kc-sdk-app/api/orders.rb
+- lib/kc-sdk-app/configuration.rb
+- lib/kc-sdk-app/engine.rb
+- lib/kc-sdk-app/version.rb
+homepage: https://github.com/kabobcompany/kc-sdk-app-ruby
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/kabobcompany/kc-sdk-app-ruby
+  source_code_uri: https://github.com/kabobcompany/kc-sdk-app-ruby
+  changelog_uri: https://github.com/kabobcompany/kc-sdk-app-ruby/CHANGELOG.md
+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.1.6
+signing_key:
+specification_version: 4
+summary: Kabob cloud client library.
+test_files: []