teller 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf5c1ff1333acb15ef5ba071923ef838b162009404692dd4ac484e523750cbc8
+  data.tar.gz: 8f16479f346cfb8ab229f2e59dfddbfff719eec80c7213f31cadbe33e7244c4e
+SHA512:
+  metadata.gz: 956fbbad3d348c9542edba1dc41f1ec194e51211f1eab1ea497be1789ecf54972a6d0539dad793a4295aa06da1cea71d1df9d289228dd3fab767c0d739592153
+  data.tar.gz: b3364bd36a6594481928ea81814ac90186bda9706f4883792c033bc2068d8fad4578e9f690dabd298164f2f6731599ceccb54c3e685f6bb54968eb6860a20de4

data/.gitignore

@@ -0,0 +1,9 @@
+Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in teller.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "webmock", "~> 3.18"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Stevie Graham
+
+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,96 @@
+# Teller
+
+The official Ruby language bindings for the Teller API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'teller'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install teller
+
+## Usage
+
+First configure the library for your application
+
+```ruby
+Teller::Config.setup do |c|
+    c.certificate  = "/path/to/teller/cert.pem"
+    c.private_key  = "/path/to/its/private_key.pem"
+    c.access_token = "access-token-from-teller-connect-enrollment"
+end
+```
+
+Statically configuring an access token might make sense if you're just building something using your own accounts, but it doesn't if you're building something for thousands of users, which is why you can also set your config when instantiating the client. 
+
+```ruby
+client = Teller::Client.new access_token: "test_token_ky6igyqi3qxa4"
+```
+
+During instantiation the client will take whatever static config you've made (if any), and apply config given to the constructor. Config values supplied at instantiation will override conflicting statically configured values.
+
+Now you have your client configured you can use it to explore the API.
+
+```ruby
+account = client.accounts.first
+# => #<Teller::Resource type="credit", subtype="credit_card", status="open", name="Platinum Card", links={"transactions"=>"https://api.teller.io/accounts/acc_oiin624kqjrg2mp2ea000/transactions", "self"=>"https://api.teller.io/accounts/acc_oiin624kqjrg2mp2ea000", "balances"=>"https://api.teller.io/accounts/acc_oiin624kqjrg2mp2ea000/balances"}, last_four="7857", institution={"name"=>"Security Credit Union", "id"=>"security_cu"}, id="acc_oiin624kqjrg2mp2ea000", enrollment_id="enr_oiin624rqaojse22oe000", currency="USD">
+
+account.name
+# => "Platinum Card"
+```
+
+You can easily load related resources linked to in the "links" section of the API response"
+
+```ruby
+account.balances
+# =>  #<Teller::Resource links={"self"=>"https://api.teller.io/accounts/acc_oiin624kqjrg2mp2ea000/balances", "account"=>"https://api.teller.io/accounts/acc_oiin624kqjrg2mp2ea000"}, ledger="4698.93", available="204.12", account_id="acc_oiin624kqjrg2mp2ea000">
+
+account.transactions
+# => [#<Teller::Resource type="card_payment", status="pending", running_balance=nil, links={"self"=>"https://api.teller.io/accounts/acc_oiin624kqjrg2mp2ea000/transactions/txn_oj0t0gfqpvj7favgn8000", "account"=>"https://api.teller.io/accounts/acc_oiin624kqjrg2mp2ea000"}, id="txn_oj0t0gfqpvj7favgn8000", details={"processing_status"=>"complete", "counterparty"=>{"type"=>"organization", "name"=>"WILLIAMS-SONOMA"}, "category"=>"shopping"}, description="Williams-Sonoma", date="2023-07-23", amount="96.95", account_id="acc_oiin624kqjrg2mp2ea000">, ...]
+```
+
+You can also fetch arbitrary members of a collection resource
+
+```ruby
+client.accounts.get("acc_oiin624jqjrg2mp2ea000")
+# =>  #<Teller::Resource type="depository", subtype="savings", status="open", name="Essential Savings", links={"transactions"=>"https://api.teller.io/accounts/acc_oiin624jqjrg2mp2ea000/transactions", "self"=>"https://api.teller.io/accounts/acc_oiin624jqjrg2mp2ea000", "details"=>"https://api.teller.io/accounts/acc_oiin624jqjrg2mp2ea000/details", "balances"=>"https://api.teller.io/accounts/acc_oiin624jqjrg2mp2ea000/balances"}, last_four="3528", institution={"name"=>"Security Credit Union", "id"=>"security_cu"}, id="acc_oiin624jqjrg2mp2ea000", enrollment_id="enr_oiin624rqaojse22oe000", currency="USD">
+```
+
+The client caches API responses after the first time you invoke a method that requests a given resource. To force the client to redo the request you can call reload
+
+```ruby
+# When called the first time the client will make a request to the Teller API
+client.accounts
+
+# On subsequent invocations locally cached data is returned
+client.accounts
+client.accounts
+client.accounts
+
+# Calling reload will always result in a new API request
+client.accounts.reload
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tellerhq/teller-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "teller"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/teller/api.rb

@@ -0,0 +1,56 @@
+class Teller::API
+  class Error < StandardError; end
+  def initialize(config)
+    @config = config
+  end
+
+  def delete(url)
+    request(:delete, url)
+  end
+
+  def get(url)
+    request(:get, url)
+  end
+
+  def post(url, body)
+    request(:post, url, body)
+  end
+
+  def request(method, url, body=nil)
+    uri = URI.parse(url)
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true 
+
+    if @config.certificate && @config.private_key
+      http.cert = @config.certificate
+      http.key = @config.private_key
+    end
+
+    klass = Net::HTTP.const_get(method.to_s.capitalize)
+
+    request = klass.new(uri.request_uri)
+
+    if body
+      request.body = body.to_json
+      request.add_field("Content-Type", "application/json")
+    end
+
+
+    if @config.access_token
+      request.add_field('Authorization', "Basic #{Base64.strict_encode64("#{@config.access_token}:")}")
+    end
+
+    response = http.request(request)
+
+    case response
+    when Net::HTTPNoContent
+      return
+    when Net::HTTPSuccess
+      JSON.parse(response.body)
+    when Net::HTTPClientError, Net::HTTPServerError
+      error = JSON.parse(response.body) 
+      raise Error, "#{error["error"]["code"]} - #{error["error"]["message"]}"
+    end
+  end
+end

data/lib/teller/client.rb

@@ -0,0 +1,26 @@
+module Teller
+  class Client
+    URL = "https://api.teller.io".freeze
+
+    def initialize(overrides={})
+      config = Teller::Config.dup
+      config.setup(overrides)
+      
+      client = Teller::API.new(config)
+      entrypoint = client.get(URL)
+      @target = Teller::Resource.new(entrypoint, client)
+    end
+
+    def method_missing(method, *args, &block)
+      if @target.respond_to?(method)
+        @target.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      @target.respond_to?(method)
+    end
+  end
+end

data/lib/teller/collection_resource.rb

@@ -0,0 +1,41 @@
+module Teller
+  class CollectionResource
+    def initialize(url, collection, client)
+      @url = url
+      @collection = collection.map { |i| Teller::Resource.new(i, client) }
+      @client = client
+    end
+
+    def get(id)
+      url = @url + "/" + id
+      Teller::Resource.new(@client.get(url), @client)
+    end
+
+    def delete
+      @client.delete @url
+      @collection = []
+      true
+    end
+
+    def reload
+      @collection = @client.get(@url).map { |i| Teller::Resource.new(i, @client) }
+      self
+    end
+
+    def method_missing(method, *args, &block)
+      if @collection.respond_to?(method)
+        @collection.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      @collection.respond_to?(method) || super
+    end
+
+    def inspect
+      @collection
+    end
+  end
+end

data/lib/teller/config.rb

@@ -0,0 +1,49 @@
+require 'openssl'
+
+module Teller::Config
+  class Error < StandardError; end
+
+  attr_accessor :access_token, :certificate, :private_key
+
+  def setup(opts = {})
+    if block_given?
+      yield(self)
+    else
+      opts.each { |k, v| send(:"#{k}=", v) }
+    end
+  end
+
+  def certificate=(path)
+    if path
+      begin
+        File.open(path, 'r') do |file|
+          @certificate = OpenSSL::X509::Certificate.new(file)
+        end
+      rescue Errno::ENOENT
+        raise Error, "Certificate file not found: #{path}"
+      rescue OpenSSL::X509::CertificateError
+        raise Error, "Invalid certificate data in file: #{path}"
+      end
+    else
+      @certificate = nil
+    end
+  end
+
+  def private_key=(path)
+    if path
+      begin
+        File.open(path, 'r') do |file|
+          @private_key = OpenSSL::PKey.read(file, nil)
+        end
+      rescue Errno::ENOENT
+        raise Error, "Private key file not found: #{path}"
+      rescue OpenSSL::PKey::PKeyError
+        raise Error, "Invalid private key data in file: #{path}"
+      end
+    else
+      @private_key = nil
+    end
+  end
+
+  extend self
+end

data/lib/teller/resource.rb

@@ -0,0 +1,47 @@
+require 'json'
+require 'net/http'
+require 'uri'
+require 'base64'
+require 'ostruct'
+
+class Teller::Resource < OpenStruct
+  def initialize(state, client)
+    @client = client
+    super(state)
+  end
+
+  def method_missing(method, *args, &block)    
+    if @table[:links].key?(method.to_s)
+      @table[method] ||= subresource(table[:links][method.to_s])
+      @table[method]
+    else
+      super
+    end
+  end
+
+  def delete
+    @client.delete @table[:links]["self"]
+    true
+  end
+
+  def reload
+    initialize(@client.get(@table[:links]["self"]), @client)
+    self
+  end 
+
+  def respond_to_missing?(method, include_private = false)
+    @table[:links]&.key?(method.to_s) || super
+  end
+
+  private
+
+  def subresource(link)
+    state = @client.get(link)
+
+    if state.is_a?(Array)
+      Teller::CollectionResource.new(link, state, @client)
+    else
+      Teller::Resource.new(state, @client)
+    end
+  end
+end

data/lib/teller/version.rb

@@ -0,0 +1,3 @@
+module Teller
+  VERSION = "0.0.1"
+end

data/lib/teller.rb

@@ -0,0 +1,10 @@
+require "teller/version"
+require "teller/config"
+require "teller/resource"
+require "teller/collection_resource"
+require "teller/api"
+require "teller/client"
+
+
+module Teller
+end

data/teller.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/teller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "teller"
+  spec.version       = Teller::VERSION
+  spec.authors       = ["Stevie Graham"]
+  spec.email         = ["sg@teller.io"]
+
+  spec.summary       = "The official Teller Ruby language bindings/"
+  spec.homepage      = "https://github.com/tellerhq/teller-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: teller
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stevie Graham
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-08 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- sg@teller.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/teller.rb
+- lib/teller/api.rb
+- lib/teller/client.rb
+- lib/teller/collection_resource.rb
+- lib/teller/config.rb
+- lib/teller/resource.rb
+- lib/teller/version.rb
+- teller.gemspec
+homepage: https://github.com/tellerhq/teller-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tellerhq/teller-ruby
+  source_code_uri: https://github.com/tellerhq/teller-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: The official Teller Ruby language bindings/
+test_files: []