fragment-dev 1.0.0

data/lib/fragment_client/version.rb

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

data/lib/fragment_client.rb

@@ -0,0 +1,122 @@
+# typed: false
+# frozen_string_literal: true
+
+require 'json'
+require 'graphql/client'
+require 'graphql/client/http'
+require 'sorbet-runtime'
+require 'uri'
+require 'net/http'
+require 'fragment_client/version'
+
+# A support module for the client
+module FragmentGraphQl
+  VERSION = FragmentSDK::VERSION
+  extend T::Sig
+
+  CustomHTTP = Class.new(GraphQL::Client::HTTP) do
+    extend T::Sig
+    sig { params(context: T.untyped).returns(T::Hash[T.untyped, T.untyped]) }
+    def headers(context)
+      { 'Authorization' => format('Bearer %s', context[:access_token]),
+        'X-Fragment-Client' => format('ruby-client@%s', FragmentGraphQl::VERSION) }
+    end
+  end
+
+  HTTP = T.let(CustomHTTP.new('https://api.fragment.dev/graphql'), GraphQL::Client::HTTP)
+
+  FragmentSchema = T.let(GraphQL::Client.load_schema("#{__dir__}/fragment.schema.json"), T.untyped)
+
+  Client = T.let(GraphQL::Client.new(schema: FragmentSchema, execute: HTTP), GraphQL::Client)
+
+  FragmentQueries = T.let(Client.parse(
+                            File.read("#{__dir__}/queries.graphql")
+                          ), T.untyped)
+end
+
+# A client for Fragment
+class FragmentClient
+  # A token for the client with an expiry time
+  class Token < T::Struct
+    const :token, String
+    const :expires_at, Time
+  end
+
+  extend T::Sig
+
+  sig do
+    params(client_id: String, client_secret: String, extra_queries_filename: T.nilable(String),
+           api_url: T.nilable(String), oauth_url: T.nilable(String), oauth_scope: T.nilable(String)).void
+  end
+  def initialize(client_id, client_secret, extra_queries_filename: nil, api_url: nil,
+                 oauth_url: 'https://auth.fragment.dev/oauth2/token', oauth_scope: 'https://api.fragment.dev/*')
+    @oauth_scope = T.let(oauth_scope, String)
+    @oauth_url = T.let(URI.parse(oauth_url), URI)
+    @client_id = T.let(client_id, String)
+    @client_secret = T.let(client_secret, String)
+
+    execute = api_url ? FragmentGraphQl::CustomHTTP.new(URI.parse(api_url).to_s) : FragmentGraphQl::HTTP
+    @execute = T.let(execute, GraphQL::Client::HTTP)
+
+    @client = T.let(GraphQL::Client.new(schema: FragmentGraphQl::FragmentSchema, execute: @execute), GraphQL::Client)
+    @token = T.let(create_token, Token)
+
+    define_method_from_queries(FragmentGraphQl::FragmentQueries)
+    return if extra_queries_filename.nil?
+
+    queries = @client.parse(
+      File.read(extra_queries_filename)
+    )
+    define_method_from_queries(queries)
+  end
+
+  sig { params(query: T.untyped, variables: T.untyped).returns(T.untyped) }
+  def query(query, variables)
+    expiry_time_skew = 120
+    @token = create_token if Time.now > @token.expires_at - expiry_time_skew
+    puts query
+    @client.query(query, variables: variables, context: { access_token: @token.token })
+  end
+
+  private
+
+  def define_method_from_queries(queries)
+    queries.constants.each do |qry|
+      name = qry.to_s.gsub(/[a-z]([A-Z])/) do |m|
+        format('%<lower>s_%<upper>s', lower: m[0], upper: m[1].downcase)
+      end.gsub(/^[A-Z]/, &:downcase)
+      define_singleton_method(name) do |v|
+        query(queries.const_get(qry), v)
+      end
+    end
+  end
+
+  sig { returns(Token) }
+  def create_token
+    uri = URI.parse(@oauth_url.to_s)
+    post = Net::HTTP::Post.new(uri.to_s)
+    post.basic_auth(@client_id, @client_secret)
+    post.body = format('grant_type=client_credentials&scope=%<scope>s&client_id=%<id>s', scope: @oauth_scope,
+                                                                                         id: @client_id)
+
+    begin
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https'
+      response = http.request(post)
+
+      case response
+      when Net::HTTPSuccess
+        # Parse the response body
+        body = JSON.parse(response.body)
+        Token.new(
+          token: T.let(body['access_token'], String),
+          expires_at: Time.now + T.let(body['expires_in'], Integer)
+        )
+      else
+        raise StandardError, format("oauth Authentication failed: '%s'", response.body)
+      end
+    rescue StandardError => e
+      raise StandardError, format("oauth Authentication failed: '%s'", e.to_s)
+    end
+  end
+end

data/lib/fragment_client.rbi

@@ -0,0 +1,6 @@
+# typed: strong
+# frozen_string_literal: true
+
+# A client for Fragment
+class FragmentClient
+end

data/lib/queries.graphql

@@ -0,0 +1,513 @@
+mutation StoreSchema($schema: SchemaInput!) {
+  storeSchema(schema: $schema) {
+    __typename
+    ... on StoreSchemaResult {
+      schema {
+        key
+        name
+        version {
+          created
+          version
+        }
+      }
+    }
+    ... on Error {
+      code
+      message
+    }
+  }
+}
+
+mutation CreateLedger(
+  $ik: SafeString!
+  $ledger: CreateLedgerInput!
+  $schemaKey: SafeString!
+) {
+  createLedger(ik: $ik, ledger: $ledger, schema: { key: $schemaKey }) {
+    __typename
+    ... on CreateLedgerResult {
+      ledger {
+        id
+        ik
+        name
+        created
+        schema {
+          key
+        }
+      }
+      isIkReplay
+    }
+    ... on Error {
+      code
+      message
+    }
+  }
+}
+
+mutation AddLedgerEntry(
+  $ik: SafeString!
+  $ledgerIk: SafeString!
+  $type: String!
+  $posted: DateTime
+  $parameters: JSON!
+  $tags: [LedgerEntryTagInput!]
+  $groups: [LedgerEntryGroupInput!]
+) {
+  addLedgerEntry(
+    ik: $ik
+    entry: {
+      ledger: { ik: $ledgerIk }
+      type: $type
+      posted: $posted
+      parameters: $parameters
+      tags: $tags
+      groups: $groups
+    }
+  ) {
+    __typename
+    ... on AddLedgerEntryResult {
+      isIkReplay
+      entry {
+        type
+        id
+        ik
+        posted
+        created
+      }
+      lines {
+        id
+        amount
+        account {
+          path
+        }
+      }
+    }
+    ... on Error {
+      code
+      message
+    }
+  }
+}
+
+mutation AddLedgerEntryRuntime(
+  $ik: SafeString!
+  $type: String!
+  $ledgerIk: SafeString!
+  $posted: DateTime
+  $lines: [LedgerLineInput!]!
+  $tags: [LedgerEntryTagInput!]
+  $groups: [LedgerEntryGroupInput!]
+) {
+  addLedgerEntry(
+    ik: $ik
+    entry: {
+      type: $type
+      ledger: { ik: $ledgerIk }
+      posted: $posted
+      lines: $lines
+      tags: $tags
+      groups: $groups
+    }
+  ) {
+    __typename
+    ... on AddLedgerEntryResult {
+      isIkReplay
+      entry {
+        type
+        id
+        ik
+        posted
+        created
+      }
+      lines {
+        id
+        amount
+        account {
+          path
+        }
+      }
+    }
+    ... on Error {
+      code
+      message
+    }
+  }
+}
+
+mutation ReconcileTx(
+  $ledgerIk: SafeString!
+  $type: String!
+  $parameters: JSON!
+  $tags: [LedgerEntryTagInput!]
+  $groups: [LedgerEntryGroupInput!]
+) {
+  reconcileTx(
+    entry: {
+      ledger: { ik: $ledgerIk }
+      type: $type
+      parameters: $parameters
+      tags: $tags
+      groups: $groups
+    }
+  ) {
+    __typename
+    ... on ReconcileTxResult {
+      entry {
+        id
+        ik
+        date
+        posted
+        created
+        description
+      }
+      lines {
+        id
+        amount
+        account {
+          path
+        }
+        externalTxId
+      }
+    }
+    ... on Error {
+      code
+      message
+    }
+  }
+}
+
+mutation ReconcileTxRuntime(
+  $ledgerIk: SafeString!
+  $type: String!
+  $lines: [LedgerLineInput!]!
+  $tags: [LedgerEntryTagInput!]
+  $groups: [LedgerEntryGroupInput!]
+) {
+  reconcileTx(
+    entry: {
+      ledger: { ik: $ledgerIk }
+      type: $type
+      lines: $lines
+      tags: $tags
+      groups: $groups
+    }
+  ) {
+    __typename
+    ... on ReconcileTxResult {
+      entry {
+        id
+        ik
+        date
+        posted
+        created
+        description
+      }
+      lines {
+        id
+        amount
+        account {
+          path
+        }
+        externalTxId
+      }
+    }
+    ... on Error {
+      code
+      message
+    }
+  }
+}
+
+mutation UpdateLedger($ledgerIk: SafeString!, $update: UpdateLedgerInput!) {
+  updateLedger(ledger: { ik: $ledgerIk }, update: $update) {
+    __typename
+    ... on UpdateLedgerResult {
+      ledger {
+        id
+        ik
+        name
+      }
+    }
+    ... on Error {
+      code
+      message
+    }
+  }
+}
+mutation CreateCustomLink($name: String!, $ik: SafeString!) {
+  createCustomLink(name: $name, ik: $ik) {
+    __typename
+    ... on CreateCustomLinkResult {
+      link {
+        id
+        name
+        created
+      }
+      isIkReplay
+    }
+    ... on Error {
+      code
+      message
+    }
+  }
+}
+
+mutation SyncCustomAccounts($linkId: ID!, $accounts: [CustomAccountInput!]!) {
+  syncCustomAccounts(link: { id: $linkId }, accounts: $accounts) {
+    __typename
+    ... on SyncCustomAccountsResult {
+      accounts {
+        id
+        externalId
+        name
+        currency {
+          code
+          customCurrencyId
+        }
+      }
+    }
+    ... on Error {
+      code
+      message
+    }
+  }
+}
+
+mutation SyncCustomTxs($linkId: ID!, $txs: [CustomTxInput!]!) {
+  syncCustomTxs(link: { id: $linkId }, txs: $txs) {
+    __typename
+    ... on SyncCustomTxsResult {
+      txs {
+        __typename
+        linkId
+        id
+        externalId
+        externalAccountId
+        amount
+        description
+        posted
+      }
+    }
+    ... on Error {
+      code
+      message
+    }
+  }
+}
+
+query GetLedger($ik: SafeString!) {
+  ledger(ledger: { ik: $ik }) {
+    id
+    ik
+    name
+    created
+    balanceUTCOffset
+  }
+}
+
+query GetLedgerEntry($ik: SafeString!, $ledgerIk: SafeString!) {
+  ledgerEntry(ledgerEntry: { ik: $ik, ledger: { ik: $ledgerIk } }) {
+    id
+    ik
+    posted
+    created
+    description
+    lines {
+      nodes {
+        id
+        amount
+        account {
+          path
+        }
+      }
+    }
+  }
+}
+
+query ListLedgerAccounts(
+  $ledgerIk: SafeString!
+  $after: String
+  $first: Int
+  $before: String
+) {
+  ledger(ledger: { ik: $ledgerIk }) {
+    id
+    ik
+    name
+    created
+    ledgerAccounts(after: $after, first: $first, before: $before) {
+      nodes {
+        id
+        path
+        name
+        type
+        created
+      }
+      pageInfo {
+        hasNextPage
+        endCursor
+        hasPreviousPage
+        startCursor
+      }
+    }
+  }
+}
+
+query ListLedgerAccountBalances(
+  $ledgerIk: SafeString!
+  $after: String
+  $first: Int
+  $before: String
+  $balanceCurrency: CurrencyMatchInput
+  $balanceAt: LastMoment
+  $ownBalanceConsistencyMode: ReadBalanceConsistencyMode
+) {
+  ledger(ledger: { ik: $ledgerIk }) {
+    id
+    ik
+    name
+    created
+    ledgerAccounts(after: $after, first: $first, before: $before) {
+      nodes {
+        id
+        path
+        name
+        type
+        created
+        ownBalance(
+          currency: $balanceCurrency
+          at: $balanceAt
+          consistencyMode: $ownBalanceConsistencyMode
+        )
+        childBalance(currency: $balanceCurrency, at: $balanceAt)
+        balance(currency: $balanceCurrency, at: $balanceAt)
+      }
+      pageInfo {
+        hasNextPage
+        endCursor
+        hasPreviousPage
+        startCursor
+      }
+    }
+  }
+}
+
+query ListMultiCurrencyLedgerAccountBalances(
+  $ledgerIk: SafeString!
+  $after: String
+  $first: Int
+  $before: String
+  $balanceAt: LastMoment
+  $ownBalancesConsistencyMode: ReadBalanceConsistencyMode
+) {
+  ledger(ledger: { ik: $ledgerIk }) {
+    id
+    ik
+    name
+    created
+    ledgerAccounts(after: $after, first: $first, before: $before) {
+      nodes {
+        id
+        path
+        name
+        type
+        created
+        ownBalances(
+          at: $balanceAt
+          consistencyMode: $ownBalancesConsistencyMode
+        ) {
+          nodes {
+            currency {
+              code
+              customCurrencyId
+            }
+            amount
+          }
+        }
+        childBalances(at: $balanceAt) {
+          nodes {
+            currency {
+              code
+              customCurrencyId
+            }
+            amount
+          }
+        }
+        balances(at: $balanceAt) {
+          nodes {
+            currency {
+              code
+              customCurrencyId
+            }
+            amount
+          }
+        }
+      }
+      pageInfo {
+        hasNextPage
+        endCursor
+        hasPreviousPage
+        startCursor
+      }
+    }
+  }
+}
+
+query GetLedgerAccountLines(
+  $path: String!
+  $ledgerIk: SafeString!
+  $after: String
+  $first: Int
+  $before: String
+  $filter: LedgerLinesFilterSet
+) {
+  ledgerAccount(ledgerAccount: { ledger: { ik: $ledgerIk }, path: $path }) {
+    id
+    path
+    lines(after: $after, first: $first, before: $before, filter: $filter) {
+      nodes {
+        id
+        posted
+        created
+        amount
+        description
+      }
+      pageInfo {
+        hasNextPage
+        endCursor
+        hasPreviousPage
+        startCursor
+      }
+    }
+  }
+}
+
+query GetLedgerAccountBalance(
+  $path: String!
+  $ledgerIk: SafeString!
+  $balanceCurrency: CurrencyMatchInput
+  $balanceAt: LastMoment
+  $ownBalanceConsistencyMode: ReadBalanceConsistencyMode
+) {
+  ledgerAccount(ledgerAccount: { ledger: { ik: $ledgerIk }, path: $path }) {
+    id
+    path
+    ownBalance(
+      currency: $balanceCurrency
+      at: $balanceAt
+      consistencyMode: $ownBalanceConsistencyMode
+    )
+  }
+}
+
+query GetSchema($key: SafeString!, $version: Int) {
+  schema(schema: { key: $key, version: $version }) {
+    key
+    name
+    version {
+      created
+      version
+      json
+    }
+  }
+}

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: fragment-dev
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- fragment
+autorequire:
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql-client
+  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: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description:
+email: snoble@fragment.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fragment.schema.json
+- lib/fragment_client.rb
+- lib/fragment_client.rbi
+- lib/fragment_client/version.rb
+- lib/queries.graphql
+homepage: https://fragment.dev
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: the ruby fragment client sdk
+test_files: []