stigg-api-client 0.0.1.pre.b.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dbf4e72503b9416ddfd42d96f2aebea92370784f23f44c35bf252f64855cfcbe
+  data.tar.gz: 6737a488450aa135af6d4a7c850ba6582899b17e35bfd8264e81951d70ab4897
+SHA512:
+  metadata.gz: 2c5448e553f8213254522c81fef16f85a94cd7e0e44c55b3a6acd0236ee7db647e49fdfe77828dc9c2489a1b265e251fdb1b944fae7fb8194ca69446fdd02b9d
+  data.tar.gz: 25ff5286ff877849553b09f909a5ed59a92b9f746ac05b745798d91175347087824c2e4cddd11808afe8f18be2d597953c14462d53653f1171bc85df1c4da900

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 3
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Naming/ConstantName:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in stigg-api-client.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "bump", "~> 0.10"

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    stigg-api-client (0.0.1.pre.b.1)
+      graphlient (~> 0.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    bump (0.10.0)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    graphlient (0.7.0)
+      faraday (~> 2.0)
+      graphql-client
+    graphql (2.0.20)
+    graphql-client (0.18.0)
+      activesupport (>= 3.0)
+      graphql
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.18.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.38.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bump (~> 0.10)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  stigg-api-client!
+
+BUNDLED WITH
+   2.3.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Anton Zagrebelny
+
+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,106 @@
+# Stigg::Client
+
+This Ruby gem provides a wrapper to [Stigg's GraphQL API](https://docs.stigg.io/docs/graphql-api) based on the operations that are in use by the [Stigg's Node.js SDK](https://docs.stigg.io/docs/nodejs-sdk). 
+It leverages the [graphlient](https://github.com/ashkan18/graphlient) library under the hood, and utilizes the `Graphlient::Client` class to execute the API requests.
+
+## Documentation
+
+See https://docs.stigg.io/docs/ruby-sdk
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add stigg-api-client
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install stigg-api-client
+
+## Usage
+
+
+Initialize the client:
+
+```ruby
+
+require("stigg")
+
+api_key = ENV["STIGG_SERVER_API_KEY"]
+
+client = Stigg.create_client(api_key)
+
+```
+
+Provision a customer
+
+```ruby
+
+require("stigg")
+
+api_key = ENV["STIGG_SERVER_API_KEY"]
+
+client = Stigg.create_client(api_key)
+
+resp = client.request(Stigg::Mutation::ProvisionCustomer, {
+    "input": {
+        "refId": "customer-id",
+        "name": "Acme",
+        "email": "hello@acme.com",
+        "couponRefId": "coupon-id",
+        "billingInformation": {
+            "language": "en",
+            "timezone": "America/New_York",
+            "billingAddress": {
+                "country": "US",
+                "city": "New York",
+                "state": "NY",
+                "addressLine1": "123 Main Street",
+                "addressLine2": "Apt. 1",
+                "phoneNumber": "+1 212-499-5321",
+                "postalCode": "10164"
+            },
+            "shippingAddress": {
+                "country": "US",
+                "city": "New York",
+                "state": "NY",
+                "addressLine1": "123 Main Street",
+                "addressLine2": "Apt. 1",
+                "phoneNumber": "+1 212-499-5321",
+                "postalCode": "10164"
+            }
+        },
+        "additionalMetaData": {
+            "key": "value"
+        },
+        "subscriptionParams": {
+            "planId": "plan-revvenu-basic"
+        }
+    }
+})
+
+p resp.data.provision_customer.customer.name
+
+```
+
+Get a customer by ID
+
+```ruby
+
+
+require("stigg")
+
+api_key = ENV["STIGG_SERVER_API_KEY"]
+
+client = Stigg.create_client(api_key)
+
+resp = client.request(Stigg::Query::GetCustomerById, { 'customerId': 'customer-id' })
+customer_edge = resp.data.customers.edges[0]
+if customer_edge
+  customer = customer_edge.node
+  p customer.name
+else
+  p 'Customer not found'
+end
+
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/stigg/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "version"
+require "graphlient"
+
+module Stigg
+  class Client
+    def initialize(client)
+      @client = client
+    end
+
+    def request(query, variables = nil)
+      @client.query(query, variables)
+    end
+  end
+
+  class << self
+    # @param [String] api_key
+    # @param [String api_url
+    # @return [Client]
+    def create_client(api_key, api_url = "https://api.stigg.io/graphql", request_timeout=30)
+      schema_path = File.join(__dir__, 'generated/schema.json').to_s
+
+      client = Graphlient::Client.new(
+        api_url,
+        headers: {
+          "X-API-KEY": api_key
+        },
+        http_options: {
+          read_timeout: request_timeout,
+          write_timeout: request_timeout
+        },
+        schema_path: schema_path
+      )
+
+      Client.new(client)
+    end
+  end
+end

data/lib/stigg/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stigg
+  VERSION = "0.0.1-b.1"
+end

data/lib/stigg.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "stigg/generated/operations"
+require "stigg/version"
+require "stigg/client"

data/project.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/api-client-ruby/lib",
+  "projectType": "library",
+  "implicitDependencies": ["api-client-schema"],
+  "targets": {
+    "generate": {
+      "executor": "@nrwl/workspace:run-commands",
+      "options": {
+        "command": "./scripts/generate.sh",
+        "cwd": "packages/api-client-ruby"
+      }
+    },
+    "publish": {
+      "executor": "@nrwl/workspace:run-commands",
+      "options": {
+        "command": "./scripts/publish.sh {args.ver}",
+        "cwd": "packages/api-client-ruby"
+      }
+    },
+    "test": {
+      "executor": "@nrwl/workspace:run-commands",
+      "options": {
+        "command": "rake spec",
+        "cwd": "packages/api-client-ruby"
+      },
+      "dependsOn": [
+        {
+          "projects": "self",
+          "target": "generate"
+        }
+      ]
+    }
+  },
+  "tags": []
+}

data/scripts/generate-operations.mjs

@@ -0,0 +1,99 @@
+import * as gql from 'graphql';
+import fs from 'fs';
+
+const schema = fs.readFileSync(
+  '../api-client-schema/src/generated/schema.graphql',
+  'utf8'
+);
+
+const operations = fs.readFileSync('operations.graphql', 'utf8');
+
+const gqlSchema = gql.buildSchema(schema);
+
+const gqlOperations = gql.parse(operations);
+
+function generateOperationsModule() {
+  const typeInfo = new gql.TypeInfo(gqlSchema);
+  const outputProgram = gql.visit(
+    gqlOperations,
+    gql.visitWithTypeInfo(typeInfo, visitor(gqlSchema, typeInfo))
+  );
+
+  const modules = ['Fragment', 'Mutation', 'Query']
+    .map(
+      (moduleName) =>
+        `module ${moduleName}\n${outputProgram
+          .filter((x) => x.moduleName === moduleName)
+          .map((x) => x.element)
+          .join('\n\n')}\nend`
+    )
+    .join('\n');
+
+  return `# frozen_string_literal: true\n\nmodule Stigg\n${modules}\nend`;
+}
+
+function findFragments(node, results = new Set()) {
+  if (node.kind === 'FragmentSpread') {
+    results.add(node.name.value);
+    gqlOperations.definitions.find((def) => {
+      if (
+        def.kind === 'FragmentDefinition' &&
+        def.name.value === node.name.value
+      ) {
+        findFragments(def, results);
+      }
+    });
+  }
+  node.selectionSet?.selections?.forEach((node) =>
+    findFragments(node, results)
+  );
+  return results;
+}
+
+function visitor(schema, typeInfo) {
+  return {
+    enter(node) {
+      typeInfo.enter(node);
+    },
+    leave(node) {
+      typeInfo.leave(node);
+      switch (node.kind) {
+        case 'Document':
+          return node.definitions;
+        case 'OperationDefinition': {
+          const results = findFragments(node);
+          const rawQuery = node.loc.source.body.substring(
+            node.loc.start,
+            node.loc.end
+          );
+          const namelessQuery = rawQuery.replace(
+            `${node.operation} ${node.name.value}`,
+            `${node.operation} `
+          );
+          const includedFragments = [...results]
+            .map((x) => `#{Fragment::${x}}\n`)
+            .join('');
+          const constantName =
+            node.name.value[0].toUpperCase() + node.name.value.slice(1);
+          return {
+            moduleName: node.operation === 'mutation' ? 'Mutation' : 'Query',
+            element: `${constantName} = <<-GRAPHQL\n${namelessQuery}\n${includedFragments}GRAPHQL`,
+          };
+        }
+        case 'FragmentDefinition': {
+          const querySource = node.loc.source.body.substring(
+            node.loc.start,
+            node.loc.end
+          );
+          return {
+            moduleName: 'Fragment',
+            element: `${node.name.value} = <<-GRAPHQL\n${querySource}\nGRAPHQL`,
+          };
+        }
+      }
+    },
+  };
+}
+
+const module = generateOperationsModule();
+fs.writeFileSync('lib/stigg/generated/operations.rb', module);

data/scripts/generate.sh

@@ -0,0 +1,17 @@
+#!/bin/bash -e
+
+# stitch the operation files together
+cat ../api-client-schema/src/operations/*.graphql > operations.graphql
+
+mkdir -p lib/stigg/generated/
+
+cat <<-EOF > lib/stigg/generated/schema.json
+  $(echo { \"data\": ) $(cat ../api-client-schema/src/generated/schema.json) $(echo })
+EOF
+
+node scripts/generate-operations.mjs
+rm operations.graphql
+
+bundle exec rubocop -a lib/stigg/generated/operations.rb
+
+printf "api-client-ruby generated!\n"

data/scripts/publish.sh

@@ -0,0 +1,28 @@
+#!/bin/bash -e
+
+VERSION=$1
+
+if [ -z "$VERSION" ]; then
+  echo "Usage: ./scripts/publish.sh <version>"
+  exit 1
+fi
+
+bundle config unset deployment
+
+bundle exec bump set "${VERSION}" --no-commit --no-bundle
+git diff
+
+echo "Building..."
+bundle exec rake build
+
+# create a temporary commit, since it's not possible to
+# release with a dirty working directory
+echo "Releasing..."
+git tag -d "v#${VERSION}" || true
+git add .
+git commit --no-verify -m "tmp commit for ruby release"
+git tag -a "v#${VERSION}" -m 'tmp tag'
+bundle exec rake release -v || (git reset --soft HEAD~1 && exit 1)
+git reset --soft HEAD~1
+
+printf "api-client-ruby published!\n"

data/stigg-api-client.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/stigg/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "stigg-api-client"
+  spec.version = Stigg::VERSION
+  spec.authors = ["Stigg"]
+  spec.email = ["support@stigg.io"]
+
+  spec.summary = "Stigg API Client"
+  spec.description = "Stigg API Client for Ruby"
+  spec.homepage = "https://stigg.io"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "graphlient", "~> 0.7.0"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: stigg-api-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.b.1
+platform: ruby
+authors:
+- Stigg
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphlient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Stigg API Client for Ruby
+email:
+- support@stigg.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stigg.rb
+- lib/stigg/client.rb
+- lib/stigg/version.rb
+- project.json
+- scripts/generate-operations.mjs
+- scripts/generate.sh
+- scripts/publish.sh
+- stigg-api-client.gemspec
+homepage: https://stigg.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://stigg.io
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Stigg API Client
+test_files: []