bunny_app 1.18.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53806b76d7adaa8bdb227a84f6a192c9044c0d21cc04d845a827c9222be45e16
+  data.tar.gz: 8046c1b3f43417f98ee878f2288b744effdb79a8dae47cc2bfa368057914d4f2
+SHA512:
+  metadata.gz: 16a8f959c2b08b6e75b7a0d2aa70bcb4fb00c942e7f3e5ceadd4c3216b70c0ff1035d23fb0a43194612ca2e650360d6d6bd9890cb0d7fbec7b73a7454253e1db
+  data.tar.gz: 1b937249175ea0678f71dc1326e6f47507982ffa5bc90905156886ec9c661b1a97bf9919237098b87fc144287dd673fb5f72916c6dbbd9e9e2f853ae9c2a626a

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 (10-Mar-2022)
+
+- Initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Bunny
+
+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,141 @@
+# bunny-ruby
+
+Ruby SDK for Bunny
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bunnyapp'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install bunnyapp
+```
+
+## Getting Started
+
+You can use this gem to send customized graphql queries to Bunny or use the built in convience methods.
+
+First configure the Bunny client.
+
+```ruby
+require 'bunny_app'
+
+# We recommend using the client_id/secret of your Bunny client app
+# this will enable automatic retries when the access token expires
+BunnyApp.config do |c|
+  c.client_id = 'xxx'
+  c.client_secret = 'xxx'
+  c.scope = 'standard:read standard:write'
+  c.base_uri = 'https://<subdomain>.bunny.com'
+end
+
+# Alternately you can generate the access token outside of this sdk
+# be aware that if your access_token expires an exception will be raised
+BunnyApp.config do |c|
+  c.access_token = 'xxx'
+  c.base_uri = 'https://<subdomain>.bunny.com'
+end
+```
+
+> Remember! Don't commit secrets to source control!
+
+### Generate rails config
+
+Create a config file at `config/initializers/bunny_app.rb`
+
+```sh
+> bin/rails g bunny_app:install
+```
+
+### Track feature usage
+
+If you have usage based billing or just want to track feature usage then use this method.
+
+```ruby
+# Usage is tracked as if it just happened
+json_response = BunnyApp::Usage.track(
+  quantity: 5, feature_code: 'products', tenant_code: '2')
+
+# Usage is tracked using the date supplied
+json_response = BunnyApp::Usage.track(
+  quantity: 5, feature_code: 'products', tenant_code: '2', usage_at: '2022-03-10')
+```
+
+### Custom queries & mutations
+
+Alternately you can build and send your own custom graphql queries or mutations
+
+```ruby
+query = <<-'GRAPHQL'
+mutation featureUsageCreate ($attributes: FeatureUsageAttributes!) {
+    featureUsageCreate (attributes: $attributes) {
+        errors
+        featureUsage {
+            id
+            quantity
+            usageAt
+            tenant {
+                id
+                code
+                name
+            }
+            feature {
+                id
+                code
+                name
+            }
+        }
+    }
+}
+GRAPHQL
+
+variables = {
+  attributes: {
+    quantity: 1,
+    usageAt: "2022-03-10",
+    tenantCode: "123456",
+    featureCode: "users"
+  }
+}
+
+json_response = BunnyApp.query(query, variables)
+```
+
+### Verify webhook signature
+
+Bunny can send webhooks for key actions like a subscription change. When you get a webhook from Bunny you should verify the signature that is supplied in the `x-bunny-signature` header matches the payload.
+
+```ruby
+payload = '{"type":"SubscriptionProvisioningChange","payload":{"subscription":{"id":27,"state":"trial","trial_start_date":"2022-06-04","trial_end_date":"2022-06-18","start_date":null,"end_date":null,"auto_renew":false,"account":{"id":33,"name":"Ondricka, Flatley and Kessler"},"tenant":null,"product":{"code":"stealth","name":"Stealth","description":null,"sku":null},"features":[{"code":"users","quantity":1},{"code":"crm","quantity":null}]}}}'
+
+BunnyApp::Webhook.verify("8bd5aa9c6a96fbce9fc3065af6e9871ac19a1d0a", payload, "secret-key")
+```
+
+## Requirements
+
+This gem requires Ruby 2.5+
+
+## Development
+
+Run `bin/setup` to install dependencies.
+
+Run `rake spec` to run the tests.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Set IGNORE_SSL when running locally to ignore ssl warnings.
+
+```sh
+> IGNORE_SSL=true bin/console
+```

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommended for running the tests'
+end
+
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/bunny_app.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bunny_app/version'
+
+Gem::Specification.new do |spec|
+  spec.name                   = 'bunny_app'
+  spec.version                = BunnyApp::VERSION
+  spec.authors                = ['Bunny', 'Rich Chetwynd']
+  spec.email                  = ['support@bunny.com']
+
+  spec.summary                = 'Ruby SDK for Bunny App'
+  spec.description            = 'Use Bunny for SaaS subscription management, quoting, billing and CRM'
+  spec.homepage               = 'https://github.com/bunny/bunny-ruby'
+  spec.license                = 'MIT'
+  spec.platform               = Gem::Platform::RUBY
+  spec.required_ruby_version  = '>= 3.1.0'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  raise 'RubyGems 3.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir['README.md', 'LICENSE', 'CHANGELOG.md', 'generators/**/*.rb',
+                   'lib/**/*.rb', 'lib/**/*.rake',
+                   'bunny_app.gemspec', 'Gemfile', 'Rakefile']
+
+  spec.executables   = []
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'httparty', '~> 0.20'
+  spec.add_runtime_dependency 'json', '~> 2.6'
+
+  spec.add_development_dependency 'fakeweb', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rubocop', '~> 1.26'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.13'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.9'
+end

data/lib/bunny_app/client.rb

@@ -0,0 +1,89 @@
+require 'httparty'
+require 'json'
+
+module BunnyApp
+  class Client
+    include HTTParty
+
+    attr_accessor :headers
+
+    USER_AGENT = "BunnyApp Ruby v#{BunnyApp::VERSION}".freeze
+
+    def initialize
+      self.class.base_uri BunnyApp.base_uri
+      self.class.default_options.update(verify: verify_ssl)
+
+      BunnyApp.access_token ||= fetch_access_token
+      @headers = {
+        'User-Agent' => USER_AGENT,
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{BunnyApp.access_token}"
+      }
+    end
+
+    def fetch_access_token
+      body = URI.encode_www_form({
+                                   grant_type: 'client_credentials',
+                                   client_id: BunnyApp.client_id,
+                                   client_secret: BunnyApp.client_secret,
+                                   scope: BunnyApp.scope
+                                 })
+
+      headers = {
+        'Content-Type' => 'application/x-www-form-urlencoded'
+      }
+
+      res = self.class.post('/oauth/token', headers:, body:)
+
+      case res.code.to_s
+      when /2[0-9][0-9]/ # HTTP 2xx
+        BunnyApp.retryable = true
+        res['access_token']
+      when /40[0-9]/
+        raise AuthorizationError, res.parsed_response['error_description']
+      else
+        raise ResponseError, res.body
+      end
+    end
+
+    def query(query, variables, retries = 0)
+      body = {
+        query:,
+        variables:
+      }.to_json
+
+      @headers['Authorization'] = "Bearer #{BunnyApp.access_token}"
+
+      res = self.class.post('/graphql', headers: @headers, body:)
+
+      case res.code.to_s
+      when /2[0-9][0-9]/ # HTTP 2xx
+        res.body
+      when /401/ # Access Token Expired
+        raise AuthorizationError, 'Invalid access token' unless BunnyApp.retryable
+        raise AuthorizationError, 'Invalid api credentials' if retries >= 1
+
+        BunnyApp.access_token = fetch_access_token
+        retries += 1
+        query(query, variables, retries)
+
+      when /403/ # HTTP 403
+        raise AuthorizationError, res.parsed_response['error_decscription']
+      else
+        raise ResponseError, res.body # HTTP 400, 500 etc
+      end
+    end
+
+    # Performs the api request within a new Thread, so it is non blocking.
+    # Consider it fire and forget
+    def query_async(query, variables)
+      Thread.new do
+        query(query, variables)
+      end
+    end
+
+    def verify_ssl
+      return true unless ENV['IGNORE_SSL']
+    end
+  end
+end

data/lib/bunny_app/errors.rb

@@ -0,0 +1,7 @@
+module BunnyApp
+  class AuthorizationError < StandardError
+  end
+
+  class ResponseError < StandardError
+  end
+end

data/lib/bunny_app/platform.rb

@@ -0,0 +1,27 @@
+module BunnyApp
+  class Platform
+    @platform_create_mutation = <<-'GRAPHQL'
+    mutation platformCreate ($attributes: PlatformAttributes!) {
+      platformCreate (attributes: $attributes) {
+        platform {
+          id
+          name
+          code
+        }
+        errors
+      }
+    }
+    GRAPHQL
+
+    def self.create(name:, code:)
+      variables = {
+        attributes: {
+          name: name,
+          code: code
+        }
+      }
+
+      Client.new.query(@platform_create_mutation, variables)
+    end
+  end
+end

data/lib/bunny_app/subscription.rb

@@ -0,0 +1,43 @@
+module BunnyApp
+  class Subscription
+    @subscription_create_mutation = <<-'GRAPHQL'
+    mutation subscriptionCreate ($attributes: SubscriptionAttributes!) {
+      subscriptionCreate (attributes: $attributes) {
+          errors
+          subscription {
+              id
+              trialStartDate
+              trialEndDate
+              startDate
+              endDate
+              state
+              productPlan {
+                name
+              }
+              tenant {
+                code
+                name
+              }
+          }
+      }
+  }
+    GRAPHQL
+
+    def self.create(account_name:, first_name:, last_name:, email:, product_plan_code:, options: {})
+      variables = {
+        attributes: {
+          accountName: account_name,
+          firstName: first_name,
+          lastName: last_name,
+          email:,
+          productPlanCode: product_plan_code,
+          trialStartDate: options[:trial_start_date],
+          tenantCode: options[:tenant_code]&.to_s,
+          trial: options[:trial]
+        }
+      }
+
+      Client.new.query(@subscription_create_mutation, variables)
+    end
+  end
+end

data/lib/bunny_app/tenant.rb

@@ -0,0 +1,34 @@
+module BunnyApp
+  class Tenant
+    @tenant_create_mutation = <<-'GRAPHQL'
+    mutation tenantCreate ($attributes: TenantAttributes!, $subscriptionId: ID!) {
+      tenantCreate (attributes: $attributes, subscriptionId: $subscriptionId) {
+        tenant {
+          code
+          id
+          name
+          platform {
+            id
+            name
+            code
+          }
+        }
+        errors
+      }
+    }
+    GRAPHQL
+
+    def self.create(name:, code:, platform_code: 'main', subscription_id: nil)
+      variables = {
+        attributes: {
+          name:,
+          code:,
+          platformCode: platform_code
+        },
+        subscriptionId: subscription_id
+      }
+
+      Client.new.query(@tenant_create_mutation, variables)
+    end
+  end
+end

data/lib/bunny_app/usage.rb

@@ -0,0 +1,40 @@
+module BunnyApp
+  class Usage
+    @feature_usage_create_mutation = <<-'GRAPHQL'
+    mutation featureUsageCreate ($attributes: FeatureUsageAttributes!) {
+        featureUsageCreate (attributes: $attributes) {
+            errors
+            featureUsage {
+                id
+                quantity
+                usageAt
+                tenant {
+                    id
+                    code
+                    name
+                }
+                feature {
+                    id
+                    code
+                    name
+                }
+            }
+        }
+    }
+    GRAPHQL
+
+    def self.track(quantity:, feature_code:, tenant_code:, usage_at: nil)
+      variables = {
+        attributes: {
+          quantity:,
+          featureCode: feature_code,
+          tenantCode: tenant_code
+        }
+      }
+
+      variables[:attributes][:usageAt] = usage_at unless usage_at.nil?
+
+      Client.new.query(@feature_usage_create_mutation, variables)
+    end
+  end
+end

data/lib/bunny_app/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BunnyApp
+  VERSION = '1.18.0'
+end

data/lib/bunny_app/webhook.rb

@@ -0,0 +1,13 @@
+require 'openssl'
+require 'base64'
+
+module BunnyApp
+  class Webhook
+    def self.verify(signature, payload, signing_key)
+      digest = OpenSSL::Digest.new('sha1')
+      hash = OpenSSL::HMAC.hexdigest(digest, signing_key, payload)
+
+      OpenSSL.secure_compare(hash, signature)
+    end
+  end
+end

data/lib/bunny_app.rb

@@ -0,0 +1,31 @@
+require 'bunny_app/version'
+require 'bunny_app/errors'
+require 'bunny_app/client'
+require 'bunny_app/usage'
+require 'bunny_app/platform'
+require 'bunny_app/tenant'
+require 'bunny_app/subscription'
+require 'bunny_app/webhook'
+
+module BunnyApp
+  class << self
+    attr_accessor :client_id, :client_secret, :scope, :access_token, :retryable
+    attr_writer :base_uri
+
+    def config
+      yield self
+    end
+
+    def base_uri
+      @base_uri || 'https://api.bunny.com'
+    end
+
+    def query(query, variables)
+      Client.new.query(query, variables)
+    end
+
+    def query_async(query, variables)
+      Client.new.query_async(query, variables)
+    end
+  end
+end

data/lib/generators/bunny_app/install_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators'
+require 'bunny_app'
+
+module BunnyApp
+  class InstallGenerator < Rails::Generators::Base
+    desc 'This generator creates a configuration file for the Bunny ruby client inside config/initializers'
+    def create_configuration_file
+      initializer 'bunny_app.rb' do
+        <<~CONFIG
+          # Specifies configuration options for the Bunny gem.
+          BunnyApp.config do |c|
+
+            # This is where your API credentials go. You should almost certainly not have it
+            # committed to source control, but instead load it from a secret store.
+            c.client_id = ENV['BUNNY_APP_CLIENT_ID']
+            c.client_secret = ENV['BUNNY_APP_CLIENT_SECRET']
+            c.scope = ENV['BUNNY_APP_SCOPE']
+
+            # Base URI for the Bunny API
+            c.base_uri = 'https://<subdomain>.bunny.com'
+
+            # Optional.
+            # Use this instead of client_id/secret if you dont care about the token expiring
+            # c.access_token = ENV['BUNNY_APP_ACCESS_TOKEN']
+
+          end
+        CONFIG
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: bunny_app
+version: !ruby/object:Gem::Version
+  version: 1.18.0
+platform: ruby
+authors:
+- Bunny
+- Rich Chetwynd
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: Use Bunny for SaaS subscription management, quoting, billing and CRM
+email:
+- support@bunny.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bunny_app.gemspec
+- lib/bunny_app.rb
+- lib/bunny_app/client.rb
+- lib/bunny_app/errors.rb
+- lib/bunny_app/platform.rb
+- lib/bunny_app/subscription.rb
+- lib/bunny_app/tenant.rb
+- lib/bunny_app/usage.rb
+- lib/bunny_app/version.rb
+- lib/bunny_app/webhook.rb
+- lib/generators/bunny_app/install_generator.rb
+homepage: https://github.com/bunny/bunny-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Ruby SDK for Bunny App
+test_files: []