spackle-ruby 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Bolder Research, LLC
+
+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

@@ -0,0 +1,79 @@
+# Spackle Ruby Library
+
+[![CI](https://github.com/spackleso/spackle-ruby/actions/workflows/test.yml/badge.svg)](https://github.com/spackleso/spackle-ruby/actions/workflows/test.yml)
+
+The Spackle Ruby library provides optimized access to billing aware flags created on the Spackle platform.
+
+## Documentation
+
+See the [Ruby API docs](https://docs.spackle.so/ruby).
+
+## Setup
+
+### Install the Spackle library
+
+```sh
+gem install spackle-ruby
+```
+
+### Bundler
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'spackle'
+```
+
+### Configure your environment
+In order to use Spackle, you need to configure your API key on the `Spackle` module. You can find your API key in Spackle app [settings page](https://dashboard.stripe.com/settings/apps/so.spackle.stripe).
+
+```ruby
+require 'spackle'
+
+Spackle.api_key = "<api key>"
+```
+
+### Bootstrap the client (optional)
+
+The Spackle client requires a single initialization step that includes a network request. To front load this process, you can call the `bootstrap` method in your codebase.
+
+```ruby
+Spackle.bootstrap()
+```
+
+## Usage
+
+### Fetch a customer
+
+Spackle uses stripe ids as references to customer features.
+
+```ruby
+customer = Spackle::Customer.retrieve("cus_00000000")
+```
+
+### Verify feature access
+
+```ruby
+customer.enabled("feature_key")
+```
+
+### Fetch a feature limit
+
+```ruby
+customer.limit("feature_key")
+```
+
+## Logging
+The Spackle Ruby library emits logs as it performs various internal tasks. You can control the verbosity of Spackle's logging a few different ways:
+
+1. Set the environment variable SPACKLE_LOG to the value `debug`, `info`, or `error`
+
+   ```sh
+   $ export SPACKLE_LOG=debug
+   ```
+
+2. Set Spackle.log_level:
+
+   ```ruby
+   Spackle.log_level = 'debug'
+   ```

data/Rakefile

@@ -0,0 +1,7 @@
+require "rake/testtask"
+
+task default: %i[test]
+
+Rake::TestTask.new do |t|
+  t.pattern = "./test/**/*_test.rb"
+end

data/bin/spackle-console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "irb"
+require "irb/completion"
+
+require "#{::File.dirname(__FILE__)}/../lib/spackle"
+
+# Config IRB to enable --simple-prompt and auto indent
+IRB.conf[:PROMPT_MODE] = :SIMPLE
+IRB.conf[:AUTO_INDENT] = true
+
+puts "Loaded gem 'spackle'"
+
+IRB.start

data/lib/spackle/customer.rb

@@ -0,0 +1,38 @@
+module Spackle
+  class Customer
+    @data = nil
+
+    def self.retrieve(id)
+      Util.log_debug("Retrieving customer data for #{id}")
+      data = Spackle.client.get_item({
+        'CustomerId' => id
+      })
+      Util.log_debug("Retrieved customer data for #{id}: #{data}")
+      Customer.new(data)
+    end
+
+    def initialize(data)
+      @data = data
+    end
+
+    def enabled(key)
+      @data['features'].each do |f|
+        if f['key'] == key
+          return f['value_flag']
+        end
+      end
+
+      return false
+    end
+
+    def limit(key)
+      @data['features'].each do |f|
+        if f['key'] == key
+          return f['value_limit']
+        end
+      end
+
+      return 0
+    end
+  end
+end

data/lib/spackle/dynamodb.rb

@@ -0,0 +1,92 @@
+require 'aws-sdk'
+require 'net/http'
+require 'json'
+
+module Spackle
+  class DynamoDB
+    @client = nil
+    @identity_id = nil
+    @table_name = nil
+    @aws_region = nil
+
+    def initialize
+      @client = bootstrap_client
+    end
+
+    def get_item(key)
+      key = key.merge({
+        'AccountId' => @identity_id,
+      })
+
+      response = @client.get_item({
+        table_name: @table_name,
+        key: key
+      })
+
+      JSON.parse(response.item['State'])
+    end
+
+    private
+
+
+    def bootstrap_client
+      Util.log_debug('Bootstrapping DynamoDB client...')
+      uri = URI(Spackle.api_base + '/auth/session')
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+
+      request = Net::HTTP::Post.new(uri.path)
+      request['Authorization'] = 'Bearer ' + Spackle.api_key
+
+      response = https.request(request)
+      data = JSON.parse(response.body)
+      Util.log_debug("Created session: #{data}")
+
+      @identity_id = data['identity_id']
+      @table_name = data['table_name']
+      @aws_region = data['aws_region']
+
+      credentials = SpackleCredentials.new(
+        data['role_arn'],
+        data['token']
+      )
+
+      Aws::DynamoDB::Client.new(
+        region: @aws_region,
+        credentials: credentials,
+      )
+    end
+  end
+
+  class SpackleCredentials
+    include Aws::CredentialProvider
+    include Aws::RefreshingCredentials
+
+    @role_arn = nil
+    @token = nil
+
+    def initialize(role_arn, token)
+      @client = Aws::STS::Client.new(:credentials => false)
+      @role_arn = role_arn
+      @token = token
+      super()
+    end
+
+    private
+
+    def refresh
+      Util.log_debug('Refreshing DynamoDB credentials...')
+      c = @client.assume_role_with_web_identity({
+        role_arn: @role_arn,
+        role_session_name: Base64.strict_encode64(SecureRandom.uuid),
+        web_identity_token: @token
+      }).credentials
+      @credentials = Aws::Credentials.new(
+        c.access_key_id,
+        c.secret_access_key,
+        c.session_token
+      )
+      @expiration = c.expiration
+    end
+  end
+end

data/lib/spackle/spackle_configuration.rb

@@ -0,0 +1,21 @@
+require 'logger'
+
+module Spackle
+  class SpackleConfiguration
+    attr_accessor :api_key
+    attr_accessor :api_base
+    attr_accessor :log_level
+    attr_reader   :logger
+
+    def initialize
+      @api_base = 'https://api.spackle.so'
+      @log_level = Logger::INFO
+      @logger = Logger.new(STDOUT, level: @log_level)
+    end
+
+    def log_level=(level)
+      @log_level = level
+      @logger.level = level
+    end
+  end
+end

data/lib/spackle/util.rb

@@ -0,0 +1,15 @@
+module Spackle
+  module Util
+    def self.log_error(message)
+      Spackle.logger.error(message)
+    end
+
+    def self.log_info(message)
+      Spackle.logger.info(message)
+    end
+
+    def self.log_debug(message)
+      Spackle.logger.debug(message)
+    end
+  end
+end

data/lib/spackle.rb

@@ -0,0 +1,40 @@
+require 'logger'
+require 'forwardable'
+
+require 'spackle/customer'
+require 'spackle/dynamodb'
+require 'spackle/spackle_configuration'
+require 'spackle/util'
+
+module Spackle
+  @config = Spackle::SpackleConfiguration.new
+  @client = nil
+
+  LEVEL_DEBUG = Logger::DEBUG
+  LEVEL_ERROR = Logger::ERROR
+  LEVEL_INFO = Logger::INFO
+
+  class << self
+    extend Forwardable
+
+    attr_reader :config
+
+    def_delegators :@config, :api_key, :api_key=
+    def_delegators :@config, :api_base, :api_base=
+    def_delegators :@config, :log_level, :log_level=
+    def_delegators :@config, :logger, :logger=
+  end
+
+  def self.client
+    unless Spackle.api_key.nil?
+      @client ||= Spackle::DynamoDB.new()
+    end
+  end
+
+  def self.bootstrap
+    self.client
+    nil
+  end
+end
+
+Spackle.log_level = ENV["SPACKLE_LOG"] unless ENV["SPACKLE_LOG"].nil?

data/spackle.gemspec

@@ -0,0 +1,33 @@
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
+
+Gem::Specification.new do |s|
+  s.name          = "spackle-ruby"
+  s.version       = "0.0.1"
+  s.summary       = "Spackle Ruby gem"
+  s.description   = "Spackle is the easiest way to integrate your Ruby app with Stripe Billing." \
+                    "See https://www.spackle.so for details."
+  s.authors       = ["Spackle"]
+  s.email         = "support@spackle.so"
+  s.homepage      = "https://docs.spackle.so/ruby"
+  s.license       = "MIT"
+  s.metadata = {
+    "bug_tracker_uri" => "https://github.com/spackleso/spackle-ruby/issues",
+    "documentation_uri" => "https://docs.spackle.so/ruby",
+    "github_repo" => "ssh://github.com/spackleso/spackle-ruby",
+    "homepage_uri" => "https://docs.spackle.so/ruby",
+    "source_code_uri" => "https://github.com/spackleso/spackle-ruby",
+  }
+
+  ignored = Regexp.union(
+    /\A\.editorconfig/,
+    /\A\.git/,
+    /\A\.rubocop/,
+    /\A\.travis.yml/,
+    /\A\.vscode/,
+    /\Atest/
+  )
+  s.files = `git ls-files`.split("\n").reject { |f| ignored.match(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n")
+                                           .map { |f| ::File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: spackle-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Spackle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-08 00:00:00.000000000 Z
+dependencies: []
+description: Spackle is the easiest way to integrate your Ruby app with Stripe Billing.See
+  https://www.spackle.so for details.
+email: support@spackle.so
+executables:
+- spackle-console
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/spackle-console
+- lib/spackle.rb
+- lib/spackle/customer.rb
+- lib/spackle/dynamodb.rb
+- lib/spackle/spackle_configuration.rb
+- lib/spackle/util.rb
+- spackle.gemspec
+homepage: https://docs.spackle.so/ruby
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/spackleso/spackle-ruby/issues
+  documentation_uri: https://docs.spackle.so/ruby
+  github_repo: ssh://github.com/spackleso/spackle-ruby
+  homepage_uri: https://docs.spackle.so/ruby
+  source_code_uri: https://github.com/spackleso/spackle-ruby
+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.0.3.1
+signing_key: 
+specification_version: 4
+summary: Spackle Ruby gem
+test_files: []