stigg-api-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb5028b371f0211e5eb36b851f178f31511e4fab423638d92724e534d120a400
+  data.tar.gz: 31e5e37fab257d53fd006f5854ad3c8e4650398607a4c7113ba37901eef34df8
+SHA512:
+  metadata.gz: 84fde9de567650ab41a0ee5f13f7322303dae573457dbe276082c77dce300b1444ab3d1e7f8f0f087dd5c790ffa1abca16ef349387603f3c80cced268882f994
+  data.tar.gz: 3dbab4968ff612a628dca33a59766b802d397d6a48d5a4ab8c06f2c809790eaf89383126380df2e8336d44dbfcee0c753a134a9eb96beb77b06d359ae1c877ea

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,12 @@
+# 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"

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    stigg-api-client (0.1.0)
+      graphlient (~> 0.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    faraday (2.6.0)
+      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.15)
+    graphql-client (0.18.0)
+      activesupport (>= 3.0)
+      graphql
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.16.3)
+    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.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  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,109 @@
+# Stigg::Client
+
+This library provides a Ruby wrapper to [Stigg's GraphQL API](https://docs.stigg.io/docs/graphql-api) based on
+the operations the [Stigg's Node.js SDK](https://docs.stigg.io/docs/nodejs-sdk) is using under the hood.
+
+It leverages the [graphlient](https://github.com/ashkan18/graphlient) library, and utilizes the `Graphlient::Client` class to send 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,37 @@
+# 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)
+      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.json'
+      )
+
+      Client.new(client)
+    end
+  end
+end